PHP Class Airship\Engine\Security\Filter\InputFilterContainer

Contains a set of filter rules, useful for enforcing a strict type on unstrucutred data (e.g. HTTP POST parameters).
Inheritance: implements FilterContainerInterface
Show file Open project: paragonie/airship

Protected Properties

Property Type Description
$filterMap InputFilter[]

Public Methods

Method Description
__construct ( ) InputFilterContainer constructor.
__invoke ( array $dataInput = [] ) : array Process the input array.
addFilter ( string $path, FilterInterface $filter ) : FilterContainerInterface Add a new filter to this input value
filterValue ( string $key, mixed $multiDimensional ) : mixed Use firstlevel.second_level.thirdLevel to find indices in an array
getUnfilteredValue ( string $key, array $multiDimensional = [] ) : mixed Use firstlevel.second_level.thirdLevel to find indices in an array

Protected Methods

Method Description
sanitize ( string $input ) : string Only allow allow printable ASCII characters:

Method Details

__construct() abstract public method

InputFilterContainer constructor.
abstract public __construct ( )

__invoke() public method

Process the input array.
public __invoke ( array $dataInput = [] ) : array
$dataInput array
return array

addFilter() public method

Add a new filter to this input value
public addFilter ( string $path, FilterInterface $filter ) : FilterContainerInterface
$path string
$filter FilterInterface
return FilterContainerInterface

filterValue() public method

Use firstlevel.second_level.thirdLevel to find indices in an array
public filterValue ( string $key, mixed $multiDimensional ) : mixed
$key string
$multiDimensional mixed
return mixed

getUnfilteredValue() public method

Doesn't apply filters
public getUnfilteredValue ( string $key, array $multiDimensional = [] ) : mixed
$key string
$multiDimensional array
return mixed

sanitize() protected static method

Only allow allow printable ASCII characters:
protected static sanitize ( string $input ) : string
$input string
return string

Property Details

$filterMap protected property

protected InputFilter[],Airship\Engine\Security\Filter $filterMap
return InputFilter[]