friendica/src/Core/Cache/ICacheDriver.php

58 lines
1.2 KiB
PHP
Raw Normal View History

<?php
namespace Friendica\Core\Cache;
use Friendica\Core\Cache;
/**
* Cache Driver Interface
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
interface ICacheDriver
{
2018-09-25 22:52:32 -04:00
/**
* Lists all cache keys
*
* @return array|null Null if it isn't supported by the cache driver
*/
public function getAllKeys();
/**
2018-07-05 01:59:56 -04:00
* 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);
/**
2018-07-05 01:59:56 -04:00
* 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
2018-07-05 01:59:56 -04:00
* @param integer $ttl The cache lifespan, must be one of the Cache constants
*
* @return bool
*/
public function set($key, $value, $ttl = Cache::FIVE_MINUTES);
/**
2018-07-05 01:59:56 -04:00
* Delete a key from the cache
*
* @param string $key The cache key
*
* @return bool
*/
public function delete($key);
/**
2018-07-05 01:59:56 -04:00
* Remove outdated data from the cache
* @param boolean $outdated just remove outdated values
*
* @return bool
*/
public function clear($outdated = true);
}