feat(cache): add deleteMatching method definition in CacheInterface (#9809)

* feat(cache): add deleteMatching method definition in CacheInterface

refs #7828

* docs(changelogs): add note about Cache interface change

Author: yassinedoghri

system/Cache/CacheInterface.php

@@ -51,6 +51,15 @@ public function save(string $key, $value, int $ttl = 60);
      */
     public function delete(string $key);
 
+    /**
+     * Deletes items from the cache store matching a given pattern.
+     *
+     * @param string $pattern Cache items glob-style pattern
+     *
+     * @return int Number of deleted items
+     */
+    public function deleteMatching(string $pattern): int;
+
     /**
      * Performs atomic incrementation of a raw stored value.
      *

system/Cache/Handlers/BaseHandler.php

@@ -15,10 +15,8 @@
 
 use Closure;
 use CodeIgniter\Cache\CacheInterface;
-use CodeIgniter\Exceptions\BadMethodCallException;
 use CodeIgniter\Exceptions\InvalidArgumentException;
 use Config\Cache;
-use Exception;
 
 /**
  * Base class for cache handling
@@ -98,18 +96,4 @@ public function remember(string $key, int $ttl, Closure $callback)
 
         return $value;
     }
-
-    /**
-     * Deletes items from the cache store matching a given pattern.
-     *
-     * @param string $pattern Cache items glob-style pattern
-     *
-     * @return int
-     *
-     * @throws Exception
-     */
-    public function deleteMatching(string $pattern)
-    {
-        throw new BadMethodCallException('The deleteMatching method is not implemented.');
-    }
 }

system/Cache/Handlers/DummyHandler.php

@@ -63,10 +63,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return int
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): int
     {
         return 0;
     }

system/Cache/Handlers/FileHandler.php

@@ -131,10 +131,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return int
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): int
     {
         $deleted = 0;
 

system/Cache/Handlers/MemcachedHandler.php

@@ -182,10 +182,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return never
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): never
     {
         throw new BadMethodCallException('The deleteMatching method is not implemented for Memcached. You must select File, Redis or Predis handlers to use it.');
     }

system/Cache/Handlers/PredisHandler.php

@@ -155,10 +155,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return int
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): int
     {
         $matchedKeys = [];
 

system/Cache/Handlers/RedisHandler.php

@@ -179,10 +179,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return int
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): int
     {
         /** @var list<string> $matchedKeys */
         $matchedKeys = [];

system/Cache/Handlers/WincacheHandler.php

@@ -75,10 +75,8 @@ public function delete(string $key)
 
     /**
      * {@inheritDoc}
-     *
-     * @return never
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): never
     {
         throw new BadMethodCallException('The deleteMatching method is not implemented for Wincache. You must select File, Redis or Predis handlers to use it.');
     }

system/Test/Mock/MockCache.php

@@ -129,10 +129,8 @@ public function delete(string $key)
 
     /**
      * Deletes items from the cache store matching a given pattern.
-     *
-     * @return int
      */
-    public function deleteMatching(string $pattern)
+    public function deleteMatching(string $pattern): int
     {
         $count = 0;
 

user_guide_src/source/changelogs/v4.7.0.rst

@@ -43,6 +43,7 @@ across all insert/update operations.
 Interface Changes
 =================
 
+- **Cache:** The ``CacheInterface`` now includes the ``deleteMatching()`` method. If you've implemented your own caching driver from scratch, you will need to provide an implementation for this method to ensure compatibility.
 - **Images:** The ``ImageHandlerInterface`` now includes a new method: ``clearMetadata()``. If you've implemented your own handler from scratch, you will need to provide an implementation for this method to ensure compatibility.
 
 Method Signature Changes