settings_module::save_filemanager_settings() - Code Metrics - Inspection of "Add renovate.json" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — renovate/configure ( 3d37a9...8f147e )

unknown

created 2020-09-22 02:59 UTC

settings_module::save_filemanager_settings() A

↳ Parent: Project

Complexity

Conditions	4
Paths	5

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	4
eloc	10
c	2
b	0
f	0
nc	5
nop	1
dl	0
loc	19
rs	9.9332

<?php

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

namespace blitze\sitemaker\acp;

/**
 * @package acp
 */
class settings_module
{
	/** @var \phpbb\config\config */
	protected $config;

	/** @var \phpbb\config\db_text */
	protected $config_text;

	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

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

	/** @var \phpbb\event\dispatcher_interface */
	protected $phpbb_dispatcher;

	/** @var \phpbb\request\request_interface */
	protected $request;

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

	/** @var \phpbb\language\language */
	protected $translator;

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

	/** @var \blitze\sitemaker\services\icons\picker */
	protected $icon;

	/** @var \blitze\sitemaker\services\blocks\cleaner */
	protected $blocks_cleaner;

	/** @var \blitze\sitemaker\model\mapper_factory */
	protected $mapper_factory;

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

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

	/** @var string */
	public $tpl_name;

	/** @var string */
	public $page_title;

	/** @var string */
	public $u_action;

	/**
	 * settings_module constructor.
	 */
	public function __construct()
	{
		global $phpbb_container, $phpbb_dispatcher, $config, $db, $request, $template, $user, $phpbb_root_path, $phpEx;

		$this->db = $db;
		$this->config = $config;
		$this->phpbb_dispatcher = $phpbb_dispatcher;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $phpEx;

		$this->config_text = $phpbb_container->get('config_text');
		$this->finder = $phpbb_container->get('ext.manager')->get_finder();
		$this->translator = $phpbb_container->get('language');
		$this->blocks_cleaner = $phpbb_container->get('blitze.sitemaker.blocks.cleaner');
		$this->icon = $phpbb_container->get('blitze.sitemaker.icons.picker');
		$this->mapper_factory = $phpbb_container->get('blitze.sitemaker.mapper.factory');
	}

	/**
	 * @return void
	 */
	public function main()
	{
		$this->translator->add_lang('acp/board');
		$this->translator->add_lang('blocks_admin', 'blitze/sitemaker');

		$form_key = 'blitze/sitemaker/settings';

		$this->handle_cleanup($form_key);
		$this->handle_submit($form_key);

		add_form_key($form_key);

		$layouts = $this->get_layouts();

		/**
		 * Event to display acp settings form
		 *
		 * @event blitze.sitemaker.acp_display_settings_form
		 * @var	array	layouts		Array of layout settings
		 * @since 3.1.0
		 */
		$vars = array('layouts');
		extract($this->phpbb_dispatcher->trigger_event('blitze.sitemaker.acp_display_settings_form', compact($vars)));

		$this->template->assign_vars(array(
			'u_action'			=> $this->u_action,
			'icon_picker'		=> $this->icon->picker(),
			'config'			=> $this->config,
			'styles'			=> $this->get_styles_data($layouts),
			'layouts'			=> $layouts,
			'menu_options'		=> $this->get_menu_options(),
			'sm_user_lang'		=> $this->user->data['user_lang'],
		));

		$this->tpl_name = 'acp_settings';
		$this->page_title = 'ACP_SM_SETTINGS';
	}

	/**
	 * @param string $form_key
	 * @return void
	 */
	protected function handle_cleanup($form_key)
	{
		if (!$this->request->is_set_post('submit') && $orphans = $this->blocks_cleaner->get_orphans())
		{
			$components = $this->request->variable('cleanup', array(0 => ''));

			if ($this->request->is_set_post('orphans') && sizeof($components))
			{
				$this->check_form_key($form_key);
				$this->blocks_cleaner->run($components);

				trigger_error($this->translator->lang('BLOCKS_CLEANUP_DONE') . adm_back_link($this->u_action));
			}

			$this->template->assign_var('orphaned_blocks', $orphans);
		}
	}

