AbstractFileSet

Extends \DataType Implements \SelectorContainer, \IteratorAggregate

The FileSet class provides methods and properties for accessing and managing filesets. It extends ProjectComponent and thus inherits all methods and properties (not explicitly declared). See ProjectComponent for further detail.

TODO:

  • merge this with patternsets: FileSet extends PatternSet !!! requires additional mods to the parsing algo [HL] .... not sure if that really makes so much sense. I think that perhaps they should use common utility class if there really is that much shared functionality
author

Andreas Aderhold [email protected]

author

Hans Lellelid [email protected]

version

$Id: 949d67effd3aa293daa084a6c4365ef39ebf6223 $

see
package

phing.types

Methods

__construct

__construct() 
inherited

add an "And" selector entry on the selector list

addAnd(\AndSelector $selector) 
inherited

Arguments

$selector

\AndSelector

add a contains selector entry on the selector list

addContains(\ContainsSelector $selector) 
inherited

Arguments

$selector

\ContainsSelector

add a contains selector entry on the selector list

addContainsRegexp(\ContainsRegexpSelector $selector) 
inherited

Arguments

add an extended selector entry on the selector list

addCustom(\ExtendSelector $selector) 
inherited

Arguments

$selector

\ExtendSelector

add a selector date entry on the selector list

addDate(\DateSelector $selector) 
inherited

Arguments

$selector

\DateSelector

add a depends selector entry on the selector list

addDepend(\DependSelector $selector) 
inherited

Arguments

$selector

\DependSelector

add a depth selector entry on the selector list

addDepth(\DepthSelector $selector) 
inherited

Arguments

$selector

\DepthSelector

add a different selector entry on the selector list

addDifferent(\DifferentSelector $selector) 
inherited

Arguments

$selector

\DifferentSelector

add a executable selector entry on the selector list

addExecutable(\ExecutableSelector $selector) 
inherited

Arguments

add a selector filename entry on the selector list

addFilename(\FilenameSelector $selector) 
inherited

Arguments

$selector

\FilenameSelector

add a majority selector entry on the selector list

addMajority(\MajoritySelector $selector) 
inherited

Arguments

$selector

\MajoritySelector

add a "None" selector entry on the selector list

addNone(\NoneSelector $selector) 
inherited

Arguments

$selector

\NoneSelector

add a "Not" selector entry on the selector list

addNot(\NotSelector $selector) 
inherited

Arguments

$selector

\NotSelector

add an "Or" selector entry on the selector list

addOr(\OrSelector $selector) 
inherited

Arguments

$selector

\OrSelector

add a present selector entry on the selector list

addPresent(\PresentSelector $selector) 
inherited

Arguments

$selector

\PresentSelector

add a readable selector entry on the selector list

addReadable(\ReadableSelector $selector) 
inherited

Arguments

$selector

\ReadableSelector

add a "Select" selector entry on the selector list

addSelector(\SelectSelector $selector) 
inherited

Arguments

$selector

\SelectSelector

add a selector size entry on the selector list

addSize(\SizeSelector $selector) 
inherited

Arguments

$selector

\SizeSelector

add a type selector entry on the selector list

addType(\TypeSelector $selector) 
inherited

Arguments

$selector

\TypeSelector

add a writable selector entry on the selector list

addWritable(\WritableSelector $selector) 
inherited

Arguments

$selector

\WritableSelector

Add a new selector into this container.

appendSelector(\FileSelector $selector) 
inherited

Arguments

$selector

\FileSelector

new selector to add

Creates an exception that indicates the user has generated a loop of data types referencing each other.

circularReference() : \BuildException
inherited

Response

\BuildException

add a name entry on the exclude list

createExclude() 

add a name entry on the include files list

createExcludesFile() 

add a name entry on the include list

createInclude() 

add a name entry on the include files list

createIncludesFile() 

createPatternSet

createPatternSet() : mixed
Throws
\BuildException

Response

mixed

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

dieOnCircularReference( &$stk, \Project $p) : void
inherited

If one is included, throw a BuildException created by circularReference

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Throws
\BuildException

Arguments

$stk

