AssignmentController::beforeAction() - Code Metrics - Inspection of "Removed strongly typed parameters from CRUD action..." - yii2mod/yii2-rbac - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

unknown

created 2020-01-24 14:23 UTC

AssignmentController::beforeAction() A

↳ Parent: AssignmentController

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
dl	12
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	1

<?php

namespace yii2mod\rbac\controllers;

use Yii;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\web\Response;
use yii2mod\rbac\models\AssignmentModel;
use yii2mod\rbac\models\search\AssignmentSearch;

/**
 * Class AssignmentController
 *
 * @package yii2mod\rbac\controllers
 */
class AssignmentController extends Controller
{
	/**
	 * @var \yii\web\IdentityInterface the class name of the [[identity]] object
	 */
	public $userIdentityClass;

	/**
	 * @var string search class name for assignments search
	 */
	public $searchClass = [
		'class' => AssignmentSearch::class,
	];

	/**
	 * @var string id column name
	 */
	public $idField = 'id';

	/**
	 * @var string username column name
	 */
	public $usernameField = 'username';

	/**
	 * @var array assignments GridView columns
	 */
	public $gridViewColumns = [];

	/**
	 * @inheritdoc
	 */
	public function init()
	{
		parent::init();

		if ($this->userIdentityClass === null) {
			$this->userIdentityClass = Yii::$app->user->identityClass;
		}

		if (empty($this->gridViewColumns)) {
			$this->gridViewColumns = [
				$this->idField,
				$this->usernameField,
			];
		}
	}

	/**
	 * @inheritdoc
	 */
	public function behaviors(): array
	{
		return [
			'verbs' => [
				'class' => 'yii\filters\VerbFilter',
				'actions' => [
					'index' => ['get'],
					'view' => ['get'],
					'assign' => ['post'],
					'remove' => ['post'],
				],
			],
			'contentNegotiator' => [
				'class' => 'yii\filters\ContentNegotiator',
				'only' => ['assign', 'remove'],
				'formats' => [
					'application/json' => Response::FORMAT_JSON,
				],
			],
		];
	}

	/**
	 * List of all assignments
	 *
	 * @return string
	 */
	public function actionIndex()
	{
		/* @var AssignmentSearch */
		$searchModel = Yii::createObject($this->searchClass);

		if ($searchModel instanceof AssignmentSearch) {
			$dataProvider = $searchModel->search(Yii::$app->request->queryParams, $this->userIdentityClass, $this->idField, $this->usernameField);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} else {
			$dataProvider = $searchModel->search(Yii::$app->request->queryParams);
		}

		return $this->render('index', [
			'dataProvider' => $dataProvider,
			'searchModel' => $searchModel,
			'gridViewColumns' => $this->gridViewColumns,
		]);
	}

	/**
	 * Displays a single Assignment model.
	 *
	 * @param $id
	 *
	 * @return mixed
	 */
	public function actionView($id)
	{
		$model = $this->findModel($id);

		return $this->render('view', [
			'model' => $model,
			'usernameField' => $this->usernameField,
		]);
	}

	/**
	 * Assign items
	 *
	 * @param $id
	 *
	 * @return array
	 */
	public function actionAssign($id)

	{
		$items = Yii::$app->getRequest()->post('items', []);
		$assignmentModel = $this->findModel($id);
		$assignmentModel->assign($items);

		return $assignmentModel->getItems();
	}

	/**
	 * Remove items
	 *
	 * @param $id
	 *
	 * @return array
	 */
	public function actionRemove($id)

	{
		$items = Yii::$app->getRequest()->post('items', []);
		$assignmentModel = $this->findModel($id);
		$assignmentModel->revoke($items);

		return $assignmentModel->getItems();
	}

	/**
	 * Finds the Assignment model based on its primary key value.
	 * If the model is not found, a 404 HTTP exception will be thrown.
	 *
	 * @param $id
	 *
	 * @return AssignmentModel the loaded model
	 *
	 * @throws NotFoundHttpException if the model cannot be found
	 */
	protected function findModel($id)
	{
		$class = $this->userIdentityClass;

		if (($user = $class::findIdentity($id)) !== null) {
			return new AssignmentModel($user);
		}

		throw new NotFoundHttpException(Yii::t('yii2mod.rbac', 'The requested page does not exist.'));
	}

	public function beforeAction($action)

	{
		if (!parent::beforeAction($action)) {
			return false;
		}

		if (!\app\controllers\UsersController::test('admin')) {
			throw new \yii\web\ForbiddenHttpException('You are not allowed to access this page.');
		}

		return true;
	}
}


