types/selectors/BaseSelectorContainer.php
This is the base class for selectors that can contain other selectors.
- Author
- Bruce Atherton (Ant)
- Package
- phing.types.selectors
\BaseSelectorContainer
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)
- Parent(s)
- \SelectorContainer < \DataType < \ProjectComponent
- Children
- \OrSelector
- \AndSelector
- \NoneSelector
- \MajoritySelector
- Author
- Bruce Atherton (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).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked
- Inherited_from
- \BaseSelector::$$checked


$description= 'null'
The descriptin the user has set.
Inherited from: \DataType::$$description\BaseSelector::$$descriptionnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$description
- Inherited_from
- \BaseSelector::$$description


$errmsg= 'null'
null
Details- Type
- n/a
- Inherited_from
- \BaseSelector::$$errmsg


\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::$$projectnull
Details- 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::$$refnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \BaseSelector::$$ref
Methods


appendSelector(
\selector $selector
)
:
\the
Add a new selector into this container.
Name | Type | Description |
---|---|---|
$selector | \selector | the new selector to add |
Type | Description |
---|---|
\the | selector that was added |


circularReference(
)
:
void
Creates 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
)
:
void
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).
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
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()\BaseSelector::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()\BaseSelector::getDescription()

getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\BaseSelector::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getSelectors(
$p
)
:
void
Returns a copy of the selectors as an array.
Name | Type | Description |
---|---|---|
$p |


isReference(
)
:
void
Has the refid attribute of this element been set?
Inherited from: \DataType::isReference()\BaseSelector::isReference()

log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs 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(
)
:
void
Creates 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(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\BaseSelector::parsingComplete()

setDescription(
$desc
)
:
void
Sets 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
)
:
void
Allows 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. |


setProject(
\Project $project
)
:
void
References 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
)
:
void
Set 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 |


toString(
)
:
\comma
Convert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here.
Type | Description |
---|---|
\comma | separated list of Selectors contained in this one |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()\BaseSelector::tooManyAttributes()

validate(
)
:
void
This implementation validates the container by calling verifySettings() and then validates each contained selector provided that the selector implements the validate interface.
Ordinarily, this will validate all the elements of a selector container even if the isSelected() method of some elements is never called. This has two effects:
- Validation will often occur twice.
- Since it is not required that selectors derive from BaseSelector, there could be selectors in the container whose error conditions are not detected if their isSelected() call is never made.


verifySettings(
)
:
void
Subclasses 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()