ActiveRecord.php 49.1 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
 *
Qiang Xue committed
25
 * @property Connection $db the database connection used by this AR class.
Qiang Xue committed
26 27 28
 * @property TableSchema $tableSchema the schema information of the DB table associated with this AR class.
 * @property array $oldAttributes the old attribute values (name-value pairs).
 * @property array $dirtyAttributes the changed attribute values (name-value pairs).
29
 * @property boolean $isNewRecord whether the record is new and should be inserted when calling [[save()]].
Qiang Xue committed
30 31 32
 * @property mixed $primaryKey the primary key value.
 * @property mixed $oldPrimaryKey the old primary key value.
 *
Qiang Xue committed
33 34
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
w  
Qiang Xue committed
35
 */
Qiang Xue committed
36
class ActiveRecord extends Model
w  
Qiang Xue committed
37
{
38 39 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
	/**
	 * @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';

74 75 76 77
	/**
	 * Represents insert ActiveRecord operation. This constant is used for specifying set of atomic operations
	 * for particular scenario in the [[scenarios()]] method.
	 */
resurtm committed
78
	const OP_INSERT = 'insert';
79 80 81 82
	/**
	 * Represents update ActiveRecord operation. This constant is used for specifying set of atomic operations
	 * for particular scenario in the [[scenarios()]] method.
	 */
resurtm committed
83
	const OP_UPDATE = 'update';
84 85 86 87
	/**
	 * Represents delete ActiveRecord operation. This constant is used for specifying set of atomic operations
	 * for particular scenario in the [[scenarios()]] method.
	 */
resurtm committed
88
	const OP_DELETE = 'delete';
89

w  
Qiang Xue committed
90
	/**
Qiang Xue committed
91 92 93 94 95
	 * @var array attribute values indexed by attribute names
	 */
	private $_attributes = array();
	/**
	 * @var array old attribute values indexed by attribute names.
w  
Qiang Xue committed
96
	 */
Qiang Xue committed
97
	private $_oldAttributes;
98
	/**
Qiang Xue committed
99
	 * @var array related models indexed by the relation names
100
	 */
Qiang Xue committed
101 102
	private $_related;

103

Qiang Xue committed
104 105 106 107 108 109
	/**
	 * 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
110
	public static function getDb()
Qiang Xue committed
111
	{
Qiang Xue committed
112
		return \Yii::$app->getDb();
Qiang Xue committed
113 114
	}

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

Qiang Xue committed
150
	/**
Qiang Xue committed
151 152 153 154 155 156 157 158 159 160 161 162 163
	 * 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
164 165
	 * @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
166
	 * @return ActiveQuery the newly created [[ActiveQuery]] instance
Qiang Xue committed
167
	 */
Qiang Xue committed
168
	public static function findBySql($sql, $params = array())
w  
Qiang Xue committed
169
	{
Qiang Xue committed
170
		$query = static::createQuery();
Qiang Xue committed
171 172 173 174 175 176
		$query->sql = $sql;
		return $query->params($params);
	}

	/**
	 * Updates the whole table using the provided attribute values and conditions.
Qiang Xue committed
177 178 179 180 181 182 183 184
	 * For example, to change the status to be 1 for all customers whose status is 2:
	 *
	 * ~~~
	 * Customer::updateAll(array('status' => 1), 'status = 2');
	 * ~~~
	 *
	 * @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
185
	 * Please refer to [[Query::where()]] on how to specify this parameter.
resurtm committed
186
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
187 188
	 * @return integer the number of rows updated
	 */
Qiang Xue committed
189
	public static function updateAll($attributes, $condition = '', $params = array())
w  
Qiang Xue committed
190
	{
Qiang Xue committed
191
		$command = static::getDb()->createCommand();
Qiang Xue committed
192 193
		$command->update(static::tableName(), $attributes, $condition, $params);
		return $command->execute();
w  
Qiang Xue committed
194 195
	}

Qiang Xue committed
196
	/**
Qiang Xue committed
197 198 199 200 201 202 203
	 * Updates the whole table using the provided counter changes and conditions.
	 * For example, to increment all customers' age by 1,
	 *
	 * ~~~
	 * Customer::updateAllCounters(array('age' => 1));
	 * ~~~
	 *
Qiang Xue committed
204
	 * @param array $counters the counters to be updated (attribute name => increment value).
Qiang Xue committed
205 206
	 * 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
207
	 * Please refer to [[Query::where()]] on how to specify this parameter.
resurtm committed
208
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
209
	 * Do not name the parameters as `:bp0`, `:bp1`, etc., because they are used internally by this method.
Qiang Xue committed
210 211 212
	 * @return integer the number of rows updated
	 */
	public static function updateAllCounters($counters, $condition = '', $params = array())
w  
Qiang Xue committed
213
	{
Qiang Xue committed
214
		$n = 0;
Qiang Xue committed
215
		foreach ($counters as $name => $value) {
216
			$counters[$name] = new Expression("[[$name]]+:bp{$n}", array(":bp{$n}" => $value));
Qiang Xue committed
217
			$n++;
Qiang Xue committed
218
		}
219
		$command = static::getDb()->createCommand();
Qiang Xue committed
220 221
		$command->update(static::tableName(), $counters, $condition, $params);
		return $command->execute();
w  
Qiang Xue committed
222 223
	}

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

.  
Qiang Xue committed
246
	/**
Qiang Xue committed
247 248 249 250
	 * 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
251
	 * @return ActiveQuery the newly created [[ActiveQuery]] instance.
.  
Qiang Xue committed
252
	 */
Qiang Xue committed
253
	public static function createQuery()
w  
Qiang Xue committed
254
	{
Qiang Xue committed
255 256 257
		return new ActiveQuery(array(
			'modelClass' => get_called_class(),
		));
w  
Qiang Xue committed
258 259 260
	}

	/**
Qiang Xue committed
261
	 * Declares the name of the database table associated with this AR class.
262
	 * By default this method returns the class name as the table name by calling [[Inflector::camel2id()]]
Qiang Xue committed
263 264
	 * 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
265 266
	 * @return string the table name
	 */
Qiang Xue committed
267
	public static function tableName()
w  
Qiang Xue committed
268
	{
269
		return 'tbl_' . Inflector::camel2id(StringHelper::basename(get_called_class()), '_');
w  
Qiang Xue committed
270 271 272
	}

	/**
Qiang Xue committed
273 274
	 * 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.
275
	 * @throws InvalidConfigException if the table for the AR class does not exist.
w  
Qiang Xue committed
276
	 */
Qiang Xue committed
277
	public static function getTableSchema()
w  
Qiang Xue committed
278
	{
279 280 281 282 283 284
		$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
285 286 287
	}

	/**
Qiang Xue committed
288 289
	 * Returns the primary key name(s) for this AR class.
	 * The default implementation will return the primary key(s) as declared
Qiang Xue committed
290
	 * in the DB table that is associated with this AR class.
Qiang Xue committed
291
	 *
Qiang Xue committed
292 293 294
	 * 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
295 296 297
	 *
	 * Note that an array should be returned even for a table with single primary key.
	 *
Qiang Xue committed
298
	 * @return string[] the primary keys of the associated database table.
w  
Qiang Xue committed
299
	 */
Qiang Xue committed
300
	public static function primaryKey()
w  
Qiang Xue committed
301
	{
Qiang Xue committed
302
		return static::getTableSchema()->primaryKey;
w  
Qiang Xue committed
303 304
	}

305
	/**
306
	 * Returns the name of the column that stores the lock version for implementing optimistic locking.
307
	 *
308 309 310 311
	 * 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.
312 313 314 315 316
	 *
	 * Optimized locking is only supported by [[update()]] and [[delete()]].
	 *
	 * To use optimized locking:
	 *
317
	 * 1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`.
318
	 *    Override this method to return the name of this column.
319 320 321 322 323 324 325 326 327
	 * 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.
	 */
328
	public function optimisticLock()
329 330 331 332
	{
		return null;
	}

w  
Qiang Xue committed
333
	/**
Qiang Xue committed
334
	 * PHP getter magic method.
Qiang Xue committed
335
	 * This method is overridden so that attributes and related objects can be accessed like properties.
Qiang Xue committed
336 337 338 339 340 341
	 * @param string $name property name
	 * @return mixed property value
	 * @see getAttribute
	 */
	public function __get($name)
	{
Qiang Xue committed
342
		if (isset($this->_attributes[$name]) || array_key_exists($name, $this->_attributes)) {
Qiang Xue committed
343
			return $this->_attributes[$name];
Qiang Xue committed
344
		} elseif (isset($this->getTableSchema()->columns[$name])) {
Qiang Xue committed
345
			return null;
Qiang Xue committed
346 347 348 349 350 351 352 353
		} 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
354
			} else {
Qiang Xue committed
355
				return $value;
Qiang Xue committed
356
			}
Qiang Xue committed
357 358 359 360 361 362 363 364 365 366 367
		}
	}

	/**
	 * 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)
	{
Qiang Xue committed
368
		if (isset($this->_attributes[$name]) || isset($this->getTableSchema()->columns[$name])) {
Qiang Xue committed
369 370 371 372 373 374 375 376
			$this->_attributes[$name] = $value;
		} else {
			parent::__set($name, $value);
		}
	}

	/**
	 * Checks if a property value is null.
Qiang Xue committed
377
	 * This method overrides the parent implementation by checking if the named attribute is null or not.
Qiang Xue committed
378 379 380 381
	 * @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
382
	{
Qiang Xue committed
383 384 385 386
		try {
			return $this->__get($name) !== null;
		} catch (\Exception $e) {
			return false;
Qiang Xue committed
387 388 389 390 391 392 393 394 395 396 397
		}
	}

	/**
	 * 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
398
		if (isset($this->getTableSchema()->columns[$name])) {
Qiang Xue committed
399
			unset($this->_attributes[$name]);
Qiang Xue committed
400
		} else {
Qiang Xue committed
401 402 403 404 405 406
			$t = strtolower($name);
			if (isset($this->_related[$t])) {
				unset($this->_related[$t]);
			} else {
				parent::__unset($name);
			}
Qiang Xue committed
407 408 409
		}
	}

Qiang Xue committed
410 411 412 413
	/**
	 * 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
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
	 *
	 * 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()
	 * {
	 *     return $this->hasOne('Country', array('id' => 'country_id'));
	 * }
	 * ~~~
	 *
	 * 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
434 435 436 437 438 439
	 * @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
440
	public function hasOne($class, $link)
Qiang Xue committed
441
	{
Qiang Xue committed
442 443 444 445 446 447
		return new ActiveRelation(array(
			'modelClass' => $this->getNamespacedClass($class),
			'primaryModel' => $this,
			'link' => $link,
			'multiple' => false,
		));
Qiang Xue committed
448 449
	}

Qiang Xue committed
450 451 452 453
	/**
	 * 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
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
	 *
	 * 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()
	 * {
	 *     return $this->hasMany('Order', array('customer_id' => 'id'));
	 * }
	 * ~~~
	 *
	 * 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
472 473 474 475 476 477
	 * @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
478
	public function hasMany($class, $link)
Qiang Xue committed
479
	{
Qiang Xue committed
480 481 482 483 484 485
		return new ActiveRelation(array(
			'modelClass' => $this->getNamespacedClass($class),
			'primaryModel' => $this,
			'link' => $link,
			'multiple' => true,
		));
Qiang Xue committed
486 487
	}

Qiang Xue committed
488
	/**
Qiang Xue committed
489 490 491 492
	 * 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
493
	 */
