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 reccomended to make it work on top of a buffered reader.
| 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
readChar()
chain(\Reader $reader) : \a
\anew filter based on this configuration, but filtering the specified reader
getInitialized() : boolean
booleanwhether or not the filter is initialized
setInitialized(boolean $initialized)
booleanWhether or not the filter is initialized.
setProject(object $project)
objectThe project this filter is part of.
Should not be null.
getProject() : object
objectThe project this filter is part of
readLine() : \the
The returned String retains the '\n'.
| throws |
if the underlying reader throws one during reading |
|---|
\theline read, or null if the end of the
stream has already been reached
eof() : boolean
boolean
log(string $msg, int $level = \Project::MSG_INFO)
stringMessage to log.
intPriority 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
_readAheadCh :
_inString : boolean
| var |
|---|
boolean
initialized :
project :