COutputCache

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

Подробное описание свойств

baseCacheKey свойство только для чтения

protected string getBaseCacheKey()

Вычисляет базовый ключ кэша. Вычисленный ключ будет далее изменён в getCacheKey. Производные классы могут переопределить этот метод, если необходимы дополнительные изменения.

cache свойство только для чтения

protected ICache getCache()

кэш, используемый для кеширования содержимого.

cacheID свойство

public string $cacheID;

Идентификатор компонента приложения кэша. По умолчанию равен 'cache' (основной компонент приложения кэша).

cacheKey свойство только для чтения

protected string getCacheKey()

Вычисляет ключ кэша. Ключ вычисляется на основе getBaseCacheKey и других факторов, включая varyByRoute, varyByParam, varyBySession и varyByLanguage.

dependency свойство

public mixed $dependency;

зависимость, от которой зависит кэшируемое содержимое. Это может быть объект, реализующий интерфейс ICacheDependency, или массив, определяющий конфигурацию объекта зависимости. Например,

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

duration свойство

public integer $duration;

количество секунд, в течение которых данные могут храниться в кэше. По умолчанию 60 секунд. Если значение равно 0, существующее кэшированное содержимое будет удалено из кэша. Если значение отрицательное, кэш будет отключён (любое существующее кэшированное содержимое останется в кэше).

Обратите внимание, что если зависимость от кэша изменится или место в кэше ограничено, данные могут быть удалены из кэша раньше.

isContentCached свойство только для чтения

public boolean getIsContentCached()

указывает, может ли содержимое быть найдено в кэше

requestTypes свойство

public array $requestTypes;

список типов запросов (например, GET, POST), для которых кэш должен быть включён. По умолчанию null, что означает все типы запросов.

varyByExpression свойство

public string $varyByExpression;

PHP выражение, результат которого используется в вычислении ключа кэша. Установив это свойство, кэш вывода будет использовать разные данные кэша для каждого результата выражения. Выражение также может быть допустимым PHP обратным вызовом, включая имя метода класса (array(ClassName/Object, MethodName)) или анонимную функцию (PHP 5.3.0+). Подпись функции/метода должна быть следующей:

function foo($cache) { ... }

varyByLanguage свойство (доступно начиная с версии v1.1.14)

public boolean $varyByLanguage;

указывает, следует ли различать кэшируемое содержимое в соответствии с языком пользователя. Язык извлекается через Yii::app()->language. По умолчанию false.

varyByParam свойство

public array $varyByParam;

список параметров GET, которые должны участвовать в вычислении ключа кэша. Установив это свойство, кэш вывода будет использовать разные данные кэша для каждого набора значений параметров GET.

varyByRoute свойство

public boolean $varyByRoute;

указывает, следует ли различать кэшируемое содержимое в соответствии с маршрутом. Маршрут состоит из идентификатора запрошенного контроллера и идентификатора действия. По умолчанию true.

varyBySession свойство

public boolean $varyBySession;

указывает, следует ли различать кэшируемое содержимое в соответствии с сеансами пользователей. По умолчанию false.

Подробное описание методов

checkContentCache() метод

protected boolean checkContentCache()

protected function checkContentCache()
{
    if((empty($this->requestTypes) || in_array(Yii::app()->getRequest()->getRequestType(),$this->requestTypes))
        && ($this->_cache=$this->getCache())!==null)
    {
        if($this->duration>0 && ($data=$this->_cache->get($this->getCacheKey()))!==false)
        {
            $this->_content=$data[0];
            $this->_actions=$data[1];
            return true;
        }
        if($this->duration==0)
            $this->_cache->delete($this->getCacheKey());
        if($this->duration<=0)
            $this->_cache=null;
    }
    return false;
}

Ищет содержимое в кэше.

filter() метод

public boolean filter(CFilterChain $filterChain)

public function filter($filterChain)
{
    if(!$this->getIsContentCached())
        $filterChain->run();
    $this->run();
}

Выполняет фильтрацию перед выполнением действия. Этот метод предназначен для переопределения дочерними классами, если требуется начальная фильтрация.

getBaseCacheKey() метод

protected string getBaseCacheKey()

protected function getBaseCacheKey()
{
    return self::CACHE_KEY_PREFIX.$this->getId().'.';
}

Вычисляет базовый ключ кэша. Вычисленный ключ будет далее изменён в getCacheKey. Производные классы могут переопределить этот метод, если необходимы дополнительные изменения.

