category Zend
package Zend_Filter
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Filter_PregReplace

 Methods

Constructor

__construct(string $searchSeparator = ' ', $replacementSeparator = '-') : void
inherited_from \Zend_Filter_PregReplace::__construct()

Parameters

$searchSeparator

string

Seperator to search for

$replacementSeparator

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

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

Parameters

$options

stringarray

Defined by Zend_Filter_Interface

filter(string $value) : string

Returns the string $value, replacing the searched seperators with the defined ones

inherited_from \Zend_Filter_PregReplace::filter()

Parameters

$value

string

Returns

string

Perform regexp replacement as filter

filter(string $value) : string
Inherited
inherited_from \Zend_Filter_Interface::filter()

Parameters

$value

string

Returns

string

Get currently set match pattern

getMatchPattern() : string
Inherited

Returns

string

Get currently set replacement value

getReplacement() : string
Inherited

Returns

string

Returns the actual set seperator which replaces the searched one

getReplacementSeparator() : string

Returns

string

Returns the actual set seperator to search for

getSearchSeparator() : string

Returns

string

Is Unicode Support Enabled Utility function

isUnicodeSupportEnabled() : boolean
InheritedStatic

Returns

boolean

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

setMatchPattern(mixed $match) : \Zend_Filter_PregReplace
Inherited

Parameters

$match

mixed
  • same as the first argument of preg_replace

Returns

\Zend_Filter_PregReplace

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

setReplacement(mixed $replacement) : \Zend_Filter_PregReplace
Inherited

Parameters

$replacement

mixed
  • same as the second argument of preg_replace

Returns

\Zend_Filter_PregReplace

Sets a new seperator which replaces the searched one

setReplacementSeparator(string $separator) : \Zend_Filter_Word_SeparatorToSeparator
fluent This method is part of a fluent interface and will return the same instance

Parameters

$separator

string

Seperator which replaces the searched one

Returns

\Zend_Filter_Word_SeparatorToSeparator

Sets a new seperator to search for

setSearchSeparator(string $separator) : \Zend_Filter_Word_SeparatorToSeparator
fluent This method is part of a fluent interface and will return the same instance

Parameters

$separator

string

Seperator to search for

Returns

\Zend_Filter_Word_SeparatorToSeparator

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

_determineUnicodeSupport() : boolean
InheritedStatic

Returns

boolean

Do the real work, replaces the seperator to search for with the replacement seperator

_separatorToSeparatorFilter(string $value) : string

Returns the replaced string

Parameters

$value

string

Returns

string

 Properties

 

Pattern to match

$_matchPattern : mixed

Default

null
 

Replacement pattern

$_replacement : mixed

Default

''
 

$_replacementSeparator

$_replacementSeparator 

Default

null
 

$_searchSeparator

$_searchSeparator 

Default

null
 

Is unicode enabled?

$_unicodeSupportEnabled : boolean

Default

null
Static