• Home
• yii
• filters
• PageCache

PHP Class yii\filters\PageCache

It is an action filter that can be added to a controller and handles the beforeAction event. To use PageCache, declare it in the behaviors() method of your controller class. In the following example the filter will be applied to the index action and cache the whole page for maximum 60 seconds or until the count of entries in the post table changes. It also stores different versions of the page depending on the application language. php public function behaviors() { return [ 'pageCache' => [ 'class' => 'yii\filters\PageCache', 'only' => ['index'], 'duration' => 60, 'dependency' => [ 'class' => 'yii\caching\DbDependency', 'sql' => 'SELECT COUNT(*) FROM post', ], 'variations' => [ \Yii::$app->language, ] ], ]; } Datei anzeigen Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$cache		the cache object or the application component ID of the cache object. After the PageCache object is created, if you want to change this property, you should only assign it with a cache object. Starting from version 2.0.2, this can also be a configuration array for creating the object.
$cacheCookies		a boolean value indicating whether to cache all cookies, or an array of cookie names indicating which cookies can be cached. Be very careful with caching cookies, because it may leak sensitive or private data stored in cookies to unwanted users.
$cacheHeaders		a boolean value indicating whether to cache all HTTP headers, or an array of HTTP header names (case-insensitive) indicating which HTTP headers can be cached. Note if your HTTP headers contain sensitive information, you should white-list which headers can be cached.
$dependency		the dependency that the cached content depends on. This can be either a [[Dependency]] object or a configuration array for creating the dependency object. For example, php [ 'class' => 'yii\caching\DbDependency', 'sql' => 'SELECT MAX(updated_at) FROM post', ] would make the output cache depend on the last modified time of all posts. If any post has its modification time changed, the cached content would be invalidated. If [[cacheCookies]] or [[cacheHeaders]] is enabled, then [[\yii\caching\Dependency::reusable]] should be enabled as well to save performance. This is because the cookies and headers are currently stored separately from the actual page content, causing the dependency to be evaluated twice.
$duration		number of seconds that the data can remain valid in cache. Use 0 to indicate that the cached data will never expire.
$enabled		whether to enable the page cache. You may use this property to turn on and off the page cache according to specific setting (e.g. enable page cache only for GET requests).
$variations		list of factors that would cause the variation of the content being cached. Each factor is a string representing a variation (e.g. the language, a GET parameter). The following variation setting will cause the content to be cached in different versions according to the current application language: php [ Yii::$app->language, ]
$varyByRoute		whether the content being cached should be differentiated according to the route. A route consists of the requested controller ID and action ID. Defaults to true.
$view		the view component to use for caching. If not set, the default application view component [[\yii\web\Application::view]] will be used.

Public Methods

Method	Description
beforeAction ( Action $action ) : boolean	This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.
cacheResponse ( )	Caches response properties.
init ( )

Protected Methods

Method	Description
calculateCacheKey ( ) : array
restoreResponse ( Response $response, array $data )	Restores response properties from the given data

Method Details

Property Details