types/selectors/BaseExtendSelector.php
inherited
Classes
Convenience base class for all selectors accessed through ExtendSelector.
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
\BaseExtendSelector
Convenience base class for all selectors accessed through ExtendSelector.
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.
- Parent(s)
- \ExtendFileSelector < \DataType < \ProjectComponent
- Children
- \ContainsSelector
- \DateSelector
- \DepthSelector
- \TypeSelector
- \FilenameSelector
- \SizeSelector
- \ContainsRegexpSelector
- Author
- Hans Lellelid, hans@xmpl.org (Phing)
- Author
- Bruce Atherton, bruce@callenish.com (Ant)
- Version
- $Id$
Properties
boolean
$checked= 'true'
Are we sure we don't hold circular references?
Inherited from: \DataType::$$checked\BaseSelector::$$checkedSubclasses 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
- Inherited_from
- \BaseSelector::$$checked
$description= 'null'
The descriptin the user has set.
Inherited from: \DataType::$$description\BaseSelector::$$descriptionnullDetails- Type
- n/a
- Inherited_from
- \DataType::$$description
- Inherited_from
- \BaseSelector::$$description
$errmsg= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \BaseSelector::$$errmsg
$parameters= 'null'
The passed in parameter array.
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::$$project\BaseSelector::$$projectnullDetails- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
- Inherited_from
- \BaseSelector::$$project
$ref= 'null'
Value to the refid attribute. Type of Reference
Inherited from: \DataType::$$ref\BaseSelector::$$refnullDetails- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \BaseSelector::$$ref
Methods
circularReference(
)
:
voidCreates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()\BaseSelector::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()\BaseSelector::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()\BaseSelector::getCheckedRef()| Name | Type | Description |
|---|---|---|
| $requiredClass | ||
| $dataTypeName |
getDescription(
)
:
voidReturn the description for the current data type.
Inherited from: \DataType::getDescription()\BaseSelector::getDescription()getError(
)
:
\the
| Type | Description |
|---|---|
| \the | error condition |
getParameters(
)
:
\theAllows access to the parameters gathered and set within the <custom> tag.
| Type | Description |
|---|---|
| \the | set of parameters defined for this selector |
getProject(
)
:
\ProjectReturns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\BaseSelector::getProject()| Type | Description |
|---|---|
| \Project | Reference to current porject object |
isReference(
)
:
voidHas the refid attribute of this element been set?
Inherited from: \DataType::isReference()\BaseSelector::isReference()log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
voidLogs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()\BaseSelector::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()\BaseSelector::noChildrenAllowed()parsingComplete(
)
:
voidTemplate method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\BaseSelector::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()\BaseSelector::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.
Inherited from: \BaseSelector::setError()| Name | Type | Description |
|---|---|---|
| $msg | \msg | The error message any BuildException should throw. |
setParameters(
\parameters $parameters
)
:
voidSet all the Parameters for this custom selector, collected by the ExtendSelector class.
| Name | Type | Description |
|---|---|---|
| $parameters | \parameters | the complete set of parameters for this selector |
setProject(
\Project $project
)
:
voidReferences the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()\BaseSelector::setProject()| Name | Type | Description |
|---|---|---|
| $project | \Project | The reference to the current project |
setRefid(
\Reference $r
)
:
voidSet the value of the refid attribute.
Inherited from: \DataType::setRefid()\BaseSelector::setRefid()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()\BaseSelector::tooManyAttributes()validate(
)
:
voidSubclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
Inherited from: \BaseSelector::validate()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.
Inherited from: \BaseSelector::verifySettings()