Selector that filters files based on the filename.
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 |
circularReference() : \BuildException
dieOnCircularReference( &$stk, \Project $p) : void
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.
throws |
---|
\Project
getCheckedRef( $requiredClass, $dataTypeName) : mixed
throws |
---|
mixed
getDescription()
retujrn |
string |
---|---|
getError() : string
string
the error condition
getParameters() : array
array
the set of parameters defined for this selector
getProject() : \Project
isReference() : boolean
boolean
isSelected(\PhingFile $basedir, string $filename, \PhingFile $file) : boolean
{@inheritdoc}
string
is the name of the file to check
boolean
whether the file should be selected or not
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed() : \BuildException
parsingComplete() : void
{@inheritdoc}
setCasesensitive(boolean $casesensitive) : void
boolean
whether to pay attention to case sensitivity
setDescription(string $desc) : void
string
setError(string $msg) : void
string
The error message any BuildException should throw.
setName(string $pattern) : void
string
the file pattern that any filename must match
against in order to be selected.
setNegate(boolean $negated) : void
boolean
whether to negate this selection
setParameters(array $parameters) : mixed|void
array
the complete set of parameters for this selector
mixed|void
setProject(\Project $project) : void
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()
\Reference
tooManyAttributes() : \BuildException
toString() : string
string
validate()
throws | |
---|---|
verifySettings()
NAME_KEY
CASE_KEY
NEGATE_KEY
pattern :
casesensitive :
negated :
parameters :
errmsg : string
var |
---|
string
description : string
var |
---|
string
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).
var |
---|
boolean
project : \Project