phpbb\mediaembed\acp\main_module

Complexity

Total Complexity

15

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
B	main()	0	26	5
A	display()	0	9	1
B	get_sites()	0	23	4
A	save_manage()	0	11	1
A	save_settings()	0	8	1
A	check_form_key()	0	7	2

<?php
/**
 *
 * phpBB Media Embed PlugIn extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2016 phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace phpbb\mediaembed\acp;

/**
 * phpBB Media Embed Plugin ACP module.
 */
class main_module
{
	/** @var \phpbb\cache\driver\driver_interface $cache */
	protected $cache;

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

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

	/** @var \Symfony\Component\DependencyInjection\ContainerInterface $container */
	protected $container;

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

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

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

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

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

	/**
	 * Constructor
	 */
	public function __construct()
	{
		global $phpbb_container;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		$this->container   = $phpbb_container;
		$this->cache       = $this->container->get('cache');
		$this->config      = $this->container->get('config');
		$this->config_text = $this->container->get('config_text');
		$this->request     = $this->container->get('request');
		$this->template    = $this->container->get('template');
		$this->language    = $this->container->get('language');
		$this->form_key    = 'phpbb/mediaembed';

		$this->language->add_lang('acp', 'phpbb/mediaembed');
	}

	/**
	 * Main ACP module
	 *
	 * @param int    $id   The module ID
	 * @param string $mode The module mode
	 */
	public function main($id, $mode)

The parameter $id is not used and could be removed.

	{
		add_form_key($this->form_key);
		switch ($mode)
		{
			case 'manage':
				if ($this->request->is_set_post('submit'))
				{
					$this->save_manage();
				}
				$this->display($mode, [
					'MEDIA_SITES' => $this->get_sites(),
				]);
			break;

			case 'settings':
				if ($this->request->is_set_post('submit'))
				{
					$this->save_settings();
				}
				$this->display($mode, [
					'S_MEDIA_EMBED_BBCODE' => $this->config['media_embed_bbcode'],
				]);
			break;
		}
	}

	/**
	 * Display data in the ACP module
	 *
	 * @param string $mode The ACP module mode (manage|settings)
	 * @param array  $data Array of data to assign to the template
	 */
	protected function display($mode, $data)
	{
		$this->tpl_name   = 'acp_phpbb_mediaembed_' . strtolower($mode);

The property tpl_name does not exist. Did you maybe forget to declare it?

		$this->page_title = $this->language->lang('ACP_MEDIA_' . strtoupper($mode));

The property page_title does not exist. Did you maybe forget to declare it?

		$this->template->assign_vars(array_merge($data, [
			'U_ACTION'	=> $this->u_action,
		]));
	}

	/**
	 * Get a list of available sites
	 *
	 * @return array An array of available sites
	 */
	protected function get_sites()
	{
		$sites = [];

		$checked_sites = $this->config_text->get('media_embed_sites');
		$checked_sites = $checked_sites ? json_decode($checked_sites, true) : [];

		$configurator = $this->container->get('text_formatter.s9e.factory')->get_configurator();
		foreach ($configurator->MediaEmbed->defaultSites->getIds() as $siteId)
		{
			if (isset($configurator->BBCodes[$siteId]))
			{
				continue;
			}

			$sites[] = [
				'name'		=> $siteId,
				'checked'	=> in_array($siteId, $checked_sites),
			];
		}

		return $sites;
	}

	/**
	 * Save site managed data to the database
	 */
	protected function save_manage()
	{
		$this->check_form_key();

		$this->config_text->set('media_embed_sites', json_encode($this->request->variable('mark', [''])));

		$this->cache->destroy($this->container->getParameter('text_formatter.cache.parser.key'));
		$this->cache->destroy($this->container->getParameter('text_formatter.cache.renderer.key'));

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

	/**
	 * Save settings data to the database
	 */
	protected function save_settings()
	{
		$this->check_form_key();

		$this->config->set('media_embed_bbcode', $this->request->variable('media_embed_bbcode', 0));

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

	/**
	 * Check the form key, trigger error if invalid
	 */
	protected function check_form_key()
	{
		if (!check_form_key($this->form_key))
		{
			trigger_error('FORM_INVALID');
		}
	}
}