A convenience base class that you can subclass Selectors from. It provides some helpful common behaviour. Note that there is no need for Selectors to inherit from this class, it is only necessary that they implement FileSelector.
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 | |
---|---|
package |
phing.types.selectors |
setError($msg)
getError() : \the
\the
error condition
verifySettings()
validate()
setDescription($desc)
getDescription()
isReference()
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()
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.
getCheckedRef($requiredClass, $dataTypeName)
tooManyAttributes()
noChildrenAllowed()
circularReference()
parsingComplete() : void
setProject(\Project $project)
getProject() : \Project
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
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