banker/src/Driver/NullDriver.php
Timothy J. Warren 3df3ca9671
Some checks failed
Gitea - aviat/banker/pipeline/head There was a failure building this commit
Bump version
2023-03-16 16:24:11 -04:00

140 lines
2.5 KiB
PHP

<?php declare(strict_types=1);
/**
* Banker
*
* A Caching library implementing psr/cache (PSR 6) and psr/simple-cache (PSR 16)
*
* PHP version 8+
*
* @package Banker
* @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2016 - 2023 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 4.1.1
* @link https://git.timshomepage.net/timw4mail/banker
*/
namespace Aviat\Banker\Driver;
use DateInterval;
/**
* Cache backend for use without a cache server. Only does transient
* in-memory caching
*/
class NullDriver extends AbstractDriver {
/**
* In memory store
*
* @var array
*/
protected array $store = [];
/**
* NullDriver constructor
*/
public function __construct()
{
$this->store = [];
}
/**
* See if a key currently exists in the cache
*
* @param string $key
* @return bool
*/
public function exists(string $key): bool
{
return array_key_exists($key, $this->store);
}
/**
* Get the value for the selected cache key
*
* @param string $key
* @return mixed
*/
public function get(string $key): mixed
{
return $this->exists($key)
? $this->store[$key]
: NULL;
}
/**
* Set a cached value
*
* @param string $key
* @param mixed $value
* @param DateInterval|int|null $expires
* @return bool
*/
public function set(string $key, mixed $value, DateInterval|int|null $expires = NULL): bool
{
$this->store[$key] = $value;
return $this->store[$key] === $value;
}
/**
* Remove an item from the cache
*
* @param string $key
* @return boolean
*/
public function delete(string $key): bool
{
// Don't return true if the key didn't exist to begin with
if ( ! array_key_exists($key, $this->store))
{
return FALSE;
}
unset($this->store[$key]);
return ( ! array_key_exists($key, $this->store));
}
/**
* Remove multiple items from the cache
*
* @param string[] $keys
* @return boolean
*/
public function deleteMultiple(array $keys = []): bool
{
$this->validateKeys($keys);
$res = TRUE;
foreach($keys as $key)
{
$res = $res && $this->delete($key);
}
return $res;
}
/**
* Empty the cache
*
* @return boolean
*/
public function flush(): bool
{
$this->store = [];
return TRUE;
}
/**
* Set the specified key to expire at the given time
*
* @param string $key
* @param int $expires
* @return boolean
*/
public function expiresAt(string $key, int $expires): bool
{
//noop
return array_key_exists($key, $this->store);
}
}