filters/StripWhitespace.php

Strips whitespace from [php] files using PHP stripwhitespace() method.

Implements

\ChainableReader

Parent(s)

\BaseFilterReader < \FilterReader < \Reader

See

\FilterReader  

Author

Hans Lellelid, hans@velum.net  

Todo

-c use new PHP functions to perform this instead of regex.  

Version

$Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $  

Properties

 $initialized= 'false'

inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized

Default valuefalseDetails

Type

n/a

Inherited_from

\BaseFilterReader::$$initialized  

 $processed= 'false'

Default valuefalseDetails

Type

n/a

 $project= 'null'

inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project

Default valuenullDetails

Type

n/a

Inherited_from

\BaseFilterReader::$$project  

Methods

__construct( \Reader $in = null ) : void

inherited

Constructor used by Phing's introspection mechanism.

Inherited from: \BaseFilterReader::__construct()

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

chain( \reader $reader ) : \a

Creates a new StripWhitespace using the passed in Reader for instantiation.

Parameters

Name	Type	Description
$reader	\reader	A Reader object providing the underlying stream. Must not be null.

Returns

Type	Description
\a	new filter based on this configuration, but filtering the specified reader

close( ) : void

inherited

Inherited from: FilterReader::close()\BaseFilterReader::close()

eof( ) : boolean

inherited

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

Inherited from: \BaseFilterReader::eof()

Returns

Type	Description
boolean

getInitialized( ) : boolean

inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()

Returns

Type	Description
boolean	whether or not the filter is initialized

getProject( ) : object

inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()

Returns

Type	Description
object	The project this filter is part of

getResource( ) : void

inherited

Inherited from: FilterReader::getResource()\BaseFilterReader::getResource()

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

inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()

Parameters

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

mark( ) : void

inherited

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

markSupported( ) : void

inherited

Inherited from: Reader::markSupported()\BaseFilterReader::markSupported()

read( \off $len = null ) : \the

Returns the stream without Php comments and whitespace.

Parameters

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

Returns

Type	Description
\the	resulting stream, or -1 if the end of the resulting stream has been reached

Throws

Exception	Description
\IOException	if the underlying stream throws an IOException during reading

readLine( ) : \the

inherited

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

Inherited from: \BaseFilterReader::readLine()

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

inherited

Inherited from: Reader::ready()\BaseFilterReader::ready()

reset( ) : void

inherited

Inherited from: FilterReader::reset()\BaseFilterReader::reset()

setInitialized( boolean $initialized ) : void

inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()

Parameters

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

setProject( object $project ) : void

inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()

Parameters

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

setReader( ) : void

inherited

Inherited from: FilterReader::setReader()\BaseFilterReader::setReader()

skip( ) : void

inherited

Inherited from: FilterReader::skip()\BaseFilterReader::skip()