system/io/Reader.php
Abstract class for reading character streams.
- Author
- Hans Lellelid
- Author
- Yannick Lecaillez
- Package
- phing.system.io
- Version
- $Id$
\Reader
Package: phing\system\io
Returns
Parameters
Abstract class for reading character streams.
- Children
- \BufferedReader
- \InputStreamReader
- \FilterReader
- \StringReader
- \ConsoleReader
- Author
- Hans Lellelid
- Author
- Yannick Lecaillez
- Version
- $Id$
Methods


close(
)
:
void
abstract
Close stream.
Throws
Exception | Description |
---|---|
\IOException | if there is an error closing stream |


getResource(
)
:
string
abstract
Returns 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
If supported, places a "marker" (like a bookmark) at current stream position.
A subsequent call to reset() will move stream position back to last marker (if supported).


read(
int $len
=
null
)
:
void
abstract
Read data from source.
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
Name | Type | Description |
---|---|---|
$len | int |