vendor/api-platform/core/src/Doctrine/Odm/Extension/PaginationExtension.php line 112

  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\Doctrine\Odm\Extension;
  16. use ApiPlatform\Doctrine\Odm\Paginator;
  17. use ApiPlatform\Exception\RuntimeException;
  18. use ApiPlatform\Metadata\Operation;
  19. use ApiPlatform\State\Pagination\Pagination;
  20. use Doctrine\ODM\MongoDB\Aggregation\Builder;
  21. use Doctrine\ODM\MongoDB\DocumentManager;
  22. use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
  23. use Doctrine\Persistence\ManagerRegistry;
  25. /**
  26.  * Applies pagination on the Doctrine aggregation for resource collection when enabled.
  27.  *
  28.  * @author Kévin Dunglas <dunglas@gmail.com>
  29.  * @author Samuel ROZE <samuel.roze@gmail.com>
  30.  * @author Alan Poulain <contact@alanpoulain.eu>
  31.  */
  32. final class PaginationExtension implements AggregationResultCollectionExtensionInterface
  33. {
  34.     public function __construct(private readonly ManagerRegistry $managerRegistry, private readonly Pagination $pagination)
  35.     {
  36.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      *
  41.      * @throws RuntimeException
  42.      */
  43.     public function applyToCollection(Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array &$context = []): void
  44.     {
  45.         if (!$this->pagination->isEnabled($operation, $context)) {
  46.             return;
  47.         }
  49.         if (($context['graphql_operation_name'] ?? false) && !$this->pagination->isGraphQlEnabled($operation, $context)) {
  50.             return;
  51.         }
  53.         $context = $this->addCountToContext(clone $aggregationBuilder, $context);
  55.         [, $offset, $limit] = $this->pagination->getPagination($operation, $context);
  57.         $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  58.         if (!$manager instanceof DocumentManager) {
  59.             throw new RuntimeException(sprintf('The manager for "%s" must be an instance of "%s".', $resourceClass, DocumentManager::class));
  60.         }
  62.         /**
  63.          * @var DocumentRepository
  64.          */
  65.         $repository = $manager->getRepository($resourceClass);
  66.         $resultsAggregationBuilder = $repository->createAggregationBuilder()->skip($offset);
  67.         if ($limit > 0) {
  68.             $resultsAggregationBuilder->limit($limit);
  69.         } else {
  70.             // Results have to be 0 but MongoDB does not support a limit equal to 0.
  71.             $resultsAggregationBuilder->match()->field(Paginator::LIMIT_ZERO_MARKER_FIELD)->equals(Paginator::LIMIT_ZERO_MARKER);
  72.         }
  74.         $aggregationBuilder
  75.             ->facet()
  76.             ->field('results')->pipeline(
  77.                 $resultsAggregationBuilder
  78.             )
  79.             ->field('count')->pipeline(
  80.                 $repository->createAggregationBuilder()
  81.                     ->count('count')
  82.             );
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function supportsResult(string $resourceClass, Operation $operation = null, array $context = []): bool
  89.     {
  90.         if ($context['graphql_operation_name'] ?? false) {
  91.             return $this->pagination->isGraphQlEnabled($operation, $context);
  92.         }
  94.         return $this->pagination->isEnabled($operation, $context);
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      *
  100.      * @throws RuntimeException
  101.      */
  102.     public function getResult(Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array $context = []): iterable
  103.     {
  104.         $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  105.         if (!$manager instanceof DocumentManager) {
  106.             throw new RuntimeException(sprintf('The manager for "%s" must be an instance of "%s".', $resourceClass, DocumentManager::class));
  107.         }
  109.         $attribute = $operation?->getExtraProperties()['doctrine_mongodb'] ?? [];
  110.         $executeOptions = $attribute['execute_options'] ?? [];
  112.         return new Paginator($aggregationBuilder->execute($executeOptions), $manager->getUnitOfWork(), $resourceClass, $aggregationBuilder->getPipeline());
  113.     }
  115.     private function addCountToContext(Builder $aggregationBuilder, array $context): array
  116.     {
  117.         if (!($context['graphql_operation_name'] ?? false)) {
  118.             return $context;
  119.         }
  121.         if (isset($context['filters']['last']) && !isset($context['filters']['before'])) {
  122.             $context['count'] = $aggregationBuilder->count('count')->execute()->toArray()[0]['count'];
  123.         }
  125.         return $context;
  126.     }
  127. }