# filters/ReplaceTokens.php

## \ReplaceTokens
jump to top

Package: phing\filters

Replaces tokens in the original input with user-supplied values.

Example:

    ;

Or:

Implements
  \ChainableReader
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
  $Revision: 1039 $ $Date: 2011-02-20 20:19:21 +0100 (Sun, 20 Feb 2011) $

### Constants

`string DEFAULT_BEGIN_TOKEN = "@"`

Default "begin token" character.

  string

`string DEFAULT_END_TOKEN = "@"`

Default "end token" character.

  string

### Properties

`array $_alltokens= 'null'`

Array holding all tokens given directly to the Filter and those passed via a TokenSource.

Default value `null` Details

Type
  array

`string $_beginToken= '"@"'`

Character marking the beginning of a token.

Default value`"@"`Details

Type
  string

`string $_endToken= '"@"'`

Character marking the end of a token.

Default value`"@"`Details

Type
  string

`$_parameters= 'array()'`
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$_parameters
Default value `array()`Details

Type
Inherited_from
  \BaseParamFilterReader::$_parameters

`string $_queuedData= 'null'`

[Deprecated] Data that must be read from, if not null.

Default value `null` Details

Type
  string

`array $_tokens= 'array()'`

Array to hold the replacee-replacer pairs (String to String).

Default value `array()`Details

Type
  array

`array $_tokensources= 'array()'`

Array to hold the token sources that make tokens from different sources available

Default value `array()`Details

Type
  array

`\Reader $in= ''`
inherited

Inherited from: \FilterReader::$in
Details

Type
  \Reader
Inherited_from
  \FilterReader::$in

`$initialized= 'false'`
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$initialized
Default value `false` Details

Type
Inherited_from
  \BaseFilterReader::$initialized

`$project= 'null'`
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$project
Default value `null` Details

Type
Inherited_from
  \BaseFilterReader::$project

### Methods

`__construct( \Reader $in = null ) : void`
inherited

Constructor used by Phing's introspection mechanism.

Inherited from: \BaseFilterReader::__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.

Parameters

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 tag in build file.

`chain( object $reader ) : object`

Creates a new ReplaceTokens using the passed in Reader for instantiation.

Parameters

Name | Type | Description
--- | --- | ---
$reader | object | A Reader object providing the underlying stream. Must not be `null`.

Returns

Type | Description
--- | ---
object | A new filter based on this configuration, but filtering the specified reader

`close( ) : void`
inherited

Close stream.

Inherited from: \FilterReader::close()
Throws

Exception | Description
--- | ---
\IOException | if there is an error closing stream

`createToken( ) : object`

Adds a token element to the map of tokens to replace.

Returns

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.

Returns

Type | Description
--- | ---
object | A Reference to the source just added.

`eof( ) : boolean`
inherited

Returns whether the end of file has been reached with input stream.

Inherited from: \BaseFilterReader::eof()
Returns

Type | Description
--- | ---
boolean |

`getBeginToken( ) : string`

Returns the "begin token" character.

Returns

Type | Description
--- | ---
string | The character used to denote the beginning of a token.

`getEndToken( ) : \the`

Returns the "end token" character.

Returns

Type | Description
--- | ---
\the | character used to denote the beginning of a token

`getInitialized( ) : boolean`
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()
Returns

Type | Description
--- | ---
boolean | whether or not the filter is initialized

`getParameters( ) : void`
inherited

Inherited from: \BaseParamFilterReader::getParameters()
`getProject( ) : object`
inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()
Returns

Type | Description
--- | ---
object | The project this filter is part of

`getResource( ) : string`
inherited

Returns the filename, url, etc. that is being read from.

Inherited from: \FilterReader::getResource()

This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.

Returns

Type | Description
--- | ---
string |

`getTokens( ) : array`

Returns the map of tokens which will be replaced.

; used by ReplaceTokens::chain()

Returns

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

Returns

Type | Description
--- | ---
array |

`log( string $msg, int $level = Project::MSG_INFO ) : void`
inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()
Parameters

Name | Type | Description
--- | --- | ---
$msg | string | Message to log.
$level | int | Priority level.

