Dependency.php 1.38 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
 * Dependency is the base class for cache dependency classes.
Qiang Xue committed
12
 *
Qiang Xue committed
13 14
 * Child classes should override its [[generateDependencyData()]] for generating
 * the actual dependency data.
Qiang Xue committed
15 16 17 18
 *
 * @property boolean $hasChanged Whether the dependency has changed.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
19
 * @since 2.0
Qiang Xue committed
20
 */
Qiang Xue committed
21
abstract class Dependency extends \yii\base\Object
Qiang Xue committed
22 23
{
	/**
Qiang Xue committed
24 25
	 * @var mixed the dependency data that is saved in cache and later is compared with the
	 * latest dependency data.
Qiang Xue committed
26
	 */
Qiang Xue committed
27
	public $data;
Qiang Xue committed
28 29 30 31 32 33 34

	/**
	 * Evaluates the dependency by generating and saving the data related with dependency.
	 * This method is invoked by cache before writing data into it.
	 */
	public function evaluateDependency()
	{
Qiang Xue committed
35
		$this->data = $this->generateDependencyData();
Qiang Xue committed
36 37 38 39 40 41 42
	}

	/**
	 * @return boolean whether the dependency has changed.
	 */
	public function getHasChanged()
	{
Qiang Xue committed
43
		return $this->generateDependencyData() !== $this->data;
Qiang Xue committed
44 45 46 47
	}

	/**
	 * Generates the data needed to determine if dependency has been changed.
Qiang Xue committed
48
	 * Derived classes should override this method to generate the actual dependency data.
Qiang Xue committed
49 50
	 * @return mixed the data needed to determine if dependency has been changed.
	 */
Qiang Xue committed
51
	abstract protected function generateDependencyData();
Qiang Xue committed
52
}