Chadicus\Marvel\Api\Cache\ArrayCache

Complexity

Total Complexity

17

Size/Duplication

Total Lines	195
Duplicated Lines	4.62 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	15	3
A	set()	0	12	1
A	delete()	0	6	1
A	clear()	0	5	1
A	getMultiple()	9	9	2
A	setMultiple()	0	8	2
A	deleteMultiple()	0	8	2
A	has()	0	5	1
A	getExpires()	0	16	4

<?php

namespace Chadicus\Marvel\Api\Cache;

use DominionEnterprises\Util\Arrays;
use Psr\SimpleCache\CacheInterface;

/**
 * A PSR-16 implementation which stores data in an array.
 */
final class ArrayCache extends AbstractCache implements CacheInterface
{
    /**
     * Array containing the cached data.
     *
     * @var array
     */
    private $cache = [];

    /**
     * Fetches a value from the cache.
     *
     * @param string $key     The unique key of this item in the cache.
     * @param mixed  $default Default value to return if the key does not exist.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function get($key, $default = null)
    {
        $this->verifyKey($key);
        $cache = Arrays::get($this->cache, $key);
        if ($cache === null) {
            return $default;
        }

        if ($cache['expires'] < time()) {
            unset($this->cache[$key]);
            return $default;
        }

        return $cache['response'];
    }

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     *
     * @param string                $key   The key of the item to store.
     * @param mixed                 $value The value of the item to store, must be serializable.
     * @param null|int|DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
     *                                     the driver supports TTL then the library may set a default value
     *                                     for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function set($key, $value, $ttl = null)
    {
        $this->verifyKey($key);
        $this->verifyValue($value);

        $this->cache[$key] = [
            'response' => $value,
            'expires' => $this->getExpires($ttl),
        ];

        return true;
    }

    /**
     * Delete an item from the cache by its unique key.
     *
     * @param string $key The unique cache key of the item to delete.
     *
     * @return bool True if the item was successfully removed. False if there was an error.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function delete($key)
    {
        $this->verifyKey($key);
        unset($this->cache[$key]);
        return true;
    }

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return bool True on success and false on failure.
     */
    public function clear()
    {
        $this->cache = [];
        return true;
    }

    /**
     * Obtains multiple cache items by their unique keys.
     *
     * @param iterable $keys    A list of keys that can obtained in a single operation.
     * @param mixed    $default Default value to return for keys that do not exist.
     *
     * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function getMultiple($keys, $default = null)

This method seems to be duplicated in your project.

    {
        $items = [];
        foreach ($keys as $key) {
            $items[$key] = $this->get($key, $default);
        }

        return $items;

The return type of return $items; (array) is incompatible with the return type declared by the interface Psr\SimpleCache\CacheInterface::getMultiple of type Psr\SimpleCache\iterable.

    }

    /**
     * Persists a set of key => value pairs in the cache, with an optional TTL.
     *
     * @param iterable              $values A list of key => value pairs for a multiple-set operation.
     * @param null|int|DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
     *                                      the driver supports TTL then the library may set a default value
     *                                      for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws InvalidArgumentException Thrown if $values is neither an array nor a Traversable,
     *                                  or if any of the $values are not a legal value.
     */
    public function setMultiple($values, $ttl = null)
    {
        foreach ($values as $key => $value) {
            $this->set($key, $value, $ttl);
        }

        return true;
    }

    /**
     * Deletes multiple cache items in a single operation.
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *
     * @return bool True if the items were successfully removed. False if there was an error.
     *
     * @throws InvalidArgumentException Thrown if $keys is neither an array nor a Traversable,
     *                                  or if any of the $keys are not a legal value.
     */
    public function deleteMultiple($keys)
    {
        foreach ($keys as $key) {
            $this->delete($key);
        }

        return true;
    }

    /**
     * Determines whether an item is present in the cache.
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it making the state of your app out of date.
     *
     * @param string $key The cache item key.
     *
     * @return bool
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function has($key)
    {
        $this->verifyKey($key);
        return isset($this->cache[$key]);
    }

    /**
     * Converts the given time to live value to a epoch timestamp.
     *
     * @param mixed $key The cache key to validate.

There is no parameter named $key. Was it maybe removed?

     *
     * @return void
     *
     * @throws InvalidArgumentException Thrown if the $ttl is not null, an integer or \DateInterval.
     */
    private function getExpires($ttl)
    {
        if ($ttl === null) {
            return time() + 86400;
        }

        if (is_int($ttl)) {
            return time() + $ttl;
        }

        if ($ttl instanceof \DateInterval) {
            return time() + $ttl->s;
        }

        throw new InvalidArgumentException('$ttl must be null, an integer or \DateInterval instance');
    }
}