Config::isConfigured() - Code Metrics - Inspection of "change scrutinizr php version" - psfs/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 58ddad...5e153e )

by Fran

created 2017-02-17 23:43 UTC

Config::isConfigured() B

↳ Parent: Config

Complexity

Conditions	5
Paths	8

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	9
nc	8
nop	0
dl	0
loc	14
ccs	9
cts	9
cp	1
crap	5
rs	8.8571
c	0
b	0
f	0

<?php

namespace PSFS\base\config;


use PSFS\base\Cache;
use PSFS\base\exception\ConfigException;
use PSFS\base\Logger;
use PSFS\base\Request;
use PSFS\base\types\SingletonTrait;

/**
 * Class Config
 * @package PSFS\base\config
 */
class Config
{
    use SingletonTrait;
    const DEFAULT_LANGUAGE = "es";
    const DEFAULT_ENCODE = "UTF-8";
    const DEFAULT_CTYPE = "text/html";
    const DEFAULT_DATETIMEZONE = "Europe/Madrid";

    const CONFIG_FILE = 'config.json';

    protected $config = array();
    static public $defaults = array(
        "db_host" => "localhost",
        "db_port" => "3306",
        "default_language" => "es_ES",
        "debug" => true,
        "front.version" => "v1",
        "version" => "v1",
    );
    static public $required = array('db_host', 'db_port', 'db_name', 'db_user', 'db_password', 'home_action', 'default_language', 'debug');

    static public $encrypted = array('db_password');
    static public $optional = [
        'platform_name', // Platform name
        'restricted', // Restrict the web access
        'admin_login', // Enable web login for admin
        'logger.phpFire', // Enable phpFire to trace the logs in the browser
        'logger.memory', // Enable log memory usage un traces
        'poweredBy', // Show PoweredBy header customized
        'author', // Author for auto generated files
        'author_email', // Author email for auto generated files
        'version', // Platform version(for cache purposes)
        'front.version', // Static resources version
        'cors.enabled', // Enable CORS (regex with the domains, * for all)
        'pagination.limit', // Pagination limit for autogenerated api admin
        'api.secret', // Secret passphrase to securize the api
        'api.admin', // Enable de autogenerated api admin(wok)
        'log.level', // Max log level(default INFO)
        'admin_action', // Default admin url when access to /admin
        'cache.var', // Static cache var
        'twig.auto_reload', // Enable or disable auto reload templates for twig
        'modules.extend', // Variable for extending the current functionality
    ];
    protected $debug = false;

    /**
     * Config Constructor
     */
    public function __construct()
    {
        $this->init();
    }

    /**
     * Method that load the configuration data into the system
     * @return Config
     */
    protected function init()
    {
        if (file_exists(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE)) {
            $this->loadConfigData();
        }
        return $this;
    }

    /**
     * Method that saves the configuration
     * @param array $data
     * @param array $extra
     * @return array
     */
    protected static function saveConfigParams(array $data, array $extra)
    {
        Logger::log('Saving required config parameters');
        //En caso de tener parámetros nuevos los guardamos
        if (array_key_exists('label', $extra) && is_array($extra['label'])) {
            foreach ($extra['label'] as $index => $field) {
                if (array_key_exists($index, $extra['value']) && !empty($extra['value'][$index])) {
                    /** @var $data array */
                    $data[$field] = $extra['value'][$index];
                }
            }
        }
        return $data;
    }

    /**
     * Method that saves the extra parameters into the configuration
     * @param array $data
     * @return array
     */
    protected static function saveExtraParams(array $data)
    {
        $final_data = array();
        if (count($data) > 0) {
            Logger::log('Saving extra configuration parameters');
            foreach ($data as $key => $value) {
                if (null !== $value || $value !== '') {
                    $final_data[$key] = $value;
                }
            }
        }
        return $final_data;
    }

    /**
     * Method that returns if the system is in debug mode
     * @return boolean
     */
    public function getDebugMode()
    {
        return $this->debug;
    }

    /**
     * Method that checks if the platform is proper configured
     * @return boolean
     */
    public function isConfigured()
    {
        Logger::log('Checking configuration');
        $configured = (count($this->config) > 0);
        if ($configured) {
            foreach (static::$required as $required) {
                if (!array_key_exists($required, $this->config)) {
                    $configured = false;
                    break;
                }
            }
        }
        return ($configured || $this->checkTryToSaveConfig());
    }

    /**
     * Method that check if the user is trying to save the config
     * @return bool
     */
    public function checkTryToSaveConfig()
    {
        $uri = Request::getInstance()->getRequestUri();
        $method = Request::getInstance()->getMethod();
        return (preg_match('/^\/admin\/(config|setup)$/', $uri) !== false && strtoupper($method) === 'POST');
    }

