FilterReader

Extends \Reader

Wrapper class for readers, which can be used to apply filters.

package

phing.system.io

Methods

__construct

__construct(\Reader $in = null) 

Arguments

$in

\Reader

setReader

setReader(\Reader $in) 

Arguments

$in

\Reader

Move stream position relative to current pos.

skip(int $n) 
inherited

Arguments

$n

int

Read data from source.

read(int $len = null) 
inherited abstract

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

Arguments

$len

int

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

reset() 
inherited

Close stream.

close() 
inherited abstract
throws

if there is an error closing stream

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

getResource() : string
inherited abstract

This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.

Response

string

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

mark() 
inherited

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

Whether marking is supported.

markSupported() : boolean
inherited

Response

boolean

Is stream ready for reading.

ready() : boolean
inherited

Response

boolean

Properties

in

in : \Reader
var

Type(s)

\Reader