Sanitise::__construct() - Code Metrics - Inspection of "Updated filter validatation" - devtoolboxuk/soteria - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0845f2...abc4c4 )

by Rob

created 2019-07-27 11:56 UTC

Sanitise::__construct() A

↳ Parent: Sanitise

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	5
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace devtoolboxuk\soteria\handlers;


use devtoolboxuk\soteria\classes\Filters;
use devtoolboxuk\soteria\classes\Strings;
use devtoolboxuk\soteria\classes\Url;
use devtoolboxuk\soteria\models\SoteriaModel;

class Sanitise
{

    private $is_valid = null;
    private $_sanitised = null;
    private $filters;
    private $input;
    private $output;
    private $strings;
    private $urlService;

    function __construct()

    {
        $this->filters = new Filters();
        $this->strings = new Strings();
        $this->urlService = new Url();
    }

    /**
     *
     * Removes URLs from strings
     *
     * @param array|string $data
     * @return array|string|string[]|null
     */
    public function removeUrl($data)
    {
        $this->_sanitised = null;

        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = $this->removeUrl($value);
            }
            return $data;
        }

        $this->input = $data = trim($data);
        $data = $this->urlService->remove($data);
        $data = trim($data);

        if ($this->input != $data) {
            $this->_sanitised = true;
        }
        $this->is_valid = true;

        $this->output = $data;
        return $data;

    }

    /**
     * @param $data
     * @param string $toEncoding
     * @param string $fromEncoding
     * @return array|false|string|string[]|null
     */
    public function cleanse($data, $toEncoding = 'utf-8', $fromEncoding = 'auto')
    {

        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = $this->cleanse($value, $toEncoding, $fromEncoding);
            }
            return $data;
        }

        $this->input = $data = trim($data);
        $data = $this->strings->clean($data);
        $data = mb_convert_encoding($data, $toEncoding, $fromEncoding);
        $data = htmlspecialchars_decode($data);
        $data = $this->strings->clean($data);
        if ($this->input != $data) {
            $this->_sanitised = true;
        }
        $this->output = $data;
        return $data;
    }

    /**
     * @param $string
     * @param string $delimiter
     * @return string
     */
    public function cleanseCsv($string, $delimiter = "|")
    {
        return trim(str_replace([$delimiter, "\n", "\r", "\t"], " ", $string));
    }

    /**
     * @param $data
     * @param string $type
     * @param int $stringLength
     * @return mixed|string
     */
    public function disinfect($data, $type = 'special_chars', $stringLength = -1)
    {

        $this->_sanitised = null;

        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = $this->disinfect($value, $type, $stringLength);
            }
            return $data;
        }

        $this->input = $data = trim($data);

        $data = $this->strings->clean($data);
        $data = $this->strings->stringLength($data, $stringLength);

        switch ($type) {
            case "email":
                $filterResult = $this->filters->filterEmail($data);
                break;

            case "encoded":
                $filterResult = $this->filters->filterEncoded($data);
                break;

            case "number_float":
            case "float":
                $filterResult = $this->filters->filterFloat($data);
                break;

            case "number_int":
            case "int":
                $filterResult = $this->filters->filterInt($data);
                break;

            case "full_special_chars":
                $filterResult = $this->filters->filterFullSpecialChar($data);
                break;

            case "url":
                $filterResult = $this->filters->filterUrl($data);
                break;

            case "string":
                $filterResult = $this->filters->filterString($data);
                break;

            default:
            case "special_chars":
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                $filterResult = $this->filters->filterSpecial($data);
                break;
        }

        if ($this->input != $filterResult->getResult()) {
            $this->_sanitised = true;
        }

        $this->is_valid = $filterResult->isValid();
        $this->output = $filterResult->getResult();
        return $this->output;
    }


    /**
     * @return null
     */
    public function isSanitised()
    {
        return $this->_sanitised;
    }

    /**
     * Returns true if the data is valid
     * @return null
     */
    public function isValid()
    {
        return $this->is_valid;
    }

    function result()

    {
        $valid = false;
        if (!$this->_sanitised && $this->is_valid) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            $valid = true;
        }
        return new SoteriaModel($this->input, $this->output, $valid);
    }

}

