Koded\Caching\CacheItem

Complexity

Total Complexity

9

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isHit()	0	3	1
A	getExpiresAt()	0	3	1
A	get()	0	3	1
A	set()	0	5	1
A	getKey()	0	3	1
A	expiresAt()	0	9	2
A	expiresAfter()	0	4	1
A	__construct()	0	4	1

<?php

namespace Koded\Caching;

use Psr\Cache\CacheItemInterface;


abstract class CacheItem implements CacheItemInterface
{
    /** @var bool */
    protected $isHit = false;

    /** @var string Expects a valid cache key name */
    private $key;

    /** @var mixed */
    private $value;
    
    /** @var int Number of seconds for the expiration time */
    private $expiresAt;


    public function __construct($key, ?int $ttl)
    {
        $this->key = $key;
        $this->expiresAt = $ttl;
    }


    public function getKey(): string
    {
        return $this->key;
    }


    public function get()
    {
        return $this->value;
    }


    public function isHit(): bool
    {
        return $this->isHit;
    }


    public function set($value)
    {
        $this->value = $value;

        return $this;
    }


    public function expiresAfter($time)
    {
        // The TTL is calculated in the cache client instance
        return $this->expiresAt($time);
    }


    public function expiresAt($expiration)
    {
        $this->expiresAt = normalize_ttl($expiration ?? $this->expiresAt);

        if ($this->expiresAt < 1) {
            $this->isHit = false;
        }

        return $this;
    }

    /**
     * Returns expiration seconds for the cache item.
     * NULL is reserved for clients who do not support expiry
     * to implement some custom logic around the TTL.
     *
     * This method is not part of the PSR-6.
     *
     * @return int|null
     */
    public function getExpiresAt(): ?int
    {
        return $this->expiresAt;
    }
}