PHP Interface Airship\Engine\Contract\Security\FilterInterface

Show file Open project: paragonie/airship

Public Methods

Method	Description
addCallback ( callable $func ) : Airship\Engine\Contract\Security\FilterInterface	Add a callback to this filter (supports more than one)
process ( mixed $data ) : mixed	Process data using the filter rules.
setDefault ( $value ) : Airship\Engine\Contract\Security\FilterInterface	Set the default value (not applicable to booleans)
setIndex ( string $index ) : Airship\Engine\Contract\Security\FilterInterface
setType ( string $typeIndicator ) : Airship\Engine\Contract\Security\FilterInterface	Sets the expected input type (e.g. string, boolean)

Method Details

addCallback() public method

Add a callback to this filter (supports more than one)

public addCallback ( callable $func ) : Airship\Engine\Contract\Security\FilterInterface
$func	callable
return	Airship\Engine\Contract\Security\FilterInterface

process() public method

Process data using the filter rules.

public process ( mixed $data ) : mixed
$data	mixed
return	mixed

setDefault() public method

Set the default value (not applicable to booleans)

public setDefault ( $value ) : Airship\Engine\Contract\Security\FilterInterface
$value
return	Airship\Engine\Contract\Security\FilterInterface

setIndex() public method

public setIndex ( string $index ) : Airship\Engine\Contract\Security\FilterInterface
$index	string
return	Airship\Engine\Contract\Security\FilterInterface

setType() public method

Sets the expected input type (e.g. string, boolean)

public setType ( string $typeIndicator ) : Airship\Engine\Contract\Security\FilterInterface
$typeIndicator	string
return	Airship\Engine\Contract\Security\FilterInterface