data::get_topic_tracking_info() - Code Metrics - Inspection of "Breakup large class" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b18c7a...273208 )

by Daniel

created 2016-04-09 12:29 UTC

data::get_topic_tracking_info() A

↳ Parent: data

Complexity

Conditions	4
Paths	5

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	4.074

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
ccs	5
cts	6
cp	0.8333
rs	9.2
cc	4
eloc	5
nc	5
nop	1
crap	4.074

<?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\forum;

class data extends query_builder
{
	/** @var \phpbb\auth\auth */
	protected $auth;

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

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

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

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

	/** @var \blitze\sitemaker\services\users\data */
	protected $user_data;

	/**
	 * Constructor
	 *
	 * @param \phpbb\auth\auth						$auth					Auth object
	 * @param \phpbb\config\config					$config					Config object
	 * @param \phpbb\content_visibility				$content_visibility		Content visibility
	 * @param \phpbb\db\driver\driver_interface		$db     				Database connection
	 * @param \phpbb\user							$user					User object
	 * @param \blitze\sitemaker\services\users\data	$user_data				Sitemaker User data object
	 * @param integer								$cache_time				Cache results for 3 hours by default
	 */
	public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\content_visibility $content_visibility, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, \blitze\sitemaker\services\users\data $user_data, $cache_time = 10800)
	{
		parent::__construct($auth, $config, $content_visibility, $db, $user, $cache_time);

		$this->auth = $auth;
		$this->config = $config;
		$this->content_visibility = $content_visibility;
		$this->db = $db;
		$this->user = $user;
		$this->user_data = $user_data;
	}

	/**
	 * Get topics count
	 *
	 * @return integer
	 */
	public function get_topics_count()
	{
		$sql_array = array(
			'SELECT'	=> 'COUNT(*) AS total_topics',
			'FROM'		=> $this->store['sql_array']['FROM'],
			'WHERE'		=> $this->store['sql_array']['WHERE'],
		);
		$sql = $this->db->sql_build_query('SELECT', $sql_array);
		$result = $this->db->sql_query($sql);
		$total_topics = $this->db->sql_fetchfield('total_topics');
		$this->db->sql_freeresult($result);

		return $total_topics;
	}

	/**
	 * Get topic data
	 *
	 * @param mixed|false $limit
	 * @param int $start
	 * @return array
	 */
	public function get_topic_data($limit = false, $start = 0)
	{
		$sql = $this->db->sql_build_query('SELECT', $this->store['sql_array']);
		$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);

		while ($row = $this->db->sql_fetchrow($result))
		{
			$this->store['topic'][$row['topic_id']] = $row;

			$this->store['tracking'][$row['forum_id']]['topic_list'][] = $row['topic_id'];
			$this->store['tracking'][$row['forum_id']]['mark_time'] =& $row['forum_mark_time'];
			$this->store['post_ids']['first'][] = $row['topic_first_post_id'];
			$this->store['post_ids']['last'][] = $row['topic_last_post_id'];
		}
		$this->db->sql_freeresult($result);

		return $this->store['topic'];
	}

	/**
	 * Get post data
	 *
	 * @param mixed|false $topic_first_or_last_post (first|last)
	 * @param array $post_ids
	 * @param bool|false $limit
	 * @param int $start
	 * @param array $sql_array
	 * @return array
	 */
	public function get_post_data($topic_first_or_last_post = false, $post_ids = array(), $limit = false, $start = 0, $sql_array = array())
	{
		$sql = $this->db->sql_build_query('SELECT_DISTINCT', $this->_get_posts_sql_array($topic_first_or_last_post, $post_ids, $sql_array));
		$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);

		$post_data = array();
		while ($row = $this->db->sql_fetchrow($result))
		{
			$post_data[$row['topic_id']][$row['post_id']] = $row;
			$this->store['poster_ids'][] = $row['poster_id'];
			$this->store['poster_ids'][] = $row['post_edit_user'];
			$this->store['poster_ids'][] = $row['post_delete_user'];
			$this->store['attachments'][] = $row['post_id'];
		}
		$this->db->sql_freeresult($result);

		return $post_data;
	}

	/**
	 * Get attachments...
	 *
	 * @param int $forum_id
	 * @param array $allowed_extensions
	 * @param mixed|bool $limit
	 * @param bool $exclude_in_message
	 * @param string $order_by
	 * @return array
	 */
	public function get_attachments($forum_id = 0, $allowed_extensions = array(), $limit = false, $exclude_in_message = true, $order_by = 'filetime DESC')
	{
		$this->store['attachments'] = array_filter($this->store['attachments']);

		$attachments = array();
		if ($this->_attachments_allowed($forum_id))
		{
			$sql = $this->_get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by);
			$result = $this->db->sql_query_limit($sql, $limit);

			while ($row = $this->db->sql_fetchrow($result))
			{
				$attachments[$row['post_msg_id']][] = $row;
			}
			$this->db->sql_freeresult($result);
		}
		$this->store['attachments'] = array();

		return $attachments;
	}

	/**
	 * Get topic tracking info
	 *
	 * @param int $forum_id
	 * @return array
	 */
	public function get_topic_tracking_info($forum_id = 0)
	{
		if (!sizeof($this->store['tracking']))
		{
			return array();
		}

		$tracking_info = $this->_get_tracking_info();

		return ($forum_id) ? (isset($tracking_info[$forum_id]) ? $tracking_info[$forum_id] : array()) : $tracking_info;
	}

	/**
	 * Returns an array of topic first post or last post ids
	 *
	 * @param string $first_or_last_post
	 * @return array
	 */
	public function get_topic_post_ids($first_or_last_post = 'first')
	{
		return (isset($this->store['post_ids'][$first_or_last_post])) ? $this->store['post_ids'][$first_or_last_post] : array();
	}

	/**
	 * Returns an array of topic first post or last post ids
	 */
	public function get_posters_info()
	{
		$this->store['poster_ids'] = array_filter(array_unique($this->store['poster_ids']));

		if (!sizeof($this->store['poster_ids']))
		{
			return array();
		}

		return $this->user_data->get_users($this->store['poster_ids']);
	}

	/**
	 * @param mixed $topic_first_or_last_post
	 * @param array $post_ids
	 * @param array $sql_array
	 * @return array
	 */
	private function _get_posts_sql_array($topic_first_or_last_post, array $post_ids, array $sql_array)
	{
		$sql_array = array_merge_recursive(
			array(
				'SELECT'	=> array('p.*'),
				'FROM'		=> array(POSTS_TABLE => 'p'),
				'WHERE'		=> $this->_get_post_data_where($post_ids, $topic_first_or_last_post),
				'ORDER_BY'	=> 'p.post_time DESC',
			),
			$sql_array
		);

		$sql_array['SELECT'] = join(', ', array_filter($sql_array['SELECT']));
		$sql_array['WHERE'] = join(' AND ', array_filter($sql_array['WHERE']));

		return $sql_array;
	}

	/**
	 * @param array $post_ids
	 * @param string $topic_first_or_last_post
	 * @return array
	 */
	private function _get_post_data_where(array $post_ids, $topic_first_or_last_post)
	{
		$sql_where = array();

		if (sizeof($post_ids))
		{
			$sql_where[] = $this->db->sql_in_set('p.post_id', $post_ids);
		}
		else if (sizeof($this->store['topic']))
		{
			$this->_limit_posts_by_topic($sql_where, $topic_first_or_last_post);
		}

		$sql_where[] = $this->content_visibility->get_global_visibility_sql('post', $this->ex_fid_ary, 'p.');

		return $sql_where;
	}

	/**
	 * @param array $sql_where
	 * @param string $topic_first_or_last_post
	 */
	private function _limit_posts_by_topic(array &$sql_where, $topic_first_or_last_post)
	{
		$sql_where[] = $this->db->sql_in_set('p.topic_id', array_keys($this->store['topic']));

		if ($topic_first_or_last_post)
		{
			$sql_where[] = $this->db->sql_in_set('p.post_id', $this->get_topic_post_ids($topic_first_or_last_post));
		}
	}

	/**
	 * @return array
	 */
	private function _get_tracking_info()
	{
		$info = array();
		if ($this->_can_track_by_lastread())
		{
			$info = $this->_build_tracking_info('get_topic_tracking');
		}
		else if ($this->_can_track_anonymous())
		{
			$info = $this->_build_tracking_info('get_complete_topic_tracking');
		}

		return $info;
	}

	/**
	 * @param string $function
	 * @return array
	 */
	private function _build_tracking_info($function)
	{
		$tracking_info = array();
		foreach ($this->store['tracking'] as $fid => $forum)
		{
			$tracking_info[$fid] = call_user_func_array($function, array($fid, $forum['topic_list'], &$this->store['topic'], array($fid => $forum['mark_time'])));
		}

		return $tracking_info;
	}

	/**
	 * @return bool
	 */
	private function _can_track_by_lastread()
	{
		return ($this->config['load_db_lastread'] && $this->user->data['is_registered']) ? true : false;
	}

	/**
	 * @return bool
	 */
	private function _can_track_anonymous()
	{
		return ($this->config['load_anon_lastread'] || $this->user->data['is_registered']) ? true : false;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	private function _attachments_allowed($forum_id)
	{
		return ($this->store['attachments'] && $this->_user_can_download_attachments($forum_id)) ? true : false;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	private function _user_can_download_attachments($forum_id)
	{
		return ($this->auth->acl_get('u_download') && (!$forum_id || $this->auth->acl_get('f_download', $forum_id))) ? true : false;
	}

	/**
	 * @param array $allowed_extensions
	 * @param bool $exclude_in_message
	 * @param string $order_by
	 * @return string
	 */
	private function _get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by)
	{
		return 'SELECT *
			FROM ' . ATTACHMENTS_TABLE . '
			WHERE ' . $this->db->sql_in_set('post_msg_id', $this->store['attachments']) .
				(($exclude_in_message) ? ' AND in_message = 0' : '') .
				(sizeof($allowed_extensions) ? ' AND ' . $this->db->sql_in_set('extension', $allowed_extensions) : '') . '
			ORDER BY ' . $order_by;
	}
}


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\forum;
11
12		class data extends query_builder
13		{
14		/** @var \phpbb\auth\auth */
15		protected $auth;
16
17		/** @var \phpbb\config\config */
18		protected $config;
19
20		/** @var \phpbb\content_visibility */
21		protected $content_visibility;
22
23		/** @var \phpbb\db\driver\driver_interface */
24		protected $db;
25
26		/** @var \phpbb\user */
27		protected $user;
28
29		/** @var \blitze\sitemaker\services\users\data */
30		protected $user_data;
31
32		/**
33		* Constructor
34		*
35		* @param \phpbb\auth\auth $auth Auth object
36		* @param \phpbb\config\config $config Config object
37		* @param \phpbb\content_visibility $content_visibility Content visibility
38		* @param \phpbb\db\driver\driver_interface $db Database connection
39		* @param \phpbb\user $user User object
40		* @param \blitze\sitemaker\services\users\data $user_data Sitemaker User data object
41		* @param integer $cache_time Cache results for 3 hours by default
42		*/
43	29	public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\content_visibility $content_visibility, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, \blitze\sitemaker\services\users\data $user_data, $cache_time = 10800)
44		{
45	29	parent::__construct($auth, $config, $content_visibility, $db, $user, $cache_time);
46
47	29	$this->auth = $auth;
48	29	$this->config = $config;
49	29	$this->content_visibility = $content_visibility;
50	29	$this->db = $db;
51	29	$this->user = $user;
52	29	$this->user_data = $user_data;
53	29	}
54
55		/**
56		* Get topics count
57		*
58		* @return integer
59		*/
60	1	public function get_topics_count()
61		{
62		$sql_array = array(
63	1	'SELECT' => 'COUNT(*) AS total_topics',
64	1	'FROM' => $this->store['sql_array']['FROM'],
65	1	'WHERE' => $this->store['sql_array']['WHERE'],
66	1	);
67	1	$sql = $this->db->sql_build_query('SELECT', $sql_array);
68	1	$result = $this->db->sql_query($sql);
69	1	$total_topics = $this->db->sql_fetchfield('total_topics');
70	1	$this->db->sql_freeresult($result);
71
72	1	return $total_topics;
73		}
74
75		/**
76		* Get topic data
77		*
78		* @param mixed\|false $limit
79		* @param int $start
80		* @return array
81		*/
82	12	public function get_topic_data($limit = false, $start = 0)
83		{
84	12	$sql = $this->db->sql_build_query('SELECT', $this->store['sql_array']);
85	12	$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);
86
87	12	while ($row = $this->db->sql_fetchrow($result))
88		{
89	10	$this->store['topic'][$row['topic_id']] = $row;
90
91	10	$this->store['tracking'][$row['forum_id']]['topic_list'][] = $row['topic_id'];
92	10	$this->store['tracking'][$row['forum_id']]['mark_time'] =& $row['forum_mark_time'];
93	10	$this->store['post_ids']['first'][] = $row['topic_first_post_id'];
94	10	$this->store['post_ids']['last'][] = $row['topic_last_post_id'];
95	10	}
96	12	$this->db->sql_freeresult($result);
97
98	12	return $this->store['topic'];
99		}
100
101		/**
102		* Get post data
103		*
104		* @param mixed\|false $topic_first_or_last_post (first\|last)
105		* @param array $post_ids
106		* @param bool\|false $limit
107		* @param int $start
108		* @param array $sql_array
109		* @return array
110		*/
111	10	public function get_post_data($topic_first_or_last_post = false, $post_ids = array(), $limit = false, $start = 0, $sql_array = array())
112		{
113	10	$sql = $this->db->sql_build_query('SELECT_DISTINCT', $this->_get_posts_sql_array($topic_first_or_last_post, $post_ids, $sql_array));
114	10	$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);
115
116	10	$post_data = array();
117	10	while ($row = $this->db->sql_fetchrow($result))
118		{
119	9	$post_data[$row['topic_id']][$row['post_id']] = $row;
120	9	$this->store['poster_ids'][] = $row['poster_id'];
121	9	$this->store['poster_ids'][] = $row['post_edit_user'];
122	9	$this->store['poster_ids'][] = $row['post_delete_user'];
123	9	$this->store['attachments'][] = $row['post_id'];
124	9	}
125	10	$this->db->sql_freeresult($result);
126
127	10	return $post_data;
128		}
129
130		/**
131		* Get attachments...
132		*
133		* @param int $forum_id
134		* @param array $allowed_extensions
135		* @param mixed\|bool $limit
136		* @param bool $exclude_in_message
137		* @param string $order_by
138		* @return array
139		*/
140	7	public function get_attachments($forum_id = 0, $allowed_extensions = array(), $limit = false, $exclude_in_message = true, $order_by = 'filetime DESC')
141		{
142	7	$this->store['attachments'] = array_filter($this->store['attachments']);
143
144	7	$attachments = array();
145	7	if ($this->_attachments_allowed($forum_id))
146	7	{
147	6	$sql = $this->_get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by);
148	6	$result = $this->db->sql_query_limit($sql, $limit);
149
150	6	while ($row = $this->db->sql_fetchrow($result))
151		{
152	6	$attachments[$row['post_msg_id']][] = $row;
153	6	}
154	6	$this->db->sql_freeresult($result);
155	6	}
156	7	$this->store['attachments'] = array();
157
158	7	return $attachments;
159		}
160
161		/**
162		* Get topic tracking info
163		*
164		* @param int $forum_id
165		* @return array
166		*/
167	5	public function get_topic_tracking_info($forum_id = 0)
168		{
169	5	if (!sizeof($this->store['tracking']))
170	5	{
171		return array();
172		}
173
174	5	$tracking_info = $this->_get_tracking_info();
175
176	5	return ($forum_id) ? (isset($tracking_info[$forum_id]) ? $tracking_info[$forum_id] : array()) : $tracking_info;
177		}
178
179		/**
180		* Returns an array of topic first post or last post ids
181		*
182		* @param string $first_or_last_post
183		* @return array
184		*/
185	3	public function get_topic_post_ids($first_or_last_post = 'first')
186		{
187	3	return (isset($this->store['post_ids'][$first_or_last_post])) ? $this->store['post_ids'][$first_or_last_post] : array();
188		}
189
190		/**
191		* Returns an array of topic first post or last post ids
192		*/
193		public function get_posters_info()
194		{
195		$this->store['poster_ids'] = array_filter(array_unique($this->store['poster_ids']));
196
197		if (!sizeof($this->store['poster_ids']))
198		{
199		return array();
200		}
201
202		return $this->user_data->get_users($this->store['poster_ids']);
203		}
204
205		/**
206		* @param mixed $topic_first_or_last_post
207		* @param array $post_ids
208		* @param array $sql_array
209		* @return array
210		*/
211	10	private function _get_posts_sql_array($topic_first_or_last_post, array $post_ids, array $sql_array)
212		{
213	10	$sql_array = array_merge_recursive(
214		array(
215	10	'SELECT' => array('p.*'),
216	10	'FROM' => array(POSTS_TABLE => 'p'),
217	10	'WHERE' => $this->_get_post_data_where($post_ids, $topic_first_or_last_post),
218	10	'ORDER_BY' => 'p.post_time DESC',
219	10	),
220		$sql_array
221	10	);
222
223	10	$sql_array['SELECT'] = join(', ', array_filter($sql_array['SELECT']));
224	10	$sql_array['WHERE'] = join(' AND ', array_filter($sql_array['WHERE']));
225
226	10	return $sql_array;
227		}
228
229		/**
230		* @param array $post_ids
231		* @param string $topic_first_or_last_post
232		* @return array
233		*/
234	10	private function _get_post_data_where(array $post_ids, $topic_first_or_last_post)
235		{
236	10	$sql_where = array();
237
238	10	if (sizeof($post_ids))
239	10	{
240	2	$sql_where[] = $this->db->sql_in_set('p.post_id', $post_ids);
241	2	}
242	8	else if (sizeof($this->store['topic']))
243	8	{
244	3	$this->_limit_posts_by_topic($sql_where, $topic_first_or_last_post);
245	3	}
246
247	10	$sql_where[] = $this->content_visibility->get_global_visibility_sql('post', $this->ex_fid_ary, 'p.');
248
249	10	return $sql_where;
250		}
251
252		/**
253		* @param array $sql_where
254		* @param string $topic_first_or_last_post
255		*/
256	3	private function _limit_posts_by_topic(array &$sql_where, $topic_first_or_last_post)
257		{
258	3	$sql_where[] = $this->db->sql_in_set('p.topic_id', array_keys($this->store['topic']));
259
260		if ($topic_first_or_last_post)
261	3	{
262	3	$sql_where[] = $this->db->sql_in_set('p.post_id', $this->get_topic_post_ids($topic_first_or_last_post));
263	3	}
264	3	}
265
266		/**
267		* @return array
268		*/
269	5	private function _get_tracking_info()
270		{
271	5	$info = array();
272	5	if ($this->_can_track_by_lastread())
273	5	{
274	4	$info = $this->_build_tracking_info('get_topic_tracking');
275	4	}
276	1	else if ($this->_can_track_anonymous())
277	1	{
278	1	$info = $this->_build_tracking_info('get_complete_topic_tracking');
279	1	}
280
281	5	return $info;
282		}
283
284		/**
285		* @param string $function
286		* @return array
287		*/
288	5	private function _build_tracking_info($function)
289		{
290	5	$tracking_info = array();
291	5	foreach ($this->store['tracking'] as $fid => $forum)
292		{
293	5	$tracking_info[$fid] = call_user_func_array($function, array($fid, $forum['topic_list'], &$this->store['topic'], array($fid => $forum['mark_time'])));
294	5	}
295
296	5	return $tracking_info;
297		}
298
299		/**
300		* @return bool
301		*/
302	5	private function _can_track_by_lastread()
303		{
304	5	return ($this->config['load_db_lastread'] && $this->user->data['is_registered']) ? true : false;
305		}
306
307		/**
308		* @return bool
309		*/
310	1	private function _can_track_anonymous()
311		{
312	1	return ($this->config['load_anon_lastread'] \|\| $this->user->data['is_registered']) ? true : false;
313		}
314
315		/**
316		* @param int $forum_id
317		* @return bool
318		*/
319	7	private function _attachments_allowed($forum_id)
320		{
321	7	return ($this->store['attachments'] && $this->_user_can_download_attachments($forum_id)) ? true : false;
322		}
323
324		/**
325		* @param int $forum_id
326		* @return bool
327		*/
328	6	private function _user_can_download_attachments($forum_id)
329		{
330	6	return ($this->auth->acl_get('u_download') && (!$forum_id \|\| $this->auth->acl_get('f_download', $forum_id))) ? true : false;
331		}
332
333		/**
334		* @param array $allowed_extensions
335		* @param bool $exclude_in_message
336		* @param string $order_by
337		* @return string
338		*/
339	6	private function _get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by)
340		{
341		return 'SELECT *
342	6	FROM ' . ATTACHMENTS_TABLE . '
343	6	WHERE ' . $this->db->sql_in_set('post_msg_id', $this->store['attachments']) .
344	6	(($exclude_in_message) ? ' AND in_message = 0' : '') .
345	6	(sizeof($allowed_extensions) ? ' AND ' . $this->db->sql_in_set('extension', $allowed_extensions) : '') . '
346	6	ORDER BY ' . $order_by;
347		}
348		}
349

blitze / phpBB-ext-sitemaker

Push — develop ( b18c7a...273208 )

data::get_topic_tracking_info() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like