types/TokenSource.php
inherited
Classes
\TokenSource
A parameter is composed of a name, type and value.
Example of usage:
or:
- Parent(s)
- \DataType < \ProjectComponent
- Author
- Yannick Lecaillez
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
string
$classname= 'null'
String to hold the path to the TokenReader
nullDetails- Type
- string
array
$parameters= 'array()'
Array holding parameters for the wrapped TokenReader.
array()Details- Type
- array
\TokenReader
$reader= ''
Reference to the TokenReader used by this TokenSource
- Type
- \TokenReader
$tokens= 'array()'
Array with key/value pairs of tokens
array()Details- Type
- n/a
Methods
circularReference(
)
:
voidCreates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()configureTokenReader(
\TokenReader $reader
)
:
voidConfigures a TokenReader with the parameters passed to the TokenSource.
| Name | Type | Description |
|---|---|---|
| $reader | \TokenReader |
createParam(
)
:
\ParameterCreate nested tag.
Uses standard name/value Parameter class.
| Type | Description |
|---|---|
| \Parameter |
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 |
getClassname(
)
:
stringReturns the qualified classname (dot-path) to use for handling token replacement.
| Type | Description |
|---|---|
| string |
getDescription(
)
:
voidReturn the description for the current data type.
Inherited from: \DataType::getDescription()getProject(
)
:
void
getTokens(
)
:
voidThis function uses the wrapper to read the tokens and then returns them.
- Access
- public
isReference(
)
:
void
load(
)
:
voidThis method is called to load the sources from the reader into the buffer of the source.
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()setClassname(
string $c
)
:
voidSet the classname (dot-path) to use for handling token replacement.
| Name | Type | Description |
|---|---|---|
| $c | string |
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 |
setProject(
)
:
void
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()