classes/phing/filters/BaseFilterReader.php
Classes
\BaseFilterReader
Base class for core filter readers.
- Extends from
- \FilterReader
- see
- \FilterReader
- access
- public
- author
- Yannick Lecaillez
- package
- phing.filters
- version
- $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
Properties
$initialized= 'false'
Have the parameters passed been interpreted?
falseDetails- Type
$project= 'null'
The Phing project this filter is part of.
nullDetails- Type
Methods
__construct(
\Reader $in
=
null
)
:
Constructor 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 |
getProject(
)
:
objectReturns the project this filter is part of.
| Type | Description |
|---|---|
| object |
log(
string $msg, int $level
=
Project
)
:
Convenience method to support logging in filters.
| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
read(
\off $len
=
null
)
:
\CharactersReads characters.
| Name | Type | Description |
|---|---|---|
| $len | \off | Offset at which to start storing characters. |
| Type | Description |
|---|---|
| \Characters |
- throws
- 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 |
- throws
- if the underlying reader throws one during reading
setInitialized(
boolean $initialized
)
:
Sets the initialized status.
| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setProject(
object $project
)
:
Sets the project to work with.
| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |