Filter/Word/SeparatorToDash.php

Show:

inherited

Classes
- \Zend_Filter_Word_SeparatorToDash

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: SeparatorToDash.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_Word_SeparatorToDash
jump to top

Package: Zend\Filter

Parent(s): \Zend_Filter_Word_SeparatorToSeparator < \Zend_Filter_PregReplace
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

mixed $_matchPattern = null

inherited

Pattern to match

Inherited from: \Zend_Filter_PregReplace::$$_matchPattern \Zend_Filter_Word_SeparatorToSeparator::$$_matchPattern

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Filter_PregReplace::$$_matchPattern
Inherited_from: \Zend_Filter_Word_SeparatorToSeparator::$$_matchPattern

mixed $_replacement = ''

inherited

Replacement pattern

Inherited from: \Zend_Filter_PregReplace::$$_replacement \Zend_Filter_Word_SeparatorToSeparator::$$_replacement

Default value''Details

Type: mixed
Inherited_from: \Zend_Filter_PregReplace::$$_replacement
Inherited_from: \Zend_Filter_Word_SeparatorToSeparator::$$_replacement

$_replacementSeparator = null

inheritedInherited from: \Zend_Filter_Word_SeparatorToSeparator::$$_replacementSeparator

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Filter_Word_SeparatorToSeparator::$$_replacementSeparator

$_searchSeparator = null

inheritedInherited from: \Zend_Filter_Word_SeparatorToSeparator::$$_searchSeparator

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Filter_Word_SeparatorToSeparator::$$_searchSeparator

bool $_unicodeSupportEnabled = null

staticinherited

Is unicode enabled?

Inherited from: \Zend_Filter_PregReplace::$$_unicodeSupportEnabled \Zend_Filter_Word_SeparatorToSeparator::$$_unicodeSupportEnabled

Default valuenullDetails

Type: bool
Inherited_from: \Zend_Filter_PregReplace::$$_unicodeSupportEnabled
Inherited_from: \Zend_Filter_Word_SeparatorToSeparator::$$_unicodeSupportEnabled

Methods

__construct(string $searchSeparator = ' ') : void

Constructor

Parameters

Name	Type	Description
$searchSeparator	string	Seperator to search for change

_determineUnicodeSupport() : bool

staticinherited

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

Inherited from: \Zend_Filter_PregReplace::_determineUnicodeSupport()\Zend_Filter_Word_SeparatorToSeparator::_determineUnicodeSupport()

Returns

Type	Description
bool

_separatorToSeparatorFilter(string $value) : string

inherited

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

filter(string $value) : string

inherited

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

getMatchPattern() : string

inherited

Get currently set match pattern

Inherited from: \Zend_Filter_PregReplace::getMatchPattern()\Zend_Filter_Word_SeparatorToSeparator::getMatchPattern()

Returns

Type	Description
string

getReplacement() : string

inherited

Get currently set replacement value

Inherited from: \Zend_Filter_PregReplace::getReplacement()\Zend_Filter_Word_SeparatorToSeparator::getReplacement()

Returns

Type	Description
string

getReplacementSeparator() : string

inherited

Returns the actual set seperator which replaces the searched one

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::getReplacementSeparator()

Returns

Type	Description
string

getSearchSeparator() : string

inherited

Returns the actual set seperator to search for

Inherited from: \Zend_Filter_Word_SeparatorToSeparator::getSearchSeparator()

Returns

Type	Description
string

isUnicodeSupportEnabled() : bool

staticinherited

Is Unicode Support Enabled Utility function

Inherited from: \Zend_Filter_PregReplace::isUnicodeSupportEnabled()\Zend_Filter_Word_SeparatorToSeparator::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()\Zend_Filter_Word_SeparatorToSeparator::setMatchPattern()

Parameters

Name	Type	Description
$match	mixed	same as the first argument of preg_replace

Returns

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()\Zend_Filter_Word_SeparatorToSeparator::setReplacement()

Parameters

Name	Type	Description
$replacement	mixed	same as the second argument of preg_replace

Returns

Type	Description
\Zend_Filter_PregReplace

setReplacementSeparator(string $separator) : \Zend_Filter_Word_SeparatorToDash

inherited

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_SeparatorToDash

Details

Fluent: This method is part of a fluent interface and will return the same instance

setSearchSeparator(string $separator) : \Zend_Filter_Word_SeparatorToDash

inherited

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_SeparatorToDash

Details

Fluent: This method is part of a fluent interface and will return the same instance

Filter/Word/SeparatorToDash.php

\Zend_Filter_Word_SeparatorToDashjump to top

Properties

Methods

\Zend_Filter_Word_SeparatorToDash
jump to top