Ds\Cache\Storage\AbstractStorage

Complexity

Total Complexity

5

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	withTtl()	0	5	1
A	getTtlTimestamp()	0	10	2
A	getTtl()	0	3	1
	set()	0	1	?
	has()	0	1	?
	get()	0	1	?
	delete()	0	1	?
	clear()	0	1	?

<?php
/**
 * Src/Cache/Storage/AbstractStorage.php
 *
 * @package     Ds\Cache\Storage
 * @subpackage  Cache
 * @author      Dan Smith <dan--smith@hotmail.co.uk>
 * @version     v.1 (20/03/2017)
 * @copyright   Copyright (c) 2017, Dan Smith
 */
namespace Ds\Cache\Storage;

use DateInterval;
use DateTime;
use Ds\Cache\CacheStorageInterface;

/**
 * Class MemcacheStorage
 *
 * @package Ds\Cache\Storage
 */
abstract class AbstractStorage implements CacheStorageInterface
{
    /**
     * @var DateInterval
     */
    private $ttl;

    /**
     * Abstract Storage constructor.
     * @param DateInterval $ttl
     */
    public function __construct(DateInterval $ttl)
    {
        $this->ttl = $ttl;
    }

    /**
     * With default ttl.
     *
     * @param DateInterval $ttl
     * @return CacheStorageInterface
     */
    public function withTtl(DateInterval $ttl){
        $new = clone $this;
        $new->ttl = $ttl;
        return $new;
    }

    /**
     * Get ttl as integer.
     *
     * @param null|int $ttl
     * @return int
     */
    public function getTtlTimestamp($ttl = null){

        if (null === $ttl){
            $dateTime = new DateTime();
            $dateTime->add( $this->ttl );
            $ttl = $dateTime->getTimestamp();
        }

        return (int)$ttl;
    }

    /**
     * Get ttl as integer.
     *
     * @return DateInterval
     */
    public function getTtl(){
        return $this->ttl;
    }

    /**
     * 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 $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.
     */
    abstract public function set($key, $value, $ttl = null);

    /**
     * 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
     */
    abstract public function has($key);

    /**
     * Fetches a value from the cache.
     *
     * @param string $key     The unique key of this item in the cache.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *
     */
    abstract public function get($key);

    /**
     * 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.
     */
    abstract public function delete($key);

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return bool True on success and false on failure.
     */
    abstract public function clear();

}