3 * @file src/Core/Cache.php
5 namespace Friendica\Core;
7 use Friendica\BaseObject;
8 use Friendica\Core\Cache\ICache;
11 * @brief Class for storing data for a short time
13 class Cache extends BaseObject
15 /** @deprecated Use ICache::MONTH */
16 const MONTH = ICache::MONTH;
17 /** @deprecated Use ICache::WEEK */
18 const WEEK = ICache::WEEK;
19 /** @deprecated Use ICache::DAY */
20 const DAY = ICache::DAY;
21 /** @deprecated Use ICache::HOUR */
22 const HOUR = ICache::HOUR;
23 /** @deprecated Use ICache::HALF_HOUR */
24 const HALF_HOUR = ICache::HALF_HOUR;
25 /** @deprecated Use ICache::QUARTER_HOUR */
26 const QUARTER_HOUR = ICache::QUARTER_HOUR;
27 /** @deprecated Use ICache::FIVE_MINUTES */
28 const FIVE_MINUTES = ICache::FIVE_MINUTES;
29 /** @deprecated Use ICache::MINUTE */
30 const MINUTE = ICache::MINUTE;
31 /** @deprecated Use ICache::INFINITE */
32 const INFINITE = ICache::INFINITE;
35 * @brief Returns all the cache keys sorted alphabetically
37 * @param string $prefix Prefix of the keys (optional)
39 * @return array Empty if the driver doesn't support this feature
42 public static function getAllKeys($prefix = null)
44 return self::getClass(ICache::class)->getAllKeys($prefix);
48 * @brief Fetch cached data according to the key
50 * @param string $key The key to the cached data
52 * @return mixed Cached $value or "null" if not found
55 public static function get($key)
57 return self::getClass(ICache::class)->get($key);
61 * @brief Put data in the cache according to the key
63 * The input $value can have multiple formats.
65 * @param string $key The key to the cached data
66 * @param mixed $value The value that is about to be stored
67 * @param integer $duration The cache lifespan
72 public static function set($key, $value, $duration = ICache::MONTH)
74 return self::getClass(ICache::class)->set($key, $value, $duration);
78 * @brief Delete a value from the cache
80 * @param string $key The key to the cached data
85 public static function delete($key)
87 return self::getClass(ICache::class)->delete($key);
91 * @brief Remove outdated data from the cache
93 * @param boolean $outdated just remove outdated values
98 public static function clear($outdated = true)
100 return self::getClass(ICache::class)->clear($outdated);