UpdateAction.php 1.37 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
use yii\db\ActiveRecord;
13
use yii\web\ServerErrorHttpException;
Qiang Xue committed
14 15 16 17 18 19 20 21 22

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

28

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

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

44 45
        $model->scenario = $this->scenario;
        $model->load(Yii::$app->getRequest()->getBodyParams(), '');
46 47 48
        if ($model->save() === false && !$model->hasErrors()) {
            throw new ServerErrorHttpException('Failed to update the object for unknown reason.');
        }
Qiang Xue committed
49

50 51
        return $model;
    }
Qiang Xue committed
52
}