banker/src/Item.php

218 lines
4.9 KiB
PHP
Raw Normal View History

2016-10-19 09:57:06 -04:00
<?php declare(strict_types=1);
2016-08-31 12:18:46 -04:00
/**
2016-09-05 16:43:37 -04:00
* Banker
2016-08-31 12:18:46 -04:00
*
* A Caching library implementing psr/cache (PSR 6) and psr/simple-cache (PSR 16)
2016-08-31 12:18:46 -04:00
*
2021-11-30 11:56:15 -05:00
* PHP version 8+
2016-08-31 12:18:46 -04:00
*
2016-09-05 16:43:37 -04:00
* @package Banker
2016-08-31 12:18:46 -04:00
* @author Timothy J. Warren <tim@timshomepage.net>
2021-02-05 17:05:56 -05:00
* @copyright 2016 - 2021 Timothy J. Warren
2016-08-31 12:18:46 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2021-11-30 11:56:15 -05:00
* @version 5.0.0
2016-09-05 16:43:37 -04:00
* @link https://git.timshomepage.net/timw4mail/banker
2016-08-31 12:18:46 -04:00
*/
2016-09-05 16:43:37 -04:00
namespace Aviat\Banker;
2016-08-31 12:18:46 -04:00
2020-05-07 17:17:03 -04:00
use DateInterval;
use DateTimeInterface;
2016-08-31 12:18:46 -04:00
use Psr\Cache\CacheItemInterface;
2016-09-05 16:43:37 -04:00
use Aviat\Banker\Driver\DriverInterface;
2016-08-31 12:18:46 -04:00
/**
* Base class for Cache items
*/
2016-09-05 16:43:37 -04:00
class Item implements CacheItemInterface {
/**
* The driver for the current cache backend
*
* @var DriverInterface
*/
2020-05-07 17:17:03 -04:00
protected DriverInterface $driver;
2016-09-05 16:43:37 -04:00
/**
* The key of the cache item
*
* @var string
*/
2020-05-07 17:17:03 -04:00
protected string $key;
2016-09-05 16:43:37 -04:00
/**
* The expiration time
*
* @var int | null
*/
2020-05-07 17:17:03 -04:00
protected ?int $expiresAt;
2016-09-05 16:43:37 -04:00
/**
* The time to live
*
* @var int | null
*/
2020-05-07 17:17:03 -04:00
protected ?int $ttl;
2016-09-05 16:43:37 -04:00
/**
* The value to save in the cache
*
* @var mixed
*/
protected $value;
/**
* Create a Cache Item object
*
* @param DriverInterface $driver
* @param string $key
*/
2020-05-07 17:17:03 -04:00
public function __construct(DriverInterface $driver, string $key)
2016-09-05 16:43:37 -04:00
{
$this->driver = $driver;
$this->key = $key;
2020-05-07 17:17:03 -04:00
$this->expiresAt = NULL;
$this->ttl = NULL;
2016-09-05 16:43:37 -04:00
}
2016-08-31 12:18:46 -04:00
/**
* Returns the key for the current cache item.
*
* The key is loaded by the Implementing Library, but should be available to
* the higher level callers when needed.
*
* @return string
* The key string for this cache item.
*/
2016-10-19 09:57:06 -04:00
public function getKey(): string
2016-08-31 12:18:46 -04:00
{
2016-09-05 16:43:37 -04:00
return $this->key;
2016-08-31 12:18:46 -04:00
}
/**
* Retrieves the value of the item from the cache associated with this object's key.
*
* The value returned must be identical to the value originally stored by set().
*
* If isHit() returns false, this method MUST return null. Note that null
* is a legitimate cached value, so the isHit() method SHOULD be used to
* differentiate between "null value was found" and "no value was found."
*
* @return mixed
* The value corresponding to this cache item's key, or null if not found.
*/
public function get(): mixed
2016-08-31 12:18:46 -04:00
{
2016-09-06 17:03:43 -04:00
if ($this->isHit())
{
return $this->value ?? $this->driver->get($this->key);
2016-09-06 17:03:43 -04:00
}
2016-09-06 20:26:28 -04:00
2016-09-06 17:03:43 -04:00
return NULL;
2016-08-31 12:18:46 -04:00
}
/**
* Confirms if the cache item lookup resulted in a cache hit.
*
* Note: This method MUST NOT have a race condition between calling isHit()
* and calling get().
*
* @return bool
* True if the request resulted in a cache hit. False otherwise.
*/
2016-10-19 09:57:06 -04:00
public function isHit(): bool
2016-08-31 12:18:46 -04:00
{
return isset($this->value) || $this->driver->exists($this->key);
2016-08-31 12:18:46 -04:00
}
/**
* Sets the value represented by this cache item.
*
* The $value argument may be any item that can be serialized by PHP,
* although the method of serialization is left up to the Implementing
* Library.
*
* @param mixed $value
* The serializable value to be stored.
*
* @return static
2016-08-31 12:18:46 -04:00
* The invoked object.
*/
public function set(mixed $value): static
2016-08-31 12:18:46 -04:00
{
2016-09-05 16:43:37 -04:00
$this->value = $value;
return $this;
2016-08-31 12:18:46 -04:00
}
/**
* Sets the expiration time for this cache item.
*
2020-05-07 17:17:03 -04:00
* @param DateTimeInterface|null $expiration
2016-08-31 12:18:46 -04:00
* The point in time after which the item MUST be considered expired.
* If null is passed explicitly, a default value MAY be used. If none is set,
* the value should be stored permanently or for as long as the
* implementation allows.
*
* @return static
2016-08-31 12:18:46 -04:00
* The called object.
*/
public function expiresAt($expiration = NULL): static
2016-08-31 12:18:46 -04:00
{
2020-05-07 17:17:03 -04:00
if ($expiration instanceof DateTimeInterface)
2016-09-06 17:03:43 -04:00
{
2016-09-06 20:26:28 -04:00
$expiration = $expiration->getTimestamp();
2016-09-06 17:03:43 -04:00
}
2016-09-06 20:26:28 -04:00
$this->expiresAt = (int) $expiration;
2016-09-05 16:43:37 -04:00
return $this;
2016-08-31 12:18:46 -04:00
}
/**
* Sets the expiration time for this cache item.
*
2020-05-07 17:17:03 -04:00
* @param int|DateInterval|null $time
2016-08-31 12:18:46 -04:00
* The period of time from the present after which the item MUST be considered
* expired. An integer parameter is understood to be the time in seconds until
* expiration. If null is passed explicitly, a default value MAY be used.
* If none is set, the value should be stored permanently or for as long as the
* implementation allows.
*
* @return static
2016-08-31 12:18:46 -04:00
* The called object.
*/
public function expiresAfter($time = NULL): static
2016-08-31 12:18:46 -04:00
{
2020-05-07 17:17:03 -04:00
if ($time instanceof DateInterval)
2016-09-06 17:03:43 -04:00
{
$time = $time->format("%s");
}
2016-09-06 20:26:28 -04:00
2016-09-06 17:03:43 -04:00
$this->ttl = (int) $time;
2016-09-05 16:43:37 -04:00
return $this;
2016-08-31 12:18:46 -04:00
}
2016-09-06 20:26:28 -04:00
2016-09-06 17:03:43 -04:00
/**
2016-09-06 20:26:28 -04:00
* Save the current value to the cache
2016-09-06 17:03:43 -04:00
*
* @return bool
*/
2016-10-19 09:57:06 -04:00
public function save(): bool
2016-09-06 17:03:43 -04:00
{
if ($this->expiresAt !== NULL && $this->expiresAt !== 0)
{
$setResult = $this->driver->set($this->key, $this->value);
$expResult = $this->driver->expiresAt($this->key, $this->expiresAt);
2016-09-06 20:26:28 -04:00
2016-09-06 17:03:43 -04:00
return $setResult && $expResult;
}
if ($this->ttl !== NULL && $this->ttl !== 0)
2016-09-06 17:03:43 -04:00
{
2016-09-06 20:26:28 -04:00
return (bool) $this->driver->set($this->key, $this->value, $this->ttl);
2016-09-06 17:03:43 -04:00
}
2016-09-06 20:26:28 -04:00
return (bool) $this->driver->set($this->key, $this->value);
2016-09-06 17:03:43 -04:00
}
2016-08-31 12:18:46 -04:00
}