<?php
/*
* This file is part of the Shieldon Simple Cache package.
*
* (c) Terry L. <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Shieldon\SimpleCache;
use Psr\SimpleCache\CacheInterface;
use Shieldon\SimpleCache\Exception\CacheArgumentException;
use function file_exists;
use function is_string;
use function strtolower;
use function ucfirst;
use function method_exists;
/**
* The base Cache Adapter class.
*/
class Cache
{
/**
* The cache driver.
*
* @var null|CacheInterface
*/
protected $driver;
/**
* Constructor.
*
* @param string|CacheInterface $driver The cache driver.
* @param array $settings The settings.
*
* @throws CacheException
*/
public function __construct($driver = null, array $settings = [])
{
if ($driver instanceof CacheInterface) {
$this->driver = $driver;
} elseif (is_string($driver)) {
$class = ucfirst(strtolower($driver));
if (file_exists(__DIR__ . '/Driver/' . $class . '.php')) {
$class = '\Shieldon\SimpleCache\Driver\\' . $class;
$this->driver = new $class($settings);
$this->gc($settings);
}
}
if (!$this->driver) {
throw new CacheArgumentException(
'The data driver is not set correctly.'
);
}
}
/**
* Get the cache.
*
* @param string $ket The key of a cache.
* @param mixed $val The value of a cache.
* @return mixed
*/
public function get($key, $default = null)
{
return $this->driver->get($key, $default);
}
/**
* Set a cache.
*
* @param string $key The key of a cache.
* @param mixed $value The value of a cache.
* @param int $ttl The time to live.
* @return bool
*/
public function set($key, $value, $ttl = null)
{
return $this->driver->set($key, $value, $ttl);
}
/**
* Delete a cache.
*
* @param string $key The key of a cache.
* @return bool
*/
public function delete($key)
{
return $this->driver->delete($key);
}
/**
* Clear all caches.
*
* @return bool
*/
public function clear()
{
return $this->driver->clear();
}
/**
* Check if a cache exists.
*
* @param string $key The key of a cache.
* @return bool
*/
public function has($key)
{
return $this->driver->has($key);
}
/**
* Get multiple caches.
*
* @param array $keys The keys of a cache.
* @param mixed $default The default value.
* @return iterable
*/
public function getMultiple($keys, $default = null)
{
return $this->driver->getMultiple($keys, $default);
}
/**
* Set multiple caches.
*
* @param array $values The keys and values of a cache.
* @param int $ttl The number of seconds until the cache will expire.
* @return bool
*/
public function setMultiple($values, $ttl = null)
{
return $this->driver->setMultiple($values, $ttl);
}
/**
* Delete multiple caches.
*
* @param array $keys The keys of a cache.
* @return bool
*/
public function deleteMultiple($keys)
{
return $this->driver->deleteMultiple($keys);
}
/**
* Create or rebuid the data schema. [Non-PSR-16]
* This method is avaialbe for Mysql and Sqlite drivers.
*
* @return bool
*/
public function rebuild(): bool
{
if (method_exists($this->driver, 'rebuild')) {
return $this->driver->rebuild();
}
return false;
}
/**
* Clear all expired items. [Non-PSR-16]
*
* @return array The list of the removed items.
*/
public function clearExpiredItems(): array
{
return $this->gc([
'gc_enable' => true,
'gc_probability' => 1,
'gc_divisor' => 1,
]);
}
public function getType(): string
{
return $this->driver->getType();
}
/**
* Performing cache data garbage collection for drivers that don't have
* ability to remove expired items automatically.
* This method is not needed for Redis and Memcached driver.
*
* @param array $settings [bool $gc_enable, int $gc_probability, int $gc_divisor]
*
* @return array The list of the removed items.
*/
protected function gc(array $settings = []): array
{
if (empty($settings['gc_enable'])) {
return [];
}
$removedList = [];
$probability = $settings['gc_probability'] ?? 1;
$divisor = $settings['gc_divisor'] ?? 100;
if (method_exists($this->driver, 'gc')) {
$removedList = $this->driver->gc($probability, $divisor);
}
return $removedList;
}
}