CallbackDependency

API reference › yii › caching › CallbackDependency

class	`yii\caching\CallbackDependency`
Extends	`Dependency` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0.50
Source	`framework/caching/CallbackDependency.php`

CallbackDependency represents a dependency based on the result of a callback function.

Callback function should return a value that serves as the dependency data.

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

Properties

Property	Type	Description	Defined by
`$callback`	`callable`	The PHP callback that will be called to determine if the dependency has been changed. Default: `null`.	`CallbackDependency`
`$data`	`mixed`	The dependency data that is saved in cache and later is compared with the latest dependency data. Default: `null`.	`Dependency`
`$reusable`	`bool`	Whether this dependency is reusable or not. Default: `false`.	`Dependency`

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`evaluateDependency()`	Evaluates the dependency by generating and saving the data related with dependency.	`Dependency`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`isChanged()`	Checks whether the dependency is changed.	`Dependency`
`resetReusableData()` static	Resets all cached data for reusable dependencies.	`Dependency`
`generateDependencyData()` protected	Generates the data needed to determine if dependency has been changed.	`CallbackDependency`
`generateReusableHash()` protected	Generates a unique hash that can be used for retrieving reusable dependency data.	`Dependency`

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

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

This method returns the result of the callback function.

Parameters

Parameter	Type	Description
`$cache`	`CacheInterface`	The cache component that is currently evaluating this dependency

Returns

mixed: The data needed to determine if dependency has been changed.