Index::run() - Code Metrics - Inspection of "Php8" - ROAResearch/yii2-roa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Angel

created 2021-06-04 07:37 UTC

Index::run() A

↳ Parent: Index

Complexity

Conditions	2
Paths	1

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	1
nop	0
dl	0
loc	14
ccs	9
cts	9
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace roaresearch\yii2\roa\actions;

use roaresearch\yii2\roa\hal\ARContractSearch;
use Yii;
use yii\{base\InvalidConfigException, data\DataProviderInterface, di\Instance};

/**
 * Action to retreive a filtered and sorted collection based on a `$searchClass`
 *
 * @author Angel (Faryshta) Guevara <[email protected]>
 */
class Index extends Action
{
    /**
     * @var string model class to retreive the records on the collection.
     */
    public string $searchClass;

    /**
     * @var string name of the form containing the filter data.
     */
    public string $formName = '';

    /**
     * @inheritdoc
     */
    public function init()
    {
        $this->searchClass ?: throw new InvalidConfigException(
            $this::class . '::$searchClass must be set.'
        );
    }

    /**
     * @return DataProviderInterface | ARContractSearch
     */
    public function run(): DataProviderInterface | ARContractSearch
    {
        /** @var ARContractSearch $searchModel */
        $searchModel = Instance::ensure(
            ['class' => $this->searchClass],
            ARContractSearch::class
        );
        $dataProvider = $searchModel->search(
            Yii::$app->request->getQueryParams(),
            $this->formName
        );
        $this->checkAccess($searchModel, Yii::$app->request->getQueryParams());

        return $dataProvider ?: $searchModel;
    }
}


1		<?php
2
3		namespace roaresearch\yii2\roa\actions;
4
5		use roaresearch\yii2\roa\hal\ARContractSearch;
6		use Yii;
7		use yii\{base\InvalidConfigException, data\DataProviderInterface, di\Instance};
8
9		/**
10		* Action to retreive a filtered and sorted collection based on a `$searchClass`
11		*
12		* @author Angel (Faryshta) Guevara <[email protected]>
13		*/
14		class Index extends Action
15		{
16		/**
17		* @var string model class to retreive the records on the collection.
18		*/
19		public string $searchClass;
20
21		/**
22		* @var string name of the form containing the filter data.
23		*/
24		public string $formName = '';
25
26		/**
27		* @inheritdoc
28		*/
29	5	public function init()
30		{
31	5	$this->searchClass ?: throw new InvalidConfigException(
32		$this::class . '::$searchClass must be set.'
33		);
34	5	}
35
36		/**
37		* @return DataProviderInterface \| ARContractSearch
38		*/
39	5	public function run(): DataProviderInterface \| ARContractSearch
40		{
41		/** @var ARContractSearch $searchModel */
42	5	$searchModel = Instance::ensure(
43	5	['class' => $this->searchClass],
44	5	ARContractSearch::class
45		);
46	5	$dataProvider = $searchModel->search(
47	5	Yii::$app->request->getQueryParams(),
48	5	$this->formName
49		);
50	4	$this->checkAccess($searchModel, Yii::$app->request->getQueryParams());
51
52	4	return $dataProvider ?: $searchModel;
53		}
54		}
55

ROAResearch / yii2-roa

Pull Request — master (#6)

Index::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like