query_builder::time() - Code Metrics - Inspection of "Fix tests" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — release-3.2.0 ( b3aabc...d5281f )

by Daniel

created 2019-05-30 03:41 UTC

query_builder::time() A

↳ Parent: query_builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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 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 array */
	protected $store;

	/** @var array */
	protected $ex_fid_ary;

	/** @var integer */
	protected $cache_time;

	/**
	 * 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)
	{
		$this->auth = $auth;
		$this->config = $config;
		$this->content_visibility = $content_visibility;
		$this->db = $db;
		$this->user = $user;
		$this->cache_time = $cache_time;

		$this->ex_fid_ary = array_unique(array_keys($this->auth->acl_getf('!f_read', true)));
	}

	/**
	 * Begin query
	 *
	 * @param bool $track_topics
	 * @param bool $get_forum_data
	 * @return $this
	 */
	public function query($track_topics = true, $get_forum_data = true)
	{
		$this->_reset();

		$this->store['sql_array'] = array_fill_keys(array('SELECT', 'FROM', 'LEFT_JOIN', 'WHERE'), array());

		if ($get_forum_data)
		{
			$this->store['sql_array']['SELECT'][] = 'f.*';
			$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
		}

		$this->store['sql_array']['SELECT'][] = 't.*';

		if ($track_topics)
		{
			$this->fetch_tracking_info();
		}

		return $this;
	}

	/**
	 * Fetch Forum by id(s)
	 *
	 * @param int|array $forum_id
	 * @return $this
	 */
	public function fetch_forum($forum_id)
	{
		$this->_fetch($forum_id, (isset($this->store['sql_array']['FROM'][FORUMS_TABLE])) ? 'f.forum_id' : 't.forum_Id');

		return $this;
	}

	/**
	 * Fetch Topic by id(s)
	 *
	 * @param mixed $topic_id	Limit by topic id: single id or array of topic ids
	 * @return $this
	 */
	public function fetch_topic($topic_id)
	{
		$this->_fetch($topic_id, 't.topic_id');

		return $this;
	}

	/**
	 * Fetch Topic by Poster id(s)
	 *
	 * @param mixed $user_id	User id of topic poster: single id or array of user ids
	 * @return $this
	 */
	public function fetch_topic_poster($user_id)
	{
		$this->_fetch($user_id, 't.topic_poster');

		return $this;
	}

	/**
	 * Fetch by Topic Type
	 *
	 * @param array $topic_type
	 * @return $this
	 */
	public function fetch_topic_type(array $topic_type)
	{
		if (sizeof($topic_type))
		{
			$this->store['sql_array']['WHERE'][] = $this->db->sql_in_set('t.topic_type', $topic_type);
		}

		return $this;
	}

	/**
	 * Fetch Topic Watch info
	 *
	 * @param $type
	 * @return $this
	 */
	public function fetch_watch_status($type = 'topic')
	{
		if ($this->user->data['is_registered'])
		{
			$keys = array(
				'forum'	=> array(
					'table'	=> FORUMS_WATCH_TABLE,
					'cond'	=> 'ws.forum_id = f.forum_id',
				),
				'topic'	=> array(
					'table'	=> TOPICS_WATCH_TABLE,
					'cond'	=> 'ws.topic_id = t.topic_id',
				),
			);

			$this->store['sql_array']['SELECT'][] = 'ws.notify_status';
			$this->store['sql_array']['LEFT_JOIN'][] = array(
				'FROM'	=> array($keys[$type]['table'] => 'ws'),
				'ON'	=> $keys[$type]['cond'] . ' AND ws.user_id = ' . (int) $this->user->data['user_id'],
			);
		}

		return $this;
	}

	/**
	 * Fetch Topic Bookmark Info
	 *
	 * @return $this
	 */
	public function fetch_bookmark_status()
	{
		if ($this->user->data['is_registered'] && $this->config['allow_bookmarks'])
		{
			$this->store['sql_array']['SELECT'][] = 'bm.topic_id as bookmarked';
			$this->store['sql_array']['LEFT_JOIN'][] = array(
				'FROM'	=> array(BOOKMARKS_TABLE => 'bm'),
				'ON'	=> 'bm.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = bm.topic_id'
			);
		}

		return $this;
	}

	/**
	 * Fetch Topic Tracking Info
	 *
	 * @return $this
	 */
	public function fetch_tracking_info()
	{
		if ($this->user->data['is_registered'] && $this->config['load_db_lastread'])
		{
			$this->cache_time = 0;

			$this->store['sql_array']['SELECT'][] = 'tt.mark_time, ft.mark_time as forum_mark_time';
			$this->store['sql_array']['LEFT_JOIN'][] = array(
				'FROM'	=> array(TOPICS_TRACK_TABLE => 'tt'),
				'ON'	=> 'tt.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = tt.topic_id'
			);

			$this->store['sql_array']['LEFT_JOIN'][] = array(
				'FROM'	=> array(FORUMS_TRACK_TABLE => 'ft'),
				'ON'	=> 'ft.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.forum_id = ft.forum_id'
			);
		}

		return $this;
	}

	/**
	 * Fetch by Date Range
	 *
	 * @param int $unix_start_time
	 * @param int $unix_stop_time
	 * @param string $mode topic|post
	 * @return $this
	 */
	public function fetch_date_range($unix_start_time, $unix_stop_time, $mode = 'topic')
	{
		if ($unix_start_time && $unix_stop_time)
		{
			$this->store['sql_array']['WHERE'][] = (($mode == 'topic') ? 't.topic_time' : 'p.post_time') . " BETWEEN $unix_start_time AND $unix_stop_time";
		}

		return $this;
	}

	/**
	 * Fetch by Custom Query
	 *
	 * @param array	$sql_array			Array of elements to merge into query
	 * 										array(
	 * 											'SELECT'	=> array('p.*'),
	 * 											'WHERE'		=> array('p.post_id = 2'),
	 * 										)
	 * @param array $overwrite_keys		Array of query keys to overwrite with yours instead of merging
	 *									e.g array('SELECT') will overwrite the 'SELECT' key with whatever is provided in $sql_array
	 * @return $this
	 */
	public function fetch_custom(array $sql_array, $overwrite_keys = array())
	{
		$this->store['sql_array'] = array_merge_recursive($this->store['sql_array'], $sql_array);

		foreach ($overwrite_keys as $key)
		{
			$this->store['sql_array'][$key] = $sql_array[$key];
		}

		return $this;
	}

	/**
	 * Set Sorting Order
	 *
	 * @param string $sort_key		The sorting key e.g. t.topic_time
	 * @param string $sort_dir		Sort direction: ASC/DESC
	 * @return $this
	 */
	public function set_sorting($sort_key, $sort_dir = 'DESC')
	{
		$this->store['sql_array']['ORDER_BY'] = $sort_key . ' ' . $sort_dir;

		return $this;
	}

	/**
	 * Build the query
	 *
	 * @param bool|true $check_visibility		Should we only return data from forums the user is allowed to see?
	 * @param bool|true $enable_caching			Should the query be cached where possible?
	 * @param bool|true $exclude_hidden_forums	Leave out hidden forums?
	 * @return $this
	 */
	public function build($check_visibility = true, $enable_caching = true, $exclude_hidden_forums = true)
	{
		$this->_set_cache_time($enable_caching);
		$this->_set_topic_visibility($check_visibility);
		$this->_set_forum_table($exclude_hidden_forums);

		// Topics table need to be the last in the chain
		$this->store['sql_array']['FROM'][TOPICS_TABLE] = 't';
		$this->store['sql_array']['WHERE'][] = 't.topic_moved_id = 0';

		$this->store['sql_array']['SELECT'] = join(', ', array_filter($this->store['sql_array']['SELECT']));
		$this->store['sql_array']['WHERE'] = join(' AND ', array_filter($this->store['sql_array']['WHERE']));

		return $this;
	}

	/**
	 * Get the query array
	 *
	 * @return array	The sql array that can be used with sql_build_query
	 */
	public function get_sql_array()
	{
		return $this->store['sql_array'];
	}

	/**
	 * @param bool $enable_caching
	 * @return void
	 */
	protected function _set_cache_time($enable_caching)
	{
		if ($enable_caching === false)
		{
			$this->cache_time = 0;
		}
	}

	/**
	 * @param int|array $column_id
	 * @param string $column
	 * @return void
	 */
	private function _fetch($column_id, $column)
	{
		if (!empty($column_id))
		{
			$this->store['sql_array']['WHERE'][] = (is_array($column_id)) ? $this->db->sql_in_set($column, $column_id) : $column . ' = ' . (int) $column_id;
		}
	}

	/**
	 * @param bool $check_visibility
	 * @return void
	 */
	private function _set_topic_visibility($check_visibility)
	{
		if ($check_visibility)
		{
			$this->store['sql_array']['WHERE'][] = $this->content_visibility->get_global_visibility_sql('topic', array_map('intval', $this->ex_fid_ary), 't.');
		}
	}

	/**
	 * @param bool $exclude_hidden_forums
	 * @return void
	 */
	private function _set_forum_table($exclude_hidden_forums)
	{
		if ($exclude_hidden_forums)
		{
			$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
			$this->store['sql_array']['WHERE'][] = 'f.hidden_forum = 0';
		}

		if (isset($this->store['sql_array']['FROM'][FORUMS_TABLE]))
		{
			$this->store['sql_array']['WHERE'][] = 'f.forum_id = t.forum_id';
		}
	}

	/**
	 * Reset data
	 * @return void
	 */
	private function _reset()
	{
		$this->store = array(
			'attachments'	=> array(),
			'post_ids'		=> array(),
			'poster_ids'	=> array(),
			'sql_array'		=> array(),
			'topic'			=> array(),
			'tracking'		=> array(),
		);
	}
}


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 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 array */
30			protected $store;
31
32			/** @var array */
33			protected $ex_fid_ary;
34
35			/** @var integer */
36			protected $cache_time;
37
38			/**
39			* Constructor
40			*
41			* @param \phpbb\auth\auth $auth Auth object
42			* @param \phpbb\config\config $config Config object
43			* @param \phpbb\content_visibility $content_visibility Content visibility
44			* @param \phpbb\db\driver\driver_interface $db Database connection
45			* @param \phpbb\user $user User object
46			* @param integer $cache_time Cache results for 3 hours by default
47			*/
48			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)
49			{
50			$this->auth = $auth;
51			$this->config = $config;
52			$this->content_visibility = $content_visibility;
53			$this->db = $db;
54			$this->user = $user;
55			$this->cache_time = $cache_time;
56
57			$this->ex_fid_ary = array_unique(array_keys($this->auth->acl_getf('!f_read', true)));
58			}
59
60			/**
61			* Begin query
62			*
63			* @param bool $track_topics
64			* @param bool $get_forum_data
65			* @return $this
66			*/
67			public function query($track_topics = true, $get_forum_data = true)
68			{
69			$this->_reset();
70
71			$this->store['sql_array'] = array_fill_keys(array('SELECT', 'FROM', 'LEFT_JOIN', 'WHERE'), array());
72
73			if ($get_forum_data)
74			{
75			$this->store['sql_array']['SELECT'][] = 'f.*';
76			$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
77			}
78
79			$this->store['sql_array']['SELECT'][] = 't.*';
80
81			if ($track_topics)
82			{
83			$this->fetch_tracking_info();
84			}
85
86			return $this;
87			}
88
89			/**
90			* Fetch Forum by id(s)
91			*
92			* @param int\|array $forum_id
93			* @return $this
94			*/
95			public function fetch_forum($forum_id)
96			{
97			$this->_fetch($forum_id, (isset($this->store['sql_array']['FROM'][FORUMS_TABLE])) ? 'f.forum_id' : 't.forum_Id');
98
99			return $this;
100			}
101
102			/**
103			* Fetch Topic by id(s)
104			*
105			* @param mixed $topic_id Limit by topic id: single id or array of topic ids
106			* @return $this
107			*/
108			public function fetch_topic($topic_id)
109			{
110			$this->_fetch($topic_id, 't.topic_id');
111
112			return $this;
113			}
114
115			/**
116			* Fetch Topic by Poster id(s)
117			*
118			* @param mixed $user_id User id of topic poster: single id or array of user ids
119			* @return $this
120			*/
121			public function fetch_topic_poster($user_id)
122			{
123			$this->_fetch($user_id, 't.topic_poster');
124
125			return $this;
126			}
127
128			/**
129			* Fetch by Topic Type
130			*
131			* @param array $topic_type
132			* @return $this
133			*/
134			public function fetch_topic_type(array $topic_type)
135			{
136			if (sizeof($topic_type))
137			{
138			$this->store['sql_array']['WHERE'][] = $this->db->sql_in_set('t.topic_type', $topic_type);
139			}
140
141			return $this;
142			}
143
144			/**
145			* Fetch Topic Watch info
146			*
147			* @param $type
148			* @return $this
149			*/
150			public function fetch_watch_status($type = 'topic')
151			{
152			if ($this->user->data['is_registered'])
153			{
154			$keys = array(
155			'forum' => array(
156			'table' => FORUMS_WATCH_TABLE,
157			'cond' => 'ws.forum_id = f.forum_id',
158			),
159			'topic' => array(
160			'table' => TOPICS_WATCH_TABLE,
161			'cond' => 'ws.topic_id = t.topic_id',
162			),
163			);
164
165			$this->store['sql_array']['SELECT'][] = 'ws.notify_status';
166			$this->store['sql_array']['LEFT_JOIN'][] = array(
167			'FROM' => array($keys[$type]['table'] => 'ws'),
168			'ON' => $keys[$type]['cond'] . ' AND ws.user_id = ' . (int) $this->user->data['user_id'],
169			);
170			}
171
172			return $this;
173			}
174
175			/**
176			* Fetch Topic Bookmark Info
177			*
178			* @return $this
179			*/
180			public function fetch_bookmark_status()
181			{
182			if ($this->user->data['is_registered'] && $this->config['allow_bookmarks'])
183			{
184			$this->store['sql_array']['SELECT'][] = 'bm.topic_id as bookmarked';
185			$this->store['sql_array']['LEFT_JOIN'][] = array(
186			'FROM' => array(BOOKMARKS_TABLE => 'bm'),
187			'ON' => 'bm.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = bm.topic_id'
188			);
189			}
190
191			return $this;
192			}
193
194			/**
195			* Fetch Topic Tracking Info
196			*
197			* @return $this
198			*/
199			public function fetch_tracking_info()
200			{
201			if ($this->user->data['is_registered'] && $this->config['load_db_lastread'])
202			{
203			$this->cache_time = 0;
204
205			$this->store['sql_array']['SELECT'][] = 'tt.mark_time, ft.mark_time as forum_mark_time';
206			$this->store['sql_array']['LEFT_JOIN'][] = array(
207			'FROM' => array(TOPICS_TRACK_TABLE => 'tt'),
208			'ON' => 'tt.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = tt.topic_id'
209			);
210
211			$this->store['sql_array']['LEFT_JOIN'][] = array(
212			'FROM' => array(FORUMS_TRACK_TABLE => 'ft'),
213			'ON' => 'ft.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.forum_id = ft.forum_id'
214			);
215			}
216
217			return $this;
218			}
219
220			/**
221			* Fetch by Date Range
222			*
223			* @param int $unix_start_time
224			* @param int $unix_stop_time
225			* @param string $mode topic\|post
226			* @return $this
227			*/
228			public function fetch_date_range($unix_start_time, $unix_stop_time, $mode = 'topic')
229			{
230			if ($unix_start_time && $unix_stop_time)
231			{
232			$this->store['sql_array']['WHERE'][] = (($mode == 'topic') ? 't.topic_time' : 'p.post_time') . " BETWEEN $unix_start_time AND $unix_stop_time";
233			}
234
235			return $this;
236			}
237
238			/**
239			* Fetch by Custom Query
240			*
241			* @param array $sql_array Array of elements to merge into query
242			* array(
243			* 'SELECT' => array('p.*'),
244			* 'WHERE' => array('p.post_id = 2'),
245			* )
246			* @param array $overwrite_keys Array of query keys to overwrite with yours instead of merging
247			* e.g array('SELECT') will overwrite the 'SELECT' key with whatever is provided in $sql_array
248			* @return $this
249			*/
250			public function fetch_custom(array $sql_array, $overwrite_keys = array())
251			{
252			$this->store['sql_array'] = array_merge_recursive($this->store['sql_array'], $sql_array);
253
254			foreach ($overwrite_keys as $key)
255			{
256			$this->store['sql_array'][$key] = $sql_array[$key];
257			}
258
259			return $this;
260			}
261
262			/**
263			* Set Sorting Order
264			*
265			* @param string $sort_key The sorting key e.g. t.topic_time
266			* @param string $sort_dir Sort direction: ASC/DESC
267			* @return $this
268			*/
269			public function set_sorting($sort_key, $sort_dir = 'DESC')
270			{
271			$this->store['sql_array']['ORDER_BY'] = $sort_key . ' ' . $sort_dir;
272
273			return $this;
274			}
275
276			/**
277			* Build the query
278			*
279			* @param bool\|true $check_visibility Should we only return data from forums the user is allowed to see?
280			* @param bool\|true $enable_caching Should the query be cached where possible?
281			* @param bool\|true $exclude_hidden_forums Leave out hidden forums?
282			* @return $this
283			*/
284			public function build($check_visibility = true, $enable_caching = true, $exclude_hidden_forums = true)
285			{
286			$this->_set_cache_time($enable_caching);
287			$this->_set_topic_visibility($check_visibility);
288			$this->_set_forum_table($exclude_hidden_forums);
289
290			// Topics table need to be the last in the chain
291			$this->store['sql_array']['FROM'][TOPICS_TABLE] = 't';
292			$this->store['sql_array']['WHERE'][] = 't.topic_moved_id = 0';
293
294			$this->store['sql_array']['SELECT'] = join(', ', array_filter($this->store['sql_array']['SELECT']));
295			$this->store['sql_array']['WHERE'] = join(' AND ', array_filter($this->store['sql_array']['WHERE']));
296
297			return $this;
298			}
299
300			/**
301			* Get the query array
302			*
303			* @return array The sql array that can be used with sql_build_query
304			*/
305			public function get_sql_array()
306			{
307			return $this->store['sql_array'];
308			}
309
310			/**
311			* @param bool $enable_caching
312			* @return void
313			*/
314			protected function _set_cache_time($enable_caching)
315			{
316			if ($enable_caching === false)
317			{
318			$this->cache_time = 0;
319			}
320			}
321
322			/**
323			* @param int\|array $column_id
324			* @param string $column
325			* @return void
326			*/
327			private function _fetch($column_id, $column)
328			{
329			if (!empty($column_id))
330			{
331			$this->store['sql_array']['WHERE'][] = (is_array($column_id)) ? $this->db->sql_in_set($column, $column_id) : $column . ' = ' . (int) $column_id;
332			}
333			}
334
335			/**
336			* @param bool $check_visibility
337			* @return void
338			*/
339			private function _set_topic_visibility($check_visibility)
340			{
341			if ($check_visibility)
342			{
343			$this->store['sql_array']['WHERE'][] = $this->content_visibility->get_global_visibility_sql('topic', array_map('intval', $this->ex_fid_ary), 't.');
344			}
345			}
346
347			/**
348			* @param bool $exclude_hidden_forums
349			* @return void
350			*/
351			private function _set_forum_table($exclude_hidden_forums)
352			{
353			if ($exclude_hidden_forums)
354			{
355			$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
356			$this->store['sql_array']['WHERE'][] = 'f.hidden_forum = 0';
357			}
358
359			if (isset($this->store['sql_array']['FROM'][FORUMS_TABLE]))
360			{
361			$this->store['sql_array']['WHERE'][] = 'f.forum_id = t.forum_id';
362			}
363			}
364
365			/**
366			* Reset data
367			* @return void
368			*/
369			private function _reset()
370			{
371			$this->store = array(
372			'attachments' => array(),
373			'post_ids' => array(),
374			'poster_ids' => array(),
375			'sql_array' => array(),
376			'topic' => array(),
377			'tracking' => array(),
378			);
379			}
380			}
381

blitze / phpBB-ext-sitemaker

Push — release-3.2.0 ( b3aabc...d5281f )

query_builder::time() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like