    /**
     * Method that saves all the configuration in the system
     *
     * @param array $data
     * @param array|null $extra
     * @return boolean
     */
    public static function save(array $data, array $extra = null)
    {
        $data = self::saveConfigParams($data, $extra);
        $final_data = self::saveExtraParams($data);
        $saved = false;
        try {
            Cache::getInstance()->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE, $final_data, Cache::JSON, true);

            Config::getInstance()->loadConfigData();
            $saved = true;
        } catch (ConfigException $e) {
            Logger::log($e->getMessage(), LOG_ERR);
        }
        return $saved;
    }

    /**
     * Method that returns a config value
     * @param string $param
     * @param mixed $defaultValue
     *
     * @return mixed|null
     */
    public function get($param, $defaultValue = null)
    {
        return array_key_exists($param, $this->config) ? $this->config[$param] : $defaultValue;
    }

    /**
     * Method that returns all the configuration
     * @return array
     */
    public function dumpConfig()
    {
        return $this->config ?: [];
    }

    /**
     * Method that reloads config file
     */
    public function loadConfigData()
    {
        $this->config = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE,
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            Cache::JSON,
            TRUE) ?: [];
        $this->debug = (array_key_exists('debug', $this->config)) ? (bool)$this->config['debug'] : FALSE;
    }

    /**
     * Clear configuration set
     */
    public function clearConfig()
    {
        $this->config = [];
    }

    /**
     * Static wrapper for extracting params
     * @param string $key
     * @param mixed|null $defaultValue
     * @return mixed|null
     */
    public static function getParam($key, $defaultValue = null)
    {
        $param = Config::getInstance()->get($key);
        return (null !== $param) ? $param : $defaultValue;
    }
}


