ActiveRecord.php 50.2 KB
Newer Older
w  
Qiang Xue committed
1 2 3 4
<?php
/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
Qiang Xue committed
5
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
6 7 8
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
9
namespace yii\db;
w  
Qiang Xue committed
10

Qiang Xue committed
11
use yii\base\InvalidConfigException;
Qiang Xue committed
12
use yii\base\Model;
Qiang Xue committed
13
use yii\base\InvalidParamException;
Qiang Xue committed
14
use yii\base\ModelEvent;
Qiang Xue committed
15 16
use yii\base\UnknownMethodException;
use yii\base\InvalidCallException;
Qiang Xue committed
17
use yii\helpers\StringHelper;
18
use yii\helpers\Inflector;
w  
Qiang Xue committed
19

w  
Qiang Xue committed
20
/**
Qiang Xue committed
21
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
w  
Qiang Xue committed
22
 *
Qiang Xue committed
23
 * @include @yii/db/ActiveRecord.md
w  
Qiang Xue committed
24
 *
25 26 27 28 29 30 31 32 33 34
 * @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is
 * read-only.
 * @property boolean $isNewRecord Whether the record is new and should be inserted when calling [[save()]].
 * @property array $oldAttributes The old attribute values (name-value pairs).
 * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is
 * returned if the primary key is composite or `$asArray` is true. A string is returned otherwise (null will be
 * returned if the key value is null). This property is read-only.
 * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if
 * the primary key is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
 * the key value is null). This property is read-only.
Qiang Xue committed
35
 *
Qiang Xue committed
36 37
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
w  
Qiang Xue committed
38
 */
