Request - Code Metrics - Inspection of "patch doc block" - linpax/microphp-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 465e97...66bd01 )

by Oleg

created 2016-06-06 15:52 UTC

Request B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	8
Bugs	2	Features	0

Metric	Value
wmc	36
c	8
b	2
f	0
lcom	1
cbo	0
dl	0
loc	278
rs	8.8

17 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	isCli()	4	1
A	isAjax()	4	1
A	getMethod()	4	1
A	getUserIP()	4	2
A	getBrowser()	4	2
C	getOption()	29	16
A	getFiles()	4	2
A	query()	4	1
A	setQuery()	4	1
A	post()	4	1
A	cookie()	4	1
A	session()	4	1
A	unsetSession()	6	2
A	server()	4	1
A	requestPayload()	4	1
A	setSession()	4	1

<?php /** MicroRequest */

namespace Micro\Web;

/**
 * Request class file.
 *
 * @author Oleg Lunegov <[email protected]>
 * @link https://github.com/linpax/microphp-framework
 * @copyright Copyright &copy; 2013 Oleg Lunegov
 * @license /LICENSE
 * @package Micro
 * @subpackage Web
 * @version 1.0
 * @since 1.0
 */
class Request implements IRequest
{
    /** @var bool $cli Is running as CLI */
    protected $cli;
    /** @var array $files $_FILES from request */
    protected $files;


    /**
     * Constructor Request
     *
     * @access public
     *
     * @param array $files
     *
     * @result void
     */
    public function __construct(array $files = [])
    {
        $this->cli = PHP_SAPI === 'cli';

        $this->files = $files;
    }

    /**
     * Get flag of running as CLI
     *
     * @access public
     *
     * @return bool
     */
    public function isCli()
    {
        return $this->cli;
    }

    /**
     * Check request is AJAX ?
     *
     * @access public
     *
     * @return bool
     */
    public function isAjax()
    {
        return strtolower(filter_input(INPUT_SERVER, 'HTTP_X_REQUESTED_WITH')) === 'xmlhttprequest';
    }

    /**
     * Get request method
     *
     * @access public
     *
     * @return string
     */
    public function getMethod()
    {
        return filter_input(INPUT_SERVER, 'REQUEST_METHOD');
    }

    /**
     * Get user IP-address
     *
     * @access public
     *
     * @return string
     */
    public function getUserIP()
    {
        return ($ip = filter_input(INPUT_SERVER, 'REMOTE_ADDR')) ? $ip : '127.0.0.1';
    }

    /**
     * Get browser data from user user agent string
     *
     * @access public
     *
     * @param null|string $agent User agent string
     *
     * @return mixed
     */
    public function getBrowser($agent = null)
    {
        return get_browser($agent ?: filter_input(INPUT_SERVER, 'HTTP_USER_AGENT'), true);
    }

    /**
     * Get arguments from command line
     *
     * @access public
     *
     * @param string $char -a .. -z option char
     * @param string $name --optionName_string
     * @param bool|null $required Required value?
     *
     * @return mixed
     */
    public function getOption($char = '', $name = '', $required = null)
    {
        if (!$char && !$name) {
            return false;
        }

        if ($char && (1 < strlen($char) || 1 !== preg_match('/^\w$/', $char))) {
            return false;
        }

        if ($name && (1 !== preg_match('/^\w+$/', $name))) {
            return false;
        }

        switch ($required) {
            case true:
                $char = $char ? $char.':' : $char;
                $name = $name ? $name.':' : $name;
                break;
            case false:
                $char = $char ? $char.'::' : $char;
                $name = $name ? $name.'::' : $name;
                break;
        }

        $argv = ($opts = getopt($char, [$name])) ? array_shift($opts) : [];

        return is_array($argv) ? array_shift($argv) : $argv;
    }

    /**
     * Get files mapper
     *
     * @access public
     *
     * @param string $className Class name of mapper
     *
     * @return mixed
     */
    public function getFiles($className = '\Micro\Web\Uploader')
    {
        return $this->files ? new $className($this->files) : false;
    }

    /**
     * Get value by key from query storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function query($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_GET, $name, $filter, $options);
    }

    /**
     * Set query by key
     *
     * @access public
     *
     * @param string $name
     * @param string|integer $value
     *
     * @return void
     */
    public function setQuery($name, $value)
// 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);
    }
}
    {
        $_GET[$name] = $value;
    }

    /**
     * Get value by key from post storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return mixed
     */
    public function post($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_POST, $name, $filter, $options);
    }

    /**
     * Get value by key from cookie storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function cookie($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_COOKIE, $name, $filter, $options);
    }

    /**
     * Get value by key from session storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function session($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_SESSION, $name, $filter, $options);
    }

    /**
     * Unset value by key from session storage
     *
     * @access public
     *
     * @param string $name Key name
     *
     * @return void
     */
    public function unsetSession($name)
// 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 (array_key_exists($name, $_SESSION)) {
            unset($_SESSION[$name]);
        }
    }


    /**
     * Get value by key from server storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function server($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_SERVER, $name, $filter, $options);
    }

    /**
     * Get RequestPayload (RAW DATA)
     *
     * @return string|bool
     */
    public function requestPayload()
    {
        return file_get_contents('php://input');
    }

    /**
     * Set value into session storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param string $value Key value
     *
     * @return void
     */
    public function setSession($name, $value)
// 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);
    }
}
    {
        $_SESSION[$name] = $value;
    }
}


1			<?php /** MicroRequest */
2
3			namespace Micro\Web;
4
5			/**
6			* Request class file.
7			*
8			* @author Oleg Lunegov <[email protected]>
9			* @link https://github.com/linpax/microphp-framework
10			* @copyright Copyright © 2013 Oleg Lunegov
11			* @license /LICENSE
12			* @package Micro
13			* @subpackage Web
14			* @version 1.0
15			* @since 1.0
16			*/
17			class Request implements IRequest
18			{
19			/** @var bool $cli Is running as CLI */
20			protected $cli;
21			/** @var array $files $_FILES from request */
22			protected $files;
23
24
25			/**
26			* Constructor Request
27			*
28			* @access public
29			*
30			* @param array $files
31			*
32			* @result void
33			*/
34			public function __construct(array $files = [])
35			{
36			$this->cli = PHP_SAPI === 'cli';
37
38			$this->files = $files;
39			}
40
41			/**
42			* Get flag of running as CLI
43			*
44			* @access public
45			*
46			* @return bool
47			*/
48			public function isCli()
49			{
50			return $this->cli;
51			}
52
53			/**
54			* Check request is AJAX ?
55			*
56			* @access public
57			*
58			* @return bool
59			*/
60			public function isAjax()
61			{
62			return strtolower(filter_input(INPUT_SERVER, 'HTTP_X_REQUESTED_WITH')) === 'xmlhttprequest';
63			}
64
65			/**
66			* Get request method
67			*
68			* @access public
69			*
70			* @return string
71			*/
72			public function getMethod()
73			{
74			return filter_input(INPUT_SERVER, 'REQUEST_METHOD');
75			}
76
77			/**
78			* Get user IP-address
79			*
80			* @access public
81			*
82			* @return string
83			*/
84			public function getUserIP()
85			{
86			return ($ip = filter_input(INPUT_SERVER, 'REMOTE_ADDR')) ? $ip : '127.0.0.1';
87			}
88
89			/**
90			* Get browser data from user user agent string
91			*
92			* @access public
93			*
94			* @param null\|string $agent User agent string
95			*
96			* @return mixed
97			*/
98			public function getBrowser($agent = null)
99			{
100			return get_browser($agent ?: filter_input(INPUT_SERVER, 'HTTP_USER_AGENT'), true);
101			}
102
103			/**
104			* Get arguments from command line
105			*
106			* @access public
107			*
108			* @param string $char -a .. -z option char
109			* @param string $name --optionName_string
110			* @param bool\|null $required Required value?
111			*
112			* @return mixed
113			*/
114			public function getOption($char = '', $name = '', $required = null)
115			{
116			if (!$char && !$name) {
117			return false;
118			}
119
120			if ($char && (1 < strlen($char) \|\| 1 !== preg_match('/^\w$/', $char))) {
121			return false;
122			}
123
124			if ($name && (1 !== preg_match('/^\w+$/', $name))) {
125			return false;
126			}
127
128			switch ($required) {
129			case true:
130			$char = $char ? $char.':' : $char;
131			$name = $name ? $name.':' : $name;
132			break;
133			case false:
134			$char = $char ? $char.'::' : $char;
135			$name = $name ? $name.'::' : $name;
136			break;
137			}
138
139			$argv = ($opts = getopt($char, [$name])) ? array_shift($opts) : [];
140
141			return is_array($argv) ? array_shift($argv) : $argv;
142			}
143
144			/**
145			* Get files mapper
146			*
147			* @access public
148			*
149			* @param string $className Class name of mapper
150			*
151			* @return mixed
152			*/
153			public function getFiles($className = '\Micro\Web\Uploader')
154			{
155			return $this->files ? new $className($this->files) : false;
156			}
157
158			/**
159			* Get value by key from query storage
160			*
161			* @access public
162			*
163			* @param string $name Key name
164			* @param integer $filter
165			* @param mixed $options
166			*
167			* @return bool
168			*/
169			public function query($name, $filter = FILTER_DEFAULT, $options = null)
170			{
171			return filter_input(INPUT_GET, $name, $filter, $options);
172			}
173
174			/**
175			* Set query by key
176			*
177			* @access public
178			*
179			* @param string $name
180			* @param string\|integer $value
181			*
182			* @return void
183			*/
184			public function setQuery($name, $value)
			0 ignored issues – show Coding Style introduced 2016-06-06 15:57 UTC by Report Bug Copy Issue Report `setQuery` 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...
185			{
186			$_GET[$name] = $value;
187			}
188
189			/**
190			* Get value by key from post storage
191			*
192			* @access public
193			*
194			* @param string $name Key name
195			* @param integer $filter
196			* @param mixed $options
197			*
198			* @return mixed
199			*/
200			public function post($name, $filter = FILTER_DEFAULT, $options = null)
201			{
202			return filter_input(INPUT_POST, $name, $filter, $options);
203			}
204
205			/**
206			* Get value by key from cookie storage
207			*
208			* @access public
209			*
210			* @param string $name Key name
211			* @param integer $filter
212			* @param mixed $options
213			*
214			* @return bool
215			*/
216			public function cookie($name, $filter = FILTER_DEFAULT, $options = null)
217			{
218			return filter_input(INPUT_COOKIE, $name, $filter, $options);
219			}
220
221			/**
222			* Get value by key from session storage
223			*
224			* @access public
225			*
226			* @param string $name Key name
227			* @param integer $filter
228			* @param mixed $options
229			*
230			* @return bool
231			*/
232			public function session($name, $filter = FILTER_DEFAULT, $options = null)
233			{
234			return filter_input(INPUT_SESSION, $name, $filter, $options);
235			}
236
237			/**
238			* Unset value by key from session storage
239			*
240			* @access public
241			*
242			* @param string $name Key name
243			*
244			* @return void
245			*/
246			public function unsetSession($name)
			0 ignored issues – show Coding Style introduced 2016-06-06 14:21 UTC by Report Bug Copy Issue Report `unsetSession` uses the super-global variable `$_SESSION` 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...
247			{
248			if (array_key_exists($name, $_SESSION)) {
249			unset($_SESSION[$name]);
250			}
251			}
252
253
254			/**
255			* Get value by key from server storage
256			*
257			* @access public
258			*
259			* @param string $name Key name
260			* @param integer $filter
261			* @param mixed $options
262			*
263			* @return bool
264			*/
265			public function server($name, $filter = FILTER_DEFAULT, $options = null)
266			{
267			return filter_input(INPUT_SERVER, $name, $filter, $options);
268			}
269
270			/**
271			* Get RequestPayload (RAW DATA)
272			*
273			* @return string\|bool
274			*/
275			public function requestPayload()
276			{
277			return file_get_contents('php://input');
278			}
279
280			/**
281			* Set value into session storage
282			*
283			* @access public
284			*
285			* @param string $name Key name
286			* @param string $value Key value
287			*
288			* @return void
289			*/
290			public function setSession($name, $value)
			0 ignored issues – show Coding Style introduced 2016-06-06 14:00 UTC by Report Bug Copy Issue Report `setSession` uses the super-global variable `$_SESSION` 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...
291			{
292			$_SESSION[$name] = $value;
293			}
294			}
295

linpax / microphp-framework

Push — master ( 465e97...66bd01 )

Request B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

Duplication Side-by-Side

Filter issues like