vendor/api-platform/core/src/Serializer/JsonEncoder.php line 54

  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\Serializer;
  16. use Symfony\Component\Serializer\Encoder\DecoderInterface;
  17. use Symfony\Component\Serializer\Encoder\EncoderInterface;
  18. use Symfony\Component\Serializer\Encoder\JsonDecode;
  19. use Symfony\Component\Serializer\Encoder\JsonEncode;
  20. use Symfony\Component\Serializer\Encoder\JsonEncoder as BaseJsonEncoder;
  22. /**
  23.  * A JSON encoder with appropriate default options to embed the generated document into HTML.
  24.  *
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. final class JsonEncoder implements EncoderInterface, DecoderInterface
  28. {
  29.     // @noRector \Rector\Php81\Rector\Property\ReadOnlyPropertyRector
  30.     public function __construct(private readonly string $format, private ?BaseJsonEncoder $jsonEncoder = null)
  31.     {
  32.         if (null !== $this->jsonEncoder) {
  33.             return;
  34.         }
  36.         $this->jsonEncoder = new BaseJsonEncoder(
  37.             // Encode <, >, ', &, and " characters in the JSON, making it also safe to be embedded into HTML.
  38.             new JsonEncode(['json_encode_options' => \JSON_HEX_TAG | \JSON_HEX_APOS | \JSON_HEX_AMP | \JSON_HEX_QUOT | \JSON_UNESCAPED_UNICODE | \JSON_INVALID_UTF8_IGNORE]),
  39.             new JsonDecode(['json_decode_associative' => true])
  40.         );
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function supportsEncoding($format, array $context = []): bool
  47.     {
  48.         return $this->format === $format;
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function encode($data, $format, array $context = []): string
  55.     {
  56.         return $this->jsonEncoder->encode($data, $format, $context);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function supportsDecoding($format, array $context = []): bool
  63.     {
  64.         return $this->format === $format;
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function decode($data, $format, array $context = []): mixed
  71.     {
  72.         return $this->jsonEncoder->decode($data, $format, $context);
  73.     }
  74. }