Uploader::save() - Code Metrics - cadmium-org/cadmium-cms - Measure and Improve Code Quality continuously with Scrutinizer

Uploader::save() C
last analyzed 2017-10-02 14:48 UTC

↳ Parent: Uploader

Complexity

Conditions	11
Paths	9

Size

Total Lines	46
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	46
rs	5.2653
c	0
b	0
f	0
cc	11
eloc	14
nc	9
nop	2

How to fix Complexity

<?php

/**
 * @package Cadmium\System\Utils
 * @author Anton Romanov
 * @copyright Copyright (c) 2015-2017, Anton Romanov
 * @link http://cadmium-cms.com
 */

namespace Utils {

	use Utils\Messages, Utils\Popup, Explorer, Language, Request;

	abstract class Uploader {

		private static $base_name = null, $file_name = null;

		/**
		 * Convert a PHP upload error to a usable error code
		 */

		private static function getErrorCode(int $error) : string {

			if ($error === UPLOAD_ERR_INI_SIZE)         return 'UPLOADER_ERROR_INI_SIZE';

			if ($error === UPLOAD_ERR_FORM_SIZE)        return 'UPLOADER_ERROR_FORM_SIZE';

			if ($error === UPLOAD_ERR_PARTIAL)          return 'UPLOADER_ERROR_PARTIAL';

			if ($error === UPLOAD_ERR_NO_FILE)          return 'UPLOADER_ERROR_NO_FILE';

			if ($error === UPLOAD_ERR_NO_TMP_DIR)       return 'UPLOADER_ERROR_NO_TMP_DIR';

			if ($error === UPLOAD_ERR_CANT_WRITE)       return 'UPLOADER_ERROR_CANT_WRITE';

			if ($error === UPLOAD_ERR_EXTENSION)        return 'UPLOADER_ERROR_EXTENSION';

			# ------------------------

			return 'UPLOADER_ERROR_UNKNOWN';
		}

		/**
		 * Display an error message
		 *
		 * @return false : the method always returns false
		 */

		private static function displayError(string $phrase, bool $popup) : bool {


			$text = Language::get($phrase);

			if (!$popup) Messages::set('error', $text); else Popup::set('negative', $text);

			# ------------------------

			return false;
		}

		/**
		 * Save an uploaded file
		 *
		 * @return true|string|false : true on success, an error code on failure, or false if there are no uploaded files
		 */

		public static function save(string $name, string $dir_name) {

			if (false === ($file = Request::file($name))) return false;

			# Check for upload errors

			if ($file['error'] !== UPLOAD_ERR_OK) return self::getErrorCode($file['error']);

			# Check for secure upload

			if (!is_uploaded_file($file['tmp_name'])) return 'UPLOADER_ERROR_SECURITY';

			# Check size

			if ($file['size'] > CONFIG_UPLOADS_MAX_SIZE) return 'UPLOADER_ERROR_SIZE';

			# Check file extension

			$extensions = ['php', 'phtml', 'php3', 'php4', 'php5', 'phps'];

			$extension = strtolower(Explorer::getExtension($file['name'], false));

			if (in_array($extension, $extensions, true)) return 'UPLOADER_ERROR_TYPE';

			# Check target directory

			if (!Explorer::isDir($dir_name) && !Explorer::createDir($dir_name)) return 'UPLOADER_ERROR_DIR';

			# Check target file

			$base_name = basename($file['name']); $file_name = ($dir_name . '/' . $base_name);

			if (Explorer::isDir($file_name) || Explorer::isFile($file_name)) return 'UPLOADER_ERROR_EXISTS';

			# Save uploaded file

			if (!@move_uploaded_file($file['tmp_name'], $file_name)) return 'UPLOADER_ERROR_SAVE';

			# Set upload data

			self::$base_name = $base_name; self::$file_name = $file_name;

			# ------------------------

			return true;
		}

		/**
		 * Save an uploaded file and display an error if appeared
		 *
		 * @param $popup : tells to display a popup error message instead of a regular message
		 *
		 * @return bool : true on success or false on failure
		 */

		public static function handle(string $name, string $dir_name, bool $popup = false) : bool {

			$result = self::save($name, $dir_name);

			if (is_string($result)) return self::displayError($result, $popup);

			# ------------------------

			return $result;
		}

		/**
		 * Get a basename of a last successfully uploaded file
		 */

		public static function getBasename() : string {

			return self::$base_name;
		}

		/**
		 * Get a filename of a last successfully uploaded file
		 */

		public static function getFilename() : string {

			return self::$file_name;
		}
	}
}


