Yiisoft\Cache\Dependency\ChainedDependency

Complexity

Total Complexity

10

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isChanged()	0	13	6
A	evaluateDependency()	0	4	2
A	generateDependencyData()	0	3	1

<?php
namespace Yiisoft\Cache\Dependency;

use Yiisoft\Cache\CacheInterface;

/**
 * ChainedDependency represents a dependency which is composed of a list of other dependencies.
 *
 * When {@see dependOnAll} is true, if any of the dependencies has changed, this dependency is
 * considered changed; When {@see dependOnAll} is false, if one of the dependencies has NOT changed,
 * this dependency is considered NOT changed.
 *
 * For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
 */
final class ChainedDependency extends Dependency
{
    /**
     * @var Dependency[]
     */
    private $dependencies;

    /**
     * @var bool
     */
    private $dependOnAll;

    /**
     * ChainedDependency constructor.
     * @param Dependency[] $dependencies list of dependencies that this dependency is composed of.
     * Each array element must be a dependency object.
     * @param bool $dependOnAll whether this dependency is depending on every dependency in {@see 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 function __construct(array $dependencies = [], bool $dependOnAll = true)
    {
        $this->dependencies = $dependencies;
        $this->dependOnAll = $dependOnAll;
    }

    /**
     * Evaluates the dependency by generating and saving the data related with dependency.
     * @param CacheInterface $cache the cache component that is currently evaluating this dependency
     */
    public function evaluateDependency(CacheInterface $cache): void
    {
        foreach ($this->dependencies as $dependency) {
            $dependency->evaluateDependency($cache);
        }
    }

    /**
     * Generates the data needed to determine if dependency has been changed.
     * This method does nothing in this class.
     * @param CacheInterface $cache the cache component that is currently evaluating this dependency
     * @return mixed the data needed to determine if dependency has been changed.
     */
    protected function generateDependencyData(CacheInterface $cache)
    {
        return null;
    }

    public function isChanged(CacheInterface $cache): bool
    {
        foreach ($this->dependencies as $dependency) {
            if ($this->dependOnAll && $dependency->isChanged($cache)) {
                return true;
            }

            if (!$this->dependOnAll && !$dependency->isChanged($cache)) {
                return false;
            }
        }

        return !$this->dependOnAll;
    }
}