diff options
| author | n-aleha <nick_aleha@myway.com> | 2014-05-17 03:43:34 +0300 |
|---|---|---|
| committer | n-aleha <nick_aleha@myway.com> | 2014-08-03 06:57:05 +0300 |
| commit | 19b9df7e630031e3bdf0640a91f7025da3a00257 (patch) | |
| tree | 100803d4d1390fbddcd0c7f2c448237c586d9f09 /phpBB/phpbb/search/base.php | |
| parent | c991b1d587e8ab3b080e2e6762646efe00e05bc5 (diff) | |
| download | forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.gz forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.bz2 forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.xz forums-19b9df7e630031e3bdf0640a91f7025da3a00257.zip | |
[ticket/12557] Fix doc block errors found by Sami
PHPBB3-12557
Diffstat (limited to 'phpBB/phpbb/search/base.php')
| -rw-r--r-- | phpBB/phpbb/search/base.php | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/phpBB/phpbb/search/base.php b/phpBB/phpbb/search/base.php index 9395b6a273..90f11fc45a 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,15 @@ 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 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) { |