Класс yii\caching\TagDependency
| Наследование | yii\caching\TagDependency » yii\caching\Dependency » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/caching/TagDependency.php |
TagDependency связывает элемент кэшированных данных с одним или несколькими $тегами.
Вызывая invalidate(), можно сделать недействительными все кэшированные элементы данных, связанные с указанными именем(ами) тега.
// setting multiple cache keys to store data forever and tagging them with "user-123"
Yii::$app->cache->set('user_42_profile', '', 0, new TagDependency(['tags' => 'user-123']));
Yii::$app->cache->set('user_42_stats', '', 0, new TagDependency(['tags' => 'user-123']));
// invalidating all keys tagged with "user-123"
TagDependency::invalidate(Yii::$app->cache, 'user-123');
Для получения более подробной информации и руководства по использованию кэша, см. статью руководства по кэшированию.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $данные | смешанный | Данные зависимости, которые сохраняются в кэше и впоследствии сравниваются с последними данными зависимости. | yii\caching\Dependency |
| $повторно_используемый | boolean | Указывает, является ли эта зависимость повторно используемой. | yii\caching\Dependency |
| $теги | строка|массив | Список имён тегов для этой зависимости. | yii\caching\TagDependency |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли читать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| evaluateDependency() | Оценивает зависимость, генерируя и сохраняя данные, связанные с зависимостью. | yii\caching\Dependency |
| getHasChanged() | Возвращает значение, указывающее, изменилась ли зависимость. | yii\caching\Dependency |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| invalidate() | Делает недействительными все кэшированные элементы данных, связанные с любым из указанных $тегов. | yii\caching\TagDependency |
| isChanged() | Проверяет, изменилась ли зависимость. | yii\caching\TagDependency |
| resetReusableData() | Сбрасывает все кэшированные данные для повторно используемых зависимостей. | yii\caching\Dependency |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| generateDependencyData() | Генерирует данные, необходимые для определения изменения зависимости. | yii\caching\TagDependency |
| generateReusableHash() | Генерирует уникальный хэш, который можно использовать для извлечения данных о повторно используемой зависимости. | yii\caching\Dependency |
| getTimestamps() | Возвращает временные метки для указанных тегов. | yii\caching\TagDependency |
| touchKeys() | Генерирует временную метку для указанных ключей кэша. | yii\caching\TagDependency |
Подробности свойств
$теги открытое свойство
Список имён тегов для этой зависимости. Для одного тега вы можете указать его как строку.
public string|array $tags = []
Подробности методов
generateDependencyData() защищённый метод
Генерирует данные, необходимые для определения, была ли изменена зависимость.
Этот метод ничего не делает в этом классе.
| защищённый смешанный generateDependencyData ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кеширования, который в данный момент оценивает эту зависимость |
| return | смешанный |
Данные, необходимые для определения, была ли изменена зависимость. |
getTimestamps() защищённый метод
Возвращает метки времени для указанных тегов.
| защищённый массив getTimestamps ( $cache, $tags ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface | |
| $tags | строка[] | |
| return | массив |
Метки времени, индексированные по указанным тегам. |
invalidate() публичный статический метод
Очищает все кэшированные элементы данных, связанные с любым из указанных $tags.
| публичный статический void invalidate ( $cache, $tags ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кеширования, который кеширует элементы данных |
| $tags | строка|массив | |
isChanged() публичный метод
Проверяет, была ли изменена зависимость
| публичный булево isChanged ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кеширования, который в данный момент оценивает эту зависимость |
| return | булево |
Была ли изменена зависимость. |
touchKeys() защищённый статический метод
Генерирует метку времени для указанных ключей кеша.
| защищённый статический массив touchKeys ( $cache, $keys ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface | |
| $keys | строка[] | |
| return | массив |
Метка времени, индексированная по ключам кеша |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-caching-tagdependency.html
