UpdateAction.php 1.17 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
    /**
     * @var string the scenario to be assigned to the model before it is validated and updated.
     */
    public $scenario = Model::SCENARIO_DEFAULT;
Qiang Xue committed
26

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

38 39 40
        if ($this->checkAccess) {
            call_user_func($this->checkAccess, $this->id, $model);
        }
Qiang Xue committed
41

42 43
        $model->scenario = $this->scenario;
        $model->load(Yii::$app->getRequest()->getBodyParams(), '');
44
        $model->save();
Qiang Xue committed
45

46 47
        return $model;
    }
Qiang Xue committed
48
}