PREG Regexp Engine.

Implements a regexp engine using PHP's preg_match(), preg_match_all(), and preg_replace() functions.

author hans lellelid, hans@velum.net
package phing.util.regexp

 Methods

Gets whether or not regex operation is case sensitive.

getIgnoreCase() : boolean

Returns

boolean

Gets pattern modifiers.

getModifiers() : string

Returns

string

Gets whether regexp is to be applied in multiline mode.

getMultiline() : boolean

Returns

boolean

Matches pattern against source string and sets the matches array.

match(string $pattern, string $source, array $matches) : boolean

Parameters

$pattern

string

The regex pattern to match.

$source

string

The source string.

$matches

array

The array in which to store matches.

Returns

booleanSuccess of matching operation.

Matches all patterns in source string and sets the matches array.

matchAll(string $pattern, string $source, array $matches) : boolean

Parameters

$pattern

string

The regex pattern to match.

$source

string

The source string.

$matches

array

The array in which to store matches.

Returns

booleanSuccess of matching operation.

Replaces $pattern with $replace in $source string.

replace(string $pattern, string $replace, string $source) : string

References to \1 group matches will be replaced with more preg-friendly $1.

Parameters

$pattern

string

The regex pattern to match.

$replace

string

The string with which to replace matches.

$source

string

The source string.

Returns

stringThe replaced source string.

Sets whether or not regex operation is case sensitive.

setIgnoreCase(boolean $bit) : void

Parameters

$bit

boolean

Sets pattern modifiers for regex engine

setModifiers(string $mods) : void

Parameters

$mods

string

Modifiers to be applied to a given regex

Sets whether regexp should be applied in multiline mode.

setMultiline(boolean $bit) 

Parameters

$bit

boolean

The pattern needs to be converted into PREG style -- which includes adding expression delims & any flags, etc.

preparePattern(string $pattern) : string

Parameters

$pattern

string

Returns

stringprepared pattern.

 Properties

 

$ignoreCase : boolean
   

$multiline : boolean