Класс yii\widgets\FragmentCache
| Наследование | yii\widgets\FragmentCache » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/FragmentCache.php |
FragmentCache используется yii\base\View для кэширования фрагментов страницы.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $cache | yii\caching\CacheInterface|array|string | Объект кэша или идентификатор компонента приложения объекта кэша. | yii\widgets\FragmentCache |
| $cachedContent | string|false | Кэшируемое содержимое. | yii\widgets\FragmentCache |
| $counter | integer | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $dependency | array|yii\caching\Dependency | Зависимость, от которой зависит кэшируемое содержимое. | yii\widgets\FragmentCache |
| $duration | integer | Количество секунд, в течение которого данные могут оставаться валидными в кэше. | yii\widgets\FragmentCache |
| $dynamicPlaceholders | array | Список заготовок для вставки динамического содержимого. | yii\widgets\FragmentCache |
| $enabled | boolean | Включить кэширование фрагментов. | yii\widgets\FragmentCache |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не завершены). | yii\base\Widget |
| $variations | array | Список факторов, которые могут привести к изменению кэшируемого содержимого. | yii\widgets\FragmentCache |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представления. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает работу виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект имени поведения. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| getCachedContent() | Возвращает кэшированное содержимое, если оно доступно. | yii\widgets\FragmentCache |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект FragmentCache. | yii\widgets\FragmentCache |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Помечает конец содержимого, которое должно быть кэшировано. | yii\widgets\FragmentCache |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| calculateKey() | Генерирует уникальный ключ, используемый для хранения содержимого в кэше. | yii\widgets\FragmentCache |
| updateDynamicContent() | Заменяет плейсхолдеры в содержимом результатами вычисленных динамических выражений. | yii\widgets\FragmentCache |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, генерируемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое генерируется, когда виджет инициализируется через init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$cache общедоступное свойство
Объект кэша или идентификатор компонента приложения для объекта кэша. После создания объекта FragmentCache, если вы хотите изменить это свойство, вы должны присвоить ему только объект кэша. Начиная с версии 2.0.2, это также может быть конфигурационный массив для создания объекта.
public yii\caching\CacheInterface|array|string $cache = 'cache'
$cachedContent общедоступное только для чтения свойство
Кэшированное содержимое. Возвращается значение false, если действительное содержимое не найдено в кэше.
public string|false getCachedContent ( )
$dependency общедоступное свойство
Зависимость, от которой зависит кэшированное содержимое. Это может быть либо объект yii\caching\Dependency, либо конфигурационный массив для создания объекта зависимости. Например,
[
'class' => 'yii\caching\DbDependency',
'sql' => 'SELECT MAX(updated_at) FROM post',
]
сделает выходной кэш зависимым от последнего времени изменения всех записей. Если время изменения какой-либо записи изменится, кэшированное содержимое будет недействительным.
public array|yii\caching\Dependency $dependency = null
$duration общедоступное свойство
Количество секунд, в течение которых данные могут храниться в кэше. Используйте 0, чтобы указать, что кэшированные данные никогда не истекают.
public integer $duration = 60
$dynamicPlaceholders свойство public
Список плацехолдеров для вставки динамического содержимого. Это свойство используется внутри для реализации функции кэширования содержимого. Не изменяйте его.
public array $dynamicPlaceholders = null
$enabled свойство public
Включить кэширование фрагментов. Вы можете использовать это свойство для включения и выключения кэширования фрагментов в соответствии с определёнными настройками (например, включить кэширование фрагментов только для запросов GET).
public boolean $enabled = true
$variations свойство public
Список факторов, которые могут привести к изменению кэшируемого содержимого. Каждый фактор — строка, представляющая изменение (например, язык, параметр GET). Следующая настройка изменений приведет к кэшированию содержимого в различных версиях в зависимости от текущего языка приложения:
[
Yii::$app->language,
]
public array $variations = null
Подробное описание методов
calculateKey() метод protected
Генерирует уникальный ключ для хранения содержимого в кэше.
Сгенерированный ключ зависит как от $id, так и от $variations.
| protected mixed calculateKey ( ) | ||
|---|---|---|
| return | mixed |
Действительный ключ кэша |
getCachedContent() метод public
Возвращает кэшированное содержимое, если оно доступно.
| public string|false getCachedContent ( ) | ||
|---|---|---|
| return | string|false |
Кэшированное содержимое. Возвращает False, если в кэше нет валидного содержимого. |
init() метод public
Инициализирует объект FragmentCache.
| public void init ( ) |
|---|
run() метод public
Помечает конец содержимого, подлежащего кэшированию.
Содержимое, отображаемое до вызова этого метода и после init(), будет захвачено и сохранено в кэше. Этот метод ничего не делает, если в кэше уже найдено валидное содержимое.
| public void run ( ) |
|---|
updateDynamicContent() метод protected
Заменяет плацехолдеры в содержимом результатами вычисленных динамических выражений.
| protected string updateDynamicContent ( $content, $placeholders ) | ||
|---|---|---|
| $content | string | |
| $placeholders | array | |
| return | string |
Окончательное содержимое |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-fragmentcache.html
