Zend Framework
Back to top  

 Methods

Constructor

__construct() 

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

inherited_from \Zend\Filter\AbstractFilter::__invoke()
inherited_from \Zend\Filter\Word\SeparatorToSeparator::__invoke()

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

inherited_from \Zend\Filter\Word\SeparatorToSeparator::filter()

Parameters

$value

stringarray

Exceptions

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

Returns

stringarray

Retrieve options representing object state

getOptions() : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::getOptions()
inherited_from \Zend\Filter\Word\SeparatorToSeparator::getOptions()

Returns

array

Returns the actual set separator which replaces the searched one

getReplacementSeparator() : string
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::getReplacementSeparator()

Returns

string

Returns the actual set separator to search for

getSearchSeparator() : string
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::getSearchSeparator()

Returns

string

hasPcreUnicodeSupport() 

hasPcreUnicodeSupport() : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()
inherited_from \Zend\Filter\Word\SeparatorToSeparator::hasPcreUnicodeSupport()

Returns

bool

setOptions() 

setOptions(array | \Traversable $options) : \Zend\Filter\self
Inherited

inherited_from \Zend\Filter\AbstractFilter::setOptions()
inherited_from \Zend\Filter\Word\SeparatorToSeparator::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\self

Sets a new separator which replaces the searched one

setReplacementSeparator(string $separator) : \Zend\Filter\Word\self
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::setReplacementSeparator()

Parameters

$separator

string

Separator which replaces the searched one

Returns

\Zend\Filter\Word\self

Sets a new seperator to search for

setSearchSeparator(string $separator) : \Zend\Filter\Word\self
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::setSearchSeparator()

Parameters

$separator

string

Seperator to search for

Returns

\Zend\Filter\Word\self

isOptions() 

isOptions(mixed $options) : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::isOptions()
inherited_from \Zend\Filter\Word\SeparatorToSeparator::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Filter options

$options : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::$$options
inherited_from \Zend\Filter\Word\SeparatorToSeparator::$$options
 

$replacementSeparator

$replacementSeparator 
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::$$replacementSeparator
 

$searchSeparator

$searchSeparator 
Inherited

inherited_from \Zend\Filter\Word\SeparatorToSeparator::$$searchSeparator