classes/phing/types/DataType.php
Classes
\DataType
Base class for those classes that can appear inside the build file as stand alone data types.
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)
- Extends from
- \ProjectComponent
- author
- Andreas Aderhold
- author
- Hans Lellelid
- package
- phing.types
- version
- $Revision: 526 $
Properties
boolean
$checked= 'true'
Are we sure we don't hold circular references?
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
$description= 'null'
The descriptin the user has set.
nullDetails- Type
$ref= 'null'
Value to the refid attribute. Type of Reference
nullDetails- Type
Methods
circularReference(
)
:
dieOnCircularReference(
$stk, $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.
| Name | Type | Description |
|---|---|---|
| $stk | ||
| $p |
getCheckedRef(
$requiredClass, $dataTypeName
)
:
| Name | Type | Description |
|---|---|---|
| $requiredClass | ||
| $dataTypeName |
getDescription(
)
:
isReference(
)
:
noChildrenAllowed(
)
:
parsingComplete(
)
:
void
setDescription(
$desc
)
:
| Name | Type | Description |
|---|---|---|
| $desc |
setRefid(
\Reference $r
)
:
voidSubclasses 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(
)
: