PHP Class StripLineBreaks, symfony-1.4

Example:
Or:
See also: BaseParamFilterReader
Author: hans lellelid, [email protected]
Inheritance: extends BaseParamFilterReader, implements ChainableReader
Show file Open project: vjousse/symfony-1.4 Class Usage Examples

Public Methods

Method Description
chain ( Reader $reader ) : object Creates a new StripLineBreaks using the passed in Reader for instantiation.
getLineBreaks ( ) : string Gets the line-breaking characters.
read ( $len = null ) : mixed Returns the filtered stream, only including characters not in the set of line-breaking characters.
setLineBreaks ( string $lineBreaks ) Sets the line-breaking characters.

Private Methods

Method Description
_initialize ( ) Parses the parameters to set the line-breaking characters.

Method Details

chain() public method

Creates a new StripLineBreaks using the passed in Reader for instantiation.
public chain ( Reader $reader ) : object
$reader Reader
return object A new filter based on this configuration, but filtering the specified reader

getLineBreaks() public method

Gets the line-breaking characters.
public getLineBreaks ( ) : string
return string A String containing all the characters that are considered as line-breaking.

read() public method

Returns the filtered stream, only including characters not in the set of line-breaking characters.
public read ( $len = null ) : mixed
return mixed the resulting stream, or -1 if the end of the resulting stream has been reached.

setLineBreaks() public method

Sets the line-breaking characters.
public setLineBreaks ( string $lineBreaks )
$lineBreaks string A String containing all the characters to be considered as line-breaking.