marc1706\quickedit\event\listener

Complexity

Total Complexity

19

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

98.72%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getSubscribedEvents()	0	12	1
A	catch_ajax_requests()	0	21	2
A	acp_board_settings()	0	14	3
A	quickedit_settings()	0	12	1
A	add_forums_request_data()	0	6	1
A	initialise_forums_flag_data()	0	6	2
A	acp_forums_settings()	0	8	2
A	acp_forums_update_data()	0	7	2
A	check_quickedit_enabled()	0	11	4

<?php
/**
*
* @package Quickedit
* @copyright (c) 2015 - 2021 Marc Alexander ( www.m-a-styles.de )
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

namespace marc1706\quickedit\event;

use phpbb\config\config;
use phpbb\json_response;
use phpbb\language\language;
use phpbb\request\request;
use phpbb\request\request_interface;
use phpbb\template\template;
use phpbb\template\twig\twig;
use phpbb\user;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class listener implements EventSubscriberInterface
{
	/** @var config */
	protected $config;

	/** @var listener_helper */
	protected $helper;

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

	/** @var twig */
	protected $template;

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

	/* @var language */
	protected $language;

	/**
	 * Constructor for listener
	 *
	 * @param config $config phpBB config
	 * @param listener_helper $helper Listener helper
	 * @param request_interface $request $request phpBB request
	 * @param template $template phpBB template
	 * @param user $user phpBB user
	 * @param language $language
	 */
	public function __construct(config $config, listener_helper $helper, request_interface $request, template $template, user $user, language $language)
	{
		$this->config = $config;
		$this->helper = $helper;
		$this->request = $request;

It seems like $request of type object<phpbb\request\request_interface> is incompatible with the declared type object<phpbb\request\request> of property $request.

		$this->template = $template;

It seems like $template of type object<phpbb\template\template> is incompatible with the declared type object<phpbb\template\twig\twig> of property $template.

		$this->user = $user;
		$this->language = $language;
	}

	/**
	* Assign functions defined in this class to event listeners in the core
	*
	* @return array
	* @static
	*/
	static public function getSubscribedEvents() : array
	{
		return array(
			'core.posting_modify_template_vars'		=> 'catch_ajax_requests',
			'core.acp_board_config_edit_add'		=> 'acp_board_settings',
			'core.acp_manage_forums_request_data'		=> 'add_forums_request_data',
			'core.acp_manage_forums_initialise_data'	=> 'initialise_forums_flag_data',
			'core.acp_manage_forums_display_form'		=> 'acp_forums_settings',
			'core.acp_manage_forums_update_data_before'	=> 'acp_forums_update_data',
			'core.viewtopic_modify_page_title'		=> 'check_quickedit_enabled',
		);
	}

	/**
	 * Check if request is ajax and output quickedit if it is
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function catch_ajax_requests($event) : void
	{
		// Parse page for quickedit window
		if ($this->helper->is_catchable_request($event))
		{
			// Add hidden fields
			$this->helper->add_hidden_fields($event);

			// Update S_HIDDEN_FIELDS in page_data
			$this->template->assign_vars(array_merge($event['page_data'], array('S_HIDDEN_FIELDS' => $event['s_hidden_fields'])));
			$this->template->set_filenames(array(
				'body'	=> '@marc1706_quickedit/quickedit_body.html'
			));

			$json = new json_response();
			$json->send(array(
				'POST_ID'	=> $event['post_id'],
				'MESSAGE'	=> $this->template->assign_display('body'),
			));
		}
	}

	/**
	 * Set ACP board settings
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function acp_board_settings($event) : void
	{
		if ($event['mode'] == 'features')
		{
			$this->helper->modify_acp_display_vars($event);

			$this->language->add_lang('quickedit_acp', 'marc1706/quickedit');

			if ($this->request->is_set_post('allow_quick_edit_enable'))
			{
				$this->helper->enable_quick_edit($event);
			}
		}
	}

	/**
	 * Global quick edit enable/disable setting and button to enable in all forums
	 *
	 * @param int $value Value of quickedit settings. 1 if enabled, 0 if disabled
	 * @param string $key The key of the setting
	 * @return string HTML for quickedit settings
	 */
	static public function quickedit_settings(int $value, string $key) : string
	{
		// Called statically so can't use $this->language
		global $language;

		$language->add_lang('quickedit_acp', 'marc1706/quickedit');

		$radio_ary = array(1 => 'YES', 0 => 'NO');

		return h_radio('config[allow_quick_edit]', $radio_ary, $value) .
			'<br /><br /><input class="button2" type="submit" id="' . $key . '_enable" name="' . $key . '_enable" value="' . $language->lang('ALLOW_QUICK_EDIT_BUTTON') . '" />';
	}

	/**
	 * Add quickedit settings to forums request data
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function add_forums_request_data($event) : void
	{
		$forum_data = $event['forum_data'];
		$forum_data += array('enable_quick_edit' => $this->request->variable('enable_quick_edit', false));
		$event->offsetSet('forum_data', $forum_data);
	}

	/**
	 * Add quickedit flag to forums_flag
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function initialise_forums_flag_data($event) : void
	{
		$forum_data = $event['forum_data'];
		$forum_data['forum_flags'] += ($this->request->variable('enable_quick_edit', false)) ? listener_helper::QUICKEDIT_FLAG : 0;
		$event->offsetSet('forum_data', $forum_data);
	}

	/**
	 * Add quickedit setting to acp_forums settings
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function acp_forums_settings($event) : void
	{
		$this->language->add_lang('quickedit_acp', 'marc1706/quickedit');

		$template_data = $event['template_data'];
		$template_data['S_ENABLE_QUICK_EDIT'] = ($event['forum_data']['forum_flags'] & listener_helper::QUICKEDIT_FLAG) ? true : false;
		$event->offsetSet('template_data', $template_data);
	}

	/**
	 * Update the forum_data_sql with the correct flag before submitting
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function acp_forums_update_data($event) : void
	{
		$forum_data_sql = $event['forum_data_sql'];
		$forum_data_sql['forum_flags'] += ($forum_data_sql['enable_quick_edit']) ? listener_helper::QUICKEDIT_FLAG : 0;
		unset($forum_data_sql['enable_quick_edit']);
		$event->offsetSet('forum_data_sql', $forum_data_sql);
	}

	/**
	 * Check if quickedit is enabled and assign S_QUICK_EDIT accordingly
	 *
	 * @param object $event The event object
	 * @return void
	 */
	public function check_quickedit_enabled($event) : void
	{
		// Check if quick edit is available
		$s_quick_edit = false;
		if ($this->user->data['is_registered'] && $this->config['allow_quick_edit'] && $this->helper->check_forum_permissions($event))
		{
			// Quick edit enabled forum
			$s_quick_edit = $this->helper->check_topic_edit($event);
		}
		$this->template->assign_var('S_QUICK_EDIT', $s_quick_edit);
	}
}