Replaces tokens in the original input with user-supplied values.
Example:
;
Or:
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id: d83036de1df3622348c9d43dc79147e2af56124b $ |
see | |
package |
phing.filters |
_initialize()
This method is only called when this filter is used through
a
close()
throws |
if there is an error closing stream |
---|---|
createToken() : object
object
The token added to the map of replacements.
Must not be null
.
createTokensource() : object
object
A Reference to the source just added.
eof() : boolean
boolean
getBeginToken() : string
string
The character used to denote the beginning of a token.
getEndToken() : \the
\the
character used to denote the beginning of a token
getInitialized() : boolean
boolean
whether or not the filter is initialized
getParameters() : array
array
the parameters to be used by this filter
getProject() : object
object
The project this filter is part of
getResource() : string
This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
string
getTokens() : array
; used by ReplaceTokens::chain()
array
A map (String->String) of token keys to replacement values.
getTokensources() : array
array
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
Message to log.
integer
Priority level.
mark()
A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported() : boolean
boolean
read(integer $len = null)
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
integer
readLine() : string
The returned String retains the '\n'.
throws |
if the underlying reader throws one during reading |
---|---|
string
the line read, or null
if the end of the
stream has already been reached
ready() : boolean
boolean
replaceTokenCallback(array $matches) : string
array
Array of 1 el containing key to search for.
string
Text with which to replace key or value of key if none is found.
reset()
setBeginToken(string $beginToken)
string
the character used to denote the beginning of a token.
setEndToken(string $endToken)
string
the character used to denote the end of a token
setInitialized(boolean $initialized)
boolean
Whether or not the filter is initialized.
setParameters(array $parameters) : void
throws |
---|
array
Array of parameters to be used by this filter.
Should not be null
.
setProject(object|\Project $project)
skip(integer $n)
integer
DEFAULT_BEGIN_TOKEN
var |
---|
DEFAULT_END_TOKEN
var |
---|
_queuedData : string
var |
---|
string
_tokens : array
var |
---|
array
_tokensources : array
var |
---|
array
_alltokens : array
var |
---|
array
_beginToken : string
var |
---|
string
_endToken : string
var |
---|
string
_parameters : array
var |
---|
array
initialized :
project :