main_module::check_form_key() - Code Metrics - Inspection of "Merge pull request #31 from VSEphpbb/updates" - phpbb-extensions/mediaembed - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1f6ba6...205aeb )

by Matt

created 2017-05-01 08:01 UTC

main_module::check_form_key() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	2
eloc	3
nc	2
nop	0

<?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\language\language $language */
	protected $language;

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

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

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

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

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

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

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

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

	/**
	 * Constructor
	 */
	public function __construct()
	{
		global $phpbb_container;
function myFunction($a, $b) {
    // Do something
}

		$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->language    = $this->container->get('language');
		$this->log         = $this->container->get('log');
		$this->request     = $this->container->get('request');
		$this->template    = $this->container->get('template');
		$this->user        = $this->container->get('user');

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

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

	{
		$mode = strtolower($mode);

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

		$form_key = 'phpbb/mediaembed';
		add_form_key($form_key);

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

			$this->{'save_' . $mode}();
		}

		$this->{'display_' . $mode}();
	}

	/**
	 * Add settings template vars to the form
	 */
	protected function display_settings()
	{
		$this->template->assign_vars([
			'S_MEDIA_EMBED_BBCODE'		=> $this->config['media_embed_bbcode'],
			'S_MEDIA_EMBED_ALLOW_SIG'	=> $this->config['media_embed_allow_sig'],
			'U_ACTION'					=> $this->u_action,
		]);
	}

	/**
	 * Add manage sites template vars to the form
	 */
	protected function display_manage()
	{
		$this->template->assign_vars([
			'MEDIA_SITES'	=> $this->get_sites(),
			'U_ACTION'		=> $this->u_action,
		]);
	}

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

		$configurator = $this->container->get('text_formatter.s9e.factory')->get_configurator();
		foreach ($configurator->MediaEmbed->defaultSites as $siteId => $siteConfig)
		{
			$disabled = isset($configurator->BBCodes[$siteId]);
			$sites[] = [
				'id'		=> $siteId,
				'name'		=> $siteConfig['name'],
				'title'		=> $this->language->lang($disabled ? 'ACP_MEDIA_SITE_DISABLED' : 'ACP_MEDIA_SITE_TITLE', $siteId),
				'enabled'	=> in_array($siteId, $this->get_enabled_sites()),
				'disabled'	=> $disabled,
			];
		}

		return $sites;
	}

	/**
	 * Get enabled media sites stored in the database
	 *
	 * @return array An array of enabled sites
	 */
	protected function get_enabled_sites()
	{
		if ($this->enabled_sites === null)
		{
			$sites = json_decode($this->config_text->get('media_embed_sites'), true);
			$this->enabled_sites = is_array($sites) ? $sites : [];
		}

		return $this->enabled_sites;
	}

	/**
	 * Save site managed data to the database
	 */
	protected function save_manage()
	{
		$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'));

		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PHPBB_MEDIA_EMBED_MANAGE');

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

	/**
	 * Save settings data to the database
	 */
	protected function save_settings()
	{
		$this->config->set('media_embed_bbcode', $this->request->variable('media_embed_bbcode', 0));
		$this->config->set('media_embed_allow_sig', $this->request->variable('media_embed_allow_sig', 0));

		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PHPBB_MEDIA_EMBED_SETTINGS');

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


1			<?php
2			/**
3			*
4			* phpBB Media Embed PlugIn extension for the phpBB Forum Software package.
5			*
6			* @copyright (c) 2016 phpBB Limited <https://www.phpbb.com>
7			* @license GNU General Public License, version 2 (GPL-2.0)
8			*
9			*/
10
11			namespace phpbb\mediaembed\acp;
12
13			/**
14			* phpBB Media Embed Plugin ACP module.
15			*/
16			class main_module
17			{
18			/** @var \phpbb\cache\driver\driver_interface $cache */
19			protected $cache;
20
21			/** @var \phpbb\config\config $config */
22			protected $config;
23
24			/** @var \phpbb\config\db_text $config_text */
25			protected $config_text;
26
27			/** @var \Symfony\Component\DependencyInjection\ContainerInterface $container */
28			protected $container;
29
30			/** @var \phpbb\language\language $language */
31			protected $language;
32
33			/** @var \phpbb\log\log $log */
34			protected $log;
35
36			/** @var \phpbb\request\request $request */
37			protected $request;
38
39			/** @var \phpbb\template\template $template */
40			protected $template;
41
42			/** @var \phpbb\user */
43			protected $user;
44
45			/** @var array $enabled_sites */
46			protected $enabled_sites;
47
48			/** @var string $page_title */
49			public $page_title;
50
51			/** @var string $tpl_name */
52			public $tpl_name;
53
54			/** @var string $u_action */
55			public $u_action;
56
57			/**
58			* Constructor
59			*/
60			public function __construct()
61			{
62			global $phpbb_container;
			0 ignored issues – show Compatibility Best Practice introduced 2016-09-30 16:17 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
63
64			$this->container = $phpbb_container;
65			$this->cache = $this->container->get('cache');
66			$this->config = $this->container->get('config');
67			$this->config_text = $this->container->get('config_text');
68			$this->language = $this->container->get('language');
69			$this->log = $this->container->get('log');
70			$this->request = $this->container->get('request');
71			$this->template = $this->container->get('template');
72			$this->user = $this->container->get('user');
73
74			$this->language->add_lang('acp', 'phpbb/mediaembed');
75			}
76
77			/**
78			* Main ACP module
79			*
80			* @param int $id The module ID (not used)
81			* @param string $mode The module mode (manage\|settings)
82			*/
83			public function main($id, $mode)
			0 ignored issues – show Unused Code introduced 2017-04-23 19:40 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
84			{
85			$mode = strtolower($mode);
86
87			$this->tpl_name = 'acp_phpbb_mediaembed_' . $mode;
88			$this->page_title = $this->language->lang('ACP_MEDIA_' . strtoupper($mode));
89
90			$form_key = 'phpbb/mediaembed';
91			add_form_key($form_key);
92
93			if ($this->request->is_set_post('submit'))
94			{
95			if (!check_form_key($form_key))
96			{
97			trigger_error('FORM_INVALID', E_USER_WARNING);
98			}
99
100			$this->{'save_' . $mode}();
101			}
102
103			$this->{'display_' . $mode}();
104			}
105
106			/**
107			* Add settings template vars to the form
108			*/
109			protected function display_settings()
110			{
111			$this->template->assign_vars([
112			'S_MEDIA_EMBED_BBCODE' => $this->config['media_embed_bbcode'],
113			'S_MEDIA_EMBED_ALLOW_SIG' => $this->config['media_embed_allow_sig'],
114			'U_ACTION' => $this->u_action,
115			]);
116			}
117
118			/**
119			* Add manage sites template vars to the form
120			*/
121			protected function display_manage()
122			{
123			$this->template->assign_vars([
124			'MEDIA_SITES' => $this->get_sites(),
125			'U_ACTION' => $this->u_action,
126			]);
127			}
128
129			/**
130			* Get a list of available sites
131			*
132			* @return array An array of available sites
133			*/
134			protected function get_sites()
135			{
136			$sites = [];
137
138			$configurator = $this->container->get('text_formatter.s9e.factory')->get_configurator();
139			foreach ($configurator->MediaEmbed->defaultSites as $siteId => $siteConfig)
140			{
141			$disabled = isset($configurator->BBCodes[$siteId]);
142			$sites[] = [
143			'id' => $siteId,
144			'name' => $siteConfig['name'],
145			'title' => $this->language->lang($disabled ? 'ACP_MEDIA_SITE_DISABLED' : 'ACP_MEDIA_SITE_TITLE', $siteId),
146			'enabled' => in_array($siteId, $this->get_enabled_sites()),
147			'disabled' => $disabled,
148			];
149			}
150
151			return $sites;
152			}
153
154			/**
155			* Get enabled media sites stored in the database
156			*
157			* @return array An array of enabled sites
158			*/
159			protected function get_enabled_sites()
160			{
161			if ($this->enabled_sites === null)
162			{
163			$sites = json_decode($this->config_text->get('media_embed_sites'), true);
164			$this->enabled_sites = is_array($sites) ? $sites : [];
165			}
166
167			return $this->enabled_sites;
168			}
169
170			/**
171			* Save site managed data to the database
172			*/
173			protected function save_manage()
174			{
175			$this->config_text->set('media_embed_sites', json_encode($this->request->variable('mark', [''])));
176
177			$this->cache->destroy($this->container->getParameter('text_formatter.cache.parser.key'));
178			$this->cache->destroy($this->container->getParameter('text_formatter.cache.renderer.key'));
179
180			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PHPBB_MEDIA_EMBED_MANAGE');
181
182			trigger_error($this->language->lang('CONFIG_UPDATED') . adm_back_link($this->u_action));
183			}
184
185			/**
186			* Save settings data to the database
187			*/
188			protected function save_settings()
189			{
190			$this->config->set('media_embed_bbcode', $this->request->variable('media_embed_bbcode', 0));
191			$this->config->set('media_embed_allow_sig', $this->request->variable('media_embed_allow_sig', 0));
192
193			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PHPBB_MEDIA_EMBED_SETTINGS');
194
195			trigger_error($this->language->lang('CONFIG_UPDATED') . adm_back_link($this->u_action));
196			}
197			}
198

phpbb-extensions / mediaembed

Push — master ( 1f6ba6...205aeb )

main_module::check_form_key() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like