Qiang Xue committed
494
	public function populateRelation($name, $records)
Qiang Xue committed
495
	{
Qiang Xue committed
496
		$this->_related[strtolower($name)] = $records;
Qiang Xue committed
497 498
	}

Qiang Xue committed
499 500
	/**
	 * Returns the list of all attribute names of the model.
Qiang Xue committed
501
	 * The default implementation will return all column names of the table associated with this AR class.
Qiang Xue committed
502 503
	 * @return array list of attribute names.
	 */
504
	public function attributes()
Qiang Xue committed
505
	{
Qiang Xue committed
506
		return array_keys($this->getTableSchema()->columns);
507 508
	}

w  
Qiang Xue committed
509 510 511 512 513 514 515 516 517 518
	/**
	 * 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
519
		return isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
w  
Qiang Xue committed
520 521 522 523 524 525
	}

	/**
	 * Sets the named attribute value.
	 * @param string $name the attribute name
	 * @param mixed $value the attribute value.
526
	 * @throws InvalidParamException if the named attribute does not exist.
w  
Qiang Xue committed
527 528 529 530
	 * @see hasAttribute
	 */
	public function setAttribute($name, $value)
	{
531 532 533 534 535
		if (isset($this->_attributes[$name]) || isset($this->getTableSchema()->columns[$name])) {
			$this->_attributes[$name] = $value;
		} else {
			throw new InvalidParamException(get_class($this) . ' has no attribute named "' . $name . '".');
		}
w  
Qiang Xue committed
536 537
	}

Qiang Xue committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
	/**
	 * Returns the old attribute values.
	 * @return array the old attribute values (name-value pairs)
	 */
	public function getOldAttributes()
	{
		return $this->_oldAttributes === null ? array() : $this->_oldAttributes;
	}

	/**
	 * 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
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
	/**
	 * 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.
575
	 * @throws InvalidParamException if the named attribute does not exist.
Qiang Xue committed
576 577 578 579
	 * @see hasAttribute
	 */
	public function setOldAttribute($name, $value)
	{
580 581 582 583 584
		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
585 586 587 588 589 590 591 592 593
	}

	/**
	 * 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)
	{
594 595
		if (isset($this->_attributes[$name], $this->_oldAttributes[$name])) {
			return $this->_attributes[$name] !== $this->_oldAttributes[$name];
Qiang Xue committed
596 597 598 599 600
		} else {
			return isset($this->_attributes[$name]) || isset($this->_oldAttributes);
		}
	}

Qiang Xue committed
601 602 603 604 605 606
	/**
	 * 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
607
	public function getDirtyAttributes($names = null)
Qiang Xue committed
608 609
	{
		if ($names === null) {
610
			$names = $this->attributes();
Qiang Xue committed
611 612 613
		}
		$names = array_flip($names);
		$attributes = array();
Qiang Xue committed
614
		if ($this->_oldAttributes === null) {
Qiang Xue committed
615 616 617 618 619 620 621 622 623 624
			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
625
			}
Qiang Xue committed
626
		}
Qiang Xue committed
627
		return $attributes;
w  
Qiang Xue committed
628 629 630 631 632
	}

	/**
	 * Saves the current record.
	 *
Qiang Xue committed
633 634 635 636
	 * 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
637
	 *
Qiang Xue committed
638 639 640 641 642 643
	 * ~~~
	 * $customer = new Customer;  // or $customer = Customer::find($id);
	 * $customer->name = $name;
	 * $customer->email = $email;
	 * $customer->save();
	 * ~~~
w  
Qiang Xue committed
644 645 646 647 648 649 650 651 652 653
	 *
	 *
	 * @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)
	{
654 655 656 657 658
		if ($this->getIsNewRecord()) {
			return $this->insert($runValidation, $attributes);
		} else {
			return $this->update($runValidation, $attributes) !== false;
		}
Qiang Xue committed
659 660 661
	}

	/**
Qiang Xue committed
662 663 664 665 666 667
	 * 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;
668 669
	 * 2. call [[afterValidate()]] when `$runValidation` is true.
	 * 3. call [[beforeSave()]]. If the method returns false, it will skip the
Qiang Xue committed
670
	 *    rest of the steps;
671 672
	 * 4. insert the record into database. If this fails, it will skip the rest of the steps;
	 * 5. call [[afterSave()]];
Qiang Xue committed
673
	 *
674
	 * In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
Qiang Xue committed
675 676
	 * [[EVENT_BEFORE_INSERT]], [[EVENT_AFTER_INSERT]] and [[EVENT_AFTER_VALIDATE]]
	 * will be raised by the corresponding methods.
Qiang Xue committed
677 678 679 680
	 *
	 * 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
681
	 * it will be populated with the actual value after insertion.
Qiang Xue committed
682 683 684 685 686 687 688 689 690 691 692 693
	 *
	 * 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
694 695 696
	 * @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.
697
	 * @throws \Exception in case insert failed.
Qiang Xue committed
698
	 */
