mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-12 19:54:12 +02:00
Code Issues Releases Wiki Activity

[ticket/12557] Fix doc block errors found by Sami

Browse Source 
PHPBB3-12557
This commit is contained in:
n-aleha
2014-05-17 03:43:34 +03:00
parent c991b1d587
commit 19b9df7e63
6 changed files with 41 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
phpBB/phpbb/auth/auth.php
View File

@@ -208,9 +208,11 @@ class auth
/**
* Get forums with the specified permission setting
* if the option is prefixed with !, then the result becomes negated
*
* @param bool $clean set to true if only values needs to be returned which are set/unset
* @param string $opt The permission name to lookup. If it's prefixed with !, then the result becomes negated.
* @param bool $clean set to true if only values needs to be returned which are set/unset
*
* @return array Contains the forum ids with the specified permision set to true.
*/
function acl_getf($opt, $clean = false)
{

17
phpBB/phpbb/search/base.php
View File

@@ -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)
{

16
phpBB/phpbb/session.php
View File

@@ -1062,11 +1062,13 @@ class session
* Check for banned user
*
* Checks whether the supplied user is banned by id, ip or email. If no parameters
* are passed to the method pre-existing session data is used. If $return is false
* this routine does not return on finding a banned user, it outputs a relevant
* message and stops execution.
* are passed to the method pre-existing session data is used.
*
* @param string|array $user_ips Can contain a string with one IP or an array of multiple IPs
* @param int|false $user_id The user id
* @param string|array|false $user_ips Can contain a string with one IP or an array of multiple IPs
* @param string|false $user_email The user email
* @param bool $return If $return is false this routine does not return on finding a banned user,
* it outputs a relevant message and stops execution.
*/
function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false)
{
@@ -1254,12 +1256,14 @@ class session
/**
* Check if ip is blacklisted
* This should be called only where absolutly necessary
* This should be called only where absolutely necessary
*
* Only IPv4 (rbldns does not support AAAA records/IPv6 lookups)
*
* @author satmd (from the php manual)
* @param string $mode register/post - spamcop for example is ommitted for posting
* @param string $mode register/post - spamcop for example is ommitted for posting
* @param string|false $ip the IPv4 address to check
*
* @return false if ip is not blacklisted, else an array([checked server], [lookup])
*/
function check_dnsbl($mode, $ip = false)