data::get_post_data() - Code Metrics - Inspection of "Use existing methods from forum data class" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3d7558...b8b30a )

by Daniel

created 2016-01-10 10:52 UTC

data::get_post_data() A

↳ Parent: data

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	3

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
c	4
b	1
f	0
dl	0
loc	21
ccs	15
cts	15
cp	1
rs	9.3143
cc	3
eloc	14
nc	3
nop	5
crap	3

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

use blitze\sitemaker\services\forum\query_builder;

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 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))
		{
			$parse_flags = ($row['bbcode_bitfield'] ? OPTION_FLAG_BBCODE : 0) | OPTION_FLAG_SMILIES;
			$row['post_text'] = generate_text_for_display($row['post_text'], $row['bbcode_uid'], $row['bbcode_bitfield'], $parse_flags, true);

			$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 bool $exclude_in_message
	 * @param string $order_by
	 * @return array
	 */
	public function get_attachments($forum_id = 0, $allowed_extensions = array(), $exclude_in_message = true, $order_by = 'filetime DESC, post_msg_id ASC')
	{
		$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($sql);

			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.topic_id, p.post_time ASC',
			),
			$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']))
		{
			$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));
			}
		}

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

		return $sql_where;
	}

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

blitze / phpBB-ext-sitemaker

Push — master ( 3d7558...b8b30a )

data::get_post_data() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like