filters/ReplaceTokens.php

Show: inherited
Table of Contents

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

Package: phing\filters

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

Constantstring  DEFAULT_BEGIN_TOKEN = "@"

Default "begin token" character.

string
Constantstring  DEFAULT_END_TOKEN = "@"

Default "end token" character.

string

Properties

Propertyprivatearray  $_alltokens= 'null'

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

Default valuenullDetails
Type
array
Propertyprivatestring  $_beginToken= '"@"'

Character marking the beginning of a token.

Default value"@"Details
Type
string
Propertyprivatestring  $_endToken= '"@"'

Character marking the end of a token.

Default value"@"Details
Type
string
Propertyprotected  $_parameters= 'array()'
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$$_parameters
Default valuearray()Details
Type
n/a
Inherited_from
\BaseParamFilterReader::$$_parameters  
Propertyprivatestring  $_queuedData= 'null'

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

Default valuenullDetails
Type
string
Propertyprivatearray  $_tokens= 'array()'

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

Default valuearray()Details
Type
array
Propertyprivatearray  $_tokensources= 'array()'

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

Default valuearray()Details
Type
array
Propertyprotected\Reader  $in= ''
Details
Type
\Reader
Inherited_from
\FilterReader::$$in  
Inherited_from
\BaseFilterReader::$$in  
Inherited_from
\BaseParamFilterReader::$$in  
Propertyprotected  $initialized= 'false'
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initialized
Default valuefalseDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$initialized  
Inherited_from
\BaseParamFilterReader::$$initialized  
Propertyprotected  $project= 'null'
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$project
Default valuenullDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$project  
Inherited_from
\BaseParamFilterReader::$$project  

Methods

methodpublic__construct( \Reader $in = null ) : void
inherited

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.

Parameters
Name Type Description
$in \Reader
methodprivate_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.

methodpublicchain( 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
methodpublicclose( ) : void
Throws
Exception Description
\IOException if there is an error closing stream
methodpubliccreateToken( ) : 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>.
methodpubliccreateTokensource( ) : object

Adds a token source to the sources of this filter.

Returns
Type Description
object A Reference to the source just added.
methodpubliceof( ) : boolean
inherited

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

Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()
Returns
Type Description
boolean
methodpublicgetBeginToken( ) : string

Returns the "begin token" character.

Returns
Type Description
string The character used to denote the beginning of a token.
methodpublicgetEndToken( ) : \the

Returns the "end token" character.

Returns
Type Description
\the character used to denote the beginning of a token
methodpublicgetInitialized( ) : boolean
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()
Returns
Type Description
boolean whether or not the filter is initialized
methodpublicgetParameters( ) : void
inherited

Inherited from: \BaseParamFilterReader::getParameters()
methodpublicgetProject( ) : object
inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()
Returns
Type Description
object The project this filter is part of
methodpublicgetResource( ) : string
inherited

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.

Returns
Type Description
string
methodpublicgetTokens( ) : 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.
methodpublicgetTokensources( ) : array

Returns the token sources used by this filter; used by ReplaceTokens::chain()

Returns
Type Description
array
methodpubliclog( string $msg, int $level = Project::MSG_INFO ) : void
inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()
Parameters
Name Type Description
$msg string

Message to log.

$level int

Priority level.

methodpublicmark( ) : void
inherited

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

methodpublicmarkSupported( ) : boolean
Returns
Type Description
boolean
methodpublicread( \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
methodpublicreadLine( ) : \the
inherited

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

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
methodpublicready( ) : boolean
Returns
Type Description
boolean
methodprivatereplaceTokenCallback( 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  
methodpublicreset( ) : void
inherited

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

Inherited from: \FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()
methodpublicsetBeginToken( string $beginToken ) : void

Sets the "begin token" character.

Parameters
Name Type Description
$beginToken string

the character used to denote the beginning of a token.

methodpublicsetEndToken( string $endToken ) : void

Sets the "end token" character.

Parameters
Name Type Description
$endToken string

the character used to denote the end of a token

methodpublicsetInitialized( boolean $initialized ) : void
inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()
Parameters
Name Type Description
$initialized boolean

Whether or not the filter is initialized.

methodpublicsetParameters(  $parameters ) : void
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters
Name Type Description
$parameters
methodpublicsetProject( object $project ) : void
inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()
Parameters
Name Type Description
$project object

The project this filter is part of. Should not be null.

methodpublicsetReader(  $in ) : void
Parameters
Name Type Description
$in
methodpublicsetTokens( 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.

methodpublicsetTokensources( array $sources ) : void

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

Parameters
Name Type Description
$sources array

An array of token sources.

methodpublicskip( int $n ) : void
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()
Parameters
Name Type Description
$n int

\Token

Package: phing\filters

Holds a token.

Properties

Propertyprivatestring  $_key= ''

Token key.

Details
Type
string
Propertyprivatestring  $_value= ''

Token value.

Details
Type
string

Methods

methodpublicaddText( string $value ) : void

Sets the token value from text.

Parameters
Name Type Description
$value string

The value for this token. Must not be null.

methodpublicgetKey( ) : string

Returns the key for this token.

Returns
Type Description
string The key for this token.
methodpublicgetValue( ) : string

Returns the value for this token.

Returns
Type Description
string The value for this token.
methodpublicsetKey( string $key ) : void

Sets the token key.

Parameters
Name Type Description
$key string

The key for this token. Must not be null.

methodpublicsetValue( 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.18.1.