You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1502 lines
51 KiB

13 years ago
<?php
/**
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
namespace yii\db;
13 years ago
12 years ago
use yii\base\InvalidConfigException;
13 years ago
use yii\base\Model;
12 years ago
use yii\base\InvalidParamException;
13 years ago
use yii\base\ModelEvent;
use yii\base\UnknownMethodException;
use yii\base\InvalidCallException;
use yii\helpers\StringHelper;
use yii\helpers\Inflector;
13 years ago
13 years ago
/**
* ActiveRecord is the base class for classes representing relational data in terms of objects.
13 years ago
*
12 years ago
* @include @yii/db/ActiveRecord.md
13 years ago
*
12 years ago
* @property Connection $db the database connection used by this AR class.
12 years ago
* @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).
* @property boolean $isNewRecord whether the record is new and should be inserted when calling [[save()]].
12 years ago
* @property mixed $primaryKey the primary key value.
* @property mixed $oldPrimaryKey the old primary key value.
*
12 years ago
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
13 years ago
*/
12 years ago
class ActiveRecord extends Model
13 years ago
{
/**
* @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';
/**
* The insert operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
*/
const OP_INSERT = 0x01;
/**
* The update operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
*/
const OP_UPDATE = 0x02;
/**
* The delete operation. This is mainly used when overriding [[transactions()]] to specify which operations are transactional.
*/
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;
/**
13 years ago
* @var array attribute values indexed by attribute names
*/
private $_attributes = array();
/**
* @var array old attribute values indexed by attribute names.
13 years ago
*/
13 years ago
private $_oldAttributes;
/**
12 years ago
* @var array related models indexed by the relation names
*/
12 years ago
private $_related;
13 years ago
/**
13 years ago
* 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.
*/
12 years ago
public static function getDb()
13 years ago
{
return \Yii::$app->getDb();
13 years ago
}
/**
13 years ago
* Creates an [[ActiveQuery]] instance for query purpose.
13 years ago
*
12 years ago
* @include @yii/db/ActiveRecord-find.md
13 years ago
*
* @param mixed $q the query parameter. This can be one of the followings:
*
12 years ago
* - a scalar value (integer or string): query by a single primary key value and return the
* corresponding record.
12 years ago
* - an array of name-value pairs: query by a set of column values and return a single record matching all of them.
12 years ago
* - null: return a new [[ActiveQuery]] object for further query purpose.
13 years ago
*
12 years ago
* @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
12 years ago
* returned (null will be returned if there is no matching).
12 years ago
* @throws InvalidConfigException if the AR class does not have a primary key
12 years ago
* @see createQuery()
13 years ago
*/
public static function find($q = null)
{
12 years ago
$query = static::createQuery();
13 years ago
if (is_array($q)) {
12 years ago
return $query->where($q)->one();
13 years ago
} elseif ($q !== null) {
// query by primary key
12 years ago
$primaryKey = static::primaryKey();
12 years ago
if (isset($primaryKey[0])) {
return $query->where(array($primaryKey[0] => $q))->one();
} else {
throw new InvalidConfigException(get_called_class() . ' must have a primary key.');
}
13 years ago
}
13 years ago
return $query;
13 years ago
}
13 years ago
/**
12 years ago
* 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();
* ~~~
*
13 years ago
* @param string $sql the SQL statement to be executed
* @param array $params parameters to be bound to the SQL statement during execution.
12 years ago
* @return ActiveQuery the newly created [[ActiveQuery]] instance
13 years ago
*/
13 years ago
public static function findBySql($sql, $params = array())
13 years ago
{
12 years ago
$query = static::createQuery();
13 years ago
$query->sql = $sql;
return $query->params($params);
}
/**
* Updates the whole table using the provided attribute values and conditions.
12 years ago
* 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.
13 years ago
* Please refer to [[Query::where()]] on how to specify this parameter.
12 years ago
* @param array $params the parameters (name => value) to be bound to the query.
13 years ago
* @return integer the number of rows updated
*/
13 years ago
public static function updateAll($attributes, $condition = '', $params = array())
13 years ago
{
12 years ago
$command = static::getDb()->createCommand();
12 years ago
$command->update(static::tableName(), $attributes, $condition, $params);
return $command->execute();
13 years ago
}
13 years ago
/**
12 years ago
* 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));
* ~~~
*
13 years ago
* @param array $counters the counters to be updated (attribute name => increment value).
12 years ago
* 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.
13 years ago
* Please refer to [[Query::where()]] on how to specify this parameter.
12 years ago
* @param array $params the parameters (name => value) to be bound to the query.
12 years ago
* Do not name the parameters as `:bp0`, `:bp1`, etc., because they are used internally by this method.
13 years ago
* @return integer the number of rows updated
*/
public static function updateAllCounters($counters, $condition = '', $params = array())
13 years ago
{
12 years ago
$n = 0;
13 years ago
foreach ($counters as $name => $value) {
$counters[$name] = new Expression("[[$name]]+:bp{$n}", array(":bp{$n}" => $value));
12 years ago
$n++;
13 years ago
}
$command = static::getDb()->createCommand();
12 years ago
$command->update(static::tableName(), $counters, $condition, $params);
return $command->execute();
13 years ago
}
13 years ago
/**
* Deletes rows in the table using the provided conditions.
12 years ago
* 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.
13 years ago
* Please refer to [[Query::where()]] on how to specify this parameter.
12 years ago
* @param array $params the parameters (name => value) to be bound to the query.
12 years ago
* @return integer the number of rows deleted
13 years ago
*/
13 years ago
public static function deleteAll($condition = '', $params = array())
13 years ago
{
12 years ago
$command = static::getDb()->createCommand();
12 years ago
$command->delete(static::tableName(), $condition, $params);
return $command->execute();
13 years ago
}
13 years ago
/**
12 years ago
* 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.)
13 years ago
* @return ActiveQuery the newly created [[ActiveQuery]] instance.
13 years ago
*/
12 years ago
public static function createQuery()
13 years ago
{
12 years ago
return new ActiveQuery(array(
'modelClass' => get_called_class(),
));
13 years ago
}
/**
13 years ago
* Declares the name of the database table associated with this AR class.
* By default this method returns the class name as the table name by calling [[Inflector::camel2id()]]
12 years ago
* 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.
13 years ago
* @return string the table name
*/
12 years ago
public static function tableName()
13 years ago
{
return 'tbl_' . Inflector::camel2id(StringHelper::basename(get_called_class()), '_');
13 years ago
}
/**
12 years ago
* 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.
* @throws InvalidConfigException if the table for the AR class does not exist.
13 years ago
*/
12 years ago
public static function getTableSchema()
13 years ago
{
$schema = static::getDb()->getTableSchema(static::tableName());
if ($schema !== null) {
return $schema;
} else {
throw new InvalidConfigException("The table does not exist: " . static::tableName());
}
13 years ago
}
/**
12 years ago
* Returns the primary key name(s) for this AR class.
* The default implementation will return the primary key(s) as declared
12 years ago
* in the DB table that is associated with this AR class.
12 years ago
*
12 years ago
* 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.
12 years ago
*
* Note that an array should be returned even for a table with single primary key.
*
12 years ago
* @return string[] the primary keys of the associated database table.
13 years ago
*/
12 years ago
public static function primaryKey()
13 years ago
{
12 years ago
return static::getTableSchema()->primaryKey;
13 years ago
}
/**
* Returns the name of the column that stores the lock version for implementing optimistic locking.
*
* 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.
*
* Optimized locking is only supported by [[update()]] and [[delete()]].
*
* To use optimized locking:
*
* 1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`.
* Override this method to return the name of this column.
* 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.
*/
public function optimisticLock()
{
return null;
}
/**
* 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,
*
* ~~~
* return array(
* '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,
*
* );
* ~~~
*
* 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()
{
return array();
}
/**
13 years ago
* PHP getter magic method.
13 years ago
* This method is overridden so that attributes and related objects can be accessed like properties.
13 years ago
* @param string $name property name
* @return mixed property value
* @see getAttribute
*/
public function __get($name)
{
12 years ago
if (isset($this->_attributes[$name]) || array_key_exists($name, $this->_attributes)) {
13 years ago
return $this->_attributes[$name];
12 years ago
} elseif (isset($this->getTableSchema()->columns[$name])) {
13 years ago
return null;
} 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();
12 years ago
} else {
return $value;
12 years ago
}
13 years ago
}
}
/**
* 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)
{
if ($this->hasAttribute($name)) {
13 years ago
$this->_attributes[$name] = $value;
} else {
parent::__set($name, $value);
}
}
/**
* Checks if a property value is null.
12 years ago
* This method overrides the parent implementation by checking if the named attribute is null or not.
13 years ago
* @param string $name the property name or the event name
* @return boolean whether the property value is null
*/
public function __isset($name)
13 years ago
{
12 years ago
try {
return $this->__get($name) !== null;
} catch (\Exception $e) {
return false;
13 years ago
}
}
/**
* 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)
{
12 years ago
if (isset($this->getTableSchema()->columns[$name])) {
13 years ago
unset($this->_attributes[$name]);
13 years ago
} else {
$t = strtolower($name);
if (isset($this->_related[$t])) {
unset($this->_related[$t]);
} else {
parent::__unset($name);
}
13 years ago
}
}
12 years ago
/**
* 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.
12 years ago
*
* 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.
*
12 years ago
* @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.
*/
12 years ago
public function hasOne($class, $link)
12 years ago
{
12 years ago
return new ActiveRelation(array(
'modelClass' => $this->getNamespacedClass($class),
12 years ago
'primaryModel' => $this,
'link' => $link,
'multiple' => false,
));
12 years ago
}
12 years ago
/**
* 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.
12 years ago
*
* 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.
*
12 years ago
* @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.
*/
12 years ago
public function hasMany($class, $link)
12 years ago
{
12 years ago
return new ActiveRelation(array(
'modelClass' => $this->getNamespacedClass($class),
12 years ago
'primaryModel' => $this,
'link' => $link,
'multiple' => true,
));
12 years ago
}
13 years ago
/**
12 years ago
* 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.
13 years ago
*/
12 years ago
public function populateRelation($name, $records)
13 years ago
{
12 years ago
$this->_related[strtolower($name)] = $records;
13 years ago
}
13 years ago
/**
* Returns the list of all attribute names of the model.
12 years ago
* The default implementation will return all column names of the table associated with this AR class.
13 years ago
* @return array list of attribute names.
*/
public function attributes()
13 years ago
{
12 years ago
return array_keys($this->getTableSchema()->columns);
}
/**
13 years ago
* 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)
{
13 years ago
return isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
13 years ago
}
/**
* Sets the named attribute value.
* @param string $name the attribute name
* @param mixed $value the attribute value.
* @throws InvalidParamException if the named attribute does not exist.
13 years ago
* @see hasAttribute
*/
public function setAttribute($name, $value)
{
if ($this->hasAttribute($name)) {
$this->_attributes[$name] = $value;
} else {
throw new InvalidParamException(get_class($this) . ' has no attribute named "' . $name . '".');
}
13 years ago
}
12 years ago
/**
* 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]);
}
/**
12 years ago
* 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;
}
/**
12 years ago
* 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.
* @throws InvalidParamException if the named attribute does not exist.
12 years ago
* @see hasAttribute
*/
public function setOldAttribute($name, $value)
{
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 . '".');
}
12 years ago
}
/**
* 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)
{
if (isset($this->_attributes[$name], $this->_oldAttributes[$name])) {
return $this->_attributes[$name] !== $this->_oldAttributes[$name];
12 years ago
} else {
11 years ago
return isset($this->_attributes[$name]) || isset($this->_oldAttributes[$name]);
12 years ago
}
}
/**
12 years ago
* 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)
*/
12 years ago
public function getDirtyAttributes($names = null)
13 years ago
{
if ($names === null) {
$names = $this->attributes();
13 years ago
}
$names = array_flip($names);
$attributes = array();
13 years ago
if ($this->_oldAttributes === null) {
13 years ago
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;
}
13 years ago
}
13 years ago
}
13 years ago
return $attributes;
13 years ago
}
/**
* Saves the current record.
*
12 years ago
* This method will call [[insert()]] when [[isNewRecord]] is true, or [[update()]]
* when [[isNewRecord]] is false.
*
* For example, to save a customer record:
13 years ago
*
12 years ago
* ~~~
* $customer = new Customer; // or $customer = Customer::find($id);
* $customer->name = $name;
* $customer->email = $email;
* $customer->save();
* ~~~
13 years ago
*
*
* @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)
{
if ($this->getIsNewRecord()) {
return $this->insert($runValidation, $attributes);
} else {
return $this->update($runValidation, $attributes) !== false;
}
13 years ago
}
/**
12 years ago
* 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;
* 2. call [[afterValidate()]] when `$runValidation` is true.
* 3. call [[beforeSave()]]. If the method returns false, it will skip the
12 years ago
* rest of the steps;
* 4. insert the record into database. If this fails, it will skip the rest of the steps;
* 5. call [[afterSave()]];
12 years ago
*
* In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
12 years ago
* [[EVENT_BEFORE_INSERT]], [[EVENT_AFTER_INSERT]] and [[EVENT_AFTER_VALIDATE]]
* will be raised by the corresponding methods.
12 years ago
*
* 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,
13 years ago
* it will be populated with the actual value after insertion.
12 years ago
*
* 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.
13 years ago
* @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.
* @throws \Exception in case insert failed.
13 years ago
*/
12 years ago
public function insert($runValidation = true, $attributes = null)
13 years ago
{
if ($runValidation && !$this->validate($attributes)) {
return false;
}
$db = static::getDb();
$transaction = $this->isTransactional(self::OP_INSERT) && $db->getTransaction() === null ? $db->beginTransaction() : null;
try {
$result = $this->insertInternal($attributes);
if ($transaction !== null) {
if ($result === false) {
$transaction->rollback();
} else {
$transaction->commit();
}
}
} catch (\Exception $e) {
if ($transaction !== null) {
$transaction->rollback();
}
throw $e;
}
return $result;
}
/**
* @see ActiveRecord::insert()
*/
private function insertInternal($attributes = null)
{
if (!$this->beforeSave(true)) {
12 years ago
return false;
}
$values = $this->getDirtyAttributes($attributes);
if (empty($values)) {
foreach ($this->primaryKey() as $key) {
$values[$key] = isset($this->_attributes[$key]) ? $this->_attributes[$key] : null;
12 years ago
}
}
$db = static::getDb();
$command = $db->createCommand()->insert($this->tableName(), $values);
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;
13 years ago
}
}
}
foreach ($values as $name => $value) {
$this->_oldAttributes[$name] = $value;
}
$this->afterSave(true);
return true;
13 years ago
}
/**
12 years ago
* 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;
* 2. call [[afterValidate()]] when `$runValidation` is true.
* 3. call [[beforeSave()]]. If the method returns false, it will skip the
12 years ago
* rest of the steps;
* 4. save the record into database. If this fails, it will skip the rest of the steps;
* 5. call [[afterSave()]];
12 years ago
*
* In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]],
12 years ago
* [[EVENT_BEFORE_UPDATE]], [[EVENT_AFTER_UPDATE]] and [[EVENT_AFTER_VALIDATE]]
* will be raised by the corresponding methods.
12 years ago
*
* 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();
* ~~~
*
* 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
* }
* ~~~
*
12 years ago
* @param boolean $runValidation whether to perform validation before saving the record.
* If the validation fails, the record will not be inserted into the database.
13 years ago
* @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 integer|boolean the number of rows affected, or false if validation fails
* or [[beforeSave()]] stops the updating process.
* @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
* being updated is outdated.
* @throws \Exception in case update failed.
13 years ago
*/
12 years ago
public function update($runValidation = true, $attributes = null)
13 years ago
{
if ($runValidation && !$this->validate($attributes)) {
12 years ago
return false;
}
$db = static::getDb();
$transaction = $this->isTransactional(self::OP_UPDATE) && $db->getTransaction() === null ? $db->beginTransaction() : null;
try {
$result = $this->updateInternal($attributes);
if ($transaction !== null) {
if ($result === false) {
$transaction->rollback();
} else {
$transaction->commit();
}
}
} catch (\Exception $e) {
if ($transaction !== null) {
$transaction->rollback();
}
throw $e;
}
return $result;
}
/**
* @see CActiveRecord::update()
* @throws StaleObjectException
*/
private function updateInternal($attributes = null)
{
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;
13 years ago
}
$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);
if ($lock !== null && !$rows) {
throw new StaleObjectException('The object being updated is outdated.');
}
foreach ($values as $name => $value) {
$this->_oldAttributes[$name] = $this->_attributes[$name];
13 years ago
}
$this->afterSave(false);
return $rows;
13 years ago
}
/**
12 years ago
* Updates one or several counter columns for the current AR object.
13 years ago
* Note that this method differs from [[updateAllCounters()]] in that it only
* saves counters for the current AR object.
*
* An example usage is as follows:
*
* ~~~
12 years ago
* $post = Post::find($id);
13 years ago
* $post->updateCounters(array('view_count' => 1));
* ~~~
*
* @param array $counters the counters to be updated (attribute name => increment value)
12 years ago
* Use negative values if you want to decrement the counters.
13 years ago
* @return boolean whether the saving is successful
* @see updateAllCounters()
*/
public function updateCounters($counters)
{
12 years ago
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;
13 years ago
}
}
/**
12 years ago
* 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()]].
*
12 years ago
* In the above step 1 and 3, events named [[EVENT_BEFORE_DELETE]] and [[EVENT_AFTER_DELETE]]
12 years ago
* will be raised by the corresponding methods.
*
* @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.
* @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
* being deleted is outdated.
* @throws \Exception in case delete failed.
13 years ago
*/
public function delete()
{
$db = static::getDb();
$transaction = $this->isTransactional(self::OP_DELETE) && $db->getTransaction() === null ? $db->beginTransaction() : null;
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();
if ($lock !== null) {
$condition[$lock] = $this->$lock;
}
$result = $this->deleteAll($condition);
if ($lock !== null && !$result) {
throw new StaleObjectException('The object being deleted is outdated.');
}
$this->_oldAttributes = null;
$this->afterDelete();
}
if ($transaction !== null) {
if ($result === false) {
$transaction->rollback();
} else {
$transaction->commit();
}
}
} catch (\Exception $e) {
if ($transaction !== null) {
$transaction->rollback();
}
throw $e;
13 years ago
}
return $result;
13 years ago
}
/**
12 years ago
* Returns a value indicating whether the current record is new.
12 years ago
* @return boolean whether the record is new and should be inserted when calling [[save()]].
13 years ago
*/
public function getIsNewRecord()
{
13 years ago
return $this->_oldAttributes === null;
13 years ago
}
/**
* Initializes the object.
* This method is called at the end of the constructor.
12 years ago
* The default implementation will trigger an [[EVENT_INIT]] event.
* 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();
$this->trigger(self::EVENT_INIT);
}
/**
* This method is called when the AR object is created and populated with the query result.
12 years ago
* The default implementation will trigger an [[EVENT_AFTER_FIND]] event.
* When overriding this method, make sure you call the parent implementation to ensure the
* event is triggered.
*/
public function afterFind()
{
$this->trigger(self::EVENT_AFTER_FIND);
}
/**
12 years ago
* Sets the value indicating whether the record is new.
12 years ago
* @param boolean $value whether the record is new and should be inserted when calling [[save()]].
13 years ago
* @see getIsNewRecord
*/
public function setIsNewRecord($value)
{
13 years ago
$this->_oldAttributes = $value ? null : $this->_attributes;
13 years ago
}
12 years ago
/**
* This method is called at the beginning of inserting or updating a record.
12 years ago
* The default implementation will trigger an [[EVENT_BEFORE_INSERT]] event when `$insert` is true,
* or an [[EVENT_BEFORE_UPDATE]] event if `$insert` is false.
12 years ago
* 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.
*/
12 years ago
public function beforeSave($insert)
13 years ago
{
12 years ago
$event = new ModelEvent;
$this->trigger($insert ? self::EVENT_BEFORE_INSERT : self::EVENT_BEFORE_UPDATE, $event);
13 years ago
return $event->isValid;
13 years ago
}
12 years ago
/**
* This method is called at the end of inserting or updating a record.
12 years ago
* The default implementation will trigger an [[EVENT_AFTER_INSERT]] event when `$insert` is true,
* or an [[EVENT_AFTER_UPDATE]] event if `$insert` is false.
12 years ago
* 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.
*/
12 years ago
public function afterSave($insert)
13 years ago
{
$this->trigger($insert ? self::EVENT_AFTER_INSERT : self::EVENT_AFTER_UPDATE);
13 years ago
}
/**
* This method is invoked before deleting a record.
12 years ago
* The default implementation raises the [[EVENT_BEFORE_DELETE]] event.
12 years ago
* 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;
* }
* }
* ~~~
*
13 years ago
* @return boolean whether the record should be deleted. Defaults to true.
*/
13 years ago
public function beforeDelete()
13 years ago
{
12 years ago
$event = new ModelEvent;
$this->trigger(self::EVENT_BEFORE_DELETE, $event);
13 years ago
return $event->isValid;
13 years ago
}
/**
* This method is invoked after deleting a record.
12 years ago
* The default implementation raises the [[EVENT_AFTER_DELETE]] event.
13 years ago
* 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.
*/
13 years ago
public function afterDelete()
13 years ago
{
$this->trigger(self::EVENT_AFTER_DELETE);
13 years ago
}
/**
13 years ago
* Repopulates this active record with the latest data.
13 years ago
* @param array $attributes
12 years ago
* @return boolean whether the row still exists in the database. If true, the latest data
* will be populated to this active record.
13 years ago
*/
13 years ago
public function refresh($attributes = null)
13 years ago
{
12 years ago
$record = $this->find($this->getPrimaryKey(true));
13 years ago
if ($record === null) {
return false;
}
if ($attributes === null) {
foreach ($this->attributes() as $name) {
13 years ago
$this->_attributes[$name] = $record->_attributes[$name];
13 years ago
}
13 years ago
$this->_oldAttributes = $this->_attributes;
13 years ago
} else {
13 years ago
foreach ($attributes as $name) {
$this->_oldAttributes[$name] = $this->_attributes[$name] = $record->_attributes[$name];
}
13 years ago
}
13 years ago
return true;
13 years ago
}
/**
12 years ago
* 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.
13 years ago
* @param ActiveRecord $record record to compare to
12 years ago
* @return boolean whether the two active records refer to the same row in the same database table.
13 years ago
*/
13 years ago
public function equals($record)
13 years ago
{
13 years ago
return $this->tableName() === $record->tableName() && $this->getPrimaryKey() === $record->getPrimaryKey();
13 years ago
}
/**
12 years ago
* Returns the primary key value(s).
13 years ago
* @param boolean $asArray whether to return the primary key value as an array. If true,
12 years ago
* the return value will be an array with column names as keys and column values as values.
* Note that for composite primary keys, an array will always be returned regardless of this parameter value.
12 years ago
* @return mixed the primary key value. An array (column name => column value) is returned if the primary key
12 years ago
* is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
* the key value is null).
13 years ago
*/
13 years ago
public function getPrimaryKey($asArray = false)
13 years ago
{
12 years ago
$keys = $this->primaryKey();
if (count($keys) === 1 && !$asArray) {
return isset($this->_attributes[$keys[0]]) ? $this->_attributes[$keys[0]] : null;
13 years ago
} else {
13 years ago
$values = array();
12 years ago
foreach ($keys as $name) {
13 years ago
$values[$name] = isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
13 years ago
}
return $values;
13 years ago
}
}
/**
12 years ago
* Returns the old primary key value(s).
13 years ago
* 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.
13 years ago
* @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.
13 years ago
* If this is false (default), a scalar value will be returned for non-composite primary key.
12 years ago
* @return mixed the old primary key value. An array (column name => column value) is returned if the primary key
12 years ago
* is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
* the key value is null).
13 years ago
*/
13 years ago
public function getOldPrimaryKey($asArray = false)
13 years ago
{
12 years ago
$keys = $this->primaryKey();
if (count($keys) === 1 && !$asArray) {
return isset($this->_oldAttributes[$keys[0]]) ? $this->_oldAttributes[$keys[0]] : null;
13 years ago
} else {
$values = array();
12 years ago
foreach ($keys as $name) {
13 years ago
$values[$name] = isset($this->_oldAttributes[$name]) ? $this->_oldAttributes[$name] : null;
}
return $values;
}
13 years ago
}
/**
12 years ago
* Creates an active record object using a row of data.
12 years ago
* This method is called by [[ActiveQuery]] to populate the query results
* into Active Records. It is not meant to be used to create new records.
13 years ago
* @param array $row attribute values (name => value)
* @return ActiveRecord the newly created active record.
13 years ago
*/
13 years ago
public static function create($row)
13 years ago
{
13 years ago
$record = static::instantiate($row);
$columns = static::getTableSchema()->columns;
13 years ago
foreach ($row as $name => $value) {
13 years ago
if (isset($columns[$name])) {
13 years ago
$record->_attributes[$name] = $value;
13 years ago
} else {
13 years ago
$record->$name = $value;
13 years ago
}
}
13 years ago
$record->_oldAttributes = $record->_attributes;
$record->afterFind();
13 years ago
return $record;
13 years ago
}
/**
* Creates an active record instance.
12 years ago
* This method is called by [[create()]].
13 years ago
* You may override this method if the instance being created
12 years ago
* depends on the row data to be populated into the record.
13 years ago
* For example, by creating a record based on the value of a column,
* you may implement the so-called single-table inheritance mapping.
12 years ago
* @param array $row row data to be populated into the record.
* @return ActiveRecord the newly created active record
13 years ago
*/
13 years ago
public static function instantiate($row)
13 years ago
{
12 years ago
return new static;
13 years ago
}
/**
* 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
12 years ago
* @return boolean whether there is an element at the specified offset.
13 years ago
*/
public function offsetExists($offset)
{
return $this->__isset($offset);
}
12 years ago
12 years ago
/**
12 years ago
* 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
12 years ago
* @throws InvalidParamException if the named relation does not exist.
12 years ago
*/
public function getRelation($name)
{
$getter = 'get' . $name;
try {
$relation = $this->$getter();
if ($relation instanceof ActiveRelation) {
return $relation;
}
} catch (UnknownMethodException $e) {
throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e);
12 years ago
}
}
/**
12 years ago
* 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()]]`.)
* @throws InvalidCallException if the method is unable to link two models.
12 years ago
*/
12 years ago
public function link($name, $model, $extraColumns = array())
12 years ago
{
$relation = $this->getRelation($name);
if ($relation->via !== null) {
11 years ago
if ($this->getIsNewRecord() || $model->getIsNewRecord()) {
throw new InvalidCallException('Unable to link models: both models must NOT be newly created.');
}
if (is_array($relation->via)) {
12 years ago
/** @var $viaRelation ActiveRelation */
list($viaName, $viaRelation) = $relation->via;
/** @var $viaClass ActiveRecord */
12 years ago
$viaClass = $viaRelation->modelClass;
$viaTable = $viaClass::tableName();
12 years ago
// unset $viaName so that it can be reloaded to reflect the change
12 years ago
unset($this->_related[strtolower($viaName)]);
} else {
12 years ago
$viaRelation = $relation->via;
$viaTable = reset($relation->via->from);
}
$columns = array();
12 years ago
foreach ($viaRelation->link as $a => $b) {
$columns[$a] = $this->$b;
}
foreach ($relation->link as $a => $b) {
$columns[$b] = $model->$a;
}
12 years ago
foreach ($extraColumns as $k => $v) {
$columns[$k] = $v;
}
12 years ago
static::getDb()->createCommand()
12 years ago
->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()) {
throw new InvalidCallException('Unable to link models: both models are newly created.');
12 years ago
} elseif ($this->getIsNewRecord()) {
$this->bindModels(array_flip($relation->link), $this, $model);
12 years ago
} else {
12 years ago
$this->bindModels($relation->link, $model, $this);
}
12 years ago
} elseif ($p1) {
$this->bindModels(array_flip($relation->link), $this, $model);
} elseif ($p2) {
$this->bindModels($relation->link, $model, $this);
} else {
throw new InvalidCallException('Unable to link models: the link does not involve any primary key.');
}
}
12 years ago
12 years ago
// update lazily loaded related objects
12 years ago
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;
}
}
}
/**
12 years ago
* 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.
12 years ago
* @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.
* If true, the model containing the foreign key will be deleted.
* @throws InvalidCallException if the models cannot be unlinked
*/
public function unlink($name, $model, $delete = false)
{
$relation = $this->getRelation($name);
if ($relation->via !== null) {
if (is_array($relation->via)) {
12 years ago
/** @var $viaRelation ActiveRelation */
list($viaName, $viaRelation) = $relation->via;
/** @var $viaClass ActiveRecord */
12 years ago
$viaClass = $viaRelation->modelClass;
$viaTable = $viaClass::tableName();
12 years ago
unset($this->_related[strtolower($viaName)]);
} else {
12 years ago
$viaRelation = $relation->via;
$viaTable = reset($relation->via->from);
}
$columns = array();
12 years ago
foreach ($viaRelation->link as $a => $b) {
$columns[$a] = $this->$b;
}
foreach ($relation->link as $a => $b) {
$columns[$b] = $model->$a;
}
12 years ago
$command = static::getDb()->createCommand();
12 years ago
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();
}
} else {
12 years ago
$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 {
throw new InvalidCallException('Unable to unlink models: the link does not involve any primary key.');
12 years ago
}
}
12 years ago
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]);
}
}
}
}
/**
12 years ago
* 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 static function getNamespacedClass($class)
12 years ago
{
if (strpos($class, '\\') === false) {
$reflector = new \ReflectionClass(static::className());
return $reflector->getNamespaceName() . '\\' . $class;
} else {
return $class;
12 years ago
}
}
/**
12 years ago
* @param array $link
* @param ActiveRecord $foreignModel
* @param ActiveRecord $primaryModel
* @throws InvalidCallException
*/
12 years ago
private function bindModels($link, $foreignModel, $primaryModel)
{
12 years ago
foreach ($link as $fk => $pk) {
$value = $primaryModel->$pk;
if ($value === null) {
throw new InvalidCallException('Unable to link models: the primary key of ' . get_class($primaryModel) . ' is null.');
12 years ago
}
12 years ago
$foreignModel->$fk = $value;
12 years ago
}
12 years ago
$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;
12 years ago
}
/**
* 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]].
*/
public function isTransactional($operation)
{
$scenario = $this->getScenario();
$transactions = $this->transactions();
return isset($transactions[$scenario]) && ($transactions[$scenario] & $operation);
}
13 years ago
}