makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-10 13:28:55 +00:00
Code Issues Projects Releases Packages 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
Show stats Download patch file Download diff file Expand all files Collapse all files

3
phpBB/includes/acp/acp_modules.php
View file

@ -766,7 +766,8 @@ class acp_modules
/**
* Update/Add module
*
* @param bool $run_inline if set to true errors will be returned and no logs being written
* @param array &$module_data The module data
* @param bool $run_inline if set to true errors will be returned and no logs being written
*/
function update_module_data(&$module_data, $run_inline = false)
{

12
phpBB/includes/diff/diff.php
View file

@ -46,8 +46,9 @@ class diff
/**
* Computes diffs between sequences of strings.
*
* @param array $from_lines An array of strings. Typically these are lines from a file.
* @param array $to_lines An array of strings.
* @param array $from_lines An array of strings. Typically these are lines from a file.
* @param array $to_lines An array of strings.
* @param bool $preserve_cr If true, \r is replaced by a new line in the diff output
*/
function diff(&$from_content, &$to_content, $preserve_cr = true)
{
@ -491,9 +492,10 @@ class diff3 extends diff
/**
* Computes diff between 3 sequences of strings.
*
* @param array $orig The original lines to use.
* @param array $final1 The first version to compare to.
* @param array $final2 The second version to compare to.
* @param array $orig The original lines to use.
* @param array $final1 The first version to compare to.
* @param array $final2 The second version to compare to.
* @param bool $preserve_cr If true, \r is replaced by a new line in the diff output
*/
function diff3(&$orig, &$final1, &$final2, $preserve_cr = true)
{

4
phpBB/includes/functions_upload.php
View file

@ -97,6 +97,7 @@ class filespec
*
* @param real|unique|unique_ext $mode real creates a realname, filtering some characters, lowering every character. Unique creates an unique filename
* @param string $prefix Prefix applied to filename
* @param string $user_id The user_id is only needed for when cleaning a user's avatar
* @access public
*/
function clean_filename($mode = 'unique', $prefix = '', $user_id = '')
@ -278,6 +279,7 @@ class filespec
*
* @param string $destination_path Destination path, for example $config['avatar_path']
* @param bool $overwrite If set to true, an already existing file will be overwritten
* @param bool $skip_image_check If set to true, the check for the file to be a valid image is skipped
* @param string $chmod Permission mask for chmodding the file after a successful move. The mode entered here reflects the mode defined by {@link phpbb_chmod()}
*
* @access public
@ -498,6 +500,8 @@ class fileupload
* @param int $min_height Minimum image height (only checked for images)
* @param int $max_width Maximum image width (only checked for images)
* @param int $max_height Maximum image height (only checked for images)
* @param bool|array $disallowed_content If enabled, the first 256 bytes of the file must not contain any of it's values.
* Defaults to false.
*
*/
function fileupload($error_prefix = '', $allowed_extensions = false, $max_filesize = false, $min_width = false, $min_height = false, $max_width = false, $max_height = false, $disallowed_content = false)

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)