Base class for core filter readers.
author | <a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a> |
---|---|
version | $Id$ |
access | public |
see | \global\FilterReader |
package | phing.filters |
__construct(\Reader $in)
The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.
\Reader
close()
eof() : boolean
boolean
getInitialized() : boolean
boolean
whether or not the filter is initializedgetProject() : object
object
The project this filter is part ofgetResource() : string
that is being read from. This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
inherited_from | \FilterReader::getResource() |
---|
string
log(string $msg, int $level)
string
Message to log.
int
Priority level.
mark()
A subsequent call to reset() will move stream position back to last marker (if supported).
inherited_from | \Reader::mark() |
---|---|
inherited_from | \FilterReader::mark() |
markSupported() : boolean
inherited_from | \Reader::markSupported() |
---|---|
inherited_from | \FilterReader::markSupported() |
boolean
read(\off $len) : \Characters
FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.
\off
Offset at which to start storing characters.
\IOException |
If an I/O error occurs |
---|
\Characters
read, or -1 if the end of the stream
has been reachedreadLine() : \the
The returned String retains the '\n'.
\IOException |
if the underlying reader throws one during reading |
---|
\the
line read, or null
if the end of the
stream has already been reachedready() : boolean
inherited_from | \Reader::ready() |
---|---|
inherited_from | \FilterReader::ready() |
boolean
reset()
inherited_from | \FilterReader::reset() |
---|
setInitialized(boolean $initialized)
boolean
Whether or not the filter is initialized.
setProject(\Project $project)
object
The project this filter is part of. Should not be null
.
setReader(\Reader $in)
inherited_from | \FilterReader::setReader() |
---|
skip(int $n)
inherited_from | \FilterReader::skip() |
---|
int
$initialized
$project