yiisoft/db-redis

Yii Framework Redis Cache, Session and ActiveRecord extension

dev-master / 1.0.x-dev 2024-05-23 14:45 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.

It includes a Cache and Session storage handler and implements the ActiveRecord pattern that allows you to store active records in redis.

Support version

Requirements

• Redis version 2.6.12 or higher.
• Filter PHP extension.

Installation

The package could be installed with Composer:

composer require yiisoft/db-redis

General usage

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,
    ]
];

Configuring application

To use this extension, you have to configure the Yiisoft\Db\Redis\Connection|Connection class in your application configuration:

return [
    //....
    'components' => [
        'redis' => [
            'class' => 'Yiisoft\Db\Redis\Connection',
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ],
    ]
];

This provides the basic access to redis storage via the redis application component:

Yii::$app->redis->set('mykey', 'some value');
echo Yii::$app->redis->get('mykey');

See [Yiisoft\Db\Redis\Connection] for a full list of available methods.

Documentation

• Guide: English, 日本語, Português - Brasil, Русский, 中国人
• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

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.

Support the project

Follow updates