system/io/InputStreamReader.php
Show:
inherited
inherited
Classes
\InputStreamReader
Package: phing\system\io
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
Properties
Methods
__construct(
$inStream
)
:
voidConstruct a new InputStreamReader.
Parameters
| Name | Type | Description |
|---|---|---|
| $inStream |
close(
)
:
voidClose the stream.
eof(
)
:
booleanWhether eof has been reached with stream.
Returns
| Type | Description |
|---|---|
| boolean |
getResource(
)
:
stringReturns string representation of attached stream.
Returns
| Type | Description |
|---|---|
| string |
mark(
)
:
voidMarks the current position in this input stream.
Throws
| Exception | Description |
|---|---|
| \IOException | - if the underlying stream doesn't support this method. |
markSupported(
)
:
booleanWhether the attached stream supports mark/reset.
Returns
| Type | Description |
|---|---|
| boolean |
read(
int $len
=
null
)
:
stringRead data from file.
Parameters
Returns
| 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.
Parameters
Returns
Details
| 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(
)
:
voidreset(
)
:
voidRepositions this stream to the position at the time the mark method was last called on this input stream.
Throws
| Exception | Description |
|---|---|
| \IOException | - if the underlying stream doesn't support this method. |
skip(
int $n
)
:
voidSkip over $n bytes.
Parameters
| Name | Type | Description |
|---|---|---|
| $n | int |