yiisoft/cache-redis

Yii Caching Library - Redis Handler

2.0.0 2023-07-10 16:05 UTC

This package is auto-updated.

Last update: 2024-02-18 14:17:31 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Caching Library - Redis Handler


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

This package provides the Redis handler and implements PSR-16 cache.

Requirements

  • PHP 8.0 or higher.

Installation

The package could be installed with composer:

composer require yiisoft/cache-redis

General usage

For more information about the client instance and connection configuration, see the documentation of the predis/predis package.

/**
 * @var \Predis\ClientInterface $client Predis client instance to use.
 */
$cache = new \Yiisoft\Cache\Redis\RedisCache($client);

The package does not contain any additional functionality for interacting with the cache, except those defined in the PSR-16 interface.

$parameters = ['user_id' => 42];
$key = 'demo';

// try retrieving $data from cache
$data = $cache->get($key);

if ($data === null) {
    // $data is not found in cache, calculate it from scratch
    $data = calculateData($parameters);
    
    // store $data in cache for an hour so that it can be retrieved next time
    $cache->set($key, $data, 3600);
}

// $data is available here

In order to delete value you can use:

$cache->delete($key);
// Or all cache
$cache->clear();

To work with values in a more efficient manner, batch operations should be used:

  • getMultiple()
  • setMultiple()
  • deleteMultiple()

This package can be used as a cache handler for the Yii Caching Library.

Redis cluster supported

The package implements Redis cluster support via Predis package.

For example, if your cluster configuration has three master nodes and three slave nodes, your client configuration might look like this:

$client = new \Predis\Client([
        ['host' => 'redis-node-1', 'port' => 'redis-node-port-1',],
        ['host' => 'redis-node-2', 'port' => 'redis-node-port-2',],
        ['host' => 'redis-node-3', 'port' => 'redis-node-port-3',],
        ['host' => 'redis-node-4', 'port' => 'redis-node-port-4',],
        ['host' => 'redis-node-5', 'port' => 'redis-node-port-5',],
        ['host' => 'redis-node-6', 'port' => 'redis-node-port-6',],
    ],
    [
        'cluster' => 'redis',
        'parameters' => [
            'password' => 'Password',
        ],
    ]
);
$cache = new \Yiisoft\Cache\Redis\RedisCache($client);

Predis will route commands on its own when specifying Redis nodes in the cluster to the appropriate nodes depending on the keys that are specified in the commands.

You can implement \Predis\Distribution\DistributorInterface to create their own distributors used by the client to distribute keys among a cluster of servers.

Then your config might look like this:

$client = new \Predis\Client([
        ['host' => 'redis-node-1', 'port' => 'redis-node-port-1',],
        ['host' => 'redis-node-2', 'port' => 'redis-node-port-2',],
        ['host' => 'redis-node-3', 'port' => 'redis-node-port-3',],
        ['host' => 'redis-node-4', 'port' => 'redis-node-port-4',],
        ['host' => 'redis-node-5', 'port' => 'redis-node-port-5',],
        ['host' => 'redis-node-6', 'port' => 'redis-node-port-6',],
    ],
    [
        'cluster' => static function () {
            $distributor = new \CustomDistributor(); // Your custom distributor
            $strategy = new \Predis\Cluster\PredisStrategy($distributor);

            return new \Predis\Connection\Cluster\PredisCluster($strategy);
        },
        'parameters' => [
            'password' => 'Password',
        ],
    ]
);

Testing

The tests use a connection to a running Redis cluster. If you are not using Docker, you must start the cluster yourself before running the tests.

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Testing in Docker

Prepare

# {{ v }} = 8.0, 8.1, 8.2. Default PHP 8.1
make build v=8.1

Unit testing

# {{ v }} = 8.0, 8.1, 8.2. Default PHP 8.1
make test v=8.1

Mutation testing

# {{ v }} = 8.0, 8.1, 8.2. Default PHP 8.1
make mutation-test v=8.0

License

The Yii Caching Library - Redis Handler is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack