SimpleMachines /
SMF2.1
@@ -475,7 +475,7 @@ |
||
| 475 | 475 | * Used by fatal_error(), fatal_lang_error() |
| 476 | 476 | * |
| 477 | 477 | * @param string $error The error |
| 478 | - * @param array $sprintf An array of data to be sprintf()'d into the specified message |
|
| 478 | + * @param boolean $sprintf An array of data to be sprintf()'d into the specified message |
|
| 479 | 479 | */ |
| 480 | 480 | function log_error_online($error, $sprintf = array()) |
| 481 | 481 | { |
@@ -2241,9 +2241,9 @@ discard block |
||
| 2241 | 2241 | * |
| 2242 | 2242 | * @uses the template_include() function to include the file. |
| 2243 | 2243 | * @param string $template_name The name of the template to load |
| 2244 | - * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2244 | + * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2245 | 2245 | * @param bool $fatal If true, dies with an error message if the template cannot be found |
| 2246 | - * @return boolean Whether or not the template was loaded |
|
| 2246 | + * @return boolean|null Whether or not the template was loaded |
|
| 2247 | 2247 | */ |
| 2248 | 2248 | function loadTemplate($template_name, $style_sheets = array(), $fatal = true) |
| 2249 | 2249 | { |
@@ -2426,7 +2426,7 @@ discard block |
||
| 2426 | 2426 | * - all code added with this function is added to the same <style> tag so do make sure your css is valid! |
| 2427 | 2427 | * |
| 2428 | 2428 | * @param string $css Some css code |
| 2429 | - * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2429 | + * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2430 | 2430 | */ |
| 2431 | 2431 | function addInlineCss($css) |
| 2432 | 2432 | { |
@@ -2442,7 +2442,7 @@ discard block |
||
| 2442 | 2442 | /** |
| 2443 | 2443 | * Add a Javascript file for output later |
| 2444 | 2444 | |
| 2445 | - * @param string $filename The name of the file to load |
|
| 2445 | + * @param string $fileName The name of the file to load |
|
| 2446 | 2446 | * @param array $params An array of parameter info |
| 2447 | 2447 | * Keys are the following: |
| 2448 | 2448 | * - ['external'] (true/false): define if the file is a externally located file. Needs to be set to true if you are loading an external file |
@@ -2540,7 +2540,7 @@ discard block |
||
| 2540 | 2540 | * |
| 2541 | 2541 | * @param string $javascript Some JS code |
| 2542 | 2542 | * @param bool $defer Whether the script should load in <head> or before the closing <html> tag |
| 2543 | - * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2543 | + * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2544 | 2544 | */ |
| 2545 | 2545 | function addInlineJavaScript($javascript, $defer = false) |
| 2546 | 2546 | { |
@@ -929,7 +929,7 @@ discard block |
||
| 929 | 929 | * Doesn't clean the inputs |
| 930 | 930 | * |
| 931 | 931 | * @param array $items_ids The items to remove |
| 932 | - * @param bool|int $group_id The ID of the group these triggers are associated with or false if deleting them from all groups |
|
| 932 | + * @param integer $group_id The ID of the group these triggers are associated with or false if deleting them from all groups |
|
| 933 | 933 | * @return bool Always returns true |
| 934 | 934 | */ |
| 935 | 935 | function removeBanTriggers($items_ids = array(), $group_id = false) |
@@ -1123,7 +1123,7 @@ discard block |
||
| 1123 | 1123 | * Errors in $context['ban_errors'] |
| 1124 | 1124 | * |
| 1125 | 1125 | * @param array $triggers The triggers to validate |
| 1126 | - * @return array An array of riggers and log info ready to be used |
|
| 1126 | + * @return integer An array of riggers and log info ready to be used |
|
| 1127 | 1127 | */ |
| 1128 | 1128 | function validateTriggers(&$triggers) |
| 1129 | 1129 | { |
@@ -1452,7 +1452,7 @@ |
||
| 1452 | 1452 | * |
| 1453 | 1453 | * @param int $id_subscribe The subscription ID |
| 1454 | 1454 | * @param int $id_member The ID of the member |
| 1455 | - * @param int|string $renewal 0 if we're forcing start/end time, otherwise a string indicating how long to renew the subscription for ('D', 'W', 'M' or 'Y') |
|
| 1455 | + * @param integer $renewal 0 if we're forcing start/end time, otherwise a string indicating how long to renew the subscription for ('D', 'W', 'M' or 'Y') |
|
| 1456 | 1456 | * @param int $forceStartTime If set, forces the subscription to start at the specified time |
| 1457 | 1457 | * @param int $forceEndTime If set, forces the subscription to end at the specified time |
| 1458 | 1458 | */ |
@@ -4070,7 +4070,7 @@ |
||
| 4070 | 4070 | * |
| 4071 | 4071 | * @param int $pmID The ID of the PM |
| 4072 | 4072 | * @param string $validFor Which folders this is valud for - can be 'inbox', 'outbox' or 'in_or_outbox' |
| 4073 | - * @return boolean Whether the PM is accessible in that folder for the current user |
|
| 4073 | + * @return boolean|null Whether the PM is accessible in that folder for the current user |
|
| 4074 | 4074 | */ |
| 4075 | 4075 | function isAccessiblePM($pmID, $validFor = 'in_or_outbox') |
| 4076 | 4076 | { |
@@ -2183,7 +2183,7 @@ discard block |
||
| 2183 | 2183 | * Deletes a single or a group of alerts by ID |
| 2184 | 2184 | * |
| 2185 | 2185 | * @param int|array The ID of a single alert to delete or an array containing the IDs of multiple alerts. The function will convert integers into an array for better handling. |
| 2186 | - * @param bool|int $memID The user ID. Used to update the user unread alerts count. |
|
| 2186 | + * @param integer $memID The user ID. Used to update the user unread alerts count. |
|
| 2187 | 2187 | * @return void|int If the $memID param is set, returns the new amount of unread alerts. |
| 2188 | 2188 | */ |
| 2189 | 2189 | function alert_delete($toDelete, $memID = false) |
@@ -2839,7 +2839,7 @@ discard block |
||
| 2839 | 2839 | /** |
| 2840 | 2840 | * Handles the "manage groups" section of the profile |
| 2841 | 2841 | * |
| 2842 | - * @return true Always returns true |
|
| 2842 | + * @return boolean Always returns true |
|
| 2843 | 2843 | */ |
| 2844 | 2844 | function profileLoadGroups() |
| 2845 | 2845 | { |
@@ -2896,7 +2896,7 @@ discard block |
||
| 2896 | 2896 | /** |
| 2897 | 2897 | * Load key signature context data. |
| 2898 | 2898 | * |
| 2899 | - * @return true Always returns true |
|
| 2899 | + * @return boolean Always returns true |
|
| 2900 | 2900 | */ |
| 2901 | 2901 | function profileLoadSignatureData() |
| 2902 | 2902 | { |
@@ -2960,7 +2960,7 @@ discard block |
||
| 2960 | 2960 | /** |
| 2961 | 2961 | * Load avatar context data. |
| 2962 | 2962 | * |
| 2963 | - * @return true Always returns true |
|
| 2963 | + * @return boolean Always returns true |
|
| 2964 | 2964 | */ |
| 2965 | 2965 | function profileLoadAvatarData() |
| 2966 | 2966 | { |
@@ -3033,7 +3033,7 @@ discard block |
||
| 3033 | 3033 | * Save a members group. |
| 3034 | 3034 | * |
| 3035 | 3035 | * @param int &$value The ID of the (new) primary group |
| 3036 | - * @return true Always returns true |
|
| 3036 | + * @return boolean Always returns true |
|
| 3037 | 3037 | */ |
| 3038 | 3038 | function profileSaveGroups(&$value) |
| 3039 | 3039 | { |
@@ -3138,7 +3138,7 @@ discard block |
||
| 3138 | 3138 | * @todo argh, the avatar here. Take this out of here! |
| 3139 | 3139 | * |
| 3140 | 3140 | * @param string &$value What kind of avatar we're expecting. Can be 'none', 'server_stored', 'gravatar', 'external' or 'upload' |
| 3141 | - * @return bool|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred |
|
| 3141 | + * @return false|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred |
|
| 3142 | 3142 | */ |
| 3143 | 3143 | function profileSaveAvatarData(&$value) |
| 3144 | 3144 | { |
@@ -2605,7 +2605,7 @@ |
||
| 2605 | 2605 | * @param int $start Which item to start with (for pagination purposes) |
| 2606 | 2606 | * @param int $items_per_page How many items to show on each page |
| 2607 | 2607 | * @param string $sort A string indicating how to sort the results |
| 2608 | - * @param int $memID The ID of the member |
|
| 2608 | + * @param string $memID The ID of the member |
|
| 2609 | 2609 | * @return array An array of information about the user's group requests |
| 2610 | 2610 | */ |
| 2611 | 2611 | function list_getGroupRequests($start, $items_per_page, $sort, $memID) |
@@ -325,7 +325,7 @@ |
||
| 325 | 325 | * Validates a IPv6 address. returns true if it is ipv6. |
| 326 | 326 | * |
| 327 | 327 | * @param string $ip The ip address to be validated |
| 328 | - * @return boolean Whether the specified IP is a valid IPv6 address |
|
| 328 | + * @return false|string Whether the specified IP is a valid IPv6 address |
|
| 329 | 329 | */ |
| 330 | 330 | function isValidIPv6($ip) |
| 331 | 331 | { |
@@ -1491,7 +1491,7 @@ |
||
| 1491 | 1491 | |
| 1492 | 1492 | /** |
| 1493 | 1493 | * Try to determine if the topic has already been deleted by another user. |
| 1494 | - * @return bool False if it can't be deleted (recycling not enabled or no recycling board set), true if we've confirmed it can be deleted. Dies with an error if it's already been deleted. |
|
| 1494 | + * @return boolean|null False if it can't be deleted (recycling not enabled or no recycling board set), true if we've confirmed it can be deleted. Dies with an error if it's already been deleted. |
|
| 1495 | 1495 | */ |
| 1496 | 1496 | function removeDeleteConcurrence() |
| 1497 | 1497 | { |
