Class RealPath

Summary

Fully Qualified Name: Laminas\Filter\RealPath
Extends: AbstractFilter

Description

Methods

Name Description Defined By
__construct() Class constructor RealPath
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Laminas\Filter\FilterInterface RealPath
getExists() Returns true if the filtered path must exist RealPath
getOptions() Retrieve options representing object state AbstractFilter
hasPcreUnicodeSupport() AbstractFilter
setExists() Sets if the path has to exist TRUE when the path must exist FALSE when not existing paths can be given RealPath
setOptions() AbstractFilter

Method Details

__construct()

Class constructor

Parameter Name Type Description
$existsOrOptions bool|\Traversable Options

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

Defined by Laminas\Filter\FilterInterface

Returns realpath($value)

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

Parameter Name Type Description
$value string

Returns: string|mixed

getExists()

Returns true if the filtered path must exist

Returns: bool

getOptions()

Retrieve options representing object state

Returns: array

hasPcreUnicodeSupport()

Returns: bool

setExists()

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

Parameter Name Type Description
$flag bool Path

Returns: self

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

Top