Issues in Group.php - All Issues - Inspection of "Transition to PHP8 testing part15" - redaxscript/redaxscript - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4eb4a8...a52438 )

by Henry

created 2021-03-26 22:17 UTC

includes/Admin/Controller/Group.php (11 issues)

Labels

Severity

Minor 11

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
namespace Redaxscript\Admin\Controller;

use Redaxscript\Admin;
use Redaxscript\Filter;
use Redaxscript\Validator;
use function json_encode;

/**
 * children class to process the admin group request
 *
 * @since 4.0.0
 *
 * @package Redaxscript
 * @category Controller
 * @author Henry Ruhs
 */

class Group extends ControllerAbstract
{
	/**
	 * process the class
	 *
	 * @since 4.0.0
	 *
	 * @param string $action action to process
	 *
	 * @return string
	 */

	public function process(string $action = null) : string
	{
		$postArray = $this->_normalizePost($this->_sanitizePost());
		$validateArray = $this->_validatePost($postArray);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

		/* validate post */

		if ($validateArray)

		{
			return $this->_error(
			[
				'route' => $this->_getErrorRoute($postArray),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				'message' => $validateArray
			]);
		}

		/* handle create */

		if ($action === 'create')
		{
			$createArray =
			[
				'name' => $postArray['name'],
				'alias' => $postArray['alias'],
				'description' => $postArray['description'],
				'categories' => $postArray['categories'],
				'articles' => $postArray['articles'],
				'extras' => $postArray['extras'],
				'comments' => $postArray['comments'],
				'groups' => $postArray['groups'],
				'users' => $postArray['users'],
				'modules' => $postArray['modules'],
				'settings' => $postArray['settings'],
				'filter' => $postArray['filter'],
				'status' => $postArray['status']
			];
			if ($this->_create($createArray))
			{
				return $this->_success(
				[
					'route' => $this->_getSuccessRoute($postArray),
					'timeout' => 2
				]);
			}
		}

		/* handle update */

		if ($action === 'update')
		{
			$updateFullArray =
			[
				'name' => $postArray['name'],
				'alias' => $postArray['alias'],
				'description' => $postArray['description'],
				'categories' => $postArray['categories'],
				'articles' => $postArray['articles'],
				'extras' => $postArray['extras'],
				'comments' => $postArray['comments'],
				'groups' => $postArray['groups'],
				'users' => $postArray['users'],
				'modules' => $postArray['modules'],
				'settings' => $postArray['settings'],
				'filter' => $postArray['filter'],
				'status' => $postArray['status']
			];
			$updateLiteArray =
			[
				'name' => $postArray['name'],
				'alias' => $postArray['alias'],
				'description' => $postArray['description']
			];
			if ($this->_update($postArray['id'], $postArray['id'] > 1 ? $updateFullArray : $updateLiteArray))
			{
				return $this->_success(
				[
					'route' => $this->_getSuccessRoute($postArray),
					'timeout' => 2
				]);
			}
		}

		/* handle error */

		return $this->_error(
		[
			'route' => $this->_getErrorRoute($postArray)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		]);
	}

	/**
	 * sanitize the post
	 *
	 * @since 4.0.0
	 *
	 * @return array
	 */

	protected function _sanitizePost() : array
	{
		$aliasFilter = new Filter\Alias();
		$numberFilter = new Filter\Number();
		$textFilter = new Filter\Text();
		$toggleFilter = new Filter\Toggle();

		/* sanitize post */

		return
		[
			'id' => $numberFilter->sanitize($this->_request->getPost('id')),

			'name' => $textFilter->sanitize($this->_request->getPost('name')),

			'alias' => $aliasFilter->sanitize($this->_request->getPost('alias')),

			'description' => $textFilter->sanitize($this->_request->getPost('description')),

			'categories' => json_encode($this->_request->getPost('categories')),
			'articles' => json_encode($this->_request->getPost('articles')),
			'extras' => json_encode($this->_request->getPost('extras')),
			'comments' => json_encode($this->_request->getPost('comments')),
			'groups' => json_encode($this->_request->getPost('groups')),
			'users' => json_encode($this->_request->getPost('users')),
			'modules' => json_encode($this->_request->getPost('modules')),
			'settings' => $numberFilter->sanitize($this->_request->getPost('settings')),

			'filter' => $toggleFilter->sanitize($this->_request->getPost('filter')),

			'status' => $toggleFilter->sanitize($this->_request->getPost('status'))

		];
	}

