filters/StripLineBreaks.php
inherited
Classes
\StripLineBreaks
Filter to flatten the stream to a single line.
Example:
Or:
- Implements
- \ChainableReader
- Parent(s)
- \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
- See
- \BaseParamFilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Author
- hans lellelid, hans@velum.net
- Copyright
- © 2003 seasonfive. All rights reserved
- Version
- $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
Constants
string
DEFAULT_LINE_BREAKS
= "\r\n"Default line-breaking characters.
- string
string
LINES_BREAKS_KEY
= "linebreaks"Parameter name for the line-breaking characters parameter.
- string
Properties
string
$_lineBreaks= '"\r\n"'
The characters that are recognized as line breaks.
"\r\n"Details- Type
- string
$_parameters= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \BaseParamFilterReader::$$_parameters
$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initializedfalseDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
- Inherited_from
- \BaseParamFilterReader::$$initialized
$project= 'null'
The Phing project this filter is part of.
Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$projectnullDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$project
- Inherited_from
- \BaseParamFilterReader::$$project
Methods
__construct(
\Reader $in
=
null
)
:
voidConstructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()\BaseParamFilterReader::__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.
| Name | Type | Description |
|---|---|---|
| $in | \Reader |
_initialize(
)
:
voidParses the parameters to set the line-breaking characters.
chain(
object $reader
)
:
objectCreates a new StripLineBreaks using the passed in Reader for instantiation.
| Name | Type | Description |
|---|---|---|
| $reader | object | A Reader object providing the underlying stream. Must not be |
| Type | Description |
|---|---|
| object | A new filter based on this configuration, but filtering the specified reader |
close(
)
:
voideof(
)
:
booleanReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()| Type | Description |
|---|---|
| boolean |
getInitialized(
)
:
booleanReturns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
getLineBreaks(
)
:
stringGets the line-breaking characters.
| Type | Description |
|---|---|
| string | A String containing all the characters that are considered as line-breaking. |
getProject(
)
:
objectReturns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()| Type | Description |
|---|---|
| object | The project this filter is part of |
getResource(
)
:
voidlog(
string $msg, int $level
=
Project::MSG_INFO
)
:
voidConvenience method to support logging in filters.
Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
mark(
)
:
void
markSupported(
)
:
voidread(
\off $len
=
null
)
:
mixedReturns the filtered stream, only including characters not in the set of line-breaking characters.
| Name | Type | Description |
|---|---|---|
| $len | \off | Offset at which to start storing characters. |
| Type | Description |
|---|---|
| mixed | the resulting stream, or -1 if the end of the resulting stream has been reached. |
| Exception | Description |
|---|---|
| \IOException | If an I/O error occurs |
- Exception
- IOException if the underlying stream throws an IOException during reading
readLine(
)
:
\theReads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()\BaseParamFilterReader::readLine()The returned String retains the '\n'.
| Type | Description |
|---|---|
| \the | line read, or <code>null</code> if the end of the stream has already been reached |
| Exception | Description |
|---|---|
| \IOException | if the underlying reader throws one during reading |
ready(
)
:
void
reset(
)
:
voidsetInitialized(
boolean $initialized
)
:
voidSets the initialized status.
Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setLineBreaks(
string $lineBreaks
)
:
voidSets the line-breaking characters.
| Name | Type | Description |
|---|---|---|
| $lineBreaks | string | A String containing all the characters to be considered as line-breaking. |
setParameters(
$parameters
)
:
void| Name | Type | Description |
|---|---|---|
| $parameters |
setProject(
object $project
)
:
voidSets the project to work with.
Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |
setReader(
)
:
voidskip(
)
:
void