cs\Config\Options

Complexity

Total Complexity

44

Size/Duplication

Total Lines	307
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	get_formatting()	0	9	1
B	get_formatting_const()	0	120	1
A	get_formatting_const_plain()	0	7	2
A	get_languages()	0	12	4
A	get_themes()	0	5	2
A	get_modules_that_can_be_default()	0	13	4
A	get_active_languages()	0	8	2
B	get_formatting_normalize()	0	17	8
A	get_defaults()	0	9	3
A	get_multilingual()	0	10	3
C	apply_formatting()	0	48	14

<?php
/**
 * @package   CleverStyle Framework
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\Config;
use
	cs\Config,
	cs\DB;

/**
 * Class for getting of db and storage configuration of module
 */
class Options {
	/**
	 * Get formats for all supported options
	 *
	 * Format includes option type, default value, supported values or ranges, whether option is password or is multilingual
	 *
	 * @return array[]
	 */
	public static function get_formatting () {
		$formatting                                               = static::get_formatting_const();
		$formatting['set_single']['language']['values']           = static::get_active_languages();
		$formatting['set_single']['timezone']['values']           = get_timezones_list();
		$formatting['set_single']['default_module']['values']     = static::get_modules_that_can_be_default();
		$formatting['set_single']['theme']['values']              = static::get_themes();
		$formatting['set_multiple']['active_languages']['values'] = static::get_languages();
		return static::get_formatting_normalize($formatting);
	}
	/**
	 * @return array[]

Should the return type not be array<string,array>?

	 */
	protected static function get_formatting_const () {
		return [
			'array'        => [
				'url'           => [],
				'cookie_domain' => []
			],
			'int_bool'     => [
				'site_mode'                         => 1,
				'title_reverse'                     => 0,
				'cache_compress_js_css'             => 1,
				'frontend_load_optimization'        => 1,
				'vulcanization'                     => 1,
				'put_js_after_body'                 => 1,
				'disable_webcomponents'             => 0,
				'multilingual'                      => 0,
				'db_balance'                        => 0,
				'db_mirror_mode'                    => DB::MIRROR_MODE_MASTER_MASTER,
				'gravatar_support'                  => 0,
				'smtp'                              => 0,
				'smtp_auth'                         => 0,
				'allow_user_registration'           => 1,
				'require_registration_confirmation' => 1,
				'auto_sign_in_after_registration'   => 1,
				'registration_confirmation_time'    => 1,
				'remember_user_ip'                  => 0,
				'simple_admin_mode'                 => 1
			],
			'int_range'    => [
				'inserts_limit'         => [
					'min'   => 1,
					'value' => 1000
				],
				'key_expire'            => [
					'min'   => 1,
					'value' => 60 * 2
				],
				'session_expire'        => [
					'min'   => 1,
					'value' => 3600 * 24 * 30
				],
				'update_ratio'          => [
					'min'   => 0,
					'max'   => 100,
					'value' => 75
				],
				'password_min_length'   => [
					'min'   => 1,
					'value' => 4
				],
				'password_min_strength' => [
					'min'   => 0,
					'max'   => 7,
					'value' => 3
				]
			],
			'set_single'   => [
				'smtp_secure'    => [
					'value'  => '',
					'values' => ['', 'ssl', 'tls']
				],
				'language'       => [
					'value'  => 'English',
					'source' => 'active_languages'
				],
				'timezone'       => [
					'value' => 'UTC'
				],
				'default_module' => [
					'value' => Config::SYSTEM_MODULE
				],
				'theme'          => [
					'value' => Config::SYSTEM_THEME
				]
			],
			'set_multiple' => [
				'active_languages' => [
					'value' => [
						'English'
					]
				]
			],
			'string'       => [
				'admin_email'   => '',
				'cookie_prefix' => '',
				'smtp_host'     => '',
				'smtp_port'     => '',
				'smtp_user'     => '',
				'smtp_password' => [
					'value'    => '',
					'password' => true
				],
				'mail_from'     => ''
			],
			'text'         => [
				'title_delimiter' => ' | ',
				'site_name'       => [
					'multilingual' => true,
					'value'        => ''
				],
				'closed_title'    => [
					'multilingual' => true,
					'value'        => 'Site closed'
				],
				'mail_from_name'  => [
					'multilingual' => true,
					'value'        => 'Administrator'
				]
			],
			'html'         => [
				'closed_text'    => [
					'multilingual' => true,
					'value'        => '<p>Site closed for maintenance</p>'
				],
				'mail_signature' => [
					'multilingual' => true,
					'value'        => ''
				]
			]
		];
	}
	/**
	 * @return array[]
	 */
	protected static function get_formatting_const_plain () {
		static $formatting;
		if (!isset($formatting)) {
			$formatting = array_merge(...array_values(static::get_formatting_const()));
		}
		return $formatting;
	}
	/**
	 * @return string[]
	 */
	protected static function get_languages () {
		$languages = defined('LANGUAGES')
			? array_unique(
				array_merge(
					_mb_substr(get_files_list(LANGUAGES, '/^.*?\.php$/i', 'f'), 0, -4) ?: [],
					_mb_substr(get_files_list(LANGUAGES, '/^.*?\.json$/i', 'f'), 0, -5) ?: []
				)
			)
			: ['English'];
		asort($languages);
		return $languages;
	}
	/**
	 * @return string[]
	 */
	protected static function get_themes () {
		$themes = defined('THEMES') ? get_files_list(THEMES, false, 'd') : [Config::SYSTEM_THEME];
		asort($themes);
		return $themes;
	}
	/**
	 * @return string[]
	 */
	protected static function get_modules_that_can_be_default () {
		$Config = Config::instance(true);
		if (!defined('MODULES') || !isset($Config->components['modules'])) {
			return [Config::SYSTEM_MODULE];
		}
		/** @noinspection PhpParamsInspection */
		return array_filter(
			array_keys($Config->components['modules']),
			function ($module) use ($Config) {
				return $Config->module($module) && file_exists_with_extension(MODULES."/$module/index", ['php', 'html', 'json']);
			}
		);
	}
	/**
	 * @return string[]
	 */
	protected static function get_active_languages () {
		$Config = Config::instance(true);
		if (!isset($Config->core['active_languages'])) {
			return ['English'];
		}
		/** @noinspection PhpIncompatibleReturnTypeInspection */
		return $Config->core['active_languages'];
	}
	/**
	 * @param array[] $format
	 *
	 * @return array[]
	 */
	protected static function get_formatting_normalize ($format) {
		foreach ($format as $type => &$items) {
			foreach ($items as $item => &$data) {
				if (!is_array($data) || !isset($data['value'])) {
					$data = [
						'value' => $data
					];
				}
				$data['type'] = $type;
				if (($type == 'set_single' || $type == 'set_multiple') && !is_array_assoc($data['values'])) {
					$data['values'] = array_combine($data['values'], $data['values']);
				}
			}
			unset($data);
		}
		return array_merge(...array_values($format));
	}
	/**
	 * Get default values for all supported options
	 *
	 * @return array

Consider making the return type a bit more specific; maybe use array[].

	 */
	public static function get_defaults () {
		$formatting = static::get_formatting_const_plain();
		foreach ($formatting as &$f) {
			if (isset($f['value'])) {
				$f = $f['value'];
			}
		}
		return $formatting;
	}
	/**
	 * Get list of multilingual options
	 *
	 * @return string[]
	 */
	public static function get_multilingual () {
		$formatting = static::get_formatting_const_plain();
		$result     = [];
		foreach ($formatting as $key => $f) {
			if (isset($f['multilingual'])) {
				$result[] = $key;
			}
		}
		return $result;
	}
	/**
	 * Take options and check each value according to needed format, correct value or use default if needed
	 *
	 * @param array $target_options
	 *
	 * @return array
	 */
	public static function apply_formatting ($target_options) {
		$options = static::get_formatting();
		foreach ($target_options as $option => &$value) {
			if (!isset($options[$option])) {
				unset($target_options[$option]);
			} else {
				$format = $options[$option];
				switch ($format['type']) {
					case 'array':
						$value = xap((array)$value);
						break;
					case 'int_bool':
						$value = (int)(bool)$value;
						break;
					case 'int_range':
						if (isset($format['min'])) {
							$value = max($format['min'], (int)$value);
						}
						if (isset($format['max'])) {
							$value = min($format['max'], (int)$value);
						}
						break;
					case 'set_single':
						$value = (string)$value;
						if (!in_array($value, $format['values'], true)) {
							$value = $format['value'];
						}
						break;
					case 'set_multiple':
						$value = array_filter(
							(array)$value,
							function ($value) use ($format) {
								return in_array((string)$value, $format['values'], true);
							}
						);
						$value = $value ?: [$format['value']];
						break;
					case 'text':
						$value = xap($value);
						break;
					case 'html':
						$value = xap($value, true);
						break;
				}
			}
		}
		return $target_options;
	}
}