system/io/InputStreamReader.php
inherited
Classes
Writer class for OutputStream objects.
Unlike the Java counterpart, this class does not (yet) handle character set transformations. This will be an important function of this class with move to supporting PHP6.
- Package
- phing.system.io
\InputStreamReader
Writer class for OutputStream objects.
Unlike the Java counterpart, this class does not (yet) handle character set transformations. This will be an important function of this class with move to supporting PHP6.
- Parent(s)
- \Reader
- Children
- \FileReader
- Author
- Hans Lellelid
- Author
- Yannick Lecaillez
- Version
- $Id$
Properties
Methods
__construct(
$inStream
)
:
voidConstruct a new InputStreamReader.
| Name | Type | Description |
|---|---|---|
| $inStream |
close(
)
:
voidClose the stream.
| Exception | Description |
|---|---|
| \IOException | if there is an error closing stream |
eof(
)
:
booleanWhether eof has been reached with stream.
| Type | Description |
|---|---|
| boolean |
getResource(
)
:
stringReturns string representation of attached stream.
This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
| Type | Description |
|---|---|
| string |
mark(
)
:
voidMarks the current position in this input stream.
A subsequent call to reset() will move stream position back to last marker (if supported).
| Exception | Description |
|---|---|
| \IOException | - if the underlying stream doesn't support this method. |
markSupported(
)
:
booleanWhether the attached stream supports mark/reset.
| Type | Description |
|---|---|
| boolean |
read(
int $len
=
null
)
:
stringRead data from file.
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
| Name | Type | Description |
|---|---|---|
| $len | int | Num chars to read. |
| Type | Description |
|---|---|
| string | chars read or -1 if eof. |
readInto(
$rBuffer
)
:
TRUEReads a entire file and stores the data in the variable passed by reference.
| Name | Type | Description |
|---|---|---|
| $rBuffer |
| Type | Description |
|---|---|
| TRUE | on success. Err object on failure. |
- Author
- Charlie Killian, charlie@tizac.com
- Deprecated
- Use read() or BufferedReader instead.
ready(
)
:
boolean
| Type | Description |
|---|---|
| boolean |
reset(
)
:
voidRepositions this stream to the position at the time the mark method was last called on this input stream.
| Exception | Description |
|---|---|
| \IOException | - if the underlying stream doesn't support this method. |
skip(
int $n
)
:
voidSkip over $n bytes.
| Name | Type | Description |
|---|---|---|
| $n | int |