acp_prune::handle() - Code Metrics - Inspection of "UNC v1.1.0" - Dark1z/usernotificationcontrol - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5)

by Dark❶

created 2021-10-02 13:34 UTC

acp_prune::handle() A

↳ Parent: acp_prune

Complexity

Conditions	4
Paths	8

Size

Total Lines	60
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	38
c	1
b	0
f	0
dl	0
loc	60
rs	9.312
cc	4
nc	8
nop	0

How to fix Long Method

<?php
/**
 *
 * User Notification Control [UNC]. An extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2020-2021, Dark❶, https://dark1.tech
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace dark1\usernotificationcontrol\controller;

/**
 * @ignore
 */
use phpbb\language\language;
use phpbb\log\log;
use phpbb\request\request;
use phpbb\template\template;
use phpbb\user;
use phpbb\config\config;
use phpbb\cron\manager as cron_manager;
use phpbb\db\driver\driver_interface as db_driver;

/**
 * User Notification Control [UNC] ACP controller Prune.
 */
class acp_prune extends acp_base
{
	/** @var language */
	protected $language;

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

	/** @var cron_manager */
	protected $cron_manager;

	/** @var db_driver */
	protected $db;

	/** @var string phpBB root path */
	protected $phpbb_root_path;

	/** @var string phpBB adm relative path */
	protected $phpbb_adm_relative_path;

	/** @var string phpBB php ext */
	protected $php_ext;

	/** Time Format */
	const TIME_FORMAT	= 'Y-m-d h:i:s A P';

	/**
	 * Constructor.
	 *
	 * @param language			$language					Language object
	 * @param log				$log						Log object
	 * @param request			$request					Request object
	 * @param template			$template					Template object
	 * @param user				$user						User object
	 * @param config			$config						Config object
	 * @param cron_manager		$cron_manager				Cron manager
	 * @param db_driver			$db							Database object
	 * @param string			$phpbb_root_path			phpBB root path
	 * @param string			$phpbb_adm_relative_path	phpBB adm relative path
	 * @param string			$php_ext					phpBB php ext
	 */
	public function __construct(language $language, log $log, request $request, template $template, user $user, config $config, cron_manager $cron_manager, db_driver $db, $phpbb_root_path, $phpbb_adm_relative_path, $php_ext)
	{
		parent::__construct($language, $log, $request, $template, $user);

		$this->language					= $language;
		$this->config					= $config;
		$this->cron_manager				= $cron_manager;
		$this->db						= $db;
		$this->phpbb_root_path			= $phpbb_root_path;
		$this->phpbb_adm_relative_path	= $phpbb_adm_relative_path;
		$this->php_ext					= $php_ext;
	}