Qiang Xue committed
39
class ActiveRecord extends Model
w  
Qiang Xue committed
40
{
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
	/**
	 * @event Event an event that is triggered when the record is initialized via [[init()]].
	 */
	const EVENT_INIT = 'init';
	/**
	 * @event Event an event that is triggered after the record is created and populated with query result.
	 */
	const EVENT_AFTER_FIND = 'afterFind';
	/**
	 * @event ModelEvent an event that is triggered before inserting a record.
	 * You may set [[ModelEvent::isValid]] to be false to stop the insertion.
	 */
	const EVENT_BEFORE_INSERT = 'beforeInsert';
	/**
	 * @event Event an event that is triggered after a record is inserted.
	 */
	const EVENT_AFTER_INSERT = 'afterInsert';
	/**
	 * @event ModelEvent an event that is triggered before updating a record.
	 * You may set [[ModelEvent::isValid]] to be false to stop the update.
	 */
	const EVENT_BEFORE_UPDATE = 'beforeUpdate';
	/**
	 * @event Event an event that is triggered after a record is updated.
	 */
	const EVENT_AFTER_UPDATE = 'afterUpdate';
	/**
	 * @event ModelEvent an event that is triggered before deleting a record.
	 * You may set [[ModelEvent::isValid]] to be false to stop the deletion.
	 */
	const EVENT_BEFORE_DELETE = 'beforeDelete';
	/**
	 * @event Event an event that is triggered after a record is deleted.
	 */
	const EVENT_AFTER_DELETE = 'afterDelete';

77
	/**
78
	 * The insert operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
79
	 */
80
	const OP_INSERT = 0x01;
81
	/**
82
	 * The update operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
83
	 */
84
	const OP_UPDATE = 0x02;
85
	/**
86
	 * The delete operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
87
	 */
88 89 90 91 92 93
	const OP_DELETE = 0x04;
	/**
	 * All three operations: insert, update, delete.
	 * This is a shortcut of the expression: OP_INSERT | OP_UPDATE | OP_DELETE.
	 */
	const OP_ALL = 0x07;
94

w  
Qiang Xue committed
95
	/**
Qiang Xue committed
96 97
	 * @var array attribute values indexed by attribute names
	 */
Alexander Makarov committed
98
	private $_attributes = [];
Qiang Xue committed
99 100
	/**
	 * @var array old attribute values indexed by attribute names.
w  
Qiang Xue committed
101
	 */
Qiang Xue committed
102
	private $_oldAttributes;
103
	/**
Qiang Xue committed
104
	 * @var array related models indexed by the relation names
105
	 */
Qiang Xue committed
106 107
	private $_related;

108

Qiang Xue committed
109 110 111 112 113 114
	/**
	 * Returns the database connection used by this AR class.
	 * By default, the "db" 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.
	 */
Qiang Xue committed
115
	public static function getDb()
Qiang Xue committed
116
	{
Qiang Xue committed
117
		return \Yii::$app->getDb();
Qiang Xue committed
118 119
	}

Qiang Xue committed
120
	/**
Qiang Xue committed
121
	 * Creates an [[ActiveQuery]] instance for query purpose.
Qiang Xue committed
122
	 *
Qiang Xue committed
123
	 * @include @yii/db/ActiveRecord-find.md
Qiang Xue committed
124 125 126
	 *
	 * @param mixed $q the query parameter. This can be one of the followings:
	 *
Qiang Xue committed
127 128
	 *  - a scalar value (integer or string): query by a single primary key value and return the
	 *    corresponding record.
Qiang Xue committed
129
	 *  - an array of name-value pairs: query by a set of column values and return a single record matching all of them.
Qiang Xue committed
130
	 *  - null: return a new [[ActiveQuery]] object for further query purpose.
Qiang Xue committed
131
	 *
Qiang Xue committed
132 133
	 * @return ActiveQuery|ActiveRecord|null When `$q` is null, a new [[ActiveQuery]] instance
	 * is returned; when `$q` is a scalar or an array, an ActiveRecord object matching it will be
Qiang Xue committed
134
	 * returned (null will be returned if there is no matching).
Qiang Xue committed
135
	 * @throws InvalidConfigException if the AR class does not have a primary key
Qiang Xue committed
136
	 * @see createQuery()
Qiang Xue committed
137 138 139
	 */
	public static function find($q = null)
	{
Qiang Xue committed
140
		$query = static::createQuery();
Qiang Xue committed
141
		if (is_array($q)) {
Qiang Xue committed
142
			return $query->where($q)->one();
Qiang Xue committed
143 144
		} elseif ($q !== null) {
			// query by primary key
Qiang Xue committed
145
			$primaryKey = static::primaryKey();
Qiang Xue committed
146
			if (isset($primaryKey[0])) {
Alexander Makarov committed
147
				return $query->where([$primaryKey[0] => $q])->one();
Qiang Xue committed
148 149 150
			} else {
				throw new InvalidConfigException(get_called_class() . ' must have a primary key.');
			}
Qiang Xue committed
151
		}
Qiang Xue committed
152
		return $query;
w  
Qiang Xue committed
153 154
	}

Qiang Xue committed
155
	/**
Qiang Xue committed
156 157 158 159 160 161 162 163 164 165 166 167 168
	 * Creates an [[ActiveQuery]] instance with a given SQL statement.
	 *
	 * Note that because the SQL statement is already specified, calling additional
	 * query modification methods (such as `where()`, `order()`) on the created [[ActiveQuery]]
	 * instance will have no effect. However, calling `with()`, `asArray()` or `indexBy()` is
	 * still fine.
	 *
	 * Below is an example:
	 *
	 * ~~~
	 * $customers = Customer::findBySql('SELECT * FROM tbl_customer')->all();
	 * ~~~
	 *
Qiang Xue committed
169 170
	 * @param string $sql the SQL statement to be executed
	 * @param array $params parameters to be bound to the SQL statement during execution.
Qiang Xue committed
171
	 * @return ActiveQuery the newly created [[ActiveQuery]] instance
Qiang Xue committed
172
	 */
Alexander Makarov committed
173
	public static function findBySql($sql, $params = [])
w  
Qiang Xue committed
174
	{
Qiang Xue committed
175
		$query = static::createQuery();
Qiang Xue committed
176 177 178 179 180 181
		$query->sql = $sql;
		return $query->params($params);
	}

	/**
	 * Updates the whole table using the provided attribute values and conditions.
Qiang Xue committed
182 183 184
	 * For example, to change the status to be 1 for all customers whose status is 2:
	 *
	 * ~~~
Alexander Makarov committed
185
	 * Customer::updateAll(['status' => 1], 'status = 2');
Qiang Xue committed
186 187 188 189
	 * ~~~
	 *
	 * @param array $attributes attribute values (name-value pairs) to be saved into the table
	 * @param string|array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
Qiang Xue committed
190
	 * Please refer to [[Query::where()]] on how to specify this parameter.
resurtm committed
191
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
192 193
	 * @return integer the number of rows updated
	 */
Alexander Makarov committed
194
	public static function updateAll($attributes, $condition = '', $params = [])
w  
Qiang Xue committed
195
	{
Qiang Xue committed
196
		$command = static::getDb()->createCommand();
Qiang Xue committed
197 198
		$command->update(static::tableName(), $attributes, $condition, $params);
		return $command->execute();
w  
Qiang Xue committed
199 200
	}

Qiang Xue committed
201
	/**
Qiang Xue committed
202 203 204 205
	 * Updates the whole table using the provided counter changes and conditions.
	 * For example, to increment all customers' age by 1,
	 *
	 * ~~~
Alexander Makarov committed
206
	 * Customer::updateAllCounters(['age' => 1]);
Qiang Xue committed
207 208
	 * ~~~
	 *
Qiang Xue committed
209
	 * @param array $counters the counters to be updated (attribute name => increment value).
Qiang Xue committed
210 211
	 * Use negative values if you want to decrement the counters.
	 * @param string|array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
Qiang Xue committed
212
	 * Please refer to [[Query::where()]] on how to specify this parameter.
resurtm committed
213
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
214
	 * Do not name the parameters as `:bp0`, `:bp1`, etc., because they are used internally by this method.
Qiang Xue committed
215 216
	 * @return integer the number of rows updated
	 */
Alexander Makarov committed
217
	public static function updateAllCounters($counters, $condition = '', $params = [])
w  
Qiang Xue committed
218
	{
Qiang Xue committed
219
		$n = 0;
Qiang Xue committed
220
		foreach ($counters as $name => $value) {
Alexander Makarov committed
221
			$counters[$name] = new Expression("[[$name]]+:bp{$n}", [":bp{$n}" => $value]);
Qiang Xue committed
222
			$n++;
Qiang Xue committed
223
		}
224
		$command = static::getDb()->createCommand();
Qiang Xue committed
225 226
		$command->update(static::tableName(), $counters, $condition, $params);
		return $command->execute();
w  
Qiang Xue committed
227 228
	}

Qiang Xue committed
229 230
	/**
	 * Deletes rows in the table using the provided conditions.
Qiang Xue committed
231 232 233 234 235 236 237 238 239
	 * 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');
	 * ~~~
	 *
	 * @param string|array $condition the conditions that will be put in the WHERE part of the DELETE SQL.
Qiang Xue committed
240
	 * Please refer to [[Query::where()]] on how to specify this parameter.
resurtm committed
241
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
242
	 * @return integer the number of rows deleted
Qiang Xue committed
243
	 */
Alexander Makarov committed
244
	public static function deleteAll($condition = '', $params = [])
w  
Qiang Xue committed
245
	{
Qiang Xue committed
246
		$command = static::getDb()->createCommand();
Qiang Xue committed
247 248
		$command->delete(static::tableName(), $condition, $params);
		return $command->execute();
w  
Qiang Xue committed
249 250
	}

.  
Qiang Xue committed
251
	/**
Qiang Xue committed
252 253 254 255
	 * Creates an [[ActiveQuery]] instance.
	 * This method is called by [[find()]], [[findBySql()]] and [[count()]] to start a SELECT query.
	 * You may override this method to return a customized query (e.g. `CustomerQuery` specified
	 * written for querying `Customer` purpose.)
Qiang Xue committed
256
	 * @return ActiveQuery the newly created [[ActiveQuery]] instance.
.  
Qiang Xue committed
257
	 */
Qiang Xue committed
258
	public static function createQuery()
w  
Qiang Xue committed
259
	{
Alexander Makarov committed
260
		return new ActiveQuery(['modelClass' => get_called_class()]);
w  
Qiang Xue committed
261 262 263
	}

	/**
Qiang Xue committed
264
	 * Declares the name of the database table associated with this AR class.
265
	 * By default this method returns the class name as the table name by calling [[Inflector::camel2id()]]
Qiang Xue committed
266 267
	 * with prefix 'tbl_'. For example, 'Customer' becomes 'tbl_customer', and 'OrderItem' becomes
	 * 'tbl_order_item'. You may override this method if the table is not named after this convention.
w  
Qiang Xue committed
268 269
	 * @return string the table name
	 */
Qiang Xue committed
270
	public static function tableName()
w  
Qiang Xue committed
271
	{
272
		return 'tbl_' . Inflector::camel2id(StringHelper::basename(get_called_class()), '_');
w  
Qiang Xue committed
273 274 275
	}

	/**
Qiang Xue committed
276 277
	 * Returns the schema information of the DB table associated with this AR class.
	 * @return TableSchema the schema information of the DB table associated with this AR class.
278
	 * @throws InvalidConfigException if the table for the AR class does not exist.
w  
Qiang Xue committed
279
	 */
Qiang Xue committed
280
	public static function getTableSchema()
w  
Qiang Xue committed
281
	{
282 283 284 285 286 287
		$schema = static::getDb()->getTableSchema(static::tableName());
		if ($schema !== null) {
			return $schema;
		} else {
			throw new InvalidConfigException("The table does not exist: " . static::tableName());
		}
w  
Qiang Xue committed
288 289 290
	}

	/**
Qiang Xue committed
291 292
	 * Returns the primary key name(s) for this AR class.
	 * The default implementation will return the primary key(s) as declared
Qiang Xue committed
293
	 * in the DB table that is associated with this AR class.
Qiang Xue committed
294
	 *
Qiang Xue committed
295 296 297
	 * If the DB table does not declare any primary key, you should override
	 * this method to return the attributes that you want to use as primary keys
	 * for this AR class.
Qiang Xue committed
298 299 300
	 *
	 * Note that an array should be returned even for a table with single primary key.
	 *
Qiang Xue committed
301
	 * @return string[] the primary keys of the associated database table.
w  
Qiang Xue committed
302
	 */
Qiang Xue committed
303
	public static function primaryKey()
w  
Qiang Xue committed
304
	{
Qiang Xue committed
305
		return static::getTableSchema()->primaryKey;
w  
Qiang Xue committed
306 307
	}

308
	/**
309
	 * Returns the name of the column that stores the lock version for implementing optimistic locking.
310
	 *
311 312 313 314
	 * Optimistic locking allows multiple users to access the same record for edits and avoids
	 * potential conflicts. In case when a user attempts to save the record upon some staled data
	 * (because another user has modified the data), a [[StaleObjectException]] exception will be thrown,
	 * and the update or deletion is skipped.
315 316 317 318 319
	 *
	 * Optimized locking is only supported by [[update()]] and [[delete()]].
	 *
	 * To use optimized locking:
	 *
320
	 * 1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`.
321
	 *    Override this method to return the name of this column.
322 323 324 325 326 327 328 329 330
	 * 2. In the Web form that collects the user input, add a hidden field that stores
	 *    the lock version of the recording being updated.
	 * 3. In the controller action that does the data updating, try to catch the [[StaleObjectException]]
	 *    and implement necessary business logic (e.g. merging the changes, prompting stated data)
	 *    to resolve the conflict.
	 *
	 * @return string the column name that stores the lock version of a table row.
	 * If null is returned (default implemented), optimistic locking will not be supported.
	 */
331
	public function optimisticLock()
332 333 334 335
	{
		return null;
	}

336 337 338 339 340 341 342 343 344 345 346
	/**
	 * Declares which DB operations should be performed within a transaction in different scenarios.
	 * The supported DB operations are: [[OP_INSERT]], [[OP_UPDATE]] and [[OP_DELETE]],
	 * which correspond to the [[insert()]], [[update()]] and [[delete()]] methods, respectively.
	 * By default, these methods are NOT enclosed in a DB transaction.
	 *
	 * In some scenarios, to ensure data consistency, you may want to enclose some or all of them
	 * in transactions. You can do so by overriding this method and returning the operations
	 * that need to be transactional. For example,
	 *
	 * ~~~
Alexander Makarov committed
347
	 * return [
348 349 350 351 352
	 *     'admin' => self::OP_INSERT,
	 *     'api' => self::OP_INSERT | self::OP_UPDATE | self::OP_DELETE,
	 *     // the above is equivalent to the following:
	 *     // 'api' => self::OP_ALL,
	 *
Alexander Makarov committed
353
	 * ];
354 355 356 357 358 359 360 361 362 363 364
	 * ~~~
	 *
	 * The above declaration specifies that in the "admin" scenario, the insert operation ([[insert()]])
	 * should be done in a transaction; and in the "api" scenario, all the operations should be done
	 * in a transaction.
	 *
	 * @return array the declarations of transactional operations. The array keys are scenarios names,
	 * and the array values are the corresponding transaction operations.
	 */
	public function transactions()
	{
Alexander Makarov committed
365
		return [];
366 367
	}

w  
Qiang Xue committed
368
	/**
Qiang Xue committed
369
	 * PHP getter magic method.
Qiang Xue committed
370
	 * This method is overridden so that attributes and related objects can be accessed like properties.
Qiang Xue committed
371 372 373 374 375 376
	 * @param string $name property name
	 * @return mixed property value
	 * @see getAttribute
	 */
	public function __get($name)
	{
Qiang Xue committed
377
		if (isset($this->_attributes[$name]) || array_key_exists($name, $this->_attributes)) {
Qiang Xue committed
378
			return $this->_attributes[$name];
Qiang Xue committed
379
		} elseif (isset($this->getTableSchema()->columns[$name])) {
Qiang Xue committed
380
			return null;
Qiang Xue committed
381 382 383 384 385 386 387 388
		} else {
			$t = strtolower($name);
			if (isset($this->_related[$t]) || $this->_related !== null && array_key_exists($t, $this->_related)) {
				return $this->_related[$t];
			}
			$value = parent::__get($name);
			if ($value instanceof ActiveRelation) {
				return $this->_related[$t] = $value->multiple ? $value->all() : $value->one();
Qiang Xue committed
389
			} else {
Qiang Xue committed
390
				return $value;
Qiang Xue committed
391
			}
Qiang Xue committed
392 393 394 395 396 397 398 399 400 401 402
		}
	}

	/**
	 * PHP setter magic method.
	 * This method is overridden so that AR attributes can be accessed like properties.
	 * @param string $name property name
	 * @param mixed $value property value
	 */
	public function __set($name, $value)
	{
403
		if ($this->hasAttribute($name)) {
Qiang Xue committed
404 405 406 407 408 409 410 411
			$this->_attributes[$name] = $value;
		} else {
			parent::__set($name, $value);
		}
	}

	/**
	 * Checks if a property value is null.
Qiang Xue committed
412
	 * This method overrides the parent implementation by checking if the named attribute is null or not.
Qiang Xue committed
413 414 415 416
	 * @param string $name the property name or the event name
	 * @return boolean whether the property value is null
	 */
	public function __isset($name)
w  
Qiang Xue committed
417
	{
Qiang Xue committed
418 419 420 421
		try {
			return $this->__get($name) !== null;
		} catch (\Exception $e) {
			return false;
Qiang Xue committed
422 423 424 425 426 427 428 429 430 431 432
		}
	}

	/**
	 * Sets a component property to be null.
	 * This method overrides the parent implementation by clearing
	 * the specified attribute value.
	 * @param string $name the property name or the event name
	 */
	public function __unset($name)
	{
Qiang Xue committed
433
		if (isset($this->getTableSchema()->columns[$name])) {
Qiang Xue committed
434
			unset($this->_attributes[$name]);
Qiang Xue committed
435
		} else {
Qiang Xue committed
436 437 438 439 440 441
			$t = strtolower($name);
			if (isset($this->_related[$t])) {
				unset($this->_related[$t]);
			} else {
				parent::__unset($name);
			}
Qiang Xue committed
442 443 444
		}
	}

Qiang Xue committed
445 446 447 448
	/**
	 * Declares a `has-one` relation.
	 * The declaration is returned in terms of an [[ActiveRelation]] instance
	 * through which the related record can be queried and retrieved back.
Qiang Xue committed
449 450 451 452 453 454 455 456 457 458
	 *
	 * A `has-one` relation means that there is at most one related record matching
	 * the criteria set by this relation, e.g., a customer has one country.
	 *
	 * For example, to declare the `country` relation for `Customer` class, we can write
	 * the following code in the `Customer` class:
	 *
	 * ~~~
	 * public function getCountry()
	 * {
459
	 *     return $this->hasOne(Country::className(), ['id' => 'country_id']);
Qiang Xue committed
460 461 462 463 464 465 466 467 468
	 * }
	 * ~~~
	 *
	 * Note that in the above, the 'id' key in the `$link` parameter refers to an attribute name
	 * in the related class `Country`, while the 'country_id' value refers to an attribute name
	 * in the current AR class.
	 *
	 * Call methods declared in [[ActiveRelation]] to further customize the relation.
	 *
Qiang Xue committed
469 470 471 472 473 474
	 * @param string $class the class name of the related record
	 * @param array $link the primary-foreign key constraint. The keys of the array refer to
	 * the columns in the table associated with the `$class` model, while the values of the
	 * array refer to the corresponding columns in the table associated with this AR class.
	 * @return ActiveRelation the relation object.
	 */
Qiang Xue committed
475
	public function hasOne($class, $link)
Qiang Xue committed
476
	{
Alexander Makarov committed
477
		return new ActiveRelation([
478
			'modelClass' => $class,
Qiang Xue committed
479 480 481
			'primaryModel' => $this,
			'link' => $link,
			'multiple' => false,
Alexander Makarov committed
482
		]);
Qiang Xue committed
483 484
	}

Qiang Xue committed
485 486 487 488
	/**
	 * Declares a `has-many` relation.
	 * The declaration is returned in terms of an [[ActiveRelation]] instance
	 * through which the related record can be queried and retrieved back.
Qiang Xue committed
489 490 491 492 493 494 495 496 497 498
	 *
	 * A `has-many` relation means that there are multiple related records matching
	 * the criteria set by this relation, e.g., a customer has many orders.
	 *
	 * For example, to declare the `orders` relation for `Customer` class, we can write
	 * the following code in the `Customer` class:
	 *
	 * ~~~
	 * public function getOrders()
	 * {
499
	 *     return $this->hasMany(Order::className(), ['customer_id' => 'id']);
Qiang Xue committed
500 501 502 503 504 505 506
	 * }
	 * ~~~
	 *
	 * Note that in the above, the 'customer_id' key in the `$link` parameter refers to
	 * an attribute name in the related class `Order`, while the 'id' value refers to
	 * an attribute name in the current AR class.
	 *
Qiang Xue committed
507 508 509 510 511 512
	 * @param string $class the class name of the related record
	 * @param array $link the primary-foreign key constraint. The keys of the array refer to
	 * the columns in the table associated with the `$class` model, while the values of the
	 * array refer to the corresponding columns in the table associated with this AR class.
	 * @return ActiveRelation the relation object.
	 */
Qiang Xue committed
513
	public function hasMany($class, $link)
Qiang Xue committed
514
	{
Alexander Makarov committed
515
		return new ActiveRelation([
516
			'modelClass' => $class,
Qiang Xue committed
517 518 519
			'primaryModel' => $this,
			'link' => $link,
			'multiple' => true,
Alexander Makarov committed
520
		]);
Qiang Xue committed
521 522
	}

Qiang Xue committed
523
	/**
Qiang Xue committed
524 525 526 527
	 * Populates the named relation with the related records.
	 * Note that this method does not check if the relation exists or not.
	 * @param string $name the relation name (case-insensitive)
	 * @param ActiveRecord|array|null the related records to be populated into the relation.
Qiang Xue committed
528
	 */
Qiang Xue committed
529
	public function populateRelation($name, $records)
Qiang Xue committed
530
	{
Qiang Xue committed
531
		$this->_related[strtolower($name)] = $records;
Qiang Xue committed
532 533
	}

Qiang Xue committed
534 535
	/**
	 * Returns the list of all attribute names of the model.
Qiang Xue committed
536
	 * The default implementation will return all column names of the table associated with this AR class.
Qiang Xue committed
537 538
	 * @return array list of attribute names.
	 */
539
	public function attributes()
Qiang Xue committed
540
	{
Qiang Xue committed
541
		return array_keys($this->getTableSchema()->columns);
542 543
	}

w  
Qiang Xue committed
544 545 546 547 548 549 550 551 552 553
	/**
	 * Returns the named attribute value.
	 * If this record is the result of a query and the attribute is not loaded,
	 * null will be returned.
	 * @param string $name the attribute name
	 * @return mixed the attribute value. Null if the attribute is not set or does not exist.
	 * @see hasAttribute
	 */
	public function getAttribute($name)
	{
Qiang Xue committed
554
		return isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
w  
Qiang Xue committed
555 556 557 558 559 560
	}

	/**
	 * Sets the named attribute value.
	 * @param string $name the attribute name
	 * @param mixed $value the attribute value.
561
	 * @throws InvalidParamException if the named attribute does not exist.
w  
Qiang Xue committed
562 563 564 565
	 * @see hasAttribute
	 */
	public function setAttribute($name, $value)
	{
566
		if ($this->hasAttribute($name)) {
567 568 569 570
			$this->_attributes[$name] = $value;
		} else {
			throw new InvalidParamException(get_class($this) . ' has no attribute named "' . $name . '".');
		}
w  
Qiang Xue committed
571 572
	}

573 574 575 576 577 578 579 580 581 582
	/**
	 * Returns a value indicating whether the model has an attribute with the specified name.
	 * @param string $name the name of the attribute
	 * @return boolean whether the model has an attribute with the specified name.
	 */
	public function hasAttribute($name)
	{
		return isset($this->_attributes[$name]) || isset($this->getTableSchema()->columns[$name]);
	}

Qiang Xue committed
583 584 585 586 587 588
	/**
	 * Returns the old attribute values.
	 * @return array the old attribute values (name-value pairs)
	 */
	public function getOldAttributes()
	{
Alexander Makarov committed
589
		return $this->_oldAttributes === null ? [] : $this->_oldAttributes;
Qiang Xue committed
590 591 592 593 594 595 596 597 598 599 600 601
	}

	/**
	 * Sets the old attribute values.
	 * All existing old attribute values will be discarded.
	 * @param array $values old attribute values to be set.
	 */
	public function setOldAttributes($values)
	{
		$this->_oldAttributes = $values;
	}

Qiang Xue committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	/**
	 * Returns the old value of the named attribute.
	 * If this record is the result of a query and the attribute is not loaded,
	 * null will be returned.
	 * @param string $name the attribute name
	 * @return mixed the old attribute value. Null if the attribute is not loaded before
	 * or does not exist.
	 * @see hasAttribute
	 */
	public function getOldAttribute($name)
	{
		return isset($this->_oldAttributes[$name]) ? $this->_oldAttributes[$name] : null;
	}

	/**
	 * Sets the old value of the named attribute.
	 * @param string $name the attribute name
	 * @param mixed $value the old attribute value.
620
	 * @throws InvalidParamException if the named attribute does not exist.
Qiang Xue committed
621 622 623 624
	 * @see hasAttribute
	 */
	public function setOldAttribute($name, $value)
	{
625 626 627 628 629
		if (isset($this->_oldAttributes[$name]) || isset($this->getTableSchema()->columns[$name])) {
			$this->_oldAttributes[$name] = $value;
		} else {
			throw new InvalidParamException(get_class($this) . ' has no attribute named "' . $name . '".');
		}
Qiang Xue committed
630 631 632 633 634 635 636 637 638
	}

	/**
	 * Returns a value indicating whether the named attribute has been changed.
	 * @param string $name the name of the attribute
	 * @return boolean whether the attribute has been changed
	 */
	public function isAttributeChanged($name)
	{
639 640
		if (isset($this->_attributes[$name], $this->_oldAttributes[$name])) {
			return $this->_attributes[$name] !== $this->_oldAttributes[$name];
Qiang Xue committed
641
		} else {
Qiang Xue committed
642
			return isset($this->_attributes[$name]) || isset($this->_oldAttributes[$name]);
Qiang Xue committed
643 644 645
		}
	}

Qiang Xue committed
646 647 648 649 650 651
	/**
	 * Returns the attribute values that have been modified since they are loaded or saved most recently.
	 * @param string[]|null $names the names of the attributes whose values may be returned if they are
	 * changed recently. If null, [[attributes()]] will be used.
	 * @return array the changed attribute values (name-value pairs)
	 */
Qiang Xue committed
652
	public function getDirtyAttributes($names = null)
Qiang Xue committed
653 654
	{
		if ($names === null) {
655
			$names = $this->attributes();
Qiang Xue committed
656 657
		}
		$names = array_flip($names);
Alexander Makarov committed
658
		$attributes = [];
Qiang Xue committed
659
		if ($this->_oldAttributes === null) {
Qiang Xue committed
660 661 662 663 664 665 666 667 668 669
			foreach ($this->_attributes as $name => $value) {
				if (isset($names[$name])) {
					$attributes[$name] = $value;
				}
			}
		} else {
			foreach ($this->_attributes as $name => $value) {
				if (isset($names[$name]) && (!array_key_exists($name, $this->_oldAttributes) || $value !== $this->_oldAttributes[$name])) {
					$attributes[$name] = $value;
				}
w  
Qiang Xue committed
670
			}
Qiang Xue committed
671
		}
Qiang Xue committed
672
		return $attributes;
w  
Qiang Xue committed
673 674 675 676 677
	}

	/**
	 * Saves the current record.
	 *
Qiang Xue committed
678 679 680 681
	 * This method will call [[insert()]] when [[isNewRecord]] is true, or [[update()]]
	 * when [[isNewRecord]] is false.
	 *
	 * For example, to save a customer record:
w  
Qiang Xue committed
682
	 *
Qiang Xue committed
683 684 685 686 687 688
	 * ~~~
	 * $customer = new Customer;  // or $customer = Customer::find($id);
	 * $customer->name = $name;
	 * $customer->email = $email;
	 * $customer->save();
	 * ~~~
w  
Qiang Xue committed
689 690 691 692 693 694 695 696 697 698
	 *
	 *
	 * @param boolean $runValidation whether to perform validation before saving the record.
	 * If the validation fails, the record will not be saved to database.
	 * @param array $attributes list of attributes that need to be saved. Defaults to null,
	 * meaning all attributes that are loaded from DB will be saved.
	 * @return boolean whether the saving succeeds
	 */
	public function save($runValidation = true, $attributes = null)
	{
699 700 701 702 703
		if ($this->getIsNewRecord()) {
			return $this->insert($runValidation, $attributes);
		} else {
			return $this->update($runValidation, $attributes) !== false;
		}
Qiang Xue committed
704 705 706
	}

	/**
Qiang Xue committed
707 708 709 710 711 712
	 * Inserts a row into the associated database table using the attribute values of this record.
	 *
	 * This method performs the following steps in order:
	 *
	 * 1. call [[beforeValidate()]] when `$runValidation` is true. If validation
	 *    fails, it will skip the rest of the steps;
713 714
	 * 2. call [[afterValidate()]] when `$runValidation` is true.
	 * 3. call [[beforeSave()]]. If the method returns false, it will skip the
Qiang Xue committed
715
	 *    rest of the steps;
716 717
	 * 4. insert the record into database. If this fails, it will skip the rest of the steps;
	 * 5. call [[afterSave()]];
Qiang Xue committed
718
	 *
719
	 * In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
Qiang Xue committed
720 721
	 * [[EVENT_BEFORE_INSERT]], [[EVENT_AFTER_INSERT]] and [[EVENT_AFTER_VALIDATE]]
	 * will be raised by the corresponding methods.
Qiang Xue committed
722 723 724 725
	 *
	 * Only the [[changedAttributes|changed attribute values]] will be inserted into database.
	 *
	 * If the table's primary key is auto-incremental and is null during insertion,
Qiang Xue committed
726
	 * it will be populated with the actual value after insertion.
Qiang Xue committed
727 728 729 730 731 732 733 734 735 736 737 738
	 *
	 * For example, to insert a customer record:
	 *
	 * ~~~
	 * $customer = new Customer;
	 * $customer->name = $name;
	 * $customer->email = $email;
	 * $customer->insert();
	 * ~~~
	 *
	 * @param boolean $runValidation whether to perform validation before saving the record.
	 * If the validation fails, the record will not be inserted into the database.
Qiang Xue committed
739 740 741
	 * @param array $attributes list of attributes that need to be saved. Defaults to null,
	 * meaning all attributes that are loaded from DB will be saved.
	 * @return boolean whether the attributes are valid and the record is inserted successfully.
742
	 * @throws \Exception in case insert failed.
Qiang Xue committed
743
	 */
Qiang Xue committed
744
	public function insert($runValidation = true, $attributes = null)
Qiang Xue committed
745
	{
746 747 748 749
		if ($runValidation && !$this->validate($attributes)) {
			return false;
		}
		$db = static::getDb();
Qiang Xue committed
750 751 752 753
		if ($this->isTransactional(self::OP_INSERT) && $db->getTransaction() === null) {
			$transaction = $db->beginTransaction();
			try {
				$result = $this->insertInternal($attributes);
resurtm committed
754
				if ($result === false) {
755 756 757 758
					$transaction->rollback();
				} else {
					$transaction->commit();
				}
Qiang Xue committed
759
			} catch (\Exception $e) {
760
				$transaction->rollback();
Qiang Xue committed
761
				throw $e;
762
			}
Qiang Xue committed
763 764
		} else {
			$result = $this->insertInternal($attributes);
765 766 767 768 769 770 771
		}
		return $result;
	}

	/**
	 * @see ActiveRecord::insert()
	 */
resurtm committed
772
	private function insertInternal($attributes = null)
773 774
	{
		if (!$this->beforeSave(true)) {
Qiang Xue committed
775 776
			return false;
		}
777 778 779 780
		$values = $this->getDirtyAttributes($attributes);
		if (empty($values)) {
			foreach ($this->primaryKey() as $key) {
				$values[$key] = isset($this->_attributes[$key]) ? $this->_attributes[$key] : null;
Qiang Xue committed
781
			}
782 783 784
		}
		$db = static::getDb();
		$command = $db->createCommand()->insert($this->tableName(), $values);
785 786 787 788 789 790 791 792 793
		if (!$command->execute()) {
			return false;
		}
		$table = $this->getTableSchema();
		if ($table->sequenceName !== null) {
			foreach ($table->primaryKey as $name) {
				if (!isset($this->_attributes[$name])) {
					$this->_oldAttributes[$name] = $this->_attributes[$name] = $db->getLastInsertID($table->sequenceName);
					break;
Qiang Xue committed
794 795 796
				}
			}
		}
797 798 799 800 801
		foreach ($values as $name => $value) {
			$this->_oldAttributes[$name] = $value;
		}
		$this->afterSave(true);
		return true;
Qiang Xue committed
802 803 804
	}

	/**
Qiang Xue committed
805 806 807 808 809 810
	 * Saves the changes to this active record into the associated database table.
	 *
	 * This method performs the following steps in order:
	 *
	 * 1. call [[beforeValidate()]] when `$runValidation` is true. If validation
	 *    fails, it will skip the rest of the steps;
811 812
	 * 2. call [[afterValidate()]] when `$runValidation` is true.
	 * 3. call [[beforeSave()]]. If the method returns false, it will skip the
Qiang Xue committed
813
	 *    rest of the steps;
814 815
	 * 4. save the record into database. If this fails, it will skip the rest of the steps;
	 * 5. call [[afterSave()]];
Qiang Xue committed
816
	 *
817
	 * In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
Qiang Xue committed
818 819
	 * [[EVENT_BEFORE_UPDATE]], [[EVENT_AFTER_UPDATE]] and [[EVENT_AFTER_VALIDATE]]
	 * will be raised by the corresponding methods.
Qiang Xue committed
820 821 822 823 824 825 826 827 828 829 830 831
	 *
	 * Only the [[changedAttributes|changed attribute values]] will be saved into database.
	 *
	 * For example, to update a customer record:
	 *
	 * ~~~
	 * $customer = Customer::find($id);
	 * $customer->name = $name;
	 * $customer->email = $email;
	 * $customer->update();
	 * ~~~
	 *
832 833 834 835 836 837 838 839 840 841 842 843
	 * Note that it is possible the update does not affect any row in the table.
	 * In this case, this method will return 0. For this reason, you should use the following
	 * code to check if update() is successful or not:
	 *
	 * ~~~
	 * if ($this->update() !== false) {
	 *     // update successful
	 * } else {
	 *     // update failed
	 * }
	 * ~~~
	 *
Qiang Xue committed
844 845
	 * @param boolean $runValidation whether to perform validation before saving the record.
	 * If the validation fails, the record will not be inserted into the database.
Qiang Xue committed
846 847
	 * @param array $attributes list of attributes that need to be saved. Defaults to null,
	 * meaning all attributes that are loaded from DB will be saved.
848 849
	 * @return integer|boolean the number of rows affected, or false if validation fails
	 * or [[beforeSave()]] stops the updating process.
850
	 * @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
851
	 * being updated is outdated.
852
	 * @throws \Exception in case update failed.
Qiang Xue committed
853
	 */
Qiang Xue committed
854
	public function update($runValidation = true, $attributes = null)
Qiang Xue committed
855
	{
856
		if ($runValidation && !$this->validate($attributes)) {
Qiang Xue committed
857 858
			return false;
		}
859
		$db = static::getDb();
Qiang Xue committed
860 861 862 863
		if ($this->isTransactional(self::OP_UPDATE) && $db->getTransaction() === null) {
			$transaction = $db->beginTransaction();
			try {
				$result = $this->updateInternal($attributes);
resurtm committed
864
				if ($result === false) {
865 866 867
					$transaction->rollback();
				} else {
					$transaction->commit();
868
				}
Qiang Xue committed
869
			} catch (\Exception $e) {
870
				$transaction->rollback();
Qiang Xue committed
871
				throw $e;
872
			}
Qiang Xue committed
873 874
		} else {
			$result = $this->updateInternal($attributes);
875 876 877
		}
		return $result;
	}
878

879 880 881 882
	/**
	 * @see CActiveRecord::update()
	 * @throws StaleObjectException
	 */
resurtm committed
883
	private function updateInternal($attributes = null)
884 885 886 887 888 889
	{
		if (!$this->beforeSave(false)) {
			return false;
		}
		$values = $this->getDirtyAttributes($attributes);
		if (empty($values)) {
Qiang Xue committed
890
			$this->afterSave(false);
891 892 893 894 895 896 897
			return 0;
		}
		$condition = $this->getOldPrimaryKey(true);
		$lock = $this->optimisticLock();
		if ($lock !== null) {
			if (!isset($values[$lock])) {
				$values[$lock] = $this->$lock + 1;
Qiang Xue committed
898
			}
899 900 901 902 903
			$condition[$lock] = $this->$lock;
		}
		// We do not check the return value of updateAll() because it's possible
		// that the UPDATE statement doesn't change anything and thus returns 0.
		$rows = $this->updateAll($values, $condition);
904

905 906 907 908 909 910
		if ($lock !== null && !$rows) {
			throw new StaleObjectException('The object being updated is outdated.');
		}

		foreach ($values as $name => $value) {
			$this->_oldAttributes[$name] = $this->_attributes[$name];
Qiang Xue committed
911
		}
912 913
		$this->afterSave(false);
		return $rows;
Qiang Xue committed
914 915 916
	}

	/**
Qiang Xue committed
917
	 * Updates one or several counter columns for the current AR object.
Qiang Xue committed
918 919 920 921 922 923
	 * Note that this method differs from [[updateAllCounters()]] in that it only
	 * saves counters for the current AR object.
	 *
	 * An example usage is as follows:
	 *
	 * ~~~
Qiang Xue committed
924
	 * $post = Post::find($id);
Alexander Makarov committed
925
	 * $post->updateCounters(['view_count' => 1]);
Qiang Xue committed
926 927 928
	 * ~~~
	 *
	 * @param array $counters the counters to be updated (attribute name => increment value)
Qiang Xue committed
929
	 * Use negative values if you want to decrement the counters.
Qiang Xue committed
930 931 932 933 934
	 * @return boolean whether the saving is successful
	 * @see updateAllCounters()
	 */
	public function updateCounters($counters)
	{
Qiang Xue committed
935 936 937 938 939 940 941 942
		if ($this->updateAllCounters($counters, $this->getOldPrimaryKey(true)) > 0) {
			foreach ($counters as $name => $value) {
				$this->_attributes[$name] += $value;
				$this->_oldAttributes[$name] = $this->_attributes[$name];
			}
			return true;
		} else {
			return false;
Qiang Xue committed
943 944 945 946
		}
	}

	/**
Qiang Xue committed
947 948 949 950 951 952 953 954 955
	 * Deletes the table row corresponding to this active record.
	 *
	 * This method performs the following steps in order:
	 *
	 * 1. call [[beforeDelete()]]. If the method returns false, it will skip the
	 *    rest of the steps;
	 * 2. delete the record from the database;
	 * 3. call [[afterDelete()]].
	 *
Qiang Xue committed
956
	 * In the above step 1 and 3, events named [[EVENT_BEFORE_DELETE]] and [[EVENT_AFTER_DELETE]]
Qiang Xue committed
957 958
	 * will be raised by the corresponding methods.
	 *
959 960
	 * @return integer|boolean the number of rows deleted, or false if the deletion is unsuccessful for some reason.
	 * Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful.
961
	 * @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
962
	 * being deleted is outdated.
963
	 * @throws \Exception in case delete failed.
Qiang Xue committed
964 965 966
	 */
	public function delete()
	{
967
		$db = static::getDb();
968
		$transaction = $this->isTransactional(self::OP_DELETE) && $db->getTransaction() === null ? $db->beginTransaction() : null;
969 970 971 972 973 974 975
		try {
			$result = false;
			if ($this->beforeDelete()) {
				// we do not check the return value of deleteAll() because it's possible
				// the record is already deleted in the database and thus the method will return 0
				$condition = $this->getOldPrimaryKey(true);
				$lock = $this->optimisticLock();
resurtm committed
976
				if ($lock !== null) {
977 978 979
					$condition[$lock] = $this->$lock;
				}
				$result = $this->deleteAll($condition);
resurtm committed
980
				if ($lock !== null && !$result) {
981 982 983 984
					throw new StaleObjectException('The object being deleted is outdated.');
				}
				$this->_oldAttributes = null;
				$this->afterDelete();
985
			}
resurtm committed
986 987
			if ($transaction !== null) {
				if ($result === false) {
988 989 990 991
					$transaction->rollback();
				} else {
					$transaction->commit();
				}
992
			}
993
		} catch (\Exception $e) {
resurtm committed
994
			if ($transaction !== null) {
995 996 997
				$transaction->rollback();
			}
			throw $e;
Qiang Xue committed
998
		}
999
		return $result;
w  
Qiang Xue committed
1000 1001 1002
	}

	/**
Qiang Xue committed
1003
	 * Returns a value indicating whether the current record is new.
Qiang Xue committed
1004
	 * @return boolean whether the record is new and should be inserted when calling [[save()]].
w  
Qiang Xue committed
1005 1006 1007
	 */
	public function getIsNewRecord()
	{
Qiang Xue committed
1008
		return $this->_oldAttributes === null;
w  
Qiang Xue committed
1009 1010
	}

Qiang Xue committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
	/**
	 * Sets the value indicating whether the record is new.
	 * @param boolean $value whether the record is new and should be inserted when calling [[save()]].
	 * @see getIsNewRecord
	 */
	public function setIsNewRecord($value)
	{
		$this->_oldAttributes = $value ? null : $this->_attributes;
	}

1021 1022 1023
	/**
	 * Initializes the object.
	 * This method is called at the end of the constructor.
Qiang Xue committed
1024
	 * The default implementation will trigger an [[EVENT_INIT]] event.
1025 1026 1027 1028 1029 1030
	 * If you override this method, make sure you call the parent implementation at the end
	 * to ensure triggering of the event.
	 */
	public function init()
	{
		parent::init();
1031
		$this->trigger(self::EVENT_INIT);
1032 1033 1034 1035
	}

	/**
	 * This method is called when the AR object is created and populated with the query result.
Qiang Xue committed
1036
	 * The default implementation will trigger an [[EVENT_AFTER_FIND]] event.
1037 1038 1039 1040 1041
	 * When overriding this method, make sure you call the parent implementation to ensure the
	 * event is triggered.
	 */
	public function afterFind()
	{
1042
		$this->trigger(self::EVENT_AFTER_FIND);
1043 1044
	}

Qiang Xue committed
1045 1046
	/**
	 * This method is called at the beginning of inserting or updating a record.
Qiang Xue committed
1047 1048
	 * The default implementation will trigger an [[EVENT_BEFORE_INSERT]] event when `$insert` is true,
	 * or an [[EVENT_BEFORE_UPDATE]] event if `$insert` is false.
Qiang Xue committed
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	 * When overriding this method, make sure you call the parent implementation like the following:
	 *
	 * ~~~
	 * public function beforeSave($insert)
	 * {
	 *     if (parent::beforeSave($insert)) {
	 *         // ...custom code here...
	 *         return true;
	 *     } else {
	 *         return false;
	 *     }
	 * }
	 * ~~~
	 *
	 * @param boolean $insert whether this method called while inserting a record.
	 * If false, it means the method is called while updating a record.
	 * @return boolean whether the insertion or updating should continue.
	 * If false, the insertion or updating will be cancelled.
	 */
Qiang Xue committed
1068
	public function beforeSave($insert)
w  
Qiang Xue committed
1069
	{
Qiang Xue committed
1070
		$event = new ModelEvent;
1071
		$this->trigger($insert ? self::EVENT_BEFORE_INSERT : self::EVENT_BEFORE_UPDATE, $event);
Qiang Xue committed
1072
		return $event->isValid;
w  
Qiang Xue committed
1073 1074
	}

Qiang Xue committed
1075 1076
	/**
	 * This method is called at the end of inserting or updating a record.
Qiang Xue committed
1077 1078
	 * The default implementation will trigger an [[EVENT_AFTER_INSERT]] event when `$insert` is true,
	 * or an [[EVENT_AFTER_UPDATE]] event if `$insert` is false.
Qiang Xue committed
1079 1080 1081 1082 1083
	 * When overriding this method, make sure you call the parent implementation so that
	 * the event is triggered.
	 * @param boolean $insert whether this method called while inserting a record.
	 * If false, it means the method is called while updating a record.
	 */
Qiang Xue committed
1084
	public function afterSave($insert)
w  
Qiang Xue committed
1085
	{
1086
		$this->trigger($insert ? self::EVENT_AFTER_INSERT : self::EVENT_AFTER_UPDATE);
w  
Qiang Xue committed
1087 1088 1089 1090
	}

	/**
	 * This method is invoked before deleting a record.
Qiang Xue committed
1091
	 * The default implementation raises the [[EVENT_BEFORE_DELETE]] event.
Qiang Xue committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	 * When overriding this method, make sure you call the parent implementation like the following:
	 *
	 * ~~~
	 * public function beforeDelete()
	 * {
	 *     if (parent::beforeDelete()) {
	 *         // ...custom code here...
	 *         return true;
	 *     } else {
	 *         return false;
	 *     }
	 * }
	 * ~~~
	 *
w  
Qiang Xue committed
1106 1107
	 * @return boolean whether the record should be deleted. Defaults to true.
	 */
Qiang Xue committed
1108
	public function beforeDelete()
w  
Qiang Xue committed
1109
	{
Qiang Xue committed
1110
		$event = new ModelEvent;
1111
		$this->trigger(self::EVENT_BEFORE_DELETE, $event);
Qiang Xue committed
1112
		return $event->isValid;
w  
Qiang Xue committed
1113 1114 1115 1116
	}

	/**
	 * This method is invoked after deleting a record.
Qiang Xue committed
1117
	 * The default implementation raises the [[EVENT_AFTER_DELETE]] event.
w  
Qiang Xue committed
1118 1119 1120
	 * You may override this method to do postprocessing after the record is deleted.
	 * Make sure you call the parent implementation so that the event is raised properly.
	 */
Qiang Xue committed
1121
	public function afterDelete()
w  
Qiang Xue committed
1122
	{
1123
		$this->trigger(self::EVENT_AFTER_DELETE);
w  
Qiang Xue committed
1124 1125 1126
	}

	/**
Qiang Xue committed
1127
	 * Repopulates this active record with the latest data.
Qiang Xue committed
1128
	 * @return boolean whether the row still exists in the database. If true, the latest data
1129
	 * will be populated to this active record. Otherwise, this record will remain unchanged.
w  
Qiang Xue committed
1130
	 */
1131
	public function refresh()
w  
Qiang Xue committed
1132
	{
Qiang Xue committed
1133
		$record = $this->find($this->getPrimaryKey(true));
Qiang Xue committed
1134 1135 1136
		if ($record === null) {
			return false;
		}
1137 1138
		foreach ($this->attributes() as $name) {
			$this->_attributes[$name] = $record->_attributes[$name];
w  
Qiang Xue committed
1139
		}
1140 1141
		$this->_oldAttributes = $this->_attributes;
		$this->_related = null;
Qiang Xue committed
1142
		return true;
w  
Qiang Xue committed
1143 1144 1145
	}

	/**
Qiang Xue committed
1146 1147
	 * Returns a value indicating whether the given active record is the same as the current one.
	 * The comparison is made by comparing the table names and the primary key values of the two active records.
Qiang Xue committed
1148
	 * @param ActiveRecord $record record to compare to
Qiang Xue committed
1149
	 * @return boolean whether the two active records refer to the same row in the same database table.
w  
Qiang Xue committed
1150
	 */
Qiang Xue committed
1151
	public function equals($record)
w  
Qiang Xue committed
1152
	{
Qiang Xue committed
1153
		return $this->tableName() === $record->tableName() && $this->getPrimaryKey() === $record->getPrimaryKey();
w  
Qiang Xue committed
1154 1155 1156
	}

	/**
Qiang Xue committed
1157
	 * Returns the primary key value(s).
Qiang Xue committed
1158
	 * @param boolean $asArray whether to return the primary key value as an array. If true,
Qiang Xue committed
1159
	 * the return value will be an array with column names as keys and column values as values.
1160
	 * Note that for composite primary keys, an array will always be returned regardless of this parameter value.
resurtm committed
1161
	 * @return mixed the primary key value. An array (column name => column value) is returned if the primary key
Qiang Xue committed
1162 1163
	 * is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
	 * the key value is null).
w  
Qiang Xue committed
1164
	 */
Qiang Xue committed
1165
	public function getPrimaryKey($asArray = false)
w  
Qiang Xue committed
1166
	{
Qiang Xue committed
1167 1168 1169
		$keys = $this->primaryKey();
		if (count($keys) === 1 && !$asArray) {
			return isset($this->_attributes[$keys[0]]) ? $this->_attributes[$keys[0]] : null;
Qiang Xue committed
1170
		} else {
Alexander Makarov committed
1171
			$values = [];
Qiang Xue committed
1172
			foreach ($keys as $name) {
Qiang Xue committed
1173
				$values[$name] = isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
Qiang Xue committed
1174 1175
			}
			return $values;
w  
Qiang Xue committed
1176 1177 1178 1179
		}
	}

	/**
Qiang Xue committed
1180
	 * Returns the old primary key value(s).
Qiang Xue committed
1181 1182 1183
	 * This refers to the primary key value that is populated into the record
	 * after executing a find method (e.g. find(), findAll()).
	 * The value remains unchanged even if the primary key attribute is manually assigned with a different value.
Qiang Xue committed
1184 1185
	 * @param boolean $asArray whether to return the primary key value as an array. If true,
	 * the return value will be an array with column name as key and column value as value.
Qiang Xue committed
1186
	 * If this is false (default), a scalar value will be returned for non-composite primary key.
resurtm committed
1187
	 * @return mixed the old primary key value. An array (column name => column value) is returned if the primary key
Qiang Xue committed
1188 1189
	 * is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
	 * the key value is null).
w  
Qiang Xue committed
1190
	 */
Qiang Xue committed
1191
	public function getOldPrimaryKey($asArray = false)
w  
Qiang Xue committed
1192
	{
Qiang Xue committed
1193 1194 1195
		$keys = $this->primaryKey();
		if (count($keys) === 1 && !$asArray) {
			return isset($this->_oldAttributes[$keys[0]]) ? $this->_oldAttributes[$keys[0]] : null;
Qiang Xue committed
1196
		} else {
Alexander Makarov committed
1197
			$values = [];
Qiang Xue committed
1198
			foreach ($keys as $name) {
Qiang Xue committed
1199 1200 1201 1202
				$values[$name] = isset($this->_oldAttributes[$name]) ? $this->_oldAttributes[$name] : null;
			}
			return $values;
		}
w  
Qiang Xue committed
1203 1204 1205
	}

	/**
Qiang Xue committed
1206
	 * Creates an active record object using a row of data.
Qiang Xue committed
1207
	 * This method is called by [[ActiveQuery]] to populate the query results
1208
	 * into Active Records. It is not meant to be used to create new records.
Qiang Xue committed
1209 1210
	 * @param array $row attribute values (name => value)
	 * @return ActiveRecord the newly created active record.
w  
Qiang Xue committed
1211
	 */
Qiang Xue committed
1212
	public static function create($row)
w  
Qiang Xue committed
1213
	{
Qiang Xue committed
1214
		$record = static::instantiate($row);
1215
		$columns = static::getTableSchema()->columns;
Qiang Xue committed
1216
		foreach ($row as $name => $value) {
Qiang Xue committed
1217
			if (isset($columns[$name])) {
Qiang Xue committed
1218
				$record->_attributes[$name] = $value;
Qiang Xue committed
1219
			} else {
Qiang Xue committed
1220
				$record->$name = $value;
w  
Qiang Xue committed
1221 1222
			}
		}
Qiang Xue committed
1223
		$record->_oldAttributes = $record->_attributes;
1224
		$record->afterFind();
Qiang Xue committed
1225
		return $record;
w  
Qiang Xue committed
1226 1227 1228 1229
	}

	/**
	 * Creates an active record instance.
Qiang Xue committed
1230
	 * This method is called by [[create()]].
w  
Qiang Xue committed
1231
	 * You may override this method if the instance being created
Qiang Xue committed
1232
	 * depends on the row data to be populated into the record.
w  
Qiang Xue committed
1233 1234
	 * For example, by creating a record based on the value of a column,
	 * you may implement the so-called single-table inheritance mapping.
Qiang Xue committed
1235 1236
	 * @param array $row row data to be populated into the record.
	 * @return ActiveRecord the newly created active record
w  
Qiang Xue committed
1237
	 */
Qiang Xue committed
1238
	public static function instantiate($row)
w  
Qiang Xue committed
1239
	{
Qiang Xue committed
1240
		return new static;
w  
Qiang Xue committed
1241 1242 1243 1244 1245 1246
	}

	/**
	 * Returns whether there is an element at the specified offset.
	 * This method is required by the interface ArrayAccess.
	 * @param mixed $offset the offset to check on
Qiang Xue committed
1247
	 * @return boolean whether there is an element at the specified offset.
w  
Qiang Xue committed
1248 1249 1250 1251 1252
	 */
	public function offsetExists($offset)
	{
		return $this->__isset($offset);
	}
Qiang Xue committed
1253

Qiang Xue committed
1254
	/**
Qiang Xue committed
1255 1256 1257 1258 1259
	 * Returns the relation object with the specified name.
	 * A relation is defined by a getter method which returns an [[ActiveRelation]] object.
	 * It can be declared in either the Active Record class itself or one of its behaviors.
	 * @param string $name the relation name
	 * @return ActiveRelation the relation object
Qiang Xue committed
1260
	 * @throws InvalidParamException if the named relation does not exist.
Qiang Xue committed
1261 1262 1263 1264 1265 1266 1267 1268 1269
	 */
	public function getRelation($name)
	{
		$getter = 'get' . $name;
		try {
			$relation = $this->$getter();
			if ($relation instanceof ActiveRelation) {
				return $relation;
			}
Qiang Xue committed
1270
		} catch (UnknownMethodException $e) {
1271
			throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e);
Qiang Xue committed
1272 1273 1274
		}
	}

