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.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function supportsNormalization($data, $format = null, array $context = []): bool
  48.     {
  49.         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
  50.     }
  52.     /**
  53.      * {@inheritdoc}
  54.      */
  55.     public function hasCacheableSupportsMethod(): bool
  56.     {
  57.         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      *
  63.      * @return array|string|int|float|bool|\ArrayObject|null
  64.      */
  65.     public function normalize($object, $format = null, array $context = [])
  66.     {
  67.         if (isset($context['api_resource'])) {
  68.             $originalResource = $context['api_resource'];
  69.             unset($context['api_resource']);
  70.         }
  72.         $data = $this->decorated->normalize($object, $format, $context);
  73.         if (!\is_array($data)) {
  74.             return $data;
  75.         }
  77.         if (!isset($originalResource)) {
  78.             return $data;
  79.         }
  81.         $metadata = [
  82.             '_links' => [
  83.                 'self' => [
  84.                     'href' => $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($originalResource) : $this->iriConverter->getIriFromResource($originalResource),
  85.                 ],
  86.             ],
  87.         ];
  89.         return $metadata + $data;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
  96.     {
  97.         // prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
  98.         return self::FORMAT === $format;
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      *
  104.      * @throws LogicException
  105.      *
  106.      * @return mixed
  107.      */
  108.     public function denormalize($data, $class, $format = null, array $context = [])
  109.     {
  110.         throw new LogicException(sprintf('%s is a read-only format.', self::FORMAT));
  111.     }
  112. }
  114. class_alias(ObjectNormalizer::class, \ApiPlatform\Core\Hal\Serializer\ObjectNormalizer::class);