	/**
	 * Display the options a user can configure for Cron Mode.
	 *
	 * @return void
	 * @access public
	 */
	public function handle()
	{
		// Is the form being submitted to us?
		if ($this->request->is_set_post('submit'))
		{
			$this->check_form_on_submit();

			// Set the options the user configured
			$this->config->set('dark1_unc_all_notify_expire_days', $this->request->variable('dark1_unc_all_notify_expire_days', 0));
			$this->config->set('dark1_unc_auto_prune_notify_enable', $this->request->variable('dark1_unc_auto_prune_notify_enable', 0));
			$this->config->set('dark1_unc_auto_prune_notify_gc', ($this->request->variable('dark1_unc_auto_prune_notify_gc', 0)) * 86400);

			$this->success_form_on_submit();
		}

		// Run Cron Task
		if ($this->request->is_set_post('runcrontask'))
		{
			$this->check_form_on_submit();

			$cron_task = $this->cron_manager->find_task('dark1.usernotificationcontrol.cron.auto_prune_notify');
			$cron_task->run();

			$this->success_form_on_submit();
		}

		$this->language->add_lang('acp/board');
		$main_adm_path = $this->phpbb_root_path . $this->phpbb_adm_relative_path . 'index.' . $this->php_ext;
		$read_expire_link = append_sid($main_adm_path, 'i=acp_board&amp;mode=load').'#read_notification_expire_days';

		$days = $this->config['read_notification_expire_days'] + $this->config['dark1_unc_all_notify_expire_days'];
		$timestamp = time() - ($days * 86400);
		foreach (['all' => '> 0', 'exp' => '< '.$timestamp, 'rem' => '>= '.$timestamp] as $key => $value)
		{
			$sql = 'SELECT `notification_read`, COUNT(*) AS `count`' .
					' FROM ' . NOTIFICATIONS_TABLE .
					' WHERE `notification_time` ' . (string) $value .
					' GROUP BY `notification_read`' .
					' ORDER BY `notification_read` ASC';
			$result = $this->db->sql_query($sql);
			$rows = $this->db->sql_fetchrowset($result);
			$this->db->sql_freeresult($result);

			$this->template->assign_block_vars('stats', [
				'TYPE'		=> $this->language->lang('ACP_UNC_STAT_' . strtoupper($key)),
				'UNREAD'	=> (int) $rows[0]['count'],
				'READ'		=> (int) $rows[1]['count'],
			]);
		}

		// Set output variables for display in the template
		$this->template->assign_vars([
			'UNC_READ_EXPIRE'		=> $this->config['read_notification_expire_days'],
			'UNC_READ_EXPIRE_LINK'	=> $read_expire_link,
			'UNC_ALL_EXPIRE'		=> $this->config['dark1_unc_all_notify_expire_days'],
			'UNC_TOTAL_EXPIRE'		=> $days,
			'UNC_ENABLE_CRON'		=> $this->config['dark1_unc_auto_prune_notify_enable'],
			'UNC_CRON_INTERVAL'		=> ($this->config['dark1_unc_auto_prune_notify_gc'] / 86400),
			'UNC_CRON_LAST_RUN'		=> $this->user->format_date($this->config['dark1_unc_auto_prune_notify_last_gc'], self::TIME_FORMAT, true),
			'UNC_CRON_NEXT_RUN'		=> $this->user->format_date($this->config['dark1_unc_auto_prune_notify_last_gc'] + $this->config['dark1_unc_auto_prune_notify_gc'], self::TIME_FORMAT, true),
		]);
	}
}


