Merge pull request #5848 from nupplaphil/friendica-5847

[friendica.git] / src / Core / Cache / ICacheDriver.php

diff --git a/src/Core/Cache/ICacheDriver.php b/src/Core/Cache/ICacheDriver.php
index ff329f34eb25c0b2879364ea45a0a3baa62d177f..2c04c5992578588611fd08fdefc1dd0d0ffb87f6 100644 (file)
--- a/src/Core/Cache/ICacheDriver.php
+++ b/src/Core/Cache/ICacheDriver.php
@@ -7,12 +7,21 @@ use Friendica\Core\Cache;
 /**
  * Cache Driver Interface
  *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
+ * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
 interface ICacheDriver
 {
        /**
-        * @brief Fetches cached data according to the key
+        * Lists all cache keys
+        *
+        * @param string prefix optional a prefix to search
+        *
+        * @return array Empty if it isn't supported by the cache driver
+        */
+       public function getAllKeys($prefix = null);
+
+       /**
+        * Fetches cached data according to the key
         *
         * @param string $key The key to the cached data
         *
@@ -21,18 +30,18 @@ interface ICacheDriver
        public function get($key);
 
        /**
-        * @brief Stores data in the cache identified by the key. The input $value can have multiple formats.
+        * Stores data in the cache identified by the key. The input $value can have multiple formats.
         *
         * @param string  $key      The cache key
         * @param mixed   $value    The value to store
-        * @param integer $ttl           The cache lifespan, must be one of the Cache constants
+        * @param integer $ttl The cache lifespan, must be one of the Cache constants
         *
         * @return bool
         */
        public function set($key, $value, $ttl = Cache::FIVE_MINUTES);
 
        /**
-        * @brief Delete a key from the cache
+        * Delete a key from the cache
         *
         * @param string $key      The cache key
         *
@@ -41,9 +50,10 @@ interface ICacheDriver
        public function delete($key);
 
        /**
-        * @brief Remove outdated data from the cache
+        * Remove outdated data from the cache
+        * @param  boolean $outdated just remove outdated values
         *
         * @return bool
         */
-       public function clear();
+       public function clear($outdated = true);
 }