system/io/InputStreamReader.php
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
)
:
void
Construct a new InputStreamReader.
Name | Type | Description |
---|---|---|
$inStream |


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


getResource(
)
:
string
Returns 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(
)
:
void
Marks 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(
)
:
boolean
Whether the attached stream supports mark/reset.
Type | Description |
---|---|
boolean |


read(
int $len
=
null
)
:
string
Read 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
)
:
TRUE
Reads 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.


reset(
)
:
void
Repositions 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. |