# system/io/InputStreamReader.php

## \InputStreamReader
jump to top

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
Author
  Hans Lellelid
Author
  Yannick Lecaillez
Version
  $Revision: 552 $

### Properties

`\InputStream $inStream= ''`

Details

Type
  \InputStream

### Methods

`__construct( $inStream ) : void`

Construct a new InputStreamReader.

Parameters

Name | Type | Description
--- | --- | ---
$inStream |  |

`close( ) : void`

Close the stream.

Throws

Exception | Description
--- | ---
\IOException | if there is an error closing stream

`eof( ) : boolean`

Whether eof has been reached with stream.

Returns

Type | Description
--- | ---
boolean |

`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.

Returns

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).

Throws

Exception | Description
--- | ---
\IOException | - if the underlying stream doesn't support this method.

`markSupported( ) : boolean`

Whether the attached stream supports mark/reset.

Returns

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.

Parameters

Name | Type | Description
--- | --- | ---
$len | int | Num chars to read.

Returns

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.

Parameters

Name | Type | Description
--- | --- | ---
$rBuffer |  |

Returns

Type | Description
--- | ---
TRUE | on success. Err object on failure.

Details

Author
  Charlie Killian, charlie@tizac.com
Deprecated
  Use read() or BufferedReader instead.

`ready( ) : boolean`
inherited

Is stream ready for reading.

Inherited from: \Reader::ready()
Returns

Type | Description
--- | ---
boolean |

`reset( ) : void`

Repositions 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 ) : void`

Skip over $n bytes.

Parameters

Name | Type | Description
--- | --- | ---
$n | int |

Documentation was generated by DocBlox 0.15.1.