	/**
	 * @param string $form_key
	 * @return void
	 */
	protected function handle_submit($form_key)
	{
		if ($this->request->is_set_post('submit'))
		{
			$settings = $this->request->variable('config', array('' => ''));

			$this->check_form_key($form_key);

			/**
			 * Event to save acp settings
			 *
			 * @event blitze.sitemaker.acp_save_settings
			 * @var	array	settings	Array of settings: [config_key] => [config_value]
			 * @since 3.1.0
			 */
			$vars = array('settings');
			extract($this->phpbb_dispatcher->trigger_event('blitze.sitemaker.acp_save_settings', compact($vars)));

			$this->save_config_settings($settings);

			trigger_error($this->translator->lang('SETTINGS_SAVED') . adm_back_link($this->u_action));
		}
	}

	/**
	 * @param string $form_key
	 */
	protected function check_form_key($form_key)
	{
		if (!check_form_key($form_key))
		{
			trigger_error('FORM_INVALID', E_USER_WARNING);
		}
	}

	/**
	 * @param array $layouts
	 * @return array
	 */
	protected function get_styles_data(array $layouts)
	{
		$style_prefs = (array) json_decode($this->config_text->get('sm_layout_prefs'), true);

		$result = $this->db->sql_query('SELECT style_id, style_name FROM ' . STYLES_TABLE);

		$styles = array();
		while ($row = $this->db->sql_fetchrow($result))
		{
			$id = $row['style_id'];

			$pref = $this->get_style_pref($id, $style_prefs, $layouts['portal']);

			$styles[] = array(
				'id'		=> $id,
				'name'		=> $row['style_name'],
				'layout'	=> $pref['layout'],
				'view'		=> $pref['view'],
			);
		}
		$this->db->sql_freeresult();

		return $styles;
	}

	/**
	 * @param int $style_id
	 * @param array $style_prefs
	 * @param string $default_layout
	 * @return array
	 */
	protected function get_style_pref($style_id, array $style_prefs, $default_layout)
	{
		$pref = array(
			'layout'	=> $default_layout,
			'view'		=> '',
		);

		if (isset($style_prefs[$style_id]))
		{
			$pref = $style_prefs[$style_id];
		}

		return $pref;
	}

	/**
	 * @return array
	 */
	protected function get_layouts()
	{
		$files = $this->finder
			->suffix('_layout.twig')
			->extension_directory('/styles')
			->find();
		$files = array_keys($files);

		$layouts = array();
		foreach ($files as $path)
		{
			$path = dirname($path);
			$name = basename($path);

			$layouts[$name] = $this->phpbb_root_path . $path . '/';
		}
		ksort($layouts);

		return $layouts;
	}

	/**
	 * @param array $settings
	 * @return void
	 */
	protected function save_config_settings(array $settings)
	{
		$layout_prefs = $this->request->variable('layouts', array(0 => array('' => '')));

		$this->config_text->set('sm_layout_prefs', json_encode($layout_prefs));

		foreach ($settings as $key => $value)
		{
			$this->config->set($key, $value);
		}
	}

	/**
	 * @return string
	 */
	protected function get_menu_options()
	{
		$menu_mapper = $this->mapper_factory->create('menus');

		// Get all menus
		$collection = $menu_mapper->find();

		$options = '';
		foreach ($collection as $entity)
		{
			$id = $entity->get_menu_id();
			$name = $entity->get_menu_name();
			$selected = ($id == $this->config['sm_navbar_menu']) ? ' selected="selected"' : '';
			$options .= '<option value="' . $id . '"' . $selected . '>' . $name . '</option>';
		}

		return $options;
	}
}


