ActiveRecord.php 8.66 KB
Newer Older
Carsten Brandt committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Carsten Brandt committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\redis;
Carsten Brandt committed
9

10
use yii\base\InvalidConfigException;
Carsten Brandt committed
11
use yii\db\BaseActiveRecord;
12
use yii\helpers\Inflector;
13
use yii\helpers\StringHelper;
14

Carsten Brandt committed
15 16 17
/**
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
 *
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 * This class implements the ActiveRecord pattern for the [redis](http://redis.io/) key-value store.
 *
 * For defining a record a subclass should at least implement the [[attributes()]] method to define
 * attributes. A primary key can be defined via [[primaryKey()]] which defaults to `id` if not specified.
 *
 * The following is an example model called `Customer`:
 *
 * ```php
 * class Customer extends \yii\redis\ActiveRecord
 * {
 *     public function attributes()
 *     {
 *         return ['id', 'name', 'address', 'registration_date'];
 *     }
 * }
 * ```
 *
Carsten Brandt committed
35 36 37
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
Carsten Brandt committed
38
class ActiveRecord extends BaseActiveRecord
Carsten Brandt committed
39 40 41
{
	/**
	 * Returns the database connection used by this AR class.
42
	 * By default, the "redis" application component is used as the database connection.
Carsten Brandt committed
43 44 45 46 47
	 * You may override this method if you want to use a different database connection.
	 * @return Connection the database connection used by this AR class.
	 */
	public static function getDb()
	{
48
		return \Yii::$app->getComponent('redis');
Carsten Brandt committed
49 50
	}

51
	/**
Qiang Xue committed
52
	 * @inheritdoc
53 54 55 56 57 58 59
	 */
	public static function createQuery()
	{
		return new ActiveQuery(['modelClass' => get_called_class()]);
	}

	/**
Qiang Xue committed
60
	 * @inheritdoc
61
	 */
62
	public static function createRelation($config = [])
63 64 65 66 67
	{
		return new ActiveRelation($config);
	}

	/**
68 69 70 71 72 73
	 * Returns the primary key name(s) for this AR class.
	 * This method should be overridden by child classes to define the primary key.
	 *
	 * Note that an array should be returned even when it is a single primary key.
	 *
	 * @return string[] the primary keys of this record.
74
	 */
75
	public static function primaryKey()
76
	{
77
		return ['id'];
78 79 80
	}

	/**
81 82 83
	 * Returns the list of all attribute names of the model.
	 * This method must be overridden by child classes to define available attributes.
	 * @return array list of attribute names.
84
	 */
85
	public function attributes()
86
	{
87
		throw new InvalidConfigException('The attributes() method of redis ActiveRecord has to be implemented by child classes.');
88 89
	}

90 91 92 93 94 95 96 97 98
	/**
	 * Declares prefix of the key that represents the keys that store this records in redis.
	 * By default this method returns the class name as the table name by calling [[Inflector::camel2id()]].
	 * For example, 'Customer' becomes 'customer', and 'OrderItem' becomes
	 * 'order_item'. You may override this method if you want different key naming.
	 * @return string the prefix to apply to all AR keys
	 */
	public static function keyPrefix()
	{
99
		return Inflector::camel2id(StringHelper::basename(get_called_class()), '_');
100 101
	}

102
	/**
Qiang Xue committed
103
	 * @inheritdoc
104 105 106 107 108 109 110 111 112 113 114 115 116 117
	 */
	public function insert($runValidation = true, $attributes = null)
	{
		if ($runValidation && !$this->validate($attributes)) {
			return false;
		}
		if ($this->beforeSave(true)) {
			$db = static::getDb();
			$values = $this->getDirtyAttributes($attributes);
			$pk = [];
//			if ($values === []) {
			foreach ($this->primaryKey() as $key) {
				$pk[$key] = $values[$key] = $this->getAttribute($key);
				if ($pk[$key] === null) {
118
					$pk[$key] = $values[$key] = $db->executeCommand('INCR', [static::keyPrefix() . ':s:' . $key]);
119 120 121 122 123
					$this->setAttribute($key, $values[$key]);
				}
			}
//			}
			// save pk in a findall pool
124
			$db->executeCommand('RPUSH', [static::keyPrefix(), static::buildKey($pk)]);
125

126
			$key = static::keyPrefix() . ':a:' . static::buildKey($pk);
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
			// save attributes
			$args = [$key];
			foreach($values as $attribute => $value) {
				$args[] = $attribute;
				$args[] = $value;
			}
			$db->executeCommand('HMSET', $args);

			$this->setOldAttributes($values);
			$this->afterSave(true);
			return true;
		}
		return false;
	}

142 143 144 145 146
	/**
	 * Updates the whole table using the provided attribute values and conditions.
	 * For example, to change the status to be 1 for all customers whose status is 2:
	 *
	 * ~~~
147
	 * Customer::updateAll(['status' => 1], ['id' => 2]);
148 149 150
	 * ~~~
	 *
	 * @param array $attributes attribute values (name-value pairs) to be saved into the table
151 152
	 * @param array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
	 * Please refer to [[ActiveQuery::where()]] on how to specify this parameter.
153 154
	 * @return integer the number of rows updated
	 */
155
	public static function updateAll($attributes, $condition = null)
