InputParam - Code Metrics - Inspection of "Added possibility to send empty fields via console..." - tomaj/nette-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f71e62...3bdf74 )

by Tomas

created 2016-11-28 13:27 UTC

InputParam A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	181
Duplicated Lines	9.94 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

94.37%

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
wmc	35
c	7
b	0
f	0
lcom	1
cbo	0
dl	18
loc	181
ccs	67
cts	71
cp	0.9437
rs	9

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getType()	0	4	1
A	getKey()	0	4	1
A	isRequired()	0	4	1
A	getAvailableValues()	0	4	1
A	isMulti()	0	4	1
C	isValid()	0	23	9
D	getValue()	18	48	17
A	processMultiFileUploads()	0	10	3

How to fix Duplicated Code

<?php

namespace Tomaj\NetteApi\Params;

use Exception;

class InputParam implements ParamInterface
{
    const TYPE_POST      = 'POST';
    const TYPE_GET       = 'GET';
    const TYPE_PUT       = 'PUT';
    const TYPE_FILE      = 'FILE';
    const TYPE_COOKIE    = 'COOKIE';
    const TYPE_POST_RAW  = 'POST_RAW';

    const OPTIONAL = false;
    const REQUIRED = true;

    /**
     * @var string
     */
    private $type;

    /**
     * @var string
     */
    private $key;

    /**
     * @var bool
     */
    private $required;

    /**
     * @var array|null
     */
    private $availableValues;

    /**
     * @var bool
     */
    private $multi;

