iMattPro / similartopics

acp/similar_topics_module.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,7 @@
 	* Return a variable if it is set, otherwise default
 	*
 	* @param mixed $var The variable to test
-	* @param mixed $default The default value to use
+	* @param false|string $default The default value to use
 	* @return mixed The value of the variable if set, otherwise default value
 	* @access protected
 	*/

Indentation +57 added lines, -57 removed lines

@@ -59,10 +59,10 @@ 
 	public $u_action;
 
 	/**
-	* ACP module constructor
-	*
-	* @access public
-	*/
+	 * ACP module constructor
+	 *
+	 * @access public
+	 */
 	public function __construct()
 	{
 		global $config, $db, $request, $template, $user, $phpbb_log, $phpbb_root_path, $phpEx;
@@ -85,12 +85,12 @@ 
 	}
 
 	/**
-	* Main ACP module
-	*
-	* @param int $id
-	* @param string $mode
-	* @access public
-	*/
+	 * Main ACP module
+	 *
+	 * @param int $id
+	 * @param string $mode
+	 * @access public
+	 */
 	public function main($id, $mode)
 	{
 		$form_key = 'acp_similar_topics';
@@ -254,11 +254,11 @@ 
 	}
 
 	/**
-	* Check if config field values exceed 255 chars
-	*
-	* @return null
-	* @access protected
-	*/
+	 * Check if config field values exceed 255 chars
+	 *
+	 * @return null
+	 * @access protected
+	 */
 	protected function validate_config_length()
 	{
 		$arg_list = func_get_args();
@@ -272,12 +272,12 @@ 
 	}
 
 	/**
-	* Check form key, trigger error if invalid
-	*
-	* @param string $form_key The form key value
-	* @return null
-	* @access protected
-	*/
+	 * Check form key, trigger error if invalid
+	 *
+	 * @param string $form_key The form key value
+	 * @return null
+	 * @access protected
+	 */
 	protected function check_form_key($form_key)
 	{
 		if (!check_form_key($form_key))
@@ -287,11 +287,11 @@ 
 	}
 
 	/**
-	* Get forums list
-	*
-	* @return array	forum data rows
-	* @access protected
-	*/
+	 * Get forums list
+	 *
+	 * @return array	forum data rows
+	 * @access protected
+	 */
 	protected function get_forum_list()
 	{
 		$sql = 'SELECT forum_id, forum_name, similar_topic_forums
@@ -306,13 +306,13 @@ 
 	}
 
 	/**
-	* Calculate the $pst_time based on user input
-	*
-	* @param int $length user entered value
-	* @param string $type years, months, weeks, days (y|m|w|d)
-	* @return int time in seconds
-	* @access protected
-	*/
+	 * Calculate the $pst_time based on user input
+	 *
+	 * @param int $length user entered value
+	 * @param string $type years, months, weeks, days (y|m|w|d)
+	 * @return int time in seconds
+	 * @access protected
+	 */
 	protected function set_pst_time($length, $type = 'y')
 	{
 		$type = array_key_exists($type, self::TIMES) ? $type : 'y';
@@ -321,24 +321,24 @@ 
 	}
 
 	/**
-	* Get the correct time $length value for the form
-	*
-	* @param int $time as a timestamp
-	* @param string $type years, months, weeks, days (y|m|w|d)
-	* @return int time converted to the given $type
-	* @access protected
-	*/
+	 * Get the correct time $length value for the form
+	 *
+	 * @param int $time as a timestamp
+	 * @param string $type years, months, weeks, days (y|m|w|d)
+	 * @return int time converted to the given $type
+	 * @access protected
+	 */
 	protected function get_pst_time($time, $type = '')
 	{
 		return array_key_exists($type, self::TIMES) ? (int) round($time / self::TIMES[$type]) : 0;
 	}
 
 	/**
-	* Check for FULLTEXT index support
-	*
-	* @return bool True if FULLTEXT is fully supported, false otherwise
-	* @access protected
-	*/
+	 * Check for FULLTEXT index support
+	 *
+	 * @return bool True if FULLTEXT is fully supported, false otherwise
+	 * @access protected
+	 */
 	protected function fulltext_support_enabled()
 	{
 		if ($this->fulltext->is_supported())
@@ -350,11 +350,11 @@ 
 	}
 
 	/**
-	* Enable FULLTEXT support for the topic_title
-	*
-	* @return null
-	* @access protected
-	*/
+	 * Enable FULLTEXT support for the topic_title
+	 *
+	 * @return null
+	 * @access protected
+	 */
 	protected function enable_fulltext_support()
 	{
 		if (!$this->fulltext->is_mysql())
@@ -377,13 +377,13 @@ 
 	}
 
 	/**
-	* Return a variable if it is set, otherwise default
-	*
-	* @param mixed $var The variable to test
-	* @param mixed $default The default value to use
-	* @return mixed The value of the variable if set, otherwise default value
-	* @access protected
-	*/
+	 * Return a variable if it is set, otherwise default
+	 *
+	 * @param mixed $var The variable to test
+	 * @param mixed $default The default value to use
+	 * @return mixed The value of the variable if set, otherwise default value
+	 * @access protected
+	 */
 	protected function isset_or_default($var, $default)
 	{
 		return (isset($var)) ? $var : $default;

event/ucp_listener.php

Indentation +27 added lines, -27 removed lines

@@ -33,15 +33,15 @@ 
 	protected $user;
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\auth\auth $auth
-	* @param \phpbb\config\config $config
-	* @param \phpbb\request\request $request
-	* @param \phpbb\template\template $template
-	* @param \phpbb\user $user
-	* @access public
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\auth\auth $auth
+	 * @param \phpbb\config\config $config
+	 * @param \phpbb\request\request $request
+	 * @param \phpbb\template\template $template
+	 * @param \phpbb\user $user
+	 * @access public
+	 */
 	public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
 	{
 		$this->auth = $auth;
@@ -52,12 +52,12 @@ 
 	}
 
 	/**
-	* Assign functions defined in this class to event listeners in the core
-	*
-	* @return array
-	* @static
-	* @access public
-	*/
+	 * Assign functions defined in this class to event listeners in the core
+	 *
+	 * @return array
+	 * @static
+	 * @access public
+	 */
 	static public function getSubscribedEvents()
 	{
 		return array(
@@ -67,12 +67,12 @@ 
 	}
 
 	/**
-	* Get user's Similar Topics option and display it in UCP Prefs View page
-	*
-	* @param object $event The event object
-	* @return null
-	* @access public
-	*/
+	 * Get user's Similar Topics option and display it in UCP Prefs View page
+	 *
+	 * @param object $event The event object
+	 * @return null
+	 * @access public
+	 */
 	public function ucp_prefs_get_data($event)
 	{
 		// Request the user option vars and add them to the data array
@@ -92,12 +92,12 @@ 
 	}
 
 	/**
-	* Add user's Similar Topics option state into the sql_array
-	*
-	* @param object $event The event object
-	* @return null
-	* @access public
-	*/
+	 * Add user's Similar Topics option state into the sql_array
+	 *
+	 * @param object $event The event object
+	 * @return null
+	 * @access public
+	 */
 	public function ucp_prefs_set_data($event)
 	{
 		$event['sql_ary'] = array_merge($event['sql_ary'], array(

event/listener.php

Indentation +23 added lines, -23 removed lines

@@ -21,23 +21,23 @@ 
 	protected $similar_topics;
 
 	/**
-	* Constructor
-	*
-	* @param \vse\similartopics\core\similar_topics $similar_topics
-	* @access public
-	*/
+	 * Constructor
+	 *
+	 * @param \vse\similartopics\core\similar_topics $similar_topics
+	 * @access public
+	 */
 	public function __construct(\vse\similartopics\core\similar_topics $similar_topics)
 	{
 		$this->similar_topics = $similar_topics;
 	}
 
 	/**
-	* Assign functions defined in this class to event listeners in the core
-	*
-	* @return array
-	* @static
-	* @access public
-	*/
+	 * Assign functions defined in this class to event listeners in the core
+	 *
+	 * @return array
+	 * @static
+	 * @access public
+	 */
 	static public function getSubscribedEvents()
 	{
 		return array(
@@ -47,12 +47,12 @@ 
 	}
 
 	/**
-	* Display similar topics
-	*
-	* @param object $event The event object
-	* @return null
-	* @access public
-	*/
+	 * Display similar topics
+	 *
+	 * @param object $event The event object
+	 * @return null
+	 * @access public
+	 */
 	public function display_similar_topics($event)
 	{
 		// Return early if no reason to display similar topics
@@ -65,12 +65,12 @@ 
 	}
 
 	/**
-	* Add custom permissions language variables
-	*
-	* @param object $event The event object
-	* @return null
-	* @access public
-	*/
+	 * Add custom permissions language variables
+	 *
+	 * @param object $event The event object
+	 * @return null
+	 * @access public
+	 */
 	public function add_permissions($event)
 	{
 		$permissions = $event['permissions'];

migrations/release_1_1_0_data.php

Indentation +8 added lines, -8 removed lines

@@ -63,8 +63,8 @@ 
 	}
 
 	/**
-	* Add a FULLTEXT index to phpbb_topics.topic_title
-	*/
+	 * Add a FULLTEXT index to phpbb_topics.topic_title
+	 */
 	public function add_topic_title_fulltext()
 	{
 		$fulltext = $this->get_fulltext();
@@ -78,8 +78,8 @@ 
 	}
 
 	/**
-	* Drop the FULLTEXT index on phpbb_topics.topic_title
-	*/
+	 * Drop the FULLTEXT index on phpbb_topics.topic_title
+	 */
 	public function drop_topic_title_fulltext()
 	{
 		$fulltext = $this->get_fulltext();
@@ -93,10 +93,10 @@ 
 	}
 
 	/**
-	* Get an instance of the fulltext class
-	*
-	* @return \vse\similartopics\core\fulltext_support
-	*/
+	 * Get an instance of the fulltext class
+	 *
+	 * @return \vse\similartopics\core\fulltext_support
+	 */
 	public function get_fulltext()
 	{
 		return new \vse\similartopics\core\fulltext_support($this->db);

migrations/release_1_3_0_fulltext.php

Indentation +3 added lines, -3 removed lines

@@ -40,9 +40,9 @@
 	}
 
 	/**
-	* Drop the FULLTEXT index on phpbb_topics.topic_title
-	* Convert phpbb_topics back to the original storage engine
-	*/
+	 * Drop the FULLTEXT index on phpbb_topics.topic_title
+	 * Convert phpbb_topics back to the original storage engine
+	 */
 	public function revert_fulltext_changes()
 	{
 		$fulltext = new \vse\similartopics\core\fulltext_support($this->db);

core/fulltext_support.php

Indentation +26 added lines, -26 removed lines

@@ -19,31 +19,31 @@ 
 	protected $engine;
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\db\driver\driver_interface
-	* @access public
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\db\driver\driver_interface
+	 * @access public
+	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db)
 	{
 		$this->db = $db;
 	}
 
 	/**
-	* Check if the database is using MySQL
-	*
-	* @return bool True if is mysql, false otherwise
-	*/
+	 * Check if the database is using MySQL
+	 *
+	 * @return bool True if is mysql, false otherwise
+	 */
 	public function is_mysql()
 	{
 		return ($this->db->get_sql_layer() == 'mysql4' || $this->db->get_sql_layer() == 'mysqli');
 	}
 
 	/**
-	* Check for FULLTEXT index support
-	*
-	* @return bool True if FULLTEXT is supported, false otherwise
-	*/
+	 * Check for FULLTEXT index support
+	 *
+	 * @return bool True if FULLTEXT is supported, false otherwise
+	 */
 	public function is_supported()
 	{
 		// FULLTEXT is supported on InnoDB since MySQL 5.6.4 according to
@@ -52,20 +52,20 @@ 
 	}
 
 	/**
-	* Get the database storage engine name
-	*
-	* @return string The storage engine name
-	*/
+	 * Get the database storage engine name
+	 *
+	 * @return string The storage engine name
+	 */
 	public function get_engine()
 	{
 		return (isset($this->engine)) ? $this->engine : $this->set_engine();
 	}
 
 	/**
-	* Set the database storage engine name
-	*
-	* @return string The storage engine name
-	*/
+	 * Set the database storage engine name
+	 *
+	 * @return string The storage engine name
+	 */
 	public function set_engine()
 	{
 		$this->engine = '';
@@ -90,11 +90,11 @@ 
 	}
 
 	/**
-	* Check if a field is a FULLTEXT index
-	*
-	* @param string $field name of a field
-	* @return bool True if field is a FULLTEXT index, false otherwise
-	*/
+	 * Check if a field is a FULLTEXT index
+	 *
+	 * @param string $field name of a field
+	 * @return bool True if field is a FULLTEXT index, false otherwise
+	 */
 	public function index($field = 'topic_title')
 	{
 		$sql = 'SHOW INDEX

core/similar_topics.php

Indentation +84 added lines, -84 removed lines

@@ -49,22 +49,22 @@ 
 	protected $php_ext;
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\auth\auth $auth
-	* @param \phpbb\cache\service $cache
-	* @param \phpbb\config\config $config
-	* @param \phpbb\db\driver\driver_interface $db
-	* @param \phpbb\event\dispatcher_interface $dispatcher
-	* @param \phpbb\pagination $pagination
-	* @param \phpbb\request\request $request
-	* @param \phpbb\template\template $template
-	* @param \phpbb\user $user
-	* @param \phpbb\content_visibility $content_visibility
-	* @param string $root_path
-	* @param string $php_ext
-	* @access public
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\auth\auth $auth
+	 * @param \phpbb\cache\service $cache
+	 * @param \phpbb\config\config $config
+	 * @param \phpbb\db\driver\driver_interface $db
+	 * @param \phpbb\event\dispatcher_interface $dispatcher
+	 * @param \phpbb\pagination $pagination
+	 * @param \phpbb\request\request $request
+	 * @param \phpbb\template\template $template
+	 * @param \phpbb\user $user
+	 * @param \phpbb\content_visibility $content_visibility
+	 * @param string $root_path
+	 * @param string $php_ext
+	 * @access public
+	 */
 	public function __construct(\phpbb\auth\auth $auth, \phpbb\cache\service $cache, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher_interface $dispatcher, \phpbb\pagination $pagination, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user, \phpbb\content_visibility $content_visibility, $root_path, $php_ext)
 	{
 		$this->auth = $auth;
@@ -82,11 +82,11 @@ 
 	}
 
 	/**
-	* Is similar topics available?
-	*
-	* @return bool True if available, false otherwise
-	* @access public
-	*/
+	 * Is similar topics available?
+	 *
+	 * @return bool True if available, false otherwise
+	 * @access public
+	 */
 	public function is_available()
 	{
 		return !empty($this->config['similar_topics']) && // is enabled
@@ -98,29 +98,29 @@ 
 	}
 
 	/**
-	* Is the forum available for displaying similar topics
-	*
-	* @param int $forum_id A forum identifier
-	* @return bool True if available, false otherwise
-	* @access public
-	*/
+	 * Is the forum available for displaying similar topics
+	 *
+	 * @param int $forum_id A forum identifier
+	 * @return bool True if available, false otherwise
+	 * @access public
+	 */
 	public function forum_available($forum_id)
 	{
 		return !in_array($forum_id, explode(',', $this->config['similar_topics_hide']));
 	}
 
 	/**
-	* Get similar topics by matching topic titles
-	*
-	* NOTE: Currently requires MySQL due to the use of FULLTEXT indexes
-	* and MATCH and AGAINST and UNIX_TIMESTAMP. MySQL FULLTEXT has built-in
-	* English ignore words. We use phpBB's ignore words for non-English
-	* languages. We also remove any admin-defined special ignore words.
-	*
-	* @param	array	$topic_data	Array with topic data
-	* @return 	null
-	* @access	public
-	*/
+	 * Get similar topics by matching topic titles
+	 *
+	 * NOTE: Currently requires MySQL due to the use of FULLTEXT indexes
+	 * and MATCH and AGAINST and UNIX_TIMESTAMP. MySQL FULLTEXT has built-in
+	 * English ignore words. We use phpBB's ignore words for non-English
+	 * languages. We also remove any admin-defined special ignore words.
+	 *
+	 * @param	array	$topic_data	Array with topic data
+	 * @return 	null
+	 * @access	public
+	 */
 	public function display_similar_topics($topic_data)
 	{
 		$topic_title = $this->clean_topic_title($topic_data['topic_title']);
@@ -198,12 +198,12 @@ 
 		}
 
 		/**
-		* Event to modify the sql_array for similar topics
-		*
-		* @event vse.similartopics.get_topic_data
-		* @var	array	sql_array	SQL array to get similar topics data
-		* @since 1.3.0
-		*/
+		 * Event to modify the sql_array for similar topics
+		 *
+		 * @event vse.similartopics.get_topic_data
+		 * @var	array	sql_array	SQL array to get similar topics data
+		 * @since 1.3.0
+		 */
 		$vars = array('sql_array');
 		extract($this->dispatcher->trigger_event('vse.similartopics.get_topic_data', compact($vars)));
 
@@ -291,13 +291,13 @@ 
 				);
 
 				/**
-				* Event to modify the similar topics template block
-				*
-				* @event vse.similartopics.modify_topicrow
-				* @var	array	row			Array with similar topic data
-				* @var	array	topic_row	Template block array
-				* @since 1.3.0
-				*/
+				 * Event to modify the similar topics template block
+				 *
+				 * @event vse.similartopics.modify_topicrow
+				 * @var	array	row			Array with similar topic data
+				 * @var	array	topic_row	Template block array
+				 * @since 1.3.0
+				 */
 				$vars = array('row', 'topic_row');
 				extract($this->dispatcher->trigger_event('vse.similartopics.modify_topicrow', compact($vars)));
 
@@ -322,12 +322,12 @@ 
 	}
 
 	/**
-	* Clean topic title (and if needed, ignore-words)
-	*
-	* @param	string	$text	The topic title
-	* @return	string	The topic title
-	* @access	public
-	*/
+	 * Clean topic title (and if needed, ignore-words)
+	 *
+	 * @param	string	$text	The topic title
+	 * @return	string	The topic title
+	 * @access	public
+	 */
 	public function clean_topic_title($text)
 	{
 		// Strip quotes, ampersands
@@ -342,12 +342,12 @@ 
 	}
 
 	/**
-	* Remove any non-english and/or custom defined ignore-words
-	*
-	* @param	string	$text			The topic title
-	* @return	string	The topic title
-	* @access	protected
-	*/
+	 * Remove any non-english and/or custom defined ignore-words
+	 *
+	 * @param	string	$text			The topic title
+	 * @return	string	The topic title
+	 * @access	protected
+	 */
 	protected function strip_stop_words($text)
 	{
 		$words = array();
@@ -375,12 +375,12 @@ 
 	}
 
 	/**
-	* Helper function to split string into an array of words
-	*
-	* @param	string	$text	String of plain text words
-	* @return	array	Array of plaintext words
-	* @access	protected
-	*/
+	 * Helper function to split string into an array of words
+	 *
+	 * @param	string	$text	String of plain text words
+	 * @return	array	Array of plaintext words
+	 * @access	protected
+	 */
 	protected function make_word_array($text)
 	{
 		// Strip out any non-alpha-numeric characters using PCRE regex syntax
@@ -400,33 +400,33 @@ 
 	}
 
 	/**
-	* Check if English is the current user's language
-	*
-	* @return	bool	True if lang is 'en' or 'en_us', false otherwise
-	* @access	protected
-	*/
+	 * Check if English is the current user's language
+	 *
+	 * @return	bool	True if lang is 'en' or 'en_us', false otherwise
+	 * @access	protected
+	 */
 	protected function english_lang()
 	{
 		return ($this->user->lang_name == 'en' || $this->user->lang_name == 'en_us');
 	}
 
 	/**
-	* Check if custom ignore words have been defined for similar topics
-	*
-	* @return	bool	True or false
-	* @access	protected
-	*/
+	 * Check if custom ignore words have been defined for similar topics
+	 *
+	 * @return	bool	True or false
+	 * @access	protected
+	 */
 	protected function has_ignore_words()
 	{
 		return !empty($this->config['similar_topics_words']);
 	}
 
 	/**
-	* Check if the database layer is MySQL4 or later
-	*
-	* @return	bool	True is MySQL4 or later, false otherwise
-	* @access	protected
-	*/
+	 * Check if the database layer is MySQL4 or later
+	 *
+	 * @return	bool	True is MySQL4 or later, false otherwise
+	 * @access	protected
+	 */
 	protected function is_mysql()
 	{
 		return ($this->db->get_sql_layer() == 'mysql4' || $this->db->get_sql_layer() == 'mysqli');