getCache() метод

protected ICache getCache()

protected function getCache()
{
    return Yii::app()->getComponent($this->cacheID);
}

getCacheKey() метод

protected string getCacheKey()

protected function getCacheKey()
{
    if($this->_key!==null)
        return $this->_key;
    else
    {
        $key=$this->getBaseCacheKey().'.';
        if($this->varyByRoute)
        {
            $controller=$this->getController();
            $key.=$controller->getUniqueId().'/';
            if(($action=$controller->getAction())!==null)
                $key.=$action->getId();
        }
        $key.='.';

        if($this->varyBySession)
            $key.=Yii::app()->getSession()->getSessionID();
        $key.='.';

        if(is_array($this->varyByParam) && isset($this->varyByParam[0]))
        {
            $params=array();
            foreach($this->varyByParam as $name)
            {
                if(isset($_GET[$name]))
                    $params[$name]=$_GET[$name];
                else
                    $params[$name]='';
            }
            $key.=serialize($params);
        }
        $key.='.';

        if($this->varyByExpression!==null)
            $key.=$this->evaluateExpression($this->varyByExpression);
        $key.='.';

        if($this->varyByLanguage)
            $key.=Yii::app()->language;
        $key.='.';

        return $this->_key=$key;
    }
}

Вычисляет ключ кэша. Ключ вычисляется на основе getBaseCacheKey и других факторов, включая varyByRoute, varyByParam, varyBySession и varyByLanguage.

getIsContentCached() метод

public boolean getIsContentCached()

public function getIsContentCached()
{
    if($this->_contentCached!==null)
        return $this->_contentCached;
    else
        return $this->_contentCached=$this->checkContentCache();
}

init() метод

public void init()

public function init()
{
    if($this->getIsContentCached())
        $this->replayActions();
    elseif($this->_cache!==null)
    {
        $this->getController()->getCachingStack()->push($this);
        ob_start();
        ob_implicit_flush(false);
    }
}

Отмечает начало содержимого, подлежащего кешированию. Содержимое, отображаемое после вызова этого метода и до endCache(), будет захвачено и сохранено в кэше. Этот метод ничего не делает, если действительное содержимое уже найдено в кэше.

recordAction() метод

public void recordAction(string $context, string $method, array $params)

public function recordAction($context,$method,$params)
{
    $this->_actions[]=array($context,$method,$params);
}

Записывает вызов метода, когда этот кэш вывода активен. Когда содержимое подаётся из кэша вывода, записанный метод будет повторно вызван.

replayActions() метод

protected void replayActions()

protected function replayActions()
{
    if(empty($this->_actions))
        return;
    $controller=$this->getController();
    $cs=Yii::app()->getClientScript();
    foreach($this->_actions as $action)
    {
        if($action[0]==='clientScript')
            $object=$cs;
        elseif($action[0]==='')
            $object=$controller;
        else
            $object=$controller->{$action[0]};
        if(method_exists($object,$action[1]))
            call_user_func_array(array($object,$action[1]),$action[2]);
        elseif($action[0]==='' && function_exists($action[1]))
            call_user_func_array($action[1],$action[2]);
        else
            throw new CException(Yii::t('yii','Unable to replay the action "{object}.{method}". The method does not exist.',
                array('object'=>$action[0],
                    'method'=>$action[1])));
    }
}

Повторяет записанные вызовы методов.

run() метод

public void run()

public function run()
{
    if($this->getIsContentCached())
    {
        if($this->getController()->isCachingStackEmpty())
            echo $this->getController()->processDynamicOutput($this->_content);
        else
            echo $this->_content;
    }
    elseif($this->_cache!==null)
    {
        $this->_content=ob_get_clean();
        $this->getController()->getCachingStack()->pop();
        $data=array($this->_content,$this->_actions);
        if(is_array($this->dependency))
            $this->dependency=Yii::createComponent($this->dependency);
        $this->_cache->set($this->getCacheKey(),$data,$this->duration,$this->dependency);

        if($this->getController()->isCachingStackEmpty())
            echo $this->getController()->processDynamicOutput($this->_content);
        else
            echo $this->_content;
    }
}

Помечает конец контента, который должен быть кэширован. Контент, отображаемый до этого вызова метода и после init(), будет захвачен и сохранён в кэше. Этот метод ничего не делает, если действительный контент уже найден в кэше.