# system/io/Reader.php

Abstract class for reading character streams.

Author
  Hans Lellelid
Author
  Yannick Lecaillez
Package
  phing.system.io
Version
  $Revision: 552 $

## \Reader
jump to top

Package: phing\system\io

Abstract class for reading character streams.

Children
  \BufferedReader
  \InputStreamReader
  \FilterReader
  \StringReader
  \ConsoleReader
Author
  Hans Lellelid
Author
  Yannick Lecaillez
Version
  $Revision: 552 $

### Methods

`close( ) : void`
abstract

Close stream.

Throws

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

`getResource( ) : string`
abstract

Returns the filename, url, etc. that is being read from.

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`

If supported, places a "marker" (like a bookmark) at current stream position.

A subsequent call to reset() will move stream position back to last marker (if supported).

`markSupported( ) : boolean`

Whether marking is supported.

Returns

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

`read( int $len = null ) : void`
abstract

Read data from source.

If length is specified, then only that number of chars is read, otherwise stream is read until EOF.

Parameters

Name | Type | Description
--- | --- | ---
$len | int |

`ready( ) : boolean`

Is stream ready for reading.

Returns

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

`reset( ) : void`

Reset the current position in stream to beginning or last mark (if supported).

`skip( int $n ) : void`

Move stream position relative to current pos.

Parameters

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

Documentation was generated by DocBlox 0.15.1.