strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Improve doc blocks in cache drivers

Browse source
This commit is contained in:
Hypolite Petovan 2018-09-25 22:51:41 -04:00
parent d1148f61ea
commit 640f76b05a
4 changed files with 48 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/Core/Cache/DatabaseCacheDriver.php
View file

@ -13,6 +13,9 @@ use Friendica\Util\DateTimeFormat;
*/ */
class DatabaseCacheDriver extends AbstractCacheDriver implements ICacheDriver class DatabaseCacheDriver extends AbstractCacheDriver implements ICacheDriver
{ {
/**
* (@inheritdoc)
*/
public function get($key) public function get($key)
{ {
$cache = DBA::selectFirst('cache', ['v'], ['`k` = ? AND `expires` >= ?', $key, DateTimeFormat::utcNow()]); $cache = DBA::selectFirst('cache', ['v'], ['`k` = ? AND `expires` >= ?', $key, DateTimeFormat::utcNow()]);
@ -32,6 +35,9 @@ class DatabaseCacheDriver extends AbstractCacheDriver implements ICacheDriver
return null; return null;
} }
/**
* (@inheritdoc)
*/
public function set($key, $value, $ttl = Cache::FIVE_MINUTES) public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
{ {
$fields = [ $fields = [
@ -43,11 +49,17 @@ class DatabaseCacheDriver extends AbstractCacheDriver implements ICacheDriver
return DBA::update('cache', $fields, ['k' => $key], true); return DBA::update('cache', $fields, ['k' => $key], true);
} }
/**
* (@inheritdoc)
*/
public function delete($key) public function delete($key)
{ {
return DBA::delete('cache', ['k' => $key]); return DBA::delete('cache', ['k' => $key]);
} }
/**
* (@inheritdoc)
*/
public function clear($outdated = true) public function clear($outdated = true)
{ {
if ($outdated) { if ($outdated) {

5
src/Core/Cache/MemcacheCacheDriver.php
View file

@ -22,6 +22,11 @@ class MemcacheCacheDriver extends AbstractCacheDriver implements IMemoryCacheDri
*/ */
private $memcache; private $memcache;
/**
* @param string $memcache_host
* @param int $memcache_port
* @throws Exception
*/
public function __construct($memcache_host, $memcache_port) public function __construct($memcache_host, $memcache_port)
{ {
if (!class_exists('Memcache', false)) { if (!class_exists('Memcache', false)) {

19
src/Core/Cache/MemcachedCacheDriver.php
View file

@ -53,6 +53,9 @@ class MemcachedCacheDriver extends AbstractCacheDriver implements IMemoryCacheDr
} }
} }
/**
* (@inheritdoc)
*/
public function get($key) public function get($key)
{ {
$return = null; $return = null;
@ -68,6 +71,9 @@ class MemcachedCacheDriver extends AbstractCacheDriver implements IMemoryCacheDr
return $return; return $return;
} }
/**
* (@inheritdoc)
*/
public function set($key, $value, $ttl = Cache::FIVE_MINUTES) public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
{ {
$cachekey = $this->getCacheKey($key); $cachekey = $this->getCacheKey($key);
@ -88,12 +94,18 @@ class MemcachedCacheDriver extends AbstractCacheDriver implements IMemoryCacheDr
} }
/**
* (@inheritdoc)
*/
public function delete($key) public function delete($key)
{ {
$cachekey = $this->getCacheKey($key); $cachekey = $this->getCacheKey($key);
return $this->memcached->delete($cachekey); return $this->memcached->delete($cachekey);
} }
/**
* (@inheritdoc)
*/
public function clear($outdated = true) public function clear($outdated = true)
{ {
if ($outdated) { if ($outdated) {
@ -104,12 +116,7 @@ class MemcachedCacheDriver extends AbstractCacheDriver implements IMemoryCacheDr
} }
/** /**
* @brief Sets a value if it's not already stored * (@inheritdoc)
*
* @param string $key The cache key
* @param mixed $value The old value we know from the cache
* @param int $ttl The cache lifespan, must be one of the Cache constants
* @return bool
*/ */
public function add($key, $value, $ttl = Cache::FIVE_MINUTES) public function add($key, $value, $ttl = Cache::FIVE_MINUTES)
{ {

18
src/Core/Cache/RedisCacheDriver.php
View file

@ -20,6 +20,11 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
*/ */
private $redis; private $redis;
/**
* @param string $redis_host
* @param int $redis_port
* @throws Exception
*/
public function __construct($redis_host, $redis_port) public function __construct($redis_host, $redis_port)
{ {
if (!class_exists('Redis', false)) { if (!class_exists('Redis', false)) {
@ -33,6 +38,9 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
} }
} }
/**
* (@inheritdoc)
*/
public function get($key) public function get($key)
{ {
$return = null; $return = null;
@ -55,6 +63,9 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
return $return; return $return;
} }
/**
* (@inheritdoc)
*/
public function set($key, $value, $ttl = Cache::FIVE_MINUTES) public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
{ {
$cachekey = $this->getCacheKey($key); $cachekey = $this->getCacheKey($key);
@ -75,12 +86,18 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
} }
} }
/**
* (@inheritdoc)
*/
public function delete($key) public function delete($key)
{ {
$cachekey = $this->getCacheKey($key); $cachekey = $this->getCacheKey($key);
return ($this->redis->delete($cachekey) > 0); return ($this->redis->delete($cachekey) > 0);
} }
/**
* (@inheritdoc)
*/
public function clear($outdated = true) public function clear($outdated = true)
{ {
if ($outdated) { if ($outdated) {
@ -127,6 +144,7 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
$this->redis->unwatch(); $this->redis->unwatch();
return false; return false;
} }
/** /**
* (@inheritdoc) * (@inheritdoc)
*/ */