Zend_Filter_PregReplace Class Reference

Inheritance diagram for Zend_Filter_PregReplace:

Public Member Functions
	__construct ($options=null)
	setMatchPattern ($match)
	getMatchPattern ()
	setReplacement ($replacement)
	getReplacement ()
	filter ($value)

Static Public Member Functions
static	isUnicodeSupportEnabled ()

Static Protected Member Functions
static	_determineUnicodeSupport ()

Protected Attributes
	$_matchPattern = null
	$_replacement = ''

Static Protected Attributes
static	$_unicodeSupportEnabled = null

Detailed Description

Definition at line 33 of file PregReplace.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor Supported options are 'match' => matching pattern 'replace' => replace with this

Parameters

string | array

$options

Returns

void

Definition at line 87 of file PregReplace.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            $options = func_get_args();
            $temp    = array();
            if (!empty($options)) {
                $temp['match'] = array_shift($options);
            }

            if (!empty($options)) {
                $temp['replace'] = array_shift($options);
            }

            $options = $temp;
        }

        if (array_key_exists('match', $options)) {
            $this->setMatchPattern($options['match']);
        }

        if (array_key_exists('replace', $options)) {
            $this->setReplacement($options['replace']);
        }
    }

Member Function Documentation

_determineUnicodeSupport()

static _determineUnicodeSupport ( )

staticprotected

Method to cache the regex needed to determine if unicode support is available

Returns

bool

Definition at line 73 of file PregReplace.php.

    {
        self::$_unicodeSupportEnabled = (@preg_match('/\pL/u', 'a')) ? true : false;
    }

filter()

filter

(

$value

)

Perform regexp replacement as filter

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 164 of file PregReplace.php.

    {
        if ($this->_matchPattern == null) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception(get_class($this) . ' does not have a valid MatchPattern set.');
        }

        return preg_replace($this->_matchPattern, $this->_replacement, $value);
    }

getMatchPattern()

getMatchPattern

(

)

Get currently set match pattern

Returns

string

Definition at line 131 of file PregReplace.php.

    {
        return $this->_matchPattern;
    }

getReplacement()

getReplacement

(

)

Get currently set replacement value

Returns

string

Definition at line 153 of file PregReplace.php.

    {
        return $this->_replacement;
    }

isUnicodeSupportEnabled()

static isUnicodeSupportEnabled ( )

static

Is Unicode Support Enabled Utility function

Returns

bool

Definition at line 59 of file PregReplace.php.

    {
        if (self::$_unicodeSupportEnabled === null) {
            self::_determineUnicodeSupport();
        }

        return self::$_unicodeSupportEnabled;
    }

setMatchPattern()

setMatchPattern

(

$match

)

Set the match pattern for the regex being called within filter()

Parameters

mixed

$match

- same as the first argument of preg_replace

Returns

Zend_Filter_PregReplace

Definition at line 120 of file PregReplace.php.

    {
        $this->_matchPattern = $match;
        return $this;
    }

setReplacement()

setReplacement

(

$replacement

)

Set the Replacement pattern/string for the preg_replace called in filter

Parameters

mixed

$replacement

- same as the second argument of preg_replace

Returns

Zend_Filter_PregReplace

Definition at line 142 of file PregReplace.php.

    {
        $this->_replacement = $replacement;
        return $this;
    }

Field Documentation

$_matchPattern

$_matchPattern = null

protected

Definition at line 39 of file PregReplace.php.

$_replacement

$_replacement = ''

protected

Definition at line 45 of file PregReplace.php.

$_unicodeSupportEnabled

$_unicodeSupportEnabled = null

staticprotected

Definition at line 52 of file PregReplace.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Filter/PregReplace.php