`mark( ) : void`
inherited

If supported, places a "marker" (like a bookmark) at current stream position.

Inherited from: \Reader::mark()

A subsequent call to reset() will move stream position back to last marker (if supported).

`markSupported( ) : boolean`
inherited

Whether marking is supported.

Inherited from: \Reader::markSupported()
Returns

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.

Parameters

Name | Type | Description
--- | --- | ---
$len | \off | Offset at which to start storing characters.

Returns

Type | Description
--- | ---
mixed | filtered stream, -1 on EOF.

Throws

Exception | Description
--- | ---
\IOException | If an I/O error occurs

`readLine( ) : \the`
inherited

Reads a line of text ending with '\n' (or until the end of the stream).

Inherited from: \BaseFilterReader::readLine()

The returned String retains the '\n'.

Returns

Type | Description
--- | ---
\the | line read, or <code>null</code> if the end of the stream has already been reached

Throws

Exception | Description
--- | ---
\IOException | if the underlying reader throws one during reading

`ready( ) : boolean`
inherited

Is stream ready for reading.

Inherited from: \Reader::ready()
Returns

Type | Description
--- | ---
boolean |

`replaceTokenCallback( array $matches ) : string`

Performs lookup on key and returns appropriate replacement string.

Parameters

Name | Type | Description
--- | --- | ---
$matches | array | Array of 1 el containing key to search for.

Returns

Type | Description
--- | ---
string | Text with which to replace key or value of key if none is found.

Details

Access
  private

`reset( ) : void`
inherited

Reset the current position in stream to beginning or last mark (if supported).

Inherited from: \FilterReader::reset()
`setBeginToken( string $beginToken ) : void`

Sets the "begin token" character.

Parameters

Name | Type | Description
--- | --- | ---
$beginToken | string | the character used to denote the beginning of a token.

`setEndToken( string $endToken ) : void`

Sets the "end token" character.

Parameters

Name | Type | Description
--- | --- | ---
$endToken | string | the character used to denote the end of a token

`setInitialized( boolean $initialized ) : void`
inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()
Parameters

Name | Type | Description
--- | --- | ---
$initialized | boolean | Whether or not the filter is initialized.

`setParameters( $parameters ) : void`
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters

Name | Type | Description
--- | --- | ---
$parameters |  |

`setProject( object $project ) : void`
inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | object | The project this filter is part of. Should not be `null`.

`setReader( $in ) : void`
inherited

Inherited from: \FilterReader::setReader()
Parameters

Name | Type | Description
--- | --- | ---
$in |  |

`setTokens( array $tokens ) : void`

Sets the map of tokens to replace.

; used by ReplaceTokens::chain()

Parameters

Name | Type | Description
--- | --- | ---
$tokens | array | A map (String->String) of token keys to replacement values. Must not be `null`.

`setTokensources( array $sources ) : void`

Sets the tokensources to use; used by ReplaceTokens::chain()

Parameters

Name | Type | Description
--- | --- | ---
$sources | array | An array of token sources.

`skip( int $n ) : void`
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()
Parameters

Name | Type | Description
--- | --- | ---
$n | int |

## \Token
jump to top

Package: phing\filters

Holds a token.

### Properties

`string $_key= ''`

Token key.

Details

Type
  string

`string $_value= ''`

Token value.

Details

Type
  string

### Methods

`addText( string $value ) : void`

Sets the token value from text.

Parameters

Name | Type | Description
--- | --- | ---
$value | string | The value for this token. Must not be `null`.

`getKey( ) : string`

Returns the key for this token.

Returns

Type | Description
--- | ---
string | The key for this token.

`getValue( ) : string`

Returns the value for this token.

Returns

Type | Description
--- | ---
string | The value for this token.

`setKey( string $key ) : void`

Sets the token key.

Parameters

Name | Type | Description
--- | --- | ---
$key | string | The key for this token. Must not be `null`.

`setValue( string $value ) : void`

Sets the token value.

Parameters

Name | Type | Description
--- | --- | ---
$value | string | The value for this token. Must not be `null`.

Documentation was generated by DocBlox 0.15.1.