friendica/src/Core/Cache/ICache.php

68 lines
1.4 KiB
PHP
Raw Normal View History

<?php
namespace Friendica\Core\Cache;
/**
* Cache Interface
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
interface ICache
{
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
*
* @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
*/
public function getAllKeys($prefix = null);
2018-09-25 22:52:32 -04:00
/**
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
* @param integer $ttl The cache lifespan, must be one of the Cache constants
*
* @return bool
*/
public function set($key, $value, $ttl = self::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);
}