Qiang Xue committed
1275
	/**
Qiang Xue committed
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
	 * Establishes the relationship between two models.
	 *
	 * The relationship is established by setting the foreign key value(s) in one model
	 * to be the corresponding primary key value(s) in the other model.
	 * The model with the foreign key will be saved into database without performing validation.
	 *
	 * If the relationship involves a pivot table, a new row will be inserted into the
	 * pivot table which contains the primary key values from both models.
	 *
	 * Note that this method requires that the primary key value is not null.
	 *
	 * @param string $name the name of the relationship
	 * @param ActiveRecord $model the model to be linked with the current one.
	 * @param array $extraColumns additional column values to be saved into the pivot table.
	 * This parameter is only meaningful for a relationship involving a pivot table
	 * (i.e., a relation set with `[[ActiveRelation::via()]]` or `[[ActiveRelation::viaTable()]]`.)
Qiang Xue committed
1292
	 * @throws InvalidCallException if the method is unable to link two models.
Qiang Xue committed
1293
	 */
Alexander Makarov committed
1294
	public function link($name, $model, $extraColumns = [])
Qiang Xue committed
1295
	{
1296 1297 1298
		$relation = $this->getRelation($name);

		if ($relation->via !== null) {
Qiang Xue committed
1299 1300 1301
			if ($this->getIsNewRecord() || $model->getIsNewRecord()) {
				throw new InvalidCallException('Unable to link models: both models must NOT be newly created.');
			}
1302
			if (is_array($relation->via)) {
Qiang Xue committed
1303 1304
				/** @var $viaRelation ActiveRelation */
				list($viaName, $viaRelation) = $relation->via;
1305
				/** @var $viaClass ActiveRecord */
Qiang Xue committed
1306
				$viaClass = $viaRelation->modelClass;
1307
				$viaTable = $viaClass::tableName();
Qiang Xue committed
1308
				// unset $viaName so that it can be reloaded to reflect the change
Qiang Xue committed
1309
				unset($this->_related[strtolower($viaName)]);
1310
			} else {
Qiang Xue committed
1311
				$viaRelation = $relation->via;
1312 1313
				$viaTable = reset($relation->via->from);
			}
Alexander Makarov committed
1314
			$columns = [];
Qiang Xue committed
1315
			foreach ($viaRelation->link as $a => $b) {
1316 1317 1318 1319 1320
				$columns[$a] = $this->$b;
			}
			foreach ($relation->link as $a => $b) {
				$columns[$b] = $model->$a;
			}
Qiang Xue committed
1321
			foreach ($extraColumns as $k => $v) {
1322 1323
				$columns[$k] = $v;
			}
Qiang Xue committed
1324
			static::getDb()->createCommand()
Qiang Xue committed
1325 1326 1327 1328 1329 1330
				->insert($viaTable, $columns)->execute();
		} else {
			$p1 = $model->isPrimaryKey(array_keys($relation->link));
			$p2 = $this->isPrimaryKey(array_values($relation->link));
			if ($p1 && $p2) {
				if ($this->getIsNewRecord() && $model->getIsNewRecord()) {
Qiang Xue committed
1331
					throw new InvalidCallException('Unable to link models: both models are newly created.');
Qiang Xue committed
1332 1333
				} elseif ($this->getIsNewRecord()) {
					$this->bindModels(array_flip($relation->link), $this, $model);
Qiang Xue committed
1334
				} else {
Qiang Xue committed
1335
					$this->bindModels($relation->link, $model, $this);
1336
				}
Qiang Xue committed
1337 1338 1339 1340
			} elseif ($p1) {
				$this->bindModels(array_flip($relation->link), $this, $model);
			} elseif ($p2) {
				$this->bindModels($relation->link, $model, $this);
1341
			} else {
Qiang Xue committed
1342
				throw new InvalidCallException('Unable to link models: the link does not involve any primary key.');
1343 1344
			}
		}
Qiang Xue committed
1345

Qiang Xue committed
1346
		// update lazily loaded related objects
Qiang Xue committed
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
		if (!$relation->multiple) {
			$this->_related[$name] = $model;
		} elseif (isset($this->_related[$name])) {
			if ($relation->indexBy !== null) {
				$indexBy = $relation->indexBy;
				$this->_related[$name][$model->$indexBy] = $model;
			} else {
				$this->_related[$name][] = $model;
			}
		}
1357 1358 1359
	}

	/**
Qiang Xue committed
1360 1361 1362 1363 1364 1365 1366
	 * Destroys the relationship between two models.
	 *
	 * The model with the foreign key of the relationship will be deleted if `$delete` is true.
	 * Otherwise, the foreign key will be set null and the model will be saved without validation.
	 *
	 * @param string $name the name of the relationship.
	 * @param ActiveRecord $model the model to be unlinked from the current one.
Qiang Xue committed
1367 1368
	 * @param boolean $delete whether to delete the model that contains the foreign key.
	 * If false, the model's foreign key will be set null and saved.
Qiang Xue committed
1369
	 * If true, the model containing the foreign key will be deleted.
Qiang Xue committed
1370
	 * @throws InvalidCallException if the models cannot be unlinked
1371
	 */
