Yiisoft\Json\Json

Complexity

Total Complexity

17

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Test Coverage

Coverage

91.67%

Importance

Changes	6
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	encode()	0	9	2
A	decode()	0	10	2
A	htmlEncode()	0	5	1
C	processData()	0	39	12

<?php

declare(strict_types=1);

namespace Yiisoft\Json;

/**
 * Json is a helper class providing JSON data encoding and decoding.
 * It enhances the PHP built-in functions `json_encode()` and `json_decode()`
 * by throwing exceptions when decoding fails.
 */
final class Json
{
    /**
     * Encodes the given value into a JSON string.
     *
     * Note that data encoded as JSON must be UTF-8 encoded according to the JSON specification.
     * You must ensure strings passed to this method have proper encoding before passing them.
     *
     * @param mixed $value The data to be encoded.
     * @param int $options The encoding options. For more details please refer to
     * {@see http://www.php.net/manual/en/function.json-encode.php}.
     * Default is `JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR`.
     * @param int $depth The maximum depth.
     *
     * @throws \JsonException if there is any encoding error.
     *
     * @return string The encoding result.
     */
    public static function encode(
        $value,
        int $options = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR,
        int $depth = 512
    ): string {
        $expressions = [];
        $value = self::processData($value, $expressions, uniqid('', true));
        $json = json_encode($value, JSON_THROW_ON_ERROR | $options, $depth);
        return $expressions === [] ? $json : strtr($json, $expressions);
    }

    /**
     * Encodes the given value into a JSON string HTML-escaping entities so it is safe to be embedded in HTML code.
     *
     * Note that data encoded as JSON must be UTF-8 encoded according to the JSON specification.
     * You must ensure strings passed to this method have proper encoding before passing them.
     *
     * @param mixed $value The data to be encoded.
     *
     * @throws \JsonException If there is any encoding error.
     *
     * @return string The encoding result.
     */
    public static function htmlEncode($value): string
    {
        return self::encode(
            $value,
            JSON_UNESCAPED_UNICODE | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_THROW_ON_ERROR
        );
    }

    /**
     * Decodes the given JSON string into a PHP data structure.
     *
     * @param string $json The JSON string to be decoded.
     * @param bool $asArray Whether to return objects in terms of associative arrays.
     * @param int $depth The recursion depth.
     * @param int $options The decode options.
     *
     * @throws \JsonException If there is any decoding error.
     *
     * @return mixed The PHP data.
     */
    public static function decode(
        string $json,
        bool $asArray = true,
        int $depth = 512,
        int $options = JSON_THROW_ON_ERROR
    ) {
        if ($json === '') {
            return null;
        }
        return json_decode($json, $asArray, $depth, JSON_THROW_ON_ERROR | $options);
    }

    /**
     * Pre-processes the data before sending it to `json_encode()`.
     *
     * @param mixed $data The data to be processed.
     * @param array $expressions collection of JavaScript expressions
     * @param string $expPrefix a prefix internally used to handle JS expressions
     *
     * @return mixed The processed data.
     */
    private static function processData($data, &$expressions, $expPrefix)
    {
        if (\is_object($data)) {
            if ($data instanceof JsExpression) {
                $token = "!{[$expPrefix=" . count($expressions) . ']}!';
                $expressions['"' . $token . '"'] = $data->expression;

                return $token;
            }

            if ($data instanceof \JsonSerializable) {
                return self::processData($data->jsonSerialize(), $expressions, $expPrefix);
            }

            if ($data instanceof \DateTimeInterface) {
                return self::processData((array)$data, $expressions, $expPrefix);
            }

            if ($data instanceof \SimpleXMLElement) {
                $data = (array)$data;
            } else {
                $result = [];
                foreach ($data as $name => $value) {
                    $result[$name] = $value;
                }
                $data = $result;
            }
            if ($data === []) {
                return new \stdClass();
            }
        }
        if (\is_array($data)) {
            foreach ($data as $key => $value) {
                if (\is_array($value) || \is_object($value)) {
                    $data[$key] = self::processData($value, $expressions, $expPrefix);
                }
            }
        }
        return $data;
    }
}