BaseJson::encode() - Code Metrics - Inspection of "Merge branch 'master' into php-74-ci" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — php-74-ci ( 3d1af5...9001b7 )

by Alexander

created 2019-12-06 15:16 UTC

BaseJson::encode() A

↳ Parent: BaseJson

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2.0054

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	2
dl	0
loc	12
ccs	8
cts	9
cp	0.8889
crap	2.0054
rs	9.9666
c	0
b	0
f	0

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\helpers;

use yii\base\Arrayable;
use yii\base\InvalidArgumentException;
use yii\web\JsExpression;
use yii\base\Model;

/**
 * BaseJson provides concrete implementation for [[Json]].
 *
 * Do not use BaseJson. Use [[Json]] instead.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class BaseJson
{
    /**
     * List of JSON Error messages assigned to constant names for better handling of version differences.
     * @var array
     * @since 2.0.7
     */
    public static $jsonErrorMessages = [
        'JSON_ERROR_DEPTH' => 'The maximum stack depth has been exceeded.',
        'JSON_ERROR_STATE_MISMATCH' => 'Invalid or malformed JSON.',
        'JSON_ERROR_CTRL_CHAR' => 'Control character error, possibly incorrectly encoded.',
        'JSON_ERROR_SYNTAX' => 'Syntax error.',
        'JSON_ERROR_UTF8' => 'Malformed UTF-8 characters, possibly incorrectly encoded.', // PHP 5.3.3
        'JSON_ERROR_RECURSION' => 'One or more recursive references in the value to be encoded.', // PHP 5.5.0
        'JSON_ERROR_INF_OR_NAN' => 'One or more NAN or INF values in the value to be encoded', // PHP 5.5.0
        'JSON_ERROR_UNSUPPORTED_TYPE' => 'A value of a type that cannot be encoded was given', // PHP 5.5.0
    ];


    /**
     * Encodes the given value into a JSON string.
     *
     * The method enhances `json_encode()` by supporting JavaScript expressions.
     * In particular, the method will not encode a JavaScript expression that is
     * represented in terms of a [[JsExpression]] object.
     *
     * 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
     * <https://secure.php.net/manual/en/function.json-encode.php>. Default is `JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE`.
     * @return string the encoding result.
     * @throws InvalidArgumentException if there is any encoding error.
     */
    public static function encode($value, $options = 320)
    {
        $expressions = [];
        $value = static::processData($value, $expressions, uniqid('', true));
        set_error_handler(function () {
            static::handleJsonError(JSON_ERROR_SYNTAX);
        }, E_WARNING);
        $json = json_encode($value, $options);
        restore_error_handler();
        static::handleJsonError(json_last_error());

        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.
     *
     * The method enhances `json_encode()` by supporting JavaScript expressions.
     * In particular, the method will not encode a JavaScript expression that is
     * represented in terms of a [[JsExpression]] object.
     *
     * 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
     * @return string the encoding result
     * @since 2.0.4
     * @throws InvalidArgumentException if there is any encoding error
     */
    public static function htmlEncode($value)
    {
        return static::encode($value, JSON_UNESCAPED_UNICODE | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS);
    }

    /**
     * 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.
     * @return mixed the PHP data
     * @throws InvalidArgumentException if there is any decoding error
     */
    public static function decode($json, $asArray = true)
    {
        if (is_array($json)) {

            throw new InvalidArgumentException('Invalid JSON data.');
        } elseif ($json === null || $json === '') {
            return null;
        }
        $decode = json_decode((string) $json, $asArray);
        static::handleJsonError(json_last_error());

        return $decode;
    }

    /**
     * Handles [[encode()]] and [[decode()]] errors by throwing exceptions with the respective error message.
     *
     * @param int $lastError error code from [json_last_error()](https://secure.php.net/manual/en/function.json-last-error.php).
     * @throws InvalidArgumentException if there is any encoding/decoding error.
     * @since 2.0.6
     */
    protected static function handleJsonError($lastError)
    {
        if ($lastError === JSON_ERROR_NONE) {
            return;
        }

        $availableErrors = [];
        foreach (static::$jsonErrorMessages as $const => $message) {
            if (defined($const)) {
                $availableErrors[constant($const)] = $message;
            }
        }

        if (isset($availableErrors[$lastError])) {
            throw new InvalidArgumentException($availableErrors[$lastError], $lastError);
        }

        throw new InvalidArgumentException('Unknown JSON encoding/decoding error.');
    }

    /**
     * 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
     */
    protected static function processData($data, &$expressions, $expPrefix)
    {
        if (is_object($data)) {
            if ($data instanceof JsExpression) {
                $token = "!{[$expPrefix=" . count($expressions) . ']}!';
                $expressions['"' . $token . '"'] = $data->expression;

                return $token;
            } elseif ($data instanceof \JsonSerializable) {
                return static::processData($data->jsonSerialize(), $expressions, $expPrefix);
            } elseif ($data instanceof Arrayable) {
                $data = $data->toArray();
            } elseif ($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] = static::processData($value, $expressions, $expPrefix);
                }
            }
        }

        return $data;
    }

    /**
     * Generates a summary of the validation errors.
     * @param Model|Model[] $models the model(s) whose validation errors are to be displayed.
     * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
     *
     * - showAllErrors: boolean, if set to true every error message for each attribute will be shown otherwise
     *   only the first error message for each attribute will be shown. Defaults to `false`.
     *
     * @return string the generated error summary
     * @since 2.0.14
     */
    public static function errorSummary($models, $options = [])
    {
        $showAllErrors = ArrayHelper::remove($options, 'showAllErrors', false);
        $lines = self::collectErrors($models, $showAllErrors);

        return json_encode($lines);
    }

    /**
     * Return array of the validation errors
     * @param Model|Model[] $models the model(s) whose validation errors are to be displayed.
     * @param $showAllErrors boolean, if set to true every error message for each attribute will be shown otherwise
     * only the first error message for each attribute will be shown.
     * @return array of the validation errors
     * @since 2.0.14
     */
    private static function collectErrors($models, $showAllErrors)
    {
        $lines = [];
        if (!is_array($models)) {
            $models = [$models];
        }

        foreach ($models as $model) {
            $lines = array_unique(array_merge($lines, $model->getErrorSummary($showAllErrors)));
        }

        return $lines;
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\helpers;
9
10		use yii\base\Arrayable;
11		use yii\base\InvalidArgumentException;
12		use yii\web\JsExpression;
13		use yii\base\Model;
14
15		/**
16		* BaseJson provides concrete implementation for [[Json]].
17		*
18		* Do not use BaseJson. Use [[Json]] instead.
19		*
20		* @author Qiang Xue <[email protected]>
21		* @since 2.0
22		*/
23		class BaseJson
24		{
25		/**
26		* List of JSON Error messages assigned to constant names for better handling of version differences.
27		* @var array
28		* @since 2.0.7
29		*/
30		public static $jsonErrorMessages = [
31		'JSON_ERROR_DEPTH' => 'The maximum stack depth has been exceeded.',
32		'JSON_ERROR_STATE_MISMATCH' => 'Invalid or malformed JSON.',
33		'JSON_ERROR_CTRL_CHAR' => 'Control character error, possibly incorrectly encoded.',
34		'JSON_ERROR_SYNTAX' => 'Syntax error.',
35		'JSON_ERROR_UTF8' => 'Malformed UTF-8 characters, possibly incorrectly encoded.', // PHP 5.3.3
36		'JSON_ERROR_RECURSION' => 'One or more recursive references in the value to be encoded.', // PHP 5.5.0
37		'JSON_ERROR_INF_OR_NAN' => 'One or more NAN or INF values in the value to be encoded', // PHP 5.5.0
38		'JSON_ERROR_UNSUPPORTED_TYPE' => 'A value of a type that cannot be encoded was given', // PHP 5.5.0
39		];
40
41
42		/**
43		* Encodes the given value into a JSON string.
44		*
45		* The method enhances `json_encode()` by supporting JavaScript expressions.
46		* In particular, the method will not encode a JavaScript expression that is
47		* represented in terms of a [[JsExpression]] object.
48		*
49		* Note that data encoded as JSON must be UTF-8 encoded according to the JSON specification.
50		* You must ensure strings passed to this method have proper encoding before passing them.
51		*
52		* @param mixed $value the data to be encoded.
53		* @param int $options the encoding options. For more details please refer to
54		* <https://secure.php.net/manual/en/function.json-encode.php>. Default is `JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE`.
55		* @return string the encoding result.
56		* @throws InvalidArgumentException if there is any encoding error.
57		*/
58	63	public static function encode($value, $options = 320)
59		{
60	63	$expressions = [];
61	63	$value = static::processData($value, $expressions, uniqid('', true));
62		set_error_handler(function () {
63		static::handleJsonError(JSON_ERROR_SYNTAX);
64	63	}, E_WARNING);
65	63	$json = json_encode($value, $options);
66	63	restore_error_handler();
67	63	static::handleJsonError(json_last_error());
68
69	62	return $expressions === [] ? $json : strtr($json, $expressions);
70		}
71
72		/**
73		* Encodes the given value into a JSON string HTML-escaping entities so it is safe to be embedded in HTML code.
74		*
75		* The method enhances `json_encode()` by supporting JavaScript expressions.
76		* In particular, the method will not encode a JavaScript expression that is
77		* represented in terms of a [[JsExpression]] object.
78		*
79		* Note that data encoded as JSON must be UTF-8 encoded according to the JSON specification.
80		* You must ensure strings passed to this method have proper encoding before passing them.
81		*
82		* @param mixed $value the data to be encoded
83		* @return string the encoding result
84		* @since 2.0.4
85		* @throws InvalidArgumentException if there is any encoding error
86		*/
87	10	public static function htmlEncode($value)
88		{
89	10	return static::encode($value, JSON_UNESCAPED_UNICODE \| JSON_HEX_QUOT \| JSON_HEX_TAG \| JSON_HEX_AMP \| JSON_HEX_APOS);
90		}
91
92		/**
93		* Decodes the given JSON string into a PHP data structure.
94		* @param string $json the JSON string to be decoded
95		* @param bool $asArray whether to return objects in terms of associative arrays.
96		* @return mixed the PHP data
97		* @throws InvalidArgumentException if there is any decoding error
98		*/
99	11	public static function decode($json, $asArray = true)
100		{
101	11	if (is_array($json)) {
		0 ignored issues – show introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report The condition `is_array($json)` is always `false`. Loading history...
102	1	throw new InvalidArgumentException('Invalid JSON data.');
103	10	} elseif ($json === null \|\| $json === '') {
104	1	return null;
105		}
106	10	$decode = json_decode((string) $json, $asArray);
107	10	static::handleJsonError(json_last_error());
108
109	9	return $decode;
110		}
111
112		/**
113		* Handles [[encode()]] and [[decode()]] errors by throwing exceptions with the respective error message.
114		*
115		* @param int $lastError error code from [json_last_error()](https://secure.php.net/manual/en/function.json-last-error.php).
116		* @throws InvalidArgumentException if there is any encoding/decoding error.
117		* @since 2.0.6
118		*/
119	72	protected static function handleJsonError($lastError)
120		{
121	72	if ($lastError === JSON_ERROR_NONE) {
122	71	return;
123		}
124
125	2	$availableErrors = [];
126	2	foreach (static::$jsonErrorMessages as $const => $message) {
127	2	if (defined($const)) {
128	2	$availableErrors[constant($const)] = $message;
129		}
130		}
131
132	2	if (isset($availableErrors[$lastError])) {
133	2	throw new InvalidArgumentException($availableErrors[$lastError], $lastError);
134		}
135
136		throw new InvalidArgumentException('Unknown JSON encoding/decoding error.');
137		}
138
139		/**
140		* Pre-processes the data before sending it to `json_encode()`.
141		* @param mixed $data the data to be processed
142		* @param array $expressions collection of JavaScript expressions
143		* @param string $expPrefix a prefix internally used to handle JS expressions
144		* @return mixed the processed data
145		*/
146	63	protected static function processData($data, &$expressions, $expPrefix)
147		{
148	63	if (is_object($data)) {
149	12	if ($data instanceof JsExpression) {
150	3	$token = "!{[$expPrefix=" . count($expressions) . ']}!';
151	3	$expressions['"' . $token . '"'] = $data->expression;
152
153	3	return $token;
154	11	} elseif ($data instanceof \JsonSerializable) {
155	4	return static::processData($data->jsonSerialize(), $expressions, $expPrefix);
156	9	} elseif ($data instanceof Arrayable) {
157	4	$data = $data->toArray();
158	6	} elseif ($data instanceof \SimpleXMLElement) {
159	1	$data = (array) $data;
160		} else {
161	6	$result = [];
162	6	foreach ($data as $name => $value) {
163	6	$result[$name] = $value;
164		}
165	6	$data = $result;
166		}
167
168	9	if ($data === []) {
169	2	return new \stdClass();
170		}
171		}
172
173	63	if (is_array($data)) {
174	56	foreach ($data as $key => $value) {
175	53	if (is_array($value) \|\| is_object($value)) {
176	20	$data[$key] = static::processData($value, $expressions, $expPrefix);
177		}
178		}
179		}
180
181	63	return $data;
182		}
183
184		/**
185		* Generates a summary of the validation errors.
186		* @param Model\|Model[] $models the model(s) whose validation errors are to be displayed.
187		* @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
188		*
189		* - showAllErrors: boolean, if set to true every error message for each attribute will be shown otherwise
190		* only the first error message for each attribute will be shown. Defaults to `false`.
191		*
192		* @return string the generated error summary
193		* @since 2.0.14
194		*/
195	1	public static function errorSummary($models, $options = [])
196		{
197	1	$showAllErrors = ArrayHelper::remove($options, 'showAllErrors', false);
198	1	$lines = self::collectErrors($models, $showAllErrors);
199
200	1	return json_encode($lines);
201		}
202
203		/**
204		* Return array of the validation errors
205		* @param Model\|Model[] $models the model(s) whose validation errors are to be displayed.
206		* @param $showAllErrors boolean, if set to true every error message for each attribute will be shown otherwise
207		* only the first error message for each attribute will be shown.
208		* @return array of the validation errors
209		* @since 2.0.14
210		*/
211	1	private static function collectErrors($models, $showAllErrors)
212		{
213	1	$lines = [];
214	1	if (!is_array($models)) {
215	1	$models = [$models];
216		}
217
218	1	foreach ($models as $model) {
219	1	$lines = array_unique(array_merge($lines, $model->getErrorSummary($showAllErrors)));
220		}
221
222	1	return $lines;
223		}
224		}
225

yiisoft / yii2

Push — php-74-ci ( 3d1af5...9001b7 )

BaseJson::encode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like