cfg_handler - Code Metrics - Inspection of "Breakup large classes" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c96b51...1deced )

by Daniel

created 2015-12-19 02:30 UTC

cfg_handler B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	318
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

98.6%

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	36
c	2
b	0
f	0
lcom	1
cbo	1
dl	0
loc	318
ccs	141
cts	143
cp	0.986
rs	8.8

17 Methods

Rating	Name	Size	Complexity
A	__construct()	11	1
B	get_edit_form()	31	2
A	get_submitted_settings()	21	3
B	_generate_config_fields()	22	4
A	_get_field_template()	16	2
A	_sets_legend()	14	2
A	_explain_field()	10	3
A	_append_field()	10	2
A	_set_params()	8	2
A	_get_field_value()	4	2
A	_prep_select_field_for_display()	6	2
A	_prep_checkbox_field_for_display()	8	1
A	_prep_multi_select_field_for_display()	6	1
A	_prep_hidden_field_for_display()	7	1
A	_prep_custom_field_for_display()	5	2
A	_add_lang_vars()	10	3
A	_get_multi_select()	10	3

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2015 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\services\blocks;

use blitze\sitemaker\services\blocks\cfg_fields;

class cfg_handler extends cfg_fields
{
	/** @var \phpbb\request\request_interface */
	protected $request;

	/** @var \phpbb\template\template */
	protected $template;

	/** @var \phpbb\user */
	protected $user;

	/** @var string phpBB root path */
	protected $phpbb_root_path;

	/** @var string phpEx */
	protected $php_ext;

