Issues in IndexAction.php - All Issues - Inspection of "added NoteBlock and used it in MainColumn (#135)" - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( edb2b9...da334f )

by Dmitry

created 2020-05-28 08:00 UTC

src/actions/IndexAction.php (2 issues)

Labels

Severity

Informational 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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\FilterStorage;
use hipanel\grid\RepresentationCollectionFinder;
use hiqdev\higrid\representations\RepresentationCollection;
use hiqdev\higrid\representations\RepresentationCollectionInterface;
use Yii;
use yii\helpers\ArrayHelper;
use yii\helpers\Inflector;
use yii\web\Controller;

/**
 * Class IndexAction.
 */
class IndexAction extends SearchAction
{
    /**
     * @var string view to render
     */
    protected $_view;
    /**
     * @var RepresentationCollectionFinder
     */
    private $representationCollectionFinder;

    public function setView($value)
    {
        $this->_view = $value;
    }

    public function getView()
    {
        if ($this->_view === null) {
            $this->_view = lcfirst(Inflector::id2camel($this->id));
        }

        return $this->_view;
    }

    public function __construct(string $id, Controller $controller, RepresentationCollectionFinder $representationCollectionFinder, array $config = [])
    {
        parent::__construct($id, $controller, $config);
        $this->representationCollectionFinder = $representationCollectionFinder;
    }

    /**
     * @var array The map of filters for the [[hipanel\base\FilterStorage|FilterStorage]]
     */
    public $filterStorageMap = [];

    protected function getDefaultRules()
    {
        return array_merge([
            'html | pjax' => [
                'save' => false,
                'flash' => false,
                'success' => [
                    'class' => RenderAction::class,
                    'view' => $this->getView(),
                    'data' => $this->data,
                    'params' => function () {
                        return [
                            'model' => $this->getSearchModel(),
                            'dataProvider' => $this->getDataProvider(),
                            'representationCollection' => $this->ensureRepresentationCollection(),
                            'uiModel' => $this->getUiModel(),
                        ];
                    },
                ],
            ],
        ], parent::getDefaultRules());
    }

    public function getUiModel()
    {
        return $this->controller->indexPageUiOptionsModel;
    }

    /**
     * Method tries to guess representation collection class name and create object
     * Creates empty collection when no specific representation exists.
     *
     * @return RepresentationCollection|RepresentationCollectionInterface
     */
    protected function ensureRepresentationCollection()
    {
        return $this->representationCollectionFinder->findOrFallback();
    }

