Issues in Article.php - All Issues - Inspection of "Fix the whole Hook class to be type correct" - redaxscript/redaxscript - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fcde34...4e146b )

by Henry

created 2021-03-27 22:50 UTC

includes/Admin/Controller/Article.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;
use function strtotime;

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

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

		/* validate post */

		if ($validateArray)

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

		/* handle create */

		if ($action === 'create')
		{
			$createArray =
			[
				'title' => $postArray['title'],
				'alias' => $postArray['alias'],
				'author' => $myName,
				'description' => $postArray['description'],
				'keywords' => $postArray['keywords'],
				'robots' => $postArray['robots'],
				'text' => $postArray['text'],
				'language' => $postArray['language'],
				'template' => $postArray['template'],
				'sibling' => $postArray['sibling'],
				'category' => $postArray['category'],
				'headline' => $postArray['headline'],
				'byline' => $postArray['byline'],
				'comments' => $postArray['comments'],
				'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 =
			[
				'title' => $postArray['title'],
				'alias' => $postArray['alias'],
				'author' => $myName,
				'description' => $postArray['description'],
				'keywords' => $postArray['keywords'],
				'robots' => $postArray['robots'],
				'text' => $postArray['text'],
				'language' => $postArray['language'],
				'template' => $postArray['template'],
				'sibling' => $postArray['sibling'],
				'category' => $postArray['category'],
				'headline' => $postArray['headline'],
				'byline' => $postArray['byline'],
				'comments' => $postArray['comments'],
				'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)
		]);
	}

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

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

		/* sanitize post */

		return
		[
			'id' => $numberFilter->sanitize($this->_request->getPost('id')),
			'title' => $textFilter->sanitize($this->_request->getPost('title')),
			'alias' => $aliasFilter->sanitize($this->_request->getPost('alias')),
			'description' => $textFilter->sanitize($this->_request->getPost('description')),
			'keywords' => $textFilter->sanitize($this->_request->getPost('keywords')),
			'robots' => $numberFilter->sanitize($this->_request->getPost('robots')),
			'text' => $htmlFilter->sanitize($this->_request->getPost('text'), $this->_registry->get('filter')),
			'language' => $specialFilter->sanitize($this->_request->getPost('language')),
			'template' => $specialFilter->sanitize($this->_request->getPost('template')),
			'sibling' => $numberFilter->sanitize($this->_request->getPost('sibling')),
			'category' => $numberFilter->sanitize($this->_request->getPost('category')),
			'headline' => $toggleFilter->sanitize($this->_request->getPost('headline')),
			'byline' => $toggleFilter->sanitize($this->_request->getPost('byline')),
			'comments' => $toggleFilter->sanitize($this->_request->getPost('comments')),
			'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
	{
		$aliasValidator = new Validator\Alias();
		$nameValidator = new Validator\Name();
		$articleModel = new Admin\Model\Article();
		$validateArray = [];

		/* validate post */

		if (!$postArray['title'])
		{
			$validateArray[] = $this->_language->get('title_empty');
		}
		else if (!$nameValidator->validate($postArray['title']))
		{
			$validateArray[] = $this->_language->get('title_incorrect');
		}
		if (!$postArray['alias'])
		{
			$validateArray[] = $this->_language->get('alias_empty');
		}
		else if (!$aliasValidator->validate($postArray['alias']) || $aliasValidator->matchSystem($postArray['alias']))
		{
			$validateArray[] = $this->_language->get('alias_incorrect');
		}
		else if (!$articleModel->isUniqueByIdAndAlias($postArray['id'], $postArray['alias']))
		{
			$validateArray[] = $this->_language->get('alias_exists');
		}
		if (!$postArray['text'])
		{
			$validateArray[] = $this->_language->get('article_empty');
		}
		return $validateArray;
	}

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

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

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

	protected function _update(int $articleId = null, array $updateArray = []) : bool
	{
		$articleModel = new Admin\Model\Article();
		return $articleModel->updateByIdAndArray($articleId, $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('articlesEdit') && $postArray['id'])
		{
			return 'admin/view/articles#row-' . $postArray['id'];
		}
		if ($this->_registry->get('articlesEdit') && $postArray['alias'])
		{
			$articleModel = new Admin\Model\Article();
			$articleId = $articleModel->getByAlias($postArray['alias'])->id;
			if ($articleId)
			{
				return 'admin/view/articles#row-' . $articleId;
			}
			return 'admin/view/articles';
		}
		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('articlesEdit') && $postArray['id'])
		{
			return 'admin/edit/articles/' . $postArray['id'];
		}
		if ($this->_registry->get('articlesNew'))
		{
			return 'admin/new/articles';
		}
		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		use function strtotime;
9
10		/**
11		* children class to process the admin article request
12		*
13		* @since 4.0.0
14		*
15		* @package Redaxscript
16		* @category Controller
17		* @author Henry Ruhs
18		*/
19
20		class Article extends ControllerAbstract
21		{
22		/**
23		* process the class
24		*
25		* @since 4.0.0
26		*
27		* @param string $action action to process
28		*
29		* @return string
30		*/
31
32	11	public function process(string $action = null) : string
33		{
34	11	$postArray = $this->_normalizePost($this->_sanitizePost());
35	11	$validateArray = $this->_validatePost($postArray);
36	11	$myName = $this->_registry->get('myName');
37	11	$now = $this->_registry->get('now');
38
39		/* validate post */
40
41	11	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	7	return $this->_error(
44		[
45	7	'route' => $this->_getErrorRoute($postArray),
46	7	'message' => $validateArray
47		]);
48		}
49
50		/* handle create */
51
52	4	if ($action === 'create')
53		{
54		$createArray =
55		[
56	1	'title' => $postArray['title'],
57	1	'alias' => $postArray['alias'],
58	1	'author' => $myName,
59	1	'description' => $postArray['description'],
60	1	'keywords' => $postArray['keywords'],
61	1	'robots' => $postArray['robots'],
62	1	'text' => $postArray['text'],
63	1	'language' => $postArray['language'],
64	1	'template' => $postArray['template'],
65	1	'sibling' => $postArray['sibling'],
66	1	'category' => $postArray['category'],
67	1	'headline' => $postArray['headline'],
68	1	'byline' => $postArray['byline'],
69	1	'comments' => $postArray['comments'],
70	1	'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
71	1	'rank' => $postArray['rank'],
72	1	'access' => $postArray['access'],
73	1	'date' => $postArray['date'] ? : $now
74		];
75	1	if ($this->_create($createArray))
76		{
77	1	return $this->_success(
78		[
79	1	'route' => $this->_getSuccessRoute($postArray),
80	1	'timeout' => 2
81		]);
82		}
83		}
84
85		/* handle update */
86
87	3	if ($action === 'update')
88		{
89		$updateArray =
90		[
91	2	'title' => $postArray['title'],
92	2	'alias' => $postArray['alias'],
93	2	'author' => $myName,
94	2	'description' => $postArray['description'],
95	2	'keywords' => $postArray['keywords'],
96	2	'robots' => $postArray['robots'],
97	2	'text' => $postArray['text'],
98	2	'language' => $postArray['language'],
99	2	'template' => $postArray['template'],
100	2	'sibling' => $postArray['sibling'],
101	2	'category' => $postArray['category'],
102	2	'headline' => $postArray['headline'],
103	2	'byline' => $postArray['byline'],
104	2	'comments' => $postArray['comments'],
105	2	'status' => $postArray['date'] > $now ? 2 : $postArray['status'],
106	2	'rank' => $postArray['rank'],
107	2	'access' => $postArray['access'],
108	2	'date' => $postArray['date'] ? : $now
109		];
110	2	if ($this->_update($postArray['id'], $updateArray))
111		{
112	2	return $this->_success(
113		[
114	2	'route' => $this->_getSuccessRoute($postArray),
115	2	'timeout' => 2
116		]);
117		}
118		}
119
120		/* handle error */
121
122	1	return $this->_error(
123		[
124	1	'route' => $this->_getErrorRoute($postArray)
125		]);
126		}
127
128		/**
129		* sanitize the post
130		*
131		* @since 4.0.0
132		*
133		* @return array
134		*/
135
136	11	protected function _sanitizePost() : array
137		{
138	11	$aliasFilter = new Filter\Alias();
139	11	$htmlFilter = new Filter\Html();
140	11	$numberFilter = new Filter\Number();
141	11	$specialFilter = new Filter\Special();
142	11	$textFilter= new Filter\Text();
143	11	$toggleFilter = new Filter\Toggle();
144
145		/* sanitize post */
146
147		return
148		[
149	11	'id' => $numberFilter->sanitize($this->_request->getPost('id')),
150	11	'title' => $textFilter->sanitize($this->_request->getPost('title')),
151	11	'alias' => $aliasFilter->sanitize($this->_request->getPost('alias')),
152	11	'description' => $textFilter->sanitize($this->_request->getPost('description')),
153	11	'keywords' => $textFilter->sanitize($this->_request->getPost('keywords')),
154	11	'robots' => $numberFilter->sanitize($this->_request->getPost('robots')),
155	11	'text' => $htmlFilter->sanitize($this->_request->getPost('text'), $this->_registry->get('filter')),
156	11	'language' => $specialFilter->sanitize($this->_request->getPost('language')),
157	11	'template' => $specialFilter->sanitize($this->_request->getPost('template')),
158	11	'sibling' => $numberFilter->sanitize($this->_request->getPost('sibling')),
159	11	'category' => $numberFilter->sanitize($this->_request->getPost('category')),
160	11	'headline' => $toggleFilter->sanitize($this->_request->getPost('headline')),
161	11	'byline' => $toggleFilter->sanitize($this->_request->getPost('byline')),
162	11	'comments' => $toggleFilter->sanitize($this->_request->getPost('comments')),
163	11	'status' => $toggleFilter->sanitize($this->_request->getPost('status')),
164	11	'rank' => $numberFilter->sanitize($this->_request->getPost('rank')),
165	11	'access' => json_encode($this->_request->getPost('access')),
166	11	'date' => strtotime($this->_request->getPost('date'))
167		];
168		}
169
170		/**
171		* validate the post
172		*
173		* @since 4.0.0
174		*
175		* @param array $postArray array of the post
176		*
177		* @return array
178		*/
179
180	11	protected function _validatePost(array $postArray = []) : array
181		{
182	11	$aliasValidator = new Validator\Alias();
183	11	$nameValidator = new Validator\Name();
184	11	$articleModel = new Admin\Model\Article();
185	11	$validateArray = [];
186
187		/* validate post */
188
189	11	if (!$postArray['title'])
190		{
191	6	$validateArray[] = $this->_language->get('title_empty');
192		}
193	5	else if (!$nameValidator->validate($postArray['title']))
194		{
195	1	$validateArray[] = $this->_language->get('title_incorrect');
196		}
197	11	if (!$postArray['alias'])
198		{
199	4	$validateArray[] = $this->_language->get('alias_empty');
200		}
201	7	else if (!$aliasValidator->validate($postArray['alias']) \|\| $aliasValidator->matchSystem($postArray['alias']))
202		{
203	2	$validateArray[] = $this->_language->get('alias_incorrect');
204		}
205	5	else if (!$articleModel->isUniqueByIdAndAlias($postArray['id'], $postArray['alias']))
206		{
207	1	$validateArray[] = $this->_language->get('alias_exists');
208		}
209	11	if (!$postArray['text'])
210		{
211	7	$validateArray[] = $this->_language->get('article_empty');
212		}
213	11	return $validateArray;
214		}
215
216		/**
217		* create the article
218		*
219		* @since 4.0.0
220		*
221		* @param array $createArray array of the create
222		*
223		* @return bool
224		*/
225
226	1	protected function _create(array $createArray = []) : bool
227		{
228	1	$articleModel = new Admin\Model\Article();
229	1	return $articleModel->createByArray($createArray);
230		}
231
232		/**
233		* update the article
234		*
235		* @since 4.0.0
236		*
237		* @param int $articleId identifier of the article
238		* @param array $updateArray array of the update
239		*
240		* @return bool
241		*/
242
243	2	protected function _update(int $articleId = null, array $updateArray = []) : bool
244		{
245	2	$articleModel = new Admin\Model\Article();
246	2	return $articleModel->updateByIdAndArray($articleId, $updateArray);
247		}
248
249		/**
250		* get success route
251		*
252		* @since 4.0.0
253		*
254		* @param array $postArray array of the post
255		*
256		* @return string
257		*/
258
259	3	protected function _getSuccessRoute(array $postArray = []) : string
260		{
261	3	if ($this->_registry->get('articlesEdit') && $postArray['id'])
262		{
263	1	return 'admin/view/articles#row-' . $postArray['id'];
264		}
265	2	if ($this->_registry->get('articlesEdit') && $postArray['alias'])
266		{
267	1	$articleModel = new Admin\Model\Article();
268	1	$articleId = $articleModel->getByAlias($postArray['alias'])->id;
269	1	if ($articleId)
270		{
271	1	return 'admin/view/articles#row-' . $articleId;
272		}
273		return 'admin/view/articles';
274		}
275	1	return 'admin';
276		}
277
278		/**
279		* get error route
280		*
281		* @since 4.0.0
282		*
283		* @param array $postArray array of the post
284		*
285		* @return string
286		*/
287
288	8	protected function _getErrorRoute(array $postArray = []) : string
289		{
290	8	if ($this->_registry->get('articlesEdit') && $postArray['id'])
291		{
292	2	return 'admin/edit/articles/' . $postArray['id'];
293		}
294	6	if ($this->_registry->get('articlesNew'))
295		{
296	5	return 'admin/new/articles';
297		}
298	1	return 'admin';
299		}
300		}
301

redaxscript / redaxscript

Push — master ( fcde34...4e146b )

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

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like