Spec-Zone.ru › Yii 2.0

Класс yii\helpers\BaseJson

Все классы | Свойства | Методы
Наследование yii\helpers\BaseJson
Подклассы yii\helpers\Json
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseJson.php

BaseJson предоставляет конкретную реализацию для yii\helpers\Json.

Не используйте BaseJson. Используйте yii\helpers\Json вместо него.

Публичные свойства

Свойство Тип Описание Определено в
$jsonErrorMessages массив yii\helpers\BaseJson

Публичные методы

Метод Описание Определено в
decode() Декодирует заданную JSON-строку в структуру данных PHP. yii\helpers\BaseJson
encode() Кодирует заданное значение в JSON-строку. yii\helpers\BaseJson
htmlEncode() Кодирует заданное значение в JSON-строку, HTML-экранируя сущности, так что оно безопасно для встраивания в HTML-код. yii\helpers\BaseJson

Защищенные методы

Метод Описание Определено в
handleJsonError() Обрабатывает ошибки encode() и decode(), выбрасывая исключения с соответствующим сообщением об ошибке. yii\helpers\BaseJson
processData() Предварительно обрабатывает данные перед отправкой в json_encode(). yii\helpers\BaseJson

Подробное описание свойств

$jsonErrorMessages общедоступное статическое свойство (доступно с версии 2.0.7)

public static array $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.', 'JSON_ERROR_RECURSION' => 'One or more recursive references in the value to be encoded.', 'JSON_ERROR_INF_OR_NAN' => 'One or more NAN or INF values in the value to be encoded', 'JSON_ERROR_UNSUPPORTED_TYPE' => 'A value of a type that cannot be encoded was given']

Подробное описание методов

decode() общедоступный статический метод

Декодирует заданную JSON-строку в структуру данных PHP.

public static mixed decode ( $json, $asArray = true )
$json строка

JSON-строка для декодирования

$asArray булево

Определяет, возвращать ли объекты в виде ассоциативных массивов.

return смешанное

Данные PHP

throws yii\base\InvalidParamException

в случае возникновения ошибки декодирования

encode() общедоступный статический метод

Кодирует заданное значение в JSON-строку.

Метод расширяет json_encode() , поддерживая JavaScript-выражения. В частности, метод не будет кодировать JavaScript-выражение, представленное объектом yii\web\JsExpression.

Обратите внимание, что данные, закодированные в JSON, должны быть закодированы в UTF-8 в соответствии со спецификацией JSON. Необходимо убедиться, что строки, переданные в этот метод, имеют правильное кодирование перед их передачей.

public static строка encode ( $value, $options = 320 )
$value смешанное

Данные для кодирования.

$options целое число

Параметры кодирования. Дополнительные сведения см. в http://www.php.net/manual/en/function.json-encode.php. Значение по умолчанию — JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE.

return строка

Результат кодирования.

throws yii\base\InvalidParamException

в случае возникновения ошибки кодирования.

handleJsonError() защищенный статический метод (доступно с версии 2.0.6)

Обрабатывает ошибки encode() и decode(), выбрасывая исключения с соответствующим сообщением об ошибке.

protected static void handleJsonError ( $lastError )
$lastError целое число

Код ошибки из json_last_error().

throws yii\base\InvalidParamException

в случае возникновения ошибки кодирования/декодирования.

htmlEncode() общедоступный статический метод (доступно с версии 2.0.4)

Кодирует заданное значение в JSON-строку, HTML-экранируя сущности, так что оно безопасно для встраивания в HTML-код.

Метод расширяет json_encode() , поддерживая JavaScript-выражения. В частности, метод не будет кодировать JavaScript-выражение, представленное объектом yii\web\JsExpression.

Обратите внимание, что данные, закодированные в JSON, должны быть закодированы в UTF-8 в соответствии со спецификацией JSON. Необходимо убедиться, что строки, переданные в этот метод, имеют правильное кодирование перед их передачей.

public static строка htmlEncode ( $value )
$value смешанное

Данные для кодирования

return строка

Результат кодирования

throws yii\base\InvalidParamException

в случае возникновения ошибки кодирования

processData() защищенный статический метод

Предварительно обрабатывает данные перед отправкой в json_encode().

protected static mixed processData ( $data, &$expressions, $expPrefix )
$data смешанное

Данные для обработки

$expressions массив

Коллекция JavaScript-выражений

$expPrefix строка

Префикс, используемый внутри для обработки JavaScript-выражений

return смешанное

Обработанные данные

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-helpers-basejson.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API