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

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\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;
  21. use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
  23. /**
  24. * A JSON encoder with appropriate default options to embed the generated document into HTML.
  25. *
  26. * @author Kévin Dunglas <dunglas@gmail.com>
  27. */
  28. final class JsonEncoder implements EncoderInterface, DecoderInterface
  29. {
  30. private $format;
  31. private $jsonEncoder;
  33. public function __construct(string $format, BaseJsonEncoder $jsonEncoder = null)
  34. {
  35. $this->format = $format;
  36. $this->jsonEncoder = $jsonEncoder;
  38. if (null !== $this->jsonEncoder) {
  39. return;
  40. }
  42. // Encode <, >, ', &, and " characters in the JSON, making it also safe to be embedded into HTML.
  43. $jsonEncodeOptions = \JSON_HEX_TAG | \JSON_HEX_APOS | \JSON_HEX_AMP | \JSON_HEX_QUOT | \JSON_UNESCAPED_UNICODE | (\PHP_VERSION_ID >= 70200 ? \JSON_INVALID_UTF8_IGNORE : 0);
  44. if (interface_exists(AdvancedNameConverterInterface::class)) {
  45. $jsonEncode = new JsonEncode(['json_encode_options' => $jsonEncodeOptions]);
  46. $jsonDecode = new JsonDecode(['json_decode_associative' => true]);
  47. } else {
  48. $jsonEncode = new JsonEncode($jsonEncodeOptions);
  49. $jsonDecode = new JsonDecode(true);
  50. }
  52. $this->jsonEncoder = new BaseJsonEncoder($jsonEncode, $jsonDecode);
  53. }
  55. /**
  56. * {@inheritdoc}
  57. */
  58. public function supportsEncoding($format, array $context = []): bool
  59. {
  60. return $this->format === $format;
  61. }
  63. /**
  64. * {@inheritdoc}
  65. */
  66. public function encode($data, $format, array $context = []): string
  67. {
  68. return $this->jsonEncoder->encode($data, $format, $context);
  69. }
  71. /**
  72. * {@inheritdoc}
  73. */
  74. public function supportsDecoding($format, array $context = []): bool
  75. {
  76. return $this->format === $format;
  77. }
  79. /**
  80. * {@inheritdoc}
  81. *
  82. * @return mixed
  83. */
  84. public function decode($data, $format, array $context = [])
  85. {
  86. return $this->jsonEncoder->decode($data, $format, $context);
  87. }
  88. }
  90. class_alias(JsonEncoder::class, \ApiPlatform\Core\Serializer\JsonEncoder::class);