Class yii\caching\TagDependency

All Classes | Properties | Methods

Inheritance	yii\caching\TagDependency » yii\caching\Dependency » yii\base\Object
Implements	yii\base\Configurable
Available since version	2.0
Source Code	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).

Public Properties

Property	Type	Description	Defined By
$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

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
evaluateDependency()	Evaluates the dependency by generating and saving the data related with dependency.	yii\caching\Dependency
getHasChanged()	Performs the actual dependency checking.	yii\caching\TagDependency
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
invalidate()	Invalidates all of the cached data items that are associated with any of the specified $tags.	yii\caching\TagDependency
resetReusableData()	Resets all cached data for reusable dependencies.	yii\caching\Dependency

Method	Description	Defined By
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 property

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

generateDependencyData() protected method

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

This method does nothing in this class.

mixed generateDependencyData( $cache )
$cache	yii\caching\Cache	The cache component that is currently evaluating this dependency
return	mixed	The data needed to determine if dependency has been changed.

getHasChanged() public method

Performs the actual dependency checking.

boolean getHasChanged( $cache )
$cache	yii\caching\Cache	The cache component that is currently evaluating this dependency
return	boolean	Whether the dependency is changed or not.

getTimestamps() protected method

Returns the timestamps for the specified tags.

array getTimestamps( $cache, $tags )
$cache	yii\caching\Cache
$tags	string[]
return	array	The timestamps indexed by the specified tags.

invalidate() public method

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

void invalidate( $cache, $tags )
$cache	yii\caching\Cache	The cache component that caches the data items
$tags	string\|array

touchKeys() protected method

Generates the timestamp for the specified cache keys.

array touchKeys( $cache, $keys )
$cache	yii\caching\Cache
$keys	string[]
return	array	The timestamp indexed by cache keys