yii\db\BaseActiveRecord::update PHP Method

BaseActiveRecord Class Documentation Usage Examples Of yii\db\BaseActiveRecord::update Show file Open project: yiisoft/yii2

update() public method

This method performs the following steps in order: 1. call [[beforeValidate()]] when $runValidation is true. If [[beforeValidate()]] returns false, the rest of the steps will be skipped; 2. call [[afterValidate()]] when $runValidation is true. If validation failed, the rest of the steps will be skipped; 3. call BaseActiveRecord::beforeSave. If BaseActiveRecord::beforeSave returns false, the rest of the steps will be skipped; 4. save the record into database. If this fails, it will skip the rest of the steps; 5. call BaseActiveRecord::afterSave; In the above step 1, 2, 3 and 5, events [[EVENT_BEFORE_VALIDATE]], [[EVENT_AFTER_VALIDATE]], [[EVENT_BEFORE_UPDATE]], and [[EVENT_AFTER_UPDATE]] will be raised by the corresponding methods. Only the [[dirtyAttributes|changed attribute values]] will be saved into database. For example, to update a customer record: php $customer = Customer::findOne($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: php if ($customer->update() !== false) { update successful } else { update failed }

public update ( boolean $runValidation = true, array $attributeNames = null ) : integer \| false
$runValidation	boolean	whether to perform validation (calling [[validate()]]) before saving the record. Defaults to `true`. If the validation fails, the record will not be saved to the database and this method will return `false`.
$attributeNames	array	list of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.
return	integer \| false	the number of rows affected, or `false` if validation fails or [[beforeSave()]] stops the updating process.

    public function update($runValidation = true, $attributeNames = null)
    {
        if ($runValidation && !$this->validate($attributeNames)) {
            return false;
        }
        return $this->updateInternal($attributeNames);
    }

Usage Example

Example #1

Show file

File: ActiveModel.php Project: phantom-d/yii2-file-daemon

 /**
  * Saves the changes to this active record into the associated database table.
  */
 public function update($runValidation = true, $attributeNames = null)
 {
     return parent::update($runValidation, $attributeNames);
 }

BaseActiveRecord

__get

__isset

__set

__unset

afterDelete

afterFind

afterRefresh

afterSave

beforeDelete

beforeSave

bindModels