CIPHPUnitTestSuperGlobal::convertToBytes() - Code Metrics - Inspection of "Add upload testing" - kenjis/ci-phpunit-test - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#157)

by Kenji

created 2016-12-08 04:35 UTC

CIPHPUnitTestSuperGlobal::convertToBytes() B

↳ Parent: CIPHPUnitTestSuperGlobal

Complexity

Conditions	5
Paths	5

Size

Total Lines	28
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	18
nc	5
nop	1
dl	0
loc	28
rs	8.439
c	0
b	0
f	0

<?php
/**
 * Part of ci-phpunit-test
 *
 * @author     Kenji Suzuki <https://github.com/kenjis>
 * @license    MIT License
 * @copyright  2015 Kenji Suzuki
 * @link       https://github.com/kenjis/ci-phpunit-test
 */

class CIPHPUnitTestSuperGlobal
namespace YourVendor;

class YourClass { }
{
	public static function set_Global($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);
    }
}
	{
		$GLOBALS[$name] = $value;
	}

	public function set_POST($params)
// 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 (is_array($params))
		{
			if ($_SERVER['REQUEST_METHOD'] === 'POST')
			{
				$_POST = $params;
			}
		}
	}

	public function set_FILES(array $files)
// 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 (count($files) > 1)
		{
			throw new LogicException('Invalid $_FILES: '.var_export($files, true));
		}

		$field = array_keys($files)[0];
		$is_multiple = is_array($files[$field]['tmp_name']);

		if ($is_multiple)
		{
			throw new LogicException('Cannot handle multiple file upload. $_FILES: '.var_export($files, true));
		}

		// Handle single file
		$file =& $files[$field];

		if (! file_exists($file['tmp_name']))
		{
			$file['error'] = UPLOAD_ERR_NO_FILE;
			$file['type'] = '';
			$file['size'] = 0;

			$_FILES = $files;
			return;
		}

		$file['size'] = filesize($file['tmp_name']);

		$upload_max_filesize = $this->convertToBytes(ini_get('upload_max_filesize'));
		if ($upload_max_filesize < $file['size'])
		{
			$file['error'] = UPLOAD_ERR_INI_SIZE;

			$_FILES = $files;
			return;
		}

		$file['error'] = UPLOAD_ERR_OK;

		$_FILES = $files;
		return;
	}

	private function convertToBytes($value)
	{
		if (is_numeric($value))
		{
			return $value;
		}
		else
		{
			$value_length = strlen($value);
			$number = substr($value, 0, $value_length - 1);
			$unit = strtolower(substr($value, $value_length - 1));

			switch ($unit)
			{
				case 'k':
					$number *= 1024;
					break;
				case 'm':
					$number *= 1024 * 1024;
					break;
				case 'g':
					$number *= 1024 * 1024 * 1024;
					break;
			}

			return $number;
		}
	}

	public function set_GET(&$argv, $params)
// 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 (is_string($argv))
		{
			$query_string = $this->getQueryString($argv);
			if ($query_string !== null)
			{
				// Set $_GET if URI string has query string
				parse_str($query_string, $_GET);
				// Remove query string from URI string
				$argv = substr($argv, 0, -strlen($query_string)-1);
			}
		}

		if (is_array($params))
		{
			if ($_SERVER['REQUEST_METHOD'] === 'GET')
			{
				// if GET params are passed, overwrite $_GET
				if ($params !== [])
				{
					$_GET = $params;
				}
			}
		}
	}

	public function set_SERVER_REQUEST_URI($argv)
// 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);
    }
}
	{
		$path = '';
		if (is_string($argv))
		{
			$path = $argv;
		}
		elseif (is_array($argv))
		{
			// Generate URI path from array of controller, method, arg, ...
			$path = implode('/', $argv);
		}

		if ($_GET !== [])
		{
			$_SERVER['REQUEST_URI'] =
				'/' . $path . '?'
				. http_build_query($_GET);
		}
		else
		{
			$_SERVER['REQUEST_URI'] = '/' . $path;
		}
	}

	/**
	 * Parse URI string and Get query string
	 * 
	 * @param string $uri
	 * @return string|null
	 * @throws LogicException
	 */
	protected function getQueryString($uri)
	{
		$query_string = parse_url('http://localhost/'.$uri, PHP_URL_QUERY);

		if ($query_string === false)
		{
			throw new LogicException('Bad URI string: ' . $uri);
		}

		return $query_string;
	}

	/**
	 * Set HTTP request header to $_SERVER
	 * 
	 * @param string $name  header name
	 * @param string $value value
	 */
	public function set_SERVER_HttpHeader($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);
    }
}
	{
		$normalized_name = str_replace('-', '_', strtoupper($name));

		if (
			$normalized_name === 'CONTENT_LENGTH' 
			|| $normalized_name === 'CONTENT_TYPE'
		)
		{
			$key = $normalized_name;
		}
		else
		{
			$key = 'HTTP_' . $normalized_name;
		}

		$_SERVER[$key] = $value;
	}
}


