satanasov / pmsearch

acp/acp_pmsearch_module.php

Indentation +4 added lines, -4 removed lines

@@ -277,10 +277,10 @@
 		return $max_post_id;
 	}
 	/**
-	* Initialises a search backend object
-	*
-	* @return false if no error occurred else an error message
-	*/
+	 * Initialises a search backend object
+	 *
+	 * @return false if no error occurred else an error message
+	 */
 	function init_search($type, &$search, &$error)
 	{
 		global $phpbb_root_path, $phpEx, $user, $auth, $config, $db, $table_prefix;

search/pm_search_fulltext_native.php

Indentation +52 added lines, -52 removed lines

@@ -20,10 +20,10 @@ 
 	protected $target;
 
 	/**
-	* Returns the name of this search backend to be displayed to administrators
-	*
-	* @return string Name
-	*/
+	 * Returns the name of this search backend to be displayed to administrators
+	 *
+	 * @return string Name
+	 */
 	public function get_name($type = 'normal')
 	{
 		switch ($type)
@@ -50,20 +50,20 @@ 
 	}
 
 	/**
-	* This function fills $this->search_query with the cleaned user search query
-	*
-	* If $terms is 'any' then the words will be extracted from the search query
-	* and combined with | inside brackets. They will afterwards be treated like
-	* an standard search query.
-	*
-	* Then it analyses the query and fills the internal arrays $must_not_contain_ids,
-	* $must_contain_ids and $must_exclude_one_ids which are later used by keyword_search()
-	*
-	* @param	string	$keywords	contains the search query string as entered by the user
-	* @param	string	$terms		is either 'all' (use search query as entered, default words to 'must be contained in post')
-	* 	or 'any' (find all posts containing at least one of the given words)
-	* @return	boolean				false if no valid keywords were found and otherwise true
-	*/
+	 * This function fills $this->search_query with the cleaned user search query
+	 *
+	 * If $terms is 'any' then the words will be extracted from the search query
+	 * and combined with | inside brackets. They will afterwards be treated like
+	 * an standard search query.
+	 *
+	 * Then it analyses the query and fills the internal arrays $must_not_contain_ids,
+	 * $must_contain_ids and $must_exclude_one_ids which are later used by keyword_search()
+	 *
+	 * @param	string	$keywords	contains the search query string as entered by the user
+	 * @param	string	$terms		is either 'all' (use search query as entered, default words to 'must be contained in post')
+	 * 	or 'any' (find all posts containing at least one of the given words)
+	 * @return	boolean				false if no valid keywords were found and otherwise true
+	 */
 	public function split_keywords($keywords, $terms)
 	{
 		$swl_table = PRIVMSGS_TABLE . '_swl';
@@ -367,22 +367,22 @@ 
 	}
 
 	/**
-	* Performs a search on keywords depending on display specific params. You have to run split_keywords() first
-	*
-	* @param	string		$type				wchich type of table to be searched defaults to norma
-	* @param	string		$fields				contains either titleonly (topic titles should be searched), msgonly (only message bodies should be searched), firstpost (only subject and body of the first post should be searched) or all (all post bodies and subjects should be searched)
-	* @param	string		$terms				is either 'all' (use query as entered, words without prefix should default to "have to be in field") or 'any' (ignore search query parts and just return all posts that contain any of the specified words)
-	* @param	array		$sort_by_sql		contains SQL code for the ORDER BY part of a query
-	* @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
-	* @param	string		$sort_dir			is either a or d representing ASC and DESC
-	* @param	string		$sort_days			specifies the maximum amount of days a post may be old
-	* @param	array		$author_ary			an array of author ids if the author should be ignored during the search the array is empty
-	* @param	string		$author_name		specifies the author match, when ANONYMOUS is also a search-match
-	* @param	array		&$id_ary			passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered
-	* @param	int			$start				indicates the first index of the page
-	* @param	int			$per_page			number of ids each page is supposed to contain
-	* @return	boolean|int						total number of results
-	*/
+	 * Performs a search on keywords depending on display specific params. You have to run split_keywords() first
+	 *
+	 * @param	string		$type				wchich type of table to be searched defaults to norma
+	 * @param	string		$fields				contains either titleonly (topic titles should be searched), msgonly (only message bodies should be searched), firstpost (only subject and body of the first post should be searched) or all (all post bodies and subjects should be searched)
+	 * @param	string		$terms				is either 'all' (use query as entered, words without prefix should default to "have to be in field") or 'any' (ignore search query parts and just return all posts that contain any of the specified words)
+	 * @param	array		$sort_by_sql		contains SQL code for the ORDER BY part of a query
+	 * @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
+	 * @param	string		$sort_dir			is either a or d representing ASC and DESC
+	 * @param	string		$sort_days			specifies the maximum amount of days a post may be old
+	 * @param	array		$author_ary			an array of author ids if the author should be ignored during the search the array is empty
+	 * @param	string		$author_name		specifies the author match, when ANONYMOUS is also a search-match
+	 * @param	array		&$id_ary			passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered
+	 * @param	int			$start				indicates the first index of the page
+	 * @param	int			$per_page			number of ids each page is supposed to contain
+	 * @return	boolean|int						total number of results
+	 */
 	public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, &$id_ary, &$start, $per_page)
 	{
 		// No keywords? No posts.
@@ -718,15 +718,15 @@ 
 	}
 
 	/**
-	* Updates wordlist and wordmatch tables when a message is posted or changed
-	*
-	* @param	string	$mode		Contains the post mode: edit, post, reply, quote
-	* @param	int		$post_id	The id of the post which is modified/created
-	* @param	string	&$message	New or updated post content
-	* @param	string	&$subject	New or updated post subject
-	* @param	int		$poster_id	Post author's user id
-	* @param	int		$forum_id	The id of the forum in which the post is located
-	*/
+	 * Updates wordlist and wordmatch tables when a message is posted or changed
+	 *
+	 * @param	string	$mode		Contains the post mode: edit, post, reply, quote
+	 * @param	int		$post_id	The id of the post which is modified/created
+	 * @param	string	&$message	New or updated post content
+	 * @param	string	&$subject	New or updated post subject
+	 * @param	int		$poster_id	Post author's user id
+	 * @param	int		$forum_id	The id of the forum in which the post is located
+	 */
 	public function index($mode, $post_id, &$message, &$subject, $poster_id, $forum_id = '')
 	{
 		$wordlist = PRIVMSGS_TABLE . '_swl';
@@ -941,9 +941,9 @@ 
 	}
 
 	/**
-	* Tidy up indexes: Tag 'common words' and remove
-	* words no longer referenced in the match table
-	*/
+	 * Tidy up indexes: Tag 'common words' and remove
+	 * words no longer referenced in the match table
+	 */
 	public function tidy()
 	{
 		$swl_table = PRIVMSGS_TABLE . '_swl';
@@ -1008,8 +1008,8 @@ 
 	}
 
 	/**
-	* Deletes all words from the index
-	*/
+	 * Deletes all words from the index
+	 */
 	public function delete_index($acp_module, $u_action, $type = 'normal')
 	{
 		$swl_table = PRIVMSGS_TABLE . '_swl';
@@ -1033,8 +1033,8 @@ 
 	}
 
 	/**
-	* Returns true if both FULLTEXT indexes exist
-	*/
+	 * Returns true if both FULLTEXT indexes exist
+	 */
 	public function index_created($type = 'normal')
 	{
 		if (!sizeof($this->stats))
@@ -1050,8 +1050,8 @@ 
 	}
 
 	/**
-	* Returns an associative array containing information about the indexes
-	*/
+	 * Returns an associative array containing information about the indexes
+	 */
 	public function index_stats($type = 'normal')
 	{
 		if (!sizeof($this->stats))