1		<?php
2
3		namespace devtoolboxuk\soteria\handlers;
4
5
6		use devtoolboxuk\soteria\classes\Filters;
7		use devtoolboxuk\soteria\classes\Strings;
8		use devtoolboxuk\soteria\classes\Url;
9		use devtoolboxuk\soteria\models\SoteriaModel;
10
11		class Sanitise
12		{
13
14		private $is_valid = null;
15		private $_sanitised = null;
16		private $filters;
17		private $input;
18		private $output;
19		private $strings;
20		private $urlService;
21
22		function __construct()
		0 ignored issues – show Best Practice introduced 2019-06-01 15:37 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
23		{
24		$this->filters = new Filters();
25		$this->strings = new Strings();
26		$this->urlService = new Url();
27		}
28
29		/**
30		*
31		* Removes URLs from strings
32		*
33		* @param array\|string $data
34		* @return array\|string\|string[]\|null
35		*/
36		public function removeUrl($data)
37		{
38		$this->_sanitised = null;
39
40		if (is_array($data)) {
41		foreach ($data as $key => $value) {
42		$data[$key] = $this->removeUrl($value);
43		}
44		return $data;
45		}
46
47		$this->input = $data = trim($data);
48		$data = $this->urlService->remove($data);
49		$data = trim($data);
50
51		if ($this->input != $data) {
52		$this->_sanitised = true;
53		}
54		$this->is_valid = true;
55
56		$this->output = $data;
57		return $data;
58
59		}
60
61		/**
62		* @param $data
63		* @param string $toEncoding
64		* @param string $fromEncoding
65		* @return array\|false\|string\|string[]\|null
66		*/
67		public function cleanse($data, $toEncoding = 'utf-8', $fromEncoding = 'auto')
68		{
69
70		if (is_array($data)) {
71		foreach ($data as $key => $value) {
72		$data[$key] = $this->cleanse($value, $toEncoding, $fromEncoding);
73		}
74		return $data;
75		}
76
77		$this->input = $data = trim($data);
78		$data = $this->strings->clean($data);
79		$data = mb_convert_encoding($data, $toEncoding, $fromEncoding);
80		$data = htmlspecialchars_decode($data);
81		$data = $this->strings->clean($data);
82		if ($this->input != $data) {
83		$this->_sanitised = true;
84		}
85		$this->output = $data;
86		return $data;
87		}
88
89		/**
90		* @param $string
91		* @param string $delimiter
92		* @return string
93		*/
94		public function cleanseCsv($string, $delimiter = "\|")
95		{
96		return trim(str_replace([$delimiter, "\n", "\r", "\t"], " ", $string));
97		}
98
99		/**
100		* @param $data
101		* @param string $type
102		* @param int $stringLength
103		* @return mixed\|string
104		*/
105	2	public function disinfect($data, $type = 'special_chars', $stringLength = -1)
106		{
107
108	2	$this->_sanitised = null;
109
110	2	if (is_array($data)) {
111		foreach ($data as $key => $value) {
112		$data[$key] = $this->disinfect($value, $type, $stringLength);
113		}
114		return $data;
115		}
116
117	2	$this->input = $data = trim($data);
118
119	2	$data = $this->strings->clean($data);
120	2	$data = $this->strings->stringLength($data, $stringLength);
121
122		switch ($type) {
123	2	case "email":
124	1	$filterResult = $this->filters->filterEmail($data);
125	1	break;
126
127	1	case "encoded":
128		$filterResult = $this->filters->filterEncoded($data);
129		break;
130
131	1	case "number_float":
132	1	case "float":
133		$filterResult = $this->filters->filterFloat($data);
134		break;
135
136	1	case "number_int":
137	1	case "int":
138		$filterResult = $this->filters->filterInt($data);
139		break;
140
141	1	case "full_special_chars":
142		$filterResult = $this->filters->filterFullSpecialChar($data);
143		break;
144
145	1	case "url":
146		$filterResult = $this->filters->filterUrl($data);
147		break;
148
149	1	case "string":
150		$filterResult = $this->filters->filterString($data);
151		break;
152
153	1	default:
154	1	case "special_chars":
		0 ignored issues – show Unused Code introduced 2019-05-25 15:36 UTC by Report Bug Copy Issue Report `case 'special_chars': ...cial($data); break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
155	1	$filterResult = $this->filters->filterSpecial($data);
156	1	break;
157	1	}
158
159	2	if ($this->input != $filterResult->getResult()) {
160		$this->_sanitised = true;
161		}
162
163	2	$this->is_valid = $filterResult->isValid();
164	2	$this->output = $filterResult->getResult();
165	2	return $this->output;
166		}
167
168
169		/**
170		* @return null
171		*/
172		public function isSanitised()
173		{
174		return $this->_sanitised;
175		}
176
177		/**
178		* Returns true if the data is valid
179		* @return null
180		*/
181		public function isValid()
182		{
183		return $this->is_valid;
184		}
185
186	2	function result()
		0 ignored issues – show Best Practice introduced 2019-05-25 15:36 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
187		{
188	2	$valid = false;
189	2	if (!$this->_sanitised && $this->is_valid) {
		0 ignored issues – show Bug Best Practice introduced 2019-05-25 15:36 UTC by Report Bug Copy Issue Report The expression `$this->_sanitised` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
190	2	$valid = true;
191	2	}
192	2	return new SoteriaModel($this->input, $this->output, $valid);
193		}
194
195		}

devtoolboxuk / soteria

Push — master ( 0845f2...abc4c4 )

Sanitise::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like