Filter/Word/Separator/Abstract.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Filter
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Filter_Word_Separator_Abstract
Package: Zend\Filter










- Parent(s)
- \Zend_Filter_PregReplace
- Children
- \Zend_Filter_Word_SeparatorToCamelCase
- \Zend_Filter_Word_DashToSeparator
- \Zend_Filter_Word_CamelCaseToSeparator
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Filter_PregReplace
Properties


mixed $_matchPattern = null
Default value
null
Details- Type
- mixed
- Inherited_from
- \Zend_Filter_PregReplace::$$_matchPattern


mixed $_replacement = ''
Default value
''
Details- Type
- mixed
- Inherited_from
- \Zend_Filter_PregReplace::$$_replacement


bool $_unicodeSupportEnabled = null
staticinherited
Is unicode enabled?
Inherited from:
\Zend_Filter_PregReplace::$$_unicodeSupportEnabledDefault value
null
Details- Type
- bool
- Inherited_from
- \Zend_Filter_PregReplace::$$_unicodeSupportEnabled
Methods


__construct(string $separator = ' ') : void
Constructor
Parameters
Name | Type | Description |
---|---|---|
$separator | string | Space by default |


_determineUnicodeSupport() : bool
staticinherited
Method to cache the regex needed to determine if unicode support is available
Inherited from: \Zend_Filter_PregReplace::_determineUnicodeSupport()Returns
Type | Description |
---|---|
bool |


filter(string $value) : string
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Filter_Exception | If filtering $value is impossible |


getReplacement() : string
inherited
Get currently set replacement value
Inherited from: \Zend_Filter_PregReplace::getReplacement()Returns
Type | Description |
---|---|
string |


isUnicodeSupportEnabled() : bool
staticinherited
Is Unicode Support Enabled Utility function
Inherited from: \Zend_Filter_PregReplace::isUnicodeSupportEnabled()Returns
Type | Description |
---|---|
bool |


setMatchPattern(mixed $match) : \Zend_Filter_PregReplace
inherited
Set the match pattern for the regex being called within filter()
Inherited from: \Zend_Filter_PregReplace::setMatchPattern()Parameters
Returns
Name | Type | Description |
---|---|---|
$match | mixed |
|
Type | Description |
---|---|
\Zend_Filter_PregReplace |


setReplacement(mixed $replacement) : \Zend_Filter_PregReplace
inherited
Set the Replacement pattern/string for the preg_replace called in filter
Inherited from: \Zend_Filter_PregReplace::setReplacement()Parameters
Returns
Name | Type | Description |
---|---|---|
$replacement | mixed |
|
Type | Description |
---|---|
\Zend_Filter_PregReplace |


setSeparator(string $separator) : \Zend_Filter_Word_Separator_Abstract
Sets a new seperator
Parameters
Returns
Details
Name | Type | Description |
---|---|---|
$separator | string | Seperator |
Type | Description |
---|---|
\Zend_Filter_Word_Separator_Abstract |
- Fluent
- This method is part of a fluent interface and will return the same instance