RedisStore
extends TaggableStore
in package
implements
Store
Interfaces, Classes and Traits
Table of Contents
- $connection : string
- The Redis connection that should be used.
- $prefix : string
- A string that should be prepended to keys.
- $redis : Factory
- The Redis factory implementation.
- __construct() : void
- Create a new Redis store.
- add() : bool
- Store an item in the cache if the key doesn't exist.
- connection() : ClientInterface
- Get the Redis connection instance.
- decrement() : int
- Decrement the value of an item in the cache.
- flush() : bool
- Remove all items from the cache.
- forever() : void
- Store an item in the cache indefinitely.
- forget() : bool
- Remove an item from the cache.
- get() : mixed
- Retrieve an item from the cache by key.
- getPrefix() : string
- Get the cache key prefix.
- getRedis() : Factory
- Get the Redis database instance.
- increment() : int
- Increment the value of an item in the cache.
- lock() : Lock
- Get a lock instance.
- many() : array<string|int, mixed>
- Retrieve multiple items from the cache by key.
- put() : void
- Store an item in the cache for a given number of minutes.
- putMany() : void
- Store multiple items in the cache for a given number of minutes.
- setConnection() : void
- Set the connection name to be used.
- setPrefix() : void
- Set the cache key prefix.
- tags() : RedisTaggedCache
- Begin executing a new tags operation.
- serialize() : mixed
- Serialize the value.
- unserialize() : mixed
- Unserialize the value.
Properties
$connection
The Redis connection that should be used.
protected
string
$connection
$prefix
A string that should be prepended to keys.
protected
string
$prefix
$redis
The Redis factory implementation.
protected
Factory
$redis
Methods
__construct()
Create a new Redis store.
public
__construct(Factory $redis[, string $prefix = '' ][, string $connection = 'default' ]) : void
Parameters
- $redis : Factory
- $prefix : string = ''
- $connection : string = 'default'
Return values
void —add()
Store an item in the cache if the key doesn't exist.
public
add(string $key, mixed $value, float|int $minutes) : bool
Parameters
- $key : string
- $value : mixed
- $minutes : float|int
Return values
bool —connection()
Get the Redis connection instance.
public
connection() : ClientInterface
Return values
ClientInterface —decrement()
Decrement the value of an item in the cache.
public
decrement(string $key[, mixed $value = 1 ]) : int
Parameters
- $key : string
- $value : mixed = 1
Return values
int —flush()
Remove all items from the cache.
public
flush() : bool
Return values
bool —forever()
Store an item in the cache indefinitely.
public
forever(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Return values
void —forget()
Remove an item from the cache.
public
forget(string $key) : bool
Parameters
- $key : string
Return values
bool —get()
Retrieve an item from the cache by key.
public
get(string|array<string|int, mixed> $key) : mixed
Parameters
- $key : string|array<string|int, mixed>
Return values
mixed —getPrefix()
Get the cache key prefix.
public
getPrefix() : string
Return values
string —getRedis()
Get the Redis database instance.
public
getRedis() : Factory
Return values
Factory —increment()
Increment the value of an item in the cache.
public
increment(string $key[, mixed $value = 1 ]) : int
Parameters
- $key : string
- $value : mixed = 1
Return values
int —lock()
Get a lock instance.
public
lock(string $name, int $seconds) : Lock
Parameters
- $name : string
- $seconds : int
Return values
Lock —many()
Retrieve multiple items from the cache by key.
public
many(array<string|int, mixed> $keys) : array<string|int, mixed>
Items not found in the cache will have a null value.
Parameters
- $keys : array<string|int, mixed>
Return values
array<string|int, mixed> —put()
Store an item in the cache for a given number of minutes.
public
put(string $key, mixed $value, float|int $minutes) : void
Parameters
- $key : string
- $value : mixed
- $minutes : float|int
Return values
void —putMany()
Store multiple items in the cache for a given number of minutes.
public
putMany(array<string|int, mixed> $values, float|int $minutes) : void
Parameters
- $values : array<string|int, mixed>
- $minutes : float|int
Return values
void —setConnection()
Set the connection name to be used.
public
setConnection(string $connection) : void
Parameters
- $connection : string
Return values
void —setPrefix()
Set the cache key prefix.
public
setPrefix(string $prefix) : void
Parameters
- $prefix : string
Return values
void —tags()
Begin executing a new tags operation.
public
tags(array<string|int, mixed>|mixed $names) : RedisTaggedCache
Parameters
- $names : array<string|int, mixed>|mixed
Return values
RedisTaggedCache —serialize()
Serialize the value.
protected
serialize(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —unserialize()
Unserialize the value.
protected
unserialize(mixed $value) : mixed
Parameters
- $value : mixed