phing-util-regex
[ class tree: phing-util-regex ] [ index: phing-util-regex ] [ all elements ]

Class: PregEngine

Source Location: /util/regexp/PregEngine.php

Class Overview


PREG Regexp Engine.


Author(s):

  • hans lellelid, hans@velum.net

Implements interfaces:

Methods



Class Details

[line 31]
PREG Regexp Engine.

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




Tags:

author:  hans lellelid, hans@velum.net


[ Top ]


Class Methods


method getIgnoreCase [line 51]

boolean getIgnoreCase( )

Gets whether or not regex operation is case sensitive.




Implementation of:
RegexpEngine::getIgnoreCase()
Returns status of ignore case flag.
[ Top ]

method match [line 73]

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

Matches pattern against source string and sets the matches array.



Tags:

return:  Success of matching operation.



Implementation of:
RegexpEngine::match()
Matches pattern against source string and sets the matches array.

Parameters:

string   $pattern   The regex pattern to match.
string   $source   The source string.
array   $matches   The array in which to store matches.
   &$matches  

[ Top ]

method matchAll [line 84]

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

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



Tags:

return:  Success of matching operation.



Implementation of:
RegexpEngine::matchAll()
Matches all patterns in source string and sets the matches array.

Parameters:

string   $pattern   The regex pattern to match.
string   $source   The source string.
array   $matches   The array in which to store matches.
   &$matches  

[ Top ]

method replace [line 97]

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

Replaces $pattern with $replace in $source string.

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




Tags:

return:  The replaced source string.



Implementation of:
RegexpEngine::replace()
Replaces $pattern with $replace in $source string.

Parameters:

string   $pattern   The regex pattern to match.
string   $replace   The string with which to replace matches.
string   $source   The source string.

[ Top ]

method setIgnoreCase [line 43]

void setIgnoreCase( boolean $bit)

Sets whether or not regex operation is case sensitive.




Implementation of:
RegexpEngine::setIgnoreCase()
Sets whether or not regex operation should ingore case.

Parameters:

boolean   $bit  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:45 +0200 by phpDocumentor 1.4.3