filters/StripPhpComments.php
inherited
Classes
\StripPhpComments
This is a Php comment and string stripper reader that filters those lexical tokens out for purposes of simple Php parsing.
(if you have more complex Php parsing needs, use a real lexer). Since this class heavily relies on the single char read function, you are reccomended to make it work on top of a buffered reader.
- Implements
- \ChainableReader
- Parent(s)
- \BaseFilterReader < \FilterReader < \Reader
- See
- \FilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Author
- hans lellelid, hans@velum.net
- Version
- $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
Properties
boolean
$_inString= 'false'
Whether or not the parser is currently in the middle of a string literal.
falseDetails- Type
- boolean
$_readAheadCh= '-1'
The read-ahead character, used for effectively pushing a single character back. -1 indicates that no character is in the buffer.
-1Details- Type
- n/a
$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initializedfalseDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
Methods
__construct(
\Reader $in
=
null
)
:
voidConstructor 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.
| Name | Type | Description |
|---|---|---|
| $in | \Reader |
chain(
\reader $reader
)
:
\aCreates a new StripPhpComments using the passed in Reader for instantiation.
| Name | Type | Description |
|---|---|---|
| $reader | \reader | A Reader object providing the underlying stream. Must not be |
| Type | Description |
|---|---|
| \a | new filter based on this configuration, but filtering the specified reader |
eof(
)
:
booleanReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()| Type | Description |
|---|---|
| boolean |
getInitialized(
)
:
boolean
| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
getProject(
)
:
objectReturns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()| Type | Description |
|---|---|
| object | The project this filter is part of |
getResource(
)
:
void
log(
string $msg, int $level
=
Project::MSG_INFO
)
:
void
| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
markSupported(
)
:
void
read(
\off $len
=
null
)
:
\theReturns the stream without Php comments.
| Name | Type | Description |
|---|---|---|
| $len | \off | Offset at which to start storing characters. |
| Type | Description |
|---|---|
| \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 |
readChar(
)
:
voidreadLine(
)
:
\theReads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::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 |
setInitialized(
boolean $initialized
)
:
void
| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setProject(
object $project
)
:
void
| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |
setReader(
)
:
void