Spec-Zone.ru › Yii 2.0

Класс yii\web\JsonResponseFormatter

Все классы | Свойства | Методы
Наследование yii\web\JsonResponseFormatter » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\web\ResponseFormatterInterface
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/web/JsonResponseFormatter.php

JsonResponseFormatter форматирует заданные данные в формате JSON или JSONP.

Используется классом yii\web\Response для форматирования данных ответа.

Чтобы настроить свойства, такие как $encodeOptions или $prettyPrint, вы можете настроить компонент приложения response, как показано ниже:

'response' => [
    // ...
    'formatters' => [
        \yii\web\Response::FORMAT_JSON => [
             'class' => 'yii\web\JsonResponseFormatter',
             'prettyPrint' => YII_DEBUG, // use "pretty" output in debug mode
             // ...
        ],
    ],
],

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

Свойство Тип Описание Определено в
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$encodeOptions целое число Параметры кодирования, передаваемые в yii\helpers\Json::encode(). yii\web\JsonResponseFormatter
$prettyPrint логическое Форматировать вывод в удобочитаемом формате. yii\web\JsonResponseFormatter
$useJsonp логическое Использовать формат ответа JSONP. yii\web\JsonResponseFormatter

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

Метод Описание Определено в
__call() Вызывает метод, который не является методом класса. yii\base\Component
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства компонента. yii\base\Component
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Component
__set() Устанавливает значение свойства компонента. yii\base\Component
__unset() Устанавливает свойство компонента в значение null. yii\base\Component
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
behaviors() Возвращает список поведений, которые должен выполнять этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Component
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Component
className() Возвращает полное имя этого класса. yii\base\Object
detachBehavior() Открепляет поведение от компонента. yii\base\Component
detachBehaviors() Открепляет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
format() Форматирует указанный ответ. yii\web\JsonResponseFormatter
getBehavior() Возвращает объект поведения с указанным именем. yii\base\Component
getBehaviors() Возвращает все прикрепленные к этому компоненту поведения. yii\base\Component
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Component
hasProperty() Возвращает значение, указывающее, определено ли свойство для этого компонента. yii\base\Component
init() Инициализирует объект. yii\base\Object
off() Открепляет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
trigger() Вызывает событие. yii\base\Component

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

Метод Описание Определено в
formatJson() Форматирует данные ответа в формате JSON. yii\web\JsonResponseFormatter
formatJsonp() Форматирует данные ответа в формате JSONP. yii\web\JsonResponseFormatter

Подробности свойств

$encodeOptions публичное свойство (доступно с версии 2.0.7)

Параметры кодирования, передаваемые в yii\helpers\Json::encode(). Для получения дополнительной информации см. http://www.php.net/manual/en/function.json-encode.php. Значение по умолчанию — JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE. Это свойство не имеет эффекта, когда $useJsonp равно true.

public integer $encodeOptions = 320

$prettyPrint публичное свойство (доступно с версии 2.0.7)

Форматировать вывод в удобочитаемом формате. Это может быть полезно для отладки. Если это значение true, JSON_PRETTY_PRINT будет добавлен к $encodeOptions. Значение по умолчанию — false. Это свойство не имеет эффекта, когда $useJsonp равно true.

public boolean $prettyPrint = false

$useJsonp публичное свойство

Использовать формат ответа JSONP. Если это значение true, данные ответа response data должны быть массивом, содержащим data и callback члены. Последний должен быть именем JavaScript-функции, а первый будет передан в эту функцию в качестве параметра.

public boolean $useJsonp = false

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

format() public метод

Форматирует указанный ответ.

public void format ( $response )
$response yii\web\Response

Ответ, который нужно отформатировать.

formatJson() защищённый метод

Форматирует данные ответа в формате JSON.

protected void formatJson ( $response )
$response yii\web\Response

formatJsonp() защищённый метод

Форматирует данные ответа в формате JSONP.

protected void formatJsonp ( $response )
$response yii\web\Response

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

Spec-Zone.ru

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