sfneal / redis-helpers

src/redis.php

<?php

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

/**
 * 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 bool $value
 */
function redisSet(string $key, $value = null, $expiration = null): bool
{
    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

Are you sure the doc-type for parameter $expiration is correct as it would always require null to be passed?

 * @return bool
 */
function redisExpire(string $key, $expiration = null): bool
{
    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 bool
 */
function redisCacheView(string $key, string $view, array $data, int $expiration = null): bool
{
    return RedisCache::set($key, View::make($view, $data)->render(), $expiration);
}

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

/**
 * 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  Closure  $callback
 * @param  int|null  $ttl
 * @return mixed
 */
function redisRemember(string $key, Closure $callback, int $ttl = null)
{
    return RedisCache::remember($key, $callback, $ttl);
}