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

Breadcrumb

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

function JsonDecode::decode

Decodes data.

Parameters

string $data The encoded JSON string to decode:

string $format Must be set to JsonEncoder::FORMAT:

array $context An optional set of options for the JSON decoder; see below:

The $context array is a simple key=>value array, with the following supported keys:

json_decode_associative: boolean If true, returns the object as an associative array. If false, returns the object as nested stdClass If not specified, this method will use the default set in JsonDecode::__construct

json_decode_recursion_depth: integer Specifies the maximum recursion depth If not specified, this method will use the default set in JsonDecode::__construct

json_decode_options: integer Specifies additional options as per documentation for json_decode

json_decode_detailed_errors: bool If true, enables seld/jsonlint as a source for more specific error messages when json_decode fails. If false or not specified, this method will use default error messages from PHP's json_decode

Throws

NotEncodableValueException

Overrides DecoderInterface::decode

See also

https://php.net/json_decode

File

vendor/symfony/serializer/Encoder/JsonDecode.php, line 83

Class

JsonDecode
Decodes JSON data.

Namespace

Symfony\Component\Serializer\Encoder

Code

public function decode(string $data, string $format, array $context = []) : mixed {
    $associative = $context[self::ASSOCIATIVE] ?? $this->defaultContext[self::ASSOCIATIVE];
    $recursionDepth = $context[self::RECURSION_DEPTH] ?? $this->defaultContext[self::RECURSION_DEPTH];
    $options = $context[self::OPTIONS] ?? $this->defaultContext[self::OPTIONS];
    try {
        $decodedData = json_decode($data, $associative, $recursionDepth, $options);
    } catch (\JsonException $e) {
        throw new NotEncodableValueException($e->getMessage(), 0, $e);
    }
    if (\JSON_THROW_ON_ERROR & $options) {
        return $decodedData;
    }
    if (\JSON_ERROR_NONE === json_last_error()) {
        return $decodedData;
    }
    $errorMessage = json_last_error_msg();
    if (!($context[self::DETAILED_ERROR_MESSAGES] ?? $this->defaultContext[self::DETAILED_ERROR_MESSAGES])) {
        throw new NotEncodableValueException($errorMessage);
    }
    if (!class_exists(JsonParser::class)) {
        throw new UnsupportedException(\sprintf('Enabling "%s" serializer option requires seld/jsonlint. Try running "composer require seld/jsonlint".', self::DETAILED_ERROR_MESSAGES));
    }
    throw new NotEncodableValueException((new JsonParser())->lint($data)?->getMessage() ?: $errorMessage);
}
RSS feed
Powered by Drupal