Selector that filters files based on whether they contain a particular string.
It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.
author | Hans Lellelid <hans@xmpl.org> (Phing) |
---|---|
author | Bruce Atherton <bruce@callenish.com> (Ant) |
package | phing.types.selectors |
version | $Id$ |
circularReference()
inherited_from | \DataType::circularReference() |
---|---|
inherited_from | \BaseSelector::circularReference() |
inherited_from | \BaseExtendSelector::circularReference() |
dieOnCircularReference($stk, \Project $p)
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.
inherited_from | \DataType::dieOnCircularReference() |
---|---|
inherited_from | \BaseSelector::dieOnCircularReference() |
inherited_from | \BaseExtendSelector::dieOnCircularReference() |
getCheckedRef($requiredClass, $dataTypeName)
inherited_from | \DataType::getCheckedRef() |
---|---|
inherited_from | \BaseSelector::getCheckedRef() |
inherited_from | \BaseExtendSelector::getCheckedRef() |
getDescription()
inherited_from | \DataType::getDescription() |
---|---|
inherited_from | \BaseSelector::getDescription() |
inherited_from | \BaseExtendSelector::getDescription() |
getError() : \the
inherited_from | \BaseSelector::getError() |
---|---|
inherited_from | \BaseExtendSelector::getError() |
\the
error conditiongetProject() : \Project
inherited_from | \ProjectComponent::getProject() |
---|---|
inherited_from | \DataType::getProject() |
inherited_from | \BaseSelector::getProject() |
inherited_from | \BaseExtendSelector::getProject() |
\Project
Reference to current porject objectisReference()
inherited_from | \DataType::isReference() |
---|---|
inherited_from | \BaseSelector::isReference() |
inherited_from | \BaseExtendSelector::isReference() |
isSelected(\PhingFile $basedir, \filename $filename, \PhingFile $file) : \whether
This is where the selector gets to decide on the inclusion of a file in a particular fileset.
\basedir
the base directory the scan is being done from
\filename
is the name of the file to check
\file
a PhingFile object the selector can use
\BuildException |
if the selector was not configured correctly |
---|
\whether
the file should be selected or notlog(string $msg, integer $level)
inherited_from | \ProjectComponent::log() |
---|---|
inherited_from | \DataType::log() |
inherited_from | \BaseSelector::log() |
inherited_from | \BaseExtendSelector::log() |
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed()
inherited_from | \DataType::noChildrenAllowed() |
---|---|
inherited_from | \BaseSelector::noChildrenAllowed() |
inherited_from | \BaseExtendSelector::noChildrenAllowed() |
parsingComplete() : void
inherited_from | \DataType::parsingComplete() |
---|---|
inherited_from | \BaseSelector::parsingComplete() |
inherited_from | \BaseExtendSelector::parsingComplete() |
setCasesensitive(boolean $casesensitive)
boolean
whether to pay attention to case sensitivity
setDescription($desc)
It will be useful in commenting what we are doing.
inherited_from | \DataType::setDescription() |
---|---|
inherited_from | \BaseSelector::setDescription() |
inherited_from | \BaseExtendSelector::setDescription() |
setError(\msg $msg)
Note that only the first error message is recorded.
inherited_from | \BaseSelector::setError() |
---|---|
inherited_from | \BaseExtendSelector::setError() |
\msg
The error message any BuildException should throw.
setParameters(array $parameters)
It translates each parameter into the appropriate setXXX() call.
array
the complete set of parameters for this selector
setProject(\Project $project)
inherited_from | \ProjectComponent::setProject() |
---|---|
inherited_from | \DataType::setProject() |
inherited_from | \BaseSelector::setProject() |
inherited_from | \BaseExtendSelector::setProject() |
setRefid(\Reference $r) : void
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()
inherited_from | \DataType::setRefid() |
---|---|
inherited_from | \BaseSelector::setRefid() |
inherited_from | \BaseExtendSelector::setRefid() |
\Reference
setText(string $contains)
string
the string that a file must contain to be selected.
toString()
tooManyAttributes()
inherited_from | \DataType::tooManyAttributes() |
---|---|
inherited_from | \BaseSelector::tooManyAttributes() |
inherited_from | \BaseExtendSelector::tooManyAttributes() |
validate()
inherited_from | \BaseSelector::validate() |
---|---|
inherited_from | \BaseExtendSelector::validate() |
verifySettings()
In this case, it means that the pattern attribute has been set.
getParameters() : \the
inherited_from | \BaseExtendSelector::getParameters() |
---|
\the
set of parameters defined for this selector$description
inherited_from | \DataType::$$description |
---|---|
inherited_from | \BaseSelector::$$description |
inherited_from | \BaseExtendSelector::$$description |
$ref
Type of Reference
inherited_from | \DataType::$$ref |
---|---|
inherited_from | \BaseSelector::$$ref |
inherited_from | \BaseExtendSelector::$$ref |
$checked : boolean
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).
inherited_from | \DataType::$$checked |
---|---|
inherited_from | \BaseSelector::$$checked |
inherited_from | \BaseExtendSelector::$$checked |
$parameters
inherited_from | \BaseExtendSelector::$$parameters |
---|
$project : \Project
inherited_from | \ProjectComponent::$$project |
---|---|
inherited_from | \DataType::$$project |
inherited_from | \BaseSelector::$$project |
inherited_from | \BaseExtendSelector::$$project |
$casesensitive
$contains
$errmsg
inherited_from | \BaseSelector::$$errmsg |
---|---|
inherited_from | \BaseExtendSelector::$$errmsg |
CASE_KEY
CONTAINS_KEY