Qiang Xue committed
699
	public function insert($runValidation = true, $attributes = null)
Qiang Xue committed
700
	{
701 702 703 704
		if ($runValidation && !$this->validate($attributes)) {
			return false;
		}
		$db = static::getDb();
705
		$transaction = $this->isOperationAtomic(self::OP_INSERT) && $db->getTransaction() === null ? $db->beginTransaction() : null;
706
		try {
resurtm committed
707 708 709
			$result = $this->insertInternal($attributes);
			if ($transaction !== null) {
				if ($result === false) {
710 711 712 713 714 715
					$transaction->rollback();
				} else {
					$transaction->commit();
				}
			}
		} catch (\Exception $e) {
resurtm committed
716
			if ($transaction !== null) {
717 718 719 720 721 722 723 724 725 726
				$transaction->rollback();
			}
			throw $e;
		}
		return $result;
	}

	/**
	 * @see ActiveRecord::insert()
	 */
resurtm committed
727
	private function insertInternal($attributes = null)
728 729
	{
		if (!$this->beforeSave(true)) {
Qiang Xue committed
730 731
			return false;
		}
732 733 734 735
		$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
736
			}
737 738 739
		}
		$db = static::getDb();
		$command = $db->createCommand()->insert($this->tableName(), $values);
740 741 742 743 744 745 746 747 748
		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
749 750 751
				}
			}
		}
752 753 754 755 756
		foreach ($values as $name => $value) {
			$this->_oldAttributes[$name] = $value;
		}
		$this->afterSave(true);
		return true;
Qiang Xue committed
757 758 759
	}

	/**
Qiang Xue committed
760 761 762 763 764 765
	 * 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;
766 767
	 * 2. call [[afterValidate()]] when `$runValidation` is true.
	 * 3. call [[beforeSave()]]. If the method returns false, it will skip the
Qiang Xue committed
768
	 *    rest of the steps;
769 770
	 * 4. save the record into database. If this fails, it will skip the rest of the steps;
	 * 5. call [[afterSave()]];
Qiang Xue committed
771
	 *
772
	 * In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
Qiang Xue committed
773 774
	 * [[EVENT_BEFORE_UPDATE]], [[EVENT_AFTER_UPDATE]] and [[EVENT_AFTER_VALIDATE]]
	 * will be raised by the corresponding methods.
Qiang Xue committed
775 776 777 778 779 780 781 782 783 784 785 786
	 *
	 * 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();
	 * ~~~
	 *
787 788 789 790 791 792 793 794 795 796 797 798
	 * 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
799 800
	 * @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
801 802
	 * @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.
803 804
	 * @return integer|boolean the number of rows affected, or false if validation fails
	 * or [[beforeSave()]] stops the updating process.
805
	 * @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
806
	 * being updated is outdated.
807
	 * @throws \Exception in case update failed.
Qiang Xue committed
808
	 */
Qiang Xue committed
809
	public function update($runValidation = true, $attributes = null)
Qiang Xue committed
810
	{
811
		if ($runValidation && !$this->validate($attributes)) {
Qiang Xue committed
812 813
			return false;
		}
814
		$db = static::getDb();
815
		$transaction = $this->isOperationAtomic(self::OP_UPDATE) && $db->getTransaction() === null ? $db->beginTransaction() : null;
816
		try {
resurtm committed
817 818 819
			$result = $this->updateInternal($attributes);
			if ($transaction !== null) {
				if ($result === false) {
820 821 822
					$transaction->rollback();
				} else {
					$transaction->commit();
823
				}
824
			}
825
		} catch (\Exception $e) {
resurtm committed
826
			if ($transaction !== null) {
827
				$transaction->rollback();
828
			}
829 830 831 832
			throw $e;
		}
		return $result;
	}
833

834 835 836 837
	/**
	 * @see CActiveRecord::update()
	 * @throws StaleObjectException
	 */
resurtm committed
838
	private function updateInternal($attributes = null)
839 840 841 842 843 844 845 846 847 848 849 850 851
	{
		if (!$this->beforeSave(false)) {
			return false;
		}
		$values = $this->getDirtyAttributes($attributes);
		if (empty($values)) {
			return 0;
		}
		$condition = $this->getOldPrimaryKey(true);
		$lock = $this->optimisticLock();
		if ($lock !== null) {
			if (!isset($values[$lock])) {
				$values[$lock] = $this->$lock + 1;
Qiang Xue committed
852
			}
853 854 855 856 857
			$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);
858

859 860 861 862 863 864
		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
865
		}
