Filter/PregReplace.php

Show:

inherited

Classes
- \Zend_Filter_PregReplace

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Filter
Version: $Id: PregReplace.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_PregReplace
jump to top

Package: Zend\Filter

Implements: \Zend_Filter_Interface
Children: \Zend_Filter_Word_SeparatorToSeparator; \Zend_Filter_Word_Separator_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

mixed $_matchPattern = null

Pattern to match

Default valuenullDetails

Type: mixed

mixed $_replacement = ''

Replacement pattern

Default value''Details

Type: mixed

bool $_unicodeSupportEnabled = null

static

Is unicode enabled?

Default valuenullDetails

Type: bool

Methods

__construct(string | array $options = null) : void

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

Parameters

Name	Type	Description
$options	string \| array

_determineUnicodeSupport() : bool

static

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

Returns

Type	Description
bool

filter(string $value) : string

Perform regexp replacement as filter

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Filter_Exception	If filtering $value is impossible

getMatchPattern() : string

Get currently set match pattern

Returns

Type	Description
string

getReplacement() : string

Get currently set replacement value

Returns

Type	Description
string

isUnicodeSupportEnabled() : bool

static

Is Unicode Support Enabled Utility function

Returns

Type	Description
bool

setMatchPattern(mixed $match) : \Zend_Filter_PregReplace

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

Parameters

Name	Type	Description
$match	mixed	same as the first argument of preg_replace

Returns

Type	Description
\Zend_Filter_PregReplace

setReplacement(mixed $replacement) : \Zend_Filter_PregReplace

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

Parameters

Name	Type	Description
$replacement	mixed	same as the second argument of preg_replace

Returns

Type	Description
\Zend_Filter_PregReplace

Filter/PregReplace.php

\Zend_Filter_PregReplacejump to top

Properties

Methods

\Zend_Filter_PregReplace
jump to top