1		<?php
2
3		namespace PSFS\base\config;
4
5
6		use PSFS\base\Cache;
7		use PSFS\base\exception\ConfigException;
8		use PSFS\base\Logger;
9		use PSFS\base\Request;
10		use PSFS\base\types\SingletonTrait;
11
12		/**
13		* Class Config
14		* @package PSFS\base\config
15		*/
16		class Config
17		{
18		use SingletonTrait;
19		const DEFAULT_LANGUAGE = "es";
20		const DEFAULT_ENCODE = "UTF-8";
21		const DEFAULT_CTYPE = "text/html";
22		const DEFAULT_DATETIMEZONE = "Europe/Madrid";
23
24		const CONFIG_FILE = 'config.json';
25
26		protected $config = array();
27		static public $defaults = array(
28		"db_host" => "localhost",
29		"db_port" => "3306",
30		"default_language" => "es_ES",
31		"debug" => true,
32		"front.version" => "v1",
33		"version" => "v1",
34		);
35		static public $required = array('db_host', 'db_port', 'db_name', 'db_user', 'db_password', 'home_action', 'default_language', 'debug');
		0 ignored issues – show Coding Style introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 139 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
36		static public $encrypted = array('db_password');
37		static public $optional = [
38		'platform_name', // Platform name
39		'restricted', // Restrict the web access
40		'admin_login', // Enable web login for admin
41		'logger.phpFire', // Enable phpFire to trace the logs in the browser
42		'logger.memory', // Enable log memory usage un traces
43		'poweredBy', // Show PoweredBy header customized
44		'author', // Author for auto generated files
45		'author_email', // Author email for auto generated files
46		'version', // Platform version(for cache purposes)
47		'front.version', // Static resources version
48		'cors.enabled', // Enable CORS (regex with the domains, * for all)
49		'pagination.limit', // Pagination limit for autogenerated api admin
50		'api.secret', // Secret passphrase to securize the api
51		'api.admin', // Enable de autogenerated api admin(wok)
52		'log.level', // Max log level(default INFO)
53		'admin_action', // Default admin url when access to /admin
54		'cache.var', // Static cache var
55		'twig.auto_reload', // Enable or disable auto reload templates for twig
56		'modules.extend', // Variable for extending the current functionality
57		];
58		protected $debug = false;
59
60		/**
61		* Config Constructor
62		*/
63	8	public function __construct()
64		{
65	8	$this->init();
66	8	}
67
68		/**
69		* Method that load the configuration data into the system
70		* @return Config
71		*/
72	8	protected function init()
73		{
74	8	if (file_exists(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE)) {
75	7	$this->loadConfigData();
76		}
77	8	return $this;
78		}
79
80		/**
81		* Method that saves the configuration
82		* @param array $data
83		* @param array $extra
84		* @return array
85		*/
86	2	protected static function saveConfigParams(array $data, array $extra)
87		{
88	2	Logger::log('Saving required config parameters');
89		//En caso de tener parámetros nuevos los guardamos
90	2	if (array_key_exists('label', $extra) && is_array($extra['label'])) {
91	1	foreach ($extra['label'] as $index => $field) {
92	1	if (array_key_exists($index, $extra['value']) && !empty($extra['value'][$index])) {
93		/** @var $data array */
94	1	$data[$field] = $extra['value'][$index];
95		}
96		}
97		}
98	2	return $data;
99		}
100
101		/**
102		* Method that saves the extra parameters into the configuration
103		* @param array $data
104		* @return array
105		*/
106	2	protected static function saveExtraParams(array $data)
107		{
108	2	$final_data = array();
109	2	if (count($data) > 0) {
110	2	Logger::log('Saving extra configuration parameters');
111	2	foreach ($data as $key => $value) {
112	2	if (null !== $value \|\| $value !== '') {
113	2	$final_data[$key] = $value;
114		}
115		}
116		}
117	2	return $final_data;
118		}
119
120		/**
121		* Method that returns if the system is in debug mode
122		* @return boolean
123		*/
124	6	public function getDebugMode()
125		{
126	6	return $this->debug;
127		}
128
129		/**
130		* Method that checks if the platform is proper configured
131		* @return boolean
132		*/
133	2	public function isConfigured()
134		{
135	2	Logger::log('Checking configuration');
136	2	$configured = (count($this->config) > 0);
137	2	if ($configured) {
138	1	foreach (static::$required as $required) {
139	1	if (!array_key_exists($required, $this->config)) {
140	1	$configured = false;
141	1	break;
142		}
143		}
144		}
145	2	return ($configured \|\| $this->checkTryToSaveConfig());
146		}
147
148		/**
149		* Method that check if the user is trying to save the config
150		* @return bool
151		*/
152	2	public function checkTryToSaveConfig()
153		{
154	2	$uri = Request::getInstance()->getRequestUri();
155	2	$method = Request::getInstance()->getMethod();
156	2	return (preg_match('/^\/admin\/(config\|setup)$/', $uri) !== false && strtoupper($method) === 'POST');
157		}
158
159		/**
160		* Method that saves all the configuration in the system
161		*
162		* @param array $data
163		* @param array\|null $extra
164		* @return boolean
165		*/
166	2	public static function save(array $data, array $extra = null)
167		{
168	2	$data = self::saveConfigParams($data, $extra);
169	2	$final_data = self::saveExtraParams($data);
170	2	$saved = false;
171		try {
172	2	Cache::getInstance()->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE, $final_data, Cache::JSON, true);
		0 ignored issues – show Coding Style introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
173	2	Config::getInstance()->loadConfigData();
174	2	$saved = true;
175		} catch (ConfigException $e) {
176		Logger::log($e->getMessage(), LOG_ERR);
177		}
178	2	return $saved;
179		}
180
181		/**
182		* Method that returns a config value
183		* @param string $param
184		* @param mixed $defaultValue
185		*
186		* @return mixed\|null
187		*/
188	4	public function get($param, $defaultValue = null)
189		{
190	4	return array_key_exists($param, $this->config) ? $this->config[$param] : $defaultValue;
191		}
192
193		/**
194		* Method that returns all the configuration
195		* @return array
196		*/
197	2	public function dumpConfig()
198		{
199	2	return $this->config ?: [];
200		}
201
202		/**
203		* Method that reloads config file
204		*/
205	2	public function loadConfigData()
206		{
207	2	$this->config = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE,
		0 ignored issues – show Documentation Bug introduced 2017-02-16 23:47 UTC by Report Bug Copy Issue Report It seems like `\PSFS\base\Cache::getIns...:JSON, TRUE) ?: array()` can also be of type `string`. However, the property `$config` is declared as type `array`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
208	2	Cache::JSON,
209	2	TRUE) ?: [];
210	2	$this->debug = (array_key_exists('debug', $this->config)) ? (bool)$this->config['debug'] : FALSE;
211	2	}
212
213		/**
214		* Clear configuration set
215		*/
216	1	public function clearConfig()
217		{
218	1	$this->config = [];
219	1	}
220
221		/**
222		* Static wrapper for extracting params
223		* @param string $key
224		* @param mixed\|null $defaultValue
225		* @return mixed\|null
226		*/
227	2	public static function getParam($key, $defaultValue = null)
228		{
229	2	$param = Config::getInstance()->get($key);
230	2	return (null !== $param) ? $param : $defaultValue;
231		}
232		}
233

psfs / core

Push — master ( 58ddad...5e153e )

Config::isConfigured() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like