2018-03-24 14:39:13 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core\Cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Cache Driver Interface
|
|
|
|
*
|
2018-09-15 19:28:38 -04:00
|
|
|
* @author Hypolite Petovan <hypolite@mrpetovan.com>
|
2018-03-24 14:39:13 -04:00
|
|
|
*/
|
|
|
|
interface ICacheDriver
|
|
|
|
{
|
2019-08-03 14:48:56 -04:00
|
|
|
const MONTH = 2592000;
|
|
|
|
const WEEK = 604800;
|
|
|
|
const DAY = 86400;
|
|
|
|
const HOUR = 3600;
|
|
|
|
const HALF_HOUR = 1800;
|
|
|
|
const QUARTER_HOUR = 900;
|
|
|
|
const FIVE_MINUTES = 300;
|
|
|
|
const MINUTE = 60;
|
|
|
|
const INFINITE = 0;
|
|
|
|
|
2018-09-25 22:52:32 -04:00
|
|
|
/**
|
|
|
|
* Lists all cache keys
|
|
|
|
*
|
2018-10-06 18:27:54 -04:00
|
|
|
* @param string prefix optional a prefix to search
|
|
|
|
*
|
2018-10-07 16:14:05 -04:00
|
|
|
* @return array Empty if it isn't supported by the cache driver
|
2018-09-25 22:52:32 -04:00
|
|
|
*/
|
2018-10-06 18:27:54 -04:00
|
|
|
public function getAllKeys($prefix = null);
|
2018-09-25 22:52:32 -04:00
|
|
|
|
2018-03-24 14:39:13 -04:00
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* Fetches cached data according to the key
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @param string $key The key to the cached data
|
|
|
|
*
|
|
|
|
* @return mixed Cached $value or "null" if not found
|
|
|
|
*/
|
|
|
|
public function get($key);
|
|
|
|
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* Stores data in the cache identified by the key. The input $value can have multiple formats.
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @param string $key The cache key
|
|
|
|
* @param mixed $value The value to store
|
2018-10-29 05:16:07 -04:00
|
|
|
* @param integer $ttl The cache lifespan, must be one of the Cache constants
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
2019-08-03 14:48:56 -04:00
|
|
|
public function set($key, $value, $ttl = self::FIVE_MINUTES);
|
2018-03-24 14:39:13 -04:00
|
|
|
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* Delete a key from the cache
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
2018-07-04 17:37:22 -04:00
|
|
|
* @param string $key The cache key
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function delete($key);
|
|
|
|
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* Remove outdated data from the cache
|
2018-07-07 13:46:16 -04:00
|
|
|
* @param boolean $outdated just remove outdated values
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
2018-07-07 13:46:16 -04:00
|
|
|
public function clear($outdated = true);
|
2018-03-24 14:39:13 -04:00
|
|
|
}
|