|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ActiveRecord class file.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright © 2008-2012 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\db\ar;
|
|
|
|
|
|
|
|
use yii\base\Model;
|
|
|
|
use yii\base\Event;
|
|
|
|
use yii\base\ModelEvent;
|
|
|
|
use yii\db\Exception;
|
|
|
|
use yii\db\dao\Connection;
|
|
|
|
use yii\db\dao\TableSchema;
|
|
|
|
use yii\db\dao\Query;
|
|
|
|
use yii\db\dao\Expression;
|
|
|
|
use yii\util\StringHelper;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ActiveRecord is the base class for classes representing relational data.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*
|
|
|
|
* @property array $attributes attribute values indexed by attribute names
|
|
|
|
*
|
|
|
|
* ActiveRecord provides a set of events for further customization:
|
|
|
|
*
|
|
|
|
* - `beforeInsert`. Raised before the record is saved.
|
|
|
|
* By setting [[\yii\base\ModelEvent::isValid]] to be false, the normal [[save()]] will be stopped.
|
|
|
|
* - `afterInsert`. Raised after the record is saved.
|
|
|
|
* - `beforeUpdate`. Raised before the record is saved.
|
|
|
|
* By setting [[\yii\base\ModelEvent::isValid]] to be false, the normal [[save()]] will be stopped.
|
|
|
|
* - `afterUpdate`. Raised after the record is saved.
|
|
|
|
* - `beforeDelete`. Raised before the record is deleted.
|
|
|
|
* By setting [[\yii\base\ModelEvent::isValid]] to be false, the normal [[delete()]] process will be stopped.
|
|
|
|
* - `afterDelete`. Raised after the record is deleted.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
abstract class ActiveRecord extends Model
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var ActiveRecord[] global model instances indexed by model class names
|
|
|
|
*/
|
|
|
|
private static $_models = array();
|
|
|
|
/**
|
|
|
|
* @var array attribute values indexed by attribute names
|
|
|
|
*/
|
|
|
|
private $_attributes = array();
|
|
|
|
/**
|
|
|
|
* @var array old attribute values indexed by attribute names.
|
|
|
|
*/
|
|
|
|
private $_oldAttributes;
|
|
|
|
/**
|
|
|
|
* @var array related records indexed by relation names.
|
|
|
|
*/
|
|
|
|
private $_related;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a model instance to support accessing non-static methods such as [[table()]], [[primaryKey()]].
|
|
|
|
* @return ActiveRecord
|
|
|
|
*/
|
|
|
|
public static function model()
|
|
|
|
{
|
|
|
|
$className = get_called_class();
|
|
|
|
if (isset(self::$_models[$className])) {
|
|
|
|
return self::$_models[$className];
|
|
|
|
} else {
|
|
|
|
return self::$_models[$className] = new static;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
public static function getDbConnection()
|
|
|
|
{
|
|
|
|
return \Yii::$application->getDb();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an [[ActiveQuery]] instance for query purpose.
|
|
|
|
*
|
|
|
|
* Because [[ActiveQuery]] implements a set of query building methods,
|
|
|
|
* additional query conditions can be specified by calling the methods of [[ActiveQuery]].
|
|
|
|
*
|
|
|
|
* Below are some usage examples:
|
|
|
|
*
|
|
|
|
* ~~~
|
|
|
|
* // find all customers
|
|
|
|
* $customers = Customer::find()->all();
|
|
|
|
* // find a single customer whose primary key value is 10
|
|
|
|
* $customer = Customer::find(10);
|
|
|
|
* // the above is equivalent to:
|
|
|
|
* Customer::find()->where(array('id' => 10))->one();
|
|
|
|
* // find all active customers and order them by their age:
|
|
|
|
* $customers = Customer::find()
|
|
|
|
* ->where(array('status' => 1))
|
|
|
|
* ->orderBy('age')
|
|
|
|
* ->all();
|
|
|
|
* // or alternatively:
|
|
|
|
* $customers = Customer::find(array(
|
|
|
|
* 'where' => array('status' => 1),
|
|
|
|
* 'orderBy' => 'age',
|
|
|
|
* ))->all();
|
|
|
|
* ~~~
|
|
|
|
*
|
|
|
|
* @param mixed $q the query parameter. This can be one of the followings:
|
|
|
|
*
|
|
|
|
* - a scalar value (integer or string): query by a single primary key value.
|
|
|
|
* - an array of name-value pairs: it will be used to configure the [[ActiveQuery]] object.
|
|
|
|
*
|
|
|
|
* @return ActiveQuery|ActiveRecord|null the [[ActiveQuery]] instance for query purpose, or
|
|
|
|
* the ActiveRecord object when a scalar is passed to this method which is considered to be a
|
|
|
|
* primary key value (null will be returned if no record is found in this case.)
|
|
|
|
*/
|
|
|
|
public static function find($q = null)
|
|
|
|
{
|
|
|
|
$query = static::createActiveQuery();
|
|
|
|
if (is_array($q)) {
|
|
|
|
foreach ($q as $name => $value) {
|
|
|
|
$query->$name = $value;
|
|
|
|
}
|
|
|
|
} elseif ($q !== null) {
|
|
|
|
// query by primary key
|
|
|
|
$primaryKey = static::model()->primaryKey();
|
|
|
|
return $query->where(array($primaryKey[0] => $q))->one();
|
|
|
|
}
|
|
|
|
return $query;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an [[ActiveQuery]] instance and queries by a given SQL statement.
|
|
|
|
* Note that because the SQL statement is already specified, calling further
|
|
|
|
* query methods (such as `where()`, `order()`) on [[ActiveQuery]] will have no effect.
|
|
|
|
* Methods such as `with()`, `asArray()` can still be called though.
|
|
|
|
* @param string $sql the SQL statement to be executed
|
|
|
|
* @param array $params parameters to be bound to the SQL statement during execution.
|
|
|
|
* @return ActiveQuery the [[ActiveQuery]] instance
|
|
|
|
*/
|
|
|
|
public static function findBySql($sql, $params = array())
|
|
|
|
{
|
|
|
|
$query = static::createActiveQuery();
|
|
|
|
$query->sql = $sql;
|
|
|
|
return $query->params($params);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Performs a COUNT query for this AR class.
|
|
|
|
*
|
|
|
|
* Below are some usage examples:
|
|
|
|
*
|
|
|
|
* ~~~
|
|
|
|
* // count the total number of customers
|
|
|
|
* echo Customer::count()->value();
|
|
|
|
* // count the number of active customers:
|
|
|
|
* echo Customer::count(array(
|
|
|
|
* 'where' => array('status' => 1),
|
|
|
|
* ))->value();
|
|
|
|
* // equivalent usage:
|
|
|
|
* echo Customer::count()
|
|
|
|
* ->where(array('status' => 1))
|
|
|
|
* ->value();
|
|
|
|
* // customize the count option
|
|
|
|
* echo Customer::count('COUNT(DISTINCT age)')->value();
|
|
|
|
* ~~~
|
|
|
|
*
|
|
|
|
* @param array|string $q the query option. This can be one of the followings:
|
|
|
|
*
|
|
|
|
* - an array of name-value pairs: it will be used to configure the [[ActiveQuery]] object.
|
|
|
|
* - a string: the count expression, e.g. 'COUNT(DISTINCT age)'.
|
|
|
|
*
|
|
|
|
* @return ActiveQuery the [[ActiveQuery]] instance
|
|
|
|
*/
|
|
|
|
public static function count($q = null)
|
|
|
|
{
|
|
|
|
$query = static::createActiveQuery();
|
|
|
|
if (is_array($q)) {
|
|
|
|
foreach ($q as $name => $value) {
|
|
|
|
$query->$name = $value;
|
|
|
|
}
|
|
|
|
} elseif ($q !== null) {
|
|
|
|
$query->select = array($q);
|
|
|
|
} elseif ($query->select === null) {
|
|
|
|
$query->select = array('COUNT(*)');
|
|
|
|
}
|
|
|
|
return $query;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates the whole table using the provided attribute values and conditions.
|
|
|
|
* @param array $attributes attribute values to be saved into the table
|
|
|
|
* @param string|array $condition the conditions that will be put in the WHERE part.
|
|
|
|
* Please refer to [[Query::where()]] on how to specify this parameter.
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query.
|
|
|
|
* @return integer the number of rows updated
|
|
|
|
*/
|
|
|
|
public static function updateAll($attributes, $condition = '', $params = array())
|
|
|
|
{
|
|
|
|
$query = new Query;
|
|
|
|
$query->update(static::model()->tableName(), $attributes, $condition, $params);
|
|
|
|
return $query->createCommand(static::getDbConnection())->execute();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates the whole table using the provided counter values and conditions.
|
|
|
|
* @param array $counters the counters to be updated (attribute name => increment value).
|
|
|
|
* @param string|array $condition the conditions that will be put in the WHERE part.
|
|
|
|
* Please refer to [[Query::where()]] on how to specify this parameter.
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query.
|
|
|
|
* @return integer the number of rows updated
|
|
|
|
*/
|
|
|
|
public static function updateAllCounters($counters, $condition = '', $params = array())
|
|
|
|
{
|
|
|
|
$db = static::getDbConnection();
|
|
|
|
foreach ($counters as $name => $value) {
|
|
|
|
$value = (int)$value;
|
|
|
|
$quotedName = $db->quoteColumnName($name, true);
|
|
|
|
$counters[$name] = new Expression($value >= 0 ? "$quotedName+$value" : "$quotedName$value");
|
|
|
|
}
|
|
|
|
$query = new Query;
|
|
|
|
$query->update(static::model()->tableName(), $counters, $condition, $params);
|
|
|
|
return $query->createCommand($db)->execute();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deletes rows in the table using the provided conditions.
|
|
|
|
* @param string|array $condition the conditions that will be put in the WHERE part.
|
|
|
|
* Please refer to [[Query::where()]] on how to specify this parameter.
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query.
|
|
|
|
* @return integer the number of rows updated
|
|
|
|
*/
|
|
|
|
public static function deleteAll($condition = '', $params = array())
|
|
|
|
{
|
|
|
|
$query = new Query;
|
|
|
|
$query->delete(static::model()->tableName(), $condition, $params);
|
|
|
|
return $query->createCommand(static::getDbConnection())->execute();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a [[ActiveQuery]] instance.
|
|
|
|
* This method is called by [[find()]] and [[findBySql()]] to start a SELECT query.
|
|
|
|
* @return ActiveQuery the newly created [[ActiveQuery]] instance.
|
|
|
|
*/
|
|
|
|
public static function createActiveQuery()
|
|
|
|
{
|
|
|
|
return new ActiveQuery(get_called_class());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 [[StringHelper::camel2id()]].
|
|
|
|
* For example, 'Customer' becomes 'customer', and 'OrderDetail' becomes 'order_detail'.
|
|
|
|
* You may override this method if the table is not named after this convention.
|
|
|
|
* @return string the table name
|
|
|
|
*/
|
|
|
|
public function tableName()
|
|
|
|
{
|
|
|
|
return StringHelper::camel2id(basename(get_class($this)), '_');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
public function getTableSchema()
|
|
|
|
{
|
|
|
|
return $this->getDbConnection()->getTableSchema($this->tableName());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the primary keys for this AR class.
|
|
|
|
* The default implementation will return the primary keys as declared
|
|
|
|
* in the DB table that is associated with this AR class.
|
|
|
|
* 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.
|
|
|
|
* @return string[] the primary keys of the associated database table.
|
|
|
|
*/
|
|
|
|
public function primaryKey()
|
|
|
|
{
|
|
|
|
return $this->getTableSchema()->primaryKey;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the default named scope that should be implicitly applied to all queries for this model.
|
|
|
|
* Note, default scope only applies to SELECT queries. It is ignored for INSERT, UPDATE and DELETE queries.
|
|
|
|
* The default implementation simply returns an empty array. You may override this method
|
|
|
|
* if the model needs to be queried with some default criteria (e.g. only active records should be returned).
|
|
|
|
* @param BaseActiveQuery
|
|
|
|
* @return BaseActiveQuery the query criteria. This will be used as the parameter to the constructor
|
|
|
|
* of {@link CDbCriteria}.
|
|
|
|
*/
|
|
|
|
public static function defaultScope($query)
|
|
|
|
{
|
|
|
|
return $query;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* PHP getter magic method.
|
|
|
|
* This method is overridden so that attributes and related objects can be accessed like properties.
|
|
|
|
* @param string $name property name
|
|
|
|
* @return mixed property value
|
|
|
|
* @see getAttribute
|
|
|
|
*/
|
|
|
|
public function __get($name)
|
|
|
|
{
|
|
|
|
if (isset($this->_attributes[$name])) {
|
|
|
|
return $this->_attributes[$name];
|
|
|
|
}
|
|
|
|
if (isset($this->getTableSchema()->columns[$name])) {
|
|
|
|
return null;
|
|
|
|
} elseif (method_exists($this, $name)) {
|
|
|
|
if (isset($this->_related[$name]) || $this->_related !== null && array_key_exists($name, $this->_related)) {
|
|
|
|
return $this->_related[$name];
|
|
|
|
} else {
|
|
|
|
// todo
|
|
|
|
return $this->_related[$name] = $this->findByRelation($md->relations[$name]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return parent::__get($name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 (isset($this->getTableSchema()->columns[$name])) {
|
|
|
|
$this->_attributes[$name] = $value;
|
|
|
|
} elseif (method_exists($this, $name)) {
|
|
|
|
$this->_related[$name] = $value;
|
|
|
|
} else {
|
|
|
|
parent::__set($name, $value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks if a property value is null.
|
|
|
|
* This method overrides the parent implementation by checking
|
|
|
|
* if the named attribute is null or not.
|
|
|
|
* @param string $name the property name or the event name
|
|
|
|
* @return boolean whether the property value is null
|
|
|
|
*/
|
|
|
|
public function __isset($name)
|
|
|
|
{
|
|
|
|
if (isset($this->_attributes[$name]) || isset($this->_related[$name])) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
if (isset($this->getTableSchema()->columns[$name]) || method_exists($this, $name)) {
|
|
|
|
return false;
|
|
|
|
} else {
|
|
|
|
return parent::__isset($name);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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)
|
|
|
|
{
|
|
|
|
if (isset($this->getTableSchema()->columns[$name])) {
|
|
|
|
unset($this->_attributes[$name]);
|
|
|
|
} elseif (method_exists($this, $name)) {
|
|
|
|
unset($this->_related[$name]);
|
|
|
|
} else {
|
|
|
|
parent::__unset($name);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes the internal storage for the relation.
|
|
|
|
* This method is internally used by [[ActiveQuery]] when populating relation data.
|
|
|
|
* @param ActiveRelation $relation the relation object
|
|
|
|
*/
|
|
|
|
public function initRelation($relation)
|
|
|
|
{
|
|
|
|
$this->_related[$relation->name] = $relation->hasMany ? array() : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param ActiveRelation $relation
|
|
|
|
* @param ActiveRecord $record
|
|
|
|
*/
|
|
|
|
public function addRelatedRecord($relation, $record)
|
|
|
|
{
|
|
|
|
if ($relation->hasMany) {
|
|
|
|
if ($relation->index !== null) {
|
|
|
|
$this->_related[$relation->name][$record->{$relation->index}] = $record;
|
|
|
|
} else {
|
|
|
|
$this->_related[$relation->name][] = $record;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$this->_related[$relation->name] = $record;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the related record(s).
|
|
|
|
* This method will return the related record(s) of the current record.
|
|
|
|
* If the relation is HAS_ONE or BELONGS_TO, it will return a single object
|
|
|
|
* or null if the object does not exist.
|
|
|
|
* If the relation is HAS_MANY or MANY_MANY, it will return an array of objects
|
|
|
|
* or an empty array.
|
|
|
|
* @param ActiveRelation|string $relation the relation object or the name of the relation
|
|
|
|
* @param array|\Closure $params additional parameters that customize the query conditions as specified in the relation declaration.
|
|
|
|
* @return mixed the related object(s).
|
|
|
|
* @throws Exception if the relation is not specified in [[relations()]].
|
|
|
|
*/
|
|
|
|
public function findByRelation($relation, $params = array())
|
|
|
|
{
|
|
|
|
if (is_string($relation)) {
|
|
|
|
$md = $this->getMetaData();
|
|
|
|
if (!isset($md->relations[$relation])) {
|
|
|
|
throw new Exception(get_class($this) . ' has no relation named "' . $relation . '".');
|
|
|
|
}
|
|
|
|
$relation = $md->relations[$relation];
|
|
|
|
}
|
|
|
|
$relation = clone $relation;
|
|
|
|
if ($params instanceof \Closure) {
|
|
|
|
$params($relation);
|
|
|
|
} else {
|
|
|
|
foreach ($params as $name => $value) {
|
|
|
|
$relation->$name = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$finder = new ActiveFinder($this->getDbConnection());
|
|
|
|
return $finder->findWithRecord($this, $relation);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the list of all attribute names of the model.
|
|
|
|
* This would return all column names of the table associated with this AR class.
|
|
|
|
* @return array list of attribute names.
|
|
|
|
*/
|
|
|
|
public function attributes()
|
|
|
|
{
|
|
|
|
return array_keys($this->getTableSchema()->columns);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the named attribute value.
|
|
|
|
* If this is a new record and the attribute is not set before,
|
|
|
|
* the default column value will be returned.
|
|
|
|
* If this record is the result of a query and the attribute is not loaded,
|
|
|
|
* null will be returned.
|
|
|
|
* You may also use $this->AttributeName to obtain the attribute value.
|
|
|
|
* @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)
|
|
|
|
{
|
|
|
|
return isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the named attribute value.
|
|
|
|
* You may also use $this->AttributeName to set the attribute value.
|
|
|
|
* @param string $name the attribute name
|
|
|
|
* @param mixed $value the attribute value.
|
|
|
|
* @see hasAttribute
|
|
|
|
*/
|
|
|
|
public function setAttribute($name, $value)
|
|
|
|
{
|
|
|
|
$this->_attributes[$name] = $value;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getChangedAttributes($names = null)
|
|
|
|
{
|
|
|
|
if ($names === null) {
|
|
|
|
$names = $this->attributes();
|
|
|
|
}
|
|
|
|
$names = array_flip($names);
|
|
|
|
$attributes = array();
|
|
|
|
if ($this->_oldAttributes === null) {
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $attributes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Saves the current record.
|
|
|
|
*
|
|
|
|
* The record is inserted as a row into the database table if its {@link isNewRecord}
|
|
|
|
* property is true (usually the case when the record is created using the 'new'
|
|
|
|
* operator). Otherwise, it will be used to update the corresponding row in the table
|
|
|
|
* (usually the case if the record is obtained using one of those 'find' methods.)
|
|
|
|
*
|
|
|
|
* Validation will be performed before saving the record. If the validation fails,
|
|
|
|
* the record will not be saved. You can call {@link getErrors()} to retrieve the
|
|
|
|
* validation errors.
|
|
|
|
*
|
|
|
|
* If the record is saved via insertion, its {@link isNewRecord} property will be
|
|
|
|
* set false, and its {@link scenario} property will be set to be 'update'.
|
|
|
|
* And if its primary key is auto-incremental and is not set before insertion,
|
|
|
|
* the primary key will be populated with the automatically generated key value.
|
|
|
|
*
|
|
|
|
* @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 (!$runValidation || $this->validate($attributes)) {
|
|
|
|
return $this->getIsNewRecord() ? $this->insert($attributes) : $this->update($attributes);
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Inserts a row into the table based on this active record attributes.
|
|
|
|
* If the table's primary key is auto-incremental and is null before insertion,
|
|
|
|
* it will be populated with the actual value after insertion.
|
|
|
|
* Note, validation is not performed in this method. You may call {@link validate} to perform the validation.
|
|
|
|
* After the record is inserted to DB successfully, its {@link isNewRecord} property will be set false,
|
|
|
|
* and its {@link scenario} property will be set to be 'update'.
|
|
|
|
* @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 if the record is not new
|
|
|
|
*/
|
|
|
|
public function insert($attributes = null)
|
|
|
|
{
|
|
|
|
if ($this->beforeInsert()) {
|
|
|
|
$query = new Query;
|
|
|
|
$values = $this->getChangedAttributes($attributes);
|
|
|
|
$db = $this->getDbConnection();
|
|
|
|
$command = $query->insert($this->tableName(), $values)->createCommand($db);
|
|
|
|
if ($command->execute()) {
|
|
|
|
$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;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
foreach ($values as $name => $value) {
|
|
|
|
$this->_oldAttributes[$name] = $value;
|
|
|
|
}
|
|
|
|
$this->afterInsert();
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates the row represented by this active record.
|
|
|
|
* All loaded attributes will be saved to the database.
|
|
|
|
* Note, validation is not performed in this method. You may call {@link validate} to perform the validation.
|
|
|
|
* @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 update is successful
|
|
|
|
* @throws Exception if the record is new
|
|
|
|
*/
|
|
|
|
public function update($attributes = null)
|
|
|
|
{
|
|
|
|
if ($this->getIsNewRecord()) {
|
|
|
|
throw new Exception('The active record cannot be updated because it is new.');
|
|
|
|
}
|
|
|
|
if ($this->beforeUpdate()) {
|
|
|
|
$values = $this->getChangedAttributes($attributes);
|
|
|
|
if ($values !== array()) {
|
|
|
|
$this->updateAll($values, $this->getOldPrimaryKey(true));
|
|
|
|
foreach ($values as $name => $value) {
|
|
|
|
$this->_oldAttributes[$name] = $this->_attributes[$name];
|
|
|
|
}
|
|
|
|
$this->afterUpdate();
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Saves one or several counter columns for the current AR object.
|
|
|
|
* Note that this method differs from [[updateAllCounters()]] in that it only
|
|
|
|
* saves counters for the current AR object.
|
|
|
|
*
|
|
|
|
* An example usage is as follows:
|
|
|
|
*
|
|
|
|
* ~~~
|
|
|
|
* $post = Post::find($id)->one();
|
|
|
|
* $post->updateCounters(array('view_count' => 1));
|
|
|
|
* ~~~
|
|
|
|
*
|
|
|
|
* Use negative values if you want to decrease the counters.
|
|
|
|
* @param array $counters the counters to be updated (attribute name => increment value)
|
|
|
|
* @return boolean whether the saving is successful
|
|
|
|
* @throws Exception if the record is new or any database error
|
|
|
|
* @see updateAllCounters()
|
|
|
|
*/
|
|
|
|
public function updateCounters($counters)
|
|
|
|
{
|
|
|
|
if ($this->getIsNewRecord()) {
|
|
|
|
throw new Exception('The active record cannot be updated because it is new.');
|
|
|
|
}
|
|
|
|
$this->updateAllCounters($counters, $this->getOldPrimaryKey(true));
|
|
|
|
foreach ($counters as $name => $value) {
|
|
|
|
$this->_attributes[$name] += $value;
|
|
|
|
$this->_oldAttributes[$name] = $this->_attributes[$name];
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deletes the row corresponding to this active record.
|
|
|
|
* @return boolean whether the deletion is successful.
|
|
|
|
* @throws Exception if the record is new or any database error
|
|
|
|
*/
|
|
|
|
public function delete()
|
|
|
|
{
|
|
|
|
if ($this->getIsNewRecord()) {
|
|
|
|
throw new Exception('The active record cannot be deleted because it is new.');
|
|
|
|
}
|
|
|
|
if ($this->beforeDelete()) {
|
|
|
|
$result = $this->deleteAll($this->getPrimaryKey(true)) > 0;
|
|
|
|
$this->_oldAttributes = null;
|
|
|
|
$this->afterDelete();
|
|
|
|
return $result;
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns if the current record is new.
|
|
|
|
* @return boolean whether the record is new and should be inserted when calling {@link save}.
|
|
|
|
* This property is automatically set in constructor and {@link populateRecord}.
|
|
|
|
* Defaults to false, but it will be set to true if the instance is created using
|
|
|
|
* the new operator.
|
|
|
|
*/
|
|
|
|
public function getIsNewRecord()
|
|
|
|
{
|
|
|
|
return $this->_oldAttributes === null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets if the record is new.
|
|
|
|
* @param boolean $value whether the record is new and should be inserted when calling {@link save}.
|
|
|
|
* @see getIsNewRecord
|
|
|
|
*/
|
|
|
|
public function setIsNewRecord($value)
|
|
|
|
{
|
|
|
|
$this->_oldAttributes = $value ? null : $this->_attributes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked before saving a record (after validation, if any).
|
|
|
|
* The default implementation raises the `beforeSave` event.
|
|
|
|
* You may override this method to do any preparation work for record saving.
|
|
|
|
* Use {@link isNewRecord} to determine whether the saving is
|
|
|
|
* for inserting or updating record.
|
|
|
|
* Make sure you call the parent implementation so that the event is raised properly.
|
|
|
|
* @return boolean whether the saving should be executed. Defaults to true.
|
|
|
|
*/
|
|
|
|
public function beforeInsert()
|
|
|
|
{
|
|
|
|
$event = new ModelEvent($this);
|
|
|
|
$this->trigger('beforeInsert', $event);
|
|
|
|
return $event->isValid;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked after saving a record successfully.
|
|
|
|
* The default implementation raises the `afterSave` event.
|
|
|
|
* You may override this method to do postprocessing after record saving.
|
|
|
|
* Make sure you call the parent implementation so that the event is raised properly.
|
|
|
|
*/
|
|
|
|
public function afterInsert()
|
|
|
|
{
|
|
|
|
$this->trigger('afterInsert', new Event($this));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked before saving a record (after validation, if any).
|
|
|
|
* The default implementation raises the `beforeSave` event.
|
|
|
|
* You may override this method to do any preparation work for record saving.
|
|
|
|
* Use {@link isNewRecord} to determine whether the saving is
|
|
|
|
* for inserting or updating record.
|
|
|
|
* Make sure you call the parent implementation so that the event is raised properly.
|
|
|
|
* @return boolean whether the saving should be executed. Defaults to true.
|
|
|
|
*/
|
|
|
|
public function beforeUpdate()
|
|
|
|
{
|
|
|
|
$event = new ModelEvent($this);
|
|
|
|
$this->trigger('beforeUpdate', $event);
|
|
|
|
return $event->isValid;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked after saving a record successfully.
|
|
|
|
* The default implementation raises the `afterSave` event.
|
|
|
|
* You may override this method to do postprocessing after record saving.
|
|
|
|
* Make sure you call the parent implementation so that the event is raised properly.
|
|
|
|
*/
|
|
|
|
public function afterUpdate()
|
|
|
|
{
|
|
|
|
$this->trigger('afterUpdate', new Event($this));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked before deleting a record.
|
|
|
|
* The default implementation raises the `beforeDelete` event.
|
|
|
|
* You may override this method to do any preparation work for record deletion.
|
|
|
|
* Make sure you call the parent implementation so that the event is raised properly.
|
|
|
|
* @return boolean whether the record should be deleted. Defaults to true.
|
|
|
|
*/
|
|
|
|
public function beforeDelete()
|
|
|
|
{
|
|
|
|
$event = new ModelEvent($this);
|
|
|
|
$this->trigger('beforeDelete', $event);
|
|
|
|
return $event->isValid;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked after deleting a record.
|
|
|
|
* The default implementation raises the `afterDelete` event.
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
public function afterDelete()
|
|
|
|
{
|
|
|
|
$this->trigger('afterDelete', new Event($this));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Repopulates this active record with the latest data.
|
|
|
|
* @param array $attributes
|
|
|
|
* @return boolean whether the row still exists in the database. If true, the latest data will be populated to this active record.
|
|
|
|
*/
|
|
|
|
public function refresh($attributes = null)
|
|
|
|
{
|
|
|
|
if ($this->getIsNewRecord()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
$record = $this->find()->where($this->getPrimaryKey(true))->one();
|
|
|
|
if ($record === null) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
if ($attributes === null) {
|
|
|
|
foreach ($this->attributes() as $name) {
|
|
|
|
$this->_attributes[$name] = $record->_attributes[$name];
|
|
|
|
}
|
|
|
|
$this->_oldAttributes = $this->_attributes;
|
|
|
|
} else {
|
|
|
|
foreach ($attributes as $name) {
|
|
|
|
$this->_oldAttributes[$name] = $this->_attributes[$name] = $record->_attributes[$name];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Compares current active record with another one.
|
|
|
|
* The comparison is made by comparing table name and the primary key values of the two active records.
|
|
|
|
* @param ActiveRecord $record record to compare to
|
|
|
|
* @return boolean whether the two active records refer to the same row in the database table.
|
|
|
|
*/
|
|
|
|
public function equals($record)
|
|
|
|
{
|
|
|
|
return $this->tableName() === $record->tableName() && $this->getPrimaryKey() === $record->getPrimaryKey();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the primary key value.
|
|
|
|
* @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.
|
|
|
|
* @return mixed the primary key value. An array (column name=>column value) is returned if the primary key is composite.
|
|
|
|
* If primary key is not defined, null will be returned.
|
|
|
|
*/
|
|
|
|
public function getPrimaryKey($asArray = false)
|
|
|
|
{
|
|
|
|
$keys = $this->primaryKey();
|
|
|
|
if (count($keys) === 1 && !$asArray) {
|
|
|
|
return isset($this->_attributes[$keys[0]]) ? $this->_attributes[$keys[0]] : null;
|
|
|
|
} else {
|
|
|
|
$values = array();
|
|
|
|
foreach ($keys as $name) {
|
|
|
|
$values[$name] = isset($this->_attributes[$name]) ? $this->_attributes[$name] : null;
|
|
|
|
}
|
|
|
|
return $values;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the old primary key value.
|
|
|
|
* 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.
|
|
|
|
* @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.
|
|
|
|
* If this is false (default), a scalar value will be returned for non-composite primary key.
|
|
|
|
* @return string|array the old primary key value. An array (column name=>column value) is returned if the primary key is composite.
|
|
|
|
* If primary key is not defined, null will be returned.
|
|
|
|
*/
|
|
|
|
public function getOldPrimaryKey($asArray = false)
|
|
|
|
{
|
|
|
|
$keys = $this->primaryKey();
|
|
|
|
if (count($keys) === 1 && !$asArray) {
|
|
|
|
return isset($this->_oldAttributes[$keys[0]]) ? $this->_oldAttributes[$keys[0]] : null;
|
|
|
|
} else {
|
|
|
|
$values = array();
|
|
|
|
foreach ($keys as $name) {
|
|
|
|
$values[$name] = isset($this->_oldAttributes[$name]) ? $this->_oldAttributes[$name] : null;
|
|
|
|
}
|
|
|
|
return $values;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an active record with the given attributes.
|
|
|
|
* @param array $row attribute values (name => value)
|
|
|
|
* @return ActiveRecord the newly created active record.
|
|
|
|
*/
|
|
|
|
public static function create($row)
|
|
|
|
{
|
|
|
|
$record = static::instantiate($row);
|
|
|
|
$columns = static::model()->getTableSchema()->columns;
|
|
|
|
foreach ($row as $name => $value) {
|
|
|
|
if (isset($columns[$name])) {
|
|
|
|
$record->_attributes[$name] = $value;
|
|
|
|
} else {
|
|
|
|
$record->$name = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
$record->_oldAttributes = $record->_attributes;
|
|
|
|
return $record;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an active record instance.
|
|
|
|
* This method is called by [[createRecord()]].
|
|
|
|
* You may override this method if the instance being created
|
|
|
|
* depends the attributes that are to be populated to the record.
|
|
|
|
* For example, by creating a record based on the value of a column,
|
|
|
|
* you may implement the so-called single-table inheritance mapping.
|
|
|
|
* @param array $row list of attribute values for the active records.
|
|
|
|
* @return ActiveRecord the active record
|
|
|
|
*/
|
|
|
|
public static function instantiate($row)
|
|
|
|
{
|
|
|
|
return new static;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
* @return boolean
|
|
|
|
*/
|
|
|
|
public function offsetExists($offset)
|
|
|
|
{
|
|
|
|
return $this->__isset($offset);
|
|
|
|
}
|
|
|
|
}
|