クラス yii\filters\ContentNegotiator
ContentNegotiatorは、レスポンスフォーマットのネゴシエーションとアプリケーション言語のネゴシエーションをサポートします。
サポートされるフォーマットプロパティが指定されている場合、ContentNegotiatorは、GETパラメータ$formatParamとAccept
HTTPヘッダーの値に基づいて、レスポンスフォーマットのネゴシエーションをサポートします。一致が見つかった場合、yii\web\Response::$formatプロパティに選択されたフォーマットが設定されます。yii\web\Response::$acceptMimeTypeとyii\web\Response::$acceptParamsも、それに応じて更新されます。
サポートされる言語が指定されている場合、ContentNegotiatorは、GETパラメータ$languageParamとAccept-Language
HTTPヘッダーの値に基づいて、アプリケーション言語のネゴシエーションをサポートします。一致が見つかった場合、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',
],
],
];
}
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$except | array | このフィルタを適用しないアクションIDのリスト。 | yii\base\ActionFilter |
$formatParam | string | レスポンスフォーマットを指定するGETパラメータの名前。 | yii\filters\ContentNegotiator |
$formats | array|null | サポートされるレスポンスフォーマットのリスト。 | yii\filters\ContentNegotiator |
$languageParam | string | アプリケーション言語を指定するGETパラメータの名前。 | yii\filters\ContentNegotiator |
$languages | array|null | サポートされる言語のリスト。 | yii\filters\ContentNegotiator |
$only | array | このフィルタを適用するアクションIDのリスト。 | yii\base\ActionFilter |
$owner | yii\base\Component|null | このビヘイビアのオーナー | yii\base\Behavior |
$request | yii\web\Request | 現在のリクエスト。 | yii\filters\ContentNegotiator |
$response | yii\web\Response|null | 送信されるレスポンス。 | yii\filters\ContentNegotiator |
公開メソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
getActionId() | yii\base\Action::$uniqueIdをモジュールを基準としたIDに変換することで、アクションIDを返します。 | yii\base\ActionFilter |
isActive() | 指定されたアクションに対してフィルタがアクティブかどうかを示す値を返します。 | yii\base\ActionFilter |
isLanguageSupported() | リクエストされた言語がサポートされている言語と一致するかどうかを示す値を返します。 | yii\filters\ContentNegotiator |
negotiateContentType() | レスポンスフォーマットをネゴシエートします。 | yii\filters\ContentNegotiator |
negotiateLanguage() | アプリケーション言語をネゴシエートします。 | yii\filters\ContentNegotiator |
プロパティの詳細
レスポンスフォーマットを指定するGETパラメータの名前です。指定されたフォーマットが$formatsに存在しない場合、yii\web\NotAcceptableHttpException例外がスローされます。パラメータ値が空の場合、またはこのプロパティがnullの場合、レスポンスフォーマットはAccept
HTTPヘッダーのみを基に決定されます。
こちらも参照してください $formats.
サポートされているレスポンスフォーマットのリストです。キーはMIMEタイプ(例:application/json
)、値は対応するフォーマット(例:html
、json
)で、yii\web\Response::$formattersで宣言されているようにサポートされている必要があります。
このプロパティが空の場合、または設定されていない場合、レスポンスフォーマットのネゴシエーションはスキップされます。
アプリケーション言語を指定するGETパラメータの名前です。指定された言語が$languagesのいずれとも一致しない場合、$languagesの最初の言語が使用されます。パラメータ値が空の場合、またはこのプロパティがnullの場合、アプリケーション言語はAccept-Language
HTTPヘッダーのみを基に決定されます。
こちらも参照してください $languages.
サポートされている言語のリストです。配列のキーはサポートされている言語のバリアント(例:en-GB
、en-US
)、配列の値はアプリケーションによって認識される対応する言語コード(例:en
、de
)です。
配列キーは必ずしも必要ではありません。配列値にキーがない場合、リクエストされた言語の一致は言語フォールバックメカニズムに基づいて行われます。たとえば、en
の値はen
、en_US
、en-US
、en-GB
などに一致します。
このプロパティが空の場合、または設定されていない場合、言語ネゴシエーションはスキップされます。
現在のリクエストです。設定されていない場合、request
アプリケーションコンポーネントが使用されます。
送信されるレスポンスです。設定されていない場合、response
アプリケーションコンポーネントが使用されます。
メソッドの詳細
定義場所: yii\base\BaseObject::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。
public mixed __call ( $name, $params ) | ||
$name | string |
メソッド名 |
$params | array |
メソッドパラメータ |
戻り値 | mixed |
メソッドの戻り値 |
---|---|---|
例外 | yii\base\UnknownMethodException |
未知のメソッドを呼び出した場合 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義場所: yii\base\BaseObject::__construct()
コンストラクタ。
デフォルトの実装は次の2つのことを行います。
- 指定された設定
$config
を使用してオブジェクトを初期化します。 - init()を呼び出します。
このメソッドを子クラスでオーバーライドする場合、推奨事項は以下の通りです。
- コンストラクタの最後のパラメータは、ここの
$config
のように、設定配列にすること。 - コンストラクタの最後に親の実装を呼び出すこと。
public void __construct ( $config = [] ) | ||
$config | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義場所: yii\base\BaseObject::__get()
オブジェクトプロパティの値を返します。
これはPHPのマジックメソッドであり、$value = $object->property;
を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください __set().
public mixed __get ( $name ) | ||
$name | string |
プロパティ名 |
戻り値 | mixed |
プロパティ値 |
---|---|---|
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
例外 | yii\base\InvalidCallException |
プロパティが書き込み専用の場合 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (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\BaseObject::__isset()
プロパティが設定されているか(つまり、定義されていてnullではないか)をチェックします。
これはPHPのマジックメソッドであり、isset($object->property)
を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
プロパティが定義されていない場合、falseが返されることに注意してください。
こちらも参照してください https://www.php.net/manual/en/function.isset.php.
public boolean __isset ( $name ) | ||
$name | string |
プロパティ名またはイベント名 |
戻り値 | boolean |
指定されたプロパティが設定されているかどうか(nullではない)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義場所: yii\base\BaseObject::__set()
オブジェクトプロパティの値を設定します。
これはPHPのマジックメソッドであり、`$object->property = $value;`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください __get().
public void __set ( $name, $value ) | ||
$name | string |
プロパティ名またはイベント名 |
$value | mixed |
プロパティ値 |
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
---|---|---|
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義場所: yii\base\BaseObject::__unset()
オブジェクトプロパティをnullに設定します。
これはPHPのマジックメソッドであり、`unset($object->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
プロパティが定義されていない場合、このメソッドは何もしません。プロパティが読み取り専用の場合、例外をスローします。
こちらも参照してください https://www.php.net/manual/en/function.unset.php.
public void __unset ( $name ) | ||
$name | string |
プロパティ名 |
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義場所: yii\base\ActionFilter::afterAction()
アクションが実行された直後に呼び出されるメソッドです。
アクションの後処理を行うために、このメソッドをオーバーライドすることができます。
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
実行されたばかりのアクション。 |
$result | mixed |
アクションの実行結果 |
戻り値 | mixed |
処理されたアクション結果。 |
---|
public function afterAction($action, $result)
{
return $result;
}
public void afterFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function afterFilter($event)
{
$event->result = $this->afterAction($event->action, $event->result);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
定義場所: yii\base\ActionFilter::attach()
ビヘイビアオブジェクトをコンポーネントにアタッチします。
$owner プロパティを設定し、events()で宣言されているイベントハンドラをアタッチします。このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void attach ( $owner ) | ||
$owner | yii\base\Component |
このビヘイビアをアタッチするコンポーネント。 |
public function attach($owner)
{
$this->owner = $owner;
$owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
アクションが実行される直前に呼び出されるメソッドです(可能な全てのフィルタの後)。このメソッドをオーバーライドして、アクションの準備を最終的に行うことができます。
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
実行されるアクション。 |
戻り値 | boolean |
アクションの実行を続行するかどうか。 |
---|
public function beforeAction($action)
{
$this->negotiate();
return true;
}
public void beforeFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function beforeFilter($event)
{
if (!$this->isActive($event->action)) {
return;
}
$event->isValid = $this->beforeAction($event->action);
if ($event->isValid) {
// call afterFilter only if beforeFilter succeeds
// beforeFilter and afterFilter should be properly nested
$this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
} else {
$event->handled = true;
}
}
アプリケーションのブートストラップ段階で呼び出されるブートストラップメソッド。
public void bootstrap ( $app ) | ||
$app | yii\base\Application |
現在実行されているアプリケーション |
public function bootstrap($app)
{
$this->negotiate();
}
定義場所: yii\base\BaseObject::canGetProperty()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、以下の場合に読み取り可能です。
- クラスが指定された名前に関連付けられたゲッターメソッドを持つ場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスが指定された名前のメンバ変数を持つ場合(`$checkVars`がtrueの場合)。
こちらも参照してください canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティを読み取ることができるかどうか |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義場所: yii\base\BaseObject::canSetProperty()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込み可能です。
- クラスが指定された名前に関連付けられたセッターメソッドを持つ場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスが指定された名前のメンバ変数を持つ場合(`$checkVars`がtrueの場合)。
こちらも参照してください canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティを書き込むことができるかどうか |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
を使用してください。
定義位置: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
戻り値 | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
定義位置: yii\base\ActionFilter::detach()
ビヘイビアオブジェクトをコンポーネントからデタッチします。
デフォルトの実装では、$owner プロパティをアンセットし、events() で宣言されたイベントハンドラをデタッチします。このメソッドをオーバーライドする場合は、必ず親実装を呼び出してください。
public void detach ( ) |
public function detach()
{
if ($this->owner) {
$this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
$this->owner = null;
}
}
定義位置: yii\base\Behavior::events()
$ownerのイベントのイベントハンドラを宣言します。
子クラスは、このメソッドをオーバーライドして、$owner コンポーネントのイベントにアタッチするべきPHPコールバックを宣言できます。
コールバックは、ビヘイビアがオーナーにアタッチされたときに$ownerのイベントにアタッチされ、ビヘイビアがコンポーネントからデタッチされたときにイベントからデタッチされます。
コールバックは次のいずれかです。
- このビヘイビア内のメソッド:
'handleClick'
、[$this, 'handleClick']
と同等です。 - オブジェクトメソッド:
[$object, 'handleClick']
- 静的メソッド:
['Page', 'handleClick']
- 無名関数:
function ($event) { ... }
例を以下に示します。
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( ) | ||
戻り値 | array |
イベント(配列キー)と対応するイベントハンドラメソッド(配列値)。 |
---|
public function events()
{
return [];
}
定義位置: yii\base\ActionFilter::getActionId()
yii\base\Action::$uniqueIdをモジュールを基準としたIDに変換することで、アクションIDを返します。
protected string getActionId ( $action ) | ||
$action | yii\base\Action |
protected function getActionId($action)
{
if ($this->owner instanceof Module) {
$mid = $this->owner->getUniqueId();
$id = $action->getUniqueId();
if ($mid !== '' && strpos($id, $mid) === 0) {
$id = substr($id, strlen($mid) + 1);
}
} else {
$id = $action->id;
}
return $id;
}
定義位置: yii\base\BaseObject::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
デフォルトの実装は、PHP関数method_exists()
の呼び出しです。PHPマジックメソッド__call()
を実装した場合は、このメソッドをオーバーライドできます。
public boolean hasMethod ( $name ) | ||
$name | string |
メソッド名 |
戻り値 | boolean |
メソッドが定義されているかどうか。 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義位置: yii\base\BaseObject::hasProperty()
プロパティが定義されているかどうかを示す値を返します。
プロパティは、次の場合に定義されます。
- クラスが指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合(この場合、プロパティ名は大小文字を区別しません)。
- クラスが指定された名前のメンバ変数を持つ場合(`$checkVars`がtrueの場合)。
参照
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティが定義されているかどうか。 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
定義位置: yii\base\ActionFilter::isActive()
指定されたアクションに対してフィルタがアクティブかどうかを示す値を返します。
protected boolean isActive ( $action ) | ||
$action | yii\base\Action |
フィルタリングされるアクション。 |
戻り値 | boolean |
指定されたアクションに対してフィルタがアクティブかどうか。 |
---|
protected function isActive($action)
{
$id = $this->getActionId($action);
if (empty($this->only)) {
$onlyMatch = true;
} else {
$onlyMatch = false;
foreach ($this->only as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$onlyMatch = true;
break;
}
}
}
$exceptMatch = false;
foreach ($this->except as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$exceptMatch = true;
break;
}
}
return !$exceptMatch && $onlyMatch;
}
リクエストされた言語がサポートされている言語と一致するかどうかを示す値を返します。
protected boolean isLanguageSupported ( $requested, $supported ) | ||
$requested | string |
要求された言語コード。 |
$supported | string |
サポートされている言語コード。 |
戻り値 | boolean |
要求された言語がサポートされているかどうか。 |
---|
protected function isLanguageSupported($requested, $supported)
{
$supported = str_replace('_', '-', strtolower($supported));
$requested = str_replace('_', '-', strtolower($requested));
return strpos($requested . '-', $supported . '-') === 0;
}
レスポンスフォーマットとアプリケーション言語をネゴシエートします。
public void negotiate ( ) |
public function negotiate()
{
$request = $this->request ?: Yii::$app->getRequest();
$response = $this->response ?: Yii::$app->getResponse();
if (!empty($this->formats)) {
if (\count($this->formats) > 1) {
$response->getHeaders()->add('Vary', 'Accept');
}
$this->negotiateContentType($request, $response);
}
if (!empty($this->languages)) {
if (\count($this->languages) > 1) {
$response->getHeaders()->add('Vary', 'Accept-Language');
}
Yii::$app->language = $this->negotiateLanguage($request);
}
}
レスポンスフォーマットをネゴシエートします。
protected void negotiateContentType ( $request, $response ) | ||
$request | yii\web\Request | |
$response | yii\web\Response | |
例外 | yii\web\BadRequestHttpException |
GETパラメータ$formatParamに配列が受け取られた場合。 |
---|---|---|
例外 | yii\web\NotAcceptableHttpException |
要求されたコンテンツタイプがどれも受け入れられない場合。 |
protected function negotiateContentType($request, $response)
{
if (!empty($this->formatParam) && ($format = $request->get($this->formatParam)) !== null) {
if (is_array($format)) {
throw new BadRequestHttpException("Invalid data received for GET parameter '{$this->formatParam}'.");
}
if (in_array($format, $this->formats)) {
$response->format = $format;
$response->acceptMimeType = null;
$response->acceptParams = [];
return;
}
throw new NotAcceptableHttpException('The requested response format is not supported: ' . $format);
}
$types = $request->getAcceptableContentTypes();
if (empty($types)) {
$types['*/*'] = [];
}
foreach ($types as $type => $params) {
if (isset($this->formats[$type])) {
$response->format = $this->formats[$type];
$response->acceptMimeType = $type;
$response->acceptParams = $params;
return;
}
}
foreach ($this->formats as $type => $format) {
$response->format = $format;
$response->acceptMimeType = $type;
$response->acceptParams = [];
break;
}
if (isset($types['*/*'])) {
return;
}
throw new NotAcceptableHttpException('None of your requested content types is supported.');
}
アプリケーション言語をネゴシエートします。
protected string negotiateLanguage ( $request ) | ||
$request | yii\web\Request | |
戻り値 | string |
選択された言語 |
---|
protected function negotiateLanguage($request)
{
if (!empty($this->languageParam) && ($language = $request->get($this->languageParam)) !== null) {
if (is_array($language)) {
// If an array received, then skip it and use the first of supported languages
return reset($this->languages);
}
if (isset($this->languages[$language])) {
return $this->languages[$language];
}
foreach ($this->languages as $key => $supported) {
if (is_int($key) && $this->isLanguageSupported($language, $supported)) {
return $supported;
}
}
return reset($this->languages);
}
foreach ($request->getAcceptableLanguages() as $language) {
if (isset($this->languages[$language])) {
return $this->languages[$language];
}
foreach ($this->languages as $key => $supported) {
if (is_int($key) && $this->isLanguageSupported($language, $supported)) {
return $supported;
}
}
}
return reset($this->languages);
}
コメントするにはサインアップ または ログインしてください。