Issues in Module.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/Module.php (1 issue)

Labels

Severity

Minor 1

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 module request
 *
 * @since 4.0.0
 *
 * @package Redaxscript
 * @category Controller
 * @author Henry Ruhs
 */

class Module 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);

		/* validate post */

		if ($validateArray)

		{
			return $this->_error(
			[
				'route' => $this->_getErrorRoute($postArray),
				'message' => $validateArray
			]);
		}

		/* handle update */

		if ($action === 'update')
		{
			$updateArray =
			[
				'name' => $postArray['name'],
				'description' => $postArray['description'],
				'status' => $postArray['status'],
				'access' => $postArray['access']
			];
			if ($this->_update($postArray['id'], $updateArray))
			{
				return $this->_success(
				[
					'route' => $this->_getSuccessRoute($postArray),
					'timeout' => 2
				]);
			}
		}

		/* handle error */

		return $this->_error(
		[
			'route' => $this->_getErrorRoute($postArray)
		]);
	}

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

	protected function _sanitizePost() : array
	{
		$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')),
			'description' => $textFilter->sanitize($this->_request->getPost('description')),
			'status' => $toggleFilter->sanitize($this->_request->getPost('status')),
			'access' => json_encode($this->_request->getPost('access'))
		];
	}

	/**
	 * 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();
		$validateArray = [];

		/* validate post */

		if (!$postArray['name'])
		{
			$validateArray[] = $this->_language->get('name_empty');
		}
		else if (!$nameValidator->validate($postArray['name']))
		{
			$validateArray[] = $this->_language->get('name_incorrect');
		}
		return $validateArray;
	}

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

	protected function _update(int $moduleId = null, array $updateArray = []) : bool
	{
		$moduleModel = new Admin\Model\Module();
		return $moduleModel->updateByIdAndArray($moduleId, $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('modulesEdit'))
		{
			if ($postArray['id'])
			{
				return 'admin/view/modules#row-' . $postArray['id'];
			}
			return 'admin/view/modules';
		}
		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('modulesEdit'))
		{
			if ($postArray['id'])
			{
				return 'admin/edit/modules/' . $postArray['id'];
			}
			return 'admin/view/modules';
		}
		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 module request
11		*
12		* @since 4.0.0
13		*
14		* @package Redaxscript
15		* @category Controller
16		* @author Henry Ruhs
17		*/
18
19		class Module 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	6	public function process(string $action = null) : string
32		{
33	6	$postArray = $this->_normalizePost($this->_sanitizePost());
34	6	$validateArray = $this->_validatePost($postArray);
35
36		/* validate post */
37
38	6	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	3	return $this->_error(
41		[
42	3	'route' => $this->_getErrorRoute($postArray),
43	3	'message' => $validateArray
44		]);
45		}
46
47		/* handle update */
48
49	3	if ($action === 'update')
50		{
51		$updateArray =
52		[
53	2	'name' => $postArray['name'],
54	2	'description' => $postArray['description'],
55	2	'status' => $postArray['status'],
56	2	'access' => $postArray['access']
57		];
58	2	if ($this->_update($postArray['id'], $updateArray))
59		{
60	2	return $this->_success(
61		[
62	2	'route' => $this->_getSuccessRoute($postArray),
63	2	'timeout' => 2
64		]);
65		}
66		}
67
68		/* handle error */
69
70	1	return $this->_error(
71		[
72	1	'route' => $this->_getErrorRoute($postArray)
73		]);
74		}
75
76		/**
77		* sanitize the post
78		*
79		* @since 4.0.0
80		*
81		* @return array
82		*/
83
84	6	protected function _sanitizePost() : array
85		{
86	6	$numberFilter = new Filter\Number();
87	6	$textFilter = new Filter\Text();
88	6	$toggleFilter = new Filter\Toggle();
89
90		/* sanitize post */
91
92		return
93		[
94	6	'id' => $numberFilter->sanitize($this->_request->getPost('id')),
95	6	'name' => $textFilter->sanitize($this->_request->getPost('name')),
96	6	'description' => $textFilter->sanitize($this->_request->getPost('description')),
97	6	'status' => $toggleFilter->sanitize($this->_request->getPost('status')),
98	6	'access' => json_encode($this->_request->getPost('access'))
99		];
100		}
101
102		/**
103		* validate the post
104		*
105		* @since 4.0.0
106		*
107		* @param array $postArray array of the post
108		*
109		* @return array
110		*/
111
112	6	protected function _validatePost(array $postArray = []) : array
113		{
114	6	$nameValidator = new Validator\Name();
115	6	$validateArray = [];
116
117		/* validate post */
118
119	6	if (!$postArray['name'])
120		{
121	3	$validateArray[] = $this->_language->get('name_empty');
122		}
123	3	else if (!$nameValidator->validate($postArray['name']))
124		{
125		$validateArray[] = $this->_language->get('name_incorrect');
126		}
127	6	return $validateArray;
128		}
129
130		/**
131		* update the module
132		*
133		* @since 4.0.0
134		*
135		* @param int $moduleId identifier of the module
136		* @param array $updateArray array of the update
137		*
138		* @return bool
139		*/
140
141	2	protected function _update(int $moduleId = null, array $updateArray = []) : bool
142		{
143	2	$moduleModel = new Admin\Model\Module();
144	2	return $moduleModel->updateByIdAndArray($moduleId, $updateArray);
145		}
146
147		/**
148		* get success route
149		*
150		* @since 4.0.0
151		*
152		* @param array $postArray array of the post
153		*
154		* @return string
155		*/
156
157	2	protected function _getSuccessRoute(array $postArray = []) : string
158		{
159	2	if ($this->_registry->get('modulesEdit'))
160		{
161	1	if ($postArray['id'])
162		{
163	1	return 'admin/view/modules#row-' . $postArray['id'];
164		}
165		return 'admin/view/modules';
166		}
167	1	return 'admin';
168		}
169
170		/**
171		* get error route
172		*
173		* @since 4.0.0
174		*
175		* @param array $postArray array of the post
176		*
177		* @return string
178		*/
179
180	4	protected function _getErrorRoute(array $postArray = []) : string
181		{
182	4	if ($this->_registry->get('modulesEdit'))
183		{
184	3	if ($postArray['id'])
185		{
186	2	return 'admin/edit/modules/' . $postArray['id'];
187		}
188	1	return 'admin/view/modules';
189		}
190	1	return 'admin';
191		}
192		}
193

redaxscript / redaxscript

Push — master ( 4eb4a8...a52438 )

includes/Admin/Controller/Module.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like