ChainedDependency

API reference › yii › caching › ChainedDependency

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

ChainedDependency represents a dependency which is composed of a list of other dependencies.

When $dependOnAll is true, if any of the dependencies has changed, this dependency is considered changed; When $dependOnAll is false, if one of the dependencies has NOT changed, this dependency is considered NOT changed.

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

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. Default: `null`.	`Dependency`
`$dependencies`	`Dependency[]`	List of dependencies that this dependency is composed of. Default: `[]`.	`ChainedDependency`
`$dependOnAll`	`bool`	Whether this dependency is depending on every dependency in `$dependencies`. Default: `true`.	`ChainedDependency`
`$reusable`	`bool`	Whether this dependency is reusable or not. Default: `false`.	`Dependency`

Methods

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.	`ChainedDependency`
`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.	`ChainedDependency`
`resetReusableData()` static	Resets all cached data for reusable dependencies.	`Dependency`
`generateDependencyData()` protected	Generates the data needed to determine if dependency has been changed.	`ChainedDependency`
`generateReusableHash()` protected	Generates a unique hash that can be used for retrieving reusable dependency data.	`Dependency`

Property details

$dependencies

public yii\caching\Dependency[] $dependencies = []

List of dependencies that this dependency is composed of.

Each array element must be a dependency object.

$dependOnAll

public bool $dependOnAll = true

Whether this dependency is depending on every dependency in $dependencies.

Defaults to true, meaning if any of the dependencies has changed, this dependency is considered changed. When it is set false, it means if one of the dependencies has NOT changed, this dependency is considered NOT changed.

Method details

evaluateDependency()

public function evaluateDependency(yii\caching\CacheInterface $cache): mixed

Evaluates the dependency by generating and saving the data related with dependency.

Parameters

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

Returns

mixed

isChanged()

public function isChanged(mixed $cache): bool

Checks whether the dependency is changed.

Parameters

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

Returns

bool: Whether the dependency has changed.

Since

2.0.11

generateDependencyData()

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

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

This method does nothing in this class.

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.