:feat: add touch for cache ttl extension

Author: Yitz Willroth

src/Illuminate/Cache/ApcStore.php

@@ -103,6 +103,20 @@ public function forget($key)
         return $this->apc->delete($this->prefix.$key);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        $value = $this->apc->get($key = $this->getPrefix().$key);
+
+        if (is_null($value)) {
+            return false;
+        }
+
+        return $this->apc->put($key, $value, $ttl);
+    }
+
     /**
      * Remove all items from the cache.
      *

src/Illuminate/Cache/ArrayStore.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Cache;
 
 use Illuminate\Contracts\Cache\LockProvider;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\InteractsWithTime;
 
@@ -130,6 +131,24 @@ public function forever($key, $value)
         return $this->put($key, $value, 0);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        $item = Arr::get($this->storage, $key = $this->getPrefix().$key, null);
+
+        if (is_null($item)) {
+            return false;
+        }
+
+        $item['expiresAt'] = $this->calculateExpiration($ttl);
+
+        $this->storage = array_merge($this->storage, [$key => $item]);
+
+        return true;
+    }
+
     /**
      * Remove an item from the cache.
      *

src/Illuminate/Cache/DatabaseStore.php

@@ -411,6 +411,17 @@ protected function forgetManyIfExpired(array $keys, bool $prefixed = false)
         return true;
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        return (bool) $this->table()
+            ->where('key', '=', $this->getPrefix().$key)
+            ->where('expiration', '>', $now = $this->getTime())
+            ->update(['expiration' => $now + $ttl]);
+    }
+
     /**
      * Remove all items from the cache.
      *

src/Illuminate/Cache/DynamoDbStore.php

@@ -448,6 +448,39 @@ public function forget($key)
         return true;
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     *
+     * @throws DynamoDbException
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        try {
+            $this->dynamo->updateItem([
+                'TableName' => $this->table,
+                'Key' => [$this->keyAttribute => ['S' => $this->getPrefix().$key]],
+                'UpdateExpression' => 'SET #expiry = :expiry',
+                'ConditionExpression' => 'attribute_exists(#key) AND #expiry > :now',
+                'ExpressionAttributeNames' => [
+                    '#key' => $this->keyAttribute,
+                    '#expiry' => $this->expirationAttribute,
+                ],
+                'ExpressionAttributeValues' => [
+                    ':expiry' => ['N' => (string) $this->toTimestamp($ttl)],
+                    ':now' => ['N' => (string) $this->currentTime()],
+                ],
+            ]);
+        } catch (DynamoDbException $e) {
+            if (str_contains($e->getMessage(), 'ConditionalCheckFailed')) {
+                return false;
+            }
+
+            throw $e;
+        }
+
+        return true;
+    }
+
     /**
      * Remove all items from the cache.
      *

src/Illuminate/Cache/FileStore.php

@@ -257,6 +257,20 @@ public function forget($key)
         return false;
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        $payload = $this->getPayload($this->getPrefix().$key);
+
+        if (is_null($payload['data'])) {
+            return false;
+        }
+
+        return $this->put($key, $payload['data'], $ttl);
+    }
+
     /**
      * Remove all items from the cache.
      *
@@ -298,7 +312,7 @@ protected function getPayload($key)
             }
 
             $expire = substr($contents, 0, 10);
-        } catch (Exception) {
+        } catch (Exception $e) {
             return $this->emptyPayload();
         }
 
@@ -314,6 +328,7 @@ protected function getPayload($key)
         try {
             $data = unserialize(substr($contents, 10));
         } catch (Exception) {
+
             $this->forget($key);
 
             return $this->emptyPayload();

src/Illuminate/Cache/MemcachedStore.php

@@ -202,6 +202,14 @@ public function restoreLock($name, $owner)
         return $this->lock($name, 0, $owner);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        return $this->memcached->touch($this->getPrefix().$key, $this->calculateExpiration($ttl));
+    }
+
     /**
      * Remove an item from the cache.
      *

src/Illuminate/Cache/MemoizedStore.php

@@ -208,6 +208,16 @@ public function forget($key)
         return $this->repository->forget($key);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        unset($this->cache[$this->prefix($key)]);
+        
+        return $this->repository->touch($key, $ttl);
+    }
+
     /**
      * Remove all items from the cache.
      *

src/Illuminate/Cache/NullStore.php

@@ -93,6 +93,14 @@ public function restoreLock($name, $owner)
         return $this->lock($name, 0, $owner);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        return false;
+    }
+
     /**
      * Remove an item from the cache.
      *

src/Illuminate/Cache/RedisStore.php

@@ -248,6 +248,14 @@ public function restoreLock($name, $owner)
         return $this->lock($name, 0, $owner);
     }
 
+    /**
+     * Set the expiration time of a cached item.
+     */
+    public function touch(string $key, int $ttl): bool
+    {
+        return (bool) $this->connection()->expire($this->getPrefix().$key, (int) max(1, $ttl));
+    }
+
     /**
      * Remove an item from the cache.
      *
@@ -458,7 +466,6 @@ protected function serialize($value)
      * Determine if the given value should be stored as plain value.
      *
      * @param  mixed  $value
-     * @return bool
      */
     protected function shouldBeStoredWithoutSerialization($value): bool
     {

src/Illuminate/Cache/Repository.php

@@ -106,7 +106,6 @@ public function missing($key)
      *
      * @param  array|string  $key
      * @param  mixed  $default
-     * @return mixed
      */
     public function get($key, $default = null): mixed
     {
@@ -251,8 +250,6 @@ public function put($key, $value, $ttl = null)
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
     public function set($key, $value, $ttl = null): bool
     {
@@ -262,7 +259,6 @@ public function set($key, $value, $ttl = null): bool
     /**
      * Store multiple items in the cache for a given number of seconds.
      *
-     * @param  array  $values
      * @param  \DateTimeInterface|\DateInterval|int|null  $ttl
      * @return bool
      */
@@ -296,7 +292,6 @@ public function putMany(array $values, $ttl = null)
     /**
      * Store multiple items in the cache indefinitely.
      *
-     * @param  array  $values
      * @return bool
      */
     protected function putManyForever(array $values)
@@ -525,6 +520,22 @@ public function flexible($key, $ttl, $callback, $lock = null)
         return $value;
     }
 
+    /**
+     * Set the expiration of a cached item; null TTL will retain indefinitely.
+     */
+    public function touch(string $key, \DateTimeInterface|\DateInterval|int|null $ttl = null): bool
+    {
+        $value = $this->get($key);
+        
+        if (is_null($value)) {
+            return false;
+        }
+
+        return is_null($ttl)
+            ? $this->forever($key, $value)
+            : $this->store->touch($this->itemKey($key), $this->getSeconds($ttl));
+    }
+
     /**
      * Remove an item from the cache.
      *
@@ -546,8 +557,6 @@ public function forget($key)
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
     public function delete($key): bool
     {
@@ -556,8 +565,6 @@ public function delete($key): bool
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
     public function deleteMultiple($keys): bool
     {
@@ -574,8 +581,6 @@ public function deleteMultiple($keys): bool
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
     public function clear(): bool
     {
@@ -737,7 +742,6 @@ public function getEventDispatcher()
     /**
      * Set the event dispatcher instance.
      *
-     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
      * @return void
      */
     public function setEventDispatcher(Dispatcher $events)
@@ -749,7 +753,6 @@ public function setEventDispatcher(Dispatcher $events)
      * Determine if a cached value exists.
      *
      * @param  string  $key
-     * @return bool
      */
     public function offsetExists($key): bool
     {
@@ -760,7 +763,6 @@ public function offsetExists($key): bool
      * Retrieve an item from the cache by key.
      *
      * @param  string  $key
-     * @return mixed
      */
     public function offsetGet($key): mixed
     {
@@ -772,7 +774,6 @@ public function offsetGet($key): mixed
      *
      * @param  string  $key
      * @param  mixed  $value
-     * @return void
      */
     public function offsetSet($key, $value): void
     {
@@ -783,7 +784,6 @@ public function offsetSet($key, $value): void
      * Remove an item from the cache.
      *
      * @param  string  $key
-     * @return void
      */
     public function offsetUnset($key): void
     {