Qiang Xue committed
1372
	public function unlink($name, $model, $delete = false)
1373 1374 1375 1376 1377
	{
		$relation = $this->getRelation($name);

		if ($relation->via !== null) {
			if (is_array($relation->via)) {
Qiang Xue committed
1378 1379
				/** @var $viaRelation ActiveRelation */
				list($viaName, $viaRelation) = $relation->via;
1380
				/** @var $viaClass ActiveRecord */
Qiang Xue committed
1381
				$viaClass = $viaRelation->modelClass;
1382
				$viaTable = $viaClass::tableName();
Qiang Xue committed
1383
				unset($this->_related[strtolower($viaName)]);
1384
			} else {
Qiang Xue committed
1385
				$viaRelation = $relation->via;
1386 1387
				$viaTable = reset($relation->via->from);
			}
Alexander Makarov committed
1388
			$columns = [];
Qiang Xue committed
1389
			foreach ($viaRelation->link as $a => $b) {
1390 1391 1392 1393 1394
				$columns[$a] = $this->$b;
			}
			foreach ($relation->link as $a => $b) {
				$columns[$b] = $model->$a;
			}
Qiang Xue committed
1395
			$command = static::getDb()->createCommand();
Qiang Xue committed
1396 1397 1398
			if ($delete) {
				$command->delete($viaTable, $columns)->execute();
			} else {
Alexander Makarov committed
1399
				$nulls = [];
Qiang Xue committed
1400 1401 1402 1403
				foreach (array_keys($columns) as $a) {
					$nulls[$a] = null;
				}
				$command->update($viaTable, $nulls, $columns)->execute();
1404 1405
			}
		} else {
Qiang Xue committed
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
			$p1 = $model->isPrimaryKey(array_keys($relation->link));
			$p2 = $this->isPrimaryKey(array_values($relation->link));
			if ($p1 && $p2 || $p2) {
				foreach ($relation->link as $a => $b) {
					$model->$a = null;
				}
				$delete ? $model->delete() : $model->save(false);
			} elseif ($p1) {
				foreach ($relation->link as $b) {
					$this->$b = null;
				}
				$delete ? $this->delete() : $this->save(false);
			} else {
Qiang Xue committed
1419
				throw new InvalidCallException('Unable to unlink models: the link does not involve any primary key.');
Qiang Xue committed
1420
			}
1421
		}
Qiang Xue committed
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432

		if (!$relation->multiple) {
			unset($this->_related[$name]);
		} elseif (isset($this->_related[$name])) {
			/** @var $b ActiveRecord */
			foreach ($this->_related[$name] as $a => $b) {
				if ($model->getPrimaryKey() == $b->getPrimaryKey()) {
					unset($this->_related[$name][$a]);
				}
			}
		}
1433 1434 1435
	}

	/**
Qiang Xue committed
1436 1437 1438
	 * @param array $link
	 * @param ActiveRecord $foreignModel
	 * @param ActiveRecord $primaryModel
Qiang Xue committed
1439
	 * @throws InvalidCallException
1440
	 */
