system/io/FilterReader.php
Show:
inherited
inherited
Classes
Wrapper class for readers, which can be used to apply filters.
- Package
- phing.system.io
\FilterReader
Package: phing\system\io
Returns
Parameters
Wrapper class for readers, which can be used to apply filters.
- Parent(s)
- \Reader
- Children
- \BaseFilterReader
- Author
- Hans Lellelid
- Author
- Yannick Lecaillez
- Version
- $Id$
Properties
Methods
__construct(
$in
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $in |
close(
)
:
voidClose stream.
Throws
| Exception | Description |
|---|---|
| \IOException | if there is an error closing stream |
getResource(
)
:
stringReturns the filename, url, etc. that is being read from.
This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
| Type | Description |
|---|---|
| string |
mark(
)
:
void
inherited
If supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported(
)
:
boolean
Returns
| Type | Description |
|---|---|
| boolean |
read(
int $len
=
null
)
:
voidRead data from source.
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 | int |
ready(
)
:
boolean
Returns
| Type | Description |
|---|---|
| boolean |
reset(
)
:
voidReset the current position in stream to beginning or last mark (if supported).
setReader(
$in
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $in |
skip(
int $n
)
:
voidMove stream position relative to current pos.
Parameters
| Name | Type | Description |
|---|---|---|
| $n | int |