filters/ReplaceRegexp.php

Show:

inherited

Classes
- \ReplaceRegexp

Table of Contents

Performs a regexp find/replace on stream.

p> Example:

Author: Hans Lellelid
Package: phing.filters
Version: $Id$

\ReplaceRegexp
jump to top

Package: phing\filters

Performs a regexp find/replace on stream.

p> Example:

Parent(s): \BaseFilterReader < \FilterReader < \Reader
Author: Hans Lellelid
Version: $Id$

Properties

\Reader
                 $in= ''

inherited

Inherited from: \FilterReader::$$in \BaseFilterReader::$$in

Details

Type: \Reader
Inherited_from: \FilterReader::$$in
Inherited_from: \BaseFilterReader::$$in


                 $initialized= 'false'

inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized

Default valuefalseDetails

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


                 $project= 'null'

inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project

Default valuenullDetails

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

array
                 $regexps= 'array()'

RegularExpression[]

Default valuearray()Details

Type: array

Methods

__construct(
          \Reader $in
              =
              null
          )
        
        :
          void

inherited

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

Parameters

Name	Type	Description
$in	\Reader

chain(
          \Reader $reader
          )
        
        :
          \ReplaceRegExp

Creates a new ReplaceRegExp filter using the passed in Reader for instantiation.

Parameters

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

Returns

Type	Description
\ReplaceRegExp	A new filter based on this configuration, but filtering the specified reader

inherited

Close stream.

Inherited from: \FilterReader::close()\BaseFilterReader::close()

Throws

Exception	Description
\IOException	if there is an error closing stream

createRegexp(
          
          )
        
        :
          \RegularExpression

Creator method handles nested tags.

Returns

Type	Description
\RegularExpression

eof(
          
          )
        
        :
          boolean

inherited

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

Inherited from: \BaseFilterReader::eof()

Returns

Type	Description
boolean

getInitialized(
          
          )
        
        :
          boolean

inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()

Returns

Type	Description
boolean	whether or not the filter is initialized

getProject(
          
          )
        
        :
          object

inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()

Returns

Type	Description
object	The project this filter is part of

getRegexps(
          
          )
        
        :
          array

Gets the current regexps.

(Used when, e.g., cloning/chaining the method.)

Returns

Type	Description
array	RegularExpression[]

getResource(
          
          )
        
        :
          string

inherited

Returns the filename, url, etc. that is being read from.

Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()

This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.

Returns

Type	Description
string

log(
          string $msg, int $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()

Parameters

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

inherited

If supported, places a "marker" (like a bookmark) at current stream position.

Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()

A subsequent call to reset() will move stream position back to last marker (if supported).

markSupported(
          
          )
        
        :
          boolean

inherited

Whether marking is supported.

Inherited from: \Reader::markSupported()\FilterReader::markSupported()\BaseFilterReader::markSupported()

Returns

Type	Description
boolean

read(
          int $len
              =
              null
          )
        
        :
          mixed

Returns the filtered stream.

The original stream is first read in fully, and the regex replace is performed.

Parameters

Name	Type	Description
$len	int	Required $len for Reader compliance.

Returns

Type	Description
mixed	The filtered stream, or -1 if the end of the resulting stream has been reached.

Throws

Exception	Description
\IOException	If an I/O error occurs

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

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(
          
          )
        
        :
          boolean

inherited

Is stream ready for reading.

Inherited from: \Reader::ready()\FilterReader::ready()\BaseFilterReader::ready()

Returns

Type	Description
boolean

inherited

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

Inherited from: \FilterReader::reset()\BaseFilterReader::reset()

setInitialized(
          boolean $initialized
          )
        
        :
          void

inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()

Parameters

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

setProject(
          object $project
          )
        
        :
          void

inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()

Parameters

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

setReader(
           $in
          )
        
        :
          void

inherited

Inherited from: \FilterReader::setReader()\BaseFilterReader::setReader()

Parameters

Name	Type	Description
$in

setRegexps(
          array $regexps
          )
        
        :
          void

Sets the current regexps.

(Used when, e.g., cloning/chaining the method.)

Parameters

Name	Type	Description
$regexps	array	RegularExpression[]

skip(
          int $n
          )
        
        :
          void

inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()\BaseFilterReader::skip()

Parameters

Name	Type	Description
$n	int

filters/ReplaceRegexp.php

\ReplaceRegexpjump to top

Properties

Methods

\ReplaceRegexp
jump to top