# system/io/FilterReader.php

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

Package
  phing.system.io

## \FilterReader
jump to top

Package: phing\system\io

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

Parent(s)
  \Reader
Children
  \BaseFilterReader
Author
  Hans Lellelid
Author
  Yannick Lecaillez
Version
  $Revision: 552 $

### Properties

`\Reader $in= ''`

Details

Type
  \Reader

### Methods

`__construct( $in = null ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$in |  |

`close( ) : void`

Close stream.

Throws

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

`getResource( ) : string`

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

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

Inherited from: \Reader::mark()

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

`markSupported( ) : boolean`
inherited

Whether marking is supported.

Inherited from: \Reader::markSupported()
Returns

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

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

Read data from source.

FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.

Parameters

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

`ready( ) : boolean`
inherited

Is stream ready for reading.

Inherited from: \Reader::ready()
Returns

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

`reset( ) : void`

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

`setReader( $in ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$in |  |

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