blitze\sitemaker\acp\settings_module

Complexity

Total Complexity

22

Size/Duplication

Total Lines	289
Duplicated Lines	0 %

Test Coverage

Coverage

99.17%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	save_config_settings()	0	9	2
A	check_form_key()	0	5	2
A	get_layouts()	0	19	2
A	__construct()	0	19	1
A	handle_cleanup()	0	15	5
A	get_style_pref()	0	13	2
A	main()	0	36	1
A	get_menu_options()	0	17	3
A	get_styles_data()	0	23	2
A	handle_submit()	0	21	2

<?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', 'navbar_manager'], '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((string) $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;
	}
}