API Documentation

Filter/PregReplace.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
version
$Id: PregReplace.php 21086 2010-02-18 21:10:39Z thomas $
Classes
Zend_Filter_PregReplace

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Filter_PregReplace

Implements
Zend_Filter_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
Properties
$_matchPattern
$_replacement
$_unicodeSupportEnabled
Methods
isUnicodeSupportEnabled
_determineUnicodeSupport
__construct
setMatchPattern
getMatchPattern
setReplacement
getReplacement
filter

Description

Properties

$_matchPattern

mixed $_matchPattern = 'null'

Pattern to match

Details

$_matchPattern
mixed
visibility
protected
default
null
final
false
static
false

$_replacement

mixed $_replacement = ''

Replacement pattern

Details

$_replacement
mixed
visibility
protected
default
final
false
static
false

$_unicodeSupportEnabled

bool $_unicodeSupportEnabled = 'null'

Is unicode enabled?

Details

$_unicodeSupportEnabled
bool
visibility
protected
default
null
final
false
static
true

Methods

__construct

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

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

Arguments
$options
stringarray
Details
visibility
public
final
false
static
false

_determineUnicodeSupport

_determineUnicodeSupport( ) : bool

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

Output
bool
Details
visibility
protected
final
false
static
true

filter

filter( string $value ) : string

Perform regexp replacement as filter

Arguments
$value
string
Output
string
Details
visibility
public
final
false
static
false

getMatchPattern

getMatchPattern( ) : string

Get currently set match pattern

Output
string
Details
visibility
public
final
false
static
false

getReplacement

getReplacement( ) : string

Get currently set replacement value

Output
string
Details
visibility
public
final
false
static
false

isUnicodeSupportEnabled

isUnicodeSupportEnabled( ) : bool

Is Unicode Support Enabled Utility function

Output
bool
Details
visibility
public
final
false
static
true

setMatchPattern

setMatchPattern( mixed $match ) : Zend_Filter_PregReplace

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

Arguments
$match
mixed
- same as the first argument of preg_replace
Details
visibility
public
final
false
static
false

setReplacement

setReplacement( mixed $replacement ) : Zend_Filter_PregReplace

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

Arguments
$replacement
mixed
- same as the second argument of preg_replace
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.