rootlocal/yii2-crud

<?php

namespace rootlocal\crud\actions;

use Yii;
use rootlocal\crud\components\Action;
use yii\db\ActiveRecord;
use yii\web\Response;
use yii\base\ErrorException;
use yii\web\NotFoundHttpException;
use Closure;

/**
 * Class UpdateAction
 * Updates an existing [[ActiveRecord]] model.
 * If update is successful, the browser will be [[redirect]] to the 'view' page.
 *
 * examples:
 *
 * ```php
 * // lambda function:
 * public function actions()
 * {
 *      'update' => [
 *          'class' => UpdateAction::class,
 *          'scenario' => Book::SCENARIO_UPDATE,
 *          'model' => function ($id, $scenario) {
 *              $model = Book::find()->where(['id' => $id])->active()->one();
 *              if($model !== null)
 *                  $model->scenario = $scenario;
 *              return $model;
 *          }
 *      ]
 * }
 *
 * // string:
 * public function actions()
 * {
 *      'update' => [
 *          'class' => UpdateAction::class,
 *          'scenario' => Book::SCENARIO_UPDATE,
 *          'model' => Book::class
 *      ]
 * }
 * ```
 *
 * @property string|Closure $model ActiveRecord Model
 * @property string|null $scenario scenario for model. Defaults to [[ActiveRecord::SCENARIO_DEFAULT]]
 *
 * @author Alexander Zakharov <sys@eml.ru>
 * @package rootlocal\crud\actions
 */
class UpdateAction extends Action
{
    /**
     * @var string
     */
    private $_scenario;

    /**
     * @var string|array $redirect the URL to be redirected to. This can be in one of the following formats:
     *
     * - a string representing a URL (e.g. "http://example.com")
     * - a string representing a URL alias (e.g. "@example.com")
     * - an array in the format of `[$route, ...name-value pairs...]` (e.g. `['site/index', 'ref' => 1]`)
     *   [[\yii\helpers\Url::to()]] will be used to convert the array into a URL.
     *
     * Any relative URL that starts with a single forward slash "/" will be converted
     * into an absolute one by prepending it with the host info of the current request.
     *
     * ```php
     * <?= \yii\helpers\Html::a('Update', ['update', 'id' => $model->id, 'redirect' => 'index'], [
     * 'class' => 'btn btn-primary btn-sm'
     * ]) ?>
     * ```
     */
    public $redirect;

    /**
     * @var string|Closure
     */
    private $_model;


    /**
     * @inheritDoc
     */
    public function init()
    {
        parent::init();

        if (Yii::$app->request->get('redirect') !== null) {
            $this->redirect = [Yii::$app->request->get('redirect')];
        }
    }

    /**
     * Runs the action.
     *
     * @param int $id primary key
     * @return array|string response
     */
    public function run($id)
    {
        $model = $this->findModel($id);

        if (Yii::$app->request->isAjax) {
            Yii::$app->response->format = Response::FORMAT_JSON;
        }

        if ($model->load(Yii::$app->request->post())) {

            if ($model->validate()) {

                if ($this->redirect === null) {
                    $this->redirect = isset($model->id) ? ['view', 'id' => $model->id] : ['index'];
                }

                if ($model->save()) {
                    Yii::$app->session->setFlash('success',
                        Yii::t('rootlocal/crud', 'Successfully completed'));


                    return Yii::$app->request->isAjax ? ['success' => true]
                        : $this->controller->redirect($this->redirect);
                }

                Yii::$app->session->setFlash('error',
                    Yii::t('rootlocal/crud', 'Unable to save Model'));

                return Yii::$app->request->isAjax ? ['success' => false]
                    : $this->controller->redirect($this->redirect);
            }
        }

        if (Yii::$app->request->isAjax) {
            return $this->controller->renderAjax($this->getViewName(), ['model' => $model]);
        }

        return $this->controller->render($this->getViewName(), ['model' => $model]);
    }

    /**
     * Finds the Alias model based on its primary key value.
     * If the model is not found, a 404 HTTP exception will be thrown.
     *
     * @param int $id primary key
     * @return ActiveRecord the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findModel($id)
    {
        $model = $this->getModel();
        $objectClass = null;

        if ($model instanceof Closure || is_array($model)) {
            $objectClass = call_user_func($model, $id, $this->getScenario());
        } else {
            /** @var ActiveRecord $model $objectClass */
            $objectClass = $model::findOne($id);

            if ($objectClass !== null) {
                $objectClass->scenario = $this->getScenario();
            }
        }

        if ($this->checkAccess && ($this->checkAccess instanceof Closure || is_array($this->checkAccess))) {
            call_user_func($this->checkAccess, $this->id, $objectClass);
        }

        if ($objectClass === null) {
            throw new NotFoundHttpException(Yii::t('rootlocal/crud',
                'The requested page does not exist.'));
        }

        return $objectClass;
    }

    /**
     * Get model
     *
     * @return string|Closure|array ActiveRecord Model
     * @throws ErrorException if Model not specified (not set)
     */
    public function getModel()
    {
        if (empty($this->_model)) {
            throw new ErrorException(Yii::t('rootlocal/crud', 'Model not specified'));
        }

        return $this->_model;
    }

    /**
     * Set model
     *
     * @param string|Closure|array $model ActiveRecord Model
     */
    public function setModel($model): void
    {
        $this->_model = $model;
    }

    /**
     * Set scenario
     *
     * @param string|null $scenario scenario for model. Defaults to [[ActiveRecord::SCENARIO_DEFAULT]]
     */
    public function setScenario($scenario): void
    {
        $this->_scenario = $scenario;
    }

    /**
     * Get scenario
     *
     * @return string scenario for model. Defaults to [[ActiveRecord::SCENARIO_DEFAULT]]
     */
    public function getScenario()
    {
        if ($this->_scenario === null) {
            $this->_scenario = ActiveRecord::SCENARIO_DEFAULT;
        }

        return $this->_scenario;
    }
}