marc1706\quickedit\event\listener_helper

Complexity

Total Complexity

26

Size/Duplication

Total Lines	209
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	is_catchable_request()	0	4	3
A	add_hidden_fields()	0	32	4
A	not_empty_or_default()	0	4	2
A	enable_quick_edit()	0	10	3
A	modify_acp_display_vars()	0	23	3
A	check_topic_edit()	0	11	4
A	check_forum_permissions()	0	11	3
A	add_hidden_if_exists()	0	11	2
A	isset_or_default()	0	4	1

<?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\auth\auth;
use phpbb\config\config;
use phpbb\request\request;
use phpbb\request\request_interface;

class listener_helper
{
	/** @var auth */
	protected $auth;

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

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

	/** @var int quickedit forums flag */
	const QUICKEDIT_FLAG = 128;

	/**
	 * Constructor for listener
	 *
	 * @param auth $auth phpBB auth
	 * @param config $config phpBB config
	 * @param request_interface $request $request phpBB request
	 */
	public function __construct(auth $auth, config $config, request_interface $request)
	{
		$this->auth = $auth;
		$this->config = $config;
		$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.

	}

	/**
	* Check if request is a catchable request
	*
	* @param object $event The event object
	* @return bool True if it's a catchable request, false if not
	*/
	public function is_catchable_request($event) : bool
	{
		return $this->request->is_ajax() && !$event['submit'] && $event['mode'] == 'edit';
	}

	/**
	* Add hidden fields in order to prevent dropping the needed values upon
	* submission.
	*
	* @param object $event The event object
	* @return void
	*/
	public function add_hidden_fields(&$event)
	{
		$hidden_fields = [
			'attachment_data' 		=> $event['message_parser']->attachment_data,
			'poll_vote_change'		=> $this->not_empty_or_default($event['post_data']['poll_vote_change'], ' checked="checked"', ''),
			'poll_title'			=> $this->isset_or_default($event['post_data']['poll_title'], ''),
			'poll_option_text'		=> $this->not_empty_or_default($event['post_data']['poll_options'], implode("\n", $event['post_data']['poll_options']), ''),
			'poll_max_options'		=> $this->isset_or_default((int) $event['post_data']['poll_max_options'], 1),
			'poll_length'			=> $event['post_data']['poll_length'],
			'topic_status'			=> $event['post_data']['topic_status'],
		];

		if (!empty($event['post_data']['post_edit_locked']))
		{
			$hidden_fields['lock_post'] = $event['post_data']['post_edit_locked'];
		}

		if (!empty($event['post_data']['enable_sig']))
		{
			$hidden_fields['attach_sig'] = $event['post_data']['enable_sig'];
		}

		if (!empty($event['post_data']['topic_status']))
		{
			$hidden_fields['lock_topic'] = true;
		}

		$event['s_hidden_fields'] .= build_hidden_fields($hidden_fields);

		// Add hidden fields for kinerity/topicdescriptions
		$event['s_hidden_fields'] = $this->add_hidden_if_exists($event['s_hidden_fields'], $event['post_data'], 'topic_desc');
	}

	/**
	* Returns value if it is set, otherwise the default
	*
	* @param mixed $value The variable to check
	* @param mixed $default The default value to use if variable is not set
	* @return mixed Value if variable is set, default value if not
	*/
	protected function isset_or_default($value, $default)
	{
		return $value ?? $default;
	}

	/**
	* Returns value if it's not empty, otherwise the default
	*
	* @param mixed $check_value The variable to check
	* @param mixed $value The value if $check_value is not empty
	* @param mixed $default The default value to use if variable is empty
	* @return mixed Value if $check_value is not empty, default value if not
	*/
	protected function not_empty_or_default($check_value, $value, $default)
	{
		return (!empty($check_value)) ? $value : $default;
	}

	/**
	* Enable quick edit
	*
	* @param object $event The event object
	* @return void
	*/
	public function enable_quick_edit($event)
	{
		$cfg_array = ($this->request->is_set('config')) ? $this->request->variable('config', array('' => '')) : '';
		if (isset($cfg_array['allow_quick_edit']))
		{
			$this->config->set('allow_quick_edit', (bool) $cfg_array['allow_quick_edit']);
			\enable_bitfield_column_flag(FORUMS_TABLE, 'forum_flags', log(self::QUICKEDIT_FLAG, 2));
		}
		$event->offsetSet('submit', true);
	}

	/**
	* Add quickedit settings to acp settings by modifying the display vars
	*
	* @param object $event The event object
	* @return void
	*/
	public function modify_acp_display_vars($event)
	{
		$new_display_var = array(
			'title'	=> $event['display_vars']['title'],
			'vars'	=> array(),
		);

		foreach ($event['display_vars']['vars'] as $key => $content)
		{
			$new_display_var['vars'][$key] = $content;
			if ($key == 'allow_quick_reply')
			{
				$new_display_var['vars']['allow_quick_edit'] = array(
					'lang'		=> 'ALLOW_QUICK_EDIT',
					'validate'	=> 'bool',
					'type'		=> 'custom',
					'function'	=> array('marc1706\quickedit\event\listener', 'quickedit_settings'),
					'explain' 	=> true,
				);
			}
		}
		$event->offsetSet('display_vars', $new_display_var);
	}

	/**
	* Check whether user can edit in this topic and forum
	*
	* @param object $event The event object
	* @return bool True if user can edit in this topic or forum, else false
	*/
	public function check_topic_edit($event) : bool
	{
		if (($event['topic_data']['forum_status'] == ITEM_UNLOCKED && $event['topic_data']['topic_status'] == ITEM_UNLOCKED) || $this->auth->acl_get('m_edit', $event['forum_id']))
		{
			return true;
		}
		else
		{
			return false;
		}
	}

	/**
	* Check forum_permissions and flag
	*
	* @param object $event The event object
	* @return bool True if quickedit is enabled and user can reply in forum,
	*		false if not
	*/
	public function check_forum_permissions($event) : bool
	{
		if (($event['topic_data']['forum_flags'] & self::QUICKEDIT_FLAG) && $this->auth->acl_get('f_reply', $event['forum_id']))
		{
			return true;
		}
		else
		{
			return false;
		}
	}

	/**
	 * Add data to hidden fields if column exists in post_data array
	 *
	 * @param string $hidden_fields Hidden fields data
	 * @param array $data_array post_data array
	 * @param string $column Column name
	 *
	 * @return string Hidden fields data
	 */
	protected function add_hidden_if_exists(string $hidden_fields, array $data_array, string $column) : string
	{
		if (isset($data_array[$column]))
		{
			$hidden_fields .= build_hidden_fields(array(
				$column		=> $data_array[$column],
			));
		}

		return $hidden_fields;
	}
}