diff --git a/src/Cache/Adapter.php b/src/Cache/Adapter.php index a1ea41e2b7..91aa22d68a 100644 --- a/src/Cache/Adapter.php +++ b/src/Cache/Adapter.php @@ -24,6 +24,13 @@ interface Adapter */ public function save(string $key, array|string $data, string $hash = ''): bool|string|array; + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool; + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Filesystem.php b/src/Cache/Adapter/Filesystem.php index b07c01203f..02c8649de9 100644 --- a/src/Cache/Adapter/Filesystem.php +++ b/src/Cache/Adapter/Filesystem.php @@ -97,6 +97,24 @@ class Filesystem implements Adapter } } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + $file = $this->getPath($key); + + if (! file_exists($file) || ! touch($file)) { + return false; + } + + clearstatcache(true, $file); + + return true; + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Hazelcast.php b/src/Cache/Adapter/Hazelcast.php index 2a696c0958..6818c069bb 100644 --- a/src/Cache/Adapter/Hazelcast.php +++ b/src/Cache/Adapter/Hazelcast.php @@ -87,6 +87,27 @@ class Hazelcast implements Adapter return ($this->execute(fn () => $this->memcached->set($key, json_encode($cache)))) ? $data : false; } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + $cache = $this->execute(fn () => $this->memcached->get($key)); + if (is_string($cache)) { + $cache = json_decode($cache, true); + } + + if (! is_array($cache)) { + return false; + } + + $cache['time'] = time(); + + return (bool) $this->execute(fn () => $this->memcached->set($key, json_encode($cache))); + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Memcached.php b/src/Cache/Adapter/Memcached.php index 98363c2e3f..b80aa3fec0 100644 --- a/src/Cache/Adapter/Memcached.php +++ b/src/Cache/Adapter/Memcached.php @@ -89,6 +89,24 @@ class Memcached implements Adapter return $this->execute(fn () => $this->memcached->set($key, $cache)) ? $data : false; } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + /** @var array{time: int, data: string|array}|false */ + $cache = $this->execute(fn () => $this->memcached->get($key)); + if ($cache === false) { + return false; + } + + $cache['time'] = time(); + + return (bool) $this->execute(fn () => $this->memcached->set($key, $cache)); + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Memory.php b/src/Cache/Adapter/Memory.php index 63c084281b..bb4a82a92d 100644 --- a/src/Cache/Adapter/Memory.php +++ b/src/Cache/Adapter/Memory.php @@ -76,6 +76,25 @@ class Memory implements Adapter return $data; } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + if (empty($key) || ! isset($this->store[$key])) { + return false; + } + + /** @var array{time: int, data: string|array} $saved */ + $saved = $this->store[$key]; + $saved['time'] = time(); + $this->store[$key] = $saved; + + return true; + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/None.php b/src/Cache/Adapter/None.php index a3bb629f58..76ec9ff672 100644 --- a/src/Cache/Adapter/None.php +++ b/src/Cache/Adapter/None.php @@ -53,6 +53,16 @@ class None implements Adapter return false; } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + return false; + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Pool.php b/src/Cache/Adapter/Pool.php index 2fa228bf3e..851069830b 100644 --- a/src/Cache/Adapter/Pool.php +++ b/src/Cache/Adapter/Pool.php @@ -59,6 +59,16 @@ class Pool implements Adapter return $result; } + public function touch(string $key, string $hash = ''): bool + { + /** + * @var bool $result + */ + $result = $this->delegate(__FUNCTION__, \func_get_args()); + + return $result; + } + public function list(string $key): array { /** diff --git a/src/Cache/Adapter/Redis.php b/src/Cache/Adapter/Redis.php index 3c0683f8b2..654da4cffa 100644 --- a/src/Cache/Adapter/Redis.php +++ b/src/Cache/Adapter/Redis.php @@ -152,6 +152,35 @@ class Redis implements Adapter } } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + if (empty($hash)) { + $hash = $key; + } + + $redis_string = $this->execute(fn () => $this->redis->hGet($key, $hash)); + + if ($redis_string === false || $redis_string === null || ! is_string($redis_string)) { + return false; + } + + try { + /** @var array{time: int, data: mixed} $cache */ + $cache = json_decode($redis_string, true, flags: JSON_THROW_ON_ERROR); + $cache['time'] = time(); + $value = json_encode($cache, flags: JSON_THROW_ON_ERROR); + } catch (Throwable $th) { + return false; + } + + return $this->execute(fn () => $this->redis->hSet($key, $hash, $value)) !== false; + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/RedisCluster.php b/src/Cache/Adapter/RedisCluster.php index 186fe3f7d0..7dcd4b51d5 100644 --- a/src/Cache/Adapter/RedisCluster.php +++ b/src/Cache/Adapter/RedisCluster.php @@ -103,7 +103,7 @@ class RedisCluster implements Adapter /** @var string|false */ $redis_string = $this->execute(fn () => $this->redis->hGet($key, $hash)); - if ($redis_string === false) { + if ($redis_string === false || ! is_string($redis_string)) { return false; } @@ -151,6 +151,36 @@ class RedisCluster implements Adapter } } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + if (empty($hash)) { + $hash = $key; + } + + /** @var string|false */ + $redis_string = $this->execute(fn () => $this->redis->hGet($key, $hash)); + + if ($redis_string === false || ! is_string($redis_string)) { + return false; + } + + try { + /** @var array{time: int, data: mixed} $cache */ + $cache = json_decode($redis_string, true, flags: JSON_THROW_ON_ERROR); + $cache['time'] = time(); + $value = json_encode($cache, flags: JSON_THROW_ON_ERROR); + } catch (Throwable $th) { + return false; + } + + return $this->execute(fn () => $this->redis->hSet($key, $hash, $value)) !== false; + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Adapter/Sharding.php b/src/Cache/Adapter/Sharding.php index a036b8972f..0521edff6a 100644 --- a/src/Cache/Adapter/Sharding.php +++ b/src/Cache/Adapter/Sharding.php @@ -92,6 +92,16 @@ class Sharding implements Adapter return $this->getAdapter($key)->save($key, $data, $hash); } + /** + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + return $this->getAdapter($key)->touch($key, $hash); + } + /** * @param string $key * @return string[] diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php index 416e1e5118..324fb71da1 100644 --- a/src/Cache/Cache.php +++ b/src/Cache/Cache.php @@ -106,6 +106,29 @@ class Cache } } + /** + * Refresh a cache entry timestamp without replacing its data. + * + * @param string $key + * @param string $hash optional + * @return bool + */ + public function touch(string $key, string $hash = ''): bool + { + $key = $this->caseSensitive ? $key : strtolower($key); + $hash = $this->caseSensitive ? $hash : strtolower($hash); + + $start = microtime(true); + $result = $this->adapter->touch($key, $hash); + $duration = microtime(true) - $start; + $this->operationDuration?->record($duration, [ + 'operation' => 'touch', + 'adapter' => $this->adapter->getName($key), + ]); + + return $result; + } + /** * Returns a list of keys. * diff --git a/tests/Cache/Base.php b/tests/Cache/Base.php index eecfdf5278..4fd13cb62e 100644 --- a/tests/Cache/Base.php +++ b/tests/Cache/Base.php @@ -57,6 +57,21 @@ abstract class Base extends TestCase $this->assertEquals(false, $data); } + public function testCacheTouch(): void + { + $result = self::$cache->save('touch-key', 'touch data', 'touch-key'); + $this->assertEquals('touch data', $result); + + sleep(3); + + $this->assertEquals(false, self::$cache->load('touch-key', 2, 'touch-key')); + $this->assertEquals(true, self::$cache->touch('touch-key', 'touch-key')); + $this->assertEquals('touch data', self::$cache->load('touch-key', 2, 'touch-key')); + $this->assertEquals(false, self::$cache->touch('missing-touch-key', 'missing-touch-key')); + + self::$cache->purge('touch-key'); + } + public function testCaseInsensitivity(): void { // Ensure case in-sensitivity first (configured in adapter's setUp) diff --git a/tests/Cache/NoneTest.php b/tests/Cache/NoneTest.php index bf86461969..0eb57886a8 100644 --- a/tests/Cache/NoneTest.php +++ b/tests/Cache/NoneTest.php @@ -60,6 +60,11 @@ class NoneTest extends Base $this->assertEquals(true, $result); } + public function testCacheTouch(): void + { + $this->assertEquals(false, self::$cache->touch($this->key)); + } + public function testCaseInsensitivity(): void { // None adapter does not expect case sensitivity/insensitivy