data::get_topic_post_ids() - Code Metrics - Inspection of "Install composer dependencies" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cbbc79...7e8448 )

by Daniel

created 2016-08-27 22:40 UTC

data::get_topic_post_ids() A

↳ Parent: data

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes	3
Bugs	1	Features	0

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

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

	/**
	 * 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 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, $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;
	}

	/**
	 * 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();
	}

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

blitze / phpBB-ext-sitemaker

Push — master ( cbbc79...7e8448 )

data::get_topic_post_ids() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like