API Documentation

Filter/Word/DashToUnderscore.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Filter  
version
$Id: DashToUnderscore.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Filter_Word_DashToUnderscore

Extends from
\Zend_Filter_Word_SeparatorToSeparator
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Filter  

Methods

methodpublic__construct( ) : void

Constructor

methodprotected_determineUnicodeSupport( ) : bool
static

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

Inherited from: \Zend_Filter_PregReplace::_determineUnicodeSupport()
Returns
Type Description
bool
methodprotected_separatorToSeparatorFilter( string $value ) : string

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

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::_separatorToSeparatorFilter()

Returns the replaced string

Parameters
Name Type Description
$value string
Returns
Type Description
string
methodpublicfilter( string $value ) : string

Defined by Zend_Filter_Interface

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::filter()

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

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

Get currently set match pattern

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

Get currently set replacement value

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

Returns the actual set seperator which replaces the searched one

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::getReplacementSeparator()
Returns
Type Description
string
methodpublicgetSearchSeparator( ) : string

Returns the actual set seperator to search for

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::getSearchSeparator()
Returns
Type Description
string
methodpublicisUnicodeSupportEnabled( ) : bool
static

Is Unicode Support Enabled Utility function

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

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

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
methodpublicsetReplacementSeparator( string $separator ) : \Zend_Filter_Word_DashToUnderscore

Sets a new seperator which replaces the searched one

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::setReplacementSeparator()
Parameters
Name Type Description
$separator string Seperator which replaces the searched one
Returns
Type Description
\Zend_Filter_Word_DashToUnderscore
Details
fluent
This method is part of a fluent interface and will return the same instance  
methodpublicsetSearchSeparator( string $separator ) : \Zend_Filter_Word_DashToUnderscore

Sets a new seperator to search for

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::setSearchSeparator()
Parameters
Name Type Description
$separator string Seperator to search for
Returns
Type Description
\Zend_Filter_Word_DashToUnderscore
Details
fluent
This method is part of a fluent interface and will return the same instance  
Documentation was generated by DocBlox 0.13.3.