Класс yii\web\JsonParser
| Наследование | yii\web\JsonParser |
|---|---|
| Реализует | yii\web\RequestParserInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/JsonParser.php |
Парсит сырое тело HTTP-запроса с помощью yii\helpers\Json::decode()
Для включения парсинга JSON-запросов вы можете настроить yii\web\Request::$parsers с использованием этого класса:
'request' => [
'parsers' => [
'application/json' => 'yii\web\JsonParser',
]
]
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $asArray | boolean | Возвращать ли объекты в виде ассоциативных массивов. | yii\web\JsonParser |
| $throwException | boolean | Выбрасывать ли исключение yii\web\BadRequestHttpException, если тело содержит некорректный JSON | yii\web\JsonParser |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| parse() | Парсит тело HTTP-запроса. | yii\web\JsonParser |
Подробное описание свойств
$asArray публичное свойство
Возвращать ли объекты в виде ассоциативных массивов.
public boolean $asArray = true
$throwException публичное свойство
Выбрасывать ли исключение yii\web\BadRequestHttpException, если тело содержит некорректный JSON
public boolean $throwException = true
Подробное описание методов
parse() публичный метод
Парсит тело HTTP-запроса.
| public массив parse ( $rawBody, $contentType ) | ||
|---|---|---|
| $rawBody | строка |
Сырое тело HTTP-запроса. |
| $contentType | строка |
Тип контента, указанный для тела запроса. |
| return | массив |
Параметры, извлеченные из тела запроса |
| throws | yii\web\BadRequestHttpException |
если тело содержит некорректный JSON и $throwException равно |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-jsonparser.html
