Config::set() - Code Metrics - Inspection of "Improve Router class and fix some issue, bugs" - tnhfw/tnh-fw - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0.0-dev ( 407604...83bedf )

by nguereza

created 2020-02-24 13:53 UTC

Config::set() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php
	defined('ROOT_PATH') || exit('Access denied');
	/**
	 * TNH Framework
	 *
	 * A simple PHP framework using HMVC architecture
	 *
	 * This content is released under the GNU GPL License (GPL)
	 *
	 * Copyright (C) 2017 Tony NGUEREZA
	 *
	 * This program is free software; you can redistribute it and/or
	 * modify it under the terms of the GNU General Public License
	 * as published by the Free Software Foundation; either version 3
	 * of the License, or (at your option) any later version.
	 *
	 * This program is distributed in the hope that it will be useful,
	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	 * GNU General Public License for more details.
	 *
	 * You should have received a copy of the GNU General Public License
	 * along with this program; if not, write to the Free Software
	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
	*/

	class Config{
		
		/**
		 * The list of loaded configuration
		 * @var array
		 */
		private static $config = array();

		/**
		 * The logger instance
		 * @var Log
		 */
		private static $logger;

		/**
		 * The signleton of the logger
		 * @return Object the Log instance
		 */
		private static function getLogger(){
			if(self::$logger == null){
				$logger = array();
				$logger[0] =& class_loader('Log', 'classes');
				$logger[0]->setLogger('Library::Config');
				self::$logger = $logger[0];
			}
			return self::$logger;			
		}

		/**
		 * Set the log instance for future use
		 * @param Log $logger the log object
		 * @return Log the log instance
		 */
		public static function setLogger($logger){
			self::$logger = $logger;
			return self::$logger;
		}

		/**
		 * Initialize the configuration by loading all the configuration from config file
		 */
		public static function init(){
			$logger = static::getLogger();
			$logger->debug('Initialization of the configuration');
			self::$config = & load_configurations();
			self::setBaseUrlUsingServerVar();
			if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
				$logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
			}
			$logger->info('Configuration initialized successfully');
			$logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
		}

		/**
		 * Get the configuration item value
		 * @param  string $item    the configuration item name to get
		 * @param  mixed $default the default value to use if can not find the config item in the list
		 * @return mixed          the config value if exist or the default value
		 */
		public static function get($item, $default = null){
			$logger = static::getLogger();
			if(array_key_exists($item, self::$config)){
				return self::$config[$item];
			}
			$logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
			return $default;
		}

		/**
		 * Set the configuration item value
		 * @param string $item  the config item name to set
		 * @param mixed $value the config item value
		 */
		public static function set($item, $value){
			self::$config[$item] = $value;
		}

		/**
		 * Get all the configuration values
		 * @return array the config values
		 */
		public static function getAll(){
			return self::$config;
		}

		/**
		 * Set the configuration values bu merged with the existing configuration
		 * @param array $config the config values to add in the configuration list
		 */
		public static function setAll(array $config = array()){
			self::$config = array_merge(self::$config, $config);
		}

		/**
		 * Delete the configuration item in the list
		 * @param  string $item the config item name to be deleted
		 * @return boolean true if the item exists and is deleted successfully otherwise will return false.
		 */
		public static function delete($item){
			$logger = static::getLogger();
			if(array_key_exists($item, self::$config)){
				$logger->info('Delete config item ['.$item.']');
				unset(self::$config[$item]);
				return true;
			}
			else{
				$logger->warning('Config item ['.$item.'] to be deleted does not exists');
				return false;
			}
		}

		/**
		 * Load the configuration file. This an alias to Loader::config()
		 * @param  string $config the config name to be loaded
		 */
		public static function load($config){
			Loader::config($config);
		}

		/**
		 * Set the configuration for "base_url" if is not set in the configuration
		 */
		private static function setBaseUrlUsingServerVar(){
			$logger = static::getLogger();
			if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){
				if(ENVIRONMENT == 'production'){

					$logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
				}
				$baseUrl = null;
				$protocol = 'http';
				if(is_https()){
					$protocol = 'https';
				}
				$protocol .='://';

				if (isset($_SERVER['SERVER_ADDR'])){
					$baseUrl = $_SERVER['SERVER_ADDR'];
					//check if the server is running under IPv6
					if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
						$baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
					}
					$serverPort = 80;
					if (isset($_SERVER['SERVER_PORT'])) {
						$serverPort = $_SERVER['SERVER_PORT'];
					}
					$port = '';
					if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){
						$port = ':'.$serverPort;

					}
					$port = ((($serverPort != '80' && ! is_https()) || ($serverPort != '443' && is_https())) ? ':' . $serverPort : '');
					$baseUrl = $protocol . $baseUrl . $port . substr(
																		$_SERVER['SCRIPT_NAME'], 
																		0, 
																		strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
																	);
				}
				else{
					$logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
					$baseUrl = 'http://localhost/';
				}
				self::set('base_url', $baseUrl);
			}
			self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
		}
	}


1			<?php
2			defined('ROOT_PATH') \|\| exit('Access denied');
3			/**
4			* TNH Framework
5			*
6			* A simple PHP framework using HMVC architecture
7			*
8			* This content is released under the GNU GPL License (GPL)
9			*
10			* Copyright (C) 2017 Tony NGUEREZA
11			*
12			* This program is free software; you can redistribute it and/or
13			* modify it under the terms of the GNU General Public License
14			* as published by the Free Software Foundation; either version 3
15			* of the License, or (at your option) any later version.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU General Public License for more details.
21			*
22			* You should have received a copy of the GNU General Public License
23			* along with this program; if not, write to the Free Software
24			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25			*/
26
27			class Config{
28
29			/**
30			* The list of loaded configuration
31			* @var array
32			*/
33			private static $config = array();
34
35			/**
36			* The logger instance
37			* @var Log
38			*/
39			private static $logger;
40
41			/**
42			* The signleton of the logger
43			* @return Object the Log instance
44			*/
45			private static function getLogger(){
46			if(self::$logger == null){
47			$logger = array();
48			$logger[0] =& class_loader('Log', 'classes');
49			$logger[0]->setLogger('Library::Config');
50			self::$logger = $logger[0];
51			}
52			return self::$logger;
53			}
54
55			/**
56			* Set the log instance for future use
57			* @param Log $logger the log object
58			* @return Log the log instance
59			*/
60			public static function setLogger($logger){
61			self::$logger = $logger;
62			return self::$logger;
63			}
64
65			/**
66			* Initialize the configuration by loading all the configuration from config file
67			*/
68			public static function init(){
69			$logger = static::getLogger();
70			$logger->debug('Initialization of the configuration');
71			self::$config = & load_configurations();
72			self::setBaseUrlUsingServerVar();
73			if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
74			$logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
75			}
76			$logger->info('Configuration initialized successfully');
77			$logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
78			}
79
80			/**
81			* Get the configuration item value
82			* @param string $item the configuration item name to get
83			* @param mixed $default the default value to use if can not find the config item in the list
84			* @return mixed the config value if exist or the default value
85			*/
86			public static function get($item, $default = null){
87			$logger = static::getLogger();
88			if(array_key_exists($item, self::$config)){
89			return self::$config[$item];
90			}
91			$logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
92			return $default;
93			}
94
95			/**
96			* Set the configuration item value
97			* @param string $item the config item name to set
98			* @param mixed $value the config item value
99			*/
100			public static function set($item, $value){
101			self::$config[$item] = $value;
102			}
103
104			/**
105			* Get all the configuration values
106			* @return array the config values
107			*/
108			public static function getAll(){
109			return self::$config;
110			}
111
112			/**
113			* Set the configuration values bu merged with the existing configuration
114			* @param array $config the config values to add in the configuration list
115			*/
116			public static function setAll(array $config = array()){
117			self::$config = array_merge(self::$config, $config);
118			}
119
120			/**
121			* Delete the configuration item in the list
122			* @param string $item the config item name to be deleted
123			* @return boolean true if the item exists and is deleted successfully otherwise will return false.
124			*/
125			public static function delete($item){
126			$logger = static::getLogger();
127			if(array_key_exists($item, self::$config)){
128			$logger->info('Delete config item ['.$item.']');
129			unset(self::$config[$item]);
130			return true;
131			}
132			else{
133			$logger->warning('Config item ['.$item.'] to be deleted does not exists');
134			return false;
135			}
136			}
137
138			/**
139			* Load the configuration file. This an alias to Loader::config()
140			* @param string $config the config name to be loaded
141			*/
142			public static function load($config){
143			Loader::config($config);
144			}
145
146			/**
147			* Set the configuration for "base_url" if is not set in the configuration
148			*/
149			private static function setBaseUrlUsingServerVar(){
150			$logger = static::getLogger();
151			if (! isset(self::$config['base_url']) \|\| ! is_url(self::$config['base_url'])){
152			if(ENVIRONMENT == 'production'){
			0 ignored issues – show introduced 2020-02-18 21:51 UTC by Report Bug Copy Issue Report The condition `ENVIRONMENT == 'production'` is always `false`. Loading history...
153			$logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
154			}
155			$baseUrl = null;
156			$protocol = 'http';
157			if(is_https()){
158			$protocol = 'https';
159			}
160			$protocol .='://';
161
162			if (isset($_SERVER['SERVER_ADDR'])){
163			$baseUrl = $_SERVER['SERVER_ADDR'];
164			//check if the server is running under IPv6
165			if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
166			$baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
167			}
168			$serverPort = 80;
169			if (isset($_SERVER['SERVER_PORT'])) {
170			$serverPort = $_SERVER['SERVER_PORT'];
171			}
172			$port = '';
173			if($serverPort && ((is_https() && $serverPort != 443) \|\| (!is_https() && $serverPort != 80))){
174			$port = ':'.$serverPort;
			0 ignored issues – show Unused Code introduced 2020-02-24 13:56 UTC by Report Bug Copy Issue Report The assignment to `$port` is dead and can be removed. Loading history...
175			}
176			$port = ((($serverPort != '80' && ! is_https()) \|\| ($serverPort != '443' && is_https())) ? ':' . $serverPort : '');
177			$baseUrl = $protocol . $baseUrl . $port . substr(
178			$_SERVER['SCRIPT_NAME'],
179			0,
180			strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
181			);
182			}
183			else{
184			$logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
185			$baseUrl = 'http://localhost/';
186			}
187			self::set('base_url', $baseUrl);
188			}
189			self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
190			}
191			}
192

tnhfw / tnh-fw

Push — 1.0.0-dev ( 407604...83bedf )

Config::set() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like