hipanel\actions\SmartUpdateAction

Complexity

Total Complexity

26

Size/Duplication

Total Lines	234
Duplicated Lines	14.1 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setSearchModel()	0	4	1
B	getDataProvider()	0	24	7
A	getSearchModel()	0	8	2
C	getDefaultRules()	33	103	10
A	getView()	0	4	2
A	setView()	0	4	1
A	fetchModels()	0	8	1
A	beforeFetchLoad()	0	4	1
A	beforeFetch()	0	4	1

<?php
/**
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\actions;

use hipanel\base\Model;
use hipanel\base\SearchModelTrait;
use hiqdev\hiart\ActiveDataProvider;
use Yii;
use yii\web\BadRequestHttpException;
use yii\web\NotFoundHttpException;

/**
 * Class SmartUpdateAction.
 * @property string view
 */
class SmartUpdateAction extends SwitchAction
{
    const EVENT_BEFORE_FETCH_LOAD = 'beforeFetchLoad';
    const EVENT_BEFORE_FETCH = 'beforeFetch';

    /**
     * @var array|\Closure additional data passed to view
     */
    public $data = [];

    /**
     * @var string The view that represents current update action
     */
    public $_view;

    /**
     * @var int|string ID of object to be viewed. Defaults to `$_GET['id']`
     */
    protected $_id;

    /**
     * @var array additional data passed to model find method
     */
    public $findOptions = [];

    /**
     * @var Model
     */
    private $_searchModel;

    /**
     * @var \yii\data\ActiveDataProvider stores ActiveDataProvider after creating by [[getDataProvider]]
     * @see getDataProvider()
     */
    public $dataProvider;

    /**
     * Creates `ActiveDataProvider` with given options list, stores it to [[dataProvider]].
     *
     * @throws BadRequestHttpException
     * @throws \yii\base\InvalidConfigException when failed to generate `WHERE` condition
     * @return ActiveDataProvider
     */
    public function getDataProvider()
    {
        if ($this->dataProvider === null) {
            $this->_id = $this->_id
                ?: Yii::$app->request->post('selection')
                ?: Yii::$app->request->get('selection')
                ?: Yii::$app->request->get('id');

            $this->dataProvider = $this->getSearchModel()->search([], ['pagination' => false]);

The method search does only exist in hipanel\base\SearchModelTrait, but not in hiqdev\hiart\ActiveRecord.

            $this->dataProvider->query->andFilterWhere(
                is_array($this->_id) ? ['in', 'id', $this->_id] : ['eq', 'id', $this->_id]
            );

            if (empty($this->dataProvider->query->where)) {
                throw new BadRequestHttpException('Where condition is empty!');
            }

            $this->dataProvider->query->andFilterWhere($this->findOptions);
        }
        $limit = $this->dataProvider->query->limit;
        $this->dataProvider->query->andFilterWhere($this->findOptions)->limit($limit ?? -1);

        return $this->dataProvider;
    }

    /**
     * @param $model
     */
    public function setSearchModel($model)
    {
        $this->_searchModel = $model;
    }

    /**
     * @return Model|SearchModelTrait
     */
    public function getSearchModel()
    {
        if (is_null($this->_searchModel)) {
            $this->_searchModel = $this->controller->searchModel();

It seems like $this->controller->searchModel() of type object<hiqdev\hiart\ActiveRecord> or object<hipanel\base\SearchModelTrait> is incompatible with the declared type object<hipanel\base\Model> of property $_searchModel.

        }

        return $this->_searchModel;
    }

    /** {@inheritdoc} */
    protected function getDefaultRules()
    {
        return array_merge(parent::getDefaultRules(), [
            'POST xeditable' => [
                'class' => XEditableAction::class,
            ],
            'GET html | POST selection' => [
                'class'  => RenderAction::class,
                'data'   => $this->data,
                'view'   => $this->view,
                'params' => function ($action) {

The parameter $action is not used and could be removed.

This code seems to be duplicated across your project.

                    $models = $this->fetchModels();
                    if (empty($models)) {
                        throw new NotFoundHttpException('Search result is empty.');
                    }
                    foreach ($models as $model) {
                        $model->scenario = $this->scenario;

The property scenario does not seem to exist. Did you mean _scenario?

                    }

                    return [
                        'models' => $models,
                        'model' => reset($models),
                    ];
                },
            ],
            'GET ajax' => [
                'success' => [
                    'class' => RenderAjaxAction::class,
                    'data'   => $this->data,
                    'view'   => $this->view,
                    'params' => function ($action) {

The parameter $action is not used and could be removed.

This code seems to be duplicated across your project.

                        $models = $this->fetchModels();
                        foreach ($models as $model) {

The expression $models of type array|null is not guaranteed to be traversable. How about adding an additional type check?

                            $model->scenario = $this->scenario;

The property scenario does not seem to exist. Did you mean _scenario?

                        }

                        return [
                            'models' => $models,
                            'model' => reset($models),
                        ];
                    },
                ],
            ],
            'POST html' => [
                'save'    => true,
                'success' => [
                    'class' => RedirectAction::class,
                    'url'   => function ($action) {

This code seems to be duplicated across your project.

                        return $action->collection->count() > 1
                            ? $action->controller->getSearchUrl()
                            : $action->controller->getActionUrl('view', ['id' => $action->collection->first->id]);
                    },
                ],
                'error'   => [
                    'class'  => RenderAction::class,
                    'view'   => $this->view,
                    'data'   => $this->data,
                    'params' => function ($action) {

The parameter $action is not used and could be removed.

                        try {
                            $models = $this->fetchModels();

                            foreach ($models as $model) {

The expression $models of type array|null is not guaranteed to be traversable. How about adding an additional type check?

                                $model->scenario = $this->scenario;

The property scenario does not seem to exist. Did you mean _scenario?

                                foreach ($this->collection->models as $payload) {
                                    if ($payload->id === $model->id) {
                                        $model->setAttributes(array_filter($payload->getAttributes()));
                                    }
                                }
                            }
                        } catch (BadRequestHttpException $e) {
                            $models = $this->collection->models;
                        }

                        return [
                            'model' => reset($models),
                            'models' => $models,
                        ];
                    },
                ],
            ],
            'POST pjax' => [
                'save'    => true,
                'success' => [
                    'class'  => ProxyAction::class,
                    'action' => 'view',
                    'params' => function ($action, $model) {
                        return ['id' => $model->id];
                    },
                ],
            ],
            'POST ajax' => [
                'save'    => true,
                'success' => [
                    'class' => RedirectAction::class,
                    'url'   => function ($action) {

This code seems to be duplicated across your project.

                        return $action->collection->count() > 1
                            ? $action->controller->getSearchUrl()
                            : $action->controller->getActionUrl('view', ['id' => $action->collection->first->id]);
                    },
                ],
            ],
        ]);
    }

    /**
     * @return string
     */
    public function getView()
    {
        return $this->_view ?: $this->scenario;

The property scenario does not seem to exist. Did you mean _scenario?

    }

    /**
     * @param string $view
     */
    public function setView($view)
    {
        $this->_view = $view;
    }

    /**
     * Fetches models that will be edited.
     *
     * @throws BadRequestHttpException
     * @return Model[]
     */
    public function fetchModels()
    {
        $this->beforeFetchLoad();
        $dataProvider = $this->getDataProvider();
        $this->beforeFetch();

        return $dataProvider->getModels();
    }

    public function beforeFetchLoad()
    {
        $this->trigger(static::EVENT_BEFORE_FETCH_LOAD);
    }

    public function beforeFetch()
    {
        $this->trigger(static::EVENT_BEFORE_FETCH);
    }
}