1 | <?php |
||
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 | 30 | 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) |
|
59 | |||
60 | /** |
||
61 | * Begin query |
||
62 | * |
||
63 | * @param bool $track_topics |
||
64 | * @return $this |
||
65 | */ |
||
66 | 21 | public function query($track_topics = true) |
|
90 | |||
91 | /** |
||
92 | * Fetch Forum by id(s) |
||
93 | * |
||
94 | * @param $forum_id |
||
95 | * @return $this |
||
96 | */ |
||
97 | 16 | public function fetch_forum($forum_id) |
|
103 | |||
104 | /** |
||
105 | * Fetch Topic by id(s) |
||
106 | * |
||
107 | * @param mixed $topic_id Limit by topic id: single id or array of topic ids |
||
108 | * @return $this |
||
109 | */ |
||
110 | 3 | public function fetch_topic($topic_id) |
|
116 | |||
117 | /** |
||
118 | * Fetch Topic by Poster id(s) |
||
119 | * |
||
120 | * @param mixed $user_id User id of topic poster: single id or array of user ids |
||
121 | * @return $this |
||
122 | */ |
||
123 | 3 | public function fetch_topic_poster($user_id) |
|
129 | |||
130 | /** |
||
131 | * Fetch by Topic Type |
||
132 | * |
||
133 | * @param array $topic_type |
||
134 | * @return $this |
||
135 | */ |
||
136 | 16 | public function fetch_topic_type(array $topic_type) |
|
145 | |||
146 | /** |
||
147 | * Fetch Topic Watch info |
||
148 | * |
||
149 | * @return $this |
||
150 | */ |
||
151 | public function fetch_watch_status() |
||
170 | |||
171 | /** |
||
172 | * Fetch Topic Bookmark Info |
||
173 | * |
||
174 | * @return $this |
||
175 | */ |
||
176 | public function fetch_bookmark_status() |
||
189 | |||
190 | /** |
||
191 | * Fetch Topic Tracking Info |
||
192 | * |
||
193 | * @return $this |
||
194 | */ |
||
195 | 17 | public function fetch_tracking_info() |
|
215 | |||
216 | /** |
||
217 | * Fetch by Date Range |
||
218 | * |
||
219 | * @param int $unix_start_time |
||
220 | * @param int $unix_stop_time |
||
221 | * @param string $mode |
||
222 | * @return $this |
||
223 | */ |
||
224 | 13 | public function fetch_date_range($unix_start_time, $unix_stop_time, $mode = 'topic') |
|
233 | |||
234 | /** |
||
235 | * Fetch by Custom Query |
||
236 | * |
||
237 | * @param array $sql_array Array of elements to merge into query |
||
238 | * array( |
||
239 | * 'SELECT' => array('p.*'), |
||
240 | * 'WHERE' => array('p.post_id = 2'), |
||
241 | * ) |
||
242 | * @return $this |
||
243 | */ |
||
244 | 8 | public function fetch_custom(array $sql_array) |
|
250 | |||
251 | /** |
||
252 | * Set Sorting Order |
||
253 | * |
||
254 | * @param string $sort_key The sorting key e.g. t.topic_time |
||
255 | * @param string $sort_dir Sort direction: ASC/DESC |
||
256 | * @return $this |
||
257 | */ |
||
258 | 13 | public function set_sorting($sort_key, $sort_dir = 'DESC') |
|
264 | |||
265 | /** |
||
266 | * Build the query |
||
267 | * |
||
268 | * @param bool|true $check_visibility Should we only return data from forums the user is allowed to see? |
||
269 | * @param bool|true $enable_caching Should the query be cached where possible? |
||
270 | * @param bool|true $exclude_hidden_forums Leave out hidden forums? |
||
271 | * @return $this |
||
272 | */ |
||
273 | 21 | public function build($check_visibility = true, $enable_caching = true, $exclude_hidden_forums = true) |
|
291 | |||
292 | /** |
||
293 | * Get the query array |
||
294 | * |
||
295 | * @return array The sql array that can be used with sql_build_query |
||
296 | */ |
||
297 | 7 | public function get_sql_array() |
|
301 | |||
302 | /** |
||
303 | * @param bool $enable_caching |
||
304 | */ |
||
305 | 21 | protected function _set_cache_time($enable_caching) |
|
312 | |||
313 | /** |
||
314 | * @param int $column_id |
||
315 | * @param string $column |
||
316 | */ |
||
317 | 16 | private function _fetch($column_id, $column) |
|
324 | |||
325 | /** |
||
326 | * @param bool $check_visibility |
||
327 | */ |
||
328 | 21 | private function _set_topic_visibility($check_visibility) |
|
336 | |||
337 | /** |
||
338 | * Reset data |
||
339 | */ |
||
340 | 21 | private function _reset() |
|
351 | } |
||
352 |