util/regexp/Regexp.php

Show: inherited
Table of Contents

A factory class for regex functions.

Author
Hans Lellelid  
Package
phing.util.regexp  
Version
$Id$  

\Regexp

Package: phing\util\regexp

A factory class for regex functions.

Author
Hans Lellelid  
Version
$Id$  

Properties

Propertyprivate\RegexpEngine  $engine= ''

The regex engine -- e.g. 'preg' or 'ereg';

Details
Type
\RegexpEngine
Propertyprivatearray  $groups= 'array()'

Matching groups found.

Default valuearray()Details
Type
array
Propertyprivatestring  $pattern= ''

Pattern to match.

Details
Type
string
Propertyprivatestring  $replace= ''

Replacement pattern.

Details
Type
string

Methods

methodpublic__construct(  $engineType = 'preg' ) : void

Constructor sets the regex engine to use (preg by default).

Parameters
Name Type Description
$engineType
methodpublicgetGroup( integer $idx ) : string

Get specific matched group.

Parameters
Name Type Description
$idx integer
Returns
Type Description
string specified group or NULL if group is not set.
methodpublicgetGroups( ) : array

Get array of matched groups.

Returns
Type Description
array Matched groups
methodpublicgetIgnoreCase( ) : boolean

Gets whether the regexp matching is case insensitive.

Returns
Type Description
boolean
methodpublicgetModifiers( ) : string

Gets pattern modifiers.

Subsequent call to engines getModifiers() filters out duplicates i.e. if i is provided in $mods, and setIgnoreCase(true), "i" modifier would be included only once

Returns
Type Description
string
methodpublicgetMultiline( ) : boolean

Gets whether regexp is to be applied in multiline mode.

Returns
Type Description
boolean
methodpublicgetPattern( ) : string

Gets pattern to use for matching.

Returns
Type Description
string The pattern to match on.
methodpublicgetReplace( ) : string

Gets replacement string.

Returns
Type Description
string The pattern to replace matches with.
methodpublicmatches( string $subject ) : boolean

Performs match of specified pattern against $subject.

Parameters
Name Type Description
$subject string

The subject, on which to perform matches.

Returns
Type Description
boolean Whether or not pattern matches subject string passed.
methodpublicreplace( string $subject ) : string

Performs replacement of specified pattern and replacement strings.

Parameters
Name Type Description
$subject string

Text on which to perform replacement.

Returns
Type Description
string subject after replacement has been performed.
methodpublicsetIgnoreCase( boolean $bit ) : void

Sets whether the regexp matching is case insensitive.

(default is false -- i.e. case sensisitive)

Parameters
Name Type Description
$bit boolean
methodpublicsetModifiers( string $mods ) : void

Sets pattern modifiers for regex engine

Parameters
Name Type Description
$mods string

Modifiers to be applied to a given regex

methodpublicsetMultiline( boolean $bit ) : void

Sets whether regexp should be applied in multiline mode.

Parameters
Name Type Description
$bit boolean
methodpublicsetPattern( string $pat ) : void

Sets pattern to use for matching.

Parameters
Name Type Description
$pat string

The pattern to match on.

methodpublicsetReplace( string $rep ) : void

Sets replacement string.

Parameters
Name Type Description
$rep string

The pattern to replace matches with.

Documentation was generated by DocBlox 0.18.1.