Performs the check for circular references and returns the referenced object.

getCheckedRef( $requiredClass,  $dataTypeName) : mixed
inherited
Throws
\BuildException

Arguments

$requiredClass

$dataTypeName

Response

mixed

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

getDir

getDir(\Project $p) : mixed
Throws
\BuildException

Arguments

Response

mixed

returns a reference to the dirscanner object belonging to this fileset

getDirectoryScanner(\Project $p) : \DirectoryScanner
Throws
\BuildException
\Exception

Arguments

Response

\DirectoryScanner

getIterator

getIterator() 
abstract

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Performs the check for circular references and returns the referenced FileSet.

getRef(\Project $p) : \FileSet
Throws
\BuildException

Arguments

Response

\FileSet

Returns a copy of the selectors as an array.

getSelectors(\Project $p) : array
inherited

Arguments

Response

array

Indicates whether there are any patterns here.

hasPatterns() : boolean

Response

boolean

Whether any patterns are in this container.

Indicates whether there are any selectors here.

hasSelectors() 
inherited

Has the refid attribute of this element been set?

isReference() : boolean
inherited

Response

boolean

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

noChildrenAllowed() : \BuildException
inherited

Response

\BuildException

Template method being called when the data type has been parsed completely.

parsingComplete() : void
inherited

{@inheritdoc}

pushAndInvokeCircularReferenceCheck

pushAndInvokeCircularReferenceCheck(\DataType $dt,  &$stk, \Project $p) 
inherited static

Arguments

$dt

\DataType

$stk

Gives the count of the number of selectors in this container

selectorCount() 
inherited

Returns an array for accessing the set of selectors (not a copy).

selectorElements() 
inherited

Sets case sensitivity of the file system

setCaseSensitive( $isCaseSensitive) 

Arguments

$isCaseSensitive

setChecked

setChecked(boolean $checked) 
inherited

Arguments

$checked

boolean

Sets whether default exclusions should be used or not.

setDefaultexcludes( $useDefaultExcludes) : void
Throws
\BuildException

Arguments

$useDefaultExcludes

"true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

setDir

setDir( $dir) 
Throws
\BuildException

Arguments

$dir

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

setExcludes( $excludes) 
Throws
\BuildException

Arguments

$excludes

Sets the name of the file containing the includes patterns.

setExcludesfile( $excl) 
Throws
\BuildException

Arguments

$excl

The file to fetch the exclude patterns from.

setFile

setFile(\PhingFile $file) 

Arguments

$file

\PhingFile

Sets the set of include patterns. Patterns may be separated by a comma or a space.

setIncludes( $includes) 
Throws
\BuildException

Arguments

$includes

Sets the name of the file containing the includes patterns.

setIncludesfile(\PhingFile $incl) 
Throws
\BuildException

Arguments

$incl

\PhingFile

The file to fetch the include patterns from.

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Set the value of the refid attribute.

setRefid(\Reference $r) : void
inherited

Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()

Arguments

feed dirscanner with infos defined by this fileset

setupDirectoryScanner(\DirectoryScanner $ds, \Project $p) 
Throws
\BuildException
\Exception

Arguments

Creates an exception that indicates that refid has to be the only attribute if it is set.

tooManyAttributes() : \BuildException
inherited

Response

\BuildException

Properties

useDefaultExcludes

useDefaultExcludes : boolean
var

Type(s)

boolean

defaultPatterns

defaultPatterns : \PatternSet
var

Type(s)

\PatternSet

additionalPatterns

additionalPatterns : 

Type(s)

dir

dir : 

Type(s)

isCaseSensitive

isCaseSensitive : 

Type(s)

errorOnMissingDir

errorOnMissingDir : 

Type(s)

directoryScanner

directoryScanner : 

Type(s)

selectorsList

selectorsList : array<mixed,\BaseSelectorContainer>
inherited
var

Type(s)

array<mixed,\BaseSelectorContainer>

Value to the refid attribute.

ref : \Reference
inherited
var

Type(s)

\Reference

Are we sure we don't hold circular references?

checked : boolean
inherited

Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).

var

Type(s)

boolean

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string