	/**
	 * validate the post
	 *
	 * @since 4.0.0
	 *
	 * @param array $postArray array of the post
	 *
	 * @return array
	 */

	protected function _validatePost(array $postArray = []) : array
	{
		$nameValidator = new Validator\Name();
		$aliasValidator = new Validator\Alias();
		$groupModel = new Admin\Model\Group();
		$validateArray = [];

		/* validate post */

		if (!$postArray['name'])
		{
			$validateArray[] = $this->_language->get('name_empty');
		}
		else if (!$nameValidator->validate($postArray['name']))
		{
			$validateArray[] = $this->_language->get('name_incorrect');
		}
		if (!$postArray['alias'])
		{
			$validateArray[] = $this->_language->get('alias_empty');
		}
		else if (!$aliasValidator->validate($postArray['alias']))
		{
			$validateArray[] = $this->_language->get('alias_incorrect');
		}
		else if (!$groupModel->isUniqueByIdAndAlias($postArray['id'], $postArray['alias']))
		{
			$validateArray[] = $this->_language->get('alias_exists');
		}
		return $validateArray;
	}

	/**
	 * create the group
	 *
	 * @since 4.0.0
	 *
	 * @param array $createArray array of the create
	 *
	 * @return bool
	 */

	protected function _create(array $createArray = []) : bool
	{
		$groupModel = new Admin\Model\Group();
		return $groupModel->createByArray($createArray);
	}

	/**
	 * update the group
	 *
	 * @since 4.0.0
	 *
	 * @param int $groupId identifier of the group
	 * @param array $updateArray array of the update
	 *
	 * @return bool
	 */

	protected function _update(int $groupId = null, array $updateArray = []) : bool
	{
		$groupModel = new Admin\Model\Group();
		return $groupModel->updateByIdAndArray($groupId, $updateArray);
	}

	/**
	 * get success route
	 *
	 * @since 4.0.0
	 *
	 * @param array $postArray array of the post
	 *
	 * @return string
	 */

	protected function _getSuccessRoute(array $postArray = []) : string
	{
		if ($this->_registry->get('groupsEdit') && $postArray['id'])
		{
			return 'admin/view/groups#row-' . $postArray['id'];
		}
		if ($this->_registry->get('groupsEdit') && $postArray['alias'])
		{
			$groupModel = new Admin\Model\Group();
			$groupId = $groupModel->getByAlias($postArray['alias'])->id;
			if ($groupId)
			{
				return 'admin/view/groups#row-' . $groupId;
			}
			return 'admin/view/groups';
		}
		return 'admin';
	}

	/**
	 * get error route
	 *
	 * @since 4.0.0
	 *
	 * @param array $postArray array of the post
	 *
	 * @return string
	 */

	protected function _getErrorRoute(array $postArray = []) : string
	{
		if ($this->_registry->get('groupsEdit') && $postArray['id'])
		{
			return 'admin/edit/groups/' . $postArray['id'];
		}
		if ($this->_registry->get('groupsNew'))
		{
			return 'admin/new/groups';
		}
		return 'admin';
	}
}


