devtoolboxuk\soteria\handlers\Sanitise

Complexity

Total Complexity

33

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

24.75%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	removeUrl()	0	25	4
A	cleanString()	0	5	1
A	cleanse()	0	21	4
A	cleanseCsv()	0	4	1
C	disinfect()	0	62	14
A	stringLength()	0	9	3
A	isSanitised()	0	4	1
A	isValid()	0	4	1
A	result()	0	8	3

<?php

namespace devtoolboxuk\soteria\handlers;


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

class Sanitise

The property $is_valid is not named in camelCase.

The property $_sanitised is not named in camelCase.

{

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

    private $urlRegEx = '/\b((https?|ftp|file):\/\/|www\.)[-A-Z0-9+&@#\/%?=~_|$!:,.;]*[A-Z0-9+&@#\/%=~_|$]/i';

    function __construct()

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for __construct.

    {
        $this->filters = new Filters();
    }

    /**
     *
     * 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;

        $data = $this->cleanString($data);
        $data = preg_replace($this->urlRegEx, ' ', $data);

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

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

    }

    /**
     * @param $data
     * @return string
     */
    private function cleanString($data)
    {
        $data = implode("", explode("\\", $data));
        return strip_tags(trim(stripslashes($data)));
    }

    /**
     * @param $data
     * @return array|false|string|string[]|null
     */
    public function cleanse($data)
    {

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

        $this->input = $data;
        $data = $this->cleanString($data);
        $data = mb_convert_encoding($data, "utf-8", "auto");
        $data = htmlspecialchars_decode($data);
        $data = $this->cleanString($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 operation has 66 execution paths which exceeds the configured maximum of 10.

    {

        $this->_sanitised = null;

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

        $this->input = $data;

        $data = $this->cleanString($data);
        $data = $this->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->filtetInt($data);

The method filtetInt() does not seem to exist on object<devtoolboxuk\soteria\classes\Filters>.

                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":

case 'special_chars': $filterResult = $this->filters->filterSpecial($data); break; does not seem to be reachable.

                $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;
    }

    /**
     * @param $data
     * @param int $length
     * @return bool|string
     */
    private function stringLength($data, $length = -1)
    {
        if ($length > 0) {
            if (mb_strlen($data) > $length) {
                $data = substr($data, 0, $length);
            }
        }
        return $data;
    }


    /**
     * @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()

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for result.

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

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.

            $valid = true;
        }
        return new SoteriaModel($this->input, $this->output, $valid);
    }

}