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 |
setTranslateHTML($translate)
getTranslateHTML()
setDir(string $dir)
string
getDir()
setPrefix(string $prefix)
string
getPrefix()
setPostfix(string $postfix)
string
getPostfix()
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
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
chain(\Reader $reader) : object
object
A new filter based on this configuration, but filtering the specified reader
_initialize()
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 |
---|
_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 :
initialized :
project :