Zend Framework » \Zend\Filter\Word\DashToSeparator

Methods

Constructor

__construct(string $separator)

Inherited

inherited_from	\Zend\Filter\Word\AbstractSeparator::__construct()

Parameters

$separator

string

Space by default

Invoke filter as a command

__invoke(mixed $value) : mixed

Inherited

Proxies to filter()

inherited_from	\Zend\Filter\AbstractFilter::__invoke()
inherited_from	\Zend\Filter\Word\AbstractSeparator::__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

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\AbstractSeparator::getOptions()

Returns

array

Returns the actual set separator

getSeparator() : string

Inherited

inherited_from	\Zend\Filter\Word\AbstractSeparator::getSeparator()

Returns

string

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool

Inherited

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

Returns

bool

setOptions()

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

Inherited

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

Parameters

$options

array\Traversable

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\self

Sets a new separator

setSeparator(string $separator) : \Zend\Filter\Word\self

Inherited

inherited_from	\Zend\Filter\Word\AbstractSeparator::setSeparator()

Parameters

$separator

string

Separator

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\Word\self

isOptions()

isOptions(mixed $options) : bool

Inherited

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

Parameters

$options

mixed

Returns

bool

Properties

Filter options

$options : array

Inherited

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

$separator

$separator

Inherited

inherited_from	\Zend\Filter\Word\AbstractSeparator::$$separator