vendor/api-platform/core/src/Hydra/Serializer/CollectionNormalizer.php line 67

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\Hydra\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\ResourceClassResolverInterface;
  18. use ApiPlatform\Api\UrlGeneratorInterface;
  19. use ApiPlatform\JsonLd\ContextBuilderInterface;
  20. use ApiPlatform\JsonLd\Serializer\JsonLdContextTrait;
  21. use ApiPlatform\Metadata\CollectionOperationInterface;
  22. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  23. use ApiPlatform\Serializer\ContextTrait;
  24. use ApiPlatform\State\Pagination\PaginatorInterface;
  25. use ApiPlatform\State\Pagination\PartialPaginatorInterface;
  26. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  27. use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
  28. use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
  29. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  31. /**
  32.  * This normalizer handles collections.
  33.  *
  34.  * @author Kevin Dunglas <dunglas@gmail.com>
  35.  * @author Samuel ROZE <samuel.roze@gmail.com>
  36.  */
  37. final class CollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
  38. {
  39.     use ContextTrait;
  40.     use JsonLdContextTrait;
  41.     use NormalizerAwareTrait;
  43.     public const FORMAT = 'jsonld';
  44.     public const IRI_ONLY = 'iri_only';
  45.     private array $defaultContext = [
  46.         self::IRI_ONLY => false,
  47.     ];
  49.     public function __construct(private readonly ContextBuilderInterface $contextBuilder, private readonly ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, array $defaultContext = [])
  50.     {
  51.         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  58.     {
  59.         return self::FORMAT === $format && is_iterable($data) && isset($context['resource_class']) && !isset($context['api_sub_level']);
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      *
  65.      * @param iterable $object
  66.      */
  67.     public function normalize(mixed $object, string $format = null, array $context = []): array
  68.     {
  69.         $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
  70.         $context = $this->initContext($resourceClass, $context);
  71.         $context['api_collection_sub_level'] = true;
  72.         $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
  73.         $data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
  74.         $data['@type'] = 'hydra:Collection';
  75.         $data['hydra:member'] = [];
  76.         $iriOnly = $context[self::IRI_ONLY] ?? $this->defaultContext[self::IRI_ONLY];
  78.         if ($this->resourceMetadataCollectionFactory && ($operation = $context['operation'] ?? null) instanceof CollectionOperationInterface && method_exists($operation, 'getItemUriTemplate') && ($itemUriTemplate = $operation->getItemUriTemplate())) {
  79.             $context['operation'] = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operation->getItemUriTemplate());
  80.         } else {
  81.             unset($context['operation']);
  82.         }
  83.         unset($context['operation_name'], $context['uri_variables']);
  85.         foreach ($object as $obj) {
  86.             if ($iriOnly) {
  87.                 $data['hydra:member'][] = $this->iriConverter->getIriFromResource($obj);
  88.             } else {
  89.                 $data['hydra:member'][] = $this->normalizer->normalize($obj, $format, $context);
  90.             }
  91.         }
  93.         if ($object instanceof PaginatorInterface) {
  94.             $data['hydra:totalItems'] = $object->getTotalItems();
  95.         }
  97.         if (\is_array($object) || ($object instanceof \Countable && !$object instanceof PartialPaginatorInterface)) {
  98.             $data['hydra:totalItems'] = \count($object);
  99.         }
  101.         return $data;
  102.     }
  104.     public function hasCacheableSupportsMethod(): bool
  105.     {
  106.         return false;
  107.     }
  108. }