banker/src/Driver/NullDriver.php

160 lines
2.7 KiB
PHP
Raw Normal View History

2016-10-19 09:57:06 -04:00
<?php declare(strict_types=1);
2016-09-05 16:43:37 -04:00
/**
* Banker
*
* A Caching library implementing psr/cache
*
2016-10-19 09:57:06 -04:00
* PHP version 7.0
2016-09-05 16:43:37 -04:00
*
* @package Banker
* @author Timothy J. Warren <tim@timshomepage.net>
2017-03-01 12:33:12 -05:00
* @copyright 2016 - 2017 Timothy J. Warren
2016-09-05 16:43:37 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2017-03-01 12:33:12 -05:00
* @version 1.0.1
2016-09-05 16:43:37 -04:00
* @link https://git.timshomepage.net/timw4mail/banker
*/
namespace Aviat\Banker\Driver;
/**
* Cache backend for use without a cache server. Only does transient
* in-memory caching
*/
2016-09-06 17:03:43 -04:00
class NullDriver extends AbstractDriver {
2016-09-05 16:43:37 -04:00
/**
* In memory store
*
* @var array
*/
protected $store = [];
/**
* NullDriver constructor.
*
* @param array $config
2016-09-06 20:57:24 -04:00
* @param array $options
2016-09-05 16:43:37 -04:00
*/
2016-09-06 20:57:24 -04:00
public function __construct(array $config = [], array $options = [])
2016-09-05 16:43:37 -04:00
{
$this->store = [];
}
2016-09-06 20:57:24 -04:00
2016-09-06 17:03:43 -04:00
/**
* Clean up nothing
*/
public function __destruct()
{
//noop
}
2016-09-05 16:43:37 -04:00
/**
* See if a key currently exists in the cache
*
* @param string $key
* @return bool
*/
2016-10-19 09:57:06 -04:00
public function exists(string $key): bool
2016-09-05 16:43:37 -04:00
{
2016-10-19 09:57:06 -04:00
return array_key_exists($key, $this->store);
2016-09-05 16:43:37 -04:00
}
/**
* Get the value for the selected cache key
*
* @param string $key
* @return mixed
*/
2016-10-19 09:57:06 -04:00
public function get(string $key)
2016-09-05 16:43:37 -04:00
{
2016-09-06 20:57:24 -04:00
return ($this->exists($key))
? $this->store[$key]
2016-09-06 17:03:43 -04:00
: NULL;
2016-09-05 16:43:37 -04:00
}
/**
* Retrieve a set of values by their cache key
*
* @param string[] $keys
* @return array
*/
2016-10-19 09:57:06 -04:00
public function getMultiple(array $keys = []): array
2016-09-05 16:43:37 -04:00
{
$output = [];
foreach($keys as $key)
{
$output[$key] = $this->get($key);
}
return $output;
}
/**
* Set a cached value
*
* @param string $key
* @param mixed $value
* @param int $expires
* @return DriverInterface
*/
2016-10-19 09:57:06 -04:00
public function set(string $key, $value, int $expires = 0): DriverInterface
2016-09-05 16:43:37 -04:00
{
$this->store[$key] = $value;
return $this;
}
/**
* Remove an item from the cache
*
* @param string $key
* @return boolean
*/
2016-10-19 09:57:06 -04:00
public function delete(string $key): bool
2016-09-05 16:43:37 -04:00
{
unset($this->store[$key]);
return ( ! array_key_exists($key, $this->store));
}
/**
* Remove multiple items from the cache
*
* @param string[] $keys
* @return boolean
*/
2016-10-19 09:57:06 -04:00
public function deleteMultiple(array $keys = []): bool
2016-09-05 16:43:37 -04:00
{
$res = TRUE;
foreach($keys as $key)
{
$res = $res && $this->delete($key);
}
return $res;
}
/**
* Empty the cache
*
* @return boolean
*/
2016-10-19 09:57:06 -04:00
public function flush(): bool
2016-09-05 16:43:37 -04:00
{
$this->store = [];
return TRUE;
}
2016-09-06 20:57:24 -04:00
2016-09-06 17:03:43 -04:00
/**
* Set the specified key to expire at the given time
*
* @param string $key
* @param int $expires
* @return boolean
*/
2016-10-19 09:57:06 -04:00
public function expiresAt(string $key, int $expires): bool
2016-09-06 17:03:43 -04:00
{
//noop
return TRUE;
}
2016-09-05 16:43:37 -04:00
}