members::set_range_sql() - Code Metrics - Inspection of "Merge branch 'master' into 'develop'" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( de7659...415144 )

by Daniel

created 2016-03-29 18:04 UTC

members::set_range_sql() A

↳ Parent: members

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	4.125

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	10
ccs	4
cts	8
cp	0.5
rs	9.4285
cc	3
eloc	5
nc	2
nop	1
crap	4.125

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\services;

class members
{
	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

	/** @var\phpbb\language\language */
	protected $translator;

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

	/** @var \blitze\sitemaker\services\date_range */
	protected $date_range;

	/** @var \blitze\sitemaker\services\template driver_interface */
	protected $ptemplate;

	/** @var string */
	protected $phpbb_root_path;

	/** @var string */
	protected $php_ext;

	protected $explain_range = '';
	protected $sql_date_field = '';
	protected $view_mode = 'member_date';
	protected $user_header = 'USERNAME';
	protected $info_header = 'MEMBERS_DATE';
	protected $settings = array();

	/**
	 * Constructor
	 *
	 * @param \phpbb\db\driver\driver_interface		$db     			Database connection
	 * @param\phpbb\language\language				$translator			Language Object
	 * @param \phpbb\user							$user				User object
	 * @param \blitze\sitemaker\services\date_range	$date_range			Date range object
	 * @param \blitze\sitemaker\services\template	$ptemplate			Sitemaker template object
	 * @param string								$phpbb_root_path	Path to the phpbb includes directory.
	 * @param string								$php_ext			php file extension
	 */
	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\language\language $translator, \phpbb\user $user, \blitze\sitemaker\services\date_range $date_range, \blitze\sitemaker\services\template $ptemplate, $phpbb_root_path, $php_ext)
	{
		$this->db = $db;
		$this->translator = $translator;
		$this->user = $user;
		$this->date_range = $date_range;
		$this->ptemplate = $ptemplate;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;

		if (!function_exists('phpbb_get_user_avatar'))
		{
			include($phpbb_root_path . 'includes/functions_display.' . $php_ext);
		}
	}

	/**
	 * get members
	 * @param array $get
	 * @return string
	 */
	public function get_list(array $get = array())
	{
		$this->settings = $get + array(
			'query_type'	=> 'recent',
			'date_range'	=> '',
			'max_members'	=> 5,
		);

		$sql = $this->get_sql_statement();
		$result = $this->db->sql_query_limit($sql, $this->settings['max_members']);

		$has_results = false;
		while ($row = $this->db->sql_fetchrow($result))
		{
			$has_results = true;
			$this->ptemplate->assign_block_vars('member', call_user_func_array(array($this, $this->view_mode), array($row)));
		}
		$this->db->sql_freeresult($result);

		return $this->show_results($has_results);
	}

	/**
	 * @param array $row
	 * @return array
	 */
	protected function member_posts(array $row)
	{
		$u_posts = append_sid($this->phpbb_root_path . 'search.' . $this->php_ext, "author_id={$row['user_id']}&amp;sr=posts" . $this->explain_range);
		$user_posts = '<a href="' . $u_posts . '">' . $row['user_posts'] . '</a>';

		return array(
			'USERNAME'		=> get_username_string('full', $row['user_id'], $row['username'], $row['user_colour']),
			'USER_AVATAR'	=> phpbb_get_user_avatar($row),
			'USER_INFO'		=> $user_posts
		);
	}

	/**
	 * @param array $row
	 * @return array
	 */
	protected function member_date(array $row)
	{
		return array(
			'USERNAME'		=> get_username_string('full', $row['user_id'], $row['username'], $row['user_colour']),
			'USER_AVATAR'	=> phpbb_get_user_avatar($row),
			'USER_INFO'		=> $this->user->format_date($row['member_date'], $this->translator->lang('DATE_FORMAT'), true)
		);
	}

	/**
	 * @param array $row
	 * @return array
	 */
	protected function member_bots(array $row)
	{
		return array(
			'USERNAME'	=> get_username_string('username', $row['user_id'], $row['username'], $row['user_colour']),
			'USER_INFO'	=> $this->user->format_date($row['member_date'])
		);
	}

	/**
	 * @param bool $has_results
	 * @return string
	 */
	protected function show_results($has_results)
	{
		$html = '';
		if ($has_results)
		{
			$this->ptemplate->assign_vars(array(
				'S_LIST'		=> $this->settings['query_type'],
				'USER_TITLE'	=> $this->translator->lang($this->user_header),
				'INFO_TITLE'	=> $this->translator->lang($this->info_header),
			));

			$html = $this->ptemplate->render_view('blitze/sitemaker', 'blocks/members.html', 'members_block');
		}

		return $html;
	}

	/**
	 * @return string
	 */
	protected function get_sql_statement()
	{
		$sql_ary = array(
			'SELECT'		=> 'u.user_id, u.username, u.user_colour, u.user_avatar, u.user_avatar_type, u.user_avatar_width, u.user_avatar_height',
			'FROM'			=> array(
					USERS_TABLE => 'u'
			),
			'WHERE'			=> $this->db->sql_in_set('u.user_type', array(USER_NORMAL, USER_FOUNDER)),
		);

		$sql_method = 'set_' . $this->settings['query_type'] . '_sql';
		call_user_func_array(array($this, $sql_method), array(&$sql_ary));

		$this->set_range_sql($sql_ary);

		return $this->db->sql_build_query('SELECT', $sql_ary);
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_visits_sql(array &$sql_ary)
	{
		$sql_ary['SELECT'] .= ', u.user_lastvisit as member_date';
		$sql_ary['WHERE'] .= ' AND u.user_lastvisit <> 0';
		$sql_ary['ORDER_BY'] = 'u.user_lastvisit DESC';

		$this->sql_date_field = 'user_lastvisit';
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_bots_sql(array &$sql_ary)
	{
		$this->set_visits_sql($sql_ary);
		$this->user_header = '';
		$this->info_header = '';
		$this->view_mode = 'member_bots';

		$sql_ary['WHERE'] = 'u.user_type = ' . USER_IGNORE;
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_tenured_sql(array &$sql_ary)
	{
		$sql_ary['SELECT'] .= ', u.user_regdate as member_date';
		$sql_ary['ORDER_BY'] = 'u.user_regdate ' . (($this->settings['query_type'] == 'tenured') ? 'ASC' : 'DESC');

		$this->sql_date_field = 'u.user_regdate';
		$this->settings['date_range'] = '';
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_recent_sql(array &$sql_ary)
	{
		$this->set_tenured_sql($sql_ary);
		$this->info_header = 'JOIN_DATE';
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_posts_sql(array &$sql_ary)
	{
		$sql_ary['SELECT'] .= ', COUNT(p.post_id) as user_posts';
		$sql_ary['FROM'] += array(TOPICS_TABLE => 't');
		$sql_ary['FROM'] += array(POSTS_TABLE => 'p');
		$sql_ary['WHERE'] .= ' AND ' . time() . ' > t.topic_time AND t.topic_id = p.topic_id AND p.post_visibility = ' . ITEM_APPROVED . ' AND p.poster_id = u.user_id';
		$sql_ary['GROUP_BY'] = 'u.user_id';
		$sql_ary['ORDER_BY'] = 'user_posts DESC, u.username ASC';

		$this->info_header = 'POSTS';
		$this->view_mode = 'member_posts';
		$this->sql_date_field = 'p.post_time';
	}

	/**
	 * @param array $sql_ary
	 */
	protected function set_range_sql(array &$sql_ary)
	{
		if ($this->settings['date_range'] && $this->sql_date_field)
		{
			$range = $this->date_range->get($this->settings['date_range']);
			$this->explain_range = '&amp;date=' . $range['date'];

			$sql_ary['WHERE'] .= " AND {$this->sql_date_field} BETWEEN {$range['start']} AND {$range['stop']}";
		}
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2013 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\sitemaker\services;
11
12		class members
13		{
14		/** @var \phpbb\db\driver\driver_interface */
15		protected $db;
16
17		/** @var\phpbb\language\language */
18		protected $translator;
19
20		/** @var \phpbb\user */
21		protected $user;
22
23		/** @var \blitze\sitemaker\services\date_range */
24		protected $date_range;
25
26		/** @var \blitze\sitemaker\services\template driver_interface */
27		protected $ptemplate;
28
29		/** @var string */
30		protected $phpbb_root_path;
31
32		/** @var string */
33		protected $php_ext;
34
35		protected $explain_range = '';
36		protected $sql_date_field = '';
37		protected $view_mode = 'member_date';
38		protected $user_header = 'USERNAME';
39		protected $info_header = 'MEMBERS_DATE';
40		protected $settings = array();
41
42		/**
43		* Constructor
44		*
45		* @param \phpbb\db\driver\driver_interface $db Database connection
46		* @param\phpbb\language\language $translator Language Object
47		* @param \phpbb\user $user User object
48		* @param \blitze\sitemaker\services\date_range $date_range Date range object
49		* @param \blitze\sitemaker\services\template $ptemplate Sitemaker template object
50		* @param string $phpbb_root_path Path to the phpbb includes directory.
51		* @param string $php_ext php file extension
52		*/
53	6	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\language\language $translator, \phpbb\user $user, \blitze\sitemaker\services\date_range $date_range, \blitze\sitemaker\services\template $ptemplate, $phpbb_root_path, $php_ext)
54		{
55	6	$this->db = $db;
56	6	$this->translator = $translator;
57	6	$this->user = $user;
58	6	$this->date_range = $date_range;
59	6	$this->ptemplate = $ptemplate;
60	6	$this->phpbb_root_path = $phpbb_root_path;
61	6	$this->php_ext = $php_ext;
62
63	6	if (!function_exists('phpbb_get_user_avatar'))
64	6	{
65		include($phpbb_root_path . 'includes/functions_display.' . $php_ext);
66		}
67	6	}
68
69		/**
70		* get members
71		* @param array $get
72		* @return string
73		*/
74	6	public function get_list(array $get = array())
75		{
76	6	$this->settings = $get + array(
77	6	'query_type' => 'recent',
78	6	'date_range' => '',
79	6	'max_members' => 5,
80	6	);
81
82	6	$sql = $this->get_sql_statement();
83	6	$result = $this->db->sql_query_limit($sql, $this->settings['max_members']);
84
85	6	$has_results = false;
86	6	while ($row = $this->db->sql_fetchrow($result))
87		{
88	6	$has_results = true;
89	6	$this->ptemplate->assign_block_vars('member', call_user_func_array(array($this, $this->view_mode), array($row)));
90	6	}
91	6	$this->db->sql_freeresult($result);
92
93	6	return $this->show_results($has_results);
94		}
95
96		/**
97		* @param array $row
98		* @return array
99		*/
100	1	protected function member_posts(array $row)
101		{
102	1	$u_posts = append_sid($this->phpbb_root_path . 'search.' . $this->php_ext, "author_id={$row['user_id']}&sr=posts" . $this->explain_range);
103	1	$user_posts = '<a href="' . $u_posts . '">' . $row['user_posts'] . '</a>';
104
105		return array(
106	1	'USERNAME' => get_username_string('full', $row['user_id'], $row['username'], $row['user_colour']),
107	1	'USER_AVATAR' => phpbb_get_user_avatar($row),
108		'USER_INFO' => $user_posts
109	1	);
110		}
111
112		/**
113		* @param array $row
114		* @return array
115		*/
116	4	protected function member_date(array $row)
117		{
118		return array(
119	4	'USERNAME' => get_username_string('full', $row['user_id'], $row['username'], $row['user_colour']),
120	4	'USER_AVATAR' => phpbb_get_user_avatar($row),
121	4	'USER_INFO' => $this->user->format_date($row['member_date'], $this->translator->lang('DATE_FORMAT'), true)
122	4	);
123		}
124
125		/**
126		* @param array $row
127		* @return array
128		*/
129	1	protected function member_bots(array $row)
130		{
131		return array(
132	1	'USERNAME' => get_username_string('username', $row['user_id'], $row['username'], $row['user_colour']),
133	1	'USER_INFO' => $this->user->format_date($row['member_date'])
134	1	);
135		}
136
137		/**
138		* @param bool $has_results
139		* @return string
140		*/
141	6	protected function show_results($has_results)
142		{
143	6	$html = '';
144		if ($has_results)
145	6	{
146	6	$this->ptemplate->assign_vars(array(
147	6	'S_LIST' => $this->settings['query_type'],
148	6	'USER_TITLE' => $this->translator->lang($this->user_header),
149	6	'INFO_TITLE' => $this->translator->lang($this->info_header),
150	6	));
151
152	6	$html = $this->ptemplate->render_view('blitze/sitemaker', 'blocks/members.html', 'members_block');
153	6	}
154
155	6	return $html;
156		}
157
158		/**
159		* @return string
160		*/
161	6	protected function get_sql_statement()
162		{
163		$sql_ary = array(
164	6	'SELECT' => 'u.user_id, u.username, u.user_colour, u.user_avatar, u.user_avatar_type, u.user_avatar_width, u.user_avatar_height',
165		'FROM' => array(
166	6	USERS_TABLE => 'u'
167	6	),
168	6	'WHERE' => $this->db->sql_in_set('u.user_type', array(USER_NORMAL, USER_FOUNDER)),
169	6	);
170
171	6	$sql_method = 'set_' . $this->settings['query_type'] . '_sql';
172	6	call_user_func_array(array($this, $sql_method), array(&$sql_ary));
173
174	6	$this->set_range_sql($sql_ary);
175
176	6	return $this->db->sql_build_query('SELECT', $sql_ary);
177		}
178
179		/**
180		* @param array $sql_ary
181		*/
182	2	protected function set_visits_sql(array &$sql_ary)
183		{
184	2	$sql_ary['SELECT'] .= ', u.user_lastvisit as member_date';
185	2	$sql_ary['WHERE'] .= ' AND u.user_lastvisit <> 0';
186	2	$sql_ary['ORDER_BY'] = 'u.user_lastvisit DESC';
187
188	2	$this->sql_date_field = 'user_lastvisit';
189	2	}
190
191		/**
192		* @param array $sql_ary
193		*/
194	1	protected function set_bots_sql(array &$sql_ary)
195		{
196	1	$this->set_visits_sql($sql_ary);
197	1	$this->user_header = '';
198	1	$this->info_header = '';
199	1	$this->view_mode = 'member_bots';
200
201	1	$sql_ary['WHERE'] = 'u.user_type = ' . USER_IGNORE;
202	1	}
203
204		/**
205		* @param array $sql_ary
206		*/
207	3	protected function set_tenured_sql(array &$sql_ary)
208		{
209	3	$sql_ary['SELECT'] .= ', u.user_regdate as member_date';
210	3	$sql_ary['ORDER_BY'] = 'u.user_regdate ' . (($this->settings['query_type'] == 'tenured') ? 'ASC' : 'DESC');
211
212	3	$this->sql_date_field = 'u.user_regdate';
213	3	$this->settings['date_range'] = '';
214	3	}
215
216		/**
217		* @param array $sql_ary
218		*/
219	1	protected function set_recent_sql(array &$sql_ary)
220		{
221	1	$this->set_tenured_sql($sql_ary);
222	1	$this->info_header = 'JOIN_DATE';
223	1	}
224
225		/**
226		* @param array $sql_ary
227		*/
228	1	protected function set_posts_sql(array &$sql_ary)
229		{
230	1	$sql_ary['SELECT'] .= ', COUNT(p.post_id) as user_posts';
231	1	$sql_ary['FROM'] += array(TOPICS_TABLE => 't');
232	1	$sql_ary['FROM'] += array(POSTS_TABLE => 'p');
233	1	$sql_ary['WHERE'] .= ' AND ' . time() . ' > t.topic_time AND t.topic_id = p.topic_id AND p.post_visibility = ' . ITEM_APPROVED . ' AND p.poster_id = u.user_id';
234	1	$sql_ary['GROUP_BY'] = 'u.user_id';
235	1	$sql_ary['ORDER_BY'] = 'user_posts DESC, u.username ASC';
236
237	1	$this->info_header = 'POSTS';
238	1	$this->view_mode = 'member_posts';
239	1	$this->sql_date_field = 'p.post_time';
240	1	}
241
242		/**
243		* @param array $sql_ary
244		*/
245	6	protected function set_range_sql(array &$sql_ary)
246		{
247	6	if ($this->settings['date_range'] && $this->sql_date_field)
248	6	{
249		$range = $this->date_range->get($this->settings['date_range']);
250		$this->explain_range = '&date=' . $range['date'];
251
252		$sql_ary['WHERE'] .= " AND {$this->sql_date_field} BETWEEN {$range['start']} AND {$range['stop']}";
253		}
254	6	}
255		}
256

blitze / phpBB-ext-sitemaker

Push — develop ( de7659...415144 )

members::set_range_sql() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like