1		<?php
2
3		/**
4		* @package Cadmium\System\Utils
5		* @author Anton Romanov
6		* @copyright Copyright (c) 2015-2017, Anton Romanov
7		* @link http://cadmium-cms.com
8		*/
9
10		namespace Utils {
11
12		use Utils\Messages, Utils\Popup, Explorer, Language, Request;
13
14		abstract class Uploader {
15
16		private static $base_name = null, $file_name = null;
17
18		/**
19		* Convert a PHP upload error to a usable error code
20		*/
21
22		private static function getErrorCode(int $error) : string {
23
24		if ($error === UPLOAD_ERR_INI_SIZE) return 'UPLOADER_ERROR_INI_SIZE';
25
26		if ($error === UPLOAD_ERR_FORM_SIZE) return 'UPLOADER_ERROR_FORM_SIZE';
27
28		if ($error === UPLOAD_ERR_PARTIAL) return 'UPLOADER_ERROR_PARTIAL';
29
30		if ($error === UPLOAD_ERR_NO_FILE) return 'UPLOADER_ERROR_NO_FILE';
31
32		if ($error === UPLOAD_ERR_NO_TMP_DIR) return 'UPLOADER_ERROR_NO_TMP_DIR';
33
34		if ($error === UPLOAD_ERR_CANT_WRITE) return 'UPLOADER_ERROR_CANT_WRITE';
35
36		if ($error === UPLOAD_ERR_EXTENSION) return 'UPLOADER_ERROR_EXTENSION';
37
38		# ------------------------
39
40		return 'UPLOADER_ERROR_UNKNOWN';
41		}
42
43		/**
44		* Display an error message
45		*
46		* @return false : the method always returns false
47		*/
48
49	View Code Duplication	private static function displayError(string $phrase, bool $popup) : bool {
		0 ignored issues – show Duplication introduced 2017-06-17 18:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
50
51		$text = Language::get($phrase);
52
53		if (!$popup) Messages::set('error', $text); else Popup::set('negative', $text);
54
55		# ------------------------
56
57		return false;
58		}
59
60		/**
61		* Save an uploaded file
62		*
63		* @return true\|string\|false : true on success, an error code on failure, or false if there are no uploaded files
64		*/
65
66		public static function save(string $name, string $dir_name) {
67
68		if (false === ($file = Request::file($name))) return false;
69
70		# Check for upload errors
71
72		if ($file['error'] !== UPLOAD_ERR_OK) return self::getErrorCode($file['error']);
73
74		# Check for secure upload
75
76		if (!is_uploaded_file($file['tmp_name'])) return 'UPLOADER_ERROR_SECURITY';
77
78		# Check size
79
80		if ($file['size'] > CONFIG_UPLOADS_MAX_SIZE) return 'UPLOADER_ERROR_SIZE';
81
82		# Check file extension
83
84		$extensions = ['php', 'phtml', 'php3', 'php4', 'php5', 'phps'];
85
86		$extension = strtolower(Explorer::getExtension($file['name'], false));
87
88		if (in_array($extension, $extensions, true)) return 'UPLOADER_ERROR_TYPE';
89
90		# Check target directory
91
92		if (!Explorer::isDir($dir_name) && !Explorer::createDir($dir_name)) return 'UPLOADER_ERROR_DIR';
93
94		# Check target file
95
96		$base_name = basename($file['name']); $file_name = ($dir_name . '/' . $base_name);
97
98		if (Explorer::isDir($file_name) \|\| Explorer::isFile($file_name)) return 'UPLOADER_ERROR_EXISTS';
99
100		# Save uploaded file
101
102		if (!@move_uploaded_file($file['tmp_name'], $file_name)) return 'UPLOADER_ERROR_SAVE';
103
104		# Set upload data
105
106		self::$base_name = $base_name; self::$file_name = $file_name;
107
108		# ------------------------
109
110		return true;
111		}
112
113		/**
114		* Save an uploaded file and display an error if appeared
115		*
116		* @param $popup : tells to display a popup error message instead of a regular message
117		*
118		* @return bool : true on success or false on failure
119		*/
120
121		public static function handle(string $name, string $dir_name, bool $popup = false) : bool {
122
123		$result = self::save($name, $dir_name);
124
125		if (is_string($result)) return self::displayError($result, $popup);
126
127		# ------------------------
128
129		return $result;
130		}
131
132		/**
133		* Get a basename of a last successfully uploaded file
134		*/
135
136		public static function getBasename() : string {
137
138		return self::$base_name;
139		}
140
141		/**
142		* Get a filename of a last successfully uploaded file
143		*/
144
145		public static function getFilename() : string {
146
147		return self::$file_name;
148		}
149		}
150		}
151

cadmium-org / cadmium-cms

Uploader::save() C last analyzed 2017-10-02 14:48 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Uploader::save() C
last analyzed 2017-10-02 14:48 UTC