filters/LineContains.php

Show: inherited
Table of Contents

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

Package: phing\filters

Holds a contains element.

Properties

Propertyprivatestring  $_value= ''

Details
Type
string

Methods

methodpublicgetValue( ) : string

Returns 'contains' value.

Returns
Type Description
string
methodpublicsetValue( string $contains ) : void

Set 'contains' value.

Parameters
Name Type Description
$contains string

\LineContains

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

.

Parent(s)
\BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
See
\PhingFilterReader  
Author
Yannick Lecaillez  
Author
Hans Lellelid  
Copyright
� 2003 seasonfive. All rights reserved  
Version
$Id$  

Constants

Constantstring  CONTAINS_KEY = "contains"

The parameter name for the string to match on.

string

Properties

Propertyprivatearray  $_contains= 'array()'

Array of Contains objects.

Default valuearray()Details
Type
array
Propertyprivatestring  $_line= 'null'

[Deprecated]

Default valuenullDetails
Type
string
Propertyprotected  $_parameters= 'array()'
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$$_parameters
Default valuearray()Details
Type
n/a
Inherited_from
\BaseParamFilterReader::$$_parameters  
Propertyprotected\Reader  $in= ''
Details
Type
\Reader
Inherited_from
\FilterReader::$$in  
Inherited_from
\BaseFilterReader::$$in  
Inherited_from
\BaseParamFilterReader::$$in  
Propertyprotected  $initialized= 'false'
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initialized
Default valuefalseDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$initialized  
Inherited_from
\BaseParamFilterReader::$$initialized  
Propertyprotected  $project= 'null'
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$project
Default valuenullDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$project  
Inherited_from
\BaseParamFilterReader::$$project  

Methods

methodpublic__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
methodprivate_initialize( ) : void

Parses the parameters to add user-defined contains strings.

methodpublicchain( 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
methodpublicclose( ) : void
Throws
Exception Description
\IOException if there is an error closing stream
methodpubliccreateContains( ) : \Contains

Adds a contains nested element.

Returns
Type Description
\Contains The <code>contains</code> element added. Must not be <code>null</code>.
methodpubliceof( ) : boolean
inherited

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

Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()
Returns
Type Description
boolean
methodpublicgetContains( ) : 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.
methodpublicgetInitialized( ) : boolean
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()
Returns
Type Description
boolean whether or not the filter is initialized
methodpublicgetParameters( ) : void
inherited

Inherited from: \BaseParamFilterReader::getParameters()
methodpublicgetProject( ) : 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
methodpublicgetResource( ) : string
inherited

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.

Returns
Type Description
string
methodpubliclog( 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.

methodpublicmark( ) : void
inherited

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

methodpublicmarkSupported( ) : boolean
Returns
Type Description
boolean
methodpublicread( \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.

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
methodpublicreadChar( ) : \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  
methodpublicreadLine( ) : \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
methodpublicready( ) : boolean
Returns
Type Description
boolean
methodpublicreset( ) : void
inherited

Reset the current position in stream to beginning or last mark (if supported).

Inherited from: \FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()
methodpublicsetContains( 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.

methodpublicsetInitialized( 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.

methodpublicsetParameters(  $parameters ) : void
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters
Name Type Description
$parameters
methodpublicsetProject( 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.

methodpublicsetReader(  $in ) : void
Parameters
Name Type Description
$in
methodpublicskip( int $n ) : void
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()
Parameters
Name Type Description
$n int
Documentation was generated by DocBlox 0.18.1.