1			<?php
2			/**
3			*
4			* User Notification Control [UNC]. An extension for the phpBB Forum Software package.
5			*
6			* @copyright (c) 2020-2021, Dark❶, https://dark1.tech
7			* @license GNU General Public License, version 2 (GPL-2.0)
8			*
9			*/
10
11			namespace dark1\usernotificationcontrol\controller;
12
13			/**
14			* @ignore
15			*/
16			use phpbb\language\language;
17			use phpbb\log\log;
18			use phpbb\request\request;
19			use phpbb\template\template;
20			use phpbb\user;
21			use phpbb\config\config;
22			use phpbb\cron\manager as cron_manager;
23			use phpbb\db\driver\driver_interface as db_driver;
24
25			/**
26			* User Notification Control [UNC] ACP controller Prune.
27			*/
28			class acp_prune extends acp_base
29			{
30			/** @var language */
31			protected $language;
32
33			/** @var config */
34			protected $config;
35
36			/** @var cron_manager */
37			protected $cron_manager;
38
39			/** @var db_driver */
40			protected $db;
41
42			/** @var string phpBB root path */
43			protected $phpbb_root_path;
44
45			/** @var string phpBB adm relative path */
46			protected $phpbb_adm_relative_path;
47
48			/** @var string phpBB php ext */
49			protected $php_ext;
50
51			/** Time Format */
52			const TIME_FORMAT = 'Y-m-d h:i:s A P';
53
54			/**
55			* Constructor.
56			*
57			* @param language $language Language object
58			* @param log $log Log object
59			* @param request $request Request object
60			* @param template $template Template object
61			* @param user $user User object
62			* @param config $config Config object
63			* @param cron_manager $cron_manager Cron manager
64			* @param db_driver $db Database object
65			* @param string $phpbb_root_path phpBB root path
66			* @param string $phpbb_adm_relative_path phpBB adm relative path
67			* @param string $php_ext phpBB php ext
68			*/
69			public function __construct(language $language, log $log, request $request, template $template, user $user, config $config, cron_manager $cron_manager, db_driver $db, $phpbb_root_path, $phpbb_adm_relative_path, $php_ext)
70			{
71			parent::__construct($language, $log, $request, $template, $user);
72
73			$this->language = $language;
74			$this->config = $config;
75			$this->cron_manager = $cron_manager;
76			$this->db = $db;
77			$this->phpbb_root_path = $phpbb_root_path;
78			$this->phpbb_adm_relative_path = $phpbb_adm_relative_path;
79			$this->php_ext = $php_ext;
80			}
81
82			/**
83			* Display the options a user can configure for Cron Mode.
84			*
85			* @return void
86			* @access public
87			*/
88			public function handle()
89			{
90			// Is the form being submitted to us?
91			if ($this->request->is_set_post('submit'))
92			{
93			$this->check_form_on_submit();
94
95			// Set the options the user configured
96			$this->config->set('dark1_unc_all_notify_expire_days', $this->request->variable('dark1_unc_all_notify_expire_days', 0));
97			$this->config->set('dark1_unc_auto_prune_notify_enable', $this->request->variable('dark1_unc_auto_prune_notify_enable', 0));
98			$this->config->set('dark1_unc_auto_prune_notify_gc', ($this->request->variable('dark1_unc_auto_prune_notify_gc', 0)) * 86400);
99
100			$this->success_form_on_submit();
101			}
102
103			// Run Cron Task
104			if ($this->request->is_set_post('runcrontask'))
105			{
106			$this->check_form_on_submit();
107
108			$cron_task = $this->cron_manager->find_task('dark1.usernotificationcontrol.cron.auto_prune_notify');
109			$cron_task->run();
110
111			$this->success_form_on_submit();
112			}
113
114			$this->language->add_lang('acp/board');
115			$main_adm_path = $this->phpbb_root_path . $this->phpbb_adm_relative_path . 'index.' . $this->php_ext;
116			$read_expire_link = append_sid($main_adm_path, 'i=acp_board&mode=load').'#read_notification_expire_days';
117
118			$days = $this->config['read_notification_expire_days'] + $this->config['dark1_unc_all_notify_expire_days'];
119			$timestamp = time() - ($days * 86400);
120			foreach (['all' => '> 0', 'exp' => '< '.$timestamp, 'rem' => '>= '.$timestamp] as $key => $value)
121			{
122			$sql = 'SELECT `notification_read`, COUNT(*) AS `count`' .
123			' FROM ' . NOTIFICATIONS_TABLE .
124			' WHERE `notification_time` ' . (string) $value .
125			' GROUP BY `notification_read`' .
126			' ORDER BY `notification_read` ASC';
127			$result = $this->db->sql_query($sql);
128			$rows = $this->db->sql_fetchrowset($result);
129			$this->db->sql_freeresult($result);
130
131			$this->template->assign_block_vars('stats', [
132			'TYPE' => $this->language->lang('ACP_UNC_STAT_' . strtoupper($key)),
133			'UNREAD' => (int) $rows[0]['count'],
134			'READ' => (int) $rows[1]['count'],
135			]);
136			}
137
138			// Set output variables for display in the template
139			$this->template->assign_vars([
140			'UNC_READ_EXPIRE' => $this->config['read_notification_expire_days'],
141			'UNC_READ_EXPIRE_LINK' => $read_expire_link,
142			'UNC_ALL_EXPIRE' => $this->config['dark1_unc_all_notify_expire_days'],
143			'UNC_TOTAL_EXPIRE' => $days,
144			'UNC_ENABLE_CRON' => $this->config['dark1_unc_auto_prune_notify_enable'],
145			'UNC_CRON_INTERVAL' => ($this->config['dark1_unc_auto_prune_notify_gc'] / 86400),
146			'UNC_CRON_LAST_RUN' => $this->user->format_date($this->config['dark1_unc_auto_prune_notify_last_gc'], self::TIME_FORMAT, true),
147			'UNC_CRON_NEXT_RUN' => $this->user->format_date($this->config['dark1_unc_auto_prune_notify_last_gc'] + $this->config['dark1_unc_auto_prune_notify_gc'], self::TIME_FORMAT, true),
148			]);
149			}
150			}
151

Dark1z / usernotificationcontrol

Pull Request — master (#5)

acp_prune::handle() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like