types/PatternSet.php
The patternset storage component. Carries all necessary data and methods for the patternset stuff.
- Author
- Andreas Aderhold, andi@binarycloud.com
- Package
- phing.types
- Version
- $Id: af3bd3709d79ad0299bf6ec0130a8a244ee325ab $
\PatternSet
The patternset storage component. Carries all necessary data and methods for the patternset stuff.
This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)
- Parent(s)
- \DataType < \ProjectComponent
- Author
- Andreas Aderhold, andi@binarycloud.com
- Version
- $Id: af3bd3709d79ad0299bf6ec0130a8a244ee325ab $
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


\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


addPatternToList(
array $list
)
:
\PatternSetNameEntry
add a name entry to the given list
Name | Type | Description |
---|---|---|
$list | array | List onto which the nameentry should be added |
Type | Description |
---|---|
\PatternSetNameEntry | Reference to the created PsetNameEntry instance |


append(
$other, $p
)
:
void
Adds the patterns of the other instance to this set.
Name | Type | Description |
---|---|---|
$other | ||
$p |


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

createExclude(
)
:
\PatternSetNameEntry
Add a name entry on the exclude list
Type | Description |
---|---|
\PatternSetNameEntry | Reference to object |
Exception | Description |
---|---|
\BuildException |


createExcludesFile(
)
:
\PatternSetNameEntry
add a name entry on the exclude files list
Type | Description |
---|---|
\PatternSetNameEntry | Reference to object |
Exception | Description |
---|---|
\BuildException |


createInclude(
)
:
\PatternSetNameEntry
Add a name entry on the include list
Type | Description |
---|---|
\PatternSetNameEntry | Reference to object |
Exception | Description |
---|---|
\BuildException |


createIncludesFile(
)
:
\PatternSetNameEntry
Add a name entry on the include files list
Type | Description |
---|---|
\PatternSetNameEntry | Reference to object |
Exception | Description |
---|---|
\BuildException |


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()

getExcludePatterns(
$p
)
:
void
Returns the filtered exclude patterns.
Name | Type | Description |
---|---|---|
$p |


getIncludePatterns(
$p
)
:
void
Returns the filtered include patterns.
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 PatternSet.
Name | Type | Description |
---|---|---|
$p |


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 |


makeArray(
$list, $p
)
:
void
Convert a array of PatternSetNameEntry elements into an array of Strings.
Name | Type | Description |
---|---|---|
$list | ||
$p |


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()

readFiles(
$p
)
:
void
Read includesfile or excludesfile if not already done so.
Name | Type | Description |
---|---|---|
$p |


readPatterns(
$patternfile, $patternlist, $p
)
:
void
Reads path matching patterns from a file and adds them to the includes or excludes list
Name | Type | Description |
---|---|---|
$patternfile | ||
$patternlist | ||
$p |


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(
string $excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Name | Type | Description |
---|---|---|
$excludes | string | the string containing the exclude patterns |
Exception | Description |
---|---|
\BuildException |


setExcludesFile(
\excludesFile $excludesFile
)
:
void
Sets the name of the file containing the excludes patterns.
Name | Type | Description |
---|---|---|
$excludesFile | \excludesFile | The file to fetch the exclude patterns from. |


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


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


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 |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()\PatternSetNameEntry
"Internal" class for holding an include/exclude pattern.
Properties
Methods


evalName(
$project
)
:
string
Evaluates the pattern.
Name | Type | Description |
---|---|---|
$project |
Type | Description |
---|---|
string | The pattern or null if it is ruled out by a condition. |


setIf(
string $cond
)
:
void
Sets an if-condition property for this pattern to match.
Name | Type | Description |
---|---|---|
$cond | string |


setName(
string $name
)
:
void
Set the pattern text.
Name | Type | Description |
---|---|---|
$name | string | The pattern |


setPattern(
string $pattern
)
:
void
An alias for the setName() method.
Name | Type | Description |
---|---|---|
$pattern | string |
- See
- \setName()


setUnless(
string $cond
)
:
void
Sets an unless-condition property for this pattern to match.
Name | Type | Description |
---|---|---|
$cond | string |