Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. JsonEncoder.php

class JsonEncoder

Same name in this branch
  1. 11.1.x vendor/symfony/serializer/Encoder/JsonEncoder.php \Symfony\Component\Serializer\Encoder\JsonEncoder
  2. 11.1.x core/modules/serialization/src/Encoder/JsonEncoder.php \Drupal\serialization\Encoder\JsonEncoder

Encodes JSON:API data.

@internal JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it.

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
      • class \Drupal\jsonapi\Encoder\JsonEncoder extends \Drupal\serialization\Encoder\JsonEncoder

Expanded class hierarchy of JsonEncoder

See also

https://www.drupal.org/project/drupal/issues/3032787

jsonapi.api.php

1 string reference to 'JsonEncoder'
jsonapi.services.yml in core/modules/jsonapi/jsonapi.services.yml
core/modules/jsonapi/jsonapi.services.yml
1 service uses JsonEncoder
serializer.encoder.jsonapi in core/modules/jsonapi/jsonapi.services.yml
Drupal\jsonapi\Encoder\JsonEncoder

File

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

Namespace

Drupal\jsonapi\Encoder
View source
class JsonEncoder extends SerializationJsonEncoder {
    
    /**
     * The formats that this Encoder supports.
     *
     * @var string
     */
    protected static $format = [
        'api_json',
    ];

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
JsonEncoder::$decodingImpl protected property
JsonEncoder::$defaultContext private property
JsonEncoder::$encodingImpl protected property
JsonEncoder::$format protected static property The formats that this Encoder supports. Overrides JsonEncoder::$format
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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal