Класс yii\filters\PageCache

PageCache реализует кэширование целых страниц на стороне сервера.

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

Для использования PageCache, объявите его в методе behaviors() вашего класса контроллера. В следующем примере фильтр будет применен к действию index и кэшировать всю страницу максимум на 60 секунд или до изменения количества записей в таблице post. Он также сохраняет разные версии страницы в зависимости от языка приложения.

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,
            ]
        ],
    ];
}

Публичные свойства

Публичные методы

Защищённые методы

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

$cache общедоступное свойство

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

public yii\caching\CacheInterface|array|string $cache = 'cache'

$cacheCookies общедоступное свойство (доступно начиная с версии 2.0.4)

Логическое значение, указывающее, следует ли кэшировать все куки, или массив имён куки, указывающий, какие куки можно кэшировать. Будьте очень осторожны при кэшировании куки, так как это может привести к утечке конфиденциальных или личных данных, хранящихся в куки, для нежелательных пользователей.

public boolean|array $cacheCookies = false

$cacheHeaders общедоступное свойство (доступно начиная с версии 2.0.4)

Логическое значение, указывающее, следует ли кэшировать все HTTP-заголовки, или массив имён HTTP-заголовков (регистронезависимый) указывающий, какие HTTP-заголовки можно кэшировать. Обратите внимание, если ваши HTTP-заголовки содержат конфиденциальную информацию, вы должны указать, какие заголовки можно кэшировать.

public boolean|array $cacheHeaders = true

$dependency общедоступное свойство

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

[
    'class' => 'yii\caching\DbDependency',
    'sql' => 'SELECT MAX(updated_at) FROM post',
]

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

Если $cacheCookies или $cacheHeaders включены, то yii\caching\Dependency::$reusable также должен быть включён для экономии ресурсов. Это связано с тем, что куки и заголовки в настоящее время хранятся отдельно от фактического содержимого страницы, что приводит к двойному вычислению зависимости.

public array|yii\caching\Dependency $dependency = null

$duration общедоступное свойство

Количество секунд, в течение которых данные могут оставаться действительными в кэше. Используйте 0 для указания того, что кэшируемые данные никогда не истекают.

public integer $duration = 60

$dynamicPlaceholders общедоступное свойство (доступно начиная с версии 2.0.11)

Список плейсхолдеров для встраивания динамического содержимого. Это свойство используется внутренне для реализации функции кэширования содержимого. Не изменяйте его.

public array $dynamicPlaceholders = null

$enabled общедоступное свойство

Включить ли кэш страницы. Вы можете использовать это свойство для включения и выключения кэша страницы в зависимости от определённых настроек (например, включить кэш страницы только для запросов GET).

public boolean $enabled = true

$variations общедоступное свойство

Список факторов, которые могут привести к изменению кэшируемого содержимого. Каждый фактор — это строка, представляющая изменение (например, язык, параметр GET). Следующая настройка изменения приведет к кэшированию содержимого в разных версиях в зависимости от текущего языка приложения:

[
    Yii::$app->language,
]

public array $variations = null

$varyByRoute общедоступное свойство

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

public boolean $varyByRoute = true

$view общедоступное свойство

Компонент представления для использования при кэшировании. Если не указан, будет использоваться компонент представления по умолчанию для приложения yii\web\Application::$view.

public yii\base\View $view = null

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