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

  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\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  18. use ApiPlatform\Exception\InvalidArgumentException;
  19. use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
  20. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  21. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  23. /**
  24.  * Decorates the output with JSON-LD metadata when appropriate, but otherwise just
  25.  * passes through to the decorated normalizer.
  26.  */
  27. final class ObjectNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  28. {
  29.     use JsonLdContextTrait;
  31.     public const FORMAT = 'jsonld';
  33.     private $decorated;
  34.     private $iriConverter;
  35.     private $anonymousContextBuilder;
  37.     public function __construct(NormalizerInterface $decorated, $iriConverter, AnonymousContextBuilderInterface $anonymousContextBuilder)
  38.     {
  39.         $this->decorated = $decorated;
  40.         $this->iriConverter = $iriConverter;
  41.         $this->anonymousContextBuilder = $anonymousContextBuilder;
  43.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  44.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  45.         }
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public function supportsNormalization($data, $format = null, array $context = []): bool
  52.     {
  53.         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      */
  59.     public function hasCacheableSupportsMethod(): bool
  60.     {
  61.         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      *
  67.      * @return array|string|int|float|bool|\ArrayObject|null
  68.      */
  69.     public function normalize($object, $format = null, array $context = [])
  70.     {
  71.         if (isset($context['api_resource'])) {
  72.             $originalResource = $context['api_resource'];
  73.             unset($context['api_resource']);
  74.         }
  76.         /*
  77.          * Converts the normalized data array of a resource into an IRI, if the
  78.          * normalized data array is empty.
  79.          *
  80.          * This is useful when traversing from a non-resource towards an attribute
  81.          * which is a resource, as we do not have the benefit of {@see PropertyMetadata::isReadableLink}.
  82.          *
  83.          * It must not be propagated to subresources, as {@see PropertyMetadata::isReadableLink}
  84.          * should take effect.
  85.          */
  86.         $context['api_empty_resource_as_iri'] = true;
  88.         $data = $this->decorated->normalize($object, $format, $context);
  89.         if (!\is_array($data) || !$data) {
  90.             return $data;
  91.         }
  93.         if (isset($originalResource)) {
  94.             try {
  95.                 $context['output']['iri'] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($originalResource) : $this->iriConverter->getIriFromResource($originalResource);
  96.             } catch (InvalidArgumentException $e) {
  97.                 // The original resource has no identifiers
  98.             }
  99.             $context['api_resource'] = $originalResource;
  100.         }
  102.         $metadata = $this->createJsonLdContext($this->anonymousContextBuilder, $object, $context);
  104.         return $metadata + $data;
  105.     }
  106. }
  108. class_alias(ObjectNormalizer::class, \ApiPlatform\Core\JsonLd\Serializer\ObjectNormalizer::class);