1			<?php
2
3			/**
4			*
5			* @package sitemaker
6			* @copyright (c) 2013 Daniel A. (blitze)
7			* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
8			*
9			*/
10
11			namespace blitze\sitemaker\acp;
12
13			/**
14			* @package acp
15			*/
16			class settings_module
17			{
18			/** @var \phpbb\config\config */
19			protected $config;
20
21			/** @var \phpbb\config\db_text */
22			protected $config_text;
23
24			/** @var \phpbb\db\driver\driver_interface */
25			protected $db;
26
27			/** @var \phpbb\finder */
28			protected $finder;
29
30			/** @var \phpbb\event\dispatcher_interface */
31			protected $phpbb_dispatcher;
32
33			/** @var \phpbb\request\request_interface */
34			protected $request;
35
36			/** @var \phpbb\template\template */
37			protected $template;
38
39			/** @var \phpbb\language\language */
40			protected $translator;
41
42			/** @var \phpbb\user */
43			protected $user;
44
45			/** @var \blitze\sitemaker\services\icons\picker */
46			protected $icon;
47
48			/** @var \blitze\sitemaker\services\blocks\cleaner */
49			protected $blocks_cleaner;
50
51			/** @var \blitze\sitemaker\model\mapper_factory */
52			protected $mapper_factory;
53
54			/** @var string phpBB root path */
55			protected $phpbb_root_path;
56
57			/** @var string phpEx */
58			protected $php_ext;
59
60			/** @var string */
61			public $tpl_name;
62
63			/** @var string */
64			public $page_title;
65
66			/** @var string */
67			public $u_action;
68
69			/**
70			* settings_module constructor.
71			*/
72			public function __construct()
73			{
74			global $phpbb_container, $phpbb_dispatcher, $config, $db, $request, $template, $user, $phpbb_root_path, $phpEx;
75
76			$this->db = $db;
77			$this->config = $config;
78			$this->phpbb_dispatcher = $phpbb_dispatcher;
79			$this->request = $request;
80			$this->template = $template;
81			$this->user = $user;
82			$this->phpbb_root_path = $phpbb_root_path;
83			$this->php_ext = $phpEx;
84
85			$this->config_text = $phpbb_container->get('config_text');
86			$this->finder = $phpbb_container->get('ext.manager')->get_finder();
87			$this->translator = $phpbb_container->get('language');
88			$this->blocks_cleaner = $phpbb_container->get('blitze.sitemaker.blocks.cleaner');
89			$this->icon = $phpbb_container->get('blitze.sitemaker.icons.picker');
90			$this->mapper_factory = $phpbb_container->get('blitze.sitemaker.mapper.factory');
91			}
92
93			/**
94			* @return void
95			*/
96			public function main()
97			{
98			$this->translator->add_lang('acp/board');
99			$this->translator->add_lang('blocks_admin', 'blitze/sitemaker');
100
101			$form_key = 'blitze/sitemaker/settings';
102
103			$this->handle_cleanup($form_key);
104			$this->handle_submit($form_key);
105
106			add_form_key($form_key);
107
108			$layouts = $this->get_layouts();
109
110			/**
111			* Event to display acp settings form
112			*
113			* @event blitze.sitemaker.acp_display_settings_form
114			* @var array layouts Array of layout settings
115			* @since 3.1.0
116			*/
117			$vars = array('layouts');
118			extract($this->phpbb_dispatcher->trigger_event('blitze.sitemaker.acp_display_settings_form', compact($vars)));
119
120			$this->template->assign_vars(array(
121			'u_action' => $this->u_action,
122			'icon_picker' => $this->icon->picker(),
123			'config' => $this->config,
124			'styles' => $this->get_styles_data($layouts),
125			'layouts' => $layouts,
126			'menu_options' => $this->get_menu_options(),
127			'sm_user_lang' => $this->user->data['user_lang'],
128			));
129
130			$this->tpl_name = 'acp_settings';
131			$this->page_title = 'ACP_SM_SETTINGS';
132			}
133
134			/**
135			* @param string $form_key
136			* @return void
137			*/
138			protected function handle_cleanup($form_key)
139			{
140			if (!$this->request->is_set_post('submit') && $orphans = $this->blocks_cleaner->get_orphans())
141			{
142			$components = $this->request->variable('cleanup', array(0 => ''));
143
144			if ($this->request->is_set_post('orphans') && sizeof($components))
145			{
146			$this->check_form_key($form_key);
147			$this->blocks_cleaner->run($components);
148
149			trigger_error($this->translator->lang('BLOCKS_CLEANUP_DONE') . adm_back_link($this->u_action));
150			}
151
152			$this->template->assign_var('orphaned_blocks', $orphans);
153			}
154			}
155
156			/**
157			* @param string $form_key
158			* @return void
159			*/
160			protected function handle_submit($form_key)
161			{
162			if ($this->request->is_set_post('submit'))
163			{
164			$settings = $this->request->variable('config', array('' => ''));
165
166			$this->check_form_key($form_key);
167
168			/**
169			* Event to save acp settings
170			*
171			* @event blitze.sitemaker.acp_save_settings
172			* @var array settings Array of settings: [config_key] => [config_value]
173			* @since 3.1.0
174			*/
175			$vars = array('settings');
176			extract($this->phpbb_dispatcher->trigger_event('blitze.sitemaker.acp_save_settings', compact($vars)));
177
178			$this->save_config_settings($settings);
179
180			trigger_error($this->translator->lang('SETTINGS_SAVED') . adm_back_link($this->u_action));
181			}
182			}
183
184			/**
185			* @param string $form_key
186			*/
187			protected function check_form_key($form_key)
188			{
189			if (!check_form_key($form_key))
190			{
191			trigger_error('FORM_INVALID', E_USER_WARNING);
192			}
193			}
194
195			/**
196			* @param array $layouts
197			* @return array
198			*/
199			protected function get_styles_data(array $layouts)
200			{
201			$style_prefs = (array) json_decode($this->config_text->get('sm_layout_prefs'), true);
202
203			$result = $this->db->sql_query('SELECT style_id, style_name FROM ' . STYLES_TABLE);
204
205			$styles = array();
206			while ($row = $this->db->sql_fetchrow($result))
207			{
208			$id = $row['style_id'];
209
210			$pref = $this->get_style_pref($id, $style_prefs, $layouts['portal']);
211
212			$styles[] = array(
213			'id' => $id,
214			'name' => $row['style_name'],
215			'layout' => $pref['layout'],
216			'view' => $pref['view'],
217			);
218			}
219			$this->db->sql_freeresult();
220
221			return $styles;
222			}
223
224			/**
225			* @param int $style_id
226			* @param array $style_prefs
227			* @param string $default_layout
228			* @return array
229			*/
230			protected function get_style_pref($style_id, array $style_prefs, $default_layout)
231			{
232			$pref = array(
233			'layout' => $default_layout,
234			'view' => '',
235			);
236
237			if (isset($style_prefs[$style_id]))
238			{
239			$pref = $style_prefs[$style_id];
240			}
241
242			return $pref;
243			}
244
245			/**
246			* @return array
247			*/
248			protected function get_layouts()
249			{
250			$files = $this->finder
251			->suffix('_layout.twig')
252			->extension_directory('/styles')
253			->find();
254			$files = array_keys($files);
255
256			$layouts = array();
257			foreach ($files as $path)
258			{
259			$path = dirname($path);
260			$name = basename($path);
261
262			$layouts[$name] = $this->phpbb_root_path . $path . '/';
263			}
264			ksort($layouts);
265
266			return $layouts;
267			}
268
269			/**
270			* @param array $settings
271			* @return void
272			*/
273			protected function save_config_settings(array $settings)
274			{
275			$layout_prefs = $this->request->variable('layouts', array(0 => array('' => '')));
276
277			$this->config_text->set('sm_layout_prefs', json_encode($layout_prefs));
278
279			foreach ($settings as $key => $value)
280			{
281			$this->config->set($key, $value);
282			}
283			}
284
285			/**
286			* @return string
287			*/
288			protected function get_menu_options()
289			{
290			$menu_mapper = $this->mapper_factory->create('menus');
291
292			// Get all menus
293			$collection = $menu_mapper->find();
294
295			$options = '';
296			foreach ($collection as $entity)
297			{
298			$id = $entity->get_menu_id();
299			$name = $entity->get_menu_name();
300			$selected = ($id == $this->config['sm_navbar_menu']) ? ' selected="selected"' : '';
301			$options .= '<option value="' . $id . '"' . $selected . '>' . $name . '</option>';
302			}
303
304			return $options;
305			}
306			}
307

blitze / phpBB-ext-sitemaker

Push — renovate/configure ( 3d37a9...8f147e )

settings_module::save_filemanager_settings() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like