package Default
inherited_from \Zend\Filter\AbstractFilter

 Methods

Class constructor

__construct(boolean|\Traversable $existsOrOptions = true

Parameters

$existsOrOptions

boolean\Traversable

Options to set

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\FilterInterface

filter(string $value) : string | mixed

Returns realpath($value)

If the value provided is non-scalar, the value will remain unfiltered

Parameters

$value

string

Returns

stringmixed

Returns true if the filtered path must exist

getExists() : boolean

Returns

boolean

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

Sets if the path has to exist TRUE when the path must exist FALSE when not existing paths can be given

setExists(boolean $flag = true) : \Zend\Filter\RealPath
fluent This method is part of a fluent interface and will return the same instance

Parameters

$flag

boolean

Path must exist

Returns

\Zend\Filter\RealPath

setOptions()

setOptions(array|\Traversable $options) : \Zend\Filter\RealPath
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\RealPath

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

Filter options

$options : array

Default

array('exists' => true)
inherited_from \Zend\Filter\AbstractFilter::options
 

Filter options

$options : array

Default

array()