Config::getCachePath() - Code Metrics - Inspection of "Reformatted code and more test cases" - psfs/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8a02a1...c877ec )

by Fran

created 2016-08-18 23:35 UTC

Config::getCachePath() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	4
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10
ccs	2
cts	2
cp	1
crap	1

<?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";

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

    static public $encrypted = array('db_password');
    static public $optional = array('platform_name', 'debug', 'restricted', 'admin_login', 'logger.phpFire', 'logger.memory', 'poweredBy', 'author', 'author_email', 'version', 'front.version', 'cors.enabled', 'pagination.limit', 'api.secret');

    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 . "config.json")) {
            $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 returns the cache path
     * @return string
     */
    public function getCachePath()
    {
        return CACHE_DIR;
    }

    /**
     * Method that returns the templates path
     * @return string
     */
    public function getTemplatePath()
    {
        $path = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR;

        return realpath($path);
    }

    /**
     * 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 . "config.json", $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
     *
     * @return mixed|null
     */
    public function get($param)
    {
        return array_key_exists($param, $this->config) ? $this->config[$param] : null;
    }

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

    /**
     * Method that returns the Propel ORM parameters to setup the models
     * @return array|null

     */
    public function getPropelParams()
    {
        return Cache::getInstance()->getDataFromFile(__DIR__ . DIRECTORY_SEPARATOR . 'properties.json', Cache::JSON, true);

    }

    /**
     * Method that creates any parametrized path
     * @param string $dir
     * throws ConfigException
     */
    public static function createDir($dir)
    {
        try {
            if (!is_dir($dir) && @mkdir($dir, 0775, true) === false) {
                throw new \Exception(_('Can\'t create directory ') . $dir);
            }
        } catch (\Exception $e) {
            Logger::log($e->getMessage(), LOG_WARNING);
            if (!file_exists(dirname($dir))) {
                throw new ConfigException($e->getMessage() . $dir);
            }
        }
    }

    /**
     * Method that remove all data in the document root path
     */
    public static function clearDocumentRoot()
    {
        $rootDirs = array("css", "js", "media", "font");
        foreach ($rootDirs as $dir) {
            if (file_exists(WEB_DIR . DIRECTORY_SEPARATOR . $dir)) {
                try {
                    @shell_exec("rm -rf " . WEB_DIR . DIRECTORY_SEPARATOR . $dir);
                } catch (\Exception $e) {
                    Logger::log($e->getMessage());
                }
            }
        }
    }

    /**
     * Method that reloads config file
     */
    public function loadConfigData()
    {
        $this->config = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . "config.json", Cache::JSON, TRUE) ?: array();
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;
}
        $this->debug = (array_key_exists('debug', $this->config)) ? (bool)$this->config['debug'] : FALSE;
    }

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


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		protected $config = array();
25		static public $defaults = array(
26		"db_host" => "localhost",
27		"db_port" => "3306",
28		"default_language" => "es_ES",
29		);
30		static public $required = array('db_host', 'db_port', 'db_name', 'db_user', 'db_password', 'home_action', 'default_language');
		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...
31		static public $encrypted = array('db_password');
32		static public $optional = array('platform_name', 'debug', 'restricted', 'admin_login', 'logger.phpFire', 'logger.memory', 'poweredBy', 'author', 'author_email', 'version', 'front.version', 'cors.enabled', 'pagination.limit', 'api.secret');
		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 243 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...
