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

  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\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  20. use ApiPlatform\Core\Api\OperationType;
  21. use ApiPlatform\JsonLd\ContextBuilderInterface;
  22. use ApiPlatform\JsonLd\Serializer\JsonLdContextTrait;
  23. use ApiPlatform\Metadata\CollectionOperationInterface;
  24. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  25. use ApiPlatform\Serializer\ContextTrait;
  26. use ApiPlatform\State\Pagination\PaginatorInterface;
  27. use ApiPlatform\State\Pagination\PartialPaginatorInterface;
  28. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  29. use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
  30. use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
  31. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  33. /**
  34.  * This normalizer handles collections.
  35.  *
  36.  * @author Kevin Dunglas <dunglas@gmail.com>
  37.  * @author Samuel ROZE <samuel.roze@gmail.com>
  38.  */
  39. final class CollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
  40. {
  41.     use ContextTrait;
  42.     use JsonLdContextTrait;
  43.     use NormalizerAwareTrait;
  45.     public const FORMAT = 'jsonld';
  46.     public const IRI_ONLY = 'iri_only';
  48.     private $contextBuilder;
  49.     private $resourceClassResolver;
  50.     private $iriConverter;
  51.     private $resourceMetadataCollectionFactory;
  52.     private $defaultContext = [
  53.         self::IRI_ONLY => false,
  54.     ];
  56.     public function __construct(ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, $iriConverter, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, array $defaultContext = [])
  57.     {
  58.         $this->contextBuilder = $contextBuilder;
  59.         $this->resourceClassResolver = $resourceClassResolver;
  61.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  62.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  63.         }
  64.         $this->iriConverter = $iriConverter;
  65.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  66.         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function supportsNormalization($data, $format = null, array $context = []): bool
  73.     {
  74.         return self::FORMAT === $format && is_iterable($data);
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      *
  80.      * @param iterable $object
  81.      */
  82.     public function normalize($object, $format = null, array $context = []): array
  83.     {
  84.         if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
  85.             return $this->normalizeRawCollection($object, $format, $context);
  86.         }
  88.         $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
  89.         $context = $this->initContext($resourceClass, $context);
  90.         $context['api_collection_sub_level'] = true;
  91.         $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
  93.         if ($this->iriConverter instanceof LegacyIriConverterInterface) {
  94.             // TODO: remove in 3.0
  95.             $data['@id'] = isset($context['operation_type']) && OperationType::SUBRESOURCE === $context['operation_type'] ? $this->iriConverter->getSubresourceIriFromResourceClass($resourceClass, $context) : $this->iriConverter->getIriFromResourceClass($resourceClass);
  96.         } else {
  97.             $data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
  98.         }
  100.         $data['@type'] = 'hydra:Collection';
  101.         $data['hydra:member'] = [];
  102.         $iriOnly = $context[self::IRI_ONLY] ?? $this->defaultContext[self::IRI_ONLY];
  104.         // We need to keep this operation for serialization groups for later
  105.         if (isset($context['operation'])) {
  106.             $context['root_operation'] = $context['operation'];
  107.         }
  109.         if (isset($context['operation_name'])) {
  110.             $context['root_operation_name'] = $context['operation_name'];
  111.         }
  113.         if ($this->resourceMetadataCollectionFactory && ($operation = $context['operation'] ?? null) instanceof CollectionOperationInterface && ($itemUriTemplate = $operation->getItemUriTemplate())) {
  114.             $context['operation'] = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operation->getItemUriTemplate());
  115.         } else {
  116.             unset($context['operation']);
  117.         }
  119.         unset($context['operation_name'], $context['uri_variables']);
  121.         foreach ($object as $obj) {
  122.             if ($iriOnly) {
  123.                 $data['hydra:member'][] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($obj) : $this->iriConverter->getIriFromResource($obj);
  124.             } else {
  125.                 $data['hydra:member'][] = $this->normalizer->normalize($obj, $format, $context);
  126.             }
  127.         }
  129.         if ($object instanceof PaginatorInterface) {
  130.             $data['hydra:totalItems'] = $object->getTotalItems();
  131.         }
  132.         if (\is_array($object) || ($object instanceof \Countable && !$object instanceof PartialPaginatorInterface)) {
  133.             $data['hydra:totalItems'] = \count($object);
  134.         }
  136.         return $data;
  137.     }
  139.     /**
  140.      * {@inheritdoc}
  141.      */
  142.     public function hasCacheableSupportsMethod(): bool
  143.     {
  144.         return true;
  145.     }
  147.     /**
  148.      * Normalizes a raw collection (not API resources).
  149.      */
  150.     private function normalizeRawCollection(iterable $object, ?string $format, array $context): array
  151.     {
  152.         $data = [];
  153.         foreach ($object as $index => $obj) {
  154.             $data[$index] = $this->normalizer->normalize($obj, $format, $context);
  155.         }
  157.         return $data;
  158.     }
  159. }
  161. class_alias(CollectionNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\CollectionNormalizer::class);