classes/phing/system/io/Reader.php
Classes
Abstract class for reading character streams.
- author
- Hans Lellelid
- author
- Yannick Lecaillez
- package
- phing.system.io
- version
- $Revision: 552 $
\Reader
Abstract class for reading character streams.
- author
- Hans Lellelid
- author
- Yannick Lecaillez
- package
- phing.system.io
- version
- $Revision: 552 $
Methods
close(
)
:
abstractClose stream.
- throws
- if there is an error closing stream
getResource(
)
:
string
abstractReturns 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(
)
:
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).
markSupported(
)
:
booleanWhether marking is supported.
| Type | Description |
|---|---|
| boolean |
read(
int $len
=
null
)
:
abstractRead 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 |
ready(
)
:
booleanIs stream ready for reading.
| Type | Description |
|---|---|
| boolean |
reset(
)
:
Reset the current position in stream to beginning or last mark (if supported).
skip(
int $n
)
:
Move stream position relative to current pos.
| Name | Type | Description |
|---|---|---|
| $n | int |