类 yii\web\JsonResponseFormatter
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
'keepObjectType' => false, // keep object type for zero-indexed objects
// ...
],
],
],
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
$contentType | 字符串|null | 响应的 `Content-Type` 头部的自定义值。 | yii\web\JsonResponseFormatter |
$encodeOptions | 整数 | 传递给 yii\helpers\Json::encode() 的编码选项。 | yii\web\JsonResponseFormatter |
$keepObjectType | 布尔值 | 避免将具有零索引键的对象编码为数组 Json::encode((object)['test']) 将被编码为对象而不是数组。 | yii\web\JsonResponseFormatter |
$prettyPrint | 布尔值 | 是否以可读的“漂亮”格式格式化输出。 | yii\web\JsonResponseFormatter |
$useJsonp | 布尔值 | 是否使用 JSONP 响应格式。 | yii\web\JsonResponseFormatter |
公共方法
受保护的方法
方法 | 描述 | 定义于 |
---|---|---|
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 |
属性详细信息
响应的 `Content-Type` 头部的自定义值。当等于 `null` 时,将根据 `useJsonp` 属性使用默认内容类型。
传递给 yii\helpers\Json::encode() 的编码选项。有关更多详细信息,请参阅 https://php.ac.cn/manual/en/function.json-encode.php。默认值为 JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE
。当 $useJsonp 为 `true` 时,此属性无效。
避免将具有零索引键的对象编码为数组 Json::encode((object)['test']) 将被编码为对象而不是数组。这与 json_encode() 的行为相匹配。默认为 Json::$keepObjectType 值
是否以可读的“美观”格式格式化输出。这对于调试很有用。如果为真,则会将 `JSON_PRETTY_PRINT` 添加到 $encodeOptions。默认为 `false`。当 $useJsonp 为 `true` 时,此属性无效。
方法详情
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查是否有任何附加的行为具有命名方法,如果有,则执行它。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在调用未知方法时会隐式调用。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | array |
方法参数 |
return | mixed |
方法返回值 |
---|---|---|
throws | yii\base\UnknownMethodException |
调用未知方法时 |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现做了两件事
- 使用给定的配置 `$config` 初始化对象。
- 调用 init()。
如果此方法在子类中被覆盖,建议
- 构造函数的最后一个参数是一个配置数组,如这里的 `$config`。
- 在构造函数的末尾调用父实现。
public void __construct ( $config = [] ) | ||
$config | array |
名称-值对,将用于初始化对象属性 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并相应地执行:
- 由 getter 定义的属性:返回 getter 结果
- 行为的属性:返回行为属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 `$value = $component->property;` 时会隐式调用。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
return | mixed |
属性值或行为属性的值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果未定义属性 |
throws | yii\base\InvalidCallException |
如果属性是只写属性。 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\Component::__isset()
检查属性是否已设置,即已定义且不为 null。
此方法将按以下顺序检查并相应地执行:
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性,返回 `false`
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 `isset($component->property)` 时会隐式调用。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
return | 布尔值 |
命名属性是否已设置 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
定义于: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并相应地执行:
- 由 setter 定义的属性:设置属性值
- 格式为“on xyz” 的事件:将处理程序附加到事件“xyz”
- 格式为“as xyz” 的行为:附加名为“xyz”的行为
- 行为的属性:设置行为属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 `$component->property = $value;` 时会隐式调用。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
throws | yii\base\UnknownPropertyException |
如果未定义属性 |
---|---|---|
throws | yii\base\InvalidCallException |
如果属性是只读的。 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并相应地执行:
- 由 setter 定义的属性:将属性值设置为 null
- 行为的属性:将属性值设置为 null
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 `unset($component->property)` 时会隐式调用。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
throws | yii\base\InvalidCallException |
如果属性是只读的。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,通过调用 yii\base\Behavior::attach() 方法将行为对象附加到此组件。
另请参阅 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行为的名称。 |
$behavior | string|array|yii\base\Behavior |
行为配置。这可以是以下之一
|
return | yii\base\Behavior |
行为对象 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定义于: yii\base\Component::attachBehaviors()
将行为列表附加到组件。
每个行为都按其名称索引,并且应该是 yii\base\Behavior 对象、指定行为类的字符串,或创建行为的配置数组。
另请参阅 attachBehavior()。
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
要附加到组件的行为列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定义于: yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以覆盖此方法以指定它们希望作为行为的行为。
此方法的返回值应是一个按行为名称索引的行为对象或配置数组。行为配置可以是指定行为类的字符串或以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,可以使用此名称通过 getBehavior() 获取行为,或使用 detachBehavior() 分离行为。匿名行为无法获取或分离。
此方法中声明的行为将自动附加到组件(按需)。
public array behaviors ( ) | ||
return | array |
行为配置。 |
---|
public function behaviors()
{
return [];
}
定义于: yii\base\Component::canGetProperty()
返回一个指示属性是否可读的值。
如果可以读取属性:
- 类中存在与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类中存在具有指定名称的成员变量(当
$checkVars
为 true 时); - 已附加行为具有给定名称的可读属性(当
$checkBehaviors
为 true 时)。
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
return | 布尔值 |
属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
定义于: yii\base\Component::canSetProperty()
返回一个指示属性是否可设置的值。
如果可以写入属性:
- 类中存在与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类中存在具有指定名称的成员变量(当
$checkVars
为 true 时); - 已附加行为具有给定名称的可写属性(当
$checkBehaviors
为 true 时)。
另请参阅 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
return | 布尔值 |
属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
代替。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
return | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行为的名称。 |
return | yii\base\Behavior|null |
分离的行为。如果行为不存在则为 Null。 |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于: yii\base\Component::ensureBehaviors()
确保在 behaviors() 中声明的行为附加到此组件。
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
格式化指定的响应。
public void format ( $response ) | ||
$response | yii\web\Response |
要格式化的响应。 |
public function format($response)
{
if ($this->contentType === null) {
$this->contentType = $this->useJsonp
? self::CONTENT_TYPE_JSONP
: self::CONTENT_TYPE_JSON;
} elseif (strpos($this->contentType, 'charset') === false) {
$this->contentType .= '; charset=UTF-8';
}
$response->getHeaders()->set('Content-Type', $this->contentType);
if ($this->useJsonp) {
$this->formatJsonp($response);
} else {
$this->formatJson($response);
}
}
以 JSON 格式格式化响应数据。
protected void formatJson ( $response ) | ||
$response | yii\web\Response |
protected function formatJson($response)
{
if ($response->data !== null) {
$options = $this->encodeOptions;
if ($this->prettyPrint) {
$options |= JSON_PRETTY_PRINT;
}
$default = Json::$keepObjectType;
if ($this->keepObjectType !== null) {
Json::$keepObjectType = $this->keepObjectType;
}
$response->content = Json::encode($response->data, $options);
// Restore default value to avoid any unexpected behaviour
Json::$keepObjectType = $default;
} elseif ($response->content === null) {
$response->content = 'null';
}
}
以 JSONP 格式格式化响应数据。
protected void formatJsonp ( $response ) | ||
$response | yii\web\Response |
protected function formatJsonp($response)
{
if (
is_array($response->data)
&& isset($response->data['data'], $response->data['callback'])
) {
$response->content = sprintf(
'%s(%s);',
$response->data['callback'],
Json::htmlEncode($response->data['data'])
);
} elseif ($response->data !== null) {
$response->content = '';
Yii::warning(
"The 'jsonp' response requires that the data be an array consisting of both 'data' and 'callback' elements.",
__METHOD__
);
}
}
定义于: yii\base\Component::getBehavior()
返回命名行为对象。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行为名称 |
return | yii\base\Behavior|null |
行为对象,如果行为不存在则为 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定义于: yii\base\Component::hasEventHandlers()
返回一个指示是否存在附加到命名事件的处理程序的值。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名称 |
return | 布尔值 |
事件是否有任何处理程序附加。 |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
定义于: yii\base\Component::hasMethod()
返回一个指示方法是否已定义的值。
如果满足以下条件,则定义了一个方法:
- 类中具有指定名称的方法
- 附加的行为具有给定名称的方法(当
$checkBehaviors
为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkBehaviors | 布尔值 |
是否将行为的方法视为此组件的方法 |
return | 布尔值 |
方法是否已定义 |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
定义于: yii\base\Component::hasProperty()
返回一个指示此组件是否定义了属性的值。
属性被定义,如果
- 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类中存在具有指定名称的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的属性(当
$checkBehaviors
为 true 时)。
另请参阅
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
return | 布尔值 |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
}
定义于: yii\base\Component::off()
从此组件中分离现有事件处理程序。
此方法与 on() 相反。
注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而不会删除与此通配符匹配的普通名称注册的处理程序。
另请参阅 on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名称 |
$handler | callable|null |
要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。 |
return | 布尔值 |
如果找到处理程序并将其分离 |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
将事件处理程序附加到事件。
事件处理程序必须是一个有效的 PHP 回调。以下是一些例子
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
事件处理程序必须使用以下签名定义,
function ($event)
其中 $event
是一个 yii\base\Event 对象,其中包含与事件相关联的参数。
从 2.0.14 开始,您可以将事件名称指定为通配符模式
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
另请参阅 off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
事件名称 |
$handler | callable |
事件处理程序 |
$data | mixed |
传递给事件处理程序的数据,当事件被触发时。当调用事件处理程序时,可以访问此数据 yii\base\Event::$data。 |
$append | 布尔值 |
是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false,则新处理程序将插入到现有处理程序列表的开头。 |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
事件名称 |
$event | yii\base\Event|null |
事件实例。如果没有设置,则将创建一个默认的 yii\base\Event 对象。 |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
注册 或 登录 才能发表评论。