Класс yii\filters\HttpCache

HttpCache реализует кеширование на стороне клиента, используя заголовки Last-Modified и ETag HTTP.

Это фильтр действия, который можно добавить в контроллер и обрабатывает событие beforeAction.

Чтобы использовать HttpCache, объявите его в методе behaviors() вашего класса контроллера. В следующем примере фильтр будет применен к действию list, а заголовок 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 публичное свойство

Значение заголовка Cache-Control HTTP. Если null, заголовок не будет отправлен.

См. также http://tools.ietf.org/html/rfc2616#section-14.9.

public string $cacheControlHeader = 'public, max-age=3600'

$enabled публичное свойство

Значение, указывающее, должен ли быть включён этот фильтр.

public boolean $enabled = true

$etagSeed публичное свойство

PHP-обработчик, генерирующий строку ETag. Подпись обратного вызова должна быть:

function ($action, $params)

где $action — объект yii\base\Action, который в данный момент обрабатывается этим фильтром; $params принимает значение $params. Обработчик должен вернуть строку, служащую семеном для генерации ETag.

public callable $etagSeed = null

$lastModified общее свойство

PHP-обработчик, возвращающий метку времени последнего изменения в формате временной метки Unix. Подпись обработчика должна быть следующей:

function ($action, $params)

где $action — объект yii\base\Action, обрабатываемый этим фильтром в данный момент; $params принимает значение $params. Обработчик должен возвращать временную метку Unix.

См. также http://tools.ietf.org/html/rfc7232#section-2.2.

public callable $lastModified = null

$params общее свойство

Дополнительные параметры, которые должны быть переданы обработчикам $lastModified и $etagSeed.

public mixed $params = null

$sessionCacheLimiter общее свойство

Имя ограничителя кэша сеанса, которое должно быть установлено при вызове session_cache_limiter(). Значение по умолчанию — пустая строка, что означает отключение автоматической отправки заголовков кэша. Можно задать значение этого свойства public, private, private_no_expire, и nocache. Подробное объяснение этих значений см. в session_cache_limiter().

Если это свойство null, то session_cache_limiter() не будет вызван. В результате PHP отправит заголовки в соответствии с настройкой session.cache_limiter PHP ini.

public string $sessionCacheLimiter = ''

$weakEtag общее свойство (доступно с версии 2.0.8)

Нужно ли генерировать слабые ETag.

Слабые ETag следует использовать, если содержимое должно считаться семантически эквивалентным, но не байтово-равным.

См. также http://tools.ietf.org/html/rfc7232#section-2.3.

public boolean $weakEtag = false

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