PHP Класс Neomerx\JsonApi\Http\Query\RestrictiveQueryChecker

Наследование: implements Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( boolean $allowUnrecognized = true, array $includePaths = null, array $fieldSetTypes = null, array $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null )
checkQuery ( Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )

Защищенные методы

Метод Описание
checkFieldSets ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
checkFiltering ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
checkIncludePaths ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
checkPaging ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
checkSorting ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
checkUnrecognized ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )

Приватные методы

Метод Описание
flip ( array $array = null ) : array | null
isFieldsAllowed ( array $fields = null ) : boolean Check input fields against allowed.
keysWithinAllowed ( array $toCheck = null, array $allowed = null ) : boolean
valuesWithinAllowed ( array $toCheck = null, array $allowed = null ) : boolean

Описание методов

__construct() публичный Метод

public __construct ( boolean $allowUnrecognized = true, array $includePaths = null, array $fieldSetTypes = null, array $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null )
$allowUnrecognized boolean
$includePaths array
$fieldSetTypes array
$sortParameters array
$pagingParameters array
$filteringParameters array

checkFieldSets() защищенный Метод

protected checkFieldSets ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkFiltering() защищенный Метод

protected checkFiltering ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkIncludePaths() защищенный Метод

protected checkIncludePaths ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkPaging() защищенный Метод

protected checkPaging ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkQuery() публичный Метод

public checkQuery ( Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkSorting() защищенный Метод

protected checkSorting ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

checkUnrecognized() защищенный Метод

protected checkUnrecognized ( ErrorCollection $errors, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters )
$errors Neomerx\JsonApi\Exceptions\ErrorCollection
$parameters Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface