Setting::_sanitizePost() - Code Metrics - Inspection of "Sanitize all the things (#669)" - redaxscript/redaxscript - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc8f37...8770f3 )

by Henry

created 2020-07-04 19:55 UTC

Setting::_sanitizePost() A

↳ Parent: Setting

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	29
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	39
ccs	29
cts	29
cp	1
rs	9.296
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
namespace Redaxscript\Admin\Controller;

use Redaxscript\Admin;
use Redaxscript\Filter;
use Redaxscript\Validator;

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

class Setting 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(),
				'message' => $validateArray
			]);
		}

		/* handle update */

		if ($action === 'update')
		{
			$updateArray =
			[
				'language' => $postArray['language'],
				'template' => $postArray['template'],
				'title' => $postArray['title'],
				'author' => $postArray['author'],
				'copyright' => $postArray['copyright'],
				'description' => $postArray['description'],
				'keywords' => $postArray['keywords'],
				'robots' => $postArray['robots'],
				'email' => $postArray['email'],
				'subject' => $postArray['subject'],
				'notification' => $postArray['notification'],
				'charset' => $postArray['charset'],
				'divider' => $postArray['divider'],
				'zone' => $postArray['zone'],
				'time' => $postArray['time'],
				'date' => $postArray['date'],
				'homepage' => $postArray['homepage'],
				'limit' => $postArray['limit'],
				'order' => $postArray['order'],
				'pagination' => $postArray['pagination'],
				'moderation' => $postArray['moderation'],
				'registration' => $postArray['registration'],
				'verification' => $postArray['verification'],
				'recovery' => $postArray['recovery'],
				'captcha' => $postArray['captcha']
			];
			if ($this->_update($updateArray))
			{
				return $this->_success(
				[
					'route' => 'admin',
					'timeout' => 2
				]);
			}
		}

		/* handle error */

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

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

	protected function _sanitizePost() : array
	{
		$emailFilter = new Filter\Email();
		$numberFilter = new Filter\Number();
		$specialFilter = new Filter\Special();
		$textFilter = new Filter\Text();
		$toggleFilter = new Filter\Toggle();

		/* sanitize post */

		return
		[
			'language' => $specialFilter->sanitize($this->_request->getPost('language')),

			'template' => $specialFilter->sanitize($this->_request->getPost('template')),

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

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

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

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

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

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

			'email' => $emailFilter->sanitize($this->_request->getPost('email')),

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

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

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

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

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

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

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

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

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

			'order' => $specialFilter->sanitize($this->_request->getPost('order')),

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

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

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

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

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

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

		];
	}

	/**
	 * 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();
		$userValidator = new Validator\User();
		$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['author'])
		{
			$validateArray[] = $this->_language->get('author_empty');
		}
		else if (!$userValidator->validate($postArray['author']))
		{
			$validateArray[] = $this->_language->get('author_incorrect');
		}
		if (!$postArray['charset'] || !$postArray['limit'])
		{
			$validateArray[] = $this->_language->get('input_empty');
		}
		return $validateArray;
	}

	/**
	 * update the setting
	 *
	 * @since 4.0.0
	 *
	 * @param array $updateArray array of the update
	 *
	 * @return bool
	 */

	protected function _update(array $updateArray = []) : bool
	{
		$settingModel = new Admin\Model\Setting();
		return $settingModel->updateByArray($updateArray);
	}

	/**
	 * get error route
	 *
	 * @since 4.1.0
	 *
	 * @return string
	 */

	protected function _getErrorRoute() : string
	{
		if ($this->_registry->get('settingsEdit'))
		{
			return 'admin/edit/settings';
		}
		return 'admin';
	}
}


1		<?php
2		namespace Redaxscript\Admin\Controller;
3
4		use Redaxscript\Admin;
5		use Redaxscript\Filter;
6		use Redaxscript\Validator;
7
8		/**
9		* children class to process the admin setting request
10		*
11		* @since 4.0.0
12		*
13		* @package Redaxscript
14		* @category Controller
15		* @author Henry Ruhs
16		*/
17
18		class Setting extends ControllerAbstract
19		{
20		/**
21		* process the class
22		*
23		* @since 4.0.0
24		*
25		* @param string $action action to process
26		*
27		* @return string
28		*/
29	4
30		public function process(string $action = null) : string
31	4	{
32	4	$postArray = $this->_normalizePost($this->_sanitizePost());
33		$validateArray = $this->_validatePost($postArray);
		0 ignored issues – show Bug introduced 2018-09-08 16:06 UTC by Report Bug Copy Issue Report It seems like `$postArray` defined by `$this->_normalizePost($this->_sanitizePost())` on line `32` can also be of type `null`; however, `Redaxscript\Admin\Contro...etting::_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...
34
35		/* validate post */
36	4
37		if ($validateArray)
		0 ignored issues – show Bug Best Practice introduced 2018-07-03 16:14 UTC by Report Bug Copy Issue Report 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...
38	2	{

redaxscript / redaxscript

Push — master ( dc8f37...8770f3 )

Setting::_sanitizePost() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like