	/**
	 * Constructor
	 *
	 * @param \phpbb\request\request_interface		$request				Request object
	 * @param \phpbb\template\template				$template				Template object
	 * @param \phpbb\user							$user					User object
	 * @param \blitze\sitemaker\services\groups		$groups					Groups object
	 * @param string								$phpbb_root_path		phpBB root path
	 * @param string								$php_ext				phpEx
	 */
	public function __construct(\phpbb\request\request_interface $request, \phpbb\template\template $template, \phpbb\user $user, \blitze\sitemaker\services\groups $groups, $phpbb_root_path, $php_ext)
	{
		parent::__construct($user);

		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->groups = $groups;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * @param array $block_data
	 * @param array $default_settings
	 * @return template|string
	 */
	public function get_edit_form(array $block_data, array $default_settings)
	{
		global $module;

		if (!function_exists('build_cfg_template'))
		{
			include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
		}

		// We fake this class as it is needed by the build_cfg_template function
		$module = new \stdClass();
		$module->module = $this;

		$this->_generate_config_fields($block_data['settings'], $default_settings);
		$selected_groups = $this->_ensure_array($block_data['permission']);

		$this->template->assign_vars(array(
			'S_ACTIVE'		=> $block_data['status'],
			'S_TYPE'		=> $block_data['type'],
			'S_NO_WRAP'		=> $block_data['no_wrap'],
			'S_HIDE_TITLE'	=> $block_data['hide_title'],
			'S_BLOCK_CLASS'	=> trim($block_data['class']),
			'S_GROUP_OPS'	=> $this->groups->get_options('special', $selected_groups),
		));

		$this->template->set_filenames(array(
			'block_settings' => 'block_settings.html',
		));

		return $this->template->assign_display('block_settings');
	}

	/**
	 * @param array $default_settings
	 * @return array|void
	 */
	public function get_submitted_settings(array $default_settings)
	{
		if (!function_exists('validate_config_vars'))
		{
			include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
		}

		$cfg_array = utf8_normalize_nfc($this->request->variable('config', array('' => ''), true));

		$errors = array();
		validate_config_vars($default_settings, $cfg_array, $errors);

		if (sizeof($errors))
		{
			return array('errors' => join("\n", $errors));
		}

		$this->_get_multi_select($cfg_array, $default_settings);

		return array_intersect_key($cfg_array, $default_settings);
	}

	/**
	 * Generate block configuration fields
	 *
	 * @param array $db_settings
	 * @param array $default_settings
	 */
	private function _generate_config_fields(array &$db_settings, array $default_settings)
	{
		foreach ($default_settings as $field => $vars)
		{
			if ($this->_sets_legend($field, $vars) || !is_array($vars))
			{
				continue;
			}

			$db_settings[$field] = $this->_get_field_value($field, $vars['default'], $db_settings);
			$content = $this->_get_field_template($field, $db_settings, $vars);

			$this->template->assign_block_vars('options', array(
				'KEY'			=> $field,
				'TITLE'			=> $this->user->lang($vars['lang']),
				'S_EXPLAIN'		=> $vars['explain'],
				'TITLE_EXPLAIN'	=> $vars['lang_explain'],
				'CONTENT'		=> $content,
			));
			unset($default_settings[$field]);
		}
	}

	/**
	 * @param $field
	 * @param array $db_settings
	 * @param array $vars
	 * @return string
	 */
	private function _get_field_template($field, array &$db_settings, array &$vars)
	{
		$vars['lang_explain'] = $this->_explain_field($vars);
		$vars['append'] = $this->_append_field($vars);

		$type = explode(':', $vars['type']);
		$method = '_prep_' . $type[0] . '_field_for_display';

		if (is_callable(array($this, $method)))
		{
			$this->_set_params($field, $vars, $db_settings);
			$this->$method($vars, $type, $field, $db_settings);
		}

		return build_cfg_template($type, $field, $db_settings, $field, $vars);
	}

	/**
	 * @param string $field
	 * @param string|array $vars
	 * @return boolean
	 */
	private function _sets_legend($field, $vars)
	{
		if (strpos($field, 'legend') !== false)
		{
			$this->template->assign_block_vars('options', array(
				'S_LEGEND'	=> $field,
				'LEGEND'	=> $this->user->lang($vars)
			));

			return true;
		}

		return false;
	}

	/**
	 * @param array $vars
	 * @return mixed|string
	 */
	private function _explain_field(array $vars)
	{
		$l_explain = '';
		if (!empty($vars['explain']))
		{
			$l_explain = (isset($vars['lang_explain'])) ? $this->user->lang($vars['lang_explain']) : $this->user->lang($vars['lang'] . '_EXPLAIN');
		}

		return $l_explain;
	}

	/**
	 * @param array $vars
	 * @return mixed|string
	 */
	private function _append_field(array $vars)
	{
		$append = '';
		if (!empty($vars['append']))
		{
			$append = $this->user->lang($vars['append']);
		}

		return $append;
	}

	/**
	 * @param $field
	 * @param $vars
	 * @param $settings
	 */
	private function _set_params($field, &$vars, $settings)
	{
		if (!empty($vars['options']))
		{
			$vars['params'][] = $vars['options'];
			$vars['params'][] = $settings[$field];
		}
	}

	/**
	 * @param $field
	 * @param $default
	 * @param $db_settings
	 * @return mixed
	 */
	private function _get_field_value($field, $default, $db_settings)
	{
		return (!empty($db_settings[$field])) ? $db_settings[$field] : $default;
	}

	/**
	 * @param $vars
	 */
	private function _prep_select_field_for_display(&$vars)
	{
		$this->_add_lang_vars($vars['params'][0]);

		$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : 'build_select';
	}

	/**
	 * @param $vars
	 * @param $type
	 * @param $field
	 */
	private function _prep_checkbox_field_for_display(&$vars, &$type, $field)
	{
		$this->_add_lang_vars($vars['params'][0]);

		$vars['method'] = 'build_checkbox';
		$vars['params'][] = $field;
		$type[0] = 'custom';
	}

	/**
	 * @param $vars
	 * @param $type
	 * @param $field
	 */
	private function _prep_multi_select_field_for_display(&$vars, &$type, $field)
	{
		$this->_prep_checkbox_field_for_display($vars, $type, $field);

		$vars['method'] ='build_multi_select';
	}

	/**
	 * @param $vars
	 * @param $type
	 */
	private function _prep_hidden_field_for_display(&$vars, &$type)
	{
		$vars['method'] = 'build_hidden';
		$vars['explain'] = '';
		$vars['lang'] = '';
		$type[0] = 'custom';
	}

	/**
	 * @param $vars
	 * @param $type
	 */
	private function _prep_custom_field_for_display(&$vars, &$type)
	{
		$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : '';
		$type[0] = 'custom';
	}

	/**
	 * this looks bad but its the only way without modifying phpbb code
	 * this is for select items that do not need to be translated
	 * @param array $options
	 */
	private function _add_lang_vars(array $options)
	{
		foreach ($options as $title)
		{
			if (!isset($this->user->lang[$title]))
			{
				$this->user->lang[$title] = $title;
			}
		}
	}

	/**
	 * @param array $cfg_array
	 * @param array $df_settings
	 */
	private function _get_multi_select(array &$cfg_array, array $df_settings)
	{
		$multi_select = utf8_normalize_nfc($this->request->variable('config', array('' => array('' => '')), true));
		$multi_select = array_filter($multi_select);

		foreach ($multi_select as $field => $settings)
		{
			$cfg_array[$field] = (!empty($settings)) ? $settings : $df_settings[$field]['default'];
		}
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2015 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\sitemaker\services\blocks;
11
12		use blitze\sitemaker\services\blocks\cfg_fields;
13
14		class cfg_handler extends cfg_fields
15		{
16		/** @var \phpbb\request\request_interface */
17		protected $request;
18
19		/** @var \phpbb\template\template */
20		protected $template;
21
22		/** @var \phpbb\user */
23		protected $user;
24
25		/** @var string phpBB root path */
26		protected $phpbb_root_path;
27
28		/** @var string phpEx */
29		protected $php_ext;
30
31		/**
32		* Constructor
33		*
34		* @param \phpbb\request\request_interface $request Request object
35		* @param \phpbb\template\template $template Template object
36		* @param \phpbb\user $user User object
37		* @param \blitze\sitemaker\services\groups $groups Groups object
38		* @param string $phpbb_root_path phpBB root path
39		* @param string $php_ext phpEx
40		*/
41	44	public function __construct(\phpbb\request\request_interface $request, \phpbb\template\template $template, \phpbb\user $user, \blitze\sitemaker\services\groups $groups, $phpbb_root_path, $php_ext)
42		{
43	44	parent::__construct($user);
44
45	44	$this->request = $request;
46	44	$this->template = $template;
47	44	$this->user = $user;
48	44	$this->groups = $groups;
		0 ignored issues – show Bug introduced 2015-12-19 02:39 UTC by Report Bug Copy Issue Report The property `groups` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
49	44	$this->phpbb_root_path = $phpbb_root_path;
50	44	$this->php_ext = $php_ext;
51	44	}
52
53		/**
54		* @param array $block_data
55		* @param array $default_settings
56		* @return template\|string
57		*/
58	7	public function get_edit_form(array $block_data, array $default_settings)
59		{
60	7	global $module;
61
62	7	if (!function_exists('build_cfg_template'))
63	7	{
64	1	include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
65	1	}
66
67		// We fake this class as it is needed by the build_cfg_template function
68	7	$module = new \stdClass();
69	7	$module->module = $this;
70
71	7	$this->_generate_config_fields($block_data['settings'], $default_settings);
72	7	$selected_groups = $this->_ensure_array($block_data['permission']);
73
74	7	$this->template->assign_vars(array(
75	7	'S_ACTIVE' => $block_data['status'],
76	7	'S_TYPE' => $block_data['type'],
77	7	'S_NO_WRAP' => $block_data['no_wrap'],
78	7	'S_HIDE_TITLE' => $block_data['hide_title'],
79	7	'S_BLOCK_CLASS' => trim($block_data['class']),
80	7	'S_GROUP_OPS' => $this->groups->get_options('special', $selected_groups),
81	7	));
82
83	7	$this->template->set_filenames(array(
84	7	'block_settings' => 'block_settings.html',
85	7	));
86
87	7	return $this->template->assign_display('block_settings');
88		}
89
90		/**
91		* @param array $default_settings
92		* @return array\|void
93		*/
94	6	public function get_submitted_settings(array $default_settings)
95		{
96	6	if (!function_exists('validate_config_vars'))
97	6	{
98		include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
99		}
100
101	6	$cfg_array = utf8_normalize_nfc($this->request->variable('config', array('' => ''), true));
102
103	6	$errors = array();
104	6	validate_config_vars($default_settings, $cfg_array, $errors);
105
106	6	if (sizeof($errors))
107	6	{
108	1	return array('errors' => join("\n", $errors));
109		}
110
111	5	$this->_get_multi_select($cfg_array, $default_settings);
112
113	5	return array_intersect_key($cfg_array, $default_settings);
114		}
115
116		/**
117		* Generate block configuration fields
118		*
119		* @param array $db_settings
120		* @param array $default_settings
121		*/
122	7	private function _generate_config_fields(array &$db_settings, array $default_settings)
123		{
124	7	foreach ($default_settings as $field => $vars)
125		{
126	6	if ($this->_sets_legend($field, $vars) \|\| !is_array($vars))
127	6	{
128	6	continue;
129		}
130
131	6	$db_settings[$field] = $this->_get_field_value($field, $vars['default'], $db_settings);
132	6	$content = $this->_get_field_template($field, $db_settings, $vars);
133
134	6	$this->template->assign_block_vars('options', array(
135	6	'KEY' => $field,
136	6	'TITLE' => $this->user->lang($vars['lang']),
137	6	'S_EXPLAIN' => $vars['explain'],
138	6	'TITLE_EXPLAIN' => $vars['lang_explain'],
139	6	'CONTENT' => $content,
140	6	));
141	6	unset($default_settings[$field]);
142	7	}
143	7	}
144
145		/**
146		* @param $field
147		* @param array $db_settings
148		* @param array $vars
149		* @return string
150		*/
151	6	private function _get_field_template($field, array &$db_settings, array &$vars)
152		{
153	6	$vars['lang_explain'] = $this->_explain_field($vars);
154	6	$vars['append'] = $this->_append_field($vars);
155
156	6	$type = explode(':', $vars['type']);
157	6	$method = '_prep_' . $type[0] . '_field_for_display';
158
159	6	if (is_callable(array($this, $method)))
160	6	{
161	5	$this->_set_params($field, $vars, $db_settings);
162	5	$this->$method($vars, $type, $field, $db_settings);
163	5	}
164
165	6	return build_cfg_template($type, $field, $db_settings, $field, $vars);
166		}
167
168		/**
169		* @param string $field
170		* @param string\|array $vars
171		* @return boolean
172		*/
173	6	private function _sets_legend($field, $vars)
174		{
175	6	if (strpos($field, 'legend') !== false)
176	6	{
177	6	$this->template->assign_block_vars('options', array(
178	6	'S_LEGEND' => $field,
179	6	'LEGEND' => $this->user->lang($vars)
180	6	));
181
182	6	return true;
183		}
184
185	6	return false;
186		}
187
188		/**
189		* @param array $vars
190		* @return mixed\|string
191		*/
192	6	private function _explain_field(array $vars)
193		{
194	6	$l_explain = '';
195	6	if (!empty($vars['explain']))
196	6	{
197	2	$l_explain = (isset($vars['lang_explain'])) ? $this->user->lang($vars['lang_explain']) : $this->user->lang($vars['lang'] . '_EXPLAIN');
198	2	}
199
200	6	return $l_explain;
201		}
202
203		/**
204		* @param array $vars
205		* @return mixed\|string
206		*/
207	6	private function _append_field(array $vars)
208		{
209	6	$append = '';
210	6	if (!empty($vars['append']))
211	6	{
212	1	$append = $this->user->lang($vars['append']);
213	1	}
214
215	6	return $append;
216		}
217
218		/**
219		* @param $field
220		* @param $vars
221		* @param $settings
222		*/
223	5	private function _set_params($field, &$vars, $settings)
224		{
225	5	if (!empty($vars['options']))
226	5	{
227	3	$vars['params'][] = $vars['options'];
228	3	$vars['params'][] = $settings[$field];
229	3	}
230	5	}
231
232		/**
233		* @param $field
234		* @param $default
235		* @param $db_settings
236		* @return mixed
237		*/
238	6	private function _get_field_value($field, $default, $db_settings)
239		{
240	6	return (!empty($db_settings[$field])) ? $db_settings[$field] : $default;
241		}
242
243		/**
244		* @param $vars
245		*/
246	1	private function _prep_select_field_for_display(&$vars)
247		{
248	1	$this->_add_lang_vars($vars['params'][0]);
249
250	1	$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : 'build_select';
251	1	}
252
253		/**
254		* @param $vars
255		* @param $type
256		* @param $field
257		*/
258	2	private function _prep_checkbox_field_for_display(&$vars, &$type, $field)
259		{
260	2	$this->_add_lang_vars($vars['params'][0]);
261
262	2	$vars['method'] = 'build_checkbox';
263	2	$vars['params'][] = $field;
264	2	$type[0] = 'custom';
265	2	}
266
267		/**
268		* @param $vars
269		* @param $type
270		* @param $field
271		*/
272	1	private function _prep_multi_select_field_for_display(&$vars, &$type, $field)
273		{
274	1	$this->_prep_checkbox_field_for_display($vars, $type, $field);
275
276	1	$vars['method'] ='build_multi_select';
277	1	}
278
279		/**
280		* @param $vars
281		* @param $type
282		*/
283	1	private function _prep_hidden_field_for_display(&$vars, &$type)
284		{
285	1	$vars['method'] = 'build_hidden';
286	1	$vars['explain'] = '';
287	1	$vars['lang'] = '';
288	1	$type[0] = 'custom';
289	1	}
290
291		/**
292		* @param $vars
293		* @param $type
294		*/
295	1	private function _prep_custom_field_for_display(&$vars, &$type)
296		{
297	1	$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : '';
298	1	$type[0] = 'custom';
299	1	}
300
301		/**
302		* this looks bad but its the only way without modifying phpbb code
303		* this is for select items that do not need to be translated
304		* @param array $options
305		*/
306	4	private function _add_lang_vars(array $options)
307		{
308	3	foreach ($options as $title)
309		{
310	3	if (!isset($this->user->lang[$title]))
311	3	{
312	3	$this->user->lang[$title] = $title;
313	3	}
314	3	}
315	4	}
316
317		/**
318		* @param array $cfg_array
319		* @param array $df_settings
320		*/
321	5	private function _get_multi_select(array &$cfg_array, array $df_settings)
322		{
323	5	$multi_select = utf8_normalize_nfc($this->request->variable('config', array('' => array('' => '')), true));
324	5	$multi_select = array_filter($multi_select);
325
326	5	foreach ($multi_select as $field => $settings)
327		{
328	1	$cfg_array[$field] = (!empty($settings)) ? $settings : $df_settings[$field]['default'];
329	5	}
330	5	}
331		}
332

blitze / phpBB-ext-sitemaker

Push — master ( c96b51...1deced )

cfg_handler B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

17 Methods

Duplication Side-by-Side

Filter issues like