Egils\Component\Cache\CacheItem

Complexity

Total Complexity

12

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getKey()	0	4	1
A	get()	0	4	1
A	set()	0	6	1
A	isHit()	0	4	1
A	exists()	0	4	1
A	setExpiration()	0	12	3
A	getExpiration()	0	4	1
A	setHit()	0	10	2

<?php
/*
 * This file is part of the Egils\Component\Cache package.
 *
 * (c) Egidijus Lukauskas <egils.ps@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Egils\Component\Cache;

use Psr\Cache\CacheItemInterface;
use DateTime;

class CacheItem implements CacheItemInterface
{
    /** @var mixed */
    private $value;

    /** @var string */
    private $key;

    /** @var DateTime */
    private $expiration;

    /** @var boolean */
    private $hit;

    /**
     * @param string $key
     * @param DateTime|integer|null $ttl
     * @param boolean $hit
     * @throws InvalidArgumentException
     */
    public function __construct($key, $ttl = null, $hit = false)
    {
        $this->key = $key;
        $this->setExpiration($ttl);
        $this->setHit($hit);
    }

    /**
     * @inheritdoc
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * @inheritdoc
     */
    public function get()
    {
        return $this->value;
    }

    /**
     * @inheritdoc
     */
    public function set($value)
    {
        $this->value = $value;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function isHit()
    {
        return $this->hit;
    }

    /**
     * @inheritdoc
     */
    public function exists()
    {
        return $this->isHit();
    }

    /**
     * @inheritdoc
     */
    public function setExpiration($ttl = null)
    {
        if (true === is_numeric($ttl)) {
            $this->expiration = new DateTime('now +' . $ttl . ' seconds');
        } elseif ($ttl instanceof DateTime) {
            $this->expiration = $ttl;
        } else {
            $this->expiration = new DateTime('now +10 years');
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getExpiration()
    {
        return $this->expiration;
    }

    /**
     * @param boolean $hit
     *
     * @return CacheItem
     * @throws InvalidArgumentException not a boolean value given
     */
    public function setHit($hit)
    {
        if (false === is_bool($hit)) {
            throw InvalidArgumentException::typeMismatch($hit, 'Boolean');
        }

        $this->hit = $hit;

        return $this;
    }
}