866 867
		$this->afterSave(false);
		return $rows;
Qiang Xue committed
868 869 870
	}

	/**
Qiang Xue committed
871
	 * Updates one or several counter columns for the current AR object.
Qiang Xue committed
872 873 874 875 876 877
	 * 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
878
	 * $post = Post::find($id);
Qiang Xue committed
879 880 881 882
	 * $post->updateCounters(array('view_count' => 1));
	 * ~~~
	 *
	 * @param array $counters the counters to be updated (attribute name => increment value)
Qiang Xue committed
883
	 * Use negative values if you want to decrement the counters.
Qiang Xue committed
884 885 886 887 888
	 * @return boolean whether the saving is successful
	 * @see updateAllCounters()
	 */
	public function updateCounters($counters)
	{
Qiang Xue committed
889 890 891 892 893 894 895 896
		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
897 898 899 900
		}
	}

	/**
Qiang Xue committed
901 902 903 904 905 906 907 908 909
	 * 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
910
	 * In the above step 1 and 3, events named [[EVENT_BEFORE_DELETE]] and [[EVENT_AFTER_DELETE]]
Qiang Xue committed
911 912
	 * will be raised by the corresponding methods.
	 *
913 914
	 * @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.
915
	 * @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
916
	 * being deleted is outdated.
917
	 * @throws \Exception in case delete failed.
Qiang Xue committed
918 919 920
	 */
	public function delete()
	{
921
		$db = static::getDb();
922
		$transaction = $this->isOperationAtomic(self::OP_DELETE) && $db->getTransaction() === null ? $db->beginTransaction() : null;
923 924 925 926 927 928 929
		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
930
				if ($lock !== null) {
931 932 933
					$condition[$lock] = $this->$lock;
				}
				$result = $this->deleteAll($condition);
resurtm committed
934
				if ($lock !== null && !$result) {
935 936 937 938
					throw new StaleObjectException('The object being deleted is outdated.');
				}
				$this->_oldAttributes = null;
				$this->afterDelete();
939
			}
resurtm committed
940 941
			if ($transaction !== null) {
				if ($result === false) {
942 943 944 945
					$transaction->rollback();
				} else {
					$transaction->commit();
				}
946
			}
947
		} catch (\Exception $e) {
resurtm committed
948
			if ($transaction !== null) {
949 950 951
				$transaction->rollback();
			}
			throw $e;
Qiang Xue committed
952
		}
953
		return $result;
w  
Qiang Xue committed
954 955 956
	}

	/**
Qiang Xue committed
957
	 * Returns a value indicating whether the current record is new.
Qiang Xue committed
958
	 * @return boolean whether the record is new and should be inserted when calling [[save()]].
w  
Qiang Xue committed
959 960 961
	 */
	public function getIsNewRecord()
	{
Qiang Xue committed
962
		return $this->_oldAttributes === null;
w  
Qiang Xue committed
963 964
	}

965 966 967
	/**
	 * Initializes the object.
	 * This method is called at the end of the constructor.
Qiang Xue committed
968
	 * The default implementation will trigger an [[EVENT_INIT]] event.
969 970 971 972 973 974
	 * 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();
975
		$this->trigger(self::EVENT_INIT);
976 977 978 979
	}

	/**
	 * This method is called when the AR object is created and populated with the query result.
Qiang Xue committed
980
	 * The default implementation will trigger an [[EVENT_AFTER_FIND]] event.
981 982 983 984 985
	 * When overriding this method, make sure you call the parent implementation to ensure the
	 * event is triggered.
	 */
	public function afterFind()
	{
986
		$this->trigger(self::EVENT_AFTER_FIND);
987 988
	}

w  
Qiang Xue committed
989
	/**
Qiang Xue committed
990
	 * Sets the value indicating whether the record is new.
Qiang Xue committed
991
	 * @param boolean $value whether the record is new and should be inserted when calling [[save()]].
w  
Qiang Xue committed
992 993 994 995
	 * @see getIsNewRecord
	 */
	public function setIsNewRecord($value)
	{
Qiang Xue committed
996
		$this->_oldAttributes = $value ? null : $this->_attributes;
w  
Qiang Xue committed
997 998
	}

Qiang Xue committed
999 1000
	/**
	 * This method is called at the beginning of inserting or updating a record.
Qiang Xue committed
1001 1002
	 * 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
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
	 * 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
1022
	public function beforeSave($insert)
w  
Qiang Xue committed
1023
	{
Qiang Xue committed
1024
		$event = new ModelEvent;
1025
		$this->trigger($insert ? self::EVENT_BEFORE_INSERT : self::EVENT_BEFORE_UPDATE, $event);
Qiang Xue committed
1026
		return $event->isValid;
w  
Qiang Xue committed
1027 1028
	}

Qiang Xue committed
1029 1030
	/**
	 * This method is called at the end of inserting or updating a record.
Qiang Xue committed
1031 1032
	 * 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
1033 1034 1035 1036 1037
	 * 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
1038
	public function afterSave($insert)
w  
Qiang Xue committed
1039
	{
1040
		$this->trigger($insert ? self::EVENT_AFTER_INSERT : self::EVENT_AFTER_UPDATE);
w  
Qiang Xue committed
1041 1042 1043 1044
	}

	/**
	 * This method is invoked before deleting a record.
Qiang Xue committed
1045
	 * The default implementation raises the [[EVENT_BEFORE_DELETE]] event.
Qiang Xue committed
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
	 * 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
1060 1061
	 * @return boolean whether the record should be deleted. Defaults to true.
	 */