33		protected $debug = false;
34
35		/**
36		* Config Constructor
37		*/
38	8	public function __construct()
39		{
40	8	$this->init();
41	8	}
42
43		/**
44		* Method that load the configuration data into the system
45		* @return Config
46		*/
47	8	protected function init()
48		{
49	8	if (file_exists(CONFIG_DIR . DIRECTORY_SEPARATOR . "config.json")) {
50	7	$this->loadConfigData();
51	7	}
52	8	return $this;
53		}
54
55		/**
56		* Method that saves the configuration
57		* @param array $data
58		* @param array $extra
59		* @return array
60		*/
61	1	protected static function saveConfigParams(array $data, array $extra)
62		{
63	1	Logger::log('Saving required config parameters');
64		//En caso de tener parámetros nuevos los guardamos
65	1	if (array_key_exists('label', $extra) && is_array($extra['label'])) {
66	1	foreach ($extra['label'] as $index => $field) {
67	1	if (array_key_exists($index, $extra['value']) && !empty($extra['value'][$index])) {
68		/** @var $data array */
69	1	$data[$field] = $extra['value'][$index];
70	1	}
71	1	}
72	1	}
73	1	return $data;
74		}
75
76		/**
77		* Method that saves the extra parameters into the configuration
78		* @param array $data
79		* @return array
80		*/
81	1	protected static function saveExtraParams(array $data)
82		{
83	1	$final_data = array();
84	1	if (count($data) > 0) {
85	1	Logger::log('Saving extra configuration parameters');
86	1	foreach ($data as $key => $value) {
87	1	if (null !== $value \|\| $value !== '') {
88	1	$final_data[$key] = $value;
89	1	}
90	1	}
91	1	}
92	1	return $final_data;
93		}
94
95		/**
96		* Method that returns if the system is in debug mode
97		* @return boolean
98		*/
99	3	public function getDebugMode()
100		{
101	3	return $this->debug;
102		}
103
104		/**
105		* Method that returns the cache path
106		* @return string
107		*/
108	1	public function getCachePath()
109		{
110	1	return CACHE_DIR;
111		}
112
113		/**
114		* Method that returns the templates path
115		* @return string
116		*/
117	1	public function getTemplatePath()
118		{
119	1	$path = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR;
		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 140 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...
120	1	return realpath($path);
121		}
122
123		/**
124		* Method that checks if the platform is proper configured
125		* @return boolean
126		*/
127	2	public function isConfigured()
128		{
129	2	Logger::log('Checking configuration');
130	2	$configured = (count($this->config) > 0);
131	2	if ($configured) {
132	1	foreach (static::$required as $required) {
133	1	if (!array_key_exists($required, $this->config)) {
134	1	$configured = false;
135	1	break;
136		}
137	1	}
138	1	}
139	2	return ($configured \|\| $this->checkTryToSaveConfig());
140		}
141
142		/**
143		* Method that check if the user is trying to save the config
144		* @return bool
145		*/
146	2	public function checkTryToSaveConfig()
147		{
148	2	$uri = Request::getInstance()->getRequestUri();
149	2	$method = Request::getInstance()->getMethod();
150	2	return (preg_match('/^\/admin\/(config\|setup)$/', $uri) !== false && strtoupper($method) === 'POST');
151		}
152
153		/**
154		* Method that saves all the configuration in the system
155		*
156		* @param array $data
157		* @param array\|null $extra
158		* @return boolean
159		*/
160	1	public static function save(array $data, array $extra = null)
161		{
162	1	$data = self::saveConfigParams($data, $extra);
163	1	$final_data = self::saveExtraParams($data);
164	1	$saved = false;
165		try {
166	1	Cache::getInstance()->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . "config.json", $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 126 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...
167	1	Config::getInstance()->loadConfigData();
168	1	$saved = true;
169	1	} catch (ConfigException $e) {
170		Logger::log($e->getMessage(), LOG_ERR);
171		}
172	1	return $saved;
173		}
174
175		/**
176		* Method that returns a config value
177		* @param string $param
178		*
179		* @return mixed\|null
180		*/
181	2	public function get($param)
182		{
183	2	return array_key_exists($param, $this->config) ? $this->config[$param] : null;
184		}
185
186		/**
187		* Method that returns all the configuration
188		* @return array
189		*/
190	1	public function dumpConfig()
191		{
192	1	return $this->config ?: [];
193		}
194
195		/**
196		* Method that returns the Propel ORM parameters to setup the models
197		* @return array\|null
		0 ignored issues – show Documentation introduced 2016-08-18 21:22 UTC by Report Bug Copy Issue Report Should the return type not be `array\|string\|null`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
198		*/
199	1	public function getPropelParams()
200		{
201	1	return Cache::getInstance()->getDataFromFile(__DIR__ . DIRECTORY_SEPARATOR . 'properties.json', Cache::JSON, true);
		0 ignored issues – show Coding Style introduced 2016-08-18 23:39 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 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...
202		}
203
204		/**
205		* Method that creates any parametrized path
206		* @param string $dir
207		* throws ConfigException
208		*/
209	3	public static function createDir($dir)
210		{
211		try {
212	3	if (!is_dir($dir) && @mkdir($dir, 0775, true) === false) {
213		throw new \Exception(_('Can\'t create directory ') . $dir);
214		}
215	3	} catch (\Exception $e) {
216	1	Logger::log($e->getMessage(), LOG_WARNING);
217		if (!file_exists(dirname($dir))) {
218		throw new ConfigException($e->getMessage() . $dir);
219		}
220		}
221	3	}
222
223		/**
224		* Method that remove all data in the document root path
225		*/
226	1	public static function clearDocumentRoot()
227		{
228	1	$rootDirs = array("css", "js", "media", "font");
229	1	foreach ($rootDirs as $dir) {
230	1	if (file_exists(WEB_DIR . DIRECTORY_SEPARATOR . $dir)) {
231		try {
232	1	@shell_exec("rm -rf " . WEB_DIR . DIRECTORY_SEPARATOR . $dir);
233	1	} catch (\Exception $e) {
234		Logger::log($e->getMessage());
235		}
236	1	}
237	1	}
238	1	}
239
240		/**
241		* Method that reloads config file
242		*/
243	1	public function loadConfigData()
244		{
245	1	$this->config = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . "config.json", Cache::JSON, TRUE) ?: array();
		0 ignored issues – show Documentation Bug introduced 2016-05-07 23:16 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... Coding Style introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 142 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...
246	1	$this->debug = (array_key_exists('debug', $this->config)) ? (bool)$this->config['debug'] : FALSE;
247	1	}
248
249		/**
250		* Clear configuration set
251		*/
252	1	public function clearConfig()
253		{
254	1	$this->config = [];
255	1	}
256		}
257

psfs / core

Push — master ( 8a02a1...c877ec )

Config::getCachePath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like