ActiveRecord.php 10.9 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;
11
use yii\base\InvalidConfigException;
Carsten Brandt committed
12
use yii\db\BaseActiveRecord;
13
use yii\helpers\Inflector;
14
use yii\helpers\StringHelper;
15

Carsten Brandt committed
16 17 18
/**
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
 *
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
 * 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
36 37 38
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
Carsten Brandt committed
39
class ActiveRecord extends BaseActiveRecord
Carsten Brandt committed
40
{
41 42 43 44 45 46 47 48
    /**
     * Returns the database connection used by this AR class.
     * By default, the "redis" application component is used as the database connection.
     * 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()
    {
49
        return \Yii::$app->get('redis');
50
    }
Carsten Brandt committed
51

52
    /**
Alexander Makarov committed
53
     * @inheritdoc
54
     * @return ActiveQuery the newly created [[ActiveQuery]] instance.
55
     */
Alexander Makarov committed
56
    public static function find()
57
    {
58
        return Yii::createObject(ActiveQuery::className(), [get_called_class()]);
59
    }
60

61 62 63 64 65 66 67 68 69 70 71 72
    /**
     * 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.
     */
    public static function primaryKey()
    {
        return ['id'];
    }
73

74 75 76 77 78 79 80 81 82
    /**
     * 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.
     */
    public function attributes()
    {
        throw new InvalidConfigException('The attributes() method of redis ActiveRecord has to be implemented by child classes.');
    }
83

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    /**
     * 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()
    {
        return Inflector::camel2id(StringHelper::basename(get_called_class()), '_');
    }

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

120 121
        $key = static::keyPrefix() . ':a:' . static::buildKey($pk);
        // save attributes
122
        $setArgs = [$key];
123
        foreach ($values as $attribute => $value) {
124
            // only insert attributes that are not null
125
            if ($value !== null) {
126
                if (is_bool($value)) {
Alexander Mohorev committed
127
                    $value = (int) $value;
128
                }
129 130 131 132 133 134 135 136 137
                $setArgs[] = $attribute;
                $setArgs[] = $value;
            }
        }

        if (count($setArgs) > 1) {
            $db->executeCommand('HMSET', $setArgs);
        }

138
        $changedAttributes = array_fill_keys(array_keys($values), null);
139
        $this->setOldAttributes($values);
140
        $this->afterSave(true, $changedAttributes);
141

142
        return true;
143 144 145 146 147 148 149 150 151 152
    }

    /**
     * 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:
     *
     * ~~~
     * Customer::updateAll(['status' => 1], ['id' => 2]);
     * ~~~
     *
153 154 155
     * @param array $attributes attribute values (name-value pairs) to be saved into the table
     * @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.
156 157 158 159 160 161 162 163 164
     * @return integer the number of rows updated
     */
    public static function updateAll($attributes, $condition = null)
    {
        if (empty($attributes)) {
            return 0;
        }
        $db = static::getDb();
        $n = 0;
Carsten Brandt committed
165
        foreach (self::fetchPks($condition) as $pk) {
166 167 168 169
            $newPk = $pk;
            $pk = static::buildKey($pk);
            $key = static::keyPrefix() . ':a:' . $pk;
            // save attributes
170 171
            $delArgs = [$key];
            $setArgs = [$key];
172 173 174 175
            foreach ($attributes as $attribute => $value) {
                if (isset($newPk[$attribute])) {
                    $newPk[$attribute] = $value;
                }
176
                if ($value !== null) {
177
                    if (is_bool($value)) {
Alexander Mohorev committed
178
                        $value = (int) $value;
179
                    }
180 181 182 183 184
                    $setArgs[] = $attribute;
                    $setArgs[] = $value;
                } else {
                    $delArgs[] = $attribute;
                }
185 186 187 188 189 190
            }
            $newPk = static::buildKey($newPk);
            $newKey = static::keyPrefix() . ':a:' . $newPk;
            // rename index if pk changed
            if ($newPk != $pk) {
                $db->executeCommand('MULTI');
191 192 193 194 195 196
                if (count($setArgs) > 1) {
                    $db->executeCommand('HMSET', $setArgs);
                }
                if (count($delArgs) > 1) {
                    $db->executeCommand('HDEL', $delArgs);
                }
197 198 199 200 201
                $db->executeCommand('LINSERT', [static::keyPrefix(), 'AFTER', $pk, $newPk]);
                $db->executeCommand('LREM', [static::keyPrefix(), 0, $pk]);
                $db->executeCommand('RENAME', [$key, $newKey]);
                $db->executeCommand('EXEC');
            } else {
202 203 204 205 206 207
                if (count($setArgs) > 1) {
                    $db->executeCommand('HMSET', $setArgs);
                }
                if (count($delArgs) > 1) {
                    $db->executeCommand('HDEL', $delArgs);
                }
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
            }
            $n++;
        }

        return $n;
    }

    /**
     * Updates the whole table using the provided counter changes and conditions.
     * For example, to increment all customers' age by 1,
     *
     * ~~~
     * Customer::updateAllCounters(['age' => 1]);
     * ~~~
     *
223 224 225 226
     * @param array $counters the counters to be updated (attribute name => increment value).
     * Use negative values if you want to decrement the counters.
     * @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.
227 228 229 230 231 232 233 234 235
     * @return integer the number of rows updated
     */
    public static function updateAllCounters($counters, $condition = null)
    {
        if (empty($counters)) {
            return 0;
        }
        $db = static::getDb();
        $n = 0;
Carsten Brandt committed
236
        foreach (self::fetchPks($condition) as $pk) {
237 238 239 240 241 242 243 244 245
            $key = static::keyPrefix() . ':a:' . static::buildKey($pk);
            foreach ($counters as $attribute => $value) {
                $db->executeCommand('HINCRBY', [$key, $attribute, $value]);
            }
            $n++;
        }

        return $n;
    }
