Abstract class for reading character streams.

author Hans Lellelid
author Yannick Lecaillez
version $Id$
package phing.system.io

 Methods

Close stream.

close() 

Exceptions

\IOException if there is an error closing stream

Returns the filename, url, etc.

getResource() : string

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

string

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

mark() 

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

Whether marking is supported.

markSupported() : boolean

Returns

boolean

Read data from source.

read(int $len) 

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

Parameters

$len

int

Is stream ready for reading.

ready() : boolean

Returns

boolean

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

reset() 

Move stream position relative to current pos.

skip(int $n) 

Parameters

$n

int