Class yii\filters\ContentNegotiator

ContentNegotiator 支持响应格式协商和应用程序语言协商。

如果指定 supported formats 属性， ContentNegotiator 将支持 基于 GET 参数 $formatParam 的值和Accept HTTP header 的响应格式协商。 如果找到匹配，yii\web\Response::$format 属性将设置为所选的格式。 yii\web\Response::$acceptMimeType 以及 yii\web\Response::$acceptParams 也将相应更新。

如果指定了 supported languages， ContentNegotiator 程序将支持 基于 GET 参数 $languageParam 和Accept-Language HTTP header 的值进行应用程序语言协商。 如果找到匹配，yii\base\Application::$language 属性将设置为选择的语言。

您可以将 ContentNegotiator 程序用作引导组件和操作筛选器。

下面的代码显示如何将 ContentNegotiator 程序用作引导组件。注意在这种情况下， 内容协商适用于整个应用程序。

// in application configuration
use yii\web\Response;

return [
    'bootstrap' => [
        [
            'class' => 'yii\filters\ContentNegotiator',
            'formats' => [
                'application/json' => Response::FORMAT_JSON,
                'application/xml' => Response::FORMAT_XML,
            ],
            'languages' => [
                'en',
                'de',
            ],
        ],
    ],
];

下面的代码显示了如何在控制器或模块中将 ContentNegotiator 程序用作操作筛选器。 在这种情况下，内容协商结果仅适用于相应的控制器或模块，或者 如果您配置过滤器的 only 或except 属性甚至还可以配置特定的操作。

use yii\web\Response;

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\ContentNegotiator',
            'only' => ['view', 'index'],  // in a controller
            // if in a module, use the following IDs for user actions
            // 'only' => ['user/view', 'user/index']
            'formats' => [
                'application/json' => Response::FORMAT_JSON,
            ],
            'languages' => [
                'en',
                'de',
            ],
        ],
    ];
}