Qiang Xue committed
1062
	public function beforeDelete()
w  
Qiang Xue committed
1063
	{
Qiang Xue committed
1064
		$event = new ModelEvent;
1065
		$this->trigger(self::EVENT_BEFORE_DELETE, $event);
Qiang Xue committed
1066
		return $event->isValid;
w  
Qiang Xue committed
1067 1068 1069 1070
	}

	/**
	 * This method is invoked after deleting a record.
Qiang Xue committed
1071
	 * The default implementation raises the [[EVENT_AFTER_DELETE]] event.
w  
Qiang Xue committed
1072 1073 1074
	 * 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
1075
	public function afterDelete()
w  
Qiang Xue committed
1076
	{
1077
		$this->trigger(self::EVENT_AFTER_DELETE);
w  
Qiang Xue committed
1078 1079 1080
	}

	/**
Qiang Xue committed
1081
	 * Repopulates this active record with the latest data.
Qiang Xue committed
1082
	 * @param array $attributes
Qiang Xue committed
1083 1084
	 * @return boolean whether the row still exists in the database. If true, the latest data
	 * will be populated to this active record.
w  
Qiang Xue committed
1085
	 */
Qiang Xue committed
1086
	public function refresh($attributes = null)
w  
Qiang Xue committed
1087
	{
Qiang Xue committed
1088
		$record = $this->find($this->getPrimaryKey(true));
Qiang Xue committed
1089 1090 1091 1092
		if ($record === null) {
			return false;
		}
		if ($attributes === null) {
1093
			foreach ($this->attributes() as $name) {
Qiang Xue committed
1094
				$this->_attributes[$name] = $record->_attributes[$name];
Qiang Xue committed
1095
			}
Qiang Xue committed
1096
			$this->_oldAttributes = $this->_attributes;
Qiang Xue committed
1097
		} else {
Qiang Xue committed
1098 1099 1100
			foreach ($attributes as $name) {
				$this->_oldAttributes[$name] = $this->_attributes[$name] = $record->_attributes[$name];
			}
w  
Qiang Xue committed
1101
		}
Qiang Xue committed
1102
		return true;
w  
Qiang Xue committed
1103 1104 1105
	}

	/**
Qiang Xue committed
1106 1107
	 * 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
1108
	 * @param ActiveRecord $record record to compare to
Qiang Xue committed
1109
	 * @return boolean whether the two active records refer to the same row in the same database table.
w  
Qiang Xue committed
1110
	 */
Qiang Xue committed
1111
	public function equals($record)
w  
Qiang Xue committed
1112
	{
Qiang Xue committed
1113
		return $this->tableName() === $record->tableName() && $this->getPrimaryKey() === $record->getPrimaryKey();
w  
Qiang Xue committed
1114 1115 1116
	}

	/**
Qiang Xue committed
1117
	 * Returns the primary key value(s).
Qiang Xue committed
1118
	 * @param boolean $asArray whether to return the primary key value as an array. If true,
Qiang Xue committed
1119
	 * the return value will be an array with column names as keys and column values as values.
1120
	 * Note that for composite primary keys, an array will always be returned regardless of this parameter value.
resurtm committed
1121
	 * @return mixed the primary key value. An array (column name => column value) is returned if the primary key
Qiang Xue committed
1122 1123
	 * 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
1124
	 */
Qiang Xue committed
1125
	public function getPrimaryKey($asArray = false)
w  
Qiang Xue committed
1126
	{
Qiang Xue committed
1127 1128 1129
		$keys = $this->primaryKey();
		if (count($keys) === 1 && !$asArray) {
			return isset($this->_attributes[$keys[0]]) ? $this->_attributes[$keys[0]] : null;
Qiang Xue committed
1130
		} else {
Qiang Xue committed
1131
			$values = array();
Qiang Xue committed
1132
			foreach ($keys as $name) {
Qiang Xue committed
1133
				$values[$name] = isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
Qiang Xue committed
1134 1135
			}
			return $values;
w  
Qiang Xue committed
1136 1137 1138 1139
		}
	}

	/**
Qiang Xue committed
1140
	 * Returns the old primary key value(s).
Qiang Xue committed
1141 1142 1143
	 * 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
1144 1145
	 * @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
1146
	 * If this is false (default), a scalar value will be returned for non-composite primary key.
resurtm committed
1147
	 * @return mixed the old primary key value. An array (column name => column value) is returned if the primary key
Qiang Xue committed
1148 1149
	 * 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
1150
	 */
Qiang Xue committed
1151
	public function getOldPrimaryKey($asArray = false)
