vse\topicpreview\acp\topic_preview_module

Complexity

Total Complexity

10

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

97.53%

Importance

Changes	16
Bugs	0	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	main()	0	21	3
A	display_settings()	0	17	1
A	submit_settings()	0	16	2
A	set_style_theme()	0	10	1
A	get_styles()	0	12	1
A	get_themes()	0	20	1

<?php
/**
*
* Topic Preview
*
* @copyright (c) 2013 Matt Friedman
* @license GNU General Public License, version 2 (GPL-2.0)
*
*/

namespace vse\topicpreview\acp;

/**
* @package acp
*/
class topic_preview_module
{
	const NO_THEME = 'no';
	const DEFAULT_THEME = 'light';

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

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

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

	/** @var \phpbb\extension\manager */
	protected $ext_manager;

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

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

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

	/** @var string */
	protected $phpbb_root_path;

	/** @var array */
	protected $themes;

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

	/**
	 * Constructor
	 */
	public function __construct()
	{
		global $cache, $config, $db, $phpbb_extension_manager, $request, $template, $user, $phpbb_root_path;

		$this->cache = $cache;
		$this->config = $config;
		$this->db = $db;
		$this->ext_manager = $phpbb_extension_manager;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->phpbb_root_path = $phpbb_root_path;

		$this->user->add_lang_ext('vse/topicpreview', 'topic_preview_acp');
	}

	/**
	 * Main ACP module
	 *
	 * @param int    $id
	 * @param string $mode
	 * @return null
	 */
	public function main($id, $mode)
	{
		$this->tpl_name = 'acp_topic_preview';
		$this->page_title = $this->user->lang('TOPIC_PREVIEW');

		$form_key = 'acp_topic_preview';
		add_form_key($form_key);

		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key($form_key))
			{
				trigger_error($this->user->lang('FORM_INVALID') . adm_back_link($this->u_action), E_USER_WARNING);
			}

			$this->submit_settings();
			trigger_error($this->user->lang('CONFIG_UPDATED') . adm_back_link($this->u_action));
		}

		$this->display_settings();
	}

	/**
	 * Display the settings with the current config values
	 */
	protected function display_settings()
	{
		$this->template->assign_vars(array(
			'TOPIC_PREVIEW_LIMIT'		=> $this->config['topic_preview_limit'],
			'TOPIC_PREVIEW_WIDTH'		=> $this->config['topic_preview_width'],
			'TOPIC_PREVIEW_DELAY'		=> $this->config['topic_preview_delay'],
			'TOPIC_PREVIEW_DRIFT'		=> $this->config['topic_preview_drift'],
			'S_TOPIC_PREVIEW_AVATARS'	=> $this->config['topic_preview_avatars'],
			'S_TOPIC_PREVIEW_LAST_POST'	=> $this->config['topic_preview_last_post'],
			'TOPIC_PREVIEW_STRIP'		=> $this->config['topic_preview_strip_bbcodes'],
			'TOPIC_PREVIEW_STYLES'		=> $this->get_styles(),
			'TOPIC_PREVIEW_THEMES'		=> $this->get_themes(),
			'TOPIC_PREVIEW_DEFAULT'		=> self::DEFAULT_THEME,
			'TOPIC_PREVIEW_NO_THEME'	=> self::NO_THEME,
			'U_ACTION'					=> $this->u_action,
		));
	}

	/**
	 * Submit the settings from the form to the database
	 */
	protected function submit_settings()
	{
		$this->config->set('topic_preview_limit', abs($this->request->variable('topic_preview_limit', 0))); // abs() no negative values
		$this->config->set('topic_preview_width', abs($this->request->variable('topic_preview_width', 0))); // abs() no negative values
		$this->config->set('topic_preview_delay', abs($this->request->variable('topic_preview_delay', 0))); // abs() no negative values
		$this->config->set('topic_preview_drift', $this->request->variable('topic_preview_drift', 0));
		$this->config->set('topic_preview_avatars', $this->request->variable('topic_preview_avatars', 0));
		$this->config->set('topic_preview_last_post', $this->request->variable('topic_preview_last_post', 0));
		$this->config->set('topic_preview_strip_bbcodes', $this->request->variable('topic_preview_strip_bbcodes', ''));

		$styles = $this->get_styles();
		foreach ($styles as $row)
		{
			$this->set_style_theme($row['style_id'], $this->request->variable('style_' . $row['style_id'], ''));
		}
	}

	/**
	 * Update topic_preview_theme setting in the styles table
	 *
	 * @param int    $style_id Identifier of the board style
	 * @param string $theme    Name of the selected theme
	 * @return null
	 */
	protected function set_style_theme($style_id, $theme)
	{
		$sql = 'UPDATE ' . STYLES_TABLE . "
			SET topic_preview_theme = '" . $this->db->sql_escape($theme) . "'
			WHERE style_id = " . (int) $style_id;

		$this->db->sql_query($sql);

		$this->cache->destroy('sql', STYLES_TABLE);
	}

	/**
	 * Get style data from the styles table
	 *
	 * @return array Style data array
	 */
	protected function get_styles()
	{
		$sql = 'SELECT style_id, style_name, topic_preview_theme
			FROM ' . STYLES_TABLE . '
			WHERE style_active = 1';
		$result = $this->db->sql_query($sql);

		$rows = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		return $rows;
	}

	/**
	 * Get file names from Topic Preview's CSS files
	 *
	 * @return array File name data array
	 */
	protected function get_themes()
	{
		$finder = $this->ext_manager->get_finder();

		// Find css files in ext/vse/topicpreview/styles/all/theme/
		$themes = $finder
			->extension_suffix('.css')
			->extension_directory('/styles/all/theme')
			->find_from_extension('topicpreview', $this->phpbb_root_path . 'ext/vse/topicpreview/');

		// Get just basenames of array keys
		$themes = array_map(function ($value) {
			return basename($value, '.css');
		}, array_keys($themes));

		// Add option for native browser tooltip (aka no theme)
		$themes[] = self::NO_THEME;

		return $themes;
	}
}