This filter strips line comments.
Example:
Or:
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id: c39d25705eee8f7dafb42f62f4a6c812bb6fbdf4 $ |
access |
public |
see | |
package |
phing.filters |
_initialize()
chain(\Reader $reader) : \StripLineComments
close()
throws |
if there is an error closing stream |
---|---|
createComment()
eof() : boolean
boolean
getComments() : array
array
getInitialized() : boolean
boolean
whether or not the filter is initialized
getParameters() : array
array
the parameters to be used by this filter
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
|
---|---|
string
the line read, or null
if the end of the
stream has already been reached
ready() : boolean
boolean
reset()
setComments( $lineBreaks)
throws | |
---|---|
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>.
setProject(object|\Project $project)
skip(integer $n)
integer
COMMENTS_KEY
_parameters : array
var |
---|
array
initialized :
project :
Array that holds the comment prefixes.
Type(s)