hipanel\actions\IndexAction

Complexity

Total Complexity

18

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setView()	0	4	1
A	getView()	0	8	2
A	getDefaultRules()	0	22	1
A	getUiModel()	0	4	1
A	ensureRepresentationCollection()	0	4	1
C	getDataProvider()	0	50	12

<?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\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;

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

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

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

        return $this->_view;
    }

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

    protected function getDefaultRules()
    {
        return array_merge([

The return type of return array_merge(array('html | pjax' => array('save' => false, 'flash' => false, 'success' => array('class' => \hipanel\actions\RenderAction::class, 'view' => $this->getView(), 'data' => $this->data, 'params' => function () { return array('model' => $this->getSearchModel(), 'dataProvider' => $this->getDataProvider(), 'representationCollection' => $this->ensureRepresentationCollection(), 'uiModel' => $this->getUiModel()); }))), parent::getDefaultRules()); (array<string,array>) is incompatible with the return type of the parent method hipanel\actions\SearchAction::getDefaultRules of type array<string,array<string,boolean|array<string,callable>>>.

            '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 RepresentationCollectionFinder::forCurrentRoute()->findOrFail();
    }

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

            $formName = $this->getSearchModel()->formName();

It seems like formName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $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]]);

The property sortAttribute does not exist on object<hipanel\models\IndexPageUiOptions>. Since you implemented __get, maybe consider adding a @property annotation.

The property sortDirection does not exist on object<hipanel\models\IndexPageUiOptions>. Since you implemented __get, maybe consider adding a @property annotation.

            }

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

        return $this->dataProvider;
    }
}