redisKeys() - Code Metrics - Inspection of "Merge pull request #6 from sfneal/dev" - sfneal/redis-helpers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 71f2f4...c227b6 )

by Stephen

created 2021-01-26 17:26 UTC

redisKeys() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

<?php

use Illuminate\Support\Facades\View;
use Sfneal\Helpers\Redis\RedisCache;

/**
 * Retrieve a formatted RedisKey with the environment prefix included.
 *
 * @param string $key
 * @return string
 */
function redisKey(string $key): string
{
    return RedisCache::key($key);
}

/**
 * Get items from the cache.
 *
 * @param string $key
 * @return mixed
 */
function redisGet(string $key)
{
    return RedisCache::get($key);
}

/**
 * Put items in the cache with a TTL.
 *
 * Use's environment's REDIS_KEY_EXPIRATION value if $expiration is null.
 *
 * @param string $key
 * @param mixed|null $value
 * @param int|null $expiration
 * @return mixed|null $value
 */
function redisSet(string $key, $value = null, $expiration = null)
{
    return RedisCache::set($key, $value, $expiration);
}

/**
 * Add a TTL attribute (time to live or time til expiration) to a Redis key.
 *
 * @param string $key
 * @param null $expiration

 * @return mixed
 */
function redisExpire(string $key, $expiration = null)
{
    return RedisCache::expire($key, $expiration);
}

/**
 * Delete Redis key's from the Cache.
 *
 * @param $key array|string
 * @return array
 */
function redisDelete($key): array
{
    return RedisCache::delete($key);
}

/**
 * Determine if a redis key exists in the cache.
 *
 * @param string $key
 * @return bool
 */
function redisExists(string $key): bool
{
    return RedisCache::exists($key);
}

/**
 * Determine if a redis key is missing from the cache.
 *
 * @param string $key
 * @return bool
 */
function redisMissing(string $key): bool
{
    return RedisCache::missing($key);
}

/**
 * Render a view & cache its output for reuse.
 *
 * @param string $key
 * @param string $view
 * @param array $data
 * @param int|null $expiration
 * @return mixed|null
 */
function redisCacheView(string $key, string $view, array $data, int $expiration = null)
{
    return RedisCache::set($key, View::make($view, $data)->render(), $expiration);
}

/**
 * Create a Redis Key with a null value if it is missing.
 *
 * @param string $key
 * @param null $value

 * @param int|null $expiration
 * @return bool
 */
function redisCreateIfMissing(string $key, $value = null, int $expiration = null): bool
{
    return RedisCache::setIfMissing($key, $value, $expiration);
    return RedisCache::setIfMissing($key, $value, /** @scrutinizer ignore-type */ $expiration);
}

/**
 * Increment a Redis Key's value & return the new value.
 *
 * @param string $key
 * @param int $value
 * @param int|null $expiration
 * @return mixed
 */
function redisIncrement(string $key, int $value = 1, int $expiration = null)
{
    return RedisCache::increment($key, $value, $expiration);
}

/**
 * Flush the entire redis cache.
 *
 * @return mixed
 */
function redisFlush()
{
    return RedisCache::flush();
}

/**
 * Flush the redis cache of all keys with environment's prefix.
 *
 * @return array
 */
function redisClearCache(): array
{
    return RedisCache::clear();
}

/**
 * Pass a $callback function to be stored in the Cache for an amount of time.
 *
 * @param string $key
 * @param int $ttl
 * @param Closure $callback
 * @return mixed
 */
function redisRemember(string $key, int $ttl, Closure $callback)
{
    return RedisCache::remember($key, $ttl, $callback);
}

/**
 * Pass a $callback function to be stored in the Cache forever.
 *
 * @param string $key
 * @param Closure $callback
 * @return mixed
 */
function redisRememberForever(string $key, Closure $callback)
{
    return RedisCache::rememberForever($key, $callback);
}


sfneal / redis-helpers

Push — master ( 71f2f4...c227b6 )

redisKeys() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like