246

247 248 249 250 251 252 253 254 255 256
    /**
     * 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:
     *
     * ~~~
     * Customer::deleteAll(['status' => 3]);
     * ~~~
     *
257 258
     * @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.
259 260 261 262
     * @return integer the number of rows deleted
     */
    public static function deleteAll($condition = null)
    {
Carsten Brandt committed
263
        $pks = self::fetchPks($condition);
264
        if (empty($pks)) {
265 266
            return 0;
        }
267

268 269
        $db = static::getDb();
        $attributeKeys = [];
270 271 272 273 274 275 276 277
        $db->executeCommand('MULTI');
        foreach ($pks as $pk) {
            $pk = static::buildKey($pk);
            $db->executeCommand('LREM', [static::keyPrefix(), 0, $pk]);
            $attributeKeys[] = static::keyPrefix() . ':a:' . $pk;
        }
        $db->executeCommand('DEL', $attributeKeys);
        $result = $db->executeCommand('EXEC');
278

279 280
        return end($result);
    }
281

282 283
    private static function fetchPks($condition)
    {
Alexander Makarov committed
284
        $query = static::find();
285 286 287
        $query->where($condition);
        $records = $query->asArray()->all(); // TODO limit fetched columns to pk
        $primaryKey = static::primaryKey();
288

289 290 291 292 293 294 295 296
        $pks = [];
        foreach ($records as $record) {
            $pk = [];
            foreach ($primaryKey as $key) {
                $pk[$key] = $record[$key];
            }
            $pks[] = $pk;
        }
297

298 299
        return $pks;
    }
300

301 302 303
    /**
     * Builds a normalized key from a given primary key value.
     *
304
     * @param mixed $key the key to be normalized
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
     * @return string the generated key
     */
    public static function buildKey($key)
    {
        if (is_numeric($key)) {
            return $key;
        } elseif (is_string($key)) {
            return ctype_alnum($key) && StringHelper::byteLength($key) <= 32 ? $key : md5($key);
        } elseif (is_array($key)) {
            if (count($key) == 1) {
                return self::buildKey(reset($key));
            }
            ksort($key); // ensure order is always the same
            $isNumeric = true;
            foreach ($key as $value) {
                if (!is_numeric($value)) {
                    $isNumeric = false;
                }
            }
            if ($isNumeric) {
                return implode('-', $key);
            }
        }
328

329 330
        return md5(json_encode($key));
    }
Carsten Brandt committed
331
}