yiisoft/db-redis

Yii Framework Redis Cache, Session and ActiveRecord extension

dev-master / 1.0.x-dev 2022-03-25 12:56 UTC

README

68747470733a2f2f646f776e6c6f61642e72656469732e696f2f72656469732e706e67

Yii DBAL Redis connection


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

Latest Stable Version Total Downloads Scrutinizer Code Quality Code Coverage

Support version

PHP Redis Version CI-Actions
7.4 - 8.0 4 - 6 Build status Mutation testing badge static analysis type-coverage

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

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

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.