PHP Class Neomerx\JsonApi\Http\Query\RestrictiveQueryChecker

Inheritance: implements Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface

Datei anzeigen Open project: neomerx/json-api

Public Methods

Method	Description
__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 )

Protected Methods

Method	Description
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 )

Private Methods

Method	Description
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

Method Details

__construct() public method

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 method

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 method

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 method

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 method

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 method

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

checkSorting() protected method

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 method

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