vendor/api-platform/core/src/JsonLd/Serializer/ObjectNormalizer.php line 52

  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\JsonLd\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Exception\InvalidArgumentException;
  18. use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
  19. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  20. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  22. /**
  23.  * Decorates the output with JSON-LD metadata when appropriate, but otherwise just
  24.  * passes through to the decorated normalizer.
  25.  */
  26. final class ObjectNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  27. {
  28.     use JsonLdContextTrait;
  30.     public const FORMAT = 'jsonld';
  32.     public function __construct(private readonly NormalizerInterface $decorated, private readonly IriConverterInterface $iriConverter, private AnonymousContextBuilderInterface $anonymousContextBuilder)
  33.     {
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  40.     {
  41.         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
  42.     }
  44.     public function hasCacheableSupportsMethod(): bool
  45.     {
  46.         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
  53.     {
  54.         if (isset($context['api_resource'])) {
  55.             $originalResource = $context['api_resource'];
  56.             unset($context['api_resource']);
  57.         }
  59.         /*
  60.          * Converts the normalized data array of a resource into an IRI, if the
  61.          * normalized data array is empty.
  62.          *
  63.          * This is useful when traversing from a non-resource towards an attribute
  64.          * which is a resource, as we do not have the benefit of {@see ApiProperty::isReadableLink}.
  65.          *
  66.          * It must not be propagated to resources, as {@see ApiProperty::isReadableLink}
  67.          * should take effect.
  68.          */
  69.         $context['api_empty_resource_as_iri'] = true;
  71.         $data = $this->decorated->normalize($object, $format, $context);
  72.         if (!\is_array($data) || !$data) {
  73.             return $data;
  74.         }
  76.         if (isset($originalResource)) {
  77.             try {
  78.                 $context['output']['iri'] = $this->iriConverter->getIriFromResource($originalResource);
  79.             } catch (InvalidArgumentException) {
  80.                 // The original resource has no identifiers
  81.             }
  82.             $context['api_resource'] = $originalResource;
  83.         }
  85.         $metadata = $this->createJsonLdContext($this->anonymousContextBuilder, $object, $context);
  87.         return $metadata + $data;
  88.     }
  89. }