types/AbstractFileSet.php
\AbstractFileSet
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
- Parent(s)
- \DataType < \ProjectComponent
- Children
- \DirSet
- \FileSet
- See
- \ProjectComponent
- Author
- Andreas Aderhold
- Author
- Hans Lellelid
- Version
- $Id$
Properties


boolean
$checked= 'true'
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).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked


boolean
$expandSymbolicLinks= 'false'
Whether to expand/dereference symbolic links, default is false
false
Details- Type
- boolean


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\DataType::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
Methods


appendSelector(
\selector $selector
)
:
void
Add a new selector into this container.
Name | Type | Description |
---|---|---|
$selector | \selector | the new selector to add |


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()

dieOnCircularReference(
$stk, $p
)
:
void
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).
Inherited from: \DataType::dieOnCircularReference()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.
Name | Type | Description |
---|---|---|
$stk | ||
$p |


getCheckedRef(
$requiredClass, $dataTypeName
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()

getDirectoryScanner(
$p
)
:
void
returns a reference to the dirscanner object belonging to this fileset
Name | Type | Description |
---|---|---|
$p |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRef(
$p
)
:
void
Performs the check for circular references and returns the referenced FileSet.
Name | Type | Description |
---|---|---|
$p |


getSelectors(
$p
)
:
\an
Returns the set of selectors as an array.
Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
\an | array of selectors in this container |


hasPatterns(
)
:
boolean
Indicates whether there are any patterns here.
Type | Description |
---|---|
boolean | Whether any patterns are in this container. |


hasSelectors(
)
:
boolean
Indicates whether there are any selectors here.
Type | Description |
---|---|
boolean | Whether any selectors are in this container |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()Name | Type | Description |
---|---|---|
$msg | string | The message to be logged. |
$level | integer | The message's priority at this message should have |


noChildrenAllowed(
)
:
void
Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()

selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Type | Description |
---|---|
int | The number of selectors in this container |


selectorElements(
)
:
array
Returns an array for accessing the set of selectors.
Type | Description |
---|---|
array | The array of selectors |


setCaseSensitive(
$isCaseSensitive
)
:
void
Sets case sensitivity of the file system
Name | Type | Description |
---|---|---|
$isCaseSensitive |


setDefaultexcludes(
\$useDefaultExcludes $useDefaultExcludes
)
:
void
Sets whether default exclusions should be used or not.
Name | Type | Description |
---|---|---|
$useDefaultExcludes | \$useDefaultExcludes | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used. |


setDescription(
$desc
)
:
void
Sets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()Name | Type | Description |
---|---|---|
$desc |


setExcludes(
$excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Name | Type | Description |
---|---|---|
$excludes |


setExcludesfile(
\$excl $excl
)
:
void
Sets the name of the file containing the includes patterns.
Name | Type | Description |
---|---|---|
$excl | \$excl | The file to fetch the exclude patterns from. |
Exception | Description |
---|---|
\BE |


setExpandSymbolicLinks(
$expandSymbolicLinks
)
:
void
Sets whether to expand/dereference symbolic links, default is false
Name | Type | Description |
---|---|---|
$expandSymbolicLinks |
- boolean


setIncludes(
$includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Name | Type | Description |
---|---|---|
$includes |


setIncludesfile(
\$incl $incl
)
:
void
Sets the name of the file containing the includes patterns.
Name | Type | Description |
---|---|---|
$incl | \$incl | The file to fetch the include patterns from. |
Exception | Description |
---|---|
\BE |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRefid(
\Reference $r
)
:
void
Makes this instance in effect a reference to another PatternSet instance.
You must not set another attribute or nest elements inside this element if you make it a reference.
Name | Type | Description |
---|---|---|
$r | \Reference |


setupDirectoryScanner(
$ds, $p
)
:
void
feed dirscanner with infos defined by this fileset
Name | Type | Description |
---|---|---|
$ds | ||
$p |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()