W3cubDocs

/Laravel 11

RedisStore

class RedisStore extends TaggableStore implements LockProvider (View source)

Properties

protected Factory $redis

The Redis factory implementation.
protected string $prefix

A string that should be prepended to keys.
protected string $connection

The Redis connection instance that should be used to manage locks.
protected string $lockConnection

The name of the connection that should be used for locks.

Methods

TaggedCache tags(array|mixed $names)

Begin executing a new tags operation.
void __construct(Factory $redis, string $prefix = '', string $connection = 'default')

Create a new Redis store.
mixed get(string $key)

Retrieve an item from the cache by key.
array many(array $keys)

Retrieve multiple items from the cache by key.
bool put(string $key, mixed $value, int $seconds)

Store an item in the cache for a given number of seconds.
bool putMany(array $values, int $seconds)

Store multiple items in the cache for a given number of seconds.
bool add(string $key, mixed $value, int $seconds)

Store an item in the cache if the key doesn't exist.
int|bool increment(string $key, mixed $value = 1)

Increment the value of an item in the cache.
int|bool decrement(string $key, mixed $value = 1)

Decrement the value of an item in the cache.
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.
Lock lock(string $name, int $seconds = 0, string|null $owner = null)

Get a lock instance.
Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.
bool forget(string $key)

Remove an item from the cache.
bool flush()

Remove all items from the cache.
void flushStaleTags()

Remove all expired tag set entries.
LazyCollection currentTags(int $chunkSize = 1000)

Get a collection of all of the cache tags currently being used.
Connection connection()

Get the Redis connection instance.
Connection lockConnection()

Get the Redis connection instance that should be used to manage locks.
void setConnection(string $connection)

Specify the name of the connection that should be used to store data.
$this setLockConnection(string $connection)

Specify the name of the connection that should be used to manage locks.
Factory getRedis()

Get the Redis database instance.
string getPrefix()

Get the cache key prefix.
void setPrefix(string $prefix)

Set the cache key prefix.
mixed serialize(mixed $value)

Serialize the value.
mixed unserialize(mixed $value)

Unserialize the value.

Details

TaggedCache tags(array|mixed $names)

Begin executing a new tags operation.

Parameters

array|mixed $names

Return Value

TaggedCache

void __construct(Factory $redis, string $prefix = '', string $connection = 'default')

Create a new Redis store.

Parameters

Factory $redis
string $prefix
string $connection

Return Value

void

mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

array many(array $keys)

Retrieve multiple items from the cache by key.

Items not found in the cache will have a null value.

Parameters

array $keys

Return Value

array

bool put(string $key, mixed $value, int $seconds)

Store an item in the cache for a given number of seconds.

Parameters

string $key
mixed $value
int $seconds

Return Value

bool

bool putMany(array $values, int $seconds)

Store multiple items in the cache for a given number of seconds.

Parameters

array $values
int $seconds

Return Value

bool

bool add(string $key, mixed $value, int $seconds)

Store an item in the cache if the key doesn't exist.

Parameters

string $key
mixed $value
int $seconds

Return Value

bool

int|bool increment(string $key, mixed $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

int|bool decrement(string $key, mixed $value = 1)

Decrement the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

Lock lock(string $name, int $seconds = 0, string|null $owner = null)

Get a lock instance.

Parameters

string $name
int $seconds
string|null $owner

Return Value

Lock

Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

Return Value

Lock

bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

bool flush()

Remove all items from the cache.

Return Value

bool

void flushStaleTags()

Remove all expired tag set entries.

Return Value

void

protected LazyCollection currentTags(int $chunkSize = 1000)

Get a collection of all of the cache tags currently being used.

Parameters

int $chunkSize

Return Value

LazyCollection

Connection connection()

Get the Redis connection instance.

Return Value

Connection

Connection lockConnection()

Get the Redis connection instance that should be used to manage locks.

Return Value

Connection

void setConnection(string $connection)

Specify the name of the connection that should be used to store data.

Parameters

string $connection

Return Value

void

$this setLockConnection(string $connection)

Specify the name of the connection that should be used to manage locks.

Parameters

string $connection

Return Value

$this

Factory getRedis()

Get the Redis database instance.

Return Value

Factory

string getPrefix()

Get the cache key prefix.

Return Value

string

void setPrefix(string $prefix)

Set the cache key prefix.

Parameters

string $prefix

Return Value

void

protected mixed serialize(mixed $value)

Serialize the value.

Parameters

mixed $value

Return Value

mixed

protected mixed unserialize(mixed $value)

Unserialize the value.

Parameters

mixed $value

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Cache/RedisStore.html