phing-types

# Class: TokenSource Source Location: /types/TokenSource.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --TokenSource
A parameter is composed of a name, type and value. #### Author(s): <href="mailto:yl@seasonfive.com" a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a> #### Version: $Revision: 526 $ | ### Variables $classname $parameters $reader $tokens | ### Methods createParam getClassname getTokens load setClassname
### Inherited Variables #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: DataType DataType::circularReference() Creates an exception that indicates the user has generated a loop of data types referencing each other. DataType::dieOnCircularReference() 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). DataType::getCheckedRef() Performs the check for circular references and returns the referenced object. DataType::getDescription() Return the description for the current data type. DataType::isReference() Has the refid attribute of this element been set? DataType::noChildrenAllowed() Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set. DataType::parsingComplete() Template method being called when the data type has been parsed completely. DataType::setDescription() Sets a description of the current data type. It will be useful in commenting what we are doing. DataType::setRefid() Set the value of the refid attribute. DataType::tooManyAttributes() Creates an exception that indicates that refid has to be the only attribute if it is set. #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 49] A parameter is composed of a name, type and value. Example of usage: <replacetokens> <tokensource classname="phing.filters.util.IniFileTokenReader"> <!-- all params for the TokenReader here --> <param name="file" value="tokens.ini" /> </tokensource> </replacetokens> or: <filterreader classname="phing.filters.ReplaceTokens"> <param type="tokensource> <param name="classname" value="phing.filters.util.IniFileTokenReader" /> <param name="file" value="tokens.ini" /> </param> </filterreader> #### Tags:
author: | <href="mailto:yl@seasonfive.com" a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a>
version: | $Revision: 526 $
[ Top ] ### Class Variables #### $classname = null [line 55] String to hold the path to the TokenReader #### Tags:
access: | protected
Type: | string
[ Top ] #### $parameters = array() [line 61] Array holding parameters for the wrapped TokenReader. #### Tags:
access: | protected
Type: | array
[ Top ] #### $reader = [line 67] Reference to the TokenReader used by this TokenSource #### Tags:
access: | protected
Type: | TokenReader
[ Top ] #### $tokens = array() [line 72] Array with key/value pairs of tokens #### Tags:
access: | protected
Type: | mixed
[ Top ] ### Class Methods ### method createParam [line 150]
`Parameter createParam( )`
Create nested <param> tag. Uses standard name/value Parameter class. [ Top ] ### method getClassname [line 141]
`string getClassname( )`
Returns the qualified classname (dot-path) to use for handling token replacement. [ Top ] ### method getTokens [line 108]
`void getTokens( )`
This function uses the wrapper to read the tokens and then returns them. #### Tags:
access: | public
[ Top ] ### method load [line 78]
`void load( )`
This method is called to load the sources from the reader into the buffer of the source. [ Top ] ### method setClassname [line 133]
`void setClassname( string $c)`
Set the classname (dot-path) to use for handling token replacement. #### Parameters:
string | $c |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:15 +0200 by phpDocumentor 1.4.3