yiisoft/db-redis

Yii Framework Redis Cache, Session and ActiveRecord extension

dev-master / 1.0.x-dev 2022-07-08 06:11 UTC

Requires

• php: ^8.0
• ext-json: *
• ext-mbstring: *
• yiisoft/arrays: ^2.0
• yiisoft/db: ^3.0@dev
• yiisoft/log: ^2.0
• yiisoft/strings: ^2.0
• yiisoft/yii-event: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.4
• roave/infection-static-analysis-plugin: ^1.3
• vimeo/psalm: ^4.5
• yiisoft/aliases: ^1.0
• yiisoft/cache: ^1.0
• yiisoft/di: ^1.0

BSD-3-Clause

• redis
• cache
• session
• yii
• active-record

README

Yii DBAL Redis connection

This extension provides the redis connection support for the Yii framework.

Support version

PHP	Redis Version	CI-Actions
7.4 - 8.0	4 - 6

Installation

The package could be installed via composer:

composer require yiisoft/db-redis

Configuration

Using yiisoft/composer-config-plugin automatically get the settings of EventDispatcherInterface::class and LoggerInterface::class.

Di-Container:

use Yiisoft\Db\Redis\Connection as RedisConnection;

return [
    RedisConnection::class => [
        '__class' => RedisConnection::class,
        'host()' => [$params['yiisoft/db-redis']['dsn']['host']],
        'port()' => [$params['yiisoft/db-redis']['dsn']['port']],
        'database()' => [$params['yiisoft/db-redis']['dsn']['database']],
        'password()' => [$params['yiisoft/db-redis']['password']]
    ]
];

Params.php

return [
    'yiisoft/db-redis' => [
        'dsn' => [
            'driver' => 'redis',
            'host' => '127.0.0.1',
            'database' => 0,
            'port' => 6379
        ],
        'password' => null,
    ]
];

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. To run it:

./vendor/bin/infection

Static analysis

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

./vendor/bin/psalm

Support the project

Follow updates

License

The Yii DBAL Redis connection is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.