filters/StripLineComments.php
inherited
Classes
\Comment
The class that holds a comment representation.
Properties
Methods
\StripLineComments
This filter strips line comments.
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: 557 $ $Date: 2009-08-29 15:54:38 +0200 (Sat, 29 Aug 2009) $
Constants
Properties
$_comments= 'array()'
Array that holds the comment prefixes.
array()Details- Type
- n/a
$_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(
)
:
voidchain(
$reader
)
:
\ReaderReturns a reader with the same configuration as this one, but filtering input from the specified reader.
| Name | Type | Description |
|---|---|---|
| $reader |
| Type | Description |
|---|---|
| \Reader | A reader with the same configuration as this one, but filtering input from the specified reader |
close(
)
:
voidcreateComment(
)
:
voideof(
)
:
booleanReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()| Type | Description |
|---|---|
| boolean |
getComments(
)
:
voidgetInitialized(
)
:
booleanReturns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
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 stream only including lines from the original stream which don't start with any of the specified comment prefixes.
| 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 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(
)
:
voidsetComments(
$lineBreaks
)
:
void| Name | Type | Description |
|---|---|---|
| $lineBreaks |
setInitialized(
boolean $initialized
)
:
voidSets the initialized status.
Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
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