vendor/api-platform/core/src/JsonApi/Serializer/ObjectNormalizer.php line 60

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\JsonApi\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\ResourceClassResolverInterface;
  18. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  19. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  20. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
  23. use ApiPlatform\Util\ClassInfoTrait;
  24. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  25. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  27. /**
  28.  * Decorates the output with JSON API metadata when appropriate, but otherwise
  29.  * just passes through to the decorated normalizer.
  30.  */
  31. final class ObjectNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  32. {
  33.     use ClassInfoTrait;
  35.     public const FORMAT = 'jsonapi';
  37.     private $decorated;
  38.     /**
  39.      * @var IriConverterInterface|LegacyIriConverterInterface
  40.      */
  41.     private $iriConverter;
  42.     private $resourceClassResolver;
  43.     /**
  44.      * @var ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface
  45.      */
  46.     private $resourceMetadataFactory;
  48.     public function __construct(NormalizerInterface $decorated, $iriConverter, ResourceClassResolverInterface $resourceClassResolver, $resourceMetadataFactory)
  49.     {
  50.         $this->decorated = $decorated;
  51.         $this->iriConverter = $iriConverter;
  52.         $this->resourceClassResolver = $resourceClassResolver;
  53.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  55.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  56.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  57.         }
  59.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  60.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  61.         }
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      */
  67.     public function supportsNormalization($data, $format = null, array $context = []): bool
  68.     {
  69.         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
  70.     }
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     public function hasCacheableSupportsMethod(): bool
  76.     {
  77.         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      *
  83.      * @return array|string|int|float|bool|\ArrayObject|null
  84.      */
  85.     public function normalize($object, $format = null, array $context = [])
  86.     {
  87.         if (isset($context['api_resource'])) {
  88.             $originalResource = $context['api_resource'];
  89.             unset($context['api_resource']);
  90.         }
  92.         $data = $this->decorated->normalize($object, $format, $context);
  93.         if (!\is_array($data) || isset($context['api_attribute'])) {
  94.             return $data;
  95.         }
  97.         if (isset($originalResource)) {
  98.             $resourceClass = $this->resourceClassResolver->getResourceClass($originalResource);
  99.             $resourceData = [
  100.                 'id' => $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($originalResource) : $this->iriConverter->getIriFromResource($originalResource),
  101.                 'type' => $this->getResourceShortName($resourceClass),
  102.             ];
  103.         } else {
  104.             // Not using an IriConverter here is deprecated in 2.7, avoid spl_object_hash as it may collide
  105.             $resourceData = [
  106.                 'id' => $this->iriConverter instanceof LegacyIriConverterInterface ? '/.well-known/genid/'.bin2hex(random_bytes(10)) : $this->iriConverter->getIriFromResource($object),
  107.                 'type' => (new \ReflectionClass($this->getObjectClass($object)))->getShortName(),
  108.             ];
  109.         }
  111.         if ($data) {
  112.             $resourceData['attributes'] = $data;
  113.         }
  115.         return ['data' => $resourceData];
  116.     }
  118.     // TODO: 3.0 remove
  119.     private function getResourceShortName(string $resourceClass): string
  120.     {
  121.         /** @var ResourceMetadata|ResourceMetadataCollection */
  122.         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  124.         if ($resourceMetadata instanceof ResourceMetadata) {
  125.             return $resourceMetadata->getShortName();
  126.         }
  128.         return $resourceMetadata->getOperation()->getShortName();
  129.     }
  130. }
  132. class_alias(ObjectNormalizer::class, \ApiPlatform\Core\JsonApi\Serializer\ObjectNormalizer::class);