class RedisCache extends AbstractCache

deprecated since Symfony 4.3, use RedisAdapter and type-hint for CacheInterface instead.

Traits

LoggerAwareTrait

Properties

protected int|null $maxIdLength from AbstractTrait

Methods

array|Traversable
doFetch(array $ids)

Fetches several cache items.

bool
doHave(string $id)

Confirms if the cache contains specified cache item.

bool
doClear(string $namespace)

Deletes all items in the pool.

bool
doDelete(array $ids)

Removes multiple items from the pool.

array|bool
doSave(array $values, int $lifetime)

Persists several cache items immediately.

hasItem($key)

{@inheritdoc}

clear()

{@inheritdoc}

deleteItem($key)

{@inheritdoc}

deleteItems(array $keys)

{@inheritdoc}

bool
enableVersioning(bool $enable = true)

Enables/disables versioning of items.

reset()

{@inheritdoc}

static mixed
unserialize(string $value) deprecated

Like the native unserialize() function but throws an exception if anything goes wrong.

static 
handleUnserializeCallback($class)

No description

__construct($redisClient, string $namespace = '', int $defaultLifetime = 0, MarshallerInterface $marshaller = null)

No description

get($key, $default = null)

{@inheritdoc}

set($key, $value, $ttl = null)

{@inheritdoc}

getMultiple($keys, $default = null)

{@inheritdoc}

setMultiple($values, $ttl = null)

{@inheritdoc}

deleteMultiple($keys)

{@inheritdoc}

static Redis|RedisCluster|Client
createConnection(string $dsn, array $options = [])

Creates a Redis connection using a DSN configuration.

Details

in AbstractTrait at line 44
abstract protected array|Traversable doFetch(array $ids)

Fetches several cache items.

Parameters

array $ids The cache identifiers to fetch

Return Value

array|Traversable The corresponding values found in the cache

in AbstractTrait at line 53
abstract protected bool doHave(string $id)

Confirms if the cache contains specified cache item.

Parameters

string $id The identifier for which to check existence

Return Value

bool True if item exists in the cache, false otherwise

in AbstractTrait at line 62
abstract protected bool doClear(string $namespace)

Deletes all items in the pool.

Parameters

string $namespace The prefix used for all identifiers managed by this pool

Return Value

bool True if the pool was successfully cleared, false otherwise

in AbstractTrait at line 71
abstract protected bool doDelete(array $ids)

Removes multiple items from the pool.

Parameters

array $ids An array of identifiers that should be removed from the pool

Return Value

bool True if the items were successfully removed, false otherwise

in AbstractTrait at line 81
abstract protected array|bool doSave(array $values, int $lifetime)

Persists several cache items immediately.

Parameters

array $values The values to cache, indexed by their cache identifier
int $lifetime The lifetime of the cached values, 0 for persisting until manual cleaning

Return Value

array|bool The identifiers that failed to be cached or a boolean stating if caching succeeded or not

in AbstractTrait at line 86
hasItem($key)

{@inheritdoc}

Parameters

$key

in AbstractTrait at line 106
clear()

{@inheritdoc}

in AbstractTrait at line 134
deleteItem($key)

{@inheritdoc}

Parameters

$key

in AbstractTrait at line 142
deleteItems(array $keys)

{@inheritdoc}

Parameters

array $keys

in AbstractTrait at line 188
bool enableVersioning(bool $enable = true)

Enables/disables versioning of items.

When versioning is enabled, clearing the cache is atomic and doesn't require listing existing keys to proceed, but old keys may need garbage collection and extra round-trips to the back-end are required.

Calling this method also clears the memoized namespace version and thus forces a resynchonization of it.

Parameters

bool $enable

Return Value

bool the previous state of versioning

in AbstractTrait at line 201
reset()

{@inheritdoc}

in AbstractTrait at line 221
static protected mixed unserialize(string $value) deprecated

deprecated since Symfony 4.2, use DefaultMarshaller instead.

Like the native unserialize() function but throws an exception if anything goes wrong.

Parameters

string $value

Return Value

mixed

Exceptions

Exception

in AbstractTrait at line 279
static handleUnserializeCallback($class)

Parameters

$class

at line 33
__construct($redisClient, string $namespace = '', int $defaultLifetime = 0, MarshallerInterface $marshaller = null)

Parameters

$redisClient
string $namespace
int $defaultLifetime
MarshallerInterface $marshaller

in AbstractCache at line 50
get($key, $default = null)

{@inheritdoc}

Parameters

$key
$default

in AbstractCache at line 68
set($key, $value, $ttl = null)

{@inheritdoc}

Parameters

$key
$value
$ttl

in AbstractCache at line 78
getMultiple($keys, $default = null)

{@inheritdoc}

Parameters

$keys
$default

in AbstractCache at line 104
setMultiple($values, $ttl = null)

{@inheritdoc}

Parameters

$values
$ttl

in AbstractCache at line 140
deleteMultiple($keys)

{@inheritdoc}

Parameters

$keys

in RedisTrait at line 81
static Redis|RedisCluster|Client createConnection(string $dsn, array $options = [])

Creates a Redis connection using a DSN configuration.

Example DSN: - redis://localhost - redis://example.com:1234 - redis://secret@example.com/13 - redis:///var/run/redis.sock - redis://secret@/var/run/redis.sock/13

Parameters

string $dsn
array $options See self::$defaultConnectionOptions

Return Value

Redis|RedisCluster|Client According to the "class" option

Exceptions

InvalidArgumentException when the DSN is invalid