クラス yii\filters\HttpCache
HttpCache は、Last-Modified
および ETag
HTTP ヘッダーを利用してクライアント側のキャッシングを実装します。
これは、コントローラーに追加できるアクションフィルターであり、beforeAction
イベントを処理します。
HttpCache を使用するには、コントローラークラスの behaviors()
メソッドで宣言します。次の例では、フィルターは index
アクションに適用され、Last-Modified ヘッダーにはデータベースのユーザーテーブルの最終更新日が含まれます。
public function behaviors()
{
return [
[
'class' => 'yii\filters\HttpCache',
'only' => ['index'],
'lastModified' => function ($action, $params) {
$q = new \yii\db\Query();
return $q->from('user')->max('updated_at');
},
// 'etagSeed' => function ($action, $params) {
// return // generate ETag seed here
// }
],
];
}
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$cacheControlHeader | string|null | Cache-Control HTTP ヘッダーの値。 |
yii\filters\HttpCache |
$enabled | boolean | このフィルターを有効にするかどうかを示す値。 | yii\filters\HttpCache |
$etagSeed | callable | ETag シード文字列を生成する PHP コールバック。 | yii\filters\HttpCache |
$except | array | このフィルターを適用しないアクション ID のリスト。 | yii\base\ActionFilter |
$lastModified | callable | 最終変更時刻の UNIX タイムスタンプを返す PHP コールバック。 | yii\filters\HttpCache |
$only | array | このフィルターを適用するアクション ID のリスト。 | yii\base\ActionFilter |
$owner | yii\base\Component|null | このビヘイビアの所有者 | yii\base\Behavior |
$params | mixed | $lastModified および $etagSeed コールバックに渡す追加パラメーター。 | yii\filters\HttpCache |
$sessionCacheLimiter | string|null | session_cache_limiter() が呼び出されたときに設定されるキャッシュリミッターの名前。 | yii\filters\HttpCache |
$weakEtag | boolean | 弱い ETag を生成するかどうか。 | yii\filters\HttpCache |
公開メソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
generateEtag() | 指定されたシード文字列から ETag を生成します。 | yii\filters\HttpCache |
getActionId() | yii\base\Action::$uniqueId をモジュールに相対的なIDに変換して、アクションIDを返します。 | yii\base\ActionFilter |
isActive() | 指定されたアクションに対してフィルターがアクティブかどうかを示す値を返します。 | yii\base\ActionFilter |
sendCacheControlHeader() | キャッシュコントロールヘッダーをクライアントに送信します。 | yii\filters\HttpCache |
validateCache() | HTTP キャッシュに有効なコンテンツが含まれているかどうかを検証します。 | yii\filters\HttpCache |
プロパティの詳細
Cache-Control
HTTP ヘッダーの値。null の場合、ヘッダーは送信されません。
こちらも参照してください https://datatracker.ietf.org/doc/html/rfc2616#section-14.9.
ETag シード文字列を生成する PHP コールバック。コールバックのシグネチャは次のようになります。
function ($action, $params)
ここで、$action
は、このフィルターが現在処理している yii\base\Action オブジェクトです。$params
は $params の値を取ります。コールバックは、ETag の生成のシードとして機能する文字列を返す必要があります。
最終更新時刻のUNIXタイムスタンプを返すPHPコールバック関数です。コールバック関数のシグネチャは次のようになります。
function ($action, $params)
ここで、$action
は、このフィルタが現在処理しているyii\base\Actionオブジェクトです。$params
は$paramsの値を取ります。コールバック関数はUNIXタイムスタンプを返す必要があります。
こちらも参照してください https://datatracker.ietf.org/doc/html/rfc7232#section-2.2.
session_cache_limiter() が呼び出されたときに設定されるキャッシュリミッターの名前です。デフォルト値は空文字列で、キャッシュヘッダーの自動送信を完全に無効にすることを意味します。このプロパティには、public
、private
、private_no_expire
、nocache
を設定できます。session_cache_limiter() を参照して、これらの値の詳細な説明を確認してください。
このプロパティがnull
の場合、session_cache_limiter()
は呼び出されません。その結果、PHPはsession.cache_limiter
PHP ini設定に従ってヘッダーを送信します。
弱い ETag を生成するかどうか。
コンテンツが意味的に等価とみなされるが、バイト単位で等価ではない場合、Weak ETagを使用する必要があります。
こちらも参照してください https://datatracker.ietf.org/doc/html/rfc7232#section-2.3.
メソッドの詳細
定義済み: 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)
{
if (!$this->enabled) {
return true;
}
$verb = Yii::$app->getRequest()->getMethod();
if ($verb !== 'GET' && $verb !== 'HEAD' || $this->lastModified === null && $this->etagSeed === null) {
return true;
}
$lastModified = $etag = null;
if ($this->lastModified !== null) {
$lastModified = call_user_func($this->lastModified, $action, $this->params);
}
if ($this->etagSeed !== null) {
$seed = call_user_func($this->etagSeed, $action, $this->params);
if ($seed !== null) {
$etag = $this->generateEtag($seed);
}
}
$this->sendCacheControlHeader();
$response = Yii::$app->getResponse();
if ($etag !== null) {
$response->getHeaders()->set('Etag', $etag);
}
$cacheValid = $this->validateCache($lastModified, $etag);
// https://tools.ietf.org/html/rfc7232#section-4.1
if ($lastModified !== null && (!$cacheValid || ($cacheValid && $etag === null))) {
$response->getHeaders()->set('Last-Modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
}
if ($cacheValid) {
$response->setStatusCode(304);
return false;
}
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;
}
}
定義位置: 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 [];
}
指定されたシード文字列から ETag を生成します。
protected string generateEtag ( $seed ) | ||
$seed | string |
ETag のシード |
戻り値 | string |
生成された ETag |
---|
protected function generateEtag($seed)
{
$etag = '"' . rtrim(base64_encode(sha1($seed, true)), '=') . '"';
return $this->weakEtag ? 'W/' . $etag : $etag;
}
定義位置: 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;
}
キャッシュコントロールヘッダーをクライアントに送信します。
参照: $cacheControlHeader.
protected void sendCacheControlHeader ( ) |
protected function sendCacheControlHeader()
{
if ($this->sessionCacheLimiter !== null) {
if ($this->sessionCacheLimiter === '' && !headers_sent() && Yii::$app->getSession()->getIsActive()) {
header_remove('Expires');
header_remove('Cache-Control');
header_remove('Last-Modified');
header_remove('Pragma');
}
Yii::$app->getSession()->setCacheLimiter($this->sessionCacheLimiter);
}
$headers = Yii::$app->getResponse()->getHeaders();
if ($this->cacheControlHeader !== null) {
$headers->set('Cache-Control', $this->cacheControlHeader);
}
}
HTTP キャッシュに有効なコンテンツが含まれているかどうかを検証します。
Last-ModifiedとETagの両方がnullの場合、falseを返します。
protected boolean validateCache ( $lastModified, $etag ) | ||
$lastModified | integer|null |
UNIXタイムスタンプで表される計算されたLast-Modified値。nullの場合、Last-Modifiedヘッダーは検証されません。 |
$etag | string|null |
計算されたETag値。nullの場合、ETagヘッダーは検証されません。 |
戻り値 | boolean |
HTTPキャッシュがまだ有効かどうか。 |
---|
protected function validateCache($lastModified, $etag)
{
if (Yii::$app->request->headers->has('If-None-Match')) {
// HTTP_IF_NONE_MATCH takes precedence over HTTP_IF_MODIFIED_SINCE
// https://datatracker.ietf.org/doc/html/rfc7232#section-3.3
return $etag !== null && in_array($etag, Yii::$app->request->getETags(), true);
} elseif (Yii::$app->request->headers->has('If-Modified-Since')) {
return $lastModified !== null && @strtotime(Yii::$app->request->headers->get('If-Modified-Since')) >= $lastModified;
}
return false;
}
サインアップ または ログイン してコメントしてください。