types/TokenSource.php
A parameter is composed of a name, type and value.
Example of usage:
or:
- Author
- Yannick Lecaillez
- Package
- phing.types
\TokenSource
A parameter is composed of a name, type and value.
Example of usage:
or:
- Parent(s)
- \DataType < \ProjectComponent
- Author
- Yannick Lecaillez
- 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).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked


string
$classname= 'null'
String to hold the path to the TokenReader
null
Details- Type
- string


array
$parameters= 'array()'
Array holding parameters for the wrapped TokenReader.
array()
Details- Type
- array


\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::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project


\TokenReader
$reader= ''
Reference to the TokenReader used by this TokenSource
- Type
- \TokenReader
Methods


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()

configureTokenReader(
\TokenReader $reader
)
:
void
Configures a TokenReader with the parameters passed to the TokenSource.
Name | Type | Description |
---|---|---|
$reader | \TokenReader |


createParam(
)
:
\Parameter
Create nested tag.
Uses standard name/value Parameter class.
Type | Description |
---|---|
\Parameter |


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()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()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getClassname(
)
:
string
Returns the qualified classname (dot-path) to use for handling token replacement.
Type | Description |
---|---|
string |


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

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


getTokens(
)
:
void
This function uses the wrapper to read the tokens and then returns them.
- Access
- public


load(
)
:
void
This method is called to load the sources from the reader into the buffer of the source.


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs 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(
)
:
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()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()

setClassname(
string $c
)
:
void
Set the classname (dot-path) to use for handling token replacement.
Name | Type | Description |
---|---|---|
$c | string |


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()Name | Type | Description |
---|---|---|
$desc |


setProject(
\Project $project
)
:
void
References 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(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()