README.md 4.84 KB
Newer Older
Carsten Brandt committed
1 2
Redis Cache, Session and ActiveRecord for Yii 2
===============================================
3 4

This extension provides the [redis](http://redis.io/) key-value store support for the Yii2 framework.
Carsten Brandt committed
5 6
It includes a `Cache` and `Session` storage handler and implents the `ActiveRecord` pattern that allows
you to store active records in redis.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

To use this extension, you have to configure the Connection class in your application configuration:

```php
return [
	//....
	'components' => [
        'redis' => [
            'class' => 'yii\redis\Connection',
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ],
	]
];
```

Carsten Brandt committed
24 25 26 27 28 29 30 31
Installation
------------

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
32
php composer.phar require --prefer-dist yiisoft/yii2-redis "*"
Carsten Brandt committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46
```

or add

```json
"yiisoft/yii2-redis": "*"
```

to the require section of your composer.json.


Using the Cache component
-------------------------

47
To use the `Cache` component, in addition to configuring the connection as described above,
Carsten Brandt committed
48
you also have to configure the `cache` component to be `yii\redis\Cache`:
49 50 51 52 53

```php
return [
	//....
	'components' => [
54 55 56 57
		// ...
		'cache' => [
			'class' => 'yii\redis\Cache',
		],
58 59 60 61
	]
];
```

62
If you only use the redis cache, you can also configure the parameters of the connection within the
Carsten Brandt committed
63
cache component (no connection application component needs to be configured in this case):
64

65 66 67 68
```php
return [
	//....
	'components' => [
69 70 71 72 73 74 75 76 77
		// ...
		'cache' => [
			'class' => 'yii\redis\Cache',
			'redis' => [
				'hostname' => 'localhost',
				'port' => 6379,
				'database' => 0,
			],
		],
78 79 80
	]
];
```
81

Carsten Brandt committed
82 83
Using the Session component
---------------------------
84

Carsten Brandt committed
85 86
To use the `Session` component, in addtition to configuring the connection as described above,
you also have to configure the `session` component to be `yii\redis\Session`:
87

Carsten Brandt committed
88 89 90 91
```php
return [
	//....
	'components' => [
92 93 94 95
		// ...
		'session' => [
			'class' => 'yii\redis\Session',
		],
Carsten Brandt committed
96 97
	]
];
98 99
```

Carsten Brandt committed
100 101
If you only use the redis session, you can also configure the parameters of the connection within the
cache component (no connection application component needs to be configured in this case):
102

Carsten Brandt committed
103 104 105 106
```php
return [
	//....
	'components' => [
107 108 109 110 111 112 113 114 115
		// ...
		'session' => [
			'class' => 'yii\redis\Session',
			'redis' => [
				'hostname' => 'localhost',
				'port' => 6379,
				'database' => 0,
			],
		],
Carsten Brandt committed
116 117
	]
];
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
```


Using the redis ActiveRecord
----------------------------

For general information on how to use yii's ActiveRecord please refer to the [guide](https://github.com/yiisoft/yii2/blob/master/docs/guide/active-record.md).

For defining a redis ActiveRecord class your record class needs to extend from `yii\redis\ActiveRecord` and
implement at least the `attributes()` method to define the attributes of the record.
A primary key can be defined via [[primaryKey()]] which defaults to `id` if not specified.
The primaryKey needs to be part of the attributes so make sure you have an `id` attribute defined if you do
not specify your own primary key.

The following is an example model called `Customer`:

```php
class Customer extends \yii\redis\ActiveRecord
{
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
	/**
	 * @return array the list of attributes for this record
	 */
	public function attributes()
	{
		return ['id', 'name', 'address', 'registration_date'];
	}

	/**
	 * @return ActiveRelation defines a relation to the Order record (can be in other database, e.g. elasticsearch or sql)
	 */
	public function getOrders()
	{
		return $this->hasMany(Order::className(), ['customer_id' => 'id']);
	}

	/**
	 * Defines a scope that modifies the `$query` to return only active(status = 1) customers
	 */
	public static function active($query)
	{
		$query->andWhere(array('status' => 1));
	}
160 161 162 163 164 165 166 167 168 169 170 171
}
```

The general usage of redis ActiveRecord is very similar to the database ActiveRecord as described in the
[guide](https://github.com/yiisoft/yii2/blob/master/docs/guide/active-record.md).
It supports the same interface and features except the following limitations:

- As redis does not support SQL the query API is limited to the following methods:
  `where()`, `limit()`, `offset()`, `orderBy()` and `indexBy()`.
  (orderBy() is not yet implemented: [#1305](https://github.com/yiisoft/yii2/issues/1305))
- `via`-relations can not be defined via a table as there are not tables in redis. You can only define relations via other records.

Carsten Brandt committed
172 173 174 175 176 177 178 179 180 181 182 183
It is also possible to define relations from redis ActiveRecords to normal ActiveRecord classes and vice versa.

Usage example:

```php
$customer = new Customer();
$customer->attributes = ['name' => 'test'];
$customer->save();
echo $customer->id; // id will automatically be incremented if not set explicitly

$customer = Customer::find()->where(['name' => 'test'])->one(); // find by query
$customer = Customer::find()->active()->all(); // find all by query (using the `active` scope)
184
```