tasks/system/MatchingTask.php
This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching.
This is very closely based on the ANT class of the same name.
- Author
- Hans Lellelid
(Phing) - Author
- Arnout J. Kuiper
(Ant) - Author
- Stefano Mazzocchi
(Ant) - Author
- Sam Ruby
(Ant) - Author
- Jon S. Stevens
(Ant - Author
- Stefan Bodewig
(Ant) - Author
- Bruce Atherton
(Ant) - Package
- phing.tasks.system
- Version
- $Id: 1e1f6274f400b90c2344c8cdb5d3711030b8f44a $
\MatchingTask
This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching.
This is very closely based on the ANT class of the same name.
- Parent(s)
- \SelectorContainer < \ProjectComponent
- Children
- \ZendGuardEncodeTask
- \TarTask
- \PearPackageTask
- \ZipTask
- \ExtractBaseTask
- \PharPackageTask
- Author
- Hans Lellelid
(Phing) - Author
- Arnout J. Kuiper
(Ant) - Author
- Stefano Mazzocchi
(Ant) - Author
- Sam Ruby
(Ant) - Author
- Jon S. Stevens
(Ant - Author
- Stefan Bodewig
(Ant) - Author
- Bruce Atherton
(Ant) - Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 1e1f6274f400b90c2344c8cdb5d3711030b8f44a $
Properties


\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\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


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


createAnd(
)
:
\AndSelector
add an "And" selector entry on the selector list
Type | Description |
---|---|
\AndSelector |


createContains(
)
:
\ContainsSelector
add a contains selector entry on the selector list
Type | Description |
---|---|
\ContainsSelector |


createCustom(
)
:
\ExtendSelector
add an extended selector entry on the selector list
Type | Description |
---|---|
\ExtendSelector |


createDate(
)
:
\DateSelector
add a selector date entry on the selector list
Type | Description |
---|---|
\DateSelector |


createDepend(
)
:
\DependSelector
add a depends selector entry on the selector list
Type | Description |
---|---|
\DependSelector |


createDepth(
)
:
\DepthSelector
add a depth selector entry on the selector list
Type | Description |
---|---|
\DepthSelector |


createExclude(
)
:
\PatternSetNameEntry
add a name entry on the exclude list
Type | Description |
---|---|
\PatternSetNameEntry |


createExcludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Type | Description |
---|---|
\PatternSetNameEntry |


createFilename(
)
:
\FilenameSelector
add a selector filename entry on the selector list
Type | Description |
---|---|
\FilenameSelector |


createInclude(
)
:
\PatternSetNameEntry
add a name entry on the include list
Type | Description |
---|---|
\PatternSetNameEntry |


createIncludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Type | Description |
---|---|
\PatternSetNameEntry |


createMajority(
)
:
\MajoritySelector
add a majority selector entry on the selector list
Type | Description |
---|---|
\MajoritySelector |


createNone(
)
:
\NoneSelector
add a "None" selector entry on the selector list
Type | Description |
---|---|
\NoneSelector |


createNot(
)
:
\NotSelector
add a "Not" selector entry on the selector list
Type | Description |
---|---|
\NotSelector |


createPresent(
)
:
\PresentSelector
add a present selector entry on the selector list
Type | Description |
---|---|
\PresentSelector |


createSelector(
)
:
\SelectSelector
add a "Select" selector entry on the selector list
Type | Description |
---|---|
\SelectSelector |


createSize(
)
:
\SizeSelector
add a selector size entry on the selector list
Type | Description |
---|---|
\SizeSelector |


getDirectoryScanner(
$baseDir
)
:
\DirectoryScanner
Returns the directory scanner needed to access the files to process.
Name | Type | Description |
---|---|---|
$baseDir |
Type | Description |
---|---|
\DirectoryScanner |


getImplicitFileSet(
)
:
\FileSet
Accessor for the implict fileset.
Type | Description |
---|---|
\FileSet |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


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


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


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


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


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


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.
Inherited from: \Task::main()Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

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


selectorElements(
)
:
\an
Returns an enumerator for accessing the set of selectors.
Type | Description |
---|---|
\an | enumerator that goes through each of the selectors |


setCaseSensitive(
boolean $isCaseSensitive
)
:
void
Sets case sensitivity of the file system
Name | Type | Description |
---|---|---|
$isCaseSensitive | boolean | "true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not. |


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


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


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 |


setExcludesfile(
\PhingFile $excludesfile
)
:
void
Sets the name of the file containing the includes patterns.
Name | Type | Description |
---|---|---|
$excludesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setFollowSymlinks(
boolean $followSymlinks
)
:
void
Sets whether or not symbolic links should be followed.
Name | Type | Description |
---|---|---|
$followSymlinks | boolean | whether or not symbolic links should be followed |


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 |


setIncludesfile(
\PhingFile $includesfile
)
:
void
Sets the name of the file containing the includes patterns.
Name | Type | Description |
---|---|---|
$includesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


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


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |