added support for predis

.github/workflows/build.yml

@@ -31,49 +31,16 @@ jobs:
           - ubuntu-latest
 
         php:
-          - 8.1
-          - 8.2
-          - 8.3
-          - 8.4
-
-        redis:
-          - 6
-          - 7
-          - 8
-
-    services:
-      redis:
-        image: redis:${{ matrix.redis }}
-        ports:
-          - 6379:6379
-        options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=5
+          - "8.1"
+          - "8.2"
+          - "8.3"
+          - "8.4"
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install PHP with extensions
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          extensions: curl, intl, redis
-          ini-values: date.timezone='UTC'
-          tools: composer:v2, pecl
-
-      - name: Install dependencies with Composer
-        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader
-
-      - name: Run tests with phpunit.
-        if: matrix.php != '8.1'
-        run: vendor/bin/phpunit --colors=always
-
-      - name: Run tests with phpunit and generate coverage.
-        if: matrix.php == '8.1'
-        run: vendor/bin/phpunit --coverage-clover=coverage.xml --colors=always
+        uses: actions/checkout@v2
 
-      - name: Upload coverage to Codecov.
-        if: matrix.php == '8.1'
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./coverage.xml
+      - name: PHP tests for PHP ${{ matrix.php }}
+        run: |
+          ls -al
+          make test-sentinel v=${{ matrix.php }}

CHANGELOG.md

@@ -1,9 +1,19 @@
 Yii Framework 2 redis extension Change Log
 ==========================================
 
-2.0.20 under development
+2.0.21 under development
 ------------------------
 
+- New #276: Added support for predis (antonshevelev)
+- New #276: Changed default value of yii\redis\Cache::$forceClusterMode to false (antonshevelev)
+- New #276: Implemented yii\redis\ConnectionInterface in yii\redis\Connection (antonshevelev)
+- New #276: Updated minimum required PHP version to 8.1 (antonshevelev)
+
+
+2.0.20 June 05, 2025
+--------------------
+
+- Bug CVE-2025-48493: Prevent logging `AUTH` parameters when `YII_DEBUG` is off (samdark)
 - Bug #270: Prevent null parameter on `mb_strlen` to avoid PHP 8.4 implicity nullable types deprecation (tehmaestro)
 
 

Makefile

@@ -35,3 +35,15 @@ clean:
 	docker rm $(shell cat tests/dockerids/redis)
 	rm tests/dockerids/redis
 
+test-sentinel:
+	make build
+	PHP_VERSION=$(filter-out $@,$(MAKECMDGOALS)) docker compose -f tests/docker/docker-compose.yml build --pull yii2-redis-php
+	PHP_VERSION=$(filter-out $@,$(MAKECMDGOALS)) docker compose -f tests/docker/docker-compose.yml up -d
+	PHP_VERSION=$(filter-out $@,$(MAKECMDGOALS)) docker compose -f tests/docker/docker-compose.yml exec yii2-redis-php sh -c "composer update && vendor/bin/phpunit --coverage-clover=coverage.clover"
+
+build:			## Build an image from a docker-compose file. Params: {{ v=8.1 }}. Default latest PHP 8.1
+	PHP_VERSION=$(filter-out $@,$(v)) docker compose -f tests/docker/docker-compose.yml up -d --build
+
+down:			## Stop and remove containers, networks
+	docker compose -f tests/docker/docker-compose.yml down
+

README.md

@@ -100,3 +100,8 @@ return [
     ]
 ];
 ```
+
+Additional topics
+-----------------
+
+* [predis support](predis.md)

composer.json

@@ -25,11 +25,12 @@
     ],
     "require": {
         "php": ">=8.1",
+        "yiisoft/yii2": "22.0.x-dev",
         "ext-openssl": "*",
-        "yiisoft/yii2": "22.0.x-dev"
+        "predis/predis": "^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.6"
+        "phpunit/phpunit": "9.*"
     },
     "autoload": {
         "psr-4": { "yii\\redis\\": "src" }

docs/guide-ja/README.md

@@ -9,6 +9,7 @@ Yii 2 Redis キャッシュ、セッションおよびアクティブレコー
 --------
 
 * [インストール](installation.md)
+* [Predisサポート](predis.md)
 
 使用方法
 --------

docs/guide-ja/predis.md

@@ -0,0 +1,70 @@
+Yii 2 Redis キャッシュ、セッションおよびアクティブレコード Predis
+===============================================
+## アプリケーションを構成する
+
+このエクステンションを使用するためには、アプリケーション構成情報で [[yii\redis\predis\PredisConnection]] クラスを構成する必要があります。
+
+> Warning: yii\redis\predis\PredisConnection クラスは redis-cluster 接続をサポートしますが、*cache*、*session*、*ActiveRecord*、*mutex* コンポーネント インタフェースのサポートは提供しません。
+
+### standalone
+```php
+return [
+    //....
+    'components' => [
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => 'tcp://redis:6379',
+            'options' => [
+                'parameters' => [
+                    'password' => 'secret', // Or NULL
+                    'database' => 0,
+                    'persistent' => true,
+                    'async_connect' => true,
+                    'read_write_timeout' => 0.1,
+                ],
+            ],
+        ],
+    ]
+];
+```
+### sentinel
+```php
+return [
+    //....
+    'components' => [
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => [
+                'tcp://redis-node-1:26379',
+                'tcp://redis-node-2:26379',
+                'tcp://redis-node-3:26379',
+            ],
+            'options' => [
+                'parameters' => [
+                    'password' => 'secret', // Or NULL
+                    'database' => 0,
+                    'persistent' => true,
+                    'async_connect' => true,
+                    'read_write_timeout' => 0.1,
+                ],
+            ],
+        ],
+    ]
+];
+```
+
+> 接続構成とオプションの詳細については、<a href="https://github.com/predis/predis">predis</a> のドキュメントを参照してください。
+
+これで、`redis` アプリケーション・コンポーネントによって、redis ストレージに対する基本的なアクセスが提供されるようになります。
+
+```php
+Yii::$app->redis->set('mykey', 'some value');
+echo Yii::$app->redis->get('mykey');
+```
+
+追加のトピック
+-----------------
+
+* [predisでキャッシュコンポーネントを使用する](topics-predis-cache.md)
+* [Predisでセッションコンポーネントを使用する](topics-predis-session.md)
+

docs/guide-ja/topics-cache.md

@@ -37,7 +37,7 @@ return [
 ```
 
 このキャッシュは [[yii\caching\CacheInterface]] の全てのメソッドを提供します。インタフェイスに含まれていない redis 固有のメソッドにアクセスしたい場合は、
-[[yii\redis\Connection]] のインスタンスである [[yii\redis\Cache::$redis]] を通じてアクセスすることが出来ます。
+[[yii\redis\ConnectionInterface]] のインスタンスである [[yii\redis\Cache::$redis]] を通じてアクセスすることが出来ます。
 
 ```php
 Yii::$app->cache->redis->hset('mykey', 'somefield', 'somevalue');

docs/guide-ja/topics-predis-cache.md

@@ -0,0 +1,53 @@
+キャッシュ・コンポーネントを使用する Predis
+=========================
+
+`Cache` コンポーネントを使用するためには、[predis](predis.md) の節で説明した接続の構成に加えて、
+`cache` コンポーネントを [[yii\redis\Cache]] として構成する必要があります。
+
+```php
+return [
+    //....
+    'components' => [
+        // ...
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => 'tcp://redis:6379',
+            // ...
+        ],
+        'cache' => [
+            'class' => 'yii\redis\Cache',
+        ],
+    ]
+];
+```
+
+redis をキャッシュとしてのみ使用する場合、すなわち、redis のアクティブレコードやセッションを使用しない場合は、接続のパラメータをキャッシュ・コンポーネントの中で構成しても構いません
+(この場合、接続のアプリケーション・コンポーネントを構成する必要はありません)。
+
+```php
+return [
+    //....
+    'components' => [
+        // ...
+        'cache' => [
+            'class' => 'yii\redis\Cache',
+            'redis' => [
+                'class' => 'yii\redis\predis\PredisConnection',
+                'parameters' => 'tcp://redis:6379',
+                // ...
+            ],
+        ],
+    ]
+];
+```
+
+このキャッシュは [[yii\caching\CacheInterface]] の全てのメソッドを提供します。インタフェイスに含まれていない redis 固有のメソッドにアクセスしたい場合は、
+[[yii\redis\ConnectionInterface]] のインスタンスである [[yii\redis\Cache::$redis]] を通じてアクセスすることが出来ます。
+
+```php
+Yii::$app->cache->redis->hset('mykey', 'somefield', 'somevalue');
+Yii::$app->cache->redis->hget('mykey', 'somefield');
+...
+```
+
+利用可能なメソッドの一覧は [[yii\redis\predis\PredisConnection]] を参照して下さい。

docs/guide-ja/topics-predis-session.md

@@ -0,0 +1,42 @@
+セッション・コンポーネントを使用する Predis
+===========================
+
+`Session` コンポーネントを使用するためには、[predis](predis.md) の節で説明した接続の構成に加えて、
+`session` コンポーネントを [[yii\redis\Session]] として構成する必要があります。
+
+```php
+return [
+    //....
+    'components' => [
+        // ...
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => 'tcp://redis:6379',
+            // ...
+        ],
+        'session' => [
+            'class' => 'yii\redis\Session',
+        ],
+    ]
+];
+```
+
+redis をセッションとしてのみ使用する場合、すなわち、redis のアクティブレコードやキャッシュは使わない場合は、接続のパラメータをセッション・コンポーネントの中で構成しても構いません
+(この場合、接続のアプリケーション・コンポーネントを構成する必要はありません)。
+
+```php
+return [
+    //....
+    'components' => [
+        // ...
+        'session' => [
+            'class' => 'yii\redis\Session',
+            'redis' => [
+                'class' => 'yii\redis\predis\PredisConnection',
+                'parameters' => 'tcp://redis:6379',
+                // ...
+            ],
+        ],
+    ]
+];
+```

docs/guide-pt-BR/README.md

@@ -7,6 +7,7 @@ Iniciando
 ---------------
 
 * [Instalação](installation.md)
+* [Suporte predis](predis.md)
 
 Uso
 ----- 

docs/guide-pt-BR/predis.md

@@ -0,0 +1,70 @@
+Predis para Redis Cache, Sessão e ActiveRecord para Yii 2
+===============================================
+## Configurando a aplicação
+
+Para usar essa extensão, você precisa parametrizar a classe [[yii\redis\predis\PredisConnection]] na configuração da aplicação:
+
+> Warning: A classe yii\redis\predis\PredisConnection suporta conexão redis-cluster, mas não fornece suporte para as interfaces de componentes *cache*, *session*, *ActiveRecord*, *mutex*.
+
+### standalone
+```php
+return [
+    //....
+    'components' => [
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => 'tcp://redis:6379',
+            'options' => [
+                'parameters' => [
+                    'password' => 'secret', // Or NULL
+                    'database' => 0,
+                    'persistent' => true,
+                    'async_connect' => true,
+                    'read_write_timeout' => 0.1,
+                ],
+            ],
+        ],
+    ]
+];
+```
+### sentinel
+```php
+return [
+    //....
+    'components' => [
+        'redis' => [
+            'class' => 'yii\redis\predis\PredisConnection',
+            'parameters' => [
+                'tcp://redis-node-1:26379',
+                'tcp://redis-node-2:26379',
+                'tcp://redis-node-3:26379',
+            ],
+            'options' => [
+                'parameters' => [
+                    'password' => 'secret', // Or NULL
+                    'database' => 0,
+                    'persistent' => true,
+                    'async_connect' => true,
+                    'read_write_timeout' => 0.1,
+                ],
+            ],
+        ],
+    ]
+];
+```
+
+> Mais informações sobre configuração e opções de conexão podem ser encontradas na documentação do <a href="https://github.com/predis/predis">predis</a>.
+
+Isto fornece o acesso básico ao armazenamento de redis através do componente de aplicação `redis`:
+
+```php
+Yii::$app->redis->set('mykey', 'some value');
+echo Yii::$app->redis->get('mykey');
+```
+
+Additional topics
+-----------------
+
+* [Usando o componente Cache com predis](topics-predis-cache.md)
+* [Usando o componente Session com predis](topics-predis-session.md)
+

docs/guide-pt-BR/topics-cache.md

@@ -35,7 +35,7 @@ return [
 ];
 ```
 
-O cache fornece todos os métodos do [[yii\caching\CacheInterface]]. Se você quiser acessar os métodos específicos do redis que não são incluído na interface, você pode usá-los via [[yii\redis\Cache::$redis]], que é uma instância de [[yii\redis\Connection]]:
+O cache fornece todos os métodos do [[yii\caching\CacheInterface]]. Se você quiser acessar os métodos específicos do redis que não são incluído na interface, você pode usá-los via [[yii\redis\Cache::$redis]], que é uma instância de [[yii\redis\ConnectionInterface]]:
 
 ```php
 Yii::$app->cache->redis->hset('mykey', 'somefield', 'somevalue');