Phing API Documentation
Back to top  

Regexp

A factory class for regex functions.

author

Hans Lellelid hans@xmpl.org
package

phing.util.regexp
version

$Id$

Methods

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

__construct($engineType = 'preg')

Arguments

$engineType

Sets pattern to use for matching.

setPattern(string $pat) : void

Arguments

$pat

string

The pattern to match on.

Gets pattern to use for matching.

getPattern() : string

Response

string

The pattern to match on.

Sets replacement string.

setReplace(string $rep) : void

Arguments

$rep

string

The pattern to replace matches with.

Gets replacement string.

getReplace() : string

Response

string

The pattern to replace matches with.

Performs match of specified pattern against $subject.

matches(string $subject) : boolean

Arguments

$subject

string

The subject, on which to perform matches.

Response

boolean

Whether or not pattern matches subject string passed.

Performs replacement of specified pattern and replacement strings.

replace(string $subject) : string

Arguments

$subject

string

Text on which to perform replacement.

Response

string

subject after replacement has been performed.

Get array of matched groups.

getGroups() : array

Response

array

Matched groups

Get specific matched group.

getGroup(integer $idx) : string

Arguments

$idx

integer

Response

string

specified group or NULL if group is not set.

Sets pattern modifiers for regex engine

setModifiers(string $mods) : void

Arguments

$mods

string

Modifiers to be applied to a given regex

Gets pattern modifiers.

getModifiers() : string

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

Response

string

Sets whether the regexp matching is case insensitive.

setIgnoreCase(boolean $bit)

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

Arguments

$bit

boolean

Gets whether the regexp matching is case insensitive.

getIgnoreCase() : boolean

Response

boolean

Sets whether regexp should be applied in multiline mode.

setMultiline(boolean $bit)

Arguments

$bit

boolean

Gets whether regexp is to be applied in multiline mode.

getMultiline() : boolean

Response

boolean

Properties

Matching groups found.

groups : array
var

Type(s)

array

Pattern to match.

pattern : string
var

Type(s)

string

Replacement pattern.

replace : string
var

Type(s)

string

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

engine : \RegexpEngine
var

Type(s)

\RegexpEngine