filters/LineContains.php
Filter which includes only those lines that contain all the user-specified strings.
Example:
Or:
This will include only those lines that contain
foo
and
bar
.
- Author
- Yannick Lecaillez
- Author
- Hans Lellelid
- Package
- phing.filters
- See
- \PhingFilterReader
- Version
- $Id$
\Contains
Holds a contains element.
Properties
Methods
\LineContains
Filter which includes only those lines that contain all the user-specified strings.
Example:
Or:
This will include only those lines that contain
foo
and
bar
.
- Parent(s)
- \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
- See
- \PhingFilterReader
- Author
- Yannick Lecaillez
- Author
- Hans Lellelid
- Copyright
- � 2003 seasonfive. All rights reserved
- Version
- $Id$
Constants
Properties


$_parameters= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \BaseParamFilterReader::$$_parameters


\Reader
$in= ''
- Type
- \Reader
- Inherited_from
- \FilterReader::$$in
- Inherited_from
- \BaseFilterReader::$$in
- Inherited_from
- \BaseParamFilterReader::$$in


$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initializedfalse
Details- 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::$$projectnull
Details- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$project
- Inherited_from
- \BaseParamFilterReader::$$project
Methods


__construct(
\Reader $in
=
null
)
:
void
Constructor 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 |


chain(
object $reader
)
:
object
Creates a new LineContains 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(
)
:
void
Close stream.
Inherited from: \FilterReader::close()\BaseFilterReader::close()\BaseParamFilterReader::close()Exception | Description |
---|---|
\IOException | if there is an error closing stream |


createContains(
)
:
\Contains
Adds a contains
nested element.
Type | Description |
---|---|
\Contains | The <code>contains</code> element added. Must not be <code>null</code>. |


eof(
)
:
boolean
Returns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()Type | Description |
---|---|
boolean |


getContains(
)
:
array
Returns the vector of words which must be contained within a line read from the original stream in order for it to match this filter.
Type | Description |
---|---|
array | The array of words which must be contained within a line read from the original stream in order for it to match this filter. The returned object is "live" - in other words, changes made to the returned object are mirrored in the filter. |


getInitialized(
)
:
boolean
Returns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()Type | Description |
---|---|
boolean | whether or not the filter is initialized |


getProject(
)
:
object
Returns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()Type | Description |
---|---|
object | The project this filter is part of |


getResource(
)
:
string
Returns the filename, url, etc. that is being read from.
Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()\BaseParamFilterReader::getResource()This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
Type | Description |
---|---|
string |


log(
string $msg, int $level
=
Project::MSG_INFO
)
:
void
Convenience 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
If supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()\BaseParamFilterReader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).


markSupported(
)
:
boolean
Whether marking is supported.
Inherited from: \Reader::markSupported()\FilterReader::markSupported()\BaseFilterReader::markSupported()\BaseParamFilterReader::markSupported()Type | Description |
---|---|
boolean |


read(
\off $len
=
null
)
:
mixed
Returns all lines in a buffer that contain specified strings.
FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.
Name | Type | Description |
---|---|---|
$len | \off | Offset at which to start storing characters. |
Type | Description |
---|---|
mixed | buffer, -1 on EOF |
Exception | Description |
---|---|
\IOException | If an I/O error occurs |


readChar(
)
:
\the
[Deprecated. For reference only, used to be read() method.] Returns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words.
Type | Description |
---|---|
\the | next character in the resulting stream, or -1 if the end of the resulting stream has been reached |
- Exception
- IOException if the underlying stream throws an IOException during reading


readLine(
)
:
\the
Reads 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(
)
:
boolean
Is stream ready for reading.
Inherited from: \Reader::ready()\FilterReader::ready()\BaseFilterReader::ready()\BaseParamFilterReader::ready()Type | Description |
---|---|
boolean |


reset(
)
:
void
Reset the current position in stream to beginning or last mark (if supported).
Inherited from: \FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()

setContains(
array $contains
)
:
void
Sets the array of words which must be contained within a line read from the original stream in order for it to match this filter.
Name | Type | Description |
---|---|---|
$contains | array | An array of words which must be contained within a line in order for it to match in this filter. Must not be |


setInitialized(
boolean $initialized
)
:
void
Sets 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
)
:
void
Sets 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(
$in
)
:
void
Name | Type | Description |
---|---|---|
$in |


skip(
int $n
)
:
void
Move stream position relative to current pos.
Inherited from: \FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()Name | Type | Description |
---|---|---|
$n | int |