Subclass as hint for supporting tasks that the included directories
instead of files should be used.
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
Methods
__construct
__construct($fileset = null)
inherited
Return a DirSet that has the same basedir and same patternsets
as this one.
__clone()
Sets whether to expand/dereference symbolic links, default is false
setExpandSymbolicLinks($expandSymbolicLinks)
inherited
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
setDir
setDir($dir)
inherited
getDir
getDir(\Project $p)
inherited
createPatternSet
createPatternSet()
inherited
add a name entry on the include list
createInclude()
inherited
add a name entry on the include files list
createIncludesFile()
inherited
add a name entry on the exclude list
createExclude()
inherited
add a name entry on the include files list
createExcludesFile()
inherited
Sets the set of include patterns. Patterns may be separated by a comma
or a space.
setIncludes($includes)
inherited
Sets the set of exclude patterns. Patterns may be separated by a comma
or a space.
setExcludes($excludes)
inherited
Sets the name of the file containing the includes patterns.
setIncludesfile(mixed $incl)
inherited
Arguments
$incl
mixed
The file to fetch the include patterns from.
Sets the name of the file containing the includes patterns.
setExcludesfile(mixed $excl)
inherited
Arguments
$excl
mixed
The file to fetch the exclude patterns from.
Sets whether default exclusions should be used or not.
setDefaultexcludes(mixed $useDefaultExcludes)
inherited
Arguments
$useDefaultExcludes
mixed
"true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.
Sets case sensitivity of the file system
setCaseSensitive($isCaseSensitive)
inherited
returns a reference to the dirscanner object belonging to this fileset
getDirectoryScanner(\Project $p)
inherited
feed dirscanner with infos defined by this fileset
setupDirectoryScanner(\DirectoryScanner $ds, \Project $p)
inherited
Performs the check for circular references and returns the
referenced FileSet.
getRef(\Project $p)
inherited
Indicates whether there are any selectors here.
hasSelectors() : boolean
inherited
Response
boolean
Whether any selectors are in this container
Indicates whether there are any patterns here.
hasPatterns() : boolean
inherited
Response
boolean
Whether any patterns are in this container.
Gives the count of the number of selectors in this container
selectorCount() : int
inherited
Response
int
The number of selectors in this container
Returns the set of selectors as an array.
getSelectors(\Project $p) : \an
inherited
Arguments
Response
\an
array of selectors in this container
Returns an array for accessing the set of selectors.
selectorElements() : array
inherited
Response
array
The array of selectors
Add a new selector into this container.
appendSelector(\FileSelector $selector)
inherited
add a "Select" selector entry on the selector list
createSelector()
inherited
add an "And" selector entry on the selector list
createAnd()
inherited
add an "Or" selector entry on the selector list
createOr()
inherited
add a "Not" selector entry on the selector list
createNot()
inherited
add a "None" selector entry on the selector list
createNone()
inherited
add a majority selector entry on the selector list
createMajority()
inherited
add a selector date entry on the selector list
createDate()
inherited
add a selector size entry on the selector list
createSize()
inherited
add a selector filename entry on the selector list
createFilename()
inherited
add an extended selector entry on the selector list
createCustom()
inherited
add a contains selector entry on the selector list
createContains()
inherited
add a contains selector entry on the selector list
createContainsRegexp()
inherited
add a present selector entry on the selector list
createPresent()
inherited
add a depth selector entry on the selector list
createDepth()
inherited
add a depends selector entry on the selector list
createDepend()
inherited
add a type selector entry on the selector list
createType()
inherited
Sets a description of the current data type. It will be useful
in commenting what we are doing.
setDescription($desc)
inherited
Return the description for the current data type.
getDescription()
inherited
Has the refid attribute of this element been set?
isReference()
inherited
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)
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.
Arguments
Performs the check for circular references and returns the referenced object.
getCheckedRef($requiredClass, $dataTypeName)
inherited
Creates an exception that indicates that refid has to be the
only attribute if it is set.
tooManyAttributes()
inherited
Creates an exception that indicates that this XML element must
not have child elements if the refid attribute is set.
noChildrenAllowed()
inherited
Creates an exception that indicates the user has generated a
loop of data types referencing each other.
circularReference()
inherited
Template method being called when the data type has been
parsed completely.
parsingComplete() : void
inherited
References the project to the current component.
setProject(\Project $project)
inherited
Arguments
$project
\Project
The reference to the current project
Returns a reference to current project
getProject() : \Project
inherited
Response
\Project
Reference to current porject object
Logs a message with the given priority.
log(string $msg, integer $level = \Project::MSG_INFO)
inherited
Arguments
$msg
string
The message to be logged.
$level
integer
The message's priority at this message should have
Properties
useDefaultExcludes
useDefaultExcludes : boolean
inherited
Whether to expand/dereference symbolic links, default is false
expandSymbolicLinks : boolean
inherited
defaultPatterns
defaultPatterns : \PatternSet
inherited
additionalPatterns
additionalPatterns :
inherited
isCaseSensitive
isCaseSensitive :
inherited
selectors
selectors :
inherited
The descriptin the user has set.
description :
inherited
Value to the refid attribute. Type of Reference
ref :
inherited
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).
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