PHPackages                             yiisoft/cache-redis - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/cache-redis

ActiveLibrary[Framework](/categories/framework)

yiisoft/cache-redis
===================

Yii Caching Library - Redis Handler

2.0.0(2y ago)1016.4k↓49.3%5[1 issues](https://github.com/yiisoft/cache-redis/issues)[1 PRs](https://github.com/yiisoft/cache-redis/pulls)1BSD-3-ClausePHPPHP ^8.0CI passing

Since Nov 7Pushed 1w ago11 watchersCompare

[ Source](https://github.com/yiisoft/cache-redis)[ Packagist](https://packagist.org/packages/yiisoft/cache-redis)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-cache-redis/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (1)Dependencies (8)Versions (6)Used By (1)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Caching Library - Redis Handler
===================================

[](#yii-caching-library---redis-handler)

[![Latest Stable Version](https://camo.githubusercontent.com/e148858443ed7abd6fa913eea0e3584d358def0dc076e5dee85543e8e34e6aa1/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d72656469732f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/cache-redis)[![Total Downloads](https://camo.githubusercontent.com/b386a40c3635bdcde27b3861ec0a8382616befde9c4788bec5731c57e987a840/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d72656469732f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/cache-redis)[![Build status](https://github.com/yiisoft/cache-redis/workflows/Run%20tests/badge.svg)](https://github.com/yiisoft/cache-redis/actions?query=workflow%3ARun+tests)[![Code Coverage](https://camo.githubusercontent.com/a7745ce2c2b37daf6819a09aafd48f37679be1c258d10f686480b6f0b6b5a246/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f63616368652d72656469732f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/cache-redis/?branch=master)[![Mutation testing badge](https://camo.githubusercontent.com/3a0a98512d5e273513a98b9721b637be8264bc9ac20dc03c5d8288a816bfcb25/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324663616368652d72656469732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-redis/master)[![static analysis](https://github.com/yiisoft/cache-redis/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/cache-redis/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/a4fca02eabdeb7e3fece0183798ccf489057703ad2a27610129174035f2a5d6a/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f63616368652d72656469732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/cache-redis)

This package provides the [Redis](https://redis.io/) handler and implements [PSR-16](https://www.php-fig.org/psr/psr-16/) cache.

Requirements
------------

[](#requirements)

- PHP 8.1 or higher.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/cache-redis
```

General usage
-------------

[](#general-usage)

For more information about the client instance and connection configuration, see the documentation of the [predis/predis](https://github.com/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](https://www.php-fig.org/psr/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](https://github.com/yiisoft/cache).

Redis cluster supported
-----------------------

[](#redis-cluster-supported)

The package implements [Redis cluster](https://redis.io/docs/management/scaling/) 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',
        ],
    ]
);
```

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Caching Library - Redis Handler is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

48

—

FairBetter than 93% of packages

Maintenance62

Regular maintenance activity

Popularity35

Limited adoption so far

Community27

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~609 days

Total

2

Last Release

1089d ago

Major Versions

1.0.0 → 2.0.02023-07-10

PHP version history (2 changes)1.0.0PHP ^7.4|^8.0

2.0.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (7 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (7 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (5 commits)")[![s1lver](https://avatars.githubusercontent.com/u/4567634?v=4)](https://github.com/s1lver "s1lver (4 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![dehbka](https://avatars.githubusercontent.com/u/16839017?v=4)](https://github.com/dehbka "dehbka (1 commits)")

---

Tags

cachehacktoberfestpsr-16redisredis-cacheyii3frameworkrediscachepsr-16yii

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-cache-redis/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-cache-redis/health.svg)](https://phpackages.com/packages/yiisoft-cache-redis)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.8k543.8M20.1k](/packages/laravel-framework)[cakephp/cakephp

The CakePHP framework

8.9k19.5M1.8k](/packages/cakephp-cakephp)[unopim/unopim

UnoPim Laravel PIM

10.5k2.4k](/packages/unopim-unopim)[oro/platform

Business Application Platform (BAP)

645143.5k115](/packages/oro-platform)[yiisoft/cache-file

Yii Caching Library - File Handler

13705.7k9](/packages/yiisoft-cache-file)[yiisoft/cache

Yii Caching Library

48956.1k33](/packages/yiisoft-cache)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)