Class yii\caching\TagDependency

继承yii\caching\TagDependency » yii\caching\Dependency » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/caching/TagDependency.php

TagDependency associates a cached data item with one or multiple $tags.

By calling invalidate(), you can invalidate all cached data items that are associated with the specified tag name(s).

// 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');

For more details and usage information on Cache, see the guide article on caching.

公共属性

隐藏继承的属性

属性类型描述定义在
$data mixed The dependency data that is saved in cache and later is compared with the latest dependency data. yii\caching\Dependency
$reusable boolean Whether this dependency is reusable or not. yii\caching\Dependency
$tags string|array A list of tag names for this dependency. yii\caching\TagDependency

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
evaluateDependency() Evaluates the dependency by generating and saving the data related with dependency. yii\caching\Dependency
getHasChanged() Returns a value indicating whether the dependency has changed. yii\caching\Dependency
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
invalidate() Invalidates all of the cached data items that are associated with any of the specified $tags. yii\caching\TagDependency
isChanged() Checks whether the dependency is changed. yii\caching\TagDependency
resetReusableData() Resets all cached data for reusable dependencies. yii\caching\Dependency

受保护的方法

隐藏继承的方法

方法描述定义在
generateDependencyData() Generates the data needed to determine if dependency has been changed. yii\caching\TagDependency
generateReusableHash() Generates a unique hash that can be used for retrieving reusable dependency data. yii\caching\Dependency
getTimestamps() Returns the timestamps for the specified tags. yii\caching\TagDependency
touchKeys() Generates the timestamp for the specified cache keys. yii\caching\TagDependency

属性详情

$tags public 属性

A list of tag names for this dependency. For a single tag, you may specify it as a string.

public string|array $tags = []

方法详情

generateDependencyData() protected 方法

Generates the data needed to determine if dependency has been changed.

This method does nothing in this class.

protected mixed generateDependencyData ( $cache )
$cache yii\caching\CacheInterface

The cache component that is currently evaluating this dependency

return mixed

The data needed to determine if dependency has been changed.

getTimestamps() protected 方法

Returns the timestamps for the specified tags.

protected array getTimestamps ( $cache, $tags )
$cache yii\caching\CacheInterface
$tags string[]
return array

The timestamps indexed by the specified tags.

invalidate() public static 方法

Invalidates all of the cached data items that are associated with any of the specified $tags.

public static void invalidate ( $cache, $tags )
$cache yii\caching\CacheInterface

The cache component that caches the data items

$tags string|array
isChanged() public 方法

Checks whether the dependency is changed.

public boolean isChanged ( $cache )
$cache yii\caching\CacheInterface

The cache component that is currently evaluating this dependency

return boolean

Whether the dependency has changed.

touchKeys() protected static 方法

Generates the timestamp for the specified cache keys.

protected static array touchKeys ( $cache, $keys )
$cache yii\caching\CacheInterface
$keys string[]
return array

The timestamp indexed by cache keys