friendica/src/Core/Cache/ICache.php
2019-08-04 16:14:19 +02:00

65 lines
1.3 KiB
PHP

<?php
namespace Friendica\Core\Cache;
/**
* Cache Interface
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
interface ICache
{
/**
* 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
*
* @return mixed Cached $value or "null" if not found
*/
public function get($key);
/**
* 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
*
* @return bool
*/
public function set($key, $value, $ttl = Cache::FIVE_MINUTES);
/**
* Delete a key from the cache
*
* @param string $key The cache key
*
* @return bool
*/
public function delete($key);
/**
* Remove outdated data from the cache
* @param boolean $outdated just remove outdated values
*
* @return bool
*/
public function clear($outdated = true);
/**
* Returns the name of the current cache
*
* @return string
*/
public function getName();
}