# filters/BaseFilterReader.php

## \BaseFilterReader
jump to top

Package: phing\filters

Base class for core filter readers.

Parent(s)
  \FilterReader < \Reader
Children
  \StripPhpComments
  \ExpandProperties
  \BaseParamFilterReader
  \StripWhitespace
  \ReplaceRegexp
See
  \FilterReader
Access
  public
Author
  Yannick Lecaillez
Version
  $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $

### Properties

`$initialized= 'false'`

Have the parameters passed been interpreted?

Default value `false` Details

Type
  n/a

`$project= 'null'`

The Phing project this filter is part of.

Default value `null` Details

Type
  n/a

### Methods

`__construct( \Reader $in = null ) : void`

Constructor used by Phing's introspection mechanism.

The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.

Parameters

Name | Type | Description
--- | --- | ---
$in | \Reader |

`close( ) : void`

`eof( ) : boolean`

Returns whether the end of file has been reached with input stream.

Returns

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

`getInitialized( ) : boolean`

Returns the initialized status.

Returns

Type | Description
--- | ---
boolean | whether or not the filter is initialized

`getProject( ) : object`

Returns the project this filter is part of.

Returns

Type | Description
--- | ---
object | The project this filter is part of

`getResource( ) : void`

`log( string $msg, int $level = Project::MSG_INFO ) : void`

Convenience method to support logging in filters.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | Message to log.
$level | int | Priority level.

`mark( ) : void`

`markSupported( ) : void`

`read( \off $len = null ) : \Characters`

Reads characters.

Parameters

Name | Type | Description
--- | --- | ---
$len | \off | Offset at which to start storing characters.

Returns

Type | Description
--- | ---
\Characters | read, or -1 if the end of the stream has been reached

Throws

Exception | Description
--- | ---
\IOException | If an I/O error occurs

`readLine( ) : \the`

Reads a line of text ending with '\n' (or until the end of the stream).

The returned String retains the '\n'.

Returns

Type | Description
--- | ---
\the | line read, or <code>null</code> if the end of the stream has already been reached

Throws

Exception | Description
--- | ---
\IOException | if the underlying reader throws one during reading

`ready( ) : void`

`reset( ) : void`

`setInitialized( boolean $initialized ) : void`

Sets the initialized status.

Parameters

Name | Type | Description
--- | --- | ---
$initialized | boolean | Whether or not the filter is initialized.

`setProject( object $project ) : void`

Sets the project to work with.

Parameters

Name | Type | Description
--- | --- | ---
$project | object | The project this filter is part of. Should not be `null`.

`setReader( ) : void`

`skip( ) : void`

Documentation was generated by DocBlox 0.17.1.