2018-03-24 14:39:13 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core\Cache;
|
|
|
|
|
|
|
|
use Friendica\Core\Cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Cache Driver Interface
|
|
|
|
*
|
|
|
|
* @author Hypolite Petovan <mrpetovan@gmail.com>
|
|
|
|
*/
|
|
|
|
interface ICacheDriver
|
|
|
|
{
|
|
|
|
/**
|
2018-07-04 17:37:22 -04:00
|
|
|
* @brief 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-04 17:37:22 -04:00
|
|
|
* @brief 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-07-04 17:37:22 -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
|
|
|
|
*/
|
2018-07-04 17:37:22 -04:00
|
|
|
public function set($key, $value, $ttl = Cache::FIVE_MINUTES);
|
2018-03-24 14:39:13 -04:00
|
|
|
|
|
|
|
/**
|
2018-07-04 17:37:22 -04:00
|
|
|
* @brief 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-04 17:37:22 -04:00
|
|
|
* @brief Remove outdated data from the cache
|
2018-03-24 14:39:13 -04:00
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function clear();
|
|
|
|
}
|