PHP Class BaseFilterReader, symfony-1.4

Protected Properties

Property	Type	Description
$initialized		Have the parameters passed been interpreted?
$project		The Phing project this filter is part of.

Public Methods

Method	Description
__construct ( Reader $in = null )	Constructor used by Phing's introspection mechanism.
eof ( ) : boolean	Returns whether the end of file has been reached with input stream.
getInitialized ( ) : boolean	Returns the initialized status.
getProject ( ) : object	Returns the project this filter is part of.
log ( string $msg, integer $level = Project::MSG_INFO )	Convenience method to support logging in filters.
read ( $len = null ) : Characters	Reads characters.
readLine ( ) : the	Reads a line of text ending with '\n' (or until the end of the stream).
setInitialized ( boolean $initialized )	Sets the initialized status.
setProject ( Project $project )	Sets the project to work with.

Method Details

__construct() public method

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.

public __construct ( Reader $in = null )
$in	Reader

eof() public method

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

public eof ( ) : boolean
return	boolean

getInitialized() public method

Returns the initialized status.

public getInitialized ( ) : boolean
return	boolean	whether or not the filter is initialized

getProject() public method

Returns the project this filter is part of.

public getProject ( ) : object
return	object	The project this filter is part of

log() public method

Convenience method to support logging in filters.

public log ( string $msg, integer $level = Project::MSG_INFO )
$msg	string	Message to log.
$level	integer	Priority level.

read() public method

Reads characters.

public read ( $len = null ) : Characters
return	Characters	read, or -1 if the end of the stream has been reached

readLine() public method

The returned String retains the '\n'.

public readLine ( ) : the
return	the	line read, or `null` if the end of the stream has already been reached

setInitialized() public method

Sets the initialized status.

public setInitialized ( boolean $initialized )
$initialized	boolean	Whether or not the filter is initialized.

setProject() public method

Sets the project to work with.

public setProject ( Project $project )
$project	Project	The project this filter is part of. Should not be `null`.

Property Details

$initialized protected_oe property

Have the parameters passed been interpreted?

protected $initialized

$project protected_oe property

The Phing project this filter is part of.

protected $project