filters/ReplaceTokens.php
Replaces tokens in the original input with user-supplied values.
Example:
;
Or:
- Access
- public
- Author
- Yannick Lecaillez
- Author
- hans lellelid, hans@velum.net
- Package
- phing.filters
- See
- \BaseParamFilterReader
- Version
- $Id: 6c5d97f2254de3c08ac34baaabf6119c54a49a7d $
\ReplaceTokens
Replaces tokens in the original input with user-supplied values.
Example:
;
Or:
- Parent(s)
- \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
- See
- \BaseParamFilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Author
- hans lellelid, hans@velum.net
- Copyright
- � 2003 seasonfive. All rights reserved
- Version
- $Id: 6c5d97f2254de3c08ac34baaabf6119c54a49a7d $
Constants
Properties


array
$_alltokens= 'null'
Array holding all tokens given directly to the Filter and those passed via a TokenSource.
null
Details- Type
- array


string
$_beginToken= '"@"'
Character marking the beginning of a token.
"@"
Details- Type
- string


$_parameters= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \BaseParamFilterReader::$$_parameters


string
$_queuedData= 'null'
[Deprecated] Data that must be read from, if not null.
null
Details- Type
- string


array
$_tokens= 'array()'
Array to hold the replacee-replacer pairs (String to String).
array()
Details- Type
- array


array
$_tokensources= 'array()'
Array to hold the token sources that make tokens from different sources available
array()
Details- Type
- array


\Reader
$in= ''
- Type
- \Reader
- Inherited_from
- \FilterReader::$$in
- Inherited_from
- \BaseFilterReader::$$in
- Inherited_from
- \BaseParamFilterReader::$$in


$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initializedfalse
Details- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
- Inherited_from
- \BaseParamFilterReader::$$initialized


$project= 'null'
The Phing project this filter is part of.
Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$projectnull
Details- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$project
- Inherited_from
- \BaseParamFilterReader::$$project
Methods


__construct(
\Reader $in
=
null
)
:
void
Constructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()\BaseParamFilterReader::__construct()The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.
Name | Type | Description |
---|---|---|
$in | \Reader |


_initialize(
)
:
void
Initializes tokens and loads the replacee-replacer hashtable.
This method is only called when this filter is used through
a


chain(
object $reader
)
:
object
Creates a new ReplaceTokens using the passed in Reader for instantiation.
Name | Type | Description |
---|---|---|
$reader | object | A Reader object providing the underlying stream. Must not be |
Type | Description |
---|---|
object | A new filter based on this configuration, but filtering the specified reader |


close(
)
:
void
Close stream.
Inherited from: \FilterReader::close()\BaseFilterReader::close()\BaseParamFilterReader::close()Exception | Description |
---|---|
\IOException | if there is an error closing stream |


createToken(
)
:
object
Adds a token element to the map of tokens to replace.
Type | Description |
---|---|
object | The token added to the map of replacements. Must not be <code>null</code>. |


createTokensource(
)
:
object
Adds a token source to the sources of this filter.
Type | Description |
---|---|
object | A Reference to the source just added. |


eof(
)
:
boolean
Returns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()Type | Description |
---|---|
boolean |


getBeginToken(
)
:
string
Returns the "begin token" character.
Type | Description |
---|---|
string | The character used to denote the beginning of a token. |


getEndToken(
)
:
\the
Returns the "end token" character.
Type | Description |
---|---|
\the | character used to denote the beginning of a token |


getInitialized(
)
:
boolean
Returns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()Type | Description |
---|---|
boolean | whether or not the filter is initialized |


getProject(
)
:
object
Returns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()Type | Description |
---|---|
object | The project this filter is part of |


getResource(
)
:
string
Returns the filename, url, etc. that is being read from.
Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()\BaseParamFilterReader::getResource()This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
Type | Description |
---|---|
string |


getTokens(
)
:
array
Returns the map of tokens which will be replaced.
; used by ReplaceTokens::chain()
Type | Description |
---|---|
array | A map (String->String) of token keys to replacement values. |


