This is the base class for selectors that can contain other selectors.
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)
author |
Bruce Atherton (Ant) |
---|---|
package |
phing.types.selectors |
appendSelector(\FileSelector $selector) : \the
circularReference()
createAnd()
createContains()
createContainsRegexp()
createCustom()
createDate()
createDepend()
createDepth()
createFilename()
createMajority()
createNone()
createNot()
createOr()
createPresent()
createSelector()
createSize()
createType()
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.
\Project
getCheckedRef( $requiredClass, $dataTypeName)
getDescription()
getError() : \the
\the
error condition
getProject() : \Project
getSelectors(\Project $p) : \an
hasSelectors() : \whether
\whether
any selectors are in this container
isReference()
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed()
parsingComplete() : void
selectorCount() : \the
\the
number of selectors in this container
selectorElements() : \an
\an
enumerator that goes through each of the selectors
setDescription( $desc)
setError( $msg)
setProject(\Project $project)
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()
toString() : \comma
\comma
separated list of Selectors contained in this one
validate()
verifySettings()
selectorsList :
errmsg :
description :
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).
var |
---|
boolean
project : \Project