yiisoft / cache

src/NullCache.php

<?php

declare(strict_types=1);

namespace Yiisoft\Cache;

use DateInterval;
use Traversable;
use Yiisoft\Cache\Exception\InvalidArgumentException;

use function array_fill_keys;
use function array_keys;
use function array_map;
use function is_string;
use function iterator_to_array;
use function strpbrk;

/**
 * NullCache does not cache anything reporting success for all methods calls.
 *
 * By replacing it with some other cache component, one can quickly switch from non-caching mode to caching mode.
 *
 * See {@see \Psr\SimpleCache\CacheInterface} for common cache operations that NullCache supports.
 */
final class NullCache implements \Psr\SimpleCache\CacheInterface
{
    public function get(string $key, mixed $default = null): mixed
    {
        $this->validateKey($key);
        return $default;
    }

    public function set(string $key, mixed $value, null|int|DateInterval $ttl = null): bool
    {
        $this->validateKey($key);
        return true;
    }

    public function delete($key): bool
    {
        $this->validateKey($key);
        return true;
    }

    public function clear(): bool
    {
        return true;
    }

    public function getMultiple(iterable $keys, mixed $default = null): iterable
    {
        $keys = $this->iterableToArray($keys);
        /** @psalm-suppress RedundantCondition */
        $this->validateKeys($keys);
        return array_fill_keys($keys, $default);
    }

    public function setMultiple(iterable $values, null|int|DateInterval $ttl = null): bool
    {
        $values = $this->iterableToArray($values);
        $this->validateKeysOfValues($values);
        return true;
    }

    public function deleteMultiple(iterable $keys): bool
    {
        $keys = $this->iterableToArray($keys);
        /** @psalm-suppress RedundantCondition */
        $this->validateKeys($keys);
        return true;
    }

    public function has(string $key): bool
    {
        $this->validateKey($key);
        return false;
    }

    /**
     * Converts iterable to array.
     *
     * @psalm-template T
     * @psalm-param iterable<T> $iterable
     * @psalm-return array<array-key,T>
     */
    private function iterableToArray(iterable $iterable): array
    {
        return $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable;

The expression return $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable could return the type iterable which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    private function validateKey(mixed $key): void
    {
        if (!is_string($key) || $key === '' || strpbrk($key, '{}()/\@:')) {
            throw new InvalidArgumentException('Invalid key value.');
        }
    }

    /**
     * @psalm-assert string[] $keys
     */
    private function validateKeys(array $keys): void
    {
        foreach ($keys as $key) {
            $this->validateKey($key);
        }
    }

    private function validateKeysOfValues(array $values): void
    {
        $keys = array_map('\strval', array_keys($values));
        $this->validateKeys($keys);
    }
}