package Default
inherited_from \Zend\Filter\Word\SeparatorToSeparator

 Methods

Constructor

__construct(string $replacementSeparator = ' '
inherited_from \Zend\Filter\Word\SeparatorToSeparator::__construct()

Parameters

$replacementSeparator

string

Space by default

Constructor

__construct(string $searchSeparator = ' ', string $replacementSeparator = '-'
Inherited

Parameters

$searchSeparator

string

Separator to search for

$replacementSeparator

string

Separator to replace with

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to \filter()

Parameters

$value

mixed

Exceptions

\Zend\Filter\Exception\ExceptionInterface If filtering $value is impossible

Returns

mixed

Defined by Zend\Filter\Filter

filter(string|array $value) : string | array
Inherited

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

Parameters

$value

stringarray

Returns

stringarray

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

Returns the actual set separator which replaces the searched one

getReplacementSeparator() : string
Inherited

Returns

string

Returns the actual set separator to search for

getSearchSeparator() : string
Inherited

Returns

string

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

setOptions()

setOptions(array|\Traversable $options) : \Zend\Filter\Word\UnderscoreToSeparator
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\Word\UnderscoreToSeparator

Sets a new separator which replaces the searched one

setReplacementSeparator(string $separator) : \Zend\Filter\Word\UnderscoreToSeparator
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$separator

string

Separator which replaces the searched one

Returns

\Zend\Filter\Word\UnderscoreToSeparator

Sets a new seperator to search for

setSearchSeparator(string $separator) : \Zend\Filter\Word\UnderscoreToSeparator
Inherited
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\UnderscoreToSeparator

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

Filter options

$options : array

Default

array()
 

$replacementSeparator

$replacementSeparator 

Default

null
 

$searchSeparator

$searchSeparator 

Default

null