1		<?php
2
3		namespace yii2mod\rbac\controllers;
4
5		use Yii;
6		use yii\web\Controller;
7		use yii\web\NotFoundHttpException;
8		use yii\web\Response;
9		use yii2mod\rbac\models\AssignmentModel;
10		use yii2mod\rbac\models\search\AssignmentSearch;
11
12		/**
13		* Class AssignmentController
14		*
15		* @package yii2mod\rbac\controllers
16		*/
17		class AssignmentController extends Controller
18		{
19		/**
20		* @var \yii\web\IdentityInterface the class name of the [[identity]] object
21		*/
22		public $userIdentityClass;
23
24		/**
25		* @var string search class name for assignments search
26		*/
27		public $searchClass = [
28		'class' => AssignmentSearch::class,
29		];
30
31		/**
32		* @var string id column name
33		*/
34		public $idField = 'id';
35
36		/**
37		* @var string username column name
38		*/
39		public $usernameField = 'username';
40
41		/**
42		* @var array assignments GridView columns
43		*/
44		public $gridViewColumns = [];
45
46		/**
47		* @inheritdoc
48		*/
49		public function init()
50		{
51		parent::init();
52
53		if ($this->userIdentityClass === null) {
54		$this->userIdentityClass = Yii::$app->user->identityClass;
55		}
56
57		if (empty($this->gridViewColumns)) {
58		$this->gridViewColumns = [
59		$this->idField,
60		$this->usernameField,
61		];
62		}
63		}
64
65		/**
66		* @inheritdoc
67		*/
68		public function behaviors(): array
69		{
70		return [
71		'verbs' => [
72		'class' => 'yii\filters\VerbFilter',
73		'actions' => [
74		'index' => ['get'],
75		'view' => ['get'],
76		'assign' => ['post'],
77		'remove' => ['post'],
78		],
79		],
80		'contentNegotiator' => [
81		'class' => 'yii\filters\ContentNegotiator',
82		'only' => ['assign', 'remove'],
83		'formats' => [
84		'application/json' => Response::FORMAT_JSON,
85		],
86		],
87		];
88		}
89
90		/**
91		* List of all assignments
92		*
93		* @return string
94		*/
95		public function actionIndex()
96		{
97		/* @var AssignmentSearch */
98		$searchModel = Yii::createObject($this->searchClass);
99
100		if ($searchModel instanceof AssignmentSearch) {
101		$dataProvider = $searchModel->search(Yii::$app->request->queryParams, $this->userIdentityClass, $this->idField, $this->usernameField);
		0 ignored issues – show Documentation introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report `$this->userIdentityClass` is of type `object<yii\web\IdentityInterface>`, but the function expects a `object<yii\db\ActiveRecord>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
102		} else {
103		$dataProvider = $searchModel->search(Yii::$app->request->queryParams);
104		}
105
106		return $this->render('index', [
107		'dataProvider' => $dataProvider,
108		'searchModel' => $searchModel,
109		'gridViewColumns' => $this->gridViewColumns,
110		]);
111		}
112
113		/**
114		* Displays a single Assignment model.
115		*
116		* @param $id
117		*
118		* @return mixed
119		*/
120		public function actionView($id)
121		{
122		$model = $this->findModel($id);
123
124		return $this->render('view', [
125		'model' => $model,
126		'usernameField' => $this->usernameField,
127		]);
128		}
129
130		/**
131		* Assign items
132		*
133		* @param $id
134		*
135		* @return array
136		*/
137	View Code Duplication	public function actionAssign($id)
		0 ignored issues – show Duplication introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
138		{
139		$items = Yii::$app->getRequest()->post('items', []);
140		$assignmentModel = $this->findModel($id);
141		$assignmentModel->assign($items);
142
143		return $assignmentModel->getItems();
144		}
145
146		/**
147		* Remove items
148		*
149		* @param $id
150		*
151		* @return array
152		*/
153	View Code Duplication	public function actionRemove($id)
		0 ignored issues – show Duplication introduced 2017-08-14 07:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
154		{
155		$items = Yii::$app->getRequest()->post('items', []);
156		$assignmentModel = $this->findModel($id);
157		$assignmentModel->revoke($items);
158
159		return $assignmentModel->getItems();
160		}
161
162		/**
163		* Finds the Assignment model based on its primary key value.
164		* If the model is not found, a 404 HTTP exception will be thrown.
165		*
166		* @param $id
167		*
168		* @return AssignmentModel the loaded model
169		*
170		* @throws NotFoundHttpException if the model cannot be found
171		*/
172		protected function findModel($id)
173		{
174		$class = $this->userIdentityClass;
175
176		if (($user = $class::findIdentity($id)) !== null) {
177		return new AssignmentModel($user);
178		}
179
180		throw new NotFoundHttpException(Yii::t('yii2mod.rbac', 'The requested page does not exist.'));
181		}
182
183	View Code Duplication	public function beforeAction($action)
		0 ignored issues – show Duplication introduced 2020-01-24 14:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
184		{
185		if (!parent::beforeAction($action)) {
186		return false;
187		}
188
189		if (!\app\controllers\UsersController::test('admin')) {
190		throw new \yii\web\ForbiddenHttpException('You are not allowed to access this page.');
191		}
192
193		return true;
194		}
195		}
196

yii2mod / yii2-rbac

Pull Request — master (#38)

AssignmentController::beforeAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like