@@ -21,23 +21,23 @@ discard block |
||
| 21 | 21 | protected $similar_topics; |
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | - * Constructor |
|
| 25 | - * |
|
| 26 | - * @param \vse\similartopics\core\similar_topics $similar_topics |
|
| 27 | - * @access public |
|
| 28 | - */ |
|
| 24 | + * Constructor |
|
| 25 | + * |
|
| 26 | + * @param \vse\similartopics\core\similar_topics $similar_topics |
|
| 27 | + * @access public |
|
| 28 | + */ |
|
| 29 | 29 | public function __construct(\vse\similartopics\core\similar_topics $similar_topics) |
| 30 | 30 | { |
| 31 | 31 | $this->similar_topics = $similar_topics; |
| 32 | 32 | } |
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | - * Assign functions defined in this class to event listeners in the core |
|
| 36 | - * |
|
| 37 | - * @return array |
|
| 38 | - * @static |
|
| 39 | - * @access public |
|
| 40 | - */ |
|
| 35 | + * Assign functions defined in this class to event listeners in the core |
|
| 36 | + * |
|
| 37 | + * @return array |
|
| 38 | + * @static |
|
| 39 | + * @access public |
|
| 40 | + */ |
|
| 41 | 41 | static public function getSubscribedEvents() |
| 42 | 42 | { |
| 43 | 43 | return array( |
@@ -47,12 +47,12 @@ discard block |
||
| 47 | 47 | } |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | - * Display similar topics |
|
| 51 | - * |
|
| 52 | - * @param \phpbb\event\data $event The event object |
|
| 53 | - * @return null |
|
| 54 | - * @access public |
|
| 55 | - */ |
|
| 50 | + * Display similar topics |
|
| 51 | + * |
|
| 52 | + * @param \phpbb\event\data $event The event object |
|
| 53 | + * @return null |
|
| 54 | + * @access public |
|
| 55 | + */ |
|
| 56 | 56 | public function display_similar_topics($event) |
| 57 | 57 | { |
| 58 | 58 | // Return early if no reason to display similar topics |
@@ -65,12 +65,12 @@ discard block |
||
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | /** |
| 68 | - * Add custom permissions language variables |
|
| 69 | - * |
|
| 70 | - * @param \phpbb\event\data $event The event object |
|
| 71 | - * @return null |
|
| 72 | - * @access public |
|
| 73 | - */ |
|
| 68 | + * Add custom permissions language variables |
|
| 69 | + * |
|
| 70 | + * @param \phpbb\event\data $event The event object |
|
| 71 | + * @return null |
|
| 72 | + * @access public |
|
| 73 | + */ |
|
| 74 | 74 | public function add_permissions($event) |
| 75 | 75 | { |
| 76 | 76 | $permissions = $event['permissions']; |
@@ -33,15 +33,15 @@ discard block |
||
| 33 | 33 | protected $user; |
| 34 | 34 | |
| 35 | 35 | /** |
| 36 | - * Constructor |
|
| 37 | - * |
|
| 38 | - * @param \phpbb\auth\auth $auth |
|
| 39 | - * @param \phpbb\config\config $config |
|
| 40 | - * @param \phpbb\request\request $request |
|
| 41 | - * @param \phpbb\template\template $template |
|
| 42 | - * @param \phpbb\user $user |
|
| 43 | - * @access public |
|
| 44 | - */ |
|
| 36 | + * Constructor |
|
| 37 | + * |
|
| 38 | + * @param \phpbb\auth\auth $auth |
|
| 39 | + * @param \phpbb\config\config $config |
|
| 40 | + * @param \phpbb\request\request $request |
|
| 41 | + * @param \phpbb\template\template $template |
|
| 42 | + * @param \phpbb\user $user |
|
| 43 | + * @access public |
|
| 44 | + */ |
|
| 45 | 45 | public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user) |
| 46 | 46 | { |
| 47 | 47 | $this->auth = $auth; |
@@ -52,12 +52,12 @@ discard block |
||
| 52 | 52 | } |
| 53 | 53 | |
| 54 | 54 | /** |
| 55 | - * Assign functions defined in this class to event listeners in the core |
|
| 56 | - * |
|
| 57 | - * @return array |
|
| 58 | - * @static |
|
| 59 | - * @access public |
|
| 60 | - */ |
|
| 55 | + * Assign functions defined in this class to event listeners in the core |
|
| 56 | + * |
|
| 57 | + * @return array |
|
| 58 | + * @static |
|
| 59 | + * @access public |
|
| 60 | + */ |
|
| 61 | 61 | static public function getSubscribedEvents() |
| 62 | 62 | { |
| 63 | 63 | return array( |
@@ -67,12 +67,12 @@ discard block |
||
| 67 | 67 | } |
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | - * Get user's Similar Topics option and display it in UCP Prefs View page |
|
| 71 | - * |
|
| 72 | - * @param \phpbb\event\data $event The event object |
|
| 73 | - * @return null |
|
| 74 | - * @access public |
|
| 75 | - */ |
|
| 70 | + * Get user's Similar Topics option and display it in UCP Prefs View page |
|
| 71 | + * |
|
| 72 | + * @param \phpbb\event\data $event The event object |
|
| 73 | + * @return null |
|
| 74 | + * @access public |
|
| 75 | + */ |
|
| 76 | 76 | public function ucp_prefs_get_data($event) |
| 77 | 77 | { |
| 78 | 78 | // Request the user option vars and add them to the data array |
@@ -92,12 +92,12 @@ discard block |
||
| 92 | 92 | } |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | - * Add user's Similar Topics option state into the sql_array |
|
| 96 | - * |
|
| 97 | - * @param \phpbb\event\data $event The event object |
|
| 98 | - * @return null |
|
| 99 | - * @access public |
|
| 100 | - */ |
|
| 95 | + * Add user's Similar Topics option state into the sql_array |
|
| 96 | + * |
|
| 97 | + * @param \phpbb\event\data $event The event object |
|
| 98 | + * @return null |
|
| 99 | + * @access public |
|
| 100 | + */ |
|
| 101 | 101 | public function ucp_prefs_set_data($event) |
| 102 | 102 | { |
| 103 | 103 | $event['sql_ary'] = array_merge($event['sql_ary'], array( |
@@ -55,10 +55,10 @@ discard block |
||
| 55 | 55 | public $u_action; |
| 56 | 56 | |
| 57 | 57 | /** |
| 58 | - * ACP module constructor |
|
| 59 | - * |
|
| 60 | - * @access public |
|
| 61 | - */ |
|
| 58 | + * ACP module constructor |
|
| 59 | + * |
|
| 60 | + * @access public |
|
| 61 | + */ |
|
| 62 | 62 | public function __construct() |
| 63 | 63 | { |
| 64 | 64 | global $phpbb_container; |
@@ -81,10 +81,10 @@ discard block |
||
| 81 | 81 | } |
| 82 | 82 | |
| 83 | 83 | /** |
| 84 | - * Main ACP module |
|
| 85 | - * |
|
| 86 | - * @access public |
|
| 87 | - */ |
|
| 84 | + * Main ACP module |
|
| 85 | + * |
|
| 86 | + * @access public |
|
| 87 | + */ |
|
| 88 | 88 | public function main() |
| 89 | 89 | { |
| 90 | 90 | $this->user->add_lang_ext('vse/similartopics', 'acp_similar_topics'); |
@@ -247,11 +247,11 @@ discard block |
||
| 247 | 247 | } |
| 248 | 248 | |
| 249 | 249 | /** |
| 250 | - * Check if config field values exceed 255 chars |
|
| 251 | - * |
|
| 252 | - * @return null |
|
| 253 | - * @access protected |
|
| 254 | - */ |
|
| 250 | + * Check if config field values exceed 255 chars |
|
| 251 | + * |
|
| 252 | + * @return null |
|
| 253 | + * @access protected |
|
| 254 | + */ |
|
| 255 | 255 | protected function validate_config_length() |
| 256 | 256 | { |
| 257 | 257 | $arg_list = func_get_args(); |
@@ -265,12 +265,12 @@ discard block |
||
| 265 | 265 | } |
| 266 | 266 | |
| 267 | 267 | /** |
| 268 | - * Check form key, trigger error if invalid |
|
| 269 | - * |
|
| 270 | - * @param string $form_key The form key value |
|
| 271 | - * @return null |
|
| 272 | - * @access protected |
|
| 273 | - */ |
|
| 268 | + * Check form key, trigger error if invalid |
|
| 269 | + * |
|
| 270 | + * @param string $form_key The form key value |
|
| 271 | + * @return null |
|
| 272 | + * @access protected |
|
| 273 | + */ |
|
| 274 | 274 | protected function check_form_key($form_key) |
| 275 | 275 | { |
| 276 | 276 | if (!check_form_key($form_key)) |
@@ -280,11 +280,11 @@ discard block |
||
| 280 | 280 | } |
| 281 | 281 | |
| 282 | 282 | /** |
| 283 | - * Get forums list |
|
| 284 | - * |
|
| 285 | - * @return array forum data rows |
|
| 286 | - * @access protected |
|
| 287 | - */ |
|
| 283 | + * Get forums list |
|
| 284 | + * |
|
| 285 | + * @return array forum data rows |
|
| 286 | + * @access protected |
|
| 287 | + */ |
|
| 288 | 288 | protected function get_forum_list() |
| 289 | 289 | { |
| 290 | 290 | $sql = 'SELECT forum_id, forum_name, similar_topic_forums |
@@ -299,13 +299,13 @@ discard block |
||
| 299 | 299 | } |
| 300 | 300 | |
| 301 | 301 | /** |
| 302 | - * Calculate the time in seconds based on requested time period length |
|
| 303 | - * |
|
| 304 | - * @param int $length user entered value |
|
| 305 | - * @param string $type years, months, weeks, days (y|m|w|d) |
|
| 306 | - * @return int time in seconds |
|
| 307 | - * @access protected |
|
| 308 | - */ |
|
| 302 | + * Calculate the time in seconds based on requested time period length |
|
| 303 | + * |
|
| 304 | + * @param int $length user entered value |
|
| 305 | + * @param string $type years, months, weeks, days (y|m|w|d) |
|
| 306 | + * @return int time in seconds |
|
| 307 | + * @access protected |
|
| 308 | + */ |
|
| 309 | 309 | protected function set_pst_time($length, $type = 'y') |
| 310 | 310 | { |
| 311 | 311 | $type = isset($this->times[$type]) ? $type : 'y'; |
@@ -314,24 +314,24 @@ discard block |
||
| 314 | 314 | } |
| 315 | 315 | |
| 316 | 316 | /** |
| 317 | - * Get the correct time period length value for the form |
|
| 318 | - * |
|
| 319 | - * @param int $time as a timestamp |
|
| 320 | - * @param string $type years, months, weeks, days (y|m|w|d) |
|
| 321 | - * @return int time converted to the given $type |
|
| 322 | - * @access protected |
|
| 323 | - */ |
|
| 317 | + * Get the correct time period length value for the form |
|
| 318 | + * |
|
| 319 | + * @param int $time as a timestamp |
|
| 320 | + * @param string $type years, months, weeks, days (y|m|w|d) |
|
| 321 | + * @return int time converted to the given $type |
|
| 322 | + * @access protected |
|
| 323 | + */ |
|
| 324 | 324 | protected function get_pst_time($time, $type = '') |
| 325 | 325 | { |
| 326 | 326 | return isset($this->times[$type]) ? (int) round($time / $this->times[$type]) : 0; |
| 327 | 327 | } |
| 328 | 328 | |
| 329 | 329 | /** |
| 330 | - * Check for FULLTEXT index support |
|
| 331 | - * |
|
| 332 | - * @return bool True if FULLTEXT is fully supported, false otherwise |
|
| 333 | - * @access protected |
|
| 334 | - */ |
|
| 330 | + * Check for FULLTEXT index support |
|
| 331 | + * |
|
| 332 | + * @return bool True if FULLTEXT is fully supported, false otherwise |
|
| 333 | + * @access protected |
|
| 334 | + */ |
|
| 335 | 335 | protected function fulltext_support_enabled() |
| 336 | 336 | { |
| 337 | 337 | if ($this->fulltext->is_supported()) |
@@ -343,11 +343,11 @@ discard block |
||
| 343 | 343 | } |
| 344 | 344 | |
| 345 | 345 | /** |
| 346 | - * Enable FULLTEXT support for the topic_title |
|
| 347 | - * |
|
| 348 | - * @return null |
|
| 349 | - * @access protected |
|
| 350 | - */ |
|
| 346 | + * Enable FULLTEXT support for the topic_title |
|
| 347 | + * |
|
| 348 | + * @return null |
|
| 349 | + * @access protected |
|
| 350 | + */ |
|
| 351 | 351 | protected function enable_fulltext_support() |
| 352 | 352 | { |
| 353 | 353 | if (!$this->fulltext->is_mysql()) |
@@ -370,13 +370,13 @@ discard block |
||
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
| 373 | - * Return a variable if it is set, otherwise default |
|
| 374 | - * |
|
| 375 | - * @param mixed $var The variable to test |
|
| 376 | - * @param mixed $default The default value to use |
|
| 377 | - * @return mixed The value of the variable if set, otherwise default value |
|
| 378 | - * @access protected |
|
| 379 | - */ |
|
| 373 | + * Return a variable if it is set, otherwise default |
|
| 374 | + * |
|
| 375 | + * @param mixed $var The variable to test |
|
| 376 | + * @param mixed $default The default value to use |
|
| 377 | + * @return mixed The value of the variable if set, otherwise default value |
|
| 378 | + * @access protected |
|
| 379 | + */ |
|
| 380 | 380 | protected function isset_or_default($var, $default) |
| 381 | 381 | { |
| 382 | 382 | return isset($var) ? $var : $default; |