class JsonEncoder

Same name in this branch

11.1.x vendor/symfony/serializer/Encoder/JsonEncoder.php \Symfony\Component\Serializer\Encoder\JsonEncoder
11.1.x core/modules/jsonapi/src/Encoder/JsonEncoder.php \Drupal\jsonapi\Encoder\JsonEncoder

Adds 'ajax' to the supported content types of the JSON encoder.

@internal This encoder should not be used directly. Rather, use the `serializer` service.

Hierarchy

class \Symfony\Component\Serializer\Encoder\JsonEncoder implements \Symfony\Component\Serializer\Encoder\EncoderInterface, \Symfony\Component\Serializer\Encoder\DecoderInterface
- class \Drupal\serialization\Encoder\JsonEncoder extends \Symfony\Component\Serializer\Encoder\JsonEncoder

Expanded class hierarchy of JsonEncoder

1 file declares its use of JsonEncoder

JsonEncoder.php in core/modules/jsonapi/src/Encoder/JsonEncoder.php

1 string reference to 'JsonEncoder'

serialization.services.yml in core/modules/serialization/serialization.services.yml: core/modules/serialization/serialization.services.yml

1 service uses JsonEncoder

serializer.encoder.json in core/modules/serialization/serialization.services.yml: Drupal\serialization\Encoder\JsonEncoder

File

core/modules/serialization/src/Encoder/JsonEncoder.php, line 16

Namespace

Drupal\serialization\Encoder

View source

class JsonEncoder extends BaseJsonEncoder {
    
    /**
     * The formats that this Encoder supports.
     *
     * @var array
     */
    protected static $format = [
        'json',
        'ajax',
    ];
    
    /**
     * {@inheritdoc}
     */
    public function __construct(?JsonEncode $encodingImpl = NULL, ?JsonDecode $decodingImpl = NULL) {
        // Encode <, >, ', &, and " for RFC4627-compliant JSON, which may also be
        // embedded into HTML.
        // @see \Symfony\Component\HttpFoundation\JsonResponse
        $json_encoding_options = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT;
        $this->encodingImpl = $encodingImpl ?: new JsonEncode([
            JsonEncode::OPTIONS => $json_encoding_options,
        ]);
        $this->decodingImpl = $decodingImpl ?: new JsonDecode([
            JsonDecode::ASSOCIATIVE => TRUE,
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function supportsEncoding(string $format, array $context = []) : bool {
        return in_array($format, static::$format);
    }
    
    /**
     * {@inheritdoc}
     */
    public function supportsDecoding(string $format, array $context = []) : bool {
        return in_array($format, static::$format);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
JsonEncoder::$decodingImpl	protected	property
JsonEncoder::$defaultContext	private	property
JsonEncoder::$encodingImpl	protected	property
JsonEncoder::$format	protected static	property	The formats that this Encoder supports.		1
JsonEncoder::decode	public	function	Decodes a string into PHP data.	Overrides DecoderInterface::decode
JsonEncoder::encode	public	function	Encodes data into the given format.	Overrides EncoderInterface::encode
JsonEncoder::FORMAT	public	constant
JsonEncoder::supportsDecoding	public	function	Checks whether the deserializer can decode from given format.	Overrides JsonEncoder::supportsDecoding
JsonEncoder::supportsEncoding	public	function	Checks whether the serializer can encode to given format.	Overrides JsonEncoder::supportsEncoding
JsonEncoder::__construct	public	function		Overrides JsonEncoder::__construct