vendor/api-platform/core/src/Core/DataProvider/Pagination.php line 169

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\DataProvider;
  16. use ApiPlatform\Core\Exception\InvalidArgumentException;
  17. use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
  18. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  20. /**
  21.  * Pagination configuration.
  22.  *
  23.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  24.  */
  25. final class Pagination
  26. {
  27.     private $options;
  28.     private $graphQlOptions;
  29.     private $resourceMetadataFactory;
  31.     public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $options = [], array $graphQlOptions = [])
  32.     {
  33.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  34.         $this->options = array_merge([
  35.             'enabled' => true,
  36.             'client_enabled' => false,
  37.             'client_items_per_page' => false,
  38.             'items_per_page' => 30,
  39.             'page_default' => 1,
  40.             'page_parameter_name' => 'page',
  41.             'enabled_parameter_name' => 'pagination',
  42.             'items_per_page_parameter_name' => 'itemsPerPage',
  43.             'maximum_items_per_page' => null,
  44.             'partial' => false,
  45.             'client_partial' => false,
  46.             'partial_parameter_name' => 'partial',
  47.         ], $options);
  48.         $this->graphQlOptions = array_merge([
  49.             'enabled' => true,
  50.         ], $graphQlOptions);
  51.     }
  53.     /**
  54.      * Gets the current page.
  55.      *
  56.      * @throws InvalidArgumentException
  57.      */
  58.     public function getPage(array $context = []): int
  59.     {
  60.         $page = (int) $this->getParameterFromContext(
  61.             $context,
  62.             $this->options['page_parameter_name'],
  63.             $this->options['page_default']
  64.         );
  66.         if (1 > $page) {
  67.             throw new InvalidArgumentException('Page should not be less than 1');
  68.         }
  70.         return $page;
  71.     }
  73.     /**
  74.      * Gets the current offset.
  75.      */
  76.     public function getOffset(string $resourceClass = null, string $operationName = null, array $context = []): int
  77.     {
  78.         $graphql = (bool) ($context['graphql_operation_name'] ?? false);
  80.         $limit = $this->getLimit($resourceClass, $operationName, $context);
  82.         if ($graphql && null !== ($after = $this->getParameterFromContext($context, 'after'))) {
  83.             return false === ($after = base64_decode($after, true)) ? 0 : (int) $after + 1;
  84.         }
  86.         if ($graphql && null !== ($before = $this->getParameterFromContext($context, 'before'))) {
  87.             return ($offset = (false === ($before = base64_decode($before, true)) ? 0 : (int) $before - $limit)) < 0 ? 0 : $offset;
  88.         }
  90.         if ($graphql && null !== ($last = $this->getParameterFromContext($context, 'last'))) {
  91.             return ($offset = ($context['count'] ?? 0) - $last) < 0 ? 0 : $offset;
  92.         }
  94.         $offset = ($this->getPage($context) - 1) * $limit;
  96.         if (!\is_int($offset)) {
  97.             throw new InvalidArgumentException('Page parameter is too large.');
  98.         }
  100.         return $offset;
  101.     }
  103.     /**
  104.      * Gets the current limit.
  105.      *
  106.      * @throws InvalidArgumentException
  107.      */
  108.     public function getLimit(string $resourceClass = null, string $operationName = null, array $context = []): int
  109.     {
  110.         $graphql = (bool) ($context['graphql_operation_name'] ?? false);
  112.         $limit = $this->options['items_per_page'];
  113.         $clientLimit = $this->options['client_items_per_page'];
  115.         if (null !== $resourceClass) {
  116.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  117.             $limit = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_items_per_page', $limit, true);
  118.             $clientLimit = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_client_items_per_page', $clientLimit, true);
  119.         }
  121.         if ($graphql && null !== ($first = $this->getParameterFromContext($context, 'first'))) {
  122.             $limit = $first;
  123.         }
  125.         if ($graphql && null !== ($last = $this->getParameterFromContext($context, 'last'))) {
  126.             $limit = $last;
  127.         }
  129.         if ($graphql && null !== ($before = $this->getParameterFromContext($context, 'before'))
  130.             && (false === ($before = base64_decode($before, true)) ? 0 : (int) $before - $limit) < 0) {
  131.             $limit = (int) $before;
  132.         }
  134.         if ($clientLimit) {
  135.             $limit = (int) $this->getParameterFromContext($context, $this->options['items_per_page_parameter_name'], $limit);
  136.             $maxItemsPerPage = null;
  138.             if (null !== $resourceClass) {
  139.                 $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  140.                 $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', null, true);
  141.                 if (null !== $maxItemsPerPage) {
  142.                     @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', \E_USER_DEPRECATED);
  143.                 }
  144.                 $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_maximum_items_per_page', $maxItemsPerPage ?? $this->options['maximum_items_per_page'], true);
  145.             }
  147.             if (null !== $maxItemsPerPage && $limit > $maxItemsPerPage) {
  148.                 $limit = $maxItemsPerPage;
  149.             }
  150.         }
  152.         if (0 > $limit) {
  153.             throw new InvalidArgumentException('Limit should not be less than 0');
  154.         }
  156.         return $limit;
  157.     }
  159.     /**
  160.      * Gets info about the pagination.
  161.      *
  162.      * Returns an array with the following info as values:
  163.      *   - the page {@see Pagination::getPage()}
  164.      *   - the offset {@see Pagination::getOffset()}
  165.      *   - the limit {@see Pagination::getLimit()}
  166.      *
  167.      * @throws InvalidArgumentException
  168.      */
  169.     public function getPagination(string $resourceClass = null, string $operationName = null, array $context = []): array
  170.     {
  171.         $page = $this->getPage($context);
  172.         $limit = $this->getLimit($resourceClass, $operationName, $context);
  174.         if (0 === $limit && 1 < $page) {
  175.             throw new InvalidArgumentException('Page should not be greater than 1 if limit is equal to 0');
  176.         }
  178.         return [$page, $this->getOffset($resourceClass, $operationName, $context), $limit];
  179.     }
  181.     /**
  182.      * Is the pagination enabled?
  183.      */
  184.     public function isEnabled(string $resourceClass = null, string $operationName = null, array $context = []): bool
  185.     {
  186.         return $this->getEnabled($context, $resourceClass, $operationName);
  187.     }
  189.     /**
  190.      * Is the pagination enabled for GraphQL?
  191.      */
  192.     public function isGraphQlEnabled(string $resourceClass = null, string $operationName = null, array $context = []): bool
  193.     {
  194.         return $this->getGraphQlEnabled($resourceClass, $operationName);
  195.     }
  197.     /**
  198.      * Is the partial pagination enabled?
  199.      */
  200.     public function isPartialEnabled(string $resourceClass = null, string $operationName = null, array $context = []): bool
  201.     {
  202.         return $this->getEnabled($context, $resourceClass, $operationName, true);
  203.     }
  205.     public function getOptions(): array
  206.     {
  207.         return $this->options;
  208.     }
  210.     public function getGraphQlPaginationType(string $resourceClass, string $operationName): string
  211.     {
  212.         try {
  213.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  214.         } catch (ResourceClassNotFoundException $e) {
  215.             return 'cursor';
  216.         }
  218.         return (string) $resourceMetadata->getGraphqlAttribute($operationName, 'pagination_type', 'cursor', true);
  219.     }
  221.     /**
  222.      * Is the classic or partial pagination enabled?
  223.      */
  224.     private function getEnabled(array $context, string $resourceClass = null, string $operationName = null, bool $partial = false): bool
  225.     {
  226.         $enabled = $this->options[$partial ? 'partial' : 'enabled'];
  227.         $clientEnabled = $this->options[$partial ? 'client_partial' : 'client_enabled'];
  229.         if (null !== $resourceClass) {
  230.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  231.             $enabled = $resourceMetadata->getCollectionOperationAttribute($operationName, $partial ? 'pagination_partial' : 'pagination_enabled', $enabled, true);
  233.             $clientEnabled = $resourceMetadata->getCollectionOperationAttribute($operationName, $partial ? 'pagination_client_partial' : 'pagination_client_enabled', $clientEnabled, true);
  234.         }
  236.         if ($clientEnabled) {
  237.             return filter_var($this->getParameterFromContext($context, $this->options[$partial ? 'partial_parameter_name' : 'enabled_parameter_name'], $enabled), \FILTER_VALIDATE_BOOLEAN);
  238.         }
  240.         return (bool) $enabled;
  241.     }
  243.     private function getGraphQlEnabled(?string $resourceClass, ?string $operationName): bool
  244.     {
  245.         $enabled = $this->graphQlOptions['enabled'];
  247.         if (null !== $resourceClass) {
  248.             try {
  249.                 $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  250.             } catch (ResourceClassNotFoundException $e) {
  251.                 return $enabled;
  252.             }
  254.             return (bool) $resourceMetadata->getGraphqlAttribute($operationName, 'pagination_enabled', $enabled, true);
  255.         }
  257.         return $enabled;
  258.     }
  260.     /**
  261.      * Gets the given pagination parameter name from the given context.
  262.      *
  263.      * @param mixed|null $default
  264.      */
  265.     private function getParameterFromContext(array $context, string $parameterName, $default = null)
  266.     {
  267.         $filters = $context['filters'] ?? [];
  269.         return \array_key_exists($parameterName, $filters) ? $filters[$parameterName] : $default;
  270.     }
  271. }