util/regexp/RegexpEngine.php

Show: inherited
    Table of Contents

    Contains some shared attributes and methods -- and some abstract methods with engine-specific implementations that sub-classes must override.

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

    \RegexpEngine

    Package: phing\util\regexp

    Contains some shared attributes and methods -- and some abstract methods with engine-specific implementations that sub-classes must override.

    Children
    \PregEngine
    Author
    Hans Lellelid  
    Version
    $Id$  

    Methods

    methodpublicgetIgnoreCase( ) : boolean

    Returns status of ignore case flag.

    Returns
    Type Description
    boolean
    methodpublicmatch( string $pattern, string $source, array $matches ) : boolean

    Matches pattern against source string and sets the matches array.

    Parameters
    Name Type Description
    $pattern string

    The regex pattern to match.

    $source string

    The source string.

    $matches array

    The array in which to store matches.

    Returns
    Type Description
    boolean Success of matching operation.
    methodpublicmatchAll( string $pattern, string $source, array $matches ) : boolean

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

    Parameters
    Name Type Description
    $pattern string

    The regex pattern to match.

    $source string

    The source string.

    $matches array

    The array in which to store matches.

    Returns
    Type Description
    boolean Success of matching operation.
    methodpublicreplace( string $pattern, string $replace, string $source ) : string

    Replaces $pattern with $replace in $source string.

    Parameters
    Name Type Description
    $pattern string

    The regex pattern to match.

    $replace string

    The string with which to replace matches.

    $source string

    The source string.

    Returns
    Type Description
    string The replaced source string.
    methodpublicsetIgnoreCase( boolean $bit ) : void

    Sets whether or not regex operation should ingore case.

    Parameters
    Name Type Description
    $bit boolean
    Documentation was generated by DocBlox 0.18.1.