Request - Code Metrics - Inspection of "Bluz 7.0.0" - bluzphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#363)

by Anton

created 2016-06-13 08:39 UTC

Request B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	321
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

53.75%

Importance

Changes	14
Bugs	4	Features	6

Metric	Value
dl	0
loc	321
ccs	43
cts	80
cp	0.5375
rs	8.295
c	14
b	4
f	6
wmc	42
lcom	1
cbo	5

20 Methods

Rating	Name	Size	Complexity
A	initInstance()	4	1
A	getServer()	4	1
A	getCookie()	4	1
A	getEnv()	4	1
A	getHeader()	4	1
B	getParam()	17	10
A	getParams()	7	1
A	getFile()	4	1
B	getClientIp()	13	5
A	getModule()	4	1
A	getController()	4	1
A	getMethod()	4	1
C	getAccept()	55	10
A	isCli()	4	1
A	isHttp()	4	1
A	isGet()	4	1
A	isPost()	4	1
A	isPut()	4	1
A	isDelete()	4	1
A	isXmlHttpRequest()	4	1

How to fix Complexity

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/framework
 */

/**
 * @namespace
 */
namespace Bluz\Proxy;

use Bluz\Common\Exception\ComponentException;
use Bluz\Request\RequestFactory;
use Psr\Http\Message\UriInterface;
use Zend\Diactoros\ServerRequest as Instance;

/**
 * Proxy to Request
 *
 * Example of usage
 * <code>
 *     use Bluz\Proxy\Request;
 *
 *     Request::getParam('foo');
 * </code>
 *
 * @package  Bluz\Proxy
 * @author   Anton Shevchuk
 * 
 * @method   static \Psr\Http\Message\UriInterface getUri()
 * @see      \Zend\Diactoros\RequestTrait::getUri()
 *
 * @method   static Instance getInstance()
 */
class Request extends AbstractProxy
{
    /**
     * @const string HTTP methods
     */
    const METHOD_OPTIONS = 'OPTIONS';
    const METHOD_GET = 'GET';
    const METHOD_HEAD = 'HEAD';
    const METHOD_PATCH = 'PATCH';
    const METHOD_POST = 'POST';
    const METHOD_PUT = 'PUT';
    const METHOD_DELETE = 'DELETE';
    const METHOD_TRACE = 'TRACE';
    const METHOD_CONNECT = 'CONNECT';

    /**
     * @const string HTTP content types 
     */
    const TYPE_ANY = '*/*';
    const TYPE_HTML = 'text/html';
    const TYPE_JSON = 'application/json';

    /**
     * Init instance
     *
     * @throws ComponentException
     */
    protected static function initInstance()
    {
        throw new ComponentException("Class `Proxy\\Request` required external initialization");
    }

    /**
     * Retrieve a member of the $_SERVER super global
     *
     * If no $key is passed, returns the entire $_SERVER array.
     *
     * @param  string $key
     * @param  string $default Default value to use if key not found
     * @return string Returns null if key does not exist
     */
    public static function getServer($key = null, $default = null)
    {
        return RequestFactory::get($key, self::getInstance()->getServerParams(), $default);
    }

    /**
     * Retrieve a member of the $_COOKIE super global
     *
     * If no $key is passed, returns the entire $_COOKIE array.
     *
     * @param  string $key
     * @param  string $default Default value to use if key not found
     * @return string Returns null if key does not exist
     */
    public static function getCookie($key = null, $default = null)
    {
        return RequestFactory::get($key, self::getInstance()->getCookieParams(), $default);
    }
    /**
     * Retrieve a member of the $_ENV super global
     *
     * If no $key is passed, returns the entire $_ENV array.
     *
     * @param  string $key
     * @param  string $default Default value to use if key not found
     * @return string Returns null if key does not exist
     */
    public static function getEnv($key = null, $default = null)
    {
        return RequestFactory::get($key, $_ENV, $default);
    }

