src/Core/Cache/Capability/ICanCache.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Cache\Capability;
  23
  24 use Friendica\Core\Cache\Enum\Duration;
  25 use Friendica\Core\Cache\Exception\CachePersistenceException;
  26
  27 /**
  28  * Interface for caches
  29  */
  30 interface ICanCache
  31 {
  32         /**
  33          * Lists all cache keys
  34          *
  35          * @param string|null prefix optional a prefix to search
  36          *
  37          * @return array Empty if it isn't supported by the cache driver
  38          */
  39         public function getAllKeys(?string $prefix = null): array;
  40
  41         /**
  42          * Fetches cached data according to the key
  43          *
  44          * @param string $key The key to the cached data
  45          *
  46          * @return mixed Cached $value or "null" if not found
  47          *
  48          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  49          */
  50         public function get(string $key);
  51
  52         /**
  53          * Stores data in the cache identified by the key. The input $value can have multiple formats.
  54          *
  55          * @param string  $key   The cache key
  56          * @param mixed   $value The value to store
  57          * @param integer $ttl   The cache lifespan, must be one of the Cache constants
  58          *
  59          * @return bool
  60          *
  61          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  62          */
  63         public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool;
  64
  65         /**
  66          * Delete a key from the cache
  67          *
  68          * @param string $key The cache key
  69          *
  70          * @return bool
  71          *
  72          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  73          */
  74         public function delete(string $key): bool;
  75
  76         /**
  77          * Remove outdated data from the cache
  78          *
  79          * @param boolean $outdated just remove outdated values
  80          *
  81          * @return bool
  82          *
  83          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  84          */
  85         public function clear(bool $outdated = true): bool;
  86
  87         /**
  88          * Returns the name of the current cache
  89          *
  90          * @return string
  91          */
  92         public function getName(): string;
  93 }