PHPDaemon\Cache\CappedStorage

Complexity

Total Complexity

18

Size/Duplication

Total Lines	141
Duplicated Lines	19.86 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setMaxCacheSize()	0	4	1
A	setCapWindow()	0	4	1
B	put()	0	25	6
A	hash()	0	4	1
A	invalidate()	0	5	1
A	get()	14	15	4
A	getValue()	14	15	4

<?php
namespace PHPDaemon\Cache;

/**
 * CappedStorage
 * @package PHPDaemon\Cache
 * @author  Vasily Zorin <maintainer@daemon.io>
 */
abstract class CappedStorage
{
    use \PHPDaemon\Traits\ClassWatchdog;
    use \PHPDaemon\Traits\StaticObjectWatchdog;

    /**
     * @var callable Sorter function
     */
    public $sorter;

    /**
     * @var integer Maximum number of cached elements
     */
    public $maxCacheSize = 64;

    /**
     * @var integer Additional window to decrease number of sorter calls
     */
    public $capWindow = 16;

    /**
     * @var array Storage of cached items
     */
    public $cache = [];

    /**
     * Sets cache size
     * @param  integer $size Maximum number of elements
     * @return void
     */
    public function setMaxCacheSize($size)
    {
        $this->maxCacheSize = $size;
    }

    /**
     * Sets cap window
     * @param  integer $w Additional window to decrease number of sorter calls
     * @return void
     */
    public function setCapWindow($w)
    {
        $this->capWindow = $w;
    }

    /**
     * Puts element in cache
     * @param  string $key Key
     * @param  mixed $value Value
     * @param  integer $ttl Time to live

Should the type for parameter $ttl not be integer|null?

     * @return mixed
     */
    public function put($key, $value, $ttl = null)
    {
        $k = $this->hash($key);
        if (isset($this->cache[$k])) {
            $item = $this->cache[$k];
            $item->setValue($value);
            if ($ttl !== null) {
                $item->expire = microtime(true) + $ttl;
            }
            return $item;
        }
        $item = new Item($value);
        if ($ttl !== null) {
            $item->expire = microtime(true) + $ttl;

The property $expire was declared of type integer, but microtime(true) + $ttl is of type double. Maybe add a type cast?

        }
        $this->cache[$k] = $item;
        $s = sizeof($this->cache);
        if ($s > $this->maxCacheSize + $this->capWindow) {
            uasort($this->cache, $this->sorter);
            for (; $s > $this->maxCacheSize; --$s) {
                array_pop($this->cache);
            }
        }
        return $item;
    }

    /**
     * Hash function
     * @param  string $key Key
     * @return integer

Should the return type not be string?

     */
    public function hash($key)
    {
        return $key;
    }

    /**
     * Invalidates cache element
     * @param  string $key Key
     * @return void
     */
    public function invalidate($key)
    {
        $k = $this->hash($key);
        unset($this->cache[$k]);
    }

    /**
     * Gets element by key
     * @param  string $key Key
     * @return object Item
     */
    public function get($key)

This method seems to be duplicated in your project.

    {
        $k = $this->hash($key);
        if (!isset($this->cache[$k])) {
            return null;
        }
        $item = $this->cache[$k];
        if (isset($item->expire)) {
            if (microtime(true) >= $item->expire) {
                unset($this->cache[$k]);
                return null;
            }
        }
        return $item;
    }

    /**
     * Gets value of element by key
     * @param  string $key Key
     * @return mixed
     */
    public function getValue($key)

This method seems to be duplicated in your project.

    {
        $k = $this->hash($key);
        if (!isset($this->cache[$k])) {
            return null;
        }
        $item = $this->cache[$k];
        if (isset($item->expire)) {
            if (microtime(true) >= $item->expire) {
                unset($this->cache[$k]);
                return null;
            }
        }
        return $item->getValue();
    }
}