    /**
     * Search for a header value
     *
     * @param string $header
     * @param mixed  $default
     * @return string
     */
    public static function getHeader($header, $default = null)
    {
        return RequestFactory::getHeader($header, self::getInstance()->getHeaders(), $default);
    }
    
    /**
     * Access values contained in the superglobals as public members
     * Order of precedence: 1. GET, 2. POST, 3. COOKIE, 4. SERVER, 5. ENV
     *
     * @param  string $key
     * @param  null   $default
     * @return mixed
     * @link http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx
     */
    public static function getParam($key, $default = null)
    {
        switch (true) {
            case ($params = self::getInstance()->getQueryParams()) && isset($params[$key]):
                return $params[$key];
function someFunction() {
    $x = 5;
    echo $x;
}
            case ($params = self::getInstance()->getParsedBody()) && isset($params[$key]):
                return $params[$key];
function someFunction() {
    $x = 5;
    echo $x;
}
            case ($params = self::getInstance()->getCookieParams()) && isset($params[$key]):
                return $params[$key];
function someFunction() {
    $x = 5;
    echo $x;
}
            case ($params = self::getInstance()->getServerParams()) && isset($params[$key]):
                return $params[$key];
function someFunction() {
    $x = 5;
    echo $x;
}
            case isset($_ENV[$key]):
                return $_ENV[$key];
            default:
                return $default;
        }
    }

    /**
     * Get all params from GET and POST or PUT
     *
     * @return array
     */
    public static function getParams()
    {
        $query = (array) self::getInstance()->getQueryParams();
        $body = (array) self::getInstance()->getParsedBody();

        return array_merge($body, $query);
    }

    /**
     * Get uploaded file
     *
     * @param  string $name
     * @return \Zend\Diactoros\UploadedFile
     */
    public static function getFile($name)
    {
        return RequestFactory::get($name, self::getInstance()->getUploadedFiles());
    }

    /**
     * Get the client's IP address
     *
     * @param  bool $checkProxy
     * @return string
     */
    public static function getClientIp($checkProxy = true)
    {
        if ($checkProxy && self::getServer('HTTP_CLIENT_IP') != null) {
            $ip = self::getServer('HTTP_CLIENT_IP');
        } else {
            if ($checkProxy && self::getServer('HTTP_X_FORWARDED_FOR') != null) {
                $ip = self::getServer('HTTP_X_FORWARDED_FOR');
            } else {
                $ip = self::getServer('REMOTE_ADDR');
            }
        }
        return $ip;
    }

    /**
     * Get module
     *
     * @return string
     */
    public static function getModule()
    {
        return self::getParam('_module', Router::getDefaultModule());
    }

    /**
     * Get controller
     *
     * @return string
     */
    public static function getController()
    {
        return self::getParam('_controller', Router::getDefaultController());
    }
    
    /**
     * Get method
     *
     * @return string
     */
    public static function getMethod()
    {
        return self::getParam('_method', self::getInstance()->getMethod());
    }

    /**
     * Get Accept MIME Type
     *
     * @todo:  refactoring this method, accept types should be stored in static? variable
     * @param  array $allowTypes
     * @return string
     */
    public static function getAccept($allowTypes = [])
    {
        static $accept;

        if (!$accept) {

            // get header from request
            $header = self::getHeader('accept');

            // make array if types
            $header = explode(',', $header);
            $header = array_map('trim', $header);

            // result store
            $types = [];

            foreach ($header as $a) {
                // the default quality is 1.
                $q = 1;
                // check if there is a different quality
                if (strpos($a, ';q=') or strpos($a, '; q=')) {
                    // divide "mime/type;q=X" into two parts: "mime/type" i "X"
                    $res = preg_split('/;([ ]?)q=/', $a);
                    $a = $res[0];
                    $q = $res[1];
                }
                // remove other extension
                if (strpos($a, ';')) {
                    $a = substr($a, 0, strpos($a, ';'));
                }

                // mime-type $a is accepted with the quality $q
                // WARNING: $q == 0 means, that mime-type isn’t supported!
                $types[$a] = (float) $q;
            }
            arsort($types);
            $accept = $types;
        }

        // if no parameter was passed, just return parsed data
        if (empty($allowTypes)) {
            return $accept;
        }

        $mimeTypes = array_map('strtolower', $allowTypes);

        // let’s check our supported types:
        foreach ($accept as $mime => $q) {
            if ($q && in_array($mime, $mimeTypes)) {
                return $mime;
            }
        }
        // no mime-type found
        return null;
    }
    
    /**
     * Check CLI
     *
     * @return bool
     */
    public static function isCli()
    {
        return (PHP_SAPI === 'cli');
    }

    /**
     * Check HTTP
     *
     * @return bool
     */
    public static function isHttp()
    {
        return (PHP_SAPI !== 'cli');
    }

    /**
     * Is this a GET method request?
     *
     * @return bool
     */
    public static function isGet()
    {
        return (self::getInstance()->getMethod() === 'GET');
    }

    /**
     * Is this a POST method request?
     *
     * @return bool
     */
    public static function isPost()
    {
        return (self::getInstance()->getMethod() === 'POST');
    }

    /**
     * Is this a PUT method request?
     *
     * @return bool
     */
    public static function isPut()
    {
        return (self::getInstance()->getMethod() === 'PUT');
    }

    /**
     * Is this a DELETE method request?
     *
     * @return bool
     */
    public static function isDelete()
    {
        return (self::getInstance()->getMethod() === 'DELETE');
    }

    /**
     * Is the request a Javascript XMLHttpRequest?
     *
     * Should work with Prototype/Script.aculo.us, possibly others.
     *
     * @return bool
     */
    public static function isXmlHttpRequest()
    {
        return (self::getHeader('X-Requested-With') == 'XMLHttpRequest');
    }
}


1		<?php
2		/**
3		* Bluz Framework Component
4		*
5		* @copyright Bluz PHP Team
6		* @link https://github.com/bluzphp/framework
7		*/
8
9		/**
10		* @namespace
11		*/
12		namespace Bluz\Proxy;
13
14		use Bluz\Common\Exception\ComponentException;
15		use Bluz\Request\RequestFactory;
16		use Psr\Http\Message\UriInterface;
17		use Zend\Diactoros\ServerRequest as Instance;
18
19		/**
20		* Proxy to Request
21		*
22		* Example of usage
23		* <code>
24		* use Bluz\Proxy\Request;
25		*
26		* Request::getParam('foo');
27		* </code>
28		*
29		* @package Bluz\Proxy
30		* @author Anton Shevchuk
31		*
32		* @method static \Psr\Http\Message\UriInterface getUri()
33		* @see \Zend\Diactoros\RequestTrait::getUri()
34		*
35		* @method static Instance getInstance()
36		*/
37		class Request extends AbstractProxy
38		{
39		/**
40		* @const string HTTP methods
41		*/
42		const METHOD_OPTIONS = 'OPTIONS';
43		const METHOD_GET = 'GET';
44		const METHOD_HEAD = 'HEAD';
45		const METHOD_PATCH = 'PATCH';
46		const METHOD_POST = 'POST';
47		const METHOD_PUT = 'PUT';
48		const METHOD_DELETE = 'DELETE';
49		const METHOD_TRACE = 'TRACE';
50		const METHOD_CONNECT = 'CONNECT';
51
52		/**
53		* @const string HTTP content types
54		*/
55		const TYPE_ANY = '/';
56		const TYPE_HTML = 'text/html';
57		const TYPE_JSON = 'application/json';
58
59		/**
60		* Init instance
61		*
62		* @throws ComponentException
63		*/
64		protected static function initInstance()
65		{
66		throw new ComponentException("Class `Proxy\\Request` required external initialization");
67		}
68
69		/**
70		* Retrieve a member of the $_SERVER super global
71		*
72		* If no $key is passed, returns the entire $_SERVER array.
73		*
74		* @param string $key
75		* @param string $default Default value to use if key not found
76		* @return string Returns null if key does not exist
77		*/
78	4	public static function getServer($key = null, $default = null)
79		{
80	4	return RequestFactory::get($key, self::getInstance()->getServerParams(), $default);
81		}
82
83		/**
84		* Retrieve a member of the $_COOKIE super global
85		*
86		* If no $key is passed, returns the entire $_COOKIE array.
87		*
88		* @param string $key
89		* @param string $default Default value to use if key not found
90		* @return string Returns null if key does not exist
91		*/
92		public static function getCookie($key = null, $default = null)
93		{
94		return RequestFactory::get($key, self::getInstance()->getCookieParams(), $default);
95		}
96		/**
97		* Retrieve a member of the $_ENV super global
98		*
99		* If no $key is passed, returns the entire $_ENV array.
100		*
101		* @param string $key
102		* @param string $default Default value to use if key not found
103		* @return string Returns null if key does not exist
104		*/
105		public static function getEnv($key = null, $default = null)
106		{
107		return RequestFactory::get($key, $_ENV, $default);
108		}
109
110		/**
111		* Search for a header value
112		*
113		* @param string $header
114		* @param mixed $default
115		* @return string
116		*/
117	2	public static function getHeader($header, $default = null)
118		{
119	2	return RequestFactory::getHeader($header, self::getInstance()->getHeaders(), $default);
120		}
121
122		/**
123		* Access values contained in the superglobals as public members
124		* Order of precedence: 1. GET, 2. POST, 3. COOKIE, 4. SERVER, 5. ENV
125		*
126		* @param string $key
127		* @param null $default
128		* @return mixed
129		* @link http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx
130		*/
131	40	public static function getParam($key, $default = null)
132		{
133		switch (true) {
134	40	case ($params = self::getInstance()->getQueryParams()) && isset($params[$key]):
135	3	return $params[$key];
		0 ignored issues – show Bug introduced 2016-06-13 08:44 UTC by Report Bug Copy Issue Report The variable `$params` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
136	38	case ($params = self::getInstance()->getParsedBody()) && isset($params[$key]):
137		return $params[$key];
		0 ignored issues – show Bug introduced 2016-06-13 08:44 UTC by Report Bug Copy Issue Report The variable `$params` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
138	38	case ($params = self::getInstance()->getCookieParams()) && isset($params[$key]):
139		return $params[$key];
		0 ignored issues – show Bug introduced 2016-06-13 08:44 UTC by Report Bug Copy Issue Report The variable `$params` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
140	38	case ($params = self::getInstance()->getServerParams()) && isset($params[$key]):
141		return $params[$key];
		0 ignored issues – show Bug introduced 2016-06-13 08:44 UTC by Report Bug Copy Issue Report The variable `$params` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
142	38	case isset($_ENV[$key]):
143		return $_ENV[$key];
144		default:
145	38	return $default;
146		}
147		}
148
149		/**
150		* Get all params from GET and POST or PUT
151		*
152		* @return array
153		*/
154	3	public static function getParams()
155		{
156	3	$query = (array) self::getInstance()->getQueryParams();
157	3	$body = (array) self::getInstance()->getParsedBody();
158
159	3	return array_merge($body, $query);
160		}
161
162		/**
163		* Get uploaded file
164		*
165		* @param string $name
166		* @return \Zend\Diactoros\UploadedFile
167		*/
168		public static function getFile($name)
169		{
170		return RequestFactory::get($name, self::getInstance()->getUploadedFiles());
171		}
172
173		/**
174		* Get the client's IP address
175		*
176		* @param bool $checkProxy
177		* @return string
178		*/
179		public static function getClientIp($checkProxy = true)
180		{
181		if ($checkProxy && self::getServer('HTTP_CLIENT_IP') != null) {
182		$ip = self::getServer('HTTP_CLIENT_IP');
183		} else {
184		if ($checkProxy && self::getServer('HTTP_X_FORWARDED_FOR') != null) {
185		$ip = self::getServer('HTTP_X_FORWARDED_FOR');
186		} else {
187		$ip = self::getServer('REMOTE_ADDR');
188		}
189		}
190		return $ip;
191		}
192
193		/**
194		* Get module
195		*
196		* @return string
197		*/
198	38	public static function getModule()
199		{
200	38	return self::getParam('_module', Router::getDefaultModule());
201		}
202
203		/**
204		* Get controller
205		*
206		* @return string
207		*/
208	38	public static function getController()
209		{
210	38	return self::getParam('_controller', Router::getDefaultController());
211		}
212
213		/**
214		* Get method
215		*
216		* @return string
217		*/
218		public static function getMethod()
219		{
220		return self::getParam('_method', self::getInstance()->getMethod());
221		}
222
223		/**
224		* Get Accept MIME Type
225		*
226		* @todo: refactoring this method, accept types should be stored in static? variable
227		* @param array $allowTypes
228		* @return string
229		*/
230	2	public static function getAccept($allowTypes = [])
231		{
232	2	static $accept;
233
234	2	if (!$accept) {
235
236		// get header from request
237	1	$header = self::getHeader('accept');
238
239		// make array if types
240	1	$header = explode(',', $header);
241	1	$header = array_map('trim', $header);
242
243		// result store
244	1	$types = [];
245
246	1	foreach ($header as $a) {
247		// the default quality is 1.
248	1	$q = 1;
249		// check if there is a different quality
250	1	if (strpos($a, ';q=') or strpos($a, '; q=')) {
251		// divide "mime/type;q=X" into two parts: "mime/type" i "X"
252		$res = preg_split('/;([ ]?)q=/', $a);
253		$a = $res[0];
254		$q = $res[1];
255		}
256		// remove other extension
257	1	if (strpos($a, ';')) {
258		$a = substr($a, 0, strpos($a, ';'));
259		}
260
261		// mime-type $a is accepted with the quality $q
262		// WARNING: $q == 0 means, that mime-type isn’t supported!
263	1	$types[$a] = (float) $q;
264		}
265	1	arsort($types);
266	1	$accept = $types;
267		}
268
269		// if no parameter was passed, just return parsed data
270	2	if (empty($allowTypes)) {
271		return $accept;
272		}
273
274	2	$mimeTypes = array_map('strtolower', $allowTypes);
275
276		// let’s check our supported types:
277	2	foreach ($accept as $mime => $q) {
278	2	if ($q && in_array($mime, $mimeTypes)) {
279	2	return $mime;
280		}
281		}
282		// no mime-type found
283		return null;
284		}
285
286		/**
287		* Check CLI
288		*
289		* @return bool
290		*/
291		public static function isCli()
292		{
293		return (PHP_SAPI === 'cli');
294		}
295
296		/**
297		* Check HTTP
298		*
299		* @return bool
300		*/
301	1	public static function isHttp()
302		{
303	1	return (PHP_SAPI !== 'cli');
304		}
305
306		/**
307		* Is this a GET method request?
308		*
309		* @return bool
310		*/
311		public static function isGet()
312		{
313		return (self::getInstance()->getMethod() === 'GET');
314		}
315
316		/**
317		* Is this a POST method request?
318		*
319		* @return bool
320		*/
321		public static function isPost()
322		{
323		return (self::getInstance()->getMethod() === 'POST');
324		}
325
326		/**
327		* Is this a PUT method request?
328		*
329		* @return bool
330		*/
331		public static function isPut()
332		{
333		return (self::getInstance()->getMethod() === 'PUT');
334		}
335
336		/**
337		* Is this a DELETE method request?
338		*
339		* @return bool
340		*/
341		public static function isDelete()
342		{
343		return (self::getInstance()->getMethod() === 'DELETE');
344		}
345
346		/**
347		* Is the request a Javascript XMLHttpRequest?
348		*
349		* Should work with Prototype/Script.aculo.us, possibly others.
350		*
351		* @return bool
352		*/
353	2	public static function isXmlHttpRequest()
354		{
355	2	return (self::getHeader('X-Requested-With') == 'XMLHttpRequest');
356		}
357		}
358

bluzphp / framework

Pull Request — master (#363)

Request B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

20 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like