w  
Qiang Xue committed
1152
	{
Qiang Xue committed
1153 1154 1155
		$keys = $this->primaryKey();
		if (count($keys) === 1 && !$asArray) {
			return isset($this->_oldAttributes[$keys[0]]) ? $this->_oldAttributes[$keys[0]] : null;
Qiang Xue committed
1156 1157
		} else {
			$values = array();
Qiang Xue committed
1158
			foreach ($keys as $name) {
Qiang Xue committed
1159 1160 1161 1162
				$values[$name] = isset($this->_oldAttributes[$name]) ? $this->_oldAttributes[$name] : null;
			}
			return $values;
		}
w  
Qiang Xue committed
1163 1164 1165
	}

	/**
Qiang Xue committed
1166
	 * Creates an active record object using a row of data.
Qiang Xue committed
1167
	 * This method is called by [[ActiveQuery]] to populate the query results
1168
	 * into Active Records. It is not meant to be used to create new records.
Qiang Xue committed
1169 1170
	 * @param array $row attribute values (name => value)
	 * @return ActiveRecord the newly created active record.
w  
Qiang Xue committed
1171
	 */
Qiang Xue committed
1172
	public static function create($row)
w  
Qiang Xue committed
1173
	{
Qiang Xue committed
1174
		$record = static::instantiate($row);
1175
		$columns = static::getTableSchema()->columns;
Qiang Xue committed
1176
		foreach ($row as $name => $value) {
Qiang Xue committed
1177
			if (isset($columns[$name])) {
Qiang Xue committed
1178
				$record->_attributes[$name] = $value;
Qiang Xue committed
1179
			} else {
Qiang Xue committed
1180
				$record->$name = $value;
w  
Qiang Xue committed
1181 1182
			}
		}
Qiang Xue committed
1183
		$record->_oldAttributes = $record->_attributes;
1184
		$record->afterFind();
Qiang Xue committed
1185
		return $record;
w  
Qiang Xue committed
1186 1187 1188 1189
	}

	/**
	 * Creates an active record instance.
Qiang Xue committed
1190
	 * This method is called by [[create()]].
w  
Qiang Xue committed
1191
	 * You may override this method if the instance being created
Qiang Xue committed
1192
	 * depends on the row data to be populated into the record.
w  
Qiang Xue committed
1193 1194
	 * 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
1195 1196
	 * @param array $row row data to be populated into the record.
	 * @return ActiveRecord the newly created active record
w  
Qiang Xue committed
1197
	 */
Qiang Xue committed
1198
	public static function instantiate($row)
w  
Qiang Xue committed
1199
	{
Qiang Xue committed
1200
		return new static;
w  
Qiang Xue committed
1201 1202 1203 1204 1205 1206
	}

	/**
	 * 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
1207
	 * @return boolean whether there is an element at the specified offset.
w  
Qiang Xue committed
1208 1209 1210 1211 1212
	 */
	public function offsetExists($offset)
	{
		return $this->__isset($offset);
	}
Qiang Xue committed
1213

Qiang Xue committed
1214
	/**
Qiang Xue committed
1215 1216 1217 1218 1219
	 * 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
1220
	 * @throws InvalidParamException if the named relation does not exist.
Qiang Xue committed
1221 1222 1223 1224 1225 1226 1227 1228 1229
	 */
	public function getRelation($name)
	{
		$getter = 'get' . $name;
		try {
			$relation = $this->$getter();
			if ($relation instanceof ActiveRelation) {
				return $relation;
			}
Qiang Xue committed
1230
		} catch (UnknownMethodException $e) {
1231
			throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e);
Qiang Xue committed
1232 1233 1234
		}
	}

Qiang Xue committed
1235
	/**
Qiang Xue committed
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
	 * 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
1252
	 * @throws InvalidCallException if the method is unable to link two models.
Qiang Xue committed
1253
	 */
Qiang Xue committed
1254
	public function link($name, $model, $extraColumns = array())
Qiang Xue committed
1255
	{
1256 1257 1258 1259
		$relation = $this->getRelation($name);

		if ($relation->via !== null) {
			if (is_array($relation->via)) {
Qiang Xue committed
1260 1261
				/** @var $viaRelation ActiveRelation */
				list($viaName, $viaRelation) = $relation->via;
1262
				/** @var $viaClass ActiveRecord */
Qiang Xue committed
1263
				$viaClass = $viaRelation->modelClass;
1264
				$viaTable = $viaClass::tableName();
Qiang Xue committed
1265
				// unset $viaName so that it can be reloaded to reflect the change
Qiang Xue committed
1266
				unset($this->_related[strtolower($viaName)]);
1267
			} else {
Qiang Xue committed
1268
				$viaRelation = $relation->via;
1269 1270 1271
				$viaTable = reset($relation->via->from);
			}
			$columns = array();
Qiang Xue committed
1272
			foreach ($viaRelation->link as $a => $b) {
1273 1274 1275 1276 1277
				$columns[$a] = $this->$b;
			}
			foreach ($relation->link as $a => $b) {
				$columns[$b] = $model->$a;
			}
Qiang Xue committed
1278
			foreach ($extraColumns as $k => $v) {
1279 1280
				$columns[$k] = $v;
			}
Qiang Xue committed
1281
			static::getDb()->createCommand()
Qiang Xue committed
1282 1283 1284 1285 1286 1287
				->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
1288
					throw new InvalidCallException('Unable to link models: both models are newly created.');
Qiang Xue committed
1289 1290
				} elseif ($this->getIsNewRecord()) {
					$this->bindModels(array_flip($relation->link), $this, $model);
Qiang Xue committed
1291
				} else {
Qiang Xue committed
1292
					$this->bindModels($relation->link, $model, $this);
1293
				}
Qiang Xue committed
1294 1295 1296 1297
			} elseif ($p1) {
				$this->bindModels(array_flip($relation->link), $this, $model);
			} elseif ($p2) {
				$this->bindModels($relation->link, $model, $this);
1298
			} else {
Qiang Xue committed
1299
				throw new InvalidCallException('Unable to link models: the link does not involve any primary key.');
1300 1301
			}
		}
