user_menu::install() - Code Metrics - board3/Board3-Portal - Measure and Improve Code Quality continuously with Scrutinizer

user_menu::install() A
last analyzed 2017-11-05 10:33 UTC

↳ Parent: user_menu

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	6
ccs	0
cts	5
cp	0
crap	2
rs	9.4285
c	0
b	0
f	0

<?php
/**
*
* @package Board3 Portal v2.1
* @copyright (c) 2013 Board3 Group ( www.board3.de )
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

namespace board3\portal\modules;

/**
* @package User menu
*/
class user_menu extends module_base
{
	/**
	* Allowed columns: Just sum up your options (Exp: left + right = 10)
	* top		1
	* left		2
	* center	4
	* right		8
	* bottom	16
	*/
	public $columns = 10;

	/**
	* Default modulename
	*/
	public $name = 'USER_MENU';

	/**
	* Default module-image:
	* file must be in "{T_THEME_PATH}/images/portal/"
	*/
	public $image_src = 'portal_user.png';

	/**
	* module-language file
	* file must be in "language/{$user->lang}/mods/portal/"
	*/
	public $language = 'portal_user_menu_module';

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

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

	/** @var \phpbb\controller\helper */
	protected $controller_helper;

	/** @var \phpbb\db\driver */
	protected $db;

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

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

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

	/** @var string PHP file extension */
	protected $php_ext;

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

	/**
	* Construct a user menu object
	*
	* @param \phpbb\auth\auth $auth phpBB auth
	* @param \phpbb\config\config $config phpBB config
	* @param \phpbb\controller\helper $controller_helper Controller helper
	* @param \phpbb\db\driver $db phpBB db driver
	* @param \phpbb\path_helper $path_helper phpBB path helper
	* @param \phpbb\template $template phpBB template
	* @param \phpbb\user $user phpBB user
	* @param string $phpbb_root_path phpBB root path
	* @param string $phpEx php file extension
	*/
	public function __construct($auth, $config, $controller_helper, $db, $path_helper, $template, $user, $phpbb_root_path, $phpEx)
	{
		$this->auth = $auth;
		$this->config = $config;
		$this->controller_helper = $controller_helper;
		$this->db = $db;
		$this->path_helper = $path_helper;
		$this->template = $template;
		$this->user = $user;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $phpEx;
	}

