vendor/api-platform/core/src/Hal/Serializer/ObjectNormalizer.php line 40

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\Hal\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  18. use Symfony\Component\Serializer\Exception\LogicException;
  19. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  20. use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
  21. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  23. /**
  24.  * Decorates the output with JSON HAL metadata when appropriate, but otherwise
  25.  * just passes through to the decorated normalizer.
  26.  */
  27. final class ObjectNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
  28. {
  29.     public const FORMAT = 'jsonhal';
  31.     private $decorated;
  32.     private $iriConverter;
  34.     public function __construct(NormalizerInterface $decorated, $iriConverter)
  35.     {
  36.         $this->decorated = $decorated;
  37.         $this->iriConverter = $iriConverter;
  39.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  40.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  41.         }
  42.     }
  44.     public function supportsNormalization($data, $format = null, array $context = []): bool
  45.     {
  46.         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
  47.     }
  49.     public function hasCacheableSupportsMethod(): bool
  50.     {
  51.         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
  52.     }
  54.     /**
  55.      * @param mixed|null $format
  56.      *
  57.      * @return array|string|int|float|bool|\ArrayObject|null
  58.      */
  59.     public function normalize($object, $format = null, array $context = [])
  60.     {
  61.         if (isset($context['api_resource'])) {
  62.             $originalResource = $context['api_resource'];
  63.             unset($context['api_resource']);
  64.         }
  66.         $data = $this->decorated->normalize($object, $format, $context);
  67.         if (!\is_array($data)) {
  68.             return $data;
  69.         }
  71.         if (!isset($originalResource)) {
  72.             return $data;
  73.         }
  75.         $metadata = [
  76.             '_links' => [
  77.                 'self' => [
  78.                     'href' => $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($originalResource) : $this->iriConverter->getIriFromResource($originalResource),
  79.                 ],
  80.             ],
  81.         ];
  83.         return $metadata + $data;
  84.     }
  86.     public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
  87.     {
  88.         // prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
  89.         return self::FORMAT === $format;
  90.     }
  92.     /**
  93.      * @param mixed|null $format
  94.      *
  95.      * @throws LogicException
  96.      */
  97.     public function denormalize($data, $class, $format = null, array $context = [])
  98.     {
  99.         throw new LogicException(sprintf('%s is a read-only format.', self::FORMAT));
  100.     }
  101. }
  103. class_alias(ObjectNormalizer::class, \ApiPlatform\Core\Hal\Serializer\ObjectNormalizer::class);