query_builder::fetch_watch_status() - Code Metrics - Inspection of "786e4fd2986cc64d1b6f206c1e0c9e9e0d895ad4" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — develop (786e4f)

by Daniel

created 2018-03-04 20:13 UTC

query_builder::fetch_watch_status() A

↳ Parent: query_builder

Complexity

Conditions	2
Paths	2

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	13
nc	2
nop	1
dl	0
loc	23
ccs	16
cts	16
cp	1
crap	2
rs	9.0856
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 */
filter:
    dependency_paths: ["lib/*"]
	protected $auth;

	/** @var \phpbb\config\config */
filter:
    dependency_paths: ["lib/*"]
	protected $config;

	/** @var \phpbb\content_visibility */
filter:
    dependency_paths: ["lib/*"]
	protected $content_visibility;

	/** @var \phpbb\db\driver\driver_interface */
filter:
    dependency_paths: ["lib/*"]
	protected $db;

	/** @var \phpbb\user */
filter:
    dependency_paths: ["lib/*"]
	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'];
	}

	/**
	 * @return int
	 */
	public function time()
	{
		return time();
	}

	/**
	 * @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'][] = 't.topic_time <= ' . (int) $this->time();
			$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 */
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The type `phpbb\auth\auth` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15		protected $auth;
16
17		/** @var \phpbb\config\config */
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The type `phpbb\config\config` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18		protected $config;
19
20		/** @var \phpbb\content_visibility */
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The type `phpbb\content_visibility` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21		protected $content_visibility;
22
23		/** @var \phpbb\db\driver\driver_interface */
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The type `phpbb\db\driver\driver_interface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
24		protected $db;
25
26		/** @var \phpbb\user */
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The type `phpbb\user` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
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	45	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	45	$this->auth = $auth;
51	45	$this->config = $config;
52	45	$this->content_visibility = $content_visibility;
53	45	$this->db = $db;
54	45	$this->user = $user;
55	45	$this->cache_time = $cache_time;
56
57	45	$this->ex_fid_ary = array_unique(array_keys($this->auth->acl_getf('!f_read', true)));
58	45	}
59
60		/**
61		* Begin query
62		*
63		* @param bool $track_topics
64		* @param bool $get_forum_data
65		* @return $this
66		*/
67	35	public function query($track_topics = true, $get_forum_data = true)
68		{
69	35	$this->_reset();
70
71	35	$this->store['sql_array'] = array_fill_keys(array('SELECT', 'FROM', 'LEFT_JOIN', 'WHERE'), array());
72
73		if ($get_forum_data)
74	35	{
75	23	$this->store['sql_array']['SELECT'][] = 'f.*';
76	23	$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\FORUMS_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
77	23	}
78
79	35	$this->store['sql_array']['SELECT'][] = 't.*';
80
81		if ($track_topics)
82	35	{
83	9	$this->fetch_tracking_info();
84	9	}
85
86	35	return $this;
87		}
88
89		/**
90		* Fetch Forum by id(s)
91		*
92		* @param int\|array $forum_id
93		* @return $this
94		*/
95	21	public function fetch_forum($forum_id)
96		{
97	21	$this->_fetch($forum_id, (isset($this->store['sql_array']['FROM'][FORUMS_TABLE])) ? 'f.forum_id' : 't.forum_Id');
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\FORUMS_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
98
99	21	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	15	public function fetch_topic($topic_id)
109		{
110	15	$this->_fetch($topic_id, 't.topic_id');
111
112	15	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	7	public function fetch_topic_poster($user_id)
122		{
123	7	$this->_fetch($user_id, 't.topic_poster');
124
125	7	return $this;
126		}
127
128		/**
129		* Fetch by Topic Type
130		*
131		* @param array $topic_type
132		* @return $this
133		*/
134	17	public function fetch_topic_type(array $topic_type)
135		{
136	17	if (sizeof($topic_type))
137	17	{
138	5	$this->store['sql_array']['WHERE'][] = $this->db->sql_in_set('t.topic_type', $topic_type);
139	5	}
140
141	17	return $this;
142		}
143
144		/**
145		* Fetch Topic Watch info
146		*
147		* @param $type
148		* @return $this
149		*/
150	2	public function fetch_watch_status($type = 'topic')
151		{
152	2	if ($this->user->data['is_registered'])
153	2	{
154		$keys = array(
155		'forum' => array(
156	1	'table' => FORUMS_WATCH_TABLE,
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\FORUMS_WATCH_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
157	1	'cond' => 'ws.forum_id = f.forum_id',
158	1	),
159		'topic' => array(
160	1	'table' => TOPICS_WATCH_TABLE,
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\TOPICS_WATCH_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
161	1	'cond' => 'ws.topic_id = t.topic_id',
162	1	),
163	1	);
164
165	1	$this->store['sql_array']['SELECT'][] = 'ws.notify_status';
166	1	$this->store['sql_array']['LEFT_JOIN'][] = array(
167	1	'FROM' => array($keys[$type]['table'] => 'ws'),
168	1	'ON' => $keys[$type]['cond'] . ' AND ws.user_id = ' . (int) $this->user->data['user_id'],
169		);
170	1	}
171
172	2	return $this;
173		}
174
175		/**
176		* Fetch Topic Bookmark Info
177		*
178		* @return $this
179		*/
180	2	public function fetch_bookmark_status()
181		{
182	2	if ($this->user->data['is_registered'] && $this->config['allow_bookmarks'])
183	2	{
184	1	$this->store['sql_array']['SELECT'][] = 'bm.topic_id as bookmarked';
185	1	$this->store['sql_array']['LEFT_JOIN'][] = array(
186	1	'FROM' => array(BOOKMARKS_TABLE => 'bm'),
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\BOOKMARKS_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
187	1	'ON' => 'bm.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = bm.topic_id'
188	1	);
189	1	}
190
191	2	return $this;
192		}
193
194		/**
195		* Fetch Topic Tracking Info
196		*
197		* @return $this
198		*/
199	9	public function fetch_tracking_info()
200		{
201	9	if ($this->user->data['is_registered'] && $this->config['load_db_lastread'])
202	9	{
203	8	$this->cache_time = 0;
204
205	8	$this->store['sql_array']['SELECT'][] = 'tt.mark_time, ft.mark_time as forum_mark_time';
206	8	$this->store['sql_array']['LEFT_JOIN'][] = array(
207	8	'FROM' => array(TOPICS_TRACK_TABLE => 'tt'),
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\TOPICS_TRACK_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
208	8	'ON' => 'tt.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.topic_id = tt.topic_id'
209	8	);
210
211	8	$this->store['sql_array']['LEFT_JOIN'][] = array(
212	8	'FROM' => array(FORUMS_TRACK_TABLE => 'ft'),
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\FORUMS_TRACK_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
213	8	'ON' => 'ft.user_id = ' . (int) $this->user->data['user_id'] . ' AND t.forum_id = ft.forum_id'
214	8	);
215	8	}
216
217	9	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	14	public function fetch_date_range($unix_start_time, $unix_stop_time, $mode = 'topic')
229		{
230	14	if ($unix_start_time && $unix_stop_time)
231	14	{
232	2	$this->store['sql_array']['WHERE'][] = (($mode == 'topic') ? 't.topic_time' : 'p.post_time') . " BETWEEN $unix_start_time AND $unix_stop_time";
233	2	}
234
235	14	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	13	public function fetch_custom(array $sql_array, $overwrite_keys = array())
251		{
252	13	$this->store['sql_array'] = array_merge_recursive($this->store['sql_array'], $sql_array);
253
254	13	foreach ($overwrite_keys as $key)
255		{
256	3	$this->store['sql_array'][$key] = $sql_array[$key];
257	13	}
258
259	13	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	13	public function set_sorting($sort_key, $sort_dir = 'DESC')
270		{
271	13	$this->store['sql_array']['ORDER_BY'] = $sort_key . ' ' . $sort_dir;
272
273	13	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	35	public function build($check_visibility = true, $enable_caching = true, $exclude_hidden_forums = true)
285		{
286	35	$this->_set_cache_time($enable_caching);
287	35	$this->_set_topic_visibility($check_visibility);
288	35	$this->_set_forum_table($exclude_hidden_forums);
289
290		// Topics table need to be the last in the chain
291	35	$this->store['sql_array']['FROM'][TOPICS_TABLE] = 't';
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\TOPICS_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
292	35	$this->store['sql_array']['WHERE'][] = 't.topic_moved_id = 0';
293
294	35	$this->store['sql_array']['SELECT'] = join(', ', array_filter($this->store['sql_array']['SELECT']));
295	35	$this->store['sql_array']['WHERE'] = join(' AND ', array_filter($this->store['sql_array']['WHERE']));
296
297	35	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	21	public function get_sql_array()
306		{
307	21	return $this->store['sql_array'];
308		}
309
310		/**
311		* @return int
312		*/
313	24	public function time()
314		{
315	24	return time();
316		}
317
318		/**
319		* @param bool $enable_caching
320		* @return void
321		*/
322	35	protected function _set_cache_time($enable_caching)
323		{
324	35	if ($enable_caching === false)
325	35	{
326	5	$this->cache_time = 0;
327	5	}
328	35	}
329
330		/**
331		* @param int\|array $column_id
332		* @param string $column
333		* @return void
334		*/
335	21	private function _fetch($column_id, $column)
336		{
337	21	if (!empty($column_id))
338	21	{
339	12	$this->store['sql_array']['WHERE'][] = (is_array($column_id)) ? $this->db->sql_in_set($column, $column_id) : $column . ' = ' . (int) $column_id;
340	12	}
341	21	}
342
343		/**
344		* @param bool $check_visibility
345		* @return void
346		*/
347	35	private function _set_topic_visibility($check_visibility)
348		{
349		if ($check_visibility)
350	35	{
351	35	$this->store['sql_array']['WHERE'][] = 't.topic_time <= ' . (int) $this->time();
352	35	$this->store['sql_array']['WHERE'][] = $this->content_visibility->get_global_visibility_sql('topic', array_map('intval', $this->ex_fid_ary), 't.');
353	35	}
354	35	}
355
356		/**
357		* @param bool $exclude_hidden_forums
358		* @return void
359		*/
360	35	private function _set_forum_table($exclude_hidden_forums)
361		{
362		if ($exclude_hidden_forums)
363	35	{
364	22	$this->store['sql_array']['FROM'][FORUMS_TABLE] = 'f';
		0 ignored issues – show Bug introduced 2018-03-04 20:20 UTC by Report Bug Copy Issue Report The constant `blitze\sitemaker\services\forum\FORUMS_TABLE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
365	22	$this->store['sql_array']['WHERE'][] = 'f.hidden_forum = 0';
366	22	}
367
368	35	if (isset($this->store['sql_array']['FROM'][FORUMS_TABLE]))
369	35	{
370	33	$this->store['sql_array']['WHERE'][] = 'f.forum_id = t.forum_id';
371	33	}
372	35	}
373
374		/**
375		* Reset data
376		* @return void
377		*/
378	35	private function _reset()
379		{
380	35	$this->store = array(
381	35	'attachments' => array(),
382	35	'post_ids' => array(),
383	35	'poster_ids' => array(),
384	35	'sql_array' => array(),
385	35	'topic' => array(),
386	35	'tracking' => array(),
387		);
388	35	}
389		}
390

blitze / phpBB-ext-sitemaker

Branch — develop (786e4f)

query_builder::fetch_watch_status() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like