# filters/LineContains.php

## \Contains
jump to top

Package: phing\filters

Holds a contains element.

### Properties

`string $_value= ''`

Details

Type
  string

### Methods

`getValue( ) : string`

Returns 'contains' value.

Returns

Type | Description
--- | ---
string |

`setValue( string $contains ) : void`

Set 'contains' value.

Parameters

Name | Type | Description
--- | --- | ---
$contains | string |

## \LineContains
jump to top

Package: phing\filters

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

.

Implements
  \ChainableReader
Parent(s)
  \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
See
  \PhingFilterReader
Author
  Yannick Lecaillez
Author
  Hans Lellelid
Copyright
  © 2003 seasonfive. All rights reserved
Version
  $Revision: 1084 $

### Constants

`string CONTAINS_KEY = "contains"`

The parameter name for the string to match on.

  string

### Properties

`array $_contains= 'array()'`

Array of Contains objects.

Default value `array()`Details

Type
  array

`string $_line= 'null'`

[Deprecated]

Default value `null` Details

Type
  string

`$_parameters= 'array()'`
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$$_parameters
Default value `array()`Details

Type
  n/a
Inherited_from
  \BaseParamFilterReader::$$_parameters

`$initialized= 'false'`
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initialized
Default value `false` Details

Type
  n/a
Inherited_from
  \BaseFilterReader::$$initialized
Inherited_from
  \BaseParamFilterReader::$$initialized

`$project= 'null'`
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$project
Default value `null` Details

Type
  n/a
Inherited_from
  \BaseFilterReader::$$project
Inherited_from
  \BaseParamFilterReader::$$project

### Methods

`__construct( \Reader $in = null ) : void`
inherited

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.

Parameters

Name | Type | Description
--- | --- | ---
$in | \Reader |

`_initialize( ) : void`

Parses the parameters to add user-defined contains strings.

`chain( object $reader ) : object`

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

Parameters

Name | Type | Description
--- | --- | ---
$reader | object | A Reader object providing the underlying stream. Must not be `null`.

Returns

Type | Description
--- | ---
object | A new filter based on this configuration, but filtering the specified reader

`close( ) : void`
inherited

Inherited from: FilterReader::close()\BaseFilterReader::close()\BaseParamFilterReader::close()
`createContains( ) : \Contains`

Adds a `contains` nested element.

Returns

Type | Description
--- | ---
\Contains | The <code>contains</code> element added. Must not be <code>null</code>.

`eof( ) : boolean`
inherited

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

Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()
Returns

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.

Returns

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`
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()
Returns

Type | Description
--- | ---
boolean | whether or not the filter is initialized

`getParameters( ) : void`
inherited

Inherited from: \BaseParamFilterReader::getParameters()
`getProject( ) : object`
inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()
Returns

Type | Description
--- | ---
object | The project this filter is part of

`getResource( ) : void`
inherited

Inherited from: FilterReader::getResource()\BaseFilterReader::getResource()\BaseParamFilterReader::getResource()
`log( string $msg, int $level = Project::MSG_INFO ) : void`
inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()
Parameters

Name | Type | Description
--- | --- | ---
$msg | string | Message to log.
$level | int | Priority level.

`mark( ) : void`
inherited

Inherited from: Reader::mark()\BaseFilterReader::mark()\BaseParamFilterReader::mark()
`markSupported( ) : void`
inherited

Inherited from: Reader::markSupported()\BaseFilterReader::markSupported()\BaseParamFilterReader::markSupported()
`read( \off $len = null ) : mixed`

Returns all lines in a buffer that contain specified strings.

Parameters

Name | Type | Description
--- | --- | ---
$len | \off | Offset at which to start storing characters.

Returns

Type | Description
--- | ---
mixed | buffer, -1 on EOF

Throws

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.

Returns

Type | Description
--- | ---
\the | next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Details

Exception
  IOException if the underlying stream throws an IOException during reading

`readLine( ) : \the`
inherited

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'.

Returns

Type | Description
--- | ---
\the | line read, or <code>null</code> if the end of the stream has already been reached

Throws

Exception | Description
--- | ---
\IOException | if the underlying reader throws one during reading

`ready( ) : void`
inherited

Inherited from: Reader::ready()\BaseFilterReader::ready()\BaseParamFilterReader::ready()
`reset( ) : void`
inherited

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.

Parameters

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 `null`.

`setInitialized( boolean $initialized ) : void`
inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()
Parameters

Name | Type | Description
--- | --- | ---
$initialized | boolean | Whether or not the filter is initialized.

`setParameters( $parameters ) : void`
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters

Name | Type | Description
--- | --- | ---
$parameters |  |

`setProject( object $project ) : void`
inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | object | The project this filter is part of. Should not be `null`.

`setReader( ) : void`
inherited

Inherited from: FilterReader::setReader()\BaseFilterReader::setReader()\BaseParamFilterReader::setReader()
`skip( ) : void`
inherited

Inherited from: FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()
Documentation was generated by DocBlox 0.17.1.