Issues in Comment.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/Comment.php (12 issues)

Labels

Severity

Minor 12

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 function json_encode;
use function strtotime;

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

class Comment 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.
}
		$myName = $this->_registry->get('myName');
		$myEmail = $this->_registry->get('myEmail');
		$now = $this->_registry->get('now');

		/* 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 =
			[
				'author' => $myName,
				'email' => $myEmail,
				'url' => $postArray['url'],
				'text' => $postArray['text'],
				'language' => $postArray['language'],
				'article' => $postArray['article'],
				'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
				'rank' => $postArray['rank'],
				'access' => $postArray['access'],
				'date' => $postArray['date'] ? : $now
			];
			if ($this->_create($createArray))
			{
				return $this->_success(
				[
					'route' => $this->_getSuccessRoute($postArray),
					'timeout' => 2
				]);
			}
		}

		/* handle update */

		if ($action === 'update')
		{
			$updateArray =
			[
				'url' => $postArray['url'],
				'text' => $postArray['text'],
				'language' => $postArray['language'],
				'article' => $postArray['article'],
				'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
				'rank' => $postArray['rank'],
				'access' => $postArray['access'],
				'date' => $postArray['date'] ? : $now
			];
			if ($this->_update($postArray['id'], $updateArray))
			{
				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
	{
		$htmlFilter = new Filter\Html();
		$numberFilter = new Filter\Number();
		$specialFilter = new Filter\Special();
		$toggleFilter = new Filter\Toggle();
		$urlFilter = new Filter\Url();

		/* sanitize post */

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

			'url' => $urlFilter->sanitize($this->_request->getPost('url')),

			'text' => $htmlFilter->sanitize($this->_request->getPost('text'), $this->_registry->get('filter')),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			'language' => $specialFilter->sanitize($this->_request->getPost('language')),

			'article' => $numberFilter->sanitize($this->_request->getPost('article')),

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

			'rank' => $numberFilter->sanitize($this->_request->getPost('rank')),

			'access' => json_encode($this->_request->getPost('access')),
			'date' => strtotime($this->_request->getPost('date'))
		];
	}

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

	protected function _validatePost(array $postArray = []) : array
	{
		$validateArray = [];

		/* validate post */

		if (!$postArray['text'])
		{
			$validateArray[] = $this->_language->get('comment_empty');
		}
		if (!$postArray['article'])
		{
			$validateArray[] = $this->_language->get('article_empty');
		}
		return $validateArray;
	}

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

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

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

	protected function _update(int $commentId = null, array $updateArray = []) : bool
	{
		$commentModel = new Admin\Model\Comment();
		return $commentModel->updateByIdAndArray($commentId, $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('commentsEdit'))
		{
			if ($postArray['id'])
			{
				return 'admin/view/comments#row-' . $postArray['id'];
			}
			$commentModel = new Admin\Model\Comment();
			$commentId = $commentModel->query()->max('id');
			if ($commentId)
			{
				return 'admin/view/comments#row-' . $commentId;
			}
			return 'admin/view/comments';
		}
		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('commentsEdit') && $postArray['id'])
		{
			return 'admin/edit/comments/' . $postArray['id'];
		}
		if ($this->_registry->get('commentsNew'))
		{
			return 'admin/new/comments';
		}
		return 'admin';
	}
}


