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

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\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\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  24. use ApiPlatform\Serializer\ContextTrait;
  25. use ApiPlatform\Serializer\OperationContextTrait;
  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;
  44.     use OperationContextTrait;
  46.     public const FORMAT = 'jsonld';
  47.     public const IRI_ONLY = 'iri_only';
  49.     private $contextBuilder;
  50.     private $resourceClassResolver;
  51.     private $iriConverter;
  52.     private $resourceMetadataCollectionFactory;
  53.     private $defaultContext = [
  54.         self::IRI_ONLY => false,
  55.     ];
  57.     public function __construct(ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, $iriConverter, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, array $defaultContext = [])
  58.     {
  59.         $this->contextBuilder = $contextBuilder;
  60.         $this->resourceClassResolver = $resourceClassResolver;
  62.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  63.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  64.         }
  65.         $this->iriConverter = $iriConverter;
  66.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  67.         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
  68.     }
  70.     public function supportsNormalization($data, $format = null, array $context = []): bool
  71.     {
  72.         return self::FORMAT === $format && is_iterable($data);
  73.     }
  75.     /**
  76.      * @param iterable   $object
  77.      * @param mixed|null $format
  78.      */
  79.     public function normalize($object, $format = null, array $context = []): array
  80.     {
  81.         if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
  82.             return $this->normalizeRawCollection($object, $format, $context);
  83.         }
  85.         $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
  86.         $context = $this->initContext($resourceClass, $context);
  87.         $context['api_collection_sub_level'] = true;
  88.         $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
  90.         if ($this->iriConverter instanceof LegacyIriConverterInterface) {
  91.             // TODO: remove in 3.0
  92.             $data['@id'] = isset($context['operation_type']) && OperationType::SUBRESOURCE === $context['operation_type'] ? $this->iriConverter->getSubresourceIriFromResourceClass($resourceClass, $context) : $this->iriConverter->getIriFromResourceClass($resourceClass);
  93.         } else {
  94.             $data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
  95.         }
  97.         $data['@type'] = 'hydra:Collection';
  98.         $data['hydra:member'] = [];
  99.         $iriOnly = $context[self::IRI_ONLY] ?? $this->defaultContext[self::IRI_ONLY];
  101.         $childContext = $this->createOperationContext($context, $resourceClass);
  102.         foreach ($object as $obj) {
  103.             if ($iriOnly) {
  104.                 $data['hydra:member'][] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($obj) : $this->iriConverter->getIriFromResource($obj);
  105.             } else {
  106.                 $data['hydra:member'][] = $this->normalizer->normalize($obj, $format, $childContext);
  107.             }
  108.         }
  110.         if ($object instanceof PaginatorInterface) {
  111.             $data['hydra:totalItems'] = $object->getTotalItems();
  112.         }
  113.         if (\is_array($object) || ($object instanceof \Countable && !$object instanceof PartialPaginatorInterface)) {
  114.             $data['hydra:totalItems'] = \count($object);
  115.         }
  117.         return $data;
  118.     }
  120.     public function hasCacheableSupportsMethod(): bool
  121.     {
  122.         return true;
  123.     }
  125.     /**
  126.      * Normalizes a raw collection (not API resources).
  127.      */
  128.     private function normalizeRawCollection(iterable $object, ?string $format, array $context): array
  129.     {
  130.         $data = [];
  131.         foreach ($object as $index => $obj) {
  132.             $data[$index] = $this->normalizer->normalize($obj, $format, $context);
  133.         }
  135.         return $data;
  136.     }
  137. }
  139. class_alias(CollectionNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\CollectionNormalizer::class);