UpdateAction.php 1.75 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rest;

use Yii;
Qiang Xue committed
11
use yii\base\Model;
Qiang Xue committed
12 13 14 15 16 17 18 19 20 21
use yii\db\ActiveRecord;

/**
 * UpdateAction implements the API endpoint for updating a model.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class UpdateAction extends Action
{
22 23 24 25 26 27 28 29
    /**
     * @var string the scenario to be assigned to the model before it is validated and updated.
     */
    public $scenario = Model::SCENARIO_DEFAULT;
    /**
     * @var boolean whether to start a DB transaction when saving the model.
     */
    public $transactional = true;
Qiang Xue committed
30

31 32
    /**
     * Updates an existing model.
33
     * @param string $id the primary key of the model.
34
     * @return \yii\db\ActiveRecordInterface the model being updated
35
     * @throws \Exception if there is any error when updating the model
36 37 38 39 40
     */
    public function run($id)
    {
        /** @var ActiveRecord $model */
        $model = $this->findModel($id);
Qiang Xue committed
41

42 43 44
        if ($this->checkAccess) {
            call_user_func($this->checkAccess, $this->id, $model);
        }
Qiang Xue committed
45

46 47
        $model->scenario = $this->scenario;
        $model->load(Yii::$app->getRequest()->getBodyParams(), '');
Qiang Xue committed
48

49 50 51 52 53 54 55 56 57 58 59 60 61 62
        if ($this->transactional && $model instanceof ActiveRecord) {
            if ($model->validate()) {
                $transaction = $model->getDb()->beginTransaction();
                try {
                    $model->update(false);
                    $transaction->commit();
                } catch (\Exception $e) {
                    $transaction->rollback();
                    throw $e;
                }
            }
        } else {
            $model->save();
        }
Qiang Xue committed
63

64 65
        return $model;
    }
Qiang Xue committed
66
}