PHP Neomerx\JsonApi\Contracts\Http HttpFactoryInterface::createQueryChecker Examples

createQueryChecker() public method

Create query parameters checker.

public createQueryChecker ( boolean | false $allowUnrecognized = false, array $includePaths = null, array $fieldSetTypes = null, array $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null ) : Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface
$allowUnrecognized	boolean | false
$includePaths	array
$fieldSetTypes	array
$sortParameters	array
$pagingParameters	array
$filteringParameters	array
return	Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface

Example #1

File: ChecksQueryParameters.php Project: cloudcreativity/json-api

 /**
  * @param HttpFactoryInterface $factory
  * @param EncodingParametersInterface $parameters
  * @param ApiInterface $api
  * @throws JsonApiException
  */
 private function checkEncodingParameters(HttpFactoryInterface $factory, EncodingParametersInterface $parameters, ApiInterface $api)
 {
     $checker = $factory->createQueryChecker($this->allowUnrecognizedParameters(), $this->allowedIncludePaths(), $this->allowedFieldSetTypes(), $this->allowedSortParameters(), $this->allowedPagingParameters($api->getPagingStrategy()), $this->allowedFilteringParameters());
     $checker->checkQuery($parameters);
 }