getTokensources(
)
:
array
Returns the token sources used by this filter; used by ReplaceTokens::chain()
Type | Description |
---|---|
array |


log(
string $msg, int $level
=
Project::MSG_INFO
)
:
void
Convenience method to support logging in filters.
Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()Name | Type | Description |
---|---|---|
$msg | string | Message to log. |
$level | int | Priority level. |


mark(
)
:
void
If supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()\BaseParamFilterReader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).


markSupported(
)
:
boolean
Whether marking is supported.
Inherited from: \Reader::markSupported()\FilterReader::markSupported()\BaseFilterReader::markSupported()\BaseParamFilterReader::markSupported()Type | Description |
---|---|
boolean |


read(
\off $len
=
null
)
:
mixed
Returns stream with tokens having been replaced with appropriate values.
If a replacement value is not found for a token, the token is left in the stream.
Name | Type | Description |
---|---|---|
$len | \off | Offset at which to start storing characters. |
Type | Description |
---|---|
mixed | filtered stream, -1 on EOF. |
Exception | Description |
---|---|
\IOException | If an I/O error occurs |


readLine(
)
:
\the
Reads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()\BaseParamFilterReader::readLine()The returned String retains the '\n'.
Type | Description |
---|---|
\the | line read, or <code>null</code> if the end of the stream has already been reached |
Exception | Description |
---|---|
\IOException | if the underlying reader throws one during reading |


ready(
)
:
boolean
Is stream ready for reading.
Inherited from: \Reader::ready()\FilterReader::ready()\BaseFilterReader::ready()\BaseParamFilterReader::ready()Type | Description |
---|---|
boolean |


replaceTokenCallback(
array $matches
)
:
string
Performs lookup on key and returns appropriate replacement string.
Name | Type | Description |
---|---|---|
$matches | array | Array of 1 el containing key to search for. |
Type | Description |
---|---|
string | Text with which to replace key or value of key if none is found. |
- Access
- private


reset(
)
:
void
Reset the current position in stream to beginning or last mark (if supported).
Inherited from: \FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()

setBeginToken(
string $beginToken
)
:
void
Sets the "begin token" character.
Name | Type | Description |
---|---|---|
$beginToken | string | the character used to denote the beginning of a token. |


setEndToken(
string $endToken
)
:
void
Sets the "end token" character.
Name | Type | Description |
---|---|---|
$endToken | string | the character used to denote the end of a token |


setInitialized(
boolean $initialized
)
:
void
Sets the initialized status.
Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()Name | Type | Description |
---|---|---|
$initialized | boolean | Whether or not the filter is initialized. |


setParameters(
$parameters
)
:
void
Name | Type | Description |
---|---|---|
$parameters |


setProject(
object $project
)
:
void
Sets the project to work with.
Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()Name | Type | Description |
---|---|---|
$project | object | The project this filter is part of. Should not be |


setReader(
$in
)
:
void
Name | Type | Description |
---|---|---|
$in |


setTokens(
array $tokens
)
:
void
Sets the map of tokens to replace.
; used by ReplaceTokens::chain()
Name | Type | Description |
---|---|---|
$tokens | array | A map (String->String) of token keys to replacement values. Must not be |


setTokensources(
array $sources
)
:
void
Sets the tokensources to use; used by ReplaceTokens::chain()
Name | Type | Description |
---|---|---|
$sources | array | An array of token sources. |


skip(
int $n
)
:
void
Move stream position relative to current pos.
Inherited from: \FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()Name | Type | Description |
---|---|---|
$n | int |
\Token
Holds a token.
Properties
Methods


addText(
string $value
)
:
void
Sets the token value from text.
Name | Type | Description |
---|---|---|
$value | string | The value for this token. Must not be |


getKey(
)
:
string
Returns the key for this token.
Type | Description |
---|---|
string | The key for this token. |


getValue(
)
:
string
Returns the value for this token.
Type | Description |
---|---|
string | The value for this token. |


setKey(
string $key
)
:
void
Sets the token key.
Name | Type | Description |
---|---|---|
$key | string | The key for this token. Must not be |