StripLineBreaks

Extends \BaseParamFilterReader Implements \ChainableReader

Filter to flatten the stream to a single line.

Example:

Or:

author

Yannick Lecaillez

author

hans lellelid, hans@velum.net

version

$Id$

access

public

see
package

phing.filters

Methods

Read data from source.

read(int $len = null) 
inherited abstract

If length is specified, then only that number of chars is read, otherwise stream is read until EOF.

Arguments

$len

int

Sets the line-breaking characters.

setLineBreaks(string $lineBreaks) 

Arguments

$lineBreaks

string

A String containing all the characters to be considered as line-breaking.

Gets the line-breaking characters.

getLineBreaks() : string

Response

string

A String containing all the characters that are considered as line-breaking.

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

chain(\Reader $reader) : object

Arguments

$reader

\Reader

Response

object

A new filter based on this configuration, but filtering the specified reader

Parses the parameters to set the line-breaking characters.

_initialize() 

setParameters

setParameters($parameters) 
inherited

Arguments

$parameters

getParameters

getParameters() 
inherited

__construct

__construct(\Reader $in = null) 
inherited

Arguments

$in

\Reader

Returns the initialized status.

getInitialized() : boolean
inherited

Response

boolean

whether or not the filter is initialized

Sets the initialized status.

setInitialized(boolean $initialized) 
inherited

Arguments

$initialized

boolean

Whether or not the filter is initialized.

Sets the project to work with.

setProject(object $project) 
inherited

Arguments

$project

object

The project this filter is part of. Should not be null.

Returns the project this filter is part of.

getProject() : object
inherited

Response

object

The project this filter is part of

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

readLine() : \the
inherited

The returned String retains the '\n'.

throws

if the underlying reader throws one during reading

Response

\the

line read, or null if the end of the stream has already been reached

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

eof() : boolean
inherited

Response

boolean

Convenience method to support logging in filters.

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

Arguments

$msg

string

Message to log.

$level

int

Priority level.

setReader

setReader(\Reader $in) 
inherited

Arguments

$in

\Reader

Move stream position relative to current pos.

skip(int $n) 
inherited

Arguments

$n

int

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

reset() 
inherited

Close stream.

close() 
inherited abstract
throws

if there is an error closing stream

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

getResource() : string
inherited abstract

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

Response

string

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

mark() 
inherited

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

Whether marking is supported.

markSupported() : boolean
inherited

Response

boolean

Is stream ready for reading.

ready() : boolean
inherited

Response

boolean

Constants

Default line-breaking characters.

DEFAULT_LINE_BREAKS
var

Parameter name for the line-breaking characters parameter.

LINES_BREAKS_KEY
var

Properties

The characters that are recognized as line breaks.

_lineBreaks : string
var

Type(s)

string

The passed in parameter array.

_parameters : 
inherited

Have the parameters passed been interpreted?

initialized : 
inherited

The Phing project this filter is part of.

project : 
inherited

in

in : \Reader
inherited
var

Type(s)

\Reader