lib/classes/JsonApi/JsonApiIntegration/QueryParserInterface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<?php

namespace JsonApi\JsonApiIntegration;

use Neomerx\JsonApi\Contracts\Http\Query\BaseQueryParserInterface;

interface QueryParserInterface extends BaseQueryParserInterface
{
    /** Query parameter */
    const PARAM_PAGING_LIMIT = 'limit';

    /** Query parameter */
    const PARAM_PAGING_OFFSET = 'offset';

    public function getIncludePaths(): iterable;

    public function getFilters(): iterable;

    /**
     * @return iterable
     */
    public function getPagination(): iterable;

    public function getUnrecognizedParameters(): iterable;
}