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

namespace yii\caching;
9

10
use yii\base\InvalidConfigException;
Qiang Xue committed
11 12 13 14 15 16 17 18 19 20 21 22

/**
 * GroupDependency marks a cached data item with a group name.
 *
 * You may invalidate the cached data items with the same group name all at once
 * by calling [[invalidate()]].
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class GroupDependency extends Dependency
{
23 24 25 26
    /**
     * @var string the group name. This property must be set.
     */
    public $group;
Qiang Xue committed
27

28 29 30
    /**
     * Generates the data needed to determine if dependency has been changed.
     * This method does nothing in this class.
31 32
     * @param Cache $cache the cache component that is currently evaluating this dependency
     * @return mixed the data needed to determine if dependency has been changed.
33 34 35 36 37 38 39 40 41 42 43
     * @throws InvalidConfigException if [[group]] is not set.
     */
    protected function generateDependencyData($cache)
    {
        if ($this->group === null) {
            throw new InvalidConfigException('GroupDependency::group must be set');
        }
        $version = $cache->get([__CLASS__, $this->group]);
        if ($version === false) {
            $version = $this->invalidate($cache, $this->group);
        }
Qiang Xue committed
44

45 46
        return $version;
    }
Qiang Xue committed
47

48 49
    /**
     * Performs the actual dependency checking.
50 51
     * @param Cache $cache the cache component that is currently evaluating this dependency
     * @return boolean whether the dependency is changed or not.
52 53 54 55 56 57 58 59 60 61 62 63 64 65
     * @throws InvalidConfigException if [[group]] is not set.
     */
    public function getHasChanged($cache)
    {
        if ($this->group === null) {
            throw new InvalidConfigException('GroupDependency::group must be set');
        }
        $version = $cache->get([__CLASS__, $this->group]);

        return $version === false || $version !== $this->data;
    }

    /**
     * Invalidates all of the cached data items that have the same [[group]].
66 67
     * @param Cache $cache the cache component that caches the data items
     * @param string $group the group name
68 69 70 71 72 73 74 75 76
     * @return string the current version number
     */
    public static function invalidate($cache, $group)
    {
        $version = microtime();
        $cache->set([__CLASS__, $group], $version);

        return $version;
    }
Qiang Xue committed
77
}