1		<?php
2		namespace Redaxscript\Admin\Controller;
3
4		use Redaxscript\Admin;
5		use Redaxscript\Filter;
6		use Redaxscript\Validator;
7		use function json_encode;
8
9		/**
10		* children class to process the admin group request
11		*
12		* @since 4.0.0
13		*
14		* @package Redaxscript
15		* @category Controller
16		* @author Henry Ruhs
17		*/
18
19		class Group extends ControllerAbstract
20		{
21		/**
22		* process the class
23		*
24		* @since 4.0.0
25		*
26		* @param string $action action to process
27		*
28		* @return string
29		*/
30
31	10	public function process(string $action = null) : string
32		{
33	10	$postArray = $this->_normalizePost($this->_sanitizePost());
34	10	$validateArray = $this->_validatePost($postArray);
		0 ignored issues – show Bug introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$postArray` defined by `$this->_normalizePost($this->_sanitizePost())` on line `33` can also be of type `null`; however, `Redaxscript\Admin\Contro...\Group::_validatePost()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
35
36		/* validate post */
37
38	10	if ($validateArray)
		0 ignored issues – show Bug Best Practice introduced 2018-07-03 16:14 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$validateArray` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
39		{
40	6	return $this->_error(
41		[
42	6	'route' => $this->_getErrorRoute($postArray),
		0 ignored issues – show Bug introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$postArray` defined by `$this->_normalizePost($this->_sanitizePost())` on line `33` can also be of type `null`; however, `Redaxscript\Admin\Contro...Group::_getErrorRoute()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
43	6	'message' => $validateArray
44		]);
45		}
46
47		/* handle create */
48
49	4	if ($action === 'create')
50		{
51		$createArray =
52		[
53	1	'name' => $postArray['name'],
54	1	'alias' => $postArray['alias'],
55	1	'description' => $postArray['description'],
56	1	'categories' => $postArray['categories'],
57	1	'articles' => $postArray['articles'],
58	1	'extras' => $postArray['extras'],
59	1	'comments' => $postArray['comments'],
60	1	'groups' => $postArray['groups'],
61	1	'users' => $postArray['users'],
62	1	'modules' => $postArray['modules'],
63	1	'settings' => $postArray['settings'],
64	1	'filter' => $postArray['filter'],
65	1	'status' => $postArray['status']
66		];
67	1	if ($this->_create($createArray))
68		{
69	1	return $this->_success(
70		[
71	1	'route' => $this->_getSuccessRoute($postArray),
72	1	'timeout' => 2
73		]);
74		}
75		}
76
77		/* handle update */
78
79	3	if ($action === 'update')
80		{
81		$updateFullArray =
82		[
83	2	'name' => $postArray['name'],
84	2	'alias' => $postArray['alias'],
85	2	'description' => $postArray['description'],
86	2	'categories' => $postArray['categories'],
87	2	'articles' => $postArray['articles'],
88	2	'extras' => $postArray['extras'],
89	2	'comments' => $postArray['comments'],
90	2	'groups' => $postArray['groups'],
91	2	'users' => $postArray['users'],
92	2	'modules' => $postArray['modules'],
93	2	'settings' => $postArray['settings'],
94	2	'filter' => $postArray['filter'],
95	2	'status' => $postArray['status']
96		];
97		$updateLiteArray =
98		[
99	2	'name' => $postArray['name'],
100	2	'alias' => $postArray['alias'],
101	2	'description' => $postArray['description']
102		];
103	2	if ($this->_update($postArray['id'], $postArray['id'] > 1 ? $updateFullArray : $updateLiteArray))
104		{
105	2	return $this->_success(
106		[
107	2	'route' => $this->_getSuccessRoute($postArray),
108	2	'timeout' => 2
109		]);
110		}
111		}
112
113		/* handle error */
114
115	1	return $this->_error(
116		[
117	1	'route' => $this->_getErrorRoute($postArray)
		0 ignored issues – show Bug introduced 2020-12-19 03:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$postArray` defined by `$this->_normalizePost($this->_sanitizePost())` on line `33` can also be of type `null`; however, `Redaxscript\Admin\Contro...Group::_getErrorRoute()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
118		]);
119		}
120
121		/**
122		* sanitize the post
123		*
124		* @since 4.0.0
125		*
126		* @return array
127		*/
128
129	10	protected function _sanitizePost() : array
130		{
131	10	$aliasFilter = new Filter\Alias();
132	10	$numberFilter = new Filter\Number();
133	10	$textFilter = new Filter\Text();
134	10	$toggleFilter = new Filter\Toggle();
135
136		/* sanitize post */
137
138		return
139		[
140	10	'id' => $numberFilter->sanitize($this->_request->getPost('id')),
		0 ignored issues – show Bug introduced 2020-07-04 08:24 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('id')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Number::sanitize()` does only seem to accept `integer\|string\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
141	10	'name' => $textFilter->sanitize($this->_request->getPost('name')),
		0 ignored issues – show Bug introduced 2020-07-04 08:24 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('name')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Text::sanitize()` does only seem to accept `integer\|string\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
142	10	'alias' => $aliasFilter->sanitize($this->_request->getPost('alias')),
		0 ignored issues – show Bug introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('alias')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Alias::sanitize()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
143	10	'description' => $textFilter->sanitize($this->_request->getPost('description')),
		0 ignored issues – show Bug introduced 2020-07-04 08:24 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('description')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Text::sanitize()` does only seem to accept `integer\|string\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
144	10	'categories' => json_encode($this->_request->getPost('categories')),
145	10	'articles' => json_encode($this->_request->getPost('articles')),
146	10	'extras' => json_encode($this->_request->getPost('extras')),
147	10	'comments' => json_encode($this->_request->getPost('comments')),
148	10	'groups' => json_encode($this->_request->getPost('groups')),
149	10	'users' => json_encode($this->_request->getPost('users')),
150	10	'modules' => json_encode($this->_request->getPost('modules')),
151	10	'settings' => $numberFilter->sanitize($this->_request->getPost('settings')),
		0 ignored issues – show Bug introduced 2020-07-04 08:24 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('settings')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Number::sanitize()` does only seem to accept `integer\|string\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
152	10	'filter' => $toggleFilter->sanitize($this->_request->getPost('filter')),
		0 ignored issues – show Bug introduced 2020-02-12 13:54 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('filter')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Toggle::sanitize()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
153	10	'status' => $toggleFilter->sanitize($this->_request->getPost('status'))
		0 ignored issues – show Bug introduced 2020-02-12 13:54 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_request->getPost('status')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Toggle::sanitize()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
154		];
155		}
156
157		/**
158		* validate the post
159		*
160		* @since 4.0.0
161		*
162		* @param array $postArray array of the post
163		*
164		* @return array
165		*/
166
167	10	protected function _validatePost(array $postArray = []) : array
168		{
169	10	$nameValidator = new Validator\Name();
170	10	$aliasValidator = new Validator\Alias();
171	10	$groupModel = new Admin\Model\Group();
172	10	$validateArray = [];
173
174		/* validate post */
175
176	10	if (!$postArray['name'])
177		{
178	4	$validateArray[] = $this->_language->get('name_empty');
179		}
180	6	else if (!$nameValidator->validate($postArray['name']))
181		{
182	1	$validateArray[] = $this->_language->get('name_incorrect');
183		}
184	10	if (!$postArray['alias'])
185		{
186	4	$validateArray[] = $this->_language->get('alias_empty');
187		}
188	6	else if (!$aliasValidator->validate($postArray['alias']))
189		{
190	1	$validateArray[] = $this->_language->get('alias_incorrect');
191		}
192	5	else if (!$groupModel->isUniqueByIdAndAlias($postArray['id'], $postArray['alias']))
193		{
194	1	$validateArray[] = $this->_language->get('alias_exists');
195		}
196	10	return $validateArray;
197		}
198
199		/**
200		* create the group
201		*
202		* @since 4.0.0
203		*
204		* @param array $createArray array of the create
205		*
206		* @return bool
207		*/
208
209	1	protected function _create(array $createArray = []) : bool
210		{
211	1	$groupModel = new Admin\Model\Group();
212	1	return $groupModel->createByArray($createArray);
213		}
214
215		/**
216		* update the group
217		*
218		* @since 4.0.0
219		*
220		* @param int $groupId identifier of the group
221		* @param array $updateArray array of the update
222		*
223		* @return bool
224		*/
225
226	2	protected function _update(int $groupId = null, array $updateArray = []) : bool
227		{
228	2	$groupModel = new Admin\Model\Group();
229	2	return $groupModel->updateByIdAndArray($groupId, $updateArray);
230		}
231
232		/**
233		* get success route
234		*
235		* @since 4.0.0
236		*
237		* @param array $postArray array of the post
238		*
239		* @return string
240		*/
241
242	3	protected function _getSuccessRoute(array $postArray = []) : string
243		{
244	3	if ($this->_registry->get('groupsEdit') && $postArray['id'])
245		{
246	1	return 'admin/view/groups#row-' . $postArray['id'];
247		}
248	2	if ($this->_registry->get('groupsEdit') && $postArray['alias'])
249		{
250	1	$groupModel = new Admin\Model\Group();
251	1	$groupId = $groupModel->getByAlias($postArray['alias'])->id;
252	1	if ($groupId)
253		{
254	1	return 'admin/view/groups#row-' . $groupId;
255		}
256		return 'admin/view/groups';
257		}
258	1	return 'admin';
259		}
260
261		/**
262		* get error route
263		*
264		* @since 4.0.0
265		*
266		* @param array $postArray array of the post
267		*
268		* @return string
269		*/
270
271	7	protected function _getErrorRoute(array $postArray = []) : string
272		{
273	7	if ($this->_registry->get('groupsEdit') && $postArray['id'])
274		{
275	2	return 'admin/edit/groups/' . $postArray['id'];
276		}
277	5	if ($this->_registry->get('groupsNew'))
278		{
279	4	return 'admin/new/groups';
280		}
281	1	return 'admin';
282		}
283		}
284

redaxscript / redaxscript

Push — master ( 4eb4a8...a52438 )

includes/Admin/Controller/Group.php (11 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like