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: d879379fbd9148e8a913afc833f5529dc08c0b63 $ |
access |
public |
see | |
package |
phing.filters |
_initialize()
close()
throws |
if there is an error closing stream |
---|---|
eof() : boolean
boolean
getBeginToken() : string
string
The character used to denote the beginning of a token.
getDir()
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
getPostfix()
getPrefix() : string
string
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
getTranslateHTML()
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
|
---|---|
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.
setDir(string $dir)
string
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 <code>null</code>.
setPostfix(string $postfix)
string
setPrefix(string $prefix)
string
setProject(object|\Project $project)
skip(integer $n)
integer
DEFAULT_BEGIN_TOKEN
var |
---|
DEFAULT_END_TOKEN
var |
---|
_tokensources : array
var |
---|
array
_beginToken : string
var |
---|
string
_endToken : string
var |
---|
string
_prefix : string
var |
---|
string
_postfix : string
var |
---|
string
_dir : string
var |
---|
string
_translatehtml : boolean
var |
---|
boolean
_parameters : array
var |
---|
array
initialized :
project :