Класс yii\filters\ContentNegotiator

ContentNegotiator поддерживает переговорный формат ответа и языка приложения.

Когда свойство поддерживаемых форматов указано, ContentNegotiator будет поддерживать переговорный формат ответа, основываясь на значении параметра GET $formatParam и HTTP-заголовке Accept. Если совпадение найдено, свойство yii\web\Response::$format будет установлено в качестве выбранного формата. Свойства yii\web\Response::$acceptMimeType и yii\web\Response::$acceptParams также будут обновлены соответственно.

Когда свойство поддерживаемых языков указано, ContentNegotiator будет поддерживать переговорный язык приложения, основываясь на значении параметра GET $languageParam и HTTP-заголовке Accept-Language. Если совпадение найдено, свойство 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',
            ],
        ],
    ];
}

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

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

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

Подробное описание свойств

$formatParam общедоступное свойство

Имя параметра GET, указывающего формат ответа. Обратите внимание, что если указанный формат не существует в $formats, будет выброшено исключение yii\web\UnsupportedMediaTypeHttpException. Если значение параметра пустое или это свойство равно null, формат ответа будет определяться только на основе заголовка Accept HTTP.

См. также $formats.

public string $formatParam = '_format'

$formats общедоступное свойство

Список поддерживаемых форматов ответа. Ключи — MIME-типы (например, application/json), а значения — соответствующие форматы (например, html, json), которые должны поддерживаться, как объявлено в yii\web\Response::$formatters.

Если это свойство пустое или не задано, переговоры о формате ответа будут пропущены.

public array $formats = null

$languageParam общедоступное свойство

Имя параметра GET, указывающего язык приложения. Обратите внимание, что если указанный язык не соответствует ни одному из $languages, будет использован первый язык из $languages. Если значение параметра пустое или это свойство равно null, язык приложения будет определяться только на основе заголовка Accept-Language HTTP.

См. также $languages.

public string $languageParam = '_lang'

$languages общедоступное свойство

Список поддерживаемых языков. Ключи массива — поддерживаемые варианты языков (например, en-GB, en-US), а значения — соответствующие коды языков (например, en, de), распознаваемые приложением.

Ключи массива не всегда обязательны. Когда у значения массива нет ключа, сопоставление запрошенного языка будет основано на механизме перехода к резервному языку. Например, значение en будет соответствовать en, en_US, en-US, en-GB, и т.д.

Если это свойство пустое или не задано, переговоры о языке будут пропущены.

public array $languages = null

$request общедоступное свойство

Текущий запрос. Если не задано, будет использован компонент приложения request.

public yii\web\Request $request = null

$response общедоступное свойство

Ответ, который будет отправлен. Если не задано, будет использован компонент приложения response.

public yii\web\Response $response = null

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