FileDependency.php 1.31 KB
Newer Older
Qiang Xue committed
1 2
<?php
/**
Qiang Xue committed
3
 * FileDependency class file.
Qiang Xue committed
4 5
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008 Yii Software LLC
Qiang Xue committed
7 8 9
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
10 11
namespace yii\caching;

Qiang Xue committed
12
/**
Qiang Xue committed
13
 * FileDependency represents a dependency based on a file's last modification time.
Qiang Xue committed
14
 *
Qiang Xue committed
15 16
 * If th last modification time of the file specified via [[fileName]] is changed,
 * the dependency is considered as changed.
Qiang Xue committed
17 18
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
19
 * @since 2.0
Qiang Xue committed
20
 */
Qiang Xue committed
21
class FileDependency extends Dependency
Qiang Xue committed
22 23 24 25 26 27 28 29 30 31
{
	/**
	 * @var string the name of the file whose last modification time is used to
	 * check if the dependency has been changed.
	 */
	public $fileName;

	/**
	 * Constructor.
	 * @param string $fileName name of the file whose change is to be checked.
Qiang Xue committed
32
	 * @param array $config name-value pairs that will be used to initialize the object properties
Qiang Xue committed
33
	 */
Qiang Xue committed
34
	public function __construct($fileName = null, $config = array())
Qiang Xue committed
35
	{
Qiang Xue committed
36
		$this->fileName = $fileName;
Qiang Xue committed
37
		parent::__construct($config);
Qiang Xue committed
38 39 40 41 42 43 44
	}

	/**
	 * Generates the data needed to determine if dependency has been changed.
	 * This method returns the file's last modification time.
	 * @return mixed the data needed to determine if dependency has been changed.
	 */
Qiang Xue committed
45
	protected function generateDependencyData()
Qiang Xue committed
46
	{
Qiang Xue committed
47
		return @filemtime($this->fileName);
Qiang Xue committed
48 49
	}
}