Yiisoft\Db\Cache\QueryCache

Complexity

Total Complexity

15

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Test Coverage

Coverage

87.88%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setEnable()	0	3	1
A	getDuration()	0	3	1
A	setInfo()	0	3	1
B	info()	0	23	7
A	isEnabled()	0	3	1
A	normalize()	0	3	1
A	removeLastInfo()	0	3	1
A	setDuration()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Cache;

use Yiisoft\Cache\CacheInterface;
use Yiisoft\Cache\CacheKeyNormalizer;
use Yiisoft\Cache\Dependency\Dependency;

use function array_pop;
use function end;
use function is_array;

/**
 * The cache application component that is used for query caching.
 */
final class QueryCache
{
    private CacheInterface $cache;
    private bool $enabled = true;
    public array $info = [];
    private int $duration = 3600;
    private CacheKeyNormalizer $keyNormalizer;

    public function __construct(CacheInterface $cache, CacheKeyNormalizer $keyNormalizer)
    {
        $this->cache = $cache;
        $this->keyNormalizer = $keyNormalizer;
    }

    /**
     * Normalizes cache key from a given key.
     *
     * If the given key is a string containing alphanumeric characters only and no more than 32 characters,
     * then the key will be returned back as it is, integers will be converted to strings. Otherwise,
     * a normalized key is generated by serializing the given key and applying MD5 hashing.
     *
     * @param mixed $key The key to be normalized.
     *
     * @return string The normalized cache key.
     */
    public function normalize($key): string
    {
        return $this->keyNormalizer->normalize($key);
    }

    /**
     * Return number of seconds that query results can remain valid in cache.
     *
     * @return int
     */
    public function getDuration(): ?int
    {
        return $this->duration;
    }

    /**
     * Return true if QueryCache is active.
     *
     * @return bool
     */
    public function isEnabled(): bool
    {
        return $this->enabled;
    }

    /**
     * Returns the current query cache information.
     *
     * This method is used internally by {@see Command}.
     *
     * @param int|null $duration the preferred caching duration. If null, it will be ignored.
     * @param Dependency|null $dependency the preferred caching dependency. If null, it will be ignored.
     *
     * @return array|null the current query cache information, or null if query cache is not enabled.
     */
    public function info(?int $duration, Dependency $dependency = null): ?array
    {
        $result = null;

        if ($this->enabled) {
            $info = end($this->info);

            if (is_array($info)) {
                if ($duration === null) {
                    $duration = $info[0];
                }

                if ($dependency === null) {
                    $dependency = $info[1];
                }
            }

            if ($duration === 0 || $duration > 0) {
                $result = [$this->cache, $duration, $dependency];
            }
        }

        return $result;
    }

    /**
     * Extract the last element from the end of the QueryCache information.
     */
    public function removeLastInfo(): void
    {
        array_pop($this->info);
    }

    /**
     * Whether to enable query caching. Note that in order to enable query caching, a valid cache component as specified
     * must be enabled and {@see enabled} must be set true. Also, only the results of the queries enclosed within
     * {@see cache()} will be cached.
     *
     * @param bool $value
     *
     * {@see cache()}
     * {@see noCache()}
     */
    public function setEnable(bool $value): void
    {
        $this->enabled = $value;
    }

    /**
     * Add an element to the array that QueryCache information.
     */
    public function setInfo($value): void
    {
        $this->info[] = $value;
    }

    /**
     * The default number of seconds that query results can remain valid in cache. Defaults to 3600, meaning 3600
     * seconds, or one hour. Use 0 to indicate that the cached data will never expire. The value of this property will
     * be used when {@see cache()} is called without a cache duration.
     *
     * @param int $value
     *
     * {@see cache()}
     */
    public function setDuration(int $value): void
    {
        $this->duration = $value;
    }
}