types/selectors/BaseSelector.php
inherited
Classes
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.
- Author
- Bruce Atherton
- Package
- phing.types.selectors
\BaseSelector
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)
- Parent(s)
- \DataType < \ProjectComponent
- Children
- \PresentSelector
- \BaseExtendSelector
- \DependSelector
- \BaseSelectorContainer
- \ExtendSelector
- Author
- Bruce Atherton
- Version
- $Id$
Properties
boolean
$checked= 'true'
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).
trueDetails- Type
- boolean
- Inherited_from
- \DataType::$$checked
$errmsg= 'null'
nullDetails- Type
- n/a
\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\DataType::$$projectnullDetails- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
Methods
circularReference(
)
:
voidCreates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()dieOnCircularReference(
$stk, $p
)
:
voidCheck 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).
Inherited from: \DataType::dieOnCircularReference()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.
| Name | Type | Description |
|---|---|---|
| $stk | ||
| $p |
getCheckedRef(
$requiredClass, $dataTypeName
)
:
voidPerforms the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()| Name | Type | Description |
|---|---|---|
| $requiredClass | ||
| $dataTypeName |
getDescription(
)
:
voidReturn the description for the current data type.
Inherited from: \DataType::getDescription()getError(
)
:
\theReturns any error messages that have been set.
| Type | Description |
|---|---|
| \the | error condition |
getProject(
)
:
\ProjectReturns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()| Type | Description |
|---|---|
| \Project | Reference to current porject object |
isReference(
)
:
void
log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
voidLogs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()| Name | Type | Description |
|---|---|---|
| $msg | string | The message to be logged. |
| $level | integer | The message's priority at this message should have |
noChildrenAllowed(
)
:
voidCreates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()parsingComplete(
)
:
voidTemplate method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()setDescription(
$desc
)
:
voidSets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()| Name | Type | Description |
|---|---|---|
| $desc |
setError(
\msg $msg
)
:
voidAllows all selectors to indicate a setup error. Note that only the first error message is recorded.
| Name | Type | Description |
|---|---|---|
| $msg | \msg | The error message any BuildException should throw. |
setProject(
\Project $project
)
:
voidReferences the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()| Name | Type | Description |
|---|---|---|
| $project | \Project | The reference to the current 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()
| Name | Type | Description |
|---|---|---|
| $r | \Reference |
tooManyAttributes(
)
:
voidCreates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()validate(
)
:
voidSubclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
verifySettings(
)
:
voidSubclasses can override this method to provide checking of their state. 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.