Attaches a prefix to every line.
Example:
Or:
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id: 71f5cbabef2b2bfd436cd79187e0cecd172d10a2 $ |
see | |
package |
phing.filters |
_initialize()
close()
throws |
if there is an error closing stream |
---|---|
eof() : boolean
boolean
getInitialized() : boolean
boolean
whether or not the filter is initialized
getParameters() : array
array
the parameters to be used by this filter
getPrefix() : string
string
The prefix which will be added at the start of each input line
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
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
reset()
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
.
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.
setProject(object|\Project $project)
skip(integer $n)
integer
PREFIX_KEY
var |
---|
_prefix : string
var |
---|
string
_parameters : array
var |
---|
array
initialized :
project :