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.
Methods
Creates an exception that indicates the user has generated a
loop of data types referencing each other.
circularReference()
Inherited
| inherited_from |
\DataType::circularReference() |
Check to see whether any DataType we hold references to is
included in the Stack (which holds all DataType instances that
directly or indirectly reference this instance, including this
instance itself).
dieOnCircularReference($stk, \Project $p)
Inherited
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() |
Parameters
$stk
$p
Performs the check for circular references and returns the referenced object.
getCheckedRef($requiredClass, $dataTypeName)
Inherited
| inherited_from |
\DataType::getCheckedRef() |
Parameters
$requiredClass
$dataTypeName
Return the description for the current data type.
getDescription()
Inherited
| inherited_from |
\DataType::getDescription() |
Returns any error messages that have been set.
getError() : \the
Returns
\theerror condition
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\DataType::getProject() |
Returns
\ProjectReference to current porject object
Has the refid attribute of this element been set?
isReference()
Inherited
| inherited_from |
\DataType::isReference() |
Method that each selector will implement to create their
selection behaviour.
isSelected(\PhingFile $basedir, \filename $filename, \PhingFile $file) : \whether
Inherited
If there is a problem with the setup
of a selector, it can throw a BuildException to indicate
the problem.
| inherited_from |
\FileSelector::isSelected() |
Parameters
$basedir
\basedirA PhingFile object for the base directory
$filename
\filenameThe name of the file to check
$file
\fileA PhingFile object for this filename
Exceptions
Returns
\whetherthe file should be selected or not
Logs a message with the given priority.
log(string $msg, integer $level)
Inherited
| inherited_from |
\ProjectComponent::log() |
| inherited_from |
\DataType::log() |
Parameters
$msg
stringThe message to be logged.
$level
integerThe message's priority at this message should have
Creates an exception that indicates that this XML element must
not have child elements if the refid attribute is set.
noChildrenAllowed()
Inherited
| inherited_from |
\DataType::noChildrenAllowed() |
Template method being called when the data type has been
parsed completely.
parsingComplete() : void
Inherited
| inherited_from |
\DataType::parsingComplete() |
Sets a description of the current data type.
setDescription($desc)
Inherited
It will be useful
in commenting what we are doing.
| inherited_from |
\DataType::setDescription() |
Parameters
$desc
Allows all selectors to indicate a setup error.
setError(\msg $msg)
Note that only
the first error message is recorded.
Parameters
$msg
\msgThe error message any BuildException should throw.
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\DataType::setProject() |
Parameters
$project
\ProjectThe reference to the current project
Set the value of the refid attribute.
setRefid(\Reference $r) : void
Inherited
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() |
Parameters
Creates an exception that indicates that refid has to be the
only attribute if it is set.
tooManyAttributes()
Inherited
| inherited_from |
\DataType::tooManyAttributes() |
Subclasses can use this to throw the requisite exception
in isSelected() in the case of an error condition.
validate()
<p>Subclasses can override this method to provide checking of their
state.
verifySettings()
So long as they call validate() from isSelected(), this will
be called automatically (unless they override validate()).
Implementations should check for incorrect settings and call
setError() as necessary.
Properties
$description
Inherited
| inherited_from |
\DataType::$$description |
$ref
Inherited
| inherited_from |
\DataType::$$ref |
$checked : boolean
Inherited
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 |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\DataType::$$project |