Replaces tokens in the original input with user-supplied values.
Example:
;
Or:
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id: 6c5d97f2254de3c08ac34baaabf6119c54a49a7d $ |
access |
public |
see | |
package |
phing.filters |
replaceTokenCallback(array $matches) : string
access |
private |
---|
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.
read(int $len = null)
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
int
setBeginToken(string $beginToken)
string
the character used to denote the beginning of a token.
getBeginToken() : string
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
getEndToken() : \the
\the
character used to denote the beginning of a token
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.
setTokens($tokens)
; used by ReplaceTokens::chain()
getTokens() : array
; used by ReplaceTokens::chain()
array
A map (String->String) of token keys to replacement values.
setTokensources($sources)
getTokensources() : array
array
chain(\Reader $reader) : object
object
A new filter based on this configuration, but filtering the specified reader
_initialize()
This method is only called when this filter is used through
a
setParameters($parameters)
getParameters()
getInitialized() : boolean
boolean
whether or not the filter is initialized
setInitialized(boolean $initialized)
boolean
Whether or not the filter is initialized.
setProject(object $project)
object
The project this filter is part of.
Should not be null
.
getProject() : object
object
The project this filter is part of
readLine() : \the
The returned String retains the '\n'.
throws |
if the underlying reader throws one during reading |
---|
\the
line read, or null
if the end of the
stream has already been reached
eof() : boolean
boolean
log(string $msg, int $level = \Project::MSG_INFO)
string
Message to log.
int
Priority level.
skip(int $n)
int
reset()
close()
throws |
if there is an error closing stream |
---|
getResource() : string
This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
string
mark()
A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported() : boolean
boolean
ready() : boolean
boolean
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 :
initialized :
project :