156 157 158 159
	{
		if (empty($attributes)) {
			return 0;
		}
Carsten Brandt committed
160
		$db = static::getDb();
161
		$n=0;
162 163 164
		foreach(static::fetchPks($condition) as $pk) {
			$newPk = $pk;
			$pk = static::buildKey($pk);
165
			$key = static::keyPrefix() . ':a:' . $pk;
166
			// save attributes
167
			$args = [$key];
168
			foreach($attributes as $attribute => $value) {
169 170 171
				if (isset($newPk[$attribute])) {
					$newPk[$attribute] = $value;
				}
172 173 174
				$args[] = $attribute;
				$args[] = $value;
			}
175
			$newPk = static::buildKey($newPk);
176
			$newKey = static::keyPrefix() . ':a:' . $newPk;
177
			// rename index if pk changed
178
			if ($newPk != $pk) {
179 180
				$db->executeCommand('MULTI');
				$db->executeCommand('HMSET', $args);
181 182
				$db->executeCommand('LINSERT', [static::keyPrefix(), 'AFTER', $pk, $newPk]);
				$db->executeCommand('LREM', [static::keyPrefix(), 0, $pk]);
183
				$db->executeCommand('RENAME', [$key, $newKey]);
184 185 186
				$db->executeCommand('EXEC');
			} else {
				$db->executeCommand('HMSET', $args);
187
			}
188 189 190 191 192 193 194 195 196 197
			$n++;
		}
		return $n;
	}

	/**
	 * Updates the whole table using the provided counter changes and conditions.
	 * For example, to increment all customers' age by 1,
	 *
	 * ~~~
198
	 * Customer::updateAllCounters(['age' => 1]);
199 200 201 202
	 * ~~~
	 *
	 * @param array $counters the counters to be updated (attribute name => increment value).
	 * Use negative values if you want to decrement the counters.
203 204
	 * @param array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
	 * Please refer to [[ActiveQuery::where()]] on how to specify this parameter.
205 206
	 * @return integer the number of rows updated
	 */
207
	public static function updateAllCounters($counters, $condition = null)
208
	{
Carsten Brandt committed
209 210 211
		if (empty($counters)) {
			return 0;
		}
212 213
		$db = static::getDb();
		$n=0;
214
		foreach(static::fetchPks($condition) as $pk) {
215
			$key = static::keyPrefix() . ':a:' . static::buildKey($pk);
216
			foreach($counters as $attribute => $value) {
217
				$db->executeCommand('HINCRBY', [$key, $attribute, $value]);
218 219 220 221 222 223 224 225 226 227 228 229 230
			}
			$n++;
		}
		return $n;
	}

	/**
	 * Deletes rows in the table using the provided conditions.
	 * WARNING: If you do not specify any condition, this method will delete ALL rows in the table.
	 *
	 * For example, to delete all customers whose status is 3:
	 *
	 * ~~~
231
	 * Customer::deleteAll(['status' => 3]);
232 233
	 * ~~~
	 *
234 235
	 * @param array $condition the conditions that will be put in the WHERE part of the DELETE SQL.
	 * Please refer to [[ActiveQuery::where()]] on how to specify this parameter.
236 237
	 * @return integer the number of rows deleted
	 */
238
	public static function deleteAll($condition = null)
239 240
	{
		$db = static::getDb();
241
		$attributeKeys = [];
242 243 244
		$pks = static::fetchPks($condition);
		$db->executeCommand('MULTI');
		foreach($pks as $pk) {
245
			$pk = static::buildKey($pk);
246 247
			$db->executeCommand('LREM', [static::keyPrefix(), 0, $pk]);
			$attributeKeys[] = static::keyPrefix() . ':a:' . $pk;
248
		}
249
		if (empty($attributeKeys)) {
250
			$db->executeCommand('EXEC');
251 252
			return 0;
		}
253 254 255
		$db->executeCommand('DEL', $attributeKeys);
		$result = $db->executeCommand('EXEC');
		return end($result);
256 257
	}

258 259 260 261 262 263 264
	private static function fetchPks($condition)
	{
		$query = static::createQuery();
		$query->where($condition);
		$records = $query->asArray()->all(); // TODO limit fetched columns to pk
		$primaryKey = static::primaryKey();

265
		$pks = [];
266
		foreach($records as $record) {
267
			$pk = [];
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
			foreach($primaryKey as $key) {
				$pk[$key] = $record[$key];
			}
			$pks[] = $pk;
		}
		return $pks;
	}

	/**
	 * Builds a normalized key from a given primary key value.
	 *
	 * @param mixed $key the key to be normalized
	 * @return string the generated key
	 */
	public static function buildKey($key)
	{
		if (is_numeric($key)) {
			return $key;
		} elseif (is_string($key)) {
287
			return ctype_alnum($key) && StringHelper::byteLength($key) <= 32 ? $key : md5($key);
288 289 290 291
		} elseif (is_array($key)) {
			if (count($key) == 1) {
				return self::buildKey(reset($key));
			}
292
			ksort($key); // ensure order is always the same
293 294 295 296 297 298 299 300 301 302 303 304
			$isNumeric = true;
			foreach($key as $value) {
				if (!is_numeric($value)) {
					$isNumeric = false;
				}
			}
			if ($isNumeric) {
				return implode('-', $key);
			}
		}
		return md5(json_encode($key));
	}
Carsten Brandt committed
305
}