This is a Php comment and string stripper reader that filters those lexical tokens out for purposes of simple Php parsing.
(if you have more complex Php parsing needs, use a real lexer). Since this class heavily relies on the single char read function, you are recommended to make it work on top of a buffered reader.
author | |
---|---|
author |
hans lellelid, hans@velum.net |
version |
$Id: c15c3abf6f4e37f99645ba0ac8cd720899572f12 $ |
see | |
package |
phing.filters |
close()
throws |
if there is an error closing stream |
---|---|
eof() : boolean
boolean
getInitialized() : boolean
boolean
whether or not the filter is initialized
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
readChar() : integer
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.
setProject(object|\Project $project)
skip(integer $n)
integer
_readAheadCh :
_inString : boolean
var |
---|
boolean
initialized :
project :