filters/BaseParamFilterReader.php
Base class for core filter readers.
- Access
- public
- Author
- Yannick Lecaillez
- Copyright
- � 2003 seasonfive. All rights reserved
- Package
- phing.filters
- See
- \FilterReader
- Version
- $Id$
\BaseParamFilterReader
Base class for core filter readers.
- Parent(s)
- \BaseFilterReader < \FilterReader < \Reader
- Children
- \XincludeFilter
- \TailFilter
- \TranslateGettext
- \IconvFilter
- \TabToSpaces
- \LineContainsRegexp
- \HeadFilter
- \LineContains
- \ReplaceTokensWithFile
- \StripLineComments
- \PrefixLines
- \StripLineBreaks
- \XsltFilter
- \ReplaceTokens
- \TidyFilter
- See
- \FilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Copyright
- � 2003 seasonfive. All rights reserved
- Version
- $Id$
Properties


\Reader
$in= ''
- Type
- \Reader
- Inherited_from
- \FilterReader::$$in
- Inherited_from
- \BaseFilterReader::$$in


$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initializedfalse
Details- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
Methods


__construct(
\Reader $in
=
null
)
:
void
Constructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()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.
Name | Type | Description |
---|---|---|
$in | \Reader |


eof(
)
:
boolean
Returns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()Type | Description |
---|---|
boolean |


getInitialized(
)
:
boolean
Type | Description |
---|---|
boolean | whether or not the filter is initialized |


getProject(
)
:
object
Returns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()Type | Description |
---|---|
object | The project this filter is part of |


getResource(
)
:
string
Returns the filename, url, etc. that is being read from.
Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
Type | Description |
---|---|
string |


log(
string $msg, int $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | Message to log. |
$level | int | Priority level. |


mark(
)
:
void
If supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).


markSupported(
)
:
boolean
Whether marking is supported.
Inherited from: \Reader::markSupported()\FilterReader::markSupported()\BaseFilterReader::markSupported()Type | Description |
---|---|
boolean |


read(
\off $len
=
null
)
:
\Characters
FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.
Name | Type | Description |
---|---|---|
$len | \off | Offset at which to start storing characters. |
Type | Description |
---|---|
\Characters | read, or -1 if the end of the stream has been reached |
Exception | Description |
---|---|
\IOException | If an I/O error occurs |


readLine(
)
:
\the
Reads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()The returned String retains the '\n'.
Type | Description |
---|---|
\the | line read, or <code>null</code> if the end of the stream has already been reached |
Exception | Description |
---|---|
\IOException | if the underlying reader throws one during reading |


ready(
)
:
boolean
Is stream ready for reading.
Inherited from: \Reader::ready()\FilterReader::ready()\BaseFilterReader::ready()Type | Description |
---|---|
boolean |


reset(
)
:
void
Reset the current position in stream to beginning or last mark (if supported).
Inherited from: \FilterReader::reset()\BaseFilterReader::reset()

setInitialized(
boolean $initialized
)
:
void
Name | Type | Description |
---|---|---|
$initialized | boolean | Whether or not the filter is initialized. |


setProject(
object $project
)
:
void
Name | Type | Description |
---|---|---|
$project | object | The project this filter is part of. Should not be |


skip(
int $n
)
:
void
Move stream position relative to current pos.
Inherited from: \FilterReader::skip()\BaseFilterReader::skip()Name | Type | Description |
---|---|---|
$n | int |