	/**
	* {@inheritdoc}
	*/
	public function get_template_side($module_id)
	{
		if (!function_exists('phpbb_get_user_rank'))
		{
			include($this->phpbb_root_path . 'includes/functions_display.' . $this->php_ext);
		}

		if ($this->user->data['is_registered'])
		{
			//
			// + new posts since last visit & you post number
			//
			$ex_fid_ary = array_unique(array_merge(array_keys($this->auth->acl_getf('!f_read', true)), array_keys($this->auth->acl_getf('!f_search', true))));

			if ($this->auth->acl_get('m_approve'))
			{
				$m_approve_fid_sql = '';
			}
			else if ($this->auth->acl_getf_global('m_approve'))
			{
				$m_approve_fid_ary = array_diff(array_keys($this->auth->acl_getf('!m_approve', true)), $ex_fid_ary);
				$m_approve_fid_sql = ' AND (p.post_visibility = 1' . ((sizeof($m_approve_fid_ary)) ? ' OR ' . $this->db->sql_in_set('p.forum_id', $m_approve_fid_ary, true) : '') . ')';
			}
			else
			{
				$m_approve_fid_sql = ' AND p.post_visibility = 1';
			}

			$sql = 'SELECT COUNT(DISTINCT t.topic_id) as total
						FROM ' . TOPICS_TABLE . ' t
						WHERE t.topic_last_post_time > ' . (int) $this->user->data['user_lastvisit'] . '
							AND t.topic_moved_id = 0
							' . str_replace(array('p.', 'post_'), array('t.', 'topic_'), $m_approve_fid_sql) . '
							' . ((sizeof($ex_fid_ary)) ? 'AND ' . $this->db->sql_in_set('t.forum_id', $ex_fid_ary, true) : '');
			$result = $this->db->sql_query($sql, 600);
			$new_posts_count = (int) $this->db->sql_fetchfield('total');
			$this->db->sql_freeresult($result);

			// unread posts
			$sql_where = 'AND t.topic_moved_id = 0
							' . str_replace(array('p.', 'post_'), array('t.', 'topic_'), $m_approve_fid_sql) . '
							' . ((sizeof($ex_fid_ary)) ? 'AND ' . $this->db->sql_in_set('t.forum_id', $ex_fid_ary, true) : '');
			$unread_list = get_unread_topics($this->user->data['user_id'], $sql_where, 'ORDER BY t.topic_id DESC');
			$unread_posts_count = sizeof($unread_list);

			// Get user avatar and rank
			$user_id = $this->user->data['user_id'];
			$username = $this->user->data['username'];
			$colour = $this->user->data['user_colour'];
			$avatar_img = phpbb_get_avatar(\phpbb\avatar\manager::clean_row($this->user->data, 'user'), 'USER_AVATAR');
			$rank_data = phpbb_get_user_rank($this->user->data, $this->user->data['user_posts']);

			// Assign specific vars
			$this->template->assign_vars(array(
				'L_NEW_POSTS'	=> $this->user->lang['SEARCH_NEW'] . '&nbsp;(' . $new_posts_count . ')',
				'L_SELF_POSTS'	=> $this->user->lang['SEARCH_SELF'] . '&nbsp;(' . $this->user->data['user_posts'] . ')',
				'L_UNREAD_POSTS'=> $this->user->lang['SEARCH_UNREAD'] . '&nbsp;(' . $unread_posts_count . ')',

				'B3P_AVATAR_IMG'    => $avatar_img,
				'B3P_RANK_TITLE'    => $rank_data['title'],
				'B3P_RANK_IMG'        => $rank_data['img'],
				'RANK_IMG_SRC'    => $rank_data['img_src'],

				'USERNAME_FULL'        => get_username_string('full', $user_id, $username, $colour),
				'U_VIEW_PROFILE'	=> get_username_string('profile', $user_id, $username, $colour),

				'U_NEW_POSTS'			=> append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=newposts'),
				'U_SELF_POSTS'			=> append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=egosearch'),
				'U_UNREAD_POSTS'		=> append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=unreadposts'),
				'U_UM_BOOKMARKS'		=> ($this->config['allow_bookmarks']) ? append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'i=main&amp;mode=bookmarks') : '',
				'U_UM_MAIN_SUBSCRIBED'	=> append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'i=main&amp;mode=subscribed'),
				'U_UM_MCP'				=> ($this->auth->acl_get('m_') || $this->auth->acl_getf_global('m_')) ? append_sid("{$this->phpbb_root_path}mcp.{$this->php_ext}", 'i=main&amp;mode=front', true, $this->user->session_id) : '',
				'S_DISPLAY_SUBSCRIPTIONS' => ($this->config['allow_topic_notify'] || $this->config['allow_forum_notify']) ? true : false,
			));

			return 'user_menu_side.html';
		}
		else
		{
			/*
			* Assign specific vars
			* Need to remove web root path as ucp.php will do the
			* redirect
			*/
			$this->template->assign_vars(array(
				'U_PORTAL_REDIRECT'	=> $this->path_helper->remove_web_root_path($this->controller_helper->route('board3_portal_controller')),
				'S_DISPLAY_FULL_LOGIN'	=> true,
				'S_AUTOLOGIN_ENABLED'	=> ($this->config['allow_autologin']) ? true : false,
				'S_LOGIN_ACTION'	=> append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'mode=login'),
				'S_SHOW_REGISTER'	=> ($this->config['board3_user_menu_register_' . $module_id]) ? true : false,
			));

			return 'login_box_side.html';
		}
	}

	/**
	* {@inheritdoc}
	*/
	public function get_template_acp($module_id)
	{
		return array(
			'title'	=> 'USER_MENU',
			'vars'	=> array(
				'legend1'					=> 'USER_MENU_SETTINGS',
				'board3_user_menu_register_' . $module_id	=> array('lang' => 'USER_MENU_REGISTER', 'validate' => 'bool', 'type' => 'radio:yes_no',	 'explain' => false),
			),
		);
	}

	/**
	* {@inheritdoc}
	*/
	public function install($module_id)
	{
		$this->config->set('board3_user_menu_register_' . $module_id, 1);

		return true;
	}

	/**
	* {@inheritdoc}
	*/
	public function uninstall($module_id, $db)
	{
		$del_config = array(
			'board3_user_menu_register_' . $module_id,
		);
		$sql = 'DELETE FROM ' . CONFIG_TABLE . '
			WHERE ' . $db->sql_in_set('config_name', $del_config);
		return $db->sql_query($sql);
	}
}


