Cmp\Cache\Backend\ArrayCache

Complexity

Total Complexity

19

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92.5%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	9	3
A	has()	0	14	3
A	get()	0	8	2
A	demand()	0	13	3
A	delete()	0	8	2
A	flush()	0	6	1
A	hasExpired()	0	4	2
A	getTimeToLive()	0	14	3

<?php

namespace Cmp\Cache\Backend;

use Cmp\Cache\Cache;
use Cmp\Cache\Exceptions\CacheException;
use Cmp\Cache\Exceptions\ExpiredException;
use Cmp\Cache\Exceptions\NotFoundException;
use Cmp\Cache\FlushableCache;
use Cmp\Cache\PurgableCache;
use Cmp\Cache\Traits\MultiCacheTrait;

/**
 * Class ArrayCache
 * 
 * A simple backend powered by an array in memory
 *
 * @package Cmp\Cache\Infrastureture\Backend
 */
class ArrayCache implements Cache
{
    use MultiCacheTrait;

    /**
     * Stored items
     * 
     * @var array
     */
    private $items = [];

    /**
     * {@inheritdoc}
     */
    public function set($key, $value, $timeToLive = null)
    {
        $this->items[$key] = [
            'value'      => $value,
            'expireTime' => $timeToLive === null || $timeToLive === 0 ? null : time() + $timeToLive,
        ];

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function has($key)
    {
        if (!array_key_exists($key, $this->items)) {
            return false;
        }

        if ($this->hasExpired($key)) {
            $this->delete($key);

            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function get($key, $default = null)
    {
        try {
            return $this->demand($key);
        } catch (CacheException $exception) {
            return $default;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function demand($key)
    {
        if (!array_key_exists($key, $this->items)) {
            throw new NotFoundException($key);
        }

        if ($this->hasExpired($key)) {
            $this->delete($key);
            throw new ExpiredException($key);
        }

        return $this->items[$key]['value'];
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        if (array_key_exists($key, $this->items)) {
            unset($this->items[$key]);
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $this->items = [];

        return true;
    }

    /**
     * Checks whether an item as expired
     *
     * @param string $key
     *
     * @return bool
     */
    private function hasExpired($key)
    {
        return $this->items[$key]['expireTime'] !== null && $this->items[$key]['expireTime'] < time();
    }

    /**
     * Gets the remaining time to live for an item
     *
     * @param $key
     *
     * @return int|null
     */
    public function getTimeToLive($key)
    {
        if (!$this->has($key)) {
            return null;
        }

        if ($this->hasExpired($key)) {
            $this->delete($key);

            return null;
        }

        return $this->items[$key]['expireTime'] - time();
    }
}