FilterPatcher
in package
Table of Contents
Properties
- $filtersRequiredKeys : array<string|int, mixed>
- $handlers : array<string|int, mixed>
- $sortAllowedKeys : array<string|int, mixed>
Methods
- __construct() : mixed
- addHandler() : void
- apply() : void
- registerHandlers() : void
- allowedKeySet() : array<string, true>
- findMapKeyByValue() : string
- isAllowedKey() : bool
Properties
$filtersRequiredKeys
private
array<string|int, mixed>
$filtersRequiredKeys
= ['key', 'filterMethod', 'value']
$handlers
private
array<string|int, mixed>
$handlers
= []
$sortAllowedKeys
private
array<string|int, mixed>
$sortAllowedKeys
= ['id', 'submitDate']
Methods
__construct()
public
__construct() : mixed
addHandler()
public
addHandler(string $handler) : void
Parameters
- $handler : string
apply()
public
apply(array<string|int, mixed> $filterParams, LSDbCriteria &$criteria, CSort &$sort[, array<string|int, mixed> $dataMap = array() ][, array<string|int, mixed> $validColumns = array() ]) : void
Parameters
- $filterParams : array<string|int, mixed>
- $criteria : LSDbCriteria
- $sort : CSort
- $dataMap : array<string|int, mixed> = array()
-
Static attribute map of the response transformer.
- $validColumns : array<string|int, mixed> = array()
-
Real response columns (system + nested question/subquestion columns) used to validate filter keys. When empty no validation is performed, preserving the previous behaviour.
Tags
registerHandlers()
public
registerHandlers() : void
allowedKeySet()
private
allowedKeySet(array<string|int, mixed> $dataMap, array<string|int, mixed> $validColumns) : array<string, true>
Parameters
- $dataMap : array<string|int, mixed>
- $validColumns : array<string|int, mixed>
Return values
array<string, true>findMapKeyByValue()
private
findMapKeyByValue(string $targetValue, array<string|int, mixed> $dataMap) : string
Parameters
- $targetValue : string
- $dataMap : array<string|int, mixed>
Return values
stringisAllowedKey()
private
isAllowedKey(string|array<string|int, mixed> $key, array<string|int, mixed> $dataMap, array<string|int, mixed> $validColumns) : bool
Parameters
- $key : string|array<string|int, mixed>
- $dataMap : array<string|int, mixed>
- $validColumns : array<string|int, mixed>