banker/src/Driver/RedisDriver.php

149 lines
2.8 KiB
PHP

<?php declare(strict_types=1);
/**
* Banker
*
* A Caching library implementing psr/cache
*
* PHP version 7.1
*
* @package Banker
* @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2016 - 2018 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 2.0.0
* @link https://git.timshomepage.net/timw4mail/banker
*/
namespace Aviat\Banker\Driver;
use Predis\Client;
/**
* Redis cache backend
*/
class RedisDriver extends AbstractDriver {
/**
* The object encapsulating the connection to the Redis server
*
* @var \Predis\Client
*/
protected $conn;
/**
* RedisDriver constructor.
*
* @codeCoverageIgnore
* @param array $config
* @param array $options - Predis library connection options
* @throws CacheException
*/
public function __construct(array $config = [], array $options = [])
{
if ( ! class_exists('Predis\\Client'))
{
throw new CacheException("The redis driver requires the predis/predis composer package to be installed.");
}
$this->conn = new Client($config, $options);
}
/**
* Disconnect from memcached server
*/
public function __destruct()
{
$this->conn->quit();
}
/**
* See if a key currently exists in the cache
*
* @param string $key
* @return bool
*/
public function exists(string $key): bool
{
return (bool) $this->conn->exists($key);
}
/**
* Get the value for the selected cache key
*
* @param string $key
* @return mixed
*/
public function get(string $key)
{
$raw = $this->conn->get($key);
return unserialize($raw);
}
/**
* Set a cached value
*
* @param string $key
* @param mixed $value
* @param int $expires
* @return DriverInterface
*/
public function set(string $key, $value, int $expires = 0): DriverInterface
{
$value = serialize($value);
if ($expires !== 0)
{
$this->conn->set($key, $value, 'EX', $expires);
}
else
{
$this->conn->set($key, $value);
}
return $this;
}
/**
* Remove an item from the cache
*
* @param string $key
* @return boolean
*/
public function delete(string $key): bool
{
return (bool) $this->conn->del($key);
}
/**
* Remove multiple items from the cache
*
* @param string[] $keys
* @return boolean
*/
public function deleteMultiple(array $keys = []): bool
{
$res = $this->conn->del(...$keys);
return $res === \count($keys);
}
/**
* Empty the cache
*
* @return boolean
*/
public function flush(): bool
{
return (bool) $this->conn->flushdb();
}
/**
* Set the expiration timestamp of a key
*
* @param string $key
* @param int $expires
* @return boolean
*/
public function expiresAt(string $key, int $expires): bool
{
return (bool) $this->conn->expireat($key, $expires);
}
}