diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2014-08-07 12:43:45 +0200 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2014-08-07 12:43:45 +0200 |
| commit | 2f44a865a01d1c9d1198484c7a9e841c22ef267d (patch) | |
| tree | 1af5a8b36be1540192b3c69d4a5494e4a5e59d65 /phpBB/phpbb/search | |
| parent | 83544992ecc013a2ab0a9b7f9f8329853fb2f212 (diff) | |
| parent | cea0cfa6f8f41ebeb73a0a90f789bfb4190009b6 (diff) | |
| download | forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.gz forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.bz2 forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.xz forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.zip | |
Merge pull request #2477 from n-aleha/ticket/12557ascraeus
[ticket/12557] Fix doc block errors found by Sami for ascraeus
* n-aleha/ticket/12557ascraeus:
[ticket/12557] Fix load active module description
[ticket/12557] Fix php file description
[ticket/12557] Fix post data description for notifications
[ticket/12557] Fix pass by reference doc blocks
[ticket/12557] Fix doc block in extension base class
[ticket/12557] Fix doc block in mimetype guesser
[ticket/12557] Fix var $preserve_cr description
[ticket/12557] Fix doc block errors found by Sami
[ticket/12557] Fix doc block errors found by Sami
[ticket/12557] Fix doc block errors found by Sami
[ticket/12557] Template fixes
[ticket/12557] Search, cron and profilefields fixes
[ticket/12557] Notification fixes
[ticket/12557] Fix doc block errors found by Sami pt1
[ticket/12557] Fix doc block errors found by Sami
[ticket/12557] Fix doc block errors found by Sami
Diffstat (limited to 'phpBB/phpbb/search')
| -rw-r--r-- | phpBB/phpbb/search/base.php | 18 | ||||
| -rw-r--r-- | phpBB/phpbb/search/fulltext_mysql.php | 6 | ||||
| -rw-r--r-- | phpBB/phpbb/search/fulltext_postgres.php | 6 | ||||
| -rw-r--r-- | phpBB/phpbb/search/fulltext_sphinx.php | 6 |
4 files changed, 33 insertions, 3 deletions
diff --git a/phpBB/phpbb/search/base.php b/phpBB/phpbb/search/base.php index 9395b6a273..30781975d8 100644 --- a/phpBB/phpbb/search/base.php +++ b/phpBB/phpbb/search/base.php @@ -85,8 +85,12 @@ class base /** * Retrieves cached search results * - * @param int &$result_count will contain the number of all results for the search (not only for the current page) - * @param array &$id_ary is filled with the ids belonging to the requested page that are stored in the cache + * @param string $search_key an md5 string generated from all the passed search options to identify the results + * @param int &$result_count will contain the number of all results for the search (not only for the current page) + * @param array &$id_ary is filled with the ids belonging to the requested page that are stored in the cache + * @param int &$start indicates the first index of the page + * @param int $per_page number of ids each page is supposed to contain + * @param string $sort_dir is either a or d representing ASC and DESC * * @return int SEARCH_RESULT_NOT_IN_CACHE or SEARCH_RESULT_IN_CACHE or SEARCH_RESULT_INCOMPLETE */ @@ -160,8 +164,16 @@ class base /** * Caches post/topic ids * - * @param array &$id_ary contains a list of post or topic ids that shall be cached, the first element + * @param string $search_key an md5 string generated from all the passed search options to identify the results + * @param string $keywords contains the keywords as entered by the user + * @param array $author_ary an array of author ids, if the author should be ignored during the search the array is empty + * @param int $result_count contains the number of all results for the search (not only for the current page) + * @param array &$id_ary contains a list of post or topic ids that shall be cached, the first element * must have the absolute index $start in the result set. + * @param int $start indicates the first index of the page + * @param string $sort_dir is either a or d representing ASC and DESC + * + * @return null */ function save_ids($search_key, $keywords, $author_ary, $result_count, &$id_ary, $start, $sort_dir) { diff --git a/phpBB/phpbb/search/fulltext_mysql.php b/phpBB/phpbb/search/fulltext_mysql.php index d4e7de31e5..1a0aba096f 100644 --- a/phpBB/phpbb/search/fulltext_mysql.php +++ b/phpBB/phpbb/search/fulltext_mysql.php @@ -73,6 +73,12 @@ class fulltext_mysql extends \phpbb\search\base * 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 $phpbb_root_path Relative path to phpBB root + * @param string $phpEx PHP file extension + * @param \phpbb\auth\auth $auth Auth object + * @param \phpbb\config\config $config Config object + * @param \phpbb\db\driver\driver_interface Database object + * @param \phpbb\user $user User object */ public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user) { diff --git a/phpBB/phpbb/search/fulltext_postgres.php b/phpBB/phpbb/search/fulltext_postgres.php index b3e7f51f87..b6af371d13 100644 --- a/phpBB/phpbb/search/fulltext_postgres.php +++ b/phpBB/phpbb/search/fulltext_postgres.php @@ -86,6 +86,12 @@ class fulltext_postgres extends \phpbb\search\base * 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 $phpbb_root_path Relative path to phpBB root + * @param string $phpEx PHP file extension + * @param \phpbb\auth\auth $auth Auth object + * @param \phpbb\config\config $config Config object + * @param \phpbb\db\driver\driver_interface Database object + * @param \phpbb\user $user User object */ public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user) { diff --git a/phpBB/phpbb/search/fulltext_sphinx.php b/phpBB/phpbb/search/fulltext_sphinx.php index 78c11f1180..79d68d2ae1 100644 --- a/phpBB/phpbb/search/fulltext_sphinx.php +++ b/phpBB/phpbb/search/fulltext_sphinx.php @@ -119,6 +119,12 @@ class fulltext_sphinx * 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 $phpbb_root_path Relative path to phpBB root + * @param string $phpEx PHP file extension + * @param \phpbb\auth\auth $auth Auth object + * @param \phpbb\config\config $config Config object + * @param \phpbb\db\driver\driver_interface Database object + * @param \phpbb\user $user User object */ public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user) { |