cs\Config

Complexity

Total Complexity

27

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	2
Bugs	1	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
B	construct()	0	25	4
A	fill_mirrors()	0	8	2
B	load_config_from_db()	0	25	3
A	apply()	0	3	1
A	apply_internal()	0	23	3
B	save()	0	31	5
A	cancel_available()	0	3	1
A	cancel()	0	3	2
A	base_url()	0	14	3
A	core_url()	0	6	1
A	module()	0	6	2

<?php
/**
 * @package   CleverStyle CMS
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs;

/**
 * Provides next events:
 *  System/Config/init/before
 *
 *  System/Config/init/after
 */
class Config {
	use
		Singleton;
	const SYSTEM_MODULE = 'System';
	const SYSTEM_THEME  = 'CleverStyle';
	/**
	 * Most of general configuration properties
	 *
	 * @var mixed[]
	 */
	public $core = [];
	/**
	 * Configuration of databases, except the main database, parameters of which are stored in configuration file
	 *
	 * @var mixed[]
	 */
	public $db = [];
	/**
	 * Configuration of storages, except the main storage, parameters of which are stored in configuration file
	 *
	 * @var mixed[]
	 */
	public $storage = [];
	/**
	 * Internal structure of components parameters
	 *
	 * @var mixed[]
	 */
	public $components = [];
	/**
	 * Array of all domains, which allowed to access the site
	 *
	 * Contains keys:
	 * * count - Total count
	 * * http - Insecure (http) domains
	 * * https - Secure (https) domains
	 *
	 * @var array
	 */
	public $mirrors = [
		'count' => 0,
		'http'  => [],
		'https' => []
	];
	/**
	 * Loading of configuration, initialization of $Config, $Cache, $L and Page objects, Routing processing
	 *
	 * @throws ExitException
	 */
	protected function construct () {
		Event::instance()->fire('System/Config/init/before');

It seems like fire() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		/**
		 * Reading settings from cache and defining missing data
		 */
		$config = Cache::instance()->config;
		/**
		 * Cache reloading, if necessary
		 */
		if (!is_array($config)) {
			$this->load_config_from_db();
		} else {
			foreach ($config as $part => $value) {
				$this->$part = $value;
			}
			unset($part, $value);
		}
		date_default_timezone_set($this->core['timezone']);
		$this->fill_mirrors();
		Event::instance()->fire('System/Config/init/after');

It seems like fire() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		if (!file_exists(MODULES.'/'.$this->core['default_module'])) {
			$this->core['default_module'] = self::SYSTEM_MODULE;
			$this->save();
		}
	}
	/**
	 * Is used to fill `$this->mirrors` using current configuration
	 */
	protected function fill_mirrors () {
		foreach ($this->core['url'] as $i => $address) {
			list($protocol, $urls) = explode('://', $address, 2);
			$urls                       = explode(';', $urls);
			$this->mirrors[$protocol][] = $urls[0];
		}
		$this->mirrors['count'] = count($this->mirrors['http']) + count($this->mirrors['https']);
	}
	/**
	 * Reloading of settings cache
	 *
	 * @return bool
	 *
	 * @throws ExitException
	 */
	protected function load_config_from_db () {
		$result = DB::instance()->qf(

It seems like qf() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			[
				"SELECT
					`core`,
					`db`,
					`storage`,
					`components`
				FROM `[prefix]config`
				WHERE `domain` = '%s'
				LIMIT 1",
				DOMAIN
			]
		);
		if (is_array($result)) {
			foreach ($result as $part => $value) {
				$this->$part = _json_decode($value);
			}
			unset($part, $value);
		} else {
			return false;
		}
		$this->apply_internal(false);
		return true;
	}
	/**
	 * Applying settings without saving changes into db
	 *
	 * @return bool
	 *
	 * @throws ExitException
	 */
	function apply () {
		return $this->apply_internal();
	}
	/**
	 * Applying settings without saving changes into db
	 *
	 * @param bool $cache_not_saved_mark
	 *
	 * @return bool
	 *
	 * @throws ExitException
	 */
	protected function apply_internal ($cache_not_saved_mark = true) {
		if ($cache_not_saved_mark) {
			$this->core['cache_not_saved'] = true;
		} else {
			unset($this->core['cache_not_saved']);
		}
		$Cache = Cache::instance();
		if (!$Cache->set(

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			'config',
			[
				'core'       => $this->core,
				'db'         => $this->db,
				'storage'    => $this->storage,
				'components' => $this->components
			]
		)
		) {
			return false;
		}
		unset($Cache->{'languages'});
		Event::instance()->fire('System/Config/changed');

It seems like fire() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		return true;
	}
	/**
	 * Saving settings
	 *
	 * @return bool
	 *
	 * @throws ExitException
	 */
	function save () {
		if ($this->cancel_available()) {
			unset($this->core['cache_not_saved']);
		}
		$core_settings_keys = file_get_json(MODULES.'/System/core_settings_keys.json');
		foreach ($this->core as $key => $value) {
			if (!in_array($key, $core_settings_keys)) {
				unset($this->core[$key]);
			}
		}
		if (DB::instance()->db_prime(0)->q(

It seems like db_prime() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			"UPDATE `[prefix]config`
			SET
				`core`			= '%s',
				`db`			= '%s',
				`storage`		= '%s',
				`components`	= '%s'
			WHERE `domain` = '%s'
			LIMIT 1",
			_json_encode($this->core),
			_json_encode($this->db),
			_json_encode($this->storage),
			_json_encode($this->components),
			DOMAIN
		)
		) {
			$this->apply_internal(false);
			return true;
		}
		return false;
	}
	/**
	 * Whether configuration was applied (not saved) and can be canceled
	 *
	 * @return bool
	 */
	function cancel_available () {
		return isset($this->core['cache_not_saved']);
	}
	/**
	 * Canceling of applied settings
	 *
	 * @return bool
	 *
	 * @throws ExitException
	 */
	function cancel () {
		return $this->load_config_from_db() && $this->apply_internal(false);
	}
	/**
	 * Get base url of current mirror including language suffix
	 *
	 * @return string
	 */
	function base_url () {
		if (Route::instance()->mirror_index === -1) {
			return '';
		}
		/**
		 * @var _SERVER $_SERVER
		 */
		$base_url = "$_SERVER->protocol://$_SERVER->host";
		$L        = Language::instance();
		if ($this->core['multilingual']) {
			$base_url .= "/$L->clang";
		}
		return $base_url;
	}
	/**
	 * Get base url of main domain
	 *
	 * @return string
	 */
	function core_url () {
		/**
		 * @var _SERVER $_SERVER
		 */
		return "$_SERVER->protocol://$_SERVER->host";
	}
	/**
	 * Get object for getting db and storage configuration of module
	 *
	 * @param string $module_name
	 *
	 * @return Config\Module_Properties
	 */
	function module ($module_name) {
		if (!isset($this->components['modules'][$module_name])) {
			return False_class::instance();
		}
		return new Config\Module_Properties($this->components['modules'][$module_name], $module_name);
	}
}