COutputCache

if($this->beginCache('cacheName',array('property1'=>'value1',...))
{
    // ... display the content to be cached here
   $this->endCache();
}

Property Details

Caclulates the base cache key. The calculated key will be further variated in getCacheKey. Derived classes may override this method if more variations are needed.

the cache used for caching the content.

the ID of the cache application component. Defaults to 'cache' (the primary cache application component.)

Calculates the cache key. The key is calculated based on getBaseCacheKey and other factors, including varyByRoute, varyByParam, varyBySession and varyByLanguage.

the dependency that the cached content depends on. This can be either an object implementing ICacheDependency interface or an array specifying the configuration of the dependency object. For example,

array(
    'class'=>'CDbCacheDependency',
    'sql'=>'SELECT MAX(lastModified) FROM Post',
)

number of seconds that the data can remain in cache. Defaults to 60 seconds. If it is 0, existing cached content would be removed from the cache. If it is a negative value, the cache will be disabled (any existing cached content will remain in the cache.)

Note, if cache dependency changes or cache space is limited, the data may be purged out of cache earlier.

whether the content can be found from cache

list of request types (e.g. GET, POST) for which the cache should be enabled only. Defaults to null, meaning all request types.

a PHP expression whose result is used in the cache key calculation. By setting this property, the output cache will use different cached data for each different expression result. The expression can also be a valid PHP callback, including class method name (array(ClassName/Object, MethodName)), or anonymous function (PHP 5.3.0+). The function/method signature should be as follows:

function foo($cache) { ... }

whether the content being cached should be differentiated according to user's language. A language is retrieved via Yii::app()->language. Defaults to false.

list of GET parameters that should participate in cache key calculation. By setting this property, the output cache will use different cached data for each different set of GET parameter values.

whether the content being cached should be differentiated according to route. A route consists of the requested controller ID and action ID. Defaults to true.

whether the content being cached should be differentiated according to user sessions. Defaults to false.

Method Details

Looks for content in cache.

Performs filtering before the action is executed. This method is meant to be overridden by child classes if begin-filtering is needed.

Caclulates the base cache key. The calculated key will be further variated in getCacheKey. Derived classes may override this method if more variations are needed.

Calculates the cache key. The key is calculated based on getBaseCacheKey and other factors, including varyByRoute, varyByParam, varyBySession and varyByLanguage.

Marks the start of content to be cached. Content displayed after this method call and before endCache() will be captured and saved in cache. This method does nothing if valid content is already found in cache.

Records a method call when this output cache is in effect. When the content is served from the output cache, the recorded method will be re-invoked.

Replays the recorded method calls.

Marks the end of content to be cached. Content displayed before this method call and after init() will be captured and saved in cache. This method does nothing if valid content is already found in cache.