system/io/InputStream.php
inherited
Classes
Wrapper class for PHP stream that supports read operations.
- Package
- phing.system.io
\InputStream
Wrapper class for PHP stream that supports read operations.
- Children
- \FileInputStream
Properties
int
$currentPosition= '0'
0Details- Type
- int
int
$mark= '0'
0Details- Type
- int
resource
$stream= ''
- Type
- resource
Methods
__construct(
resource $stream
)
:
voidConstruct a new InputStream.
| Name | Type | Description |
|---|---|---|
| $stream | resource | Configured PHP stream for writing. |
__toString(
)
:
stringReturns string representation of attached stream.
| Type | Description |
|---|---|
| string |
close(
)
:
voidCloses stream.
| Exception | Description |
|---|---|
| \IOException | if stream cannot be closed (note that calling close() on an already-closed stream will not raise an exception) |
eof(
)
:
booleanWhether eof has been reached with stream.
| Type | Description |
|---|---|
| boolean |
mark(
)
:
voidMarks the current position in this input stream.
| Exception | Description |
|---|---|
| \IOException | - if the underlying stream doesn't support this method. |
markSupported(
)
:
booleanWhether the input stream supports mark and reset methods.
| Type | Description |
|---|---|
| boolean |
read(
int $len
=
null
)
:
stringRead data from stream until $len chars or EOF.
| Name | Type | Description |
|---|---|---|
| $len | int | Num chars to read. If not specified this stream will read until EOF. |
| Type | Description |
|---|---|
| string | chars read or -1 if eof. |
readInto(
string $rBuffer
)
:
TRUEReads a entire until EOF and places contents in passed-in variable. Stream is closed after read.
| Name | Type | Description |
|---|---|---|
| $rBuffer | string | &$rBuffer String variable where read contents will be put. |
| Type | Description |
|---|---|
| TRUE | on success. |
| Exception | Description |
|---|---|
| \IOException | - if there is an error reading from stream. |
- Author
- Charlie Killian, charlie@tizac.com
- Deprecated
- - Instead, use the read() method or a BufferedReader.
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 |