friendica/src/Core/Cache.php

144 lines
3.1 KiB
PHP
Raw Normal View History

<?php
/**
* @file src/Core/Cache.php
*/
namespace Friendica\Core;
2019-03-03 15:05:35 +01:00
use Friendica\Factory\CacheDriverFactory;
/**
* @brief Class for storing data for a short time
*/
2018-03-01 06:33:56 +01:00
class Cache extends \Friendica\BaseObject
{
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;
2018-10-29 10:21:10 +01:00
const INFINITE = 0;
/**
* @var Cache\ICacheDriver
*/
private static $driver = null;
public static $driver_class = null;
public static $driver_name = null;
public static function init()
{
self::$driver_name = Config::get('system', 'cache_driver', 'database');
self::$driver = CacheDriverFactory::create(self::$driver_name);
self::$driver_class = get_class(self::$driver);
}
/**
* Returns the current cache driver
*
* @return Cache\ICacheDriver
*/
private static function getDriver()
{
if (self::$driver === null) {
self::init();
}
return self::$driver;
}
2018-09-26 04:52:32 +02:00
/**
* @brief Returns all the cache keys sorted alphabetically
*
* @param string $prefix Prefix of the keys (optional)
*
2018-10-07 22:14:05 +02:00
* @return array Empty if the driver doesn't support this feature
2019-01-06 22:06:53 +01:00
* @throws \Exception
2018-09-26 04:52:32 +02:00
*/
public static function getAllKeys($prefix = null)
2018-09-26 04:52:32 +02:00
{
$time = microtime(true);
$return = self::getDriver()->getAllKeys($prefix);
2018-09-26 04:52:32 +02:00
self::getApp()->getProfiler()->saveTimestamp($time, 'cache', System::callstack());
2018-09-26 04:52:32 +02:00
return $return;
}
/**
* @brief Fetch cached data according to the key
*
* @param string $key The key to the cached data
*
* @return mixed Cached $value or "null" if not found
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public static function get($key)
{
2018-03-01 06:33:56 +01:00
$time = microtime(true);
$return = self::getDriver()->get($key);
self::getApp()->getProfiler()->saveTimestamp($time, 'cache', System::callstack());
2018-03-01 06:33:56 +01:00
return $return;
}
/**
* @brief Put data in the cache according to the key
*
* The input $value can have multiple formats.
*
* @param string $key The key to the cached data
* @param mixed $value The value that is about to be stored
* @param integer $duration The cache lifespan
*
* @return bool
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public static function set($key, $value, $duration = self::MONTH)
{
2018-03-01 06:33:56 +01:00
$time = microtime(true);
$return = self::getDriver()->set($key, $value, $duration);
self::getApp()->getProfiler()->saveTimestamp($time, 'cache_write', System::callstack());
2018-03-01 06:33:56 +01:00
return $return;
}
2018-03-17 02:57:58 +01:00
/**
* @brief Delete a value from the cache
*
* @param string $key The key to the cached data
*
* @return bool
2019-01-06 22:06:53 +01:00
* @throws \Exception
2018-03-17 02:57:58 +01:00
*/
public static function delete($key)
{
$time = microtime(true);
$return = self::getDriver()->delete($key);
self::getApp()->getProfiler()->saveTimestamp($time, 'cache_write', System::callstack());
2018-03-17 02:57:58 +01:00
return $return;
}
/**
* @brief Remove outdated data from the cache
*
* @param boolean $outdated just remove outdated values
*
2019-01-06 22:06:53 +01:00
* @return bool
*/
public static function clear($outdated = true)
{
return self::getDriver()->clear($outdated);
}
}