Filter/Word/Separator/Abstract.php

Show: inherited
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: 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

Propertyprotectedmixed $_matchPattern = null
inherited

Pattern to match

Inherited from: \Zend_Filter_PregReplace::$$_matchPattern
Default valuenullDetails
Type
mixed
Inherited_from
\Zend_Filter_PregReplace::$$_matchPattern  
Propertyprotectedmixed $_replacement = ''
inherited

Replacement pattern

Inherited from: \Zend_Filter_PregReplace::$$_replacement
Default value''Details
Type
mixed
Inherited_from
\Zend_Filter_PregReplace::$$_replacement  
Propertyprotected$_separator = null
Default valuenullDetails
Type
n/a
Propertyprotectedbool $_unicodeSupportEnabled = null
staticinherited

Is unicode enabled?

Inherited from: \Zend_Filter_PregReplace::$$_unicodeSupportEnabled
Default valuenullDetails
Type
bool
Inherited_from
\Zend_Filter_PregReplace::$$_unicodeSupportEnabled  

Methods

methodpublic__construct(string $separator = ' ') : void

Constructor

Parameters
Name Type Description
$separator string

Space by default

methodprotected_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
methodpublicfilter(string $value) : string
inherited

Perform regexp replacement as filter

Inherited from: \Zend_Filter_PregReplace::filter()
Parameters
Name Type Description
$value string
Returns
Type Description
string
Throws
Exception Description
\Zend_Filter_Exception If filtering $value is impossible
methodpublicgetMatchPattern() : string
inherited

Get currently set match pattern

Inherited from: \Zend_Filter_PregReplace::getMatchPattern()
Returns
Type Description
string
methodpublicgetReplacement() : string
inherited

Get currently set replacement value

Inherited from: \Zend_Filter_PregReplace::getReplacement()
Returns
Type Description
string
methodpublicgetSeparator() : string

Returns the actual set seperator

Returns
Type Description
string
methodpublicisUnicodeSupportEnabled() : bool
staticinherited

Is Unicode Support Enabled Utility function

Inherited from: \Zend_Filter_PregReplace::isUnicodeSupportEnabled()
Returns
Type Description
bool
methodpublicsetMatchPattern(mixed $match) : \Zend_Filter_PregReplace
inherited

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

Inherited from: \Zend_Filter_PregReplace::setMatchPattern()
Parameters
Name Type Description
$match mixed
  • same as the first argument of preg_replace
Returns
Type Description
\Zend_Filter_PregReplace
methodpublicsetReplacement(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
Name Type Description
$replacement mixed
  • same as the second argument of preg_replace
Returns
Type Description
\Zend_Filter_PregReplace
methodpublicsetSeparator(string $separator) : \Zend_Filter_Word_Separator_Abstract

Sets a new seperator

Parameters
Name Type Description
$separator string

Seperator

Returns
Type Description
\Zend_Filter_Word_Separator_Abstract
Details
Fluent
This method is part of a fluent interface and will return the same instance  
Documentation was generated by phpDocumentor 2.0.0a8.