ChainedDependency.php 3.05 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8 9
namespace yii\caching;

Qiang Xue committed
10
/**
Qiang Xue committed
11
 * ChainedDependency represents a dependency which is composed of a list of other dependencies.
Qiang Xue committed
12
 *
Qiang Xue committed
13 14 15
 * 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.
Qiang Xue committed
16 17 18 19
 *
 * @property boolean $hasChanged Whether the dependency is changed or not.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
20
 * @since 2.0
Qiang Xue committed
21
 */
Qiang Xue committed
22
class ChainedDependency extends Dependency
Qiang Xue committed
23 24
{
	/**
Qiang Xue committed
25 26 27
	 * @var array list of dependencies that this dependency is composed of.
	 * Each array element should be a dependency object or a configuration array
	 * that can be used to create a dependency object via [[\Yii::createObject()]].
Qiang Xue committed
28
	 */
Qiang Xue committed
29 30 31 32 33 34 35 36
	public $dependencies = array();
	/**
	 * @var boolean 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.
	 */
	public $dependOnAll = true;
Qiang Xue committed
37 38

	/**
Qiang Xue committed
39 40 41 42
	 * Constructor.
	 * @param array $dependencies list of dependencies that this dependency is composed of.
	 * Each array element should be a dependency object or a configuration array
	 * that can be used to create a dependency object via [[\Yii::createObject()]].
Qiang Xue committed
43
	 * @param array $config name-value pairs that will be used to initialize the object properties
Qiang Xue committed
44
	 */
Qiang Xue committed
45
	public function __construct($dependencies = array(), $config = array())
Qiang Xue committed
46
	{
Qiang Xue committed
47
		$this->dependencies = $dependencies;
Qiang Xue committed
48
		parent::__construct($config);
Qiang Xue committed
49 50 51
	}

	/**
Qiang Xue committed
52
	 * Evaluates the dependency by generating and saving the data related with dependency.
Qiang Xue committed
53
	 */
Qiang Xue committed
54
	public function evaluateDependency()
Qiang Xue committed
55
	{
Qiang Xue committed
56 57 58 59 60
		foreach ($this->dependencies as $dependency) {
			if (!$dependency instanceof Dependency) {
				$dependency = \Yii::createObject($dependency);
			}
			$dependency->evalulateDependency();
Qiang Xue committed
61 62 63 64
		}
	}

	/**
Qiang Xue committed
65 66 67
	 * Generates the data needed to determine if dependency has been changed.
	 * This method does nothing in this class.
	 * @return mixed the data needed to determine if dependency has been changed.
Qiang Xue committed
68
	 */
Qiang Xue committed
69
	protected function generateDependencyData()
Qiang Xue committed
70
	{
Qiang Xue committed
71
		return null;
Qiang Xue committed
72 73 74 75 76 77 78 79 80 81
	}

	/**
	 * Performs the actual dependency checking.
	 * This method returns true if any of the dependency objects
	 * reports a dependency change.
	 * @return boolean whether the dependency is changed or not.
	 */
	public function getHasChanged()
	{
82
		foreach ($this->dependencies as $i => $dependency) {
Qiang Xue committed
83
			if (!$dependency instanceof Dependency) {
84
				$this->dependencies[$i] = $dependency = \Yii::createObject($dependency);
Qiang Xue committed
85 86 87 88 89 90
			}
			if ($this->dependOnAll && $dependency->getHasChanged()) {
				return true;
			} elseif (!$this->dependOnAll && !$dependency->getHasChanged()) {
				return false;
			}
Qiang Xue committed
91
		}
Qiang Xue committed
92
		return !$this->dependOnAll;
Qiang Xue committed
93 94
	}
}