Attaches a prefix to every line.
Example:
Or:
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id$ |
access |
public |
see | |
package |
phing.filters |
read(int $len = null)
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
int
setPrefix(string $prefix)
string
The prefix to add at the start of each input line.
May be null
, in which case no prefix
is added.
getPrefix() : string
string
The prefix which will be added at the start of each input line
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
PREFIX_KEY
var |
---|
_prefix : string
var |
---|
string
_parameters :
initialized :
project :