filters/BaseFilterReader.php
inherited
Classes
Base class for core filter readers.
- Access
- public
- Author
- Yannick Lecaillez
- Package
- phing.filters
- See
- \FilterReader
- Version
- $Id$
\BaseFilterReader
Base class for core filter readers.
- Parent(s)
- \FilterReader < \Reader
- Children
- \StripPhpComments
- \ExpandProperties
- \BaseParamFilterReader
- \StripWhitespace
- \ReplaceRegexp
- See
- \FilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Version
- $Id$
Properties
\Reader
$in= ''
- Type
- \Reader
- Inherited_from
- \FilterReader::$$in
$initialized= 'false'
Have the parameters passed been interpreted?
falseDetails- Type
- n/a
$project= 'null'
The Phing project this filter is part of.
nullDetails- Type
- n/a
Methods
__construct(
\Reader $in
=
null
)
:
voidConstructor used by Phing's introspection mechanism.
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(
)
:
booleanReturns whether the end of file has been reached with input stream.
| Type | Description |
|---|---|
| boolean |
getInitialized(
)
:
booleanReturns the initialized status.
| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
getProject(
)
:
objectReturns the project this filter is part of.
| Type | Description |
|---|---|
| object | The project this filter is part of |
getResource(
)
:
stringReturns the filename, url, etc. that is being read from.
Inherited from: \FilterReader::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
)
:
voidConvenience method to support logging in filters.
| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
mark(
)
:
voidIf supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()\FilterReader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported(
)
:
booleanWhether marking is supported.
Inherited from: \Reader::markSupported()\FilterReader::markSupported()| Type | Description |
|---|---|
| boolean |
read(
\off $len
=
null
)
:
\CharactersReads 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(
)
:
\theReads a line of text ending with '\n' (or until the end of the stream).
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
| Type | Description |
|---|---|
| boolean |
reset(
)
:
voidReset the current position in stream to beginning or last mark (if supported).
Inherited from: \FilterReader::reset()setInitialized(
boolean $initialized
)
:
voidSets the initialized status.
| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setProject(
object $project
)
:
voidSets the project to work with.
| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |
setReader(
$in
)
:
void| Name | Type | Description |
|---|---|---|
| $in |
skip(
int $n
)
:
void
| Name | Type | Description |
|---|---|---|
| $n | int |