Koded\Caching\CacheItemPool

Complexity

Total Complexity

18

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	3

18 Methods

Rating	Name	Duplication	Size	Complexity
A	hp$0 ➔ deleteItems()	0	6	2
	clear()	0	6	?
	getItem()	0	20	?
A	hp$0 ➔ saveDeferred()	0	13	3
	deleteItem()	0	9	?
	hasItem()	0	6	?
A	getItems()	0	7	2
A	commit()	0	8	3
A	hp$0 ➔ clear()	0	6	2
A	__destruct()	0	3	1
	saveDeferred()	0	13	?
A	hp$0 ➔ getItem()	0	20	4
A	hp$0 ➔ hasItem()	0	6	3
A	save()	0	4	1
	client()	0	3	?
	deleteItems()	0	6	?
A	hp$0 ➔ client()	0	3	1
A	hp$0 ➔ deleteItem()	0	9	3

<?php

namespace Koded\Caching;

use Exception;
use Psr\Cache\{CacheItemInterface, CacheItemPoolInterface};
use function Koded\Stdlib\now;

abstract class CacheItemPool implements CacheItemPoolInterface
{
    protected Cache $client;

    /** @var CacheItemInterface[] */
    private array $deferred = [];

    abstract public function __construct(string $client, array $parameters);

    // @codeCoverageIgnoreStart
    public function __destruct()
    {
        $this->commit();
    }
    // @codeCoverageIgnoreEnd

    public function commit(): bool
    {
        foreach ($this->deferred as $key => $item) {
            if (true === $this->save($item)) {
                unset($this->deferred[$key]);
            }
        }
        return empty($this->deferred);
    }

    public function save(CacheItemInterface $item): bool
    {
        /** @var CacheItem $item */
        return $this->client->set($item->getKey(), $item->get(), $item->getExpiresAt());

The method getExpiresAt() does not exist on Psr\Cache\CacheItemInterface. Did you maybe mean expiresAt()?

    }

    public function getItems(array $keys = []): array
    {
        $items = [];
        foreach ($keys as $key) {
            $items[$key] = $this->getItem($key);
        }
        return $items;
    }

    public function getItem($key): CacheItemInterface
    {
        try {
            $item = new class($key, $this->client->getTtl()) extends CacheItem {};
            if (false === $this->client->has($key)) {
                if (isset($this->deferred[$key])) {
                    return clone $this->deferred[$key];
                }
                return $item;
            }

            (function() {
                $this->isHit = true;

The property isHit does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                return $this;
            })->call($item);

            return $item->set($this->client->get($key));

        } catch (Exception $e) {
            throw CachePoolException::from($e);
        }
    }

    public function hasItem($key): bool
    {
        try {
            return isset($this->deferred[$key]) || $this->client->has($key);
        } catch (Exception $e) {
            throw CachePoolException::from($e);
        }
    }

    public function clear(): bool
    {
        if ($cleared = $this->client->clear()) {
            $this->deferred = [];
        }
        return $cleared;
    }

    public function deleteItems(array $keys): bool
    {
        try {
            return $this->client->deleteMultiple($keys);
        } catch (Exception $e) {
            throw CachePoolException::from($e);
        }
    }

    public function deleteItem($key): bool
    {
        try {
            if ($deleted = $this->client->delete($key)) {
                unset($this->deferred[$key]);
            }
            return $deleted;
        } catch (Exception $e) {
            throw CachePoolException::from($e);
        }
    }

    public function saveDeferred(CacheItemInterface $item): bool
    {
        /** @var CacheItem $item */
        if (null !== $item->getExpiresAt() && $item->getExpiresAt() <= now()->getTimestamp()) {
            return false;
        }

        $this->deferred[$item->getKey()] = (function() {
            $this->isHit = true;

The property isHit does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            return $this;
        })->call($item);

        return true;
    }

    /**
     * Returns the instance of the underlying cache client.
     *
     * This method is not part of the PSR-6.
     *
     * @return Cache
     */
    public function client(): Cache
    {
        return $this->client;
    }
}