FileDependency.php 1.25 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
namespace yii\caching;
9
use yii\base\InvalidConfigException;
Qiang Xue committed
10

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

	/**
	 * Generates the data needed to determine if dependency has been changed.
	 * This method returns the file's last modification time.
31
	 * @param Cache $cache the cache component that is currently evaluating this dependency
Qiang Xue committed
32
	 * @return mixed the data needed to determine if dependency has been changed.
33
	 * @throws InvalidConfigException if [[fileName]] is not set
Qiang Xue committed
34
	 */
35
	protected function generateDependencyData($cache)
Qiang Xue committed
36
	{
37 38 39
		if ($this->fileName === null) {
			throw new InvalidConfigException('FileDependency::fileName must be set');
		}
Qiang Xue committed
40
		return @filemtime($this->fileName);
Qiang Xue committed
41 42
	}
}