Qiang Xue committed
1302

Qiang Xue committed
1303
		// update lazily loaded related objects
Qiang Xue committed
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
		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;
			}
		}
1314 1315 1316
	}

	/**
Qiang Xue committed
1317 1318 1319 1320 1321 1322 1323
	 * 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
1324 1325
	 * @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
1326
	 * If true, the model containing the foreign key will be deleted.
Qiang Xue committed
1327
	 * @throws InvalidCallException if the models cannot be unlinked
1328
	 */
Qiang Xue committed
1329
	public function unlink($name, $model, $delete = false)
1330 1331 1332 1333 1334
	{
		$relation = $this->getRelation($name);

		if ($relation->via !== null) {
			if (is_array($relation->via)) {
Qiang Xue committed
1335 1336
				/** @var $viaRelation ActiveRelation */
				list($viaName, $viaRelation) = $relation->via;
1337
				/** @var $viaClass ActiveRecord */
Qiang Xue committed
1338
				$viaClass = $viaRelation->modelClass;
1339
				$viaTable = $viaClass::tableName();
Qiang Xue committed
1340
				unset($this->_related[strtolower($viaName)]);
1341
			} else {
Qiang Xue committed
1342
				$viaRelation = $relation->via;
1343 1344 1345
				$viaTable = reset($relation->via->from);
			}
			$columns = array();
Qiang Xue committed
1346
			foreach ($viaRelation->link as $a => $b) {
1347 1348 1349 1350 1351
				$columns[$a] = $this->$b;
			}
			foreach ($relation->link as $a => $b) {
				$columns[$b] = $model->$a;
			}
Qiang Xue committed
1352
			$command = static::getDb()->createCommand();
Qiang Xue committed
1353 1354 1355 1356 1357 1358 1359 1360
			if ($delete) {
				$command->delete($viaTable, $columns)->execute();
			} else {
				$nulls = array();
				foreach (array_keys($columns) as $a) {
					$nulls[$a] = null;
				}
				$command->update($viaTable, $nulls, $columns)->execute();
1361 1362
			}
		} else {
Qiang Xue committed
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
			$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
1376
				throw new InvalidCallException('Unable to unlink models: the link does not involve any primary key.');
Qiang Xue committed
1377
			}
1378
		}
Qiang Xue committed
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389

		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]);
				}
			}
		}
1390 1391
	}

Qiang Xue committed
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
	/**
	 * Changes the given class name into a namespaced one.
	 * If the given class name is already namespaced, no change will be made.
	 * Otherwise, the class name will be changed to use the same namespace as
	 * the current AR class.
	 * @param string $class the class name to be namespaced
	 * @return string the namespaced class name
	 */
	protected function getNamespacedClass($class)
	{
		if (strpos($class, '\\') === false) {
1403 1404 1405 1406
			$reflector = new \ReflectionClass($this);
			return $reflector->getNamespaceName() . '\\' . $class;
		} else {
			return $class;
Qiang Xue committed
1407 1408 1409
		}
	}

1410
	/**
Qiang Xue committed
1411 1412 1413
	 * @param array $link
	 * @param ActiveRecord $foreignModel
	 * @param ActiveRecord $primaryModel
Qiang Xue committed
1414
	 * @throws InvalidCallException
1415
	 */
Qiang Xue committed
1416
	private function bindModels($link, $foreignModel, $primaryModel)
1417
	{
Qiang Xue committed
1418 1419 1420
		foreach ($link as $fk => $pk) {
			$value = $primaryModel->$pk;
			if ($value === null) {
Qiang Xue committed
1421
				throw new InvalidCallException('Unable to link models: the primary key of ' . get_class($primaryModel) . ' is null.');
Qiang Xue committed
1422
			}
Qiang Xue committed
1423
			$foreignModel->$fk = $value;
Qiang Xue committed
1424
		}
Qiang Xue committed
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
		$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
1441
	}
1442 1443

	/**
1444
	 * @param string $operation possible values are ActiveRecord::INSERT, ActiveRecord::UPDATE and ActiveRecord::DELETE.
1445 1446
	 * @return boolean whether given operation is atomic. Currently active scenario is taken into account.
	 */
1447
	private function isOperationAtomic($operation)
1448 1449 1450
	{
		$scenario = $this->getScenario();
		$scenarios = $this->scenarios();
1451
		if (isset($scenarios[$scenario], $scenarios[$scenario]['atomic']) && is_array($scenarios[$scenario]['atomic'])) {
1452
			return in_array($operation, $scenarios[$scenario]['atomic']);
resurtm committed
1453
		} else {
1454 1455 1456
			return false;
		}
	}
w  
Qiang Xue committed
1457
}