filters/BaseFilterReader.php

Show: inherited
Table of Contents

Base class for core filter readers.

Access
public  
Author
Yannick Lecaillez  
Package
phing.filters  
See
\FilterReader  
Version
$Id$  

\BaseFilterReader

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
$Id$  

Properties

Propertyprotected\Reader  $in= ''
inherited

Inherited from: \FilterReader::$$in
Details
Type
\Reader
Inherited_from
\FilterReader::$$in  
Propertyprotected  $initialized= 'false'

Have the parameters passed been interpreted?

Default valuefalseDetails
Type
n/a
Propertyprotected  $project= 'null'

The Phing project this filter is part of.

Default valuenullDetails
Type
n/a

Methods

methodpublic__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
methodpublicclose( ) : void
inherited

Close stream.

Inherited from: \FilterReader::close()
Throws
Exception Description
\IOException if there is an error closing stream
methodpubliceof( ) : boolean

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

Returns
Type Description
boolean
methodpublicgetInitialized( ) : boolean

Returns the initialized status.

Returns
Type Description
boolean whether or not the filter is initialized
methodpublicgetProject( ) : object

Returns the project this filter is part of.

Returns
Type Description
object The project this filter is part of
methodpublicgetResource( ) : string
inherited

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

Inherited from: \FilterReader::getResource()

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

Returns
Type Description
string
methodpubliclog( 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.

methodpublicmark( ) : void
inherited

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

Inherited from: \Reader::mark()\FilterReader::mark()

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

methodpublicmarkSupported( ) : boolean
inherited

Whether marking is supported.

Inherited from: \Reader::markSupported()\FilterReader::markSupported()
Returns
Type Description
boolean
methodpublicread( \off $len = null ) : \Characters

Reads characters.

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 \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
methodpublicreadLine( ) : \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
methodpublicready( ) : boolean
inherited

Is stream ready for reading.

Inherited from: \Reader::ready()\FilterReader::ready()
Returns
Type Description
boolean
methodpublicreset( ) : void
inherited

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

Inherited from: \FilterReader::reset()
methodpublicsetInitialized( boolean $initialized ) : void

Sets the initialized status.

Parameters
Name Type Description
$initialized boolean

Whether or not the filter is initialized.

methodpublicsetProject( 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.

methodpublicsetReader(  $in ) : void
inherited

Inherited from: \FilterReader::setReader()
Parameters
Name Type Description
$in
methodpublicskip( int $n ) : void
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()
Parameters
Name Type Description
$n int
Documentation was generated by DocBlox 0.18.1.