chore: cs fixer lint

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2025-09-11 16:57:29 -04:00 committed by GitHub
parent 017cc910fc
commit a3be015fda
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -15,25 +15,25 @@ class APCu extends Cache implements IMemcache {
}
use CADTrait;
/**
* Fetches a value from the cache.
*
* @param string $key
* @return mixed|null Value if found, null otherwise
*/
/**
* Fetches a value from the cache.
*
* @param string $key
* @return mixed|null Value if found, null otherwise
*/
public function get($key) {
$result = apcu_fetch($this->getPrefix() . $key, $success);
return $success ? $result : null;
}
/**
* Stores a value in the cache.
*
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24 (24h)
* @return bool
*/
/**
* Stores a value in the cache.
*
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24 (24h)
* @return bool
*/
public function set($key, $value, $ttl = 0) {
if ($ttl === 0) {
$ttl = self::DEFAULT_TTL;
@ -41,41 +41,41 @@ class APCu extends Cache implements IMemcache {
return apcu_store($this->getPrefix() . $key, $value, $ttl) === true;
}
/**
* Checks if a given key exists in the cache.
*
* @param string $key
* @return bool
*/
/**
* Checks if a given key exists in the cache.
*
* @param string $key
* @return bool
*/
public function hasKey($key) {
return apcu_exists($this->getPrefix() . $key) === true;
}
/**
* Removes a value from the cache.
*
* @param string $key
* @return bool
*/
/**
* Removes a value from the cache.
*
* @param string $key
* @return bool
*/
public function remove($key) {
return apcu_delete($this->getPrefix() . $key) !== false;
}
/**
* Clears all cache entries that match the given prefix.
*
* @param string $prefix
* @return bool
*/
* Clears all cache entries that match the given prefix.
*
* @param string $prefix
* @return bool
*/
public function clear($prefix = '') {
/**
* Note: Prefixes/namespaces in caching are currently inconsistent/confusing.
* There are multiple levels (instance, user, app/use case) which may overlap.
* Also, other implementations (e.g., MemCached) clear everything regardless
* Note: Prefixes/namespaces in caching are currently inconsistent/confusing.
* There are multiple levels (instance, user, app/use case) which may overlap.
* Also, other implementations (e.g., MemCached) clear everything regardless
* of prefix.
* TODO: Standardize prefix naming and document any differences across cache
* TODO: Standardize prefix naming and document any differences across cache
* backends.
*/
*/
$combinedNamespace = preg_quote($this->getPrefix() . $prefix, '/');
$iterator = new \APCUIterator(
// only care about keys that start with our $combinedNamespace
@ -86,14 +86,14 @@ class APCu extends Cache implements IMemcache {
return apcu_delete($iterator) !== false;
}
/**
* Adds a key to the cache only if it does not already exist.
*
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24 (24h)
* @return bool False if key already exists (new value is ignored)
*/
/**
* Adds a key to the cache only if it does not already exist.
*
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24 (24h)
* @return bool False if key already exists (new value is ignored)
*/
public function add($key, $value, $ttl = 0) {
if ($ttl === 0) {
$ttl = self::DEFAULT_TTL;
@ -101,50 +101,50 @@ class APCu extends Cache implements IMemcache {
return apcu_add($this->getPrefix() . $key, $value, $ttl) === true;
}
/**
* Increments a stored number.
*
* If the key does not exist, it is created and set to `0` before
/**
* Increments a stored number.
*
* If the key does not exist, it is created and set to `0` before
* performing the increment (i.e. returning a value of `1`).
*
* The TTL is left alone on preexisting keys, but newly created keys
*
* The TTL is left alone on preexisting keys, but newly created keys
* automatically get assigned a TTL of self::DEFAULT_TTL.
*
* @param string $key
* @param int $step
* @return int|bool New value on success, false on failure
*/
*
* @param string $key
* @param int $step
* @return int|bool New value on success, false on failure
*/
public function inc($key, $step = 1) {
$success = null; // don't care
return apcu_inc($this->getPrefix() . $key, $step, $success, self::DEFAULT_TTL);
}
/**
* Decrements a stored number.
/**
* Decrements a stored number.
*
* If the key does not exist, false is returned and the operation
* If the key does not exist, false is returned and the operation
* does not take place. This differs from `inc()` above for unknown reasons,
* but it does match the interface and other implementations.
*
* @param string $key
* @param int $step
* @return int|bool New value on success, false if key does not exist
*/
* but it does match the interface and other implementations.
*
* @param string $key
* @param int $step
* @return int|bool New value on success, false if key does not exist
*/
public function dec($key, $step = 1) {
return $this->hasKey($key) ? apcu_dec($this->getPrefix() . $key, $step) : false;
}
/**
* Compare and set operation (CAS).
* Compare and set operation (CAS).
*
* Sets $key's value to $new IF its current value matches $old.
* Uses APCu native CAS for integers, otherwise falls back to emulated CAS.
*
* @param string $key
* @param mixed $old
* @param mixed $new
* @return bool
*/
* Sets $key's value to $new IF its current value matches $old.
* Uses APCu native CAS for integers, otherwise falls back to emulated CAS.
*
* @param string $key
* @param mixed $old
* @param mixed $new
* @return bool
*/
public function cas($key, $old, $new) {
// APCu only does cas for ints
if (is_int($old) && is_int($new)) {
@ -154,11 +154,11 @@ class APCu extends Cache implements IMemcache {
}
}
/**
* Checks if APCu is usable.
*
* @return bool
*/
/**
* Checks if APCu is usable.
*
* @return bool
*/
public static function isAvailable(): bool {
return function_exists('apcu_enabled')
&& apcu_enabled()