SmartUpdateAction::getDataProvider() - Code Metrics - Inspection of "Added DynamicFormInputsValueInheritor" - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 462bae...29fcb5 )

by Dmitry

created 2018-01-24 15:04 UTC

SmartUpdateAction::getDataProvider() C

↳ Parent: SmartUpdateAction

Complexity

Conditions	7
Paths	10

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	22
ccs	0
cts	14
cp	0
rs	6.9811
cc	7
eloc	13
nc	10
nop	0
crap	56

<?php
/**
 * HiPanel core package.
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2017, 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 mixed 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
     * @return ActiveDataProvider
     * @throws \yii\base\InvalidConfigException when failed to generate `WHERE` condition
     */
    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]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $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);
        }

        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();

        }
        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) {

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

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

                        $models = $this->fetchModels();
                        foreach ($models as $model) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                            $model->scenario = $this->scenario;

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

                        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) {

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

                            foreach ($models as $model) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                                $model->scenario = $this->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) {

                        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;

    }

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

    /**
     * Fetches models that will be edited.
     *
     * @throws BadRequestHttpException
     * @return array
     */
    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);
    }
}


1		<?php
2		/**
3		* HiPanel core package.
4		*
5		* @link https://hipanel.com/
6		* @package hipanel-core
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2014-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hipanel\actions;
12
13		use hipanel\base\Model;
14		use hipanel\base\SearchModelTrait;
15		use hiqdev\hiart\ActiveDataProvider;
16		use Yii;
17		use yii\web\BadRequestHttpException;
18		use yii\web\NotFoundHttpException;
19
20		/**
21		* Class SmartUpdateAction.
22		* @property string view
23		*/
24		class SmartUpdateAction extends SwitchAction
25		{
26		const EVENT_BEFORE_FETCH_LOAD = 'beforeFetchLoad';
27		const EVENT_BEFORE_FETCH = 'beforeFetch';
28
29		/**
30		* @var array\|\Closure additional data passed to view
31		*/
32		public $data = [];
33
34		/**
35		* @var string The view that represents current update action
36		*/
37		public $_view;
38
39		/**
40		* @var mixed ID of object to be viewed. Defaults to `$_GET['id']`
41		*/
42		protected $_id;
43
44		/**
45		* @var array additional data passed to model find method
46		*/
47		public $findOptions = [];
48
49		/**
50		* @var Model
51		*/
52		private $_searchModel;
53
54		/**
55		* @var \yii\data\ActiveDataProvider stores ActiveDataProvider after creating by [[getDataProvider]]
56		* @see getDataProvider()
57		*/
58		public $dataProvider;
59
60		/**
61		* Creates `ActiveDataProvider` with given options list, stores it to [[dataProvider]].
62		*
63		* @throws BadRequestHttpException
64		* @return ActiveDataProvider
65		* @throws \yii\base\InvalidConfigException when failed to generate `WHERE` condition
66		*/
67		public function getDataProvider()
68		{
69		if ($this->dataProvider === null) {
70		$this->_id = $this->_id
71		?: Yii::$app->request->post('selection')
72		?: Yii::$app->request->get('selection')
73		?: Yii::$app->request->get('id');
74
75		$this->dataProvider = $this->getSearchModel()->search([], ['pagination' => false]);
		0 ignored issues – show Bug introduced 2016-07-22 10:47 UTC by Report Bug Copy Issue Report The method `search` does only exist in `hipanel\base\SearchModelTrait`, but not in `hiqdev\hiart\ActiveRecord`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
76		$this->dataProvider->query->andFilterWhere(
77		is_array($this->_id) ? ['in', 'id', $this->_id] : ['eq', 'id', $this->_id]
78		);
79
80		if (empty($this->dataProvider->query->where)) {
81		throw new BadRequestHttpException('Where condition is empty!');
82		}
83
84		$this->dataProvider->query->andFilterWhere($this->findOptions);
85		}
86
87		return $this->dataProvider;
88		}
89
90		/**
91		* @param $model
92		*/
93		public function setSearchModel($model)
94		{
95		$this->_searchModel = $model;
96		}
97
98		/**
99		* @return Model\|SearchModelTrait
100		*/
101		public function getSearchModel()
102		{
103		if (is_null($this->_searchModel)) {
104		$this->_searchModel = $this->controller->searchModel();
		0 ignored issues – show Documentation Bug introduced 2016-07-22 10:47 UTC by Report Bug Copy Issue Report 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`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
105		}
106		return $this->_searchModel;
107		}
108
109		/** {@inheritdoc} */
110		protected function getDefaultRules()
111		{
112		return array_merge(parent::getDefaultRules(), [
113		'POST xeditable' => [
114		'class' => XEditableAction::class,
115		],
116		'GET html \| POST selection' => [
117		'class' => RenderAction::class,
118		'data' => $this->data,
119		'view' => $this->view,
120	View Code Duplication	'params' => function ($action) {
		0 ignored issues – show Unused Code introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The parameter `$action` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
121		$models = $this->fetchModels();
122		if (empty($models)) {
123		throw new NotFoundHttpException('Search result is empty.');
124		}
125		foreach ($models as $model) {
126		$model->scenario = $this->scenario;
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `scenario` does not seem to exist. Did you mean `_scenario`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
127		}
128		return [
129		'models' => $models,
130		'model' => reset($models),
131		];
132		},
133		],
134		'GET ajax' => [
135		'success' => [
136		'class' => RenderAjaxAction::class,
137		'data' => $this->data,
138		'view' => $this->view,
139	View Code Duplication	'params' => function ($action) {
		0 ignored issues – show Unused Code introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The parameter `$action` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
140		$models = $this->fetchModels();
141		foreach ($models as $model) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The expression `$models` of type `array\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
142		$model->scenario = $this->scenario;
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `scenario` does not seem to exist. Did you mean `_scenario`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
143		}
144		return [
145		'models' => $models,
146		'model' => reset($models),
147		];
148		},
149		],
150		],
151		'POST html' => [
152		'save' => true,
153		'success' => [
154		'class' => RedirectAction::class,
155	View Code Duplication	'url' => function ($action) {
		0 ignored issues – show Duplication introduced 2016-07-19 15:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
156		return $action->collection->count() > 1
157		? $action->controller->getSearchUrl()
158		: $action->controller->getActionUrl('view', ['id' => $action->collection->first->id]);
159		},
160		],
161		'error' => [
162		'class' => RenderAction::class,
163		'view' => $this->view,
164		'data' => $this->data,
165		'params' => function ($action) {
		0 ignored issues – show Unused Code introduced 2017-12-15 12:46 UTC by Report Bug Copy Issue Report The parameter `$action` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
166		try {
167		$models = $this->fetchModels();
168
169		foreach ($models as $model) {
		0 ignored issues – show Bug introduced 2017-12-13 15:53 UTC by Report Bug Copy Issue Report The expression `$models` of type `array\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
170		$model->scenario = $this->scenario;
		0 ignored issues – show Bug introduced 2017-12-13 15:53 UTC by Report Bug Copy Issue Report The property `scenario` does not seem to exist. Did you mean `_scenario`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
171		foreach ($this->collection->models as $payload) {
172		if ($payload->id === $model->id) {
173		$model->setAttributes(array_filter($payload->getAttributes()));
174		}
175		}
176		}
177		} catch (BadRequestHttpException $e) {
178		$models = $this->collection->models;
179		}
180
181		return [
182		'model' => reset($models),
183		'models' => $models,
184		];
185		},
186		],
187		],
188		'POST pjax' => [
189		'save' => true,
190		'success' => [
191		'class' => ProxyAction::class,
192		'action' => 'view',
193		'params' => function ($action, $model) {
194		return ['id' => $model->id];
195		},
196		],
197		],
198		'POST ajax' => [
199		'save' => true,
200		'success' => [
201		'class' => RedirectAction::class,
202	View Code Duplication	'url' => function ($action) {
		0 ignored issues – show Duplication introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
203		return $action->collection->count() > 1
204		? $action->controller->getSearchUrl()
205		: $action->controller->getActionUrl('view', ['id' => $action->collection->first->id]);
206		},
207		],
208		],
209		]);
210		}
211
212		/**
213		* @return string
214		*/
215		public function getView()
216		{
217		return $this->_view ?: $this->scenario;
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `scenario` does not seem to exist. Did you mean `_scenario`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
218		}
219
220		/**
221		* @param string $view
222		*/
223		public function setView($view)
224		{
225		$this->_view = $view;
226		}
227
228		/**
229		* Fetches models that will be edited.
230		*
231		* @throws BadRequestHttpException
232		* @return array
233		*/
234		public function fetchModels()
235		{
236		$this->beforeFetchLoad();
237		$dataProvider = $this->getDataProvider();
238		$this->beforeFetch();
239		return $dataProvider->getModels();
240		}
241
242		public function beforeFetchLoad()
243		{
244		$this->trigger(static::EVENT_BEFORE_FETCH_LOAD);
245		}
246
247		public function beforeFetch()
248		{
249		$this->trigger(static::EVENT_BEFORE_FETCH);
250		}
251		}
252

hiqdev / hipanel-core

Push — master ( 462bae...29fcb5 )

SmartUpdateAction::getDataProvider() C

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like