1		<?php
2		namespace Redaxscript\Admin\Controller;
3
4		use Redaxscript\Admin;
5		use Redaxscript\Filter;
6		use function json_encode;
7		use function strtotime;
8
9		/**
10		* children class to process the admin comment request
11		*
12		* @since 4.0.0
13		*
14		* @package Redaxscript
15		* @category Controller
16		* @author Henry Ruhs
17		*/
18
19		class Comment 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	8	public function process(string $action = null) : string
32		{
33	8	$postArray = $this->_normalizePost($this->_sanitizePost());
34	8	$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...omment::_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	8	$myName = $this->_registry->get('myName');
36	8	$myEmail = $this->_registry->get('myEmail');
37	8	$now = $this->_registry->get('now');
38
39		/* validate post */
40
41	8	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...
42		{
43	4	return $this->_error(
44		[
45	4	'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...mment::_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...
46	4	'message' => $validateArray
47		]);
48		}
49
50		/* handle create */
51
52	4	if ($action === 'create')
53		{
54		$createArray =
55		[
56	1	'author' => $myName,
57	1	'email' => $myEmail,
58	1	'url' => $postArray['url'],
59	1	'text' => $postArray['text'],
60	1	'language' => $postArray['language'],
61	1	'article' => $postArray['article'],
62	1	'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
63	1	'rank' => $postArray['rank'],
64	1	'access' => $postArray['access'],
65	1	'date' => $postArray['date'] ? : $now
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		$updateArray =
82		[
83	2	'url' => $postArray['url'],
84	2	'text' => $postArray['text'],
85	2	'language' => $postArray['language'],
86	2	'article' => $postArray['article'],
87	2	'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
88	2	'rank' => $postArray['rank'],
89	2	'access' => $postArray['access'],
90	2	'date' => $postArray['date'] ? : $now
91		];
92	2	if ($this->_update($postArray['id'], $updateArray))
93		{
94	2	return $this->_success(
95		[
96	2	'route' => $this->_getSuccessRoute($postArray),
97	2	'timeout' => 2
98		]);
99		}
100		}
101
102		/* handle error */
103
104	1	return $this->_error(
105		[
106	1	'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...mment::_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...
107		]);
108		}
109
110		/**
111		* sanitize the post
112		*
113		* @since 4.0.0
114		*
115		* @return array
116		*/
117
118	8	protected function _sanitizePost() : array
119		{
120	8	$htmlFilter = new Filter\Html();
121	8	$numberFilter = new Filter\Number();
122	8	$specialFilter = new Filter\Special();
123	8	$toggleFilter = new Filter\Toggle();
124	8	$urlFilter = new Filter\Url();
125
126		/* sanitize post */
127
128		return
129		[
130	8	'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...
131	8	'url' => $urlFilter->sanitize($this->_request->getPost('url')),
		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('url')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Url::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...
132	8	'text' => $htmlFilter->sanitize($this->_request->getPost('text'), $this->_registry->get('filter')),
		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('text')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Html::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... Documentation introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$this->_registry->get('filter')` is of type `string\|array\|null`, but the function expects a `boolean`. 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...
133	8	'language' => $specialFilter->sanitize($this->_request->getPost('language')),
		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('language')` targeting `Redaxscript\Request::getPost()` can also be of type `array`; however, `Redaxscript\Filter\Special::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...
134	8	'article' => $numberFilter->sanitize($this->_request->getPost('article')),
		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('article')` 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...
135	8	'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...
136	8	'rank' => $numberFilter->sanitize($this->_request->getPost('rank')),
		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('rank')` 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...
137	8	'access' => json_encode($this->_request->getPost('access')),
138	8	'date' => strtotime($this->_request->getPost('date'))
139		];
140		}
141
142		/**
143		* validate the post
144		*
145		* @since 4.0.0
146		*
147		* @param array $postArray array of the post
148		*
149		* @return array
150		*/
151
152	8	protected function _validatePost(array $postArray = []) : array
153		{
154	8	$validateArray = [];
155
156		/* validate post */
157
158	8	if (!$postArray['text'])
159		{
160	4	$validateArray[] = $this->_language->get('comment_empty');
161		}
162	8	if (!$postArray['article'])
163		{
164	4	$validateArray[] = $this->_language->get('article_empty');
165		}
166	8	return $validateArray;
167		}
168
169		/**
170		* create the comment
171		*
172		* @since 4.0.0
173		*
174		* @param array $createArray array of the create
175		*
176		* @return bool
177		*/
178
179	1	protected function _create(array $createArray = []) : bool
180		{
181	1	$commentModel = new Admin\Model\Comment();
182	1	return $commentModel->createByArray($createArray);
183		}
184
185		/**
186		* update the comment
187		*
188		* @since 4.0.0
189		*
190		* @param int $commentId identifier of the comment
191		* @param array $updateArray array of the update
192		*
193		* @return bool
194		*/
195
196	2	protected function _update(int $commentId = null, array $updateArray = []) : bool
197		{
198	2	$commentModel = new Admin\Model\Comment();
199	2	return $commentModel->updateByIdAndArray($commentId, $updateArray);
200		}
201
202		/**
203		* get success route
204		*
205		* @since 4.0.0
206		*
207		* @param array $postArray array of the post
208		*
209		* @return string
210		*/
211
212	3	protected function _getSuccessRoute(array $postArray = []) : string
213		{
214	3	if ($this->_registry->get('commentsEdit'))
215		{
216	2	if ($postArray['id'])
217		{
218	1	return 'admin/view/comments#row-' . $postArray['id'];
219		}
220	1	$commentModel = new Admin\Model\Comment();
221	1	$commentId = $commentModel->query()->max('id');
222	1	if ($commentId)
223		{
224	1	return 'admin/view/comments#row-' . $commentId;
225		}
226		return 'admin/view/comments';
227		}
228	1	return 'admin';
229		}
230
231		/**
232		* get error route
233		*
234		* @since 4.0.0
235		*
236		* @param array $postArray array of the post
237		*
238		* @return string
239		*/
240
241	5	protected function _getErrorRoute(array $postArray = []) : string
242		{
243	5	if ($this->_registry->get('commentsEdit') && $postArray['id'])
244		{
245	2	return 'admin/edit/comments/' . $postArray['id'];
246		}
247	3	if ($this->_registry->get('commentsNew'))
248		{
249	2	return 'admin/new/comments';
250		}
251	1	return 'admin';
252		}
253		}
254

redaxscript / redaxscript

Push — master ( 4eb4a8...a52438 )

includes/Admin/Controller/Comment.php (12 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like