1			<?php
2			/**
3			* Part of ci-phpunit-test
4			*
5			* @author Kenji Suzuki <https://github.com/kenjis>
6			* @license MIT License
7			* @copyright 2015 Kenji Suzuki
8			* @link https://github.com/kenjis/ci-phpunit-test
9			*/
10
11			class CIPHPUnitTestSuperGlobal
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
12			{
13			public static function set_Global($name, $value)
			0 ignored issues – show Coding Style introduced 2015-12-03 05:03 UTC by Report Bug Copy Issue Report `set_Global` uses the super-global variable `$GLOBALS` 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...
14			{
15			$GLOBALS[$name] = $value;
16			}
17
18			public function set_POST($params)
			0 ignored issues – show Coding Style introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report `set_POST` uses the super-global variable `$_SERVER` 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-11-20 22:47 UTC by Report Bug Copy Issue Report `set_POST` 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...
19			{
20			if (is_array($params))
21			{
22			if ($_SERVER['REQUEST_METHOD'] === 'POST')
23			{
24			$_POST = $params;
25			}
26			}
27			}
28
29			public function set_FILES(array $files)
			0 ignored issues – show Coding Style introduced 2016-12-06 08:44 UTC by Report Bug Copy Issue Report `set_FILES` 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...
30			{
31			if (count($files) > 1)
32			{
33			throw new LogicException('Invalid $_FILES: '.var_export($files, true));
34			}
35
36			$field = array_keys($files)[0];
37			$is_multiple = is_array($files[$field]['tmp_name']);
38
39			if ($is_multiple)
40			{
41			throw new LogicException('Cannot handle multiple file upload. $_FILES: '.var_export($files, true));
42			}
43
44			// Handle single file
45			$file =& $files[$field];
46
47			if (! file_exists($file['tmp_name']))
48			{
49			$file['error'] = UPLOAD_ERR_NO_FILE;
50			$file['type'] = '';
51			$file['size'] = 0;
52
53			$_FILES = $files;
54			return;
55			}
56
57			$file['size'] = filesize($file['tmp_name']);
58
59			$upload_max_filesize = $this->convertToBytes(ini_get('upload_max_filesize'));
60			if ($upload_max_filesize < $file['size'])
61			{
62			$file['error'] = UPLOAD_ERR_INI_SIZE;
63
64			$_FILES = $files;
65			return;
66			}
67
68			$file['error'] = UPLOAD_ERR_OK;
69
70			$_FILES = $files;
71			return;
72			}
73
74			private function convertToBytes($value)
75			{
76			if (is_numeric($value))
77			{
78			return $value;
79			}
80			else
81			{
82			$value_length = strlen($value);
83			$number = substr($value, 0, $value_length - 1);
84			$unit = strtolower(substr($value, $value_length - 1));
85
86			switch ($unit)
87			{
88			case 'k':
89			$number *= 1024;
90			break;
91			case 'm':
92			$number = 1024 1024;
93			break;
94			case 'g':
95			$number = 1024 1024 * 1024;
96			break;
97			}
98
99			return $number;
100			}
101			}
102
103			public function set_GET(&$argv, $params)
			0 ignored issues – show Coding Style introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report `set_GET` 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-11-20 22:47 UTC by Report Bug Copy Issue Report `set_GET` uses the super-global variable `$_SERVER` 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...
104			{
105			if (is_string($argv))
106			{
107			$query_string = $this->getQueryString($argv);
108			if ($query_string !== null)
109			{
110			// Set $_GET if URI string has query string
111			parse_str($query_string, $_GET);
112			// Remove query string from URI string
113			$argv = substr($argv, 0, -strlen($query_string)-1);
114			}
115			}
116
117			if (is_array($params))
118			{
119			if ($_SERVER['REQUEST_METHOD'] === 'GET')
120			{
121			// if GET params are passed, overwrite $_GET
122			if ($params !== [])
123			{
124			$_GET = $params;
125			}
126			}
127			}
128			}
129
130			public function set_SERVER_REQUEST_URI($argv)
			0 ignored issues – show Coding Style introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report `set_SERVER_REQUEST_URI` 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-11-20 22:47 UTC by Report Bug Copy Issue Report `set_SERVER_REQUEST_URI` uses the super-global variable `$_SERVER` 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...
131			{
132			$path = '';
133			if (is_string($argv))
134			{
135			$path = $argv;
136			}
137			elseif (is_array($argv))
138			{
139			// Generate URI path from array of controller, method, arg, ...
140			$path = implode('/', $argv);
141			}
142
143			if ($_GET !== [])
144			{
145			$_SERVER['REQUEST_URI'] =
146			'/' . $path . '?'
147			. http_build_query($_GET);
148			}
149			else
150			{
151			$_SERVER['REQUEST_URI'] = '/' . $path;
152			}
153			}
154
155			/**
156			* Parse URI string and Get query string
157			*
158			* @param string $uri
159			* @return string\|null
160			* @throws LogicException
161			*/
162			protected function getQueryString($uri)
163			{
164			$query_string = parse_url('http://localhost/'.$uri, PHP_URL_QUERY);
165
166			if ($query_string === false)
167			{
168			throw new LogicException('Bad URI string: ' . $uri);
169			}
170
171			return $query_string;
172			}
173
174			/**
175			* Set HTTP request header to $_SERVER
176			*
177			* @param string $name header name
178			* @param string $value value
179			*/
180			public function set_SERVER_HttpHeader($name, $value)
			0 ignored issues – show Coding Style introduced 2015-11-20 22:47 UTC by Report Bug Copy Issue Report `set_SERVER_HttpHeader` uses the super-global variable `$_SERVER` 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...
181			{
182			$normalized_name = str_replace('-', '_', strtoupper($name));
183
184			if (
185			$normalized_name === 'CONTENT_LENGTH'
186			\|\| $normalized_name === 'CONTENT_TYPE'
187			)
188			{
189			$key = $normalized_name;
190			}
191			else
192			{
193			$key = 'HTTP_' . $normalized_name;
194			}
195
196			$_SERVER[$key] = $value;
197			}
198			}
199

kenjis / ci-phpunit-test

Pull Request — master (#157)

CIPHPUnitTestSuperGlobal::convertToBytes() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like