Koded\Caching\Client\MultiplesTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteMultiple()	0	7	2
A	internalMultiGet()	0	7	2
A	internalMultiSet()	0	8	3
A	internalMultiDelete()	0	8	3
A	getMultiple()	0	4	1
A	setMultiple()	0	9	3

<?php
/*
 * This file is part of the Koded package.
 *
 * (c) Mihail Binev <mihail@kodeart.com>
 *
 * Please view the LICENSE distributed with this source code
 * for the full copyright and license information.
 */

namespace Koded\Caching\Client;

use function array_keys;
use function Koded\Caching\filter_keys;
use function Koded\Caching\normalize_ttl;

/**
 * Trait MultiplesTrait implements all "multi" operations
 * separated for easy override in the specific cache classes.
 *
 */
trait MultiplesTrait
{
    public function getMultiple(iterable $keys, mixed $default = null): iterable
    {
        $filtered = filter_keys($keys, false);
        return $this->internalMultiGet($filtered, $default);
    }

    public function setMultiple(iterable $values, null|int|\DateInterval $ttl = null): bool
    {
        $filtered = filter_keys($values, true);
        $ttl = normalize_ttl($ttl ?? $this->ttl);
        if ($ttl !== null && $ttl < 1) {
            // All items are considered expired and must be deleted
            return $this->deleteMultiple(array_keys($filtered));
        }
        return $this->internalMultiSet($filtered, $ttl);
    }

    public function deleteMultiple(iterable $keys): bool
    {
        $filtered = filter_keys($keys, false);
        if (empty($filtered)) {
            return true;
        }
        return $this->internalMultiDelete($filtered);
    }

    /*
     *
     * Override in specific cache classes.
     *
     */

    private function internalMultiGet(array $keys, mixed $default): iterable
    {
        $cached = [];
        foreach ($keys as $key) {
            $cached[$key] = $this->get($key, $default);

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
        return $cached;
    }

    private function internalMultiSet(array $values, ?int $ttl): bool
    {
        $cached = $count = 0;
        foreach ($values as $key => $value) {
            $count++;
            $this->set($key, $value, $ttl) && ++$cached;

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
        return $count === $cached;
    }

    private function internalMultiDelete(array $keys): bool
    {
        $deleted = $count = 0;
        foreach ($keys as $key) {
            $count++;
            $this->delete($key) && ++$deleted;

The method delete() does not exist on Koded\Caching\Client\MultiplesTrait. Did you maybe mean deleteMultiple()?

        }
        return $count === $deleted;
    }
}