Config::save() - Code Metrics - Inspection of "Updated test information" - psfs/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 02345f...0e807a )

by Fran

created 2017-03-07 15:27 UTC

Config::save() A

↳ Parent: Config

Complexity

Conditions	3
Paths	4

Size

Total Lines	17
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3.004

Importance

Changes

Metric	Value
cc	3
eloc	14
nc	4
nop	2
dl	0
loc	17
ccs	12
cts	13
cp	0.9231
crap	3.004
rs	9.4285
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
        'psfs.auth', // Variable for extending PSFS with the AUTH module
        'errors.strict', // Variable to trace all strict errors
        'psfs.memcache', // Add Memcache to prod cache process, ONLY for PROD environments
    ];
    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;
    }

    /**
     * @return bool
     */
    public function isLoaded() {
        return !empty($this->config);
    }

    /**
     * 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 {
            $final_data = array_filter($final_data, function($key, $value) {
                return in_array($key, Config::$required) || !empty($value);
            }, ARRAY_FILTER_USE_BOTH);
            $saved = (false !== file_put_contents(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE, json_encode($final_data, JSON_PRETTY_PRINT)));

            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 = json_decode(file_get_contents(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE), 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		'psfs.auth', // Variable for extending PSFS with the AUTH module
58		'errors.strict', // Variable to trace all strict errors
59		'psfs.memcache', // Add Memcache to prod cache process, ONLY for PROD environments
60		];
61		protected $debug = false;
62
63		/**
64		* Config Constructor
65		*/
66	1	public function __construct()
67		{
68	1	$this->init();
69	1	}
70
71		/**
72		* Method that load the configuration data into the system
73		* @return Config
74		*/
75	1	protected function init()
76		{
77	1	if (file_exists(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE)) {
78		$this->loadConfigData();
79		}
80	1	return $this;
81		}
82
83		/**
84		* @return bool
85		*/
86	1	public function isLoaded() {
87	1	return !empty($this->config);
88		}
89
90		/**
91		* Method that saves the configuration
92		* @param array $data
93		* @param array $extra
94		* @return array
95		*/
96	2	protected static function saveConfigParams(array $data, array $extra)
97		{
98	2	Logger::log('Saving required config parameters');
99		//En caso de tener parámetros nuevos los guardamos
100	2	if (array_key_exists('label', $extra) && is_array($extra['label'])) {
101	1	foreach ($extra['label'] as $index => $field) {
102	1	if (array_key_exists($index, $extra['value']) && !empty($extra['value'][$index])) {
103		/** @var $data array */
104	1	$data[$field] = $extra['value'][$index];
105	1	}
106	1	}
107	1	}
108	2	return $data;
109		}
110
111		/**
112		* Method that saves the extra parameters into the configuration
113		* @param array $data
114		* @return array
115		*/
116	2	protected static function saveExtraParams(array $data)
117		{
118	2	$final_data = array();
119	2	if (count($data) > 0) {
120	2	Logger::log('Saving extra configuration parameters');
121	2	foreach ($data as $key => $value) {
122	2	if (null !== $value \|\| $value !== '') {
123	2	$final_data[$key] = $value;
124	2	}
125	2	}
126	2	}
127	2	return $final_data;
128		}
129
130		/**
131		* Method that returns if the system is in debug mode
132		* @return boolean
133		*/
134	6	public function getDebugMode()
135		{
136	6	return $this->debug;
137		}
138
139		/**
140		* Method that checks if the platform is proper configured
141		* @return boolean
142		*/
143	2	public function isConfigured()
144		{
145	2	Logger::log('Checking configuration');
146	2	$configured = (count($this->config) > 0);
147	2	if ($configured) {
148	1	foreach (static::$required as $required) {
149	1	if (!array_key_exists($required, $this->config)) {
150	1	$configured = false;
151	1	break;
152		}
153	1	}
154	1	}
155	2	return ($configured \|\| $this->checkTryToSaveConfig());
156		}
157
158		/**
159		* Method that check if the user is trying to save the config
160		* @return bool
161		*/
162	2	public function checkTryToSaveConfig()
163		{
164	2	$uri = Request::getInstance()->getRequestUri();
165	2	$method = Request::getInstance()->getMethod();
166	2	return (preg_match('/^\/admin\/(config\|setup)$/', $uri) !== false && strtoupper($method) === 'POST');
167		}
168
169		/**
170		* Method that saves all the configuration in the system
171		*
172		* @param array $data
173		* @param array\|null $extra
174		* @return boolean
175		*/
176	2	public static function save(array $data, array $extra = null)
177		{
178	2	$data = self::saveConfigParams($data, $extra);
179	2	$final_data = self::saveExtraParams($data);
180	2	$saved = false;
181		try {
182	2	$final_data = array_filter($final_data, function($key, $value) {
183	2	return in_array($key, Config::$required) \|\| !empty($value);
184	2	}, ARRAY_FILTER_USE_BOTH);
185	2	$saved = (false !== file_put_contents(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE, json_encode($final_data, JSON_PRETTY_PRINT)));
		0 ignored issues – show Coding Style introduced 2017-03-04 15:07 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 150 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...
186	2	Config::getInstance()->loadConfigData();
187	2	$saved = true;
188	2	} catch (ConfigException $e) {
189		Logger::log($e->getMessage(), LOG_ERR);
190		}
191	2	return $saved;
192		}
193
194		/**
195		* Method that returns a config value
196		* @param string $param
197		* @param mixed $defaultValue
198		*
199		* @return mixed\|null
200		*/
201	8	public function get($param, $defaultValue = null)
202		{
203	8	return array_key_exists($param, $this->config) ? $this->config[$param] : $defaultValue;
204		}
205
206		/**
207		* Method that returns all the configuration
208		* @return array
209		*/
210	2	public function dumpConfig()
211		{
212	2	return $this->config ?: [];
213		}
214
215		/**
216		* Method that reloads config file
217		*/
218	2	public function loadConfigData()
219		{
220	2	$this->config = json_decode(file_get_contents(CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE), true) ?: [];
		0 ignored issues – show Documentation Bug introduced 2017-03-04 15:07 UTC by Report Bug Copy Issue Report It seems like `json_decode(file_get_con...FILE), true) ?: array()` of type `*` is incompatible with the declared type `array` of property `$config`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history... Coding Style introduced 2017-03-04 15:07 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 121 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...
221	2	$this->debug = (array_key_exists('debug', $this->config)) ? (bool)$this->config['debug'] : FALSE;
222	2	}
223
224		/**
225		* Clear configuration set
226		*/
227	1	public function clearConfig()
228		{
229	1	$this->config = [];
230	1	}
231
232		/**
233		* Static wrapper for extracting params
234		* @param string $key
235		* @param mixed\|null $defaultValue
236		* @return mixed\|null
237		*/
238	7	public static function getParam($key, $defaultValue = null)
239		{
240	7	$param = Config::getInstance()->get($key);
241	7	return (null !== $param) ? $param : $defaultValue;
242		}
243		}
244

psfs / core

Push — master ( 02345f...0e807a )

Config::save() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like