    public function __construct($type, $key, $required = self::OPTIONAL, $availableValues = null, $multi = false)
    {
        $this->type = $type;
        $this->key = $key;
        $this->required = $required;
        $this->availableValues = $availableValues;
        $this->multi = $multi;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @return string
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * @return boolean
     */
    public function isRequired()
    {
        return $this->required;
    }

    public function getAvailableValues()
    {
        return $this->availableValues;
    }

    /**
     * @return bool
     */
    public function isMulti()
    {
        return $this->multi;
    }

    /**
     * Check if actual value from environment is valid
     *
     * @return bool
     *
     * @throws Exception if actual InputParam has unsupported type
     */
    public function isValid()
    {
        if ($this->required == self::OPTIONAL) {
            return true;
        }

        $value = $this->getValue();
        if ($this->availableValues !== null) {
            if (is_array($this->availableValues)) {
                return empty(array_diff(($this->isMulti() ? $value : [$value]), $this->availableValues));
            }
        }

        if ($this->required) {
            if ($value === null || $value == '') {
                return false;
            }
            if (is_string($this->availableValues)) {
                return $value == $this->availableValues;
            }
        }
        return true;
    }

    /**
     * Process environment variables like POST|GET|etc.. and return actual value
     *
     * @return mixed
     *
     * @throws Exception if actual InputParam has unsupported type
     */
    public function getValue()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($this->type == self::TYPE_GET) {

            if (!filter_has_var(INPUT_GET, $this->key) && isset($_GET[$this->key])) {
                return $_GET[$this->key];
            }
            if ($this->isMulti()) {
                return filter_input(INPUT_GET, $this->key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
            }
            return filter_input(INPUT_GET, $this->key);
        }
        if ($this->type == self::TYPE_POST) {

            if (!filter_has_var(INPUT_POST, $this->key) && isset($_POST[$this->key])) {
                return $_POST[$this->key];
            }
            if ($this->isMulti()) {
                return filter_input(INPUT_POST, $this->key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
            }
            return filter_input(INPUT_POST, $this->key);
        }
        if ($this->type == self::TYPE_FILE) {
            if (isset($_FILES[$this->key])) {
                if ($this->isMulti()) {
                    return $this->processMultiFileUploads($_FILES[$this->key]);
                } else {
                    return $_FILES[$this->key];
                }
            }
            return null;
        }
        if ($this->type == self::TYPE_COOKIE) {
            if (isset($_COOKIE[$this->key])) {
                return $_COOKIE[$this->key];
            }
        }
        if ($this->type == self::TYPE_POST_RAW) {
            return file_get_contents("php://input");
        }
        if ($this->type == self::TYPE_PUT) {
            parse_str(file_get_contents("php://input"), $params);
            if (isset($params[$this->key])) {
                return $params[$this->key];
            }
            return '';
        }

        throw new Exception('Invalid type');
    }

    private function processMultiFileUploads($files)
    {
        $result = [];
        foreach ($files as $key => $values) {
            foreach ($values as $index => $value) {
                $result[$index][$key] = $value;
            }
        }
        return $result;
    }
}


1			<?php
2
3			namespace Tomaj\NetteApi\Params;
4
5			use Exception;
6
7			class InputParam implements ParamInterface
8			{
9			const TYPE_POST = 'POST';
10			const TYPE_GET = 'GET';
11			const TYPE_PUT = 'PUT';
12			const TYPE_FILE = 'FILE';
13			const TYPE_COOKIE = 'COOKIE';
14			const TYPE_POST_RAW = 'POST_RAW';
15
16			const OPTIONAL = false;
17			const REQUIRED = true;
18
19			/**
20			* @var string
21			*/
22			private $type;
23
24			/**
25			* @var string
26			*/
27			private $key;
28
29			/**
30			* @var bool
31			*/
32			private $required;
33
34			/**
35			* @var array\|null
36			*/
37			private $availableValues;
38
39			/**
40			* @var bool
41			*/
42			private $multi;
43
44	48		public function __construct($type, $key, $required = self::OPTIONAL, $availableValues = null, $multi = false)
45			{
46	48		$this->type = $type;
47	48		$this->key = $key;
48	48		$this->required = $required;
49	48		$this->availableValues = $availableValues;
50	48		$this->multi = $multi;
51	48		}
52
53			/**
54			* @return string
55			*/
56	9		public function getType()
57			{
58	9		return $this->type;
59			}
60
61			/**
62			* @return string
63			*/
64	21		public function getKey()
65			{
66	21		return $this->key;
67			}
68
69			/**
70			* @return boolean
71			*/
72	6		public function isRequired()
73			{
74	6		return $this->required;
75			}
76
77	6		public function getAvailableValues()
78			{
79	6		return $this->availableValues;
80			}
81
82			/**
83			* @return bool
84			*/
85	21		public function isMulti()
86			{
87	21		return $this->multi;
88			}
89
90			/**
91			* Check if actual value from environment is valid
92			*
93			* @return bool
94			*
95			* @throws Exception if actual InputParam has unsupported type
96			*/
97	18		public function isValid()
98			{
99	18		if ($this->required == self::OPTIONAL) {
100	6		return true;
101			}
102
103	18		$value = $this->getValue();
104	18		if ($this->availableValues !== null) {
105	9		if (is_array($this->availableValues)) {
106	6		return empty(array_diff(($this->isMulti() ? $value : [$value]), $this->availableValues));
107			}
108	1		}
109
110	15		if ($this->required) {
111	15		if ($value === null \|\| $value == '') {
112	6		return false;
113			}
114	9		if (is_string($this->availableValues)) {
115	3		return $value == $this->availableValues;
116			}
117	2		}
118	6		return true;
119			}
120
121			/**
122			* Process environment variables like POST\|GET\|etc.. and return actual value
123			*
124			* @return mixed
125			*
126			* @throws Exception if actual InputParam has unsupported type
127			*/
128	39		public function getValue()
			0 ignored issues – show Coding Style introduced 2015-12-25 12:35 UTC by Report Bug Copy Issue Report `getValue` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2015-12-25 12:35 UTC by Report Bug Copy Issue Report `getValue` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2015-12-25 12:35 UTC by Report Bug Copy Issue Report `getValue` uses the super-global variable `$_FILES` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2016-02-06 13:29 UTC by Report Bug Copy Issue Report `getValue` uses the super-global variable `$_COOKIE` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
129			{
130	39	View Code Duplication	if ($this->type == self::TYPE_GET) {
			0 ignored issues – show Duplication introduced 2016-01-07 09:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
131	15		if (!filter_has_var(INPUT_GET, $this->key) && isset($_GET[$this->key])) {
132	6		return $_GET[$this->key];
133			}
134	9		if ($this->isMulti()) {
135			return filter_input(INPUT_GET, $this->key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
136			}
137	9		return filter_input(INPUT_GET, $this->key);
138			}
139	33	View Code Duplication	if ($this->type == self::TYPE_POST) {
			0 ignored issues – show Duplication introduced 2016-01-07 09:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
140	12		if (!filter_has_var(INPUT_POST, $this->key) && isset($_POST[$this->key])) {
141	6		return $_POST[$this->key];
142			}
143	9		if ($this->isMulti()) {
144			return filter_input(INPUT_POST, $this->key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
145			}
146	9		return filter_input(INPUT_POST, $this->key);
147			}
148	24		if ($this->type == self::TYPE_FILE) {
149	9		if (isset($_FILES[$this->key])) {
150	6		if ($this->isMulti()) {
151	3		return $this->processMultiFileUploads($_FILES[$this->key]);
152			} else {
153	3		return $_FILES[$this->key];
154			}
155			}
156	3		return null;
157			}
158	15		if ($this->type == self::TYPE_COOKIE) {
159	3		if (isset($_COOKIE[$this->key])) {
160	3		return $_COOKIE[$this->key];
161			}
162			}
163	12		if ($this->type == self::TYPE_POST_RAW) {
164	3		return file_get_contents("php://input");
165			}
166	9		if ($this->type == self::TYPE_PUT) {
167	6		parse_str(file_get_contents("php://input"), $params);
168	6		if (isset($params[$this->key])) {
169			return $params[$this->key];
170			}
171	6		return '';
172			}
173
174	3		throw new Exception('Invalid type');
175			}
176
177	3		private function processMultiFileUploads($files)
178			{
179	3		$result = [];
180	3		foreach ($files as $key => $values) {
181	3		foreach ($values as $index => $value) {
182	3		$result[$index][$key] = $value;
183	1		}
184	1		}
185	3		return $result;
186			}
187			}
188

tomaj / nette-api

Push — master ( f71e62...3bdf74 )

InputParam A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like