1		<?php
2		/**
3		*
4		* @package Board3 Portal v2.1
5		* @copyright (c) 2013 Board3 Group ( www.board3.de )
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace board3\portal\modules;
11
12		/**
13		* @package User menu
14		*/
15		class user_menu extends module_base
16		{
17		/**
18		* Allowed columns: Just sum up your options (Exp: left + right = 10)
19		* top 1
20		* left 2
21		* center 4
22		* right 8
23		* bottom 16
24		*/
25		public $columns = 10;
26
27		/**
28		* Default modulename
29		*/
30		public $name = 'USER_MENU';
31
32		/**
33		* Default module-image:
34		* file must be in "{T_THEME_PATH}/images/portal/"
35		*/
36		public $image_src = 'portal_user.png';
37
38		/**
39		* module-language file
40		* file must be in "language/{$user->lang}/mods/portal/"
41		*/
42		public $language = 'portal_user_menu_module';
43
44		/** @var \phpbb\auth\auth */
45		protected $auth;
46
47		/** @var \phpbb\config\config */
48		protected $config;
49
50		/** @var \phpbb\controller\helper */
51		protected $controller_helper;
52
53		/** @var \phpbb\db\driver */
54		protected $db;
55
56		/** @var \phpbb\path_helper */
57		protected $path_helper;
58
59		/** @var \phpbb\template */
60		protected $template;
61
62		/** @var \phpbb\user */
63		protected $user;
64
65		/** @var string PHP file extension */
66		protected $php_ext;
67
68		/** @var string phpBB root path */
69		protected $phpbb_root_path;
70
71		/**
72		* Construct a user menu object
73		*
74		* @param \phpbb\auth\auth $auth phpBB auth
75		* @param \phpbb\config\config $config phpBB config
76		* @param \phpbb\controller\helper $controller_helper Controller helper
77		* @param \phpbb\db\driver $db phpBB db driver
78		* @param \phpbb\path_helper $path_helper phpBB path helper
79		* @param \phpbb\template $template phpBB template
80		* @param \phpbb\user $user phpBB user
81		* @param string $phpbb_root_path phpBB root path
82		* @param string $phpEx php file extension
83		*/
84	View Code Duplication	public function __construct($auth, $config, $controller_helper, $db, $path_helper, $template, $user, $phpbb_root_path, $phpEx)
85		{
86		$this->auth = $auth;
87		$this->config = $config;
88		$this->controller_helper = $controller_helper;
89		$this->db = $db;
90		$this->path_helper = $path_helper;
91		$this->template = $template;
92		$this->user = $user;
93		$this->phpbb_root_path = $phpbb_root_path;
94		$this->php_ext = $phpEx;
95		}
96
97		/**
98		* {@inheritdoc}
99		*/
100		public function get_template_side($module_id)
101		{
102		if (!function_exists('phpbb_get_user_rank'))
103		{
104		include($this->phpbb_root_path . 'includes/functions_display.' . $this->php_ext);
105		}
106
107		if ($this->user->data['is_registered'])
108		{
109		//
110		// + new posts since last visit & you post number
111		//
112		$ex_fid_ary = array_unique(array_merge(array_keys($this->auth->acl_getf('!f_read', true)), array_keys($this->auth->acl_getf('!f_search', true))));
113
114		if ($this->auth->acl_get('m_approve'))
115		{
116		$m_approve_fid_sql = '';
117		}
118		else if ($this->auth->acl_getf_global('m_approve'))
119		{
120		$m_approve_fid_ary = array_diff(array_keys($this->auth->acl_getf('!m_approve', true)), $ex_fid_ary);
121		$m_approve_fid_sql = ' AND (p.post_visibility = 1' . ((sizeof($m_approve_fid_ary)) ? ' OR ' . $this->db->sql_in_set('p.forum_id', $m_approve_fid_ary, true) : '') . ')';
122		}
123		else
124		{
125		$m_approve_fid_sql = ' AND p.post_visibility = 1';
126		}
127
128		$sql = 'SELECT COUNT(DISTINCT t.topic_id) as total
129		FROM ' . TOPICS_TABLE . ' t
130		WHERE t.topic_last_post_time > ' . (int) $this->user->data['user_lastvisit'] . '
131		AND t.topic_moved_id = 0
132		' . str_replace(array('p.', 'post_'), array('t.', 'topic_'), $m_approve_fid_sql) . '
133		' . ((sizeof($ex_fid_ary)) ? 'AND ' . $this->db->sql_in_set('t.forum_id', $ex_fid_ary, true) : '');
134		$result = $this->db->sql_query($sql, 600);
135		$new_posts_count = (int) $this->db->sql_fetchfield('total');
136		$this->db->sql_freeresult($result);
137
138		// unread posts
139		$sql_where = 'AND t.topic_moved_id = 0
140		' . str_replace(array('p.', 'post_'), array('t.', 'topic_'), $m_approve_fid_sql) . '
141		' . ((sizeof($ex_fid_ary)) ? 'AND ' . $this->db->sql_in_set('t.forum_id', $ex_fid_ary, true) : '');
142		$unread_list = get_unread_topics($this->user->data['user_id'], $sql_where, 'ORDER BY t.topic_id DESC');
143		$unread_posts_count = sizeof($unread_list);
144
145		// Get user avatar and rank
146		$user_id = $this->user->data['user_id'];
147		$username = $this->user->data['username'];
148		$colour = $this->user->data['user_colour'];
149		$avatar_img = phpbb_get_avatar(\phpbb\avatar\manager::clean_row($this->user->data, 'user'), 'USER_AVATAR');
150		$rank_data = phpbb_get_user_rank($this->user->data, $this->user->data['user_posts']);
151
152		// Assign specific vars
153		$this->template->assign_vars(array(
154		'L_NEW_POSTS' => $this->user->lang['SEARCH_NEW'] . ' (' . $new_posts_count . ')',
155		'L_SELF_POSTS' => $this->user->lang['SEARCH_SELF'] . ' (' . $this->user->data['user_posts'] . ')',
156		'L_UNREAD_POSTS'=> $this->user->lang['SEARCH_UNREAD'] . ' (' . $unread_posts_count . ')',
157
158		'B3P_AVATAR_IMG' => $avatar_img,
159		'B3P_RANK_TITLE' => $rank_data['title'],
160		'B3P_RANK_IMG' => $rank_data['img'],
161		'RANK_IMG_SRC' => $rank_data['img_src'],
162
163		'USERNAME_FULL' => get_username_string('full', $user_id, $username, $colour),
164		'U_VIEW_PROFILE' => get_username_string('profile', $user_id, $username, $colour),
165
166		'U_NEW_POSTS' => append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=newposts'),
167		'U_SELF_POSTS' => append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=egosearch'),
168		'U_UNREAD_POSTS' => append_sid("{$this->phpbb_root_path}search.{$this->php_ext}", 'search_id=unreadposts'),
169		'U_UM_BOOKMARKS' => ($this->config['allow_bookmarks']) ? append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'i=main&mode=bookmarks') : '',
170		'U_UM_MAIN_SUBSCRIBED' => append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'i=main&mode=subscribed'),
171		'U_UM_MCP' => ($this->auth->acl_get('m_') \|\| $this->auth->acl_getf_global('m_')) ? append_sid("{$this->phpbb_root_path}mcp.{$this->php_ext}", 'i=main&mode=front', true, $this->user->session_id) : '',
172		'S_DISPLAY_SUBSCRIPTIONS' => ($this->config['allow_topic_notify'] \|\| $this->config['allow_forum_notify']) ? true : false,
173		));
174
175		return 'user_menu_side.html';
176		}
177		else
178		{
179		/*
180		* Assign specific vars
181		* Need to remove web root path as ucp.php will do the
182		* redirect
183		*/
184		$this->template->assign_vars(array(
185		'U_PORTAL_REDIRECT' => $this->path_helper->remove_web_root_path($this->controller_helper->route('board3_portal_controller')),
186		'S_DISPLAY_FULL_LOGIN' => true,
187		'S_AUTOLOGIN_ENABLED' => ($this->config['allow_autologin']) ? true : false,
188		'S_LOGIN_ACTION' => append_sid("{$this->phpbb_root_path}ucp.{$this->php_ext}", 'mode=login'),
189		'S_SHOW_REGISTER' => ($this->config['board3_user_menu_register_' . $module_id]) ? true : false,
190		));
191
192		return 'login_box_side.html';
193		}
194		}
195
196		/**
197		* {@inheritdoc}
198		*/
199		public function get_template_acp($module_id)
200		{
201		return array(
202		'title' => 'USER_MENU',
203		'vars' => array(
204		'legend1' => 'USER_MENU_SETTINGS',
205		'board3_user_menu_register_' . $module_id => array('lang' => 'USER_MENU_REGISTER', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
206		),
207		);
208		}
209
210		/**
211		* {@inheritdoc}
212		*/
213		public function install($module_id)
214		{
215		$this->config->set('board3_user_menu_register_' . $module_id, 1);
216
217		return true;
218		}
219
220		/**
221		* {@inheritdoc}
222		*/
223	View Code Duplication	public function uninstall($module_id, $db)
224		{
225		$del_config = array(
226		'board3_user_menu_register_' . $module_id,
227		);
228		$sql = 'DELETE FROM ' . CONFIG_TABLE . '
229		WHERE ' . $db->sql_in_set('config_name', $del_config);
230		return $db->sql_query($sql);
231		}
232		}
233

board3 / Board3-Portal

user_menu::install() A last analyzed 2017-11-05 10:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

user_menu::install() A
last analyzed 2017-11-05 10:33 UTC