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.
Methods
Create instance; set fileset to new FileSet.
__construct()
Add a new selector into this container.
appendSelector(\FileSelector $selector) : void
add an "And" selector entry on the selector list
createAnd() : \AndSelector
add a contains selector entry on the selector list
createContains() : \ContainsSelector
add an extended selector entry on the selector list
createCustom() : \ExtendSelector
add a selector date entry on the selector list
createDate() : \DateSelector
add a depends selector entry on the selector list
createDepend() : \DependSelector
add a depth selector entry on the selector list
createDepth() : \DepthSelector
add a selector filename entry on the selector list
createFilename() : \FilenameSelector
add a majority selector entry on the selector list
createMajority() : \MajoritySelector
add a "None" selector entry on the selector list
createNone() : \NoneSelector
add a "Not" selector entry on the selector list
createNot() : \NotSelector
add an "Or" selector entry on the selector list
createOr() : void
add a present selector entry on the selector list
createPresent() : \PresentSelector
add a "Select" selector entry on the selector list
createSelector() : \SelectSelector
add a selector size entry on the selector list
createSize() : \SizeSelector
Returns the textual description of the task
getDescription() : string
Inherited
| inherited_from |
\Task::getDescription() |
Returns
stringThe text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
| inherited_from |
\Task::getLocation() |
Returns
\LocationThe location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
| inherited_from |
\Task::getOwningTarget() |
Returns
\TargetThe target object that owns this task
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\Task::getProject() |
Returns
\ProjectReference to current porject object
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the set of selectors as an array.
getSelectors(\Project $p) : array
Parameters
$p
Returns
arrayFileSelector[] An array of selectors in this container
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
| inherited_from |
\Task::getTaskName() |
Returns
stringName of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
| inherited_from |
\Task::getTaskType() |
Returns
stringThe type of this task (XML Tag)
Indicates whether there are any selectors here.
hasSelectors() : boolean
Returns
booleanWhether any selectors are in this container
Called by the parser to let the task initialize properly.
init()
Inherited
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
| inherited_from |
\Task::init() |
Exceptions
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
stringThe message to log
$level
integerThe priority of the message
Called by the project to let the task do it's work.
main()
Inherited
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.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
| inherited_from |
\Task::main() |
Gives the count of the number of selectors in this container
selectorCount() : int
Returns
intThe number of selectors in this container
Returns an enumerator for accessing the set of selectors.
selectorElements() : \an
Returns
\anenumerator that goes through each of the selectors
Sets case sensitivity of the file system
setCaseSensitive(boolean $isCaseSensitive) : void
Parameters
$isCaseSensitive
boolean"true"|"on"|"yes" if file system is case
sensitive, "false"|"off"|"no" when not.
Sets whether default exclusions should be used or not.
setDefaultexcludes(boolean $useDefaultExcludes)
Parameters
$useDefaultExcludes
boolean"true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.
Sets a textual description of the task
setDescription(string $desc)
Inherited
| inherited_from |
\Task::setDescription() |
Parameters
$desc
stringThe text describing the task
Sets the set of exclude patterns.
setExcludes(string $excludes)
Patterns may be separated by a comma
or a space.
Parameters
$excludes
stringthe string containing the exclude patterns
Sets the name of the file containing the includes patterns.
setExcludesfile(\PhingFile $excludesfile) : void
Parameters
$excludesfile
\PhingFileA string containing the filename to fetch
the include patterns from.
Sets whether or not symbolic links should be followed.
setFollowSymlinks(boolean $followSymlinks) : void
Parameters
$followSymlinks
booleanwhether or not symbolic links should be followed
Sets the set of include patterns.
setIncludes(string $includes) : void
Patterns may be separated by a comma
or a space.
Parameters
$includes
stringthe string containing the include patterns
Sets the name of the file containing the includes patterns.
setIncludesfile(\PhingFile $includesfile) : void
Parameters
$includesfile
\PhingFileA string containing the filename to fetch
the include patterns from.
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
| inherited_from |
\Task::setLocation() |
Parameters
$location
\LocationThe location object describing the position of this
task within the buildfile.
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
| inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\TargetReference to owning target
References the project to the current component.
setProject(\Project $project)
Parameters
$project
\ProjectThe reference to the current project
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
| inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
| inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
stringA string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
| inherited_from |
\Task::setTaskType() |
Parameters
$name
stringThe type of this task (XML Tag)
Returns the directory scanner needed to access the files to process.
getDirectoryScanner(\PhingFile $baseDir) : \DirectoryScanner
Parameters
$baseDir
Returns
Accessor for the implict fileset.
getImplicitFileSet() : \FileSet
Returns a name
getRegisterSlot(string $slotName)
Inherited
| inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Properties
$description : string
Inherited
| inherited_from |
\Task::$$description |
$location : \Location
Inherited
| inherited_from |
\Task::$$location |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\Task::$$project |
$target : \Target
Inherited
| inherited_from |
\Task::$$target |
$taskName : string
Inherited
| inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
| inherited_from |
\Task::$$taskType |
$useDefaultExcludes : boolean