ReplaceTokensWithFile

Extends \BaseParamFilterReader Implements \ChainableReader

Replaces tokens in the original input with the contents of a file.

The file to be used is controlled by the name of the token which corresponds to the basename of the file to be used together with the optional pre and postfix strings that is possible to set.

By default all HTML entities in the file is replaced by the corresponding HTML entities. This behaviour can be controlled by the "translatehtml" parameter.

Supported parameters are:

 prefix         string Text to be prefixed to token before using as filename
 postfix        string Text to be prefixed to token before using as filename
 dir            string The directory where the files should be read from
 translatehtml  bool   If we should translate all HTML entities in the file.

Example:

author	johan persson, johanp@aditus.nu
version	$Id: 164a2d9eeba3673653086b32e9fa2045168c992c $
access	public
see
package	phing.filters

Methods

Sets the drectory where to look for the files to use for token replacement

setTranslateHTML($translate)

Arguments

$translate

Returns the drectory where to look for the files to use for token replacement

getTranslateHTML()

Sets the drectory where to look for the files to use for token replacement

setDir(string $dir)

Arguments

$dir

string

Returns the drectory where to look for the files to use for token replacement

getDir()

Sets the prefix that is prepended to the token in order to create the file name. For example if the token is 01 and the prefix is "example" then the filename to look for will be "example01"

setPrefix(string $prefix)

Arguments

$prefix

string

getPrefix

getPrefix()

Sets the postfix that is added to the token in order to create the file name. For example if the token is 01 and the postfix is ".php" then the filename to look for will be "01.php"

setPostfix(string $postfix)

Arguments

$postfix

string

Returns the postfix that is added to the token in order to create the file name. For example if the token is 01 and the postfix is ".php" then the filename to look for will be "01.php"

getPostfix()

Sets the "begin token" character.

setBeginToken(string $beginToken)

Arguments

$beginToken

string

the character used to denote the beginning of a token.

Returns the "begin token" character.

getBeginToken() : string

Response

string

The character used to denote the beginning of a token.

Sets the "end token" character.

setEndToken(string $endToken)

Arguments

$endToken

string

the character used to denote the end of a token

Returns the "end token" character.

getEndToken() : \the

Response

\the

character used to denote the beginning of a token

Replace the token found with the appropriate file contents

replaceTokenCallback(array $matches) : string

access	private

Arguments

$matches

array

Array of 1 el containing key to search for.

Response

string

Text with which to replace key or value of key if none is found.

Read data from source.

read(int $len = null)

inherited abstract

If length is specified, then only that number of chars is read, otherwise stream is read until EOF.

Arguments

$len

int

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

chain(\Reader $reader) : object

Arguments

$reader

\Reader

Response

object

A new filter based on this configuration, but filtering the specified reader

Initializes parameters This method is only called when this filter is used through a <filterreader> tag in build file.

_initialize()

setParameters

setParameters($parameters)

inherited

Arguments

$parameters

getParameters

getParameters()

inherited

__construct

__construct(\Reader $in = null)

inherited

Arguments

$in

\Reader

Returns the initialized status.

getInitialized() : boolean

inherited

Response

boolean

whether or not the filter is initialized

Sets the initialized status.

setInitialized(boolean $initialized)

inherited

Arguments

$initialized

boolean

Whether or not the filter is initialized.

Sets the project to work with.

setProject(object $project)

inherited

Arguments

$project

object

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

Returns the project this filter is part of.

getProject() : object

inherited

Response

object

The project this filter is part of

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

readLine() : \the

inherited

The returned String retains the '\n'.

throws	if the underlying reader throws one during reading

Response

\the

line read, or null if the end of the stream has already been reached

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

eof() : boolean

inherited

Response

boolean

Convenience method to support logging in filters.

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

inherited

Arguments

$msg

string

Message to log.

$level

int

Priority level.

setReader

setReader(\Reader $in)

inherited

Arguments

$in

\Reader

Move stream position relative to current pos.

skip(int $n)

inherited

Arguments

$n

int

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

reset()

inherited

Close stream.

close()

inherited abstract

throws	if there is an error closing stream

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

getResource() : string

inherited abstract

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

Response

string

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

mark()

inherited

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

Whether marking is supported.

markSupported() : boolean

inherited

Response

boolean

Is stream ready for reading.

ready() : boolean

inherited

Response

boolean

Constants

Default "begin token" character.

DEFAULT_BEGIN_TOKEN

var

Default "end token" character.

DEFAULT_END_TOKEN

var

Properties

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

_tokensources : array

var

Type(s)

array

Character marking the beginning of a token.

_beginToken : string

var

Type(s)

string

Character marking the end of a token.

_endToken : string

var

Type(s)

string

File prefix to be inserted in front of the token to create the file name to be used.

_prefix : string

var

Type(s)

string

File postfix to be inserted in front of the token to create the file name to be used.

_postfix : string

var

Type(s)

string

Directory where to look for the files. The default is to look in the current file.

_dir : string

var

Type(s)

string

Translate all HTML entities in the file to the corresponding HTML entities before it is used as replacements. For example all '<' will be translated to < before the content is inserted.

_translatehtml : boolean

var

Type(s)

boolean

The passed in parameter array.

_parameters :

inherited

Have the parameters passed been interpreted?

initialized :

inherited

The Phing project this filter is part of.

project :

inherited

in

in : \Reader

inherited

var

Type(s)

\Reader