    /**
     * {@inheritdoc}
     */
    public function getDataProvider()
    {
        if ($this->dataProvider === null) {
            $request = Yii::$app->request;

            $formName = $this->getSearchModel()->formName();
            $requestFilters = $request->get($formName) ?: $request->get() ?: $request->post();

            // Don't save filters for ajax requests, because
            // the request is probably triggered with select2 or smt similar
            if ($request->getIsPjax() || !$request->getIsAjax()) {
                $filterStorage = new FilterStorage(['map' => $this->filterStorageMap]);

                if ($request->getIsPost() && $request->post('clear-filters')) {
                    $filterStorage->clearFilters();
                }

                $filterStorage->set($requestFilters);

                // Apply filters from storage only when request does not contain any data
                if (empty($requestFilters)) {
                    $requestFilters = $filterStorage->get();
                }
            }

            $search = ArrayHelper::merge($this->findOptions, $requestFilters);

            $this->returnOptions[$this->controller->modelClassName()] = ArrayHelper::merge(
                ArrayHelper::remove($search, 'return', []),
                ArrayHelper::remove($search, 'rename', [])
            );

            if ($formName !== '') {
                $search = [$formName => $search];
            }
            $this->dataProvider = $this->getSearchModel()->search($search, $this->dataProviderOptions);

            // Set sort
            if ($this->getUiModel()->sort) {
                $this->dataProvider->setSort(['defaultOrder' => [$this->getUiModel()->sortAttribute => $this->getUiModel()->sortDirection]]);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }

            // Set pageSize
            if ($this->getUiModel()->per_page) {
                $this->dataProvider->setPagination(['pageSize' => $this->getUiModel()->per_page]);
            }
        }

        return $this->dataProvider;
    }
}


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-2019, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\actions;
12
13			use hipanel\base\FilterStorage;
14			use hipanel\grid\RepresentationCollectionFinder;
15			use hiqdev\higrid\representations\RepresentationCollection;
16			use hiqdev\higrid\representations\RepresentationCollectionInterface;
17			use Yii;
18			use yii\helpers\ArrayHelper;
19			use yii\helpers\Inflector;
20			use yii\web\Controller;
21
22			/**
23			* Class IndexAction.
24			*/
25			class IndexAction extends SearchAction
26			{
27			/**
28			* @var string view to render
29			*/
30			protected $_view;
31			/**
32			* @var RepresentationCollectionFinder
33			*/
34			private $representationCollectionFinder;
35
36			public function setView($value)
37			{
38			$this->_view = $value;
39			}
40
41			public function getView()
42			{
43			if ($this->_view === null) {
44			$this->_view = lcfirst(Inflector::id2camel($this->id));
45			}
46
47			return $this->_view;
48			}
49
50			public function __construct(string $id, Controller $controller, RepresentationCollectionFinder $representationCollectionFinder, array $config = [])
51			{
52			parent::__construct($id, $controller, $config);
53			$this->representationCollectionFinder = $representationCollectionFinder;
54			}
55
56			/**
57			* @var array The map of filters for the [[hipanel\base\FilterStorage\|FilterStorage]]
58			*/
59			public $filterStorageMap = [];
60
61			protected function getDefaultRules()
62			{
63			return array_merge([
64			'html \| pjax' => [
65			'save' => false,
66			'flash' => false,
67			'success' => [
68			'class' => RenderAction::class,
69			'view' => $this->getView(),
70			'data' => $this->data,
71			'params' => function () {
72			return [
73			'model' => $this->getSearchModel(),
74			'dataProvider' => $this->getDataProvider(),
75			'representationCollection' => $this->ensureRepresentationCollection(),
76			'uiModel' => $this->getUiModel(),
77			];
78			},
79			],
80			],
81			], parent::getDefaultRules());
82			}
83
84			public function getUiModel()
85			{
86			return $this->controller->indexPageUiOptionsModel;
87			}
88
89			/**
90			* Method tries to guess representation collection class name and create object
91			* Creates empty collection when no specific representation exists.
92			*
93			* @return RepresentationCollection\|RepresentationCollectionInterface
94			*/
95			protected function ensureRepresentationCollection()
96			{
97			return $this->representationCollectionFinder->findOrFallback();
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function getDataProvider()
104			{
105			if ($this->dataProvider === null) {
106			$request = Yii::$app->request;
107
108			$formName = $this->getSearchModel()->formName();
109			$requestFilters = $request->get($formName) ?: $request->get() ?: $request->post();
110
111			// Don't save filters for ajax requests, because
112			// the request is probably triggered with select2 or smt similar
113			if ($request->getIsPjax() \|\| !$request->getIsAjax()) {
114			$filterStorage = new FilterStorage(['map' => $this->filterStorageMap]);
115
116			if ($request->getIsPost() && $request->post('clear-filters')) {
117			$filterStorage->clearFilters();
118			}
119
120			$filterStorage->set($requestFilters);
121
122			// Apply filters from storage only when request does not contain any data
123			if (empty($requestFilters)) {
124			$requestFilters = $filterStorage->get();
125			}
126			}
127
128			$search = ArrayHelper::merge($this->findOptions, $requestFilters);
129
130			$this->returnOptions[$this->controller->modelClassName()] = ArrayHelper::merge(
131			ArrayHelper::remove($search, 'return', []),
132			ArrayHelper::remove($search, 'rename', [])
133			);
134
135			if ($formName !== '') {
136			$search = [$formName => $search];
137			}
138			$this->dataProvider = $this->getSearchModel()->search($search, $this->dataProviderOptions);
139
140			// Set sort
141			if ($this->getUiModel()->sort) {
142			$this->dataProvider->setSort(['defaultOrder' => [$this->getUiModel()->sortAttribute => $this->getUiModel()->sortDirection]]);
			0 ignored issues – show Documentation introduced 2017-05-15 10:51 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `sortAttribute` does not exist on `object<hipanel\models\IndexPageUiOptions>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-05-15 10:51 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `sortDirection` does not exist on `object<hipanel\models\IndexPageUiOptions>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
143			}
144
145			// Set pageSize
146			if ($this->getUiModel()->per_page) {
147			$this->dataProvider->setPagination(['pageSize' => $this->getUiModel()->per_page]);
148			}
149			}
150
151			return $this->dataProvider;
152			}
153			}
154

hiqdev / hipanel-core

Push — master ( edb2b9...da334f )

src/actions/IndexAction.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like