makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 14:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/11050] fix minor comment/docblocks issues

Browse source 
No comments should end with a period. All occurences like PostgreSQL
should have proper case.

PHPBB3-11050
This commit is contained in:
Dhruv 2012-08-15 23:49:51 +05:30
parent 5a7ed3c567
commit 56395ea359
4 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
phpBB/includes/search/fulltext_mysql.php
View file

@ -73,7 +73,7 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
/** /**
* Constructor * Constructor
* Creates a new phpbb_search_fulltext_mysql, which is used as a search backend. * Creates a new phpbb_search_fulltext_mysql, which is used as a search backend
* *
* @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
*/ */
@ -325,7 +325,7 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
} }
/** /**
* Performs a search on keywords depending on display specific params. You have to run split_keywords() first. * Performs a search on keywords depending on display specific params. You have to run split_keywords() first
* *
* @param string $type contains either posts or topics depending on what should be searched for * @param string $type contains either posts or topics depending on what should be searched for
* @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 $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)
@ -346,7 +346,7 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
*/ */
public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page) public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
{ {
// No keywords? No posts. // No keywords? No posts
if (!$this->search_query) if (!$this->search_query)
{ {
return false; return false;
@ -526,7 +526,7 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
*/ */
public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page) public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
{ {
// No author? No posts. // No author? No posts
if (!sizeof($author_ary)) if (!sizeof($author_ary))
{ {
return 0; return 0;
@ -675,7 +675,7 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
} }
/** /**
* Destroys cached search results, that contained one of the new words in a post so the results won't be outdated. * Destroys cached search results, that contained one of the new words in a post so the results won't be outdated
* *
* @param string $mode contains the post mode: edit, post, reply, quote ... * @param string $mode contains the post mode: edit, post, reply, quote ...
* @param int $post_id contains the post id of the post to index * @param int $post_id contains the post id of the post to index

14
phpBB/includes/search/fulltext_native.php
View file

@ -93,9 +93,9 @@ class phpbb_search_fulltext_native extends phpbb_search_base
protected $user; protected $user;
/** /**
* Initialises the fulltext_native search backend with min/max word length and makes sure the UTF-8 normalizer is loaded. * Initialises the fulltext_native search backend with min/max word length and makes sure the UTF-8 normalizer is loaded
* *
* @param boolean|string &$error is passed by reference and should either be set to false on success or an error message on failure. * @param boolean|string &$error is passed by reference and should either be set to false on success or an error message on failure
*/ */
public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user) public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)
{ {
@ -163,14 +163,14 @@ class phpbb_search_fulltext_native extends phpbb_search_base
} }
/** /**
* This function fills $this->search_query with the cleaned user search query. * 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 * 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 * and combined with | inside brackets. They will afterwards be treated like
* an standard search query. * an standard search query.
* *
* Then it analyses the query and fills the internal arrays $must_not_contain_ids, * 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(). * $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 $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') * @param string $terms is either 'all' (use search query as entered, default words to 'must be contained in post')
@ -493,7 +493,7 @@ class phpbb_search_fulltext_native extends phpbb_search_base
} }
/** /**
* Performs a search on keywords depending on display specific params. You have to run split_keywords() first. * Performs a search on keywords depending on display specific params. You have to run split_keywords() first
* *
* @param string $type contains either posts or topics depending on what should be searched for * @param string $type contains either posts or topics depending on what should be searched for
* @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 $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)
@ -859,7 +859,7 @@ class phpbb_search_fulltext_native extends phpbb_search_base
// if we use mysql and the total result count is not cached yet, retrieve it from the db // if we use mysql and the total result count is not cached yet, retrieve it from the db
if (!$total_results && $is_mysql) if (!$total_results && $is_mysql)
{ {
// Count rows for the executed queries. Replace $select within $sql with SQL_CALC_FOUND_ROWS, and run it. // Count rows for the executed queries. Replace $select within $sql with SQL_CALC_FOUND_ROWS, and run it
$sql_array_copy = $sql_array; $sql_array_copy = $sql_array;
$sql_array_copy['SELECT'] = 'SQL_CALC_FOUND_ROWS p.post_id '; $sql_array_copy['SELECT'] = 'SQL_CALC_FOUND_ROWS p.post_id ';
@ -908,7 +908,7 @@ class phpbb_search_fulltext_native extends phpbb_search_base
*/ */
public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page) public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
{ {
// No author? No posts. // No author? No posts
if (!sizeof($author_ary)) if (!sizeof($author_ary))
{ {
return 0; return 0;

16
phpBB/includes/search/fulltext_postgres.php
View file

@ -35,7 +35,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
protected $split_words = array(); protected $split_words = array();
/** /**
* True if postgresql version supports tsearch * True if PostgreSQL version supports tsearch
* @var boolean * @var boolean
*/ */
protected $tsearch_usable = false; protected $tsearch_usable = false;
@ -53,8 +53,8 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
protected $tsearch_query; protected $tsearch_query;
/** /**
* True if phrase search is supported. * True if phrase search is supported
* postgreSQL fulltext currently doesn't support it * PostgreSQL fulltext currently doesn't support it
* @var boolean * @var boolean
*/ */
protected $phrase_search = false; protected $phrase_search = false;
@ -98,7 +98,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
/** /**
* Constructor * Constructor
* Creates a new phpbb_search_fulltext_postgres, which is used as a search backend. * Creates a new phpbb_search_fulltext_postgres, which is used as a search backend
* *
* @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
*/ */
@ -315,7 +315,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
} }
/** /**
* Performs a search on keywords depending on display specific params. You have to run split_keywords() first. * Performs a search on keywords depending on display specific params. You have to run split_keywords() first
* *
* @param string $type contains either posts or topics depending on what should be searched for * @param string $type contains either posts or topics depending on what should be searched for
* @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 $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)
@ -336,7 +336,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
*/ */
public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page) public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
{ {
// No keywords? No posts. // No keywords? No posts
if (!$this->search_query) if (!$this->search_query)
{ {
return false; return false;
@ -520,7 +520,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
*/ */
public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page) public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $m_approve_fid_ary, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
{ {
// No author? No posts. // No author? No posts
if (!sizeof($author_ary)) if (!sizeof($author_ary))
{ {
return 0; return 0;
@ -663,7 +663,7 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
} }
/** /**
* Destroys cached search results, that contained one of the new words in a post so the results won't be outdated. * Destroys cached search results, that contained one of the new words in a post so the results won't be outdated
* *
* @param string $mode contains the post mode: edit, post, reply, quote ... * @param string $mode contains the post mode: edit, post, reply, quote ...
* @param int $post_id contains the post id of the post to index * @param int $post_id contains the post id of the post to index

4
phpBB/includes/search/fulltext_sphinx.php
View file

@ -121,7 +121,7 @@ class phpbb_search_fulltext_sphinx
/** /**
* Constructor * Constructor
* Creates a new phpbb_search_fulltext_postgres, which is used as a search backend. * Creates a new phpbb_search_fulltext_postgres, which is used as a search backend
* *
* @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
*/ */
@ -434,7 +434,7 @@ class phpbb_search_fulltext_sphinx
} }
/** /**
* Performs a search on keywords depending on display specific params. You have to run split_keywords() first. * Performs a search on keywords depending on display specific params. You have to run split_keywords() first
* *
* @param string $type contains either posts or topics depending on what should be searched for * @param string $type contains either posts or topics depending on what should be searched for
* @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 $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)