cache.yml設定ファイル

cache.yml設定ファイルはビューレイヤー用のキャッシュ設定を記述します。 この設定ファイルはsettings.ymlでcache設定が有効な場合のみアクティブになります。

アプリケーションが作成されるとき、symfonyはアプリケーションのconfig/ディレクトリにデフォルトのcache.ymlファイルを生成します。 このファイルはアプリケーション全体のキャッシュを記述します(defaultキーの下)。 デフォルトでは、キャッシュはグローバルスコープでoffにセットされます:

default:
  enabled:     off
  with_layout: false
  lifetime:    86400

はじめの章で説明したように、cache.ymlファイルはコンフィギュレーションカスケードのメカニズムが有効になり、定数を格納することができます。

アプリケーションのデフォルトコンフィギュレーションはモジュールのconfig/ディレクトリのなかでcache.ymlファイルを作ることでモジュールのためにオーバーライドできます。 メインキーはプレフィックスのexecuteなしのアクションの名前です(たとえばindexキーはexecuteIndexメソッドです)。 名前にアンダースコア(_)のプレフィックスをつけることでパーシャルもしくはコンポーネントもキャッシュできます。

アクションがキャッシュされるかどうか決定するのに、symfonyは次の順序で情報を探します:

• 存在するのであれば、モジュール設定ファイルでの特定のアクション、パーシャル、コンポーネント用のコンフィギュレーション;

• 存在するのであれば、モジュール設定ファイルでのモジュール全体用のコンフィギュレーション(allキーの下);

• アプリケーションのデフォルトコンフィギュレーション(defaultキーの下)

enabled

デフォルト: off

enabled設定は現在のスコープでのキャッシュを有効もしくは無効にします。

with_layout

デフォルト: false

with_layout設定はページ全体(true)、かアクションのみ(false)をキャッシュするかを決定します。

lifetime

デフォルト: 86400

lifetime設定はサーバーサイドキャッシュの有効期間を秒単位で定義します(86400秒は1日に等しい)。

client_lifetime

デフォルト: lifetimeの値と同じ

client_lifetime設定はクライアントサイドキャッシュの有効期間を秒単位で定義します。

すでにLast-ModifiedもしくはExpiresヘッダーがセットされていない限り、この設定はExpiresヘッダーとmax-cacheキャッシュコントロール変数を自動的にセットするために使われます。

この値を0にセットすることでクライアントサイドキャッシュを無効にできます。

contextual

デフォルト: false

contextual設定はキャッシュが現在のページのコンテキストに依存するかどうかを決定します。 それゆえ設定はパーシャルとコンポーネント用に使われるときのみ意味があります。

インクルードされるテンプレートによってパーシャルの出力が異なるとき、パーシャルはコンテキスト上(contextual)であると考えられ、contextual設定はtrueにセットしなければなりません。 デフォルトでは、設定はfalseにセットされます。 falseにセットされているということはパーシャルとコンポーネントがどこでインクルードされても、出力が常に同じであることを意味します。