vendor/api-platform/core/src/Hydra/Serializer/PartialCollectionViewNormalizer.php line 50

  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\Hydra\Serializer;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\State\Pagination\PaginatorInterface;
  19. use ApiPlatform\State\Pagination\PartialPaginatorInterface;
  20. use ApiPlatform\Util\IriHelper;
  21. use Symfony\Component\PropertyAccess\PropertyAccess;
  22. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  23. use Symfony\Component\Serializer\Exception\UnexpectedValueException;
  24. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  25. use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
  26. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  28. /**
  29.  * Adds a view key to the result of a paginated Hydra collection.
  30.  *
  31.  * @author Kévin Dunglas <dunglas@gmail.com>
  32.  * @author Samuel ROZE <samuel.roze@gmail.com>
  33.  */
  34. final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
  35. {
  36.     private $collectionNormalizer;
  37.     private $pageParameterName;
  38.     private $enabledParameterName;
  39.     private $resourceMetadataFactory;
  40.     private $propertyAccessor;
  42.     public function __construct(NormalizerInterface $collectionNormalizer, string $pageParameterName = 'page', string $enabledParameterName = 'pagination', $resourceMetadataFactory = null, PropertyAccessorInterface $propertyAccessor = null)
  43.     {
  44.         $this->collectionNormalizer = $collectionNormalizer;
  45.         $this->pageParameterName = $pageParameterName;
  46.         $this->enabledParameterName = $enabledParameterName;
  47.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  49.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  50.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  51.         }
  53.         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      *
  59.      * @return array|string|int|float|bool|\ArrayObject|null
  60.      */
  61.     public function normalize($object, $format = null, array $context = [])
  62.     {
  63.         $data = $this->collectionNormalizer->normalize($object, $format, $context);
  64.         if (!\is_array($data)) {
  65.             throw new UnexpectedValueException('Expected data to be an array');
  66.         }
  68.         if (isset($context['api_sub_level'])) {
  69.             return $data;
  70.         }
  72.         $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;
  73.         if ($paginated = ($object instanceof PartialPaginatorInterface)) {
  74.             if ($object instanceof PaginatorInterface) {
  75.                 $paginated = 1. !== $lastPage = $object->getLastPage();
  76.             } else {
  77.                 $itemsPerPage = $object->getItemsPerPage();
  78.                 $pageTotalItems = (float) \count($object);
  79.             }
  81.             $currentPage = $object->getCurrentPage();
  82.         }
  84.         $parsed = IriHelper::parseIri($context['request_uri'] ?? '/', $this->pageParameterName);
  85.         $appliedFilters = $parsed['parameters'];
  86.         unset($appliedFilters[$this->enabledParameterName]);
  88.         if (!$appliedFilters && !$paginated) {
  89.             return $data;
  90.         }
  92.         $isPaginatedWithCursor = false;
  93.         $cursorPaginationAttribute = null;
  94.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface && isset($context['resource_class']) && $paginated) {
  95.             $metadata = $this->resourceMetadataFactory->create($context['resource_class']);
  96.             $isPaginatedWithCursor = null !== $cursorPaginationAttribute = $metadata->getCollectionOperationAttribute($context['collection_operation_name'] ?? $context['subresource_operation_name'], 'pagination_via_cursor', null, true);
  97.         } elseif ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface && isset($context['resource_class']) && $paginated) {
  98.             $operation = $this->resourceMetadataFactory->create($context['resource_class'])->getOperation($context['operation_name'] ?? null);
  99.             $isPaginatedWithCursor = [] !== $cursorPaginationAttribute = ($operation->getPaginationViaCursor() ?? []);
  100.         }
  102.         $data['hydra:view'] = ['@id' => null, '@type' => 'hydra:PartialCollectionView'];
  104.         if ($isPaginatedWithCursor) {
  105.             return $this->populateDataWithCursorBasedPagination($data, $parsed, $object, $cursorPaginationAttribute);
  106.         }
  108.         $data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null);
  110.         if ($paginated) {
  111.             return $this->populateDataWithPagination($data, $parsed, $currentPage, $lastPage, $itemsPerPage, $pageTotalItems);
  112.         }
  114.         return $data;
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function supportsNormalization($data, $format = null, array $context = []): bool
  121.     {
  122.         return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
  123.     }
  125.     /**
  126.      * {@inheritdoc}
  127.      */
  128.     public function hasCacheableSupportsMethod(): bool
  129.     {
  130.         return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
  131.     }
  133.     /**
  134.      * {@inheritdoc}
  135.      */
  136.     public function setNormalizer(NormalizerInterface $normalizer)
  137.     {
  138.         if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {
  139.             $this->collectionNormalizer->setNormalizer($normalizer);
  140.         }
  141.     }
  143.     private function cursorPaginationFields(array $fields, int $direction, $object)
  144.     {
  145.         $paginationFilters = [];
  147.         foreach ($fields as $field) {
  148.             $forwardRangeOperator = 'desc' === strtolower($field['direction']) ? 'lt' : 'gt';
  149.             $backwardRangeOperator = 'gt' === $forwardRangeOperator ? 'lt' : 'gt';
  151.             $operator = $direction > 0 ? $forwardRangeOperator : $backwardRangeOperator;
  153.             $paginationFilters[$field['field']] = [
  154.                 $operator => (string) $this->propertyAccessor->getValue($object, $field['field']),
  155.             ];
  156.         }
  158.         return $paginationFilters;
  159.     }
  161.     private function populateDataWithCursorBasedPagination(array $data, array $parsed, \Traversable $object, $cursorPaginationAttribute): array
  162.     {
  163.         $objects = iterator_to_array($object);
  164.         $firstObject = current($objects);
  165.         $lastObject = end($objects);
  167.         $data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters']);
  169.         if (false !== $lastObject && \is_array($cursorPaginationAttribute)) {
  170.             $data['hydra:view']['hydra:next'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, 1, $lastObject)));
  171.         }
  173.         if (false !== $firstObject && \is_array($cursorPaginationAttribute)) {
  174.             $data['hydra:view']['hydra:previous'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, -1, $firstObject)));
  175.         }
  177.         return $data;
  178.     }
  180.     private function populateDataWithPagination(array $data, array $parsed, ?float $currentPage, ?float $lastPage, ?float $itemsPerPage, ?float $pageTotalItems): array
  181.     {
  182.         if (null !== $lastPage) {
  183.             $data['hydra:view']['hydra:first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1.);
  184.             $data['hydra:view']['hydra:last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage);
  185.         }
  187.         if (1. !== $currentPage) {
  188.             $data['hydra:view']['hydra:previous'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1.);
  189.         }
  191.         if ((null !== $lastPage && $currentPage < $lastPage) || (null === $lastPage && $pageTotalItems >= $itemsPerPage)) {
  192.             $data['hydra:view']['hydra:next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1.);
  193.         }
  195.         return $data;
  196.     }
  197. }
  199. class_alias(PartialCollectionViewNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\PartialCollectionViewNormalizer::class);