banker/src/Teller.php

211 lines
6.4 KiB
PHP
Raw Normal View History

2020-05-07 17:17:03 -04:00
<?php declare(strict_types=1);
/**
* Banker
*
* A Caching library implementing psr/cache (PSR 6) and psr/simple-cache (PSR 16)
2020-05-07 17:17:03 -04:00
*
2021-02-05 17:05:56 -05:00
* PHP version 7.4+
2020-05-07 17:17:03 -04:00
*
* @package Banker
* @author Timothy J. Warren <tim@timshomepage.net>
2021-02-05 17:05:56 -05:00
* @copyright 2016 - 2021 Timothy J. Warren
2020-05-07 17:17:03 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2021-02-05 17:05:56 -05:00
* @version 3.2.0
2020-05-07 17:17:03 -04:00
* @link https://git.timshomepage.net/timw4mail/banker
*/
namespace Aviat\Banker;
use Aviat\Banker\Exception\InvalidArgumentException;
use Psr\Log\LoggerAwareInterface;
2020-05-07 17:17:03 -04:00
use Psr\SimpleCache;
use Psr\Log\LoggerInterface;
/**
* Implements PSR-16 (SimpleCache)
*/
class Teller implements SimpleCache\CacheInterface, LoggerAwareInterface {
use _Driver;
use LoggerTrait;
2020-05-07 17:17:03 -04:00
/**
* Set up the cache backend
*
* @param array $config
* @param LoggerInterface|null $logger
2020-05-07 17:17:03 -04:00
*/
public function __construct(array $config, ?LoggerInterface $logger = NULL)
{
$this->driver = $this->loadDriver($config);
if ($logger !== NULL)
{
$this->setLogger($logger);
}
2020-05-07 17:17:03 -04:00
}
/**
* Fetches a value from the cache.
*
* @param string $key The unique key of this item in the cache.
* @param mixed $default Default value to return if the key does not exist.
*
* @return mixed The value of the item from the cache, or $default in case of cache miss.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if the $key string is not a legal value.
*/
public function get($key, $default = null):mixed
2020-05-07 17:17:03 -04:00
{
$this->validateKey($key);
return ($this->driver->exists($key)) ? $this->driver->get($key) : $default;
2020-05-07 17:17:03 -04:00
}
/**
* 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|\DateInterval $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.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if the $key string is not a legal value.
*/
public function set($key, mixed $value, $ttl = null): bool
2020-05-07 17:17:03 -04:00
{
$this->validateKey($key);
return $this->driver->set($key, $value, $ttl);
2020-05-07 17:17:03 -04:00
}
/**
* 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.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if the $key string is not a legal value.
*/
public function delete($key): bool
{
$this->validateKey($key);
return $this->driver->delete($key);
2020-05-07 17:17:03 -04:00
}
/**
* Wipes clean the entire cache's keys.
*
* @return bool True on success and false on failure.
*/
public function clear(): bool
{
return $this->driver->flush();
2020-05-07 17:17:03 -04:00
}
/**
* Obtains multiple cache items by their unique keys.
*
* @param iterable $keys A list of keys that can obtained in a single operation.
* @param mixed $default Default value to return for keys that do not exist.
*
* @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if $keys is neither an array nor a Traversable,
* or if any of the $keys are not a legal value.
*/
public function getMultiple($keys, $default = null)
{
// Check type of keys
if ( ! is_iterable($keys))
{
throw new InvalidArgumentException('Keys must be an array or a traversable object');
}
2020-05-07 17:17:03 -04:00
$this->validateKeys($keys);
return $this->driver->getMultiple((array)$keys);
2020-05-07 17:17:03 -04:00
}
/**
* Persists a set of key => value pairs in the cache, with an optional TTL.
*
* @param iterable $values A list of key => value pairs for a multiple-set operation.
* @param null|int|\DateInterval $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.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if $values is neither an array nor a Traversable,
* or if any of the $values are not a legal value.
*/
public function setMultiple($values, $ttl = null): bool
{
// Check type of keys
if ( ! is_iterable($values))
{
throw new InvalidArgumentException('Values must be an array or a traversable object');
}
2020-05-07 17:17:03 -04:00
$this->validateKeys($values, TRUE);
return ($ttl === NULL)
? $this->driver->setMultiple((array)$values)
: $this->driver->setMultiple((array)$values, $ttl);
2020-05-07 17:17:03 -04:00
}
/**
* Deletes multiple cache items in a single operation.
*
* @param iterable $keys A list of string-based keys to be deleted.
*
* @return bool True if the items were successfully removed. False if there was an error.
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if $keys is neither an array nor a Traversable,
* or if any of the $keys are not a legal value.
*/
public function deleteMultiple($keys): bool
{
// Check type of keys
if ( ! is_iterable($keys))
{
throw new InvalidArgumentException('Keys must be an array or a traversable object');
}
2020-05-07 17:17:03 -04:00
$this->validateKeys($keys);
return $this->driver->deleteMultiple((array)$keys);
2020-05-07 17:17:03 -04:00
}
/**
* 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
*
* @throws SimpleCache\InvalidArgumentException
* MUST be thrown if the $key string is not a legal value.
*/
public function has($key): bool
{
$this->validateKey($key);
return $this->driver->exists($key);
2020-05-07 17:17:03 -04:00
}
}