Class yii\web\JsonResponseFormatter

继承yii\web\JsonResponseFormatter » yii\base\Component » yii\base\BaseObject
实现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, // 在调试模式下使用"pretty"(漂亮)的输出
             // ...
        ],
    ],
],

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$contentType string|null 响应的Content-Type标头的自定义值. yii\web\JsonResponseFormatter
$encodeOptions integer 传递给 yii\helpers\Json::encode(). yii\web\JsonResponseFormatter
$prettyPrint boolean 是否将输出格式化为可读的"pretty"(漂亮)格式. yii\web\JsonResponseFormatter
$useJsonp boolean 是否使用 JSONP 响应格式. yii\web\JsonResponseFormatter

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__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\BaseObject
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\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
formatJson() 将响应数据格式化为 JSON 格式. yii\web\JsonResponseFormatter
formatJsonp() 将响应数据格式化为 JSONP 格式. yii\web\JsonResponseFormatter

常量

隐藏继承的常量

常量描述定义在
CONTENT_TYPE_HAL_JSON 'application/hal+json; charset=UTF-8' HAL JSON 内容类型. yii\web\JsonResponseFormatter
CONTENT_TYPE_JSON 'application/json; charset=UTF-8' JSONP 内容类型. yii\web\JsonResponseFormatter
CONTENT_TYPE_JSONP 'application/javascript; charset=UTF-8' JSON 内容类型. yii\web\JsonResponseFormatter

属性详情

$contentType public 属性 (可用自版本: 2.0.14)

响应的Content-Type标头的自定义值.

当等于null时, 将基于useJsonp属性来使用默认内容类型.

public string|null $contentType null
$encodeOptions public 属性 (可用自版本: 2.0.7)

传递给 yii\helpers\Json::encode(). 的编码选项.

有关更多详细信息, 请参阅 http://www.php.net/manual/en/function.json-encode.php.

默认值为JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE.

$useJsonptrue时, 此属性无效.

public integer $encodeOptions 320
$prettyPrint public 属性 (可用自版本: 2.0.7)

是否将输出格式化为可读的"pretty"(漂亮)格式. 这对于调试目的很有用. 默认为false.

如果为true, 则将JSON_PRETTY_PRINT添加到 $encodeOptions.

$useJsonptrue时, 此属性无效.

public boolean $prettyPrint false
$useJsonp public 属性

是否使用 JSONP 响应格式.

如果为true, 则 响应数据 必须是一个由datacallback成员组成的数组. 后者应该是一个 JavaScript 函数名称, 而前者将作为参数传递给该函数.

public boolean $useJsonp false

方法详情

format() public 方法

格式化指定的响应.

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

要格式化的响应.

formatJson() protected 方法

将响应数据格式化为 JSON 格式.

protected void formatJson ( $response )
$response yii\web\Response
formatJsonp() protected 方法

将响应数据格式化为 JSONP 格式.

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