TokenSource

Extends \DataType

A parameter is composed of a name, type and value.

Example of usage:

or:

<param type="tokensource>

author

Yannick Lecaillez

package

phing.types

Methods

This method is called to load the sources from the reader into the buffer of the source.

load() 

This function uses the wrapper to read the tokens and then returns them.

getTokens() 
access

public

Configures a TokenReader with the parameters passed to the TokenSource.

configureTokenReader(\TokenReader $reader) 

Arguments

$reader

\TokenReader

Set the classname (dot-path) to use for handling token replacement.

setClassname(string $c) 

Arguments

$c

string

Returns the qualified classname (dot-path) to use for handling token replacement.

getClassname() : string

Response

string

Create nested <param> tag.

createParam() : \Parameter

Uses standard name/value Parameter class.

Response

\Parameter

Sets a description of the current data type. It will be useful in commenting what we are doing.

setDescription($desc) 
inherited

Arguments

$desc

Return the description for the current data type.

getDescription() 
inherited

Has the refid attribute of this element been set?

isReference() 
inherited

Set the value of the refid attribute.

setRefid(\Reference $r) : void
inherited

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()

Arguments

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).

dieOnCircularReference($stk, \Project $p) 
inherited

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.

Arguments

$stk

Performs the check for circular references and returns the referenced object.

getCheckedRef($requiredClass, $dataTypeName) 
inherited

Arguments

$requiredClass

$dataTypeName

Creates an exception that indicates that refid has to be the only attribute if it is set.

tooManyAttributes() 
inherited

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

noChildrenAllowed() 
inherited

Creates an exception that indicates the user has generated a loop of data types referencing each other.

circularReference() 
inherited

Template method being called when the data type has been parsed completely.

parsingComplete() : void
inherited

References the project to the current component.

setProject(\Project $project) 
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) 
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Properties

String to hold the path to the TokenReader

classname : string
var

Type(s)

string

Array holding parameters for the wrapped TokenReader.

parameters : array
var

Type(s)

array

Reference to the TokenReader used by this TokenSource

reader : \TokenReader
var

Type(s)

\TokenReader

Array with key/value pairs of tokens

tokens : 

The descriptin the user has set.

description : 
inherited

Value to the refid attribute. Type of Reference

ref : 
inherited

Are we sure we don't hold circular references?

checked : boolean
inherited

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).

var

Type(s)

boolean

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project