Redis Cache Adapter

Available Options

class (type: string, default: null)

Specifies the connection library to return, either \Redis, \Relay\Relay or \Predis\Client. If none is specified, fallback value is in following order, depending which one is available first: \Redis, \Relay\Relay, \Predis\Client. Explicitly set this to \Predis\Client for Sentinel if you are running into issues when retrieving master information.

persistent (type: int, default: 0)

Enables or disables use of persistent connections. A value of 0 disables persistent connections, and a value of 1 enables them.

persistent_id (type: string|null, default: null)

Specifies the persistent id string to use for a persistent connection.

timeout (type: int, default: 30)

Specifies the time (in seconds) used to connect to a Redis server before the connection attempt times out.

read_timeout (type: int, default: 0)

Specifies the time (in seconds) used when performing read operations on the underlying network resource before the operation times out.

retry_interval (type: int, default: 0)

Specifies the delay (in milliseconds) between reconnection attempts in case the client loses connection with the server.

tcp_keepalive (type: int, default: 0)

Specifies the TCP-keepalive timeout (in seconds) of the connection. This requires phpredis v4 or higher and a TCP-keepalive enabled server.

lazy (type: bool, default: null)

Enables or disables lazy connections to the backend. It's false by default when using this as a stand-alone component and true by default when using it inside a Symfony application.

redis_cluster (type: bool, default: false)

Enables or disables redis cluster. The actual value passed is irrelevant as long as it passes loose comparison checks: redis_cluster=1 will suffice.

redis_sentinel (type: string, default: null)

Specifies the master name connected to the sentinels.

sentinel_master (type: string, default: null)

Alias of redis_sentinel option.

dbindex (type: int, default: 0)

Specifies the database index to select.

failover (type: string, default: none)

Specifies failover for cluster implementations. For \RedisCluster valid options are none (default), error, distribute or slaves. For \Predis\ClientInterface valid options are slaves or distribute.

ssl (type: array, default: null)

SSL context options. See php.net/context.ssl for more information.

TagAwareMarshaller for Tag-Based Caching

Optimizes caching for tag-based retrieval, allowing efficient management of related items:

1
2
3
4
5
6
7

$marshaller = new TagAwareMarshaller();

$cache = new RedisAdapter($redis, 'tagged_namespace', 3600, $marshaller);

$item = $cache->getItem('tagged_key');
$item->set(['value' => 'some_data', 'tags' => ['tag1', 'tag2']]);
$cache->save($item);

SodiumMarshaller for Encrypted Caching

Encrypts cached data using Sodium for enhanced security:

1
2
3
4
5
6
7
8

$encryptionKeys = [sodium_crypto_box_keypair()];
$marshaller = new SodiumMarshaller($encryptionKeys);

$cache = new RedisAdapter($redis, 'secure_namespace', 3600, $marshaller);

$item = $cache->getItem('secure_key');
$item->set('confidential_data');
$cache->save($item);

DefaultMarshaller with igbinary Serialization

Uses ``igbinary` for faster and more efficient serialization when available:

1
2
3
4
5
6
7

$marshaller = new DefaultMarshaller(true);

$cache = new RedisAdapter($redis, 'optimized_namespace', 3600, $marshaller);

$item = $cache->getItem('optimized_key');
$item->set(['data' => 'optimized_data']);
$cache->save($item);

DefaultMarshaller with Exception on Failure

Throws an exception if serialization fails, facilitating error handling:

1
2
3
4
5
6
7
8
9
10
11

$marshaller = new DefaultMarshaller(false, true);

$cache = new RedisAdapter($redis, 'error_namespace', 3600, $marshaller);

try {
    $item = $cache->getItem('error_key');
    $item->set('data');
    $cache->save($item);
} catch (\ValueError $e) {
    echo 'Serialization failed: '.$e->getMessage();
}

SodiumMarshaller with Key Rotation

Supports key rotation, ensuring secure decryption with both old and new keys:

1
2
3
4
5
6
7
8

$keys = [sodium_crypto_box_keypair(), sodium_crypto_box_keypair()];
$marshaller = new SodiumMarshaller($keys);

$cache = new RedisAdapter($redis, 'rotated_namespace', 3600, $marshaller);

$item = $cache->getItem('rotated_key');
$item->set('data_to_encrypt');
$cache->save($item);