Qiang Xue committed
1441
	private function bindModels($link, $foreignModel, $primaryModel)
1442
	{
Qiang Xue committed
1443 1444 1445
		foreach ($link as $fk => $pk) {
			$value = $primaryModel->$pk;
			if ($value === null) {
Qiang Xue committed
1446
				throw new InvalidCallException('Unable to link models: the primary key of ' . get_class($primaryModel) . ' is null.');
Qiang Xue committed
1447
			}
Qiang Xue committed
1448
			$foreignModel->$fk = $value;
Qiang Xue committed
1449
		}
Qiang Xue committed
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
		$foreignModel->save(false);
	}

	/**
	 * @param array $keys
	 * @return boolean
	 */
	private function isPrimaryKey($keys)
	{
		$pks = $this->primaryKey();
		foreach ($keys as $key) {
			if (!in_array($key, $pks, true)) {
				return false;
			}
		}
		return true;
Qiang Xue committed
1466
	}
1467 1468

	/**
1469 1470 1471
	 * Returns a value indicating whether the specified operation is transactional in the current [[scenario]].
	 * @param integer $operation the operation to check. Possible values are [[OP_INSERT]], [[OP_UPDATE]] and [[OP_DELETE]].
	 * @return boolean whether the specified operation is transactional in the current [[scenario]].
1472
	 */
1473
	public function isTransactional($operation)
1474 1475
	{
		$scenario = $this->getScenario();
1476 1477
		$transactions = $this->transactions();
		return isset($transactions[$scenario]) && ($transactions[$scenario] & $operation);
1478
	}
w  
Qiang Xue committed
1479
}