@@ -473,7 +473,7 @@ |
||
| 473 | 473 | * Used by fatal_error(), fatal_lang_error() |
| 474 | 474 | * |
| 475 | 475 | * @param string $error The error |
| 476 | - * @param array $sprintf An array of data to be sprintf()'d into the specified message |
|
| 476 | + * @param boolean $sprintf An array of data to be sprintf()'d into the specified message |
|
| 477 | 477 | */ |
| 478 | 478 | function log_error_online($error, $sprintf = array()) |
| 479 | 479 | { |
@@ -4102,7 +4102,7 @@ |
||
| 4102 | 4102 | * |
| 4103 | 4103 | * @param int $pmID The ID of the PM |
| 4104 | 4104 | * @param string $validFor Which folders this is valud for - can be 'inbox', 'outbox' or 'in_or_outbox' |
| 4105 | - * @return boolean Whether the PM is accessible in that folder for the current user |
|
| 4105 | + * @return boolean|null Whether the PM is accessible in that folder for the current user |
|
| 4106 | 4106 | */ |
| 4107 | 4107 | function isAccessiblePM($pmID, $validFor = 'in_or_outbox') |
| 4108 | 4108 | { |
@@ -2181,7 +2181,7 @@ discard block |
||
| 2181 | 2181 | * Deletes a single or a group of alerts by ID |
| 2182 | 2182 | * |
| 2183 | 2183 | * @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. |
| 2184 | - * @param bool|int $memID The user ID. Used to update the user unread alerts count. |
|
| 2184 | + * @param integer $memID The user ID. Used to update the user unread alerts count. |
|
| 2185 | 2185 | * @return void|int If the $memID param is set, returns the new amount of unread alerts. |
| 2186 | 2186 | */ |
| 2187 | 2187 | function alert_delete($toDelete, $memID = false) |
@@ -2836,7 +2836,7 @@ discard block |
||
| 2836 | 2836 | /** |
| 2837 | 2837 | * Handles the "manage groups" section of the profile |
| 2838 | 2838 | * |
| 2839 | - * @return true Always returns true |
|
| 2839 | + * @return boolean Always returns true |
|
| 2840 | 2840 | */ |
| 2841 | 2841 | function profileLoadGroups() |
| 2842 | 2842 | { |
@@ -2893,7 +2893,7 @@ discard block |
||
| 2893 | 2893 | /** |
| 2894 | 2894 | * Load key signature context data. |
| 2895 | 2895 | * |
| 2896 | - * @return true Always returns true |
|
| 2896 | + * @return boolean Always returns true |
|
| 2897 | 2897 | */ |
| 2898 | 2898 | function profileLoadSignatureData() |
| 2899 | 2899 | { |
@@ -2957,7 +2957,7 @@ discard block |
||
| 2957 | 2957 | /** |
| 2958 | 2958 | * Load avatar context data. |
| 2959 | 2959 | * |
| 2960 | - * @return true Always returns true |
|
| 2960 | + * @return boolean Always returns true |
|
| 2961 | 2961 | */ |
| 2962 | 2962 | function profileLoadAvatarData() |
| 2963 | 2963 | { |
@@ -3030,7 +3030,7 @@ discard block |
||
| 3030 | 3030 | * Save a members group. |
| 3031 | 3031 | * |
| 3032 | 3032 | * @param int &$value The ID of the (new) primary group |
| 3033 | - * @return true Always returns true |
|
| 3033 | + * @return boolean Always returns true |
|
| 3034 | 3034 | */ |
| 3035 | 3035 | function profileSaveGroups(&$value) |
| 3036 | 3036 | { |
@@ -3132,7 +3132,7 @@ discard block |
||
| 3132 | 3132 | * @todo argh, the avatar here. Take this out of here! |
| 3133 | 3133 | * |
| 3134 | 3134 | * @param string &$value What kind of avatar we're expecting. Can be 'none', 'server_stored', 'gravatar', 'external' or 'upload' |
| 3135 | - * @return bool|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred |
|
| 3135 | + * @return false|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred |
|
| 3136 | 3136 | */ |
| 3137 | 3137 | function profileSaveAvatarData(&$value) |
| 3138 | 3138 | { |
@@ -18,7 +18,7 @@ |
||
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | 20 | * Get a list of versions that are currently installed on the server. |
| 21 | - * @param array $checkFor An array of what to check versions for - can contain one or more of 'gd', 'imagemagick', 'db_server', 'phpa', 'memcache', 'xcache', 'apc', 'php' or 'server' |
|
| 21 | + * @param string[] $checkFor An array of what to check versions for - can contain one or more of 'gd', 'imagemagick', 'db_server', 'phpa', 'memcache', 'xcache', 'apc', 'php' or 'server' |
|
| 22 | 22 | * @return array An array of versions (keys are same as what was in $checkFor, values are the versions) |
| 23 | 23 | */ |
| 24 | 24 | function getServerVersions($checkFor) |
@@ -1684,7 +1684,7 @@ discard block |
||
| 1684 | 1684 | /** |
| 1685 | 1685 | * Show today's birthdays. |
| 1686 | 1686 | * @param string $output_method The output method. If 'echo', displays a list of users, otherwise returns an array of info about them. |
| 1687 | - * @return void|array Displays a list of users or returns an array of info about them depending on output_method. |
|
| 1687 | + * @return null|string Displays a list of users or returns an array of info about them depending on output_method. |
|
| 1688 | 1688 | */ |
| 1689 | 1689 | function ssi_todaysBirthdays($output_method = 'echo') |
| 1690 | 1690 | { |
@@ -1710,7 +1710,7 @@ discard block |
||
| 1710 | 1710 | /** |
| 1711 | 1711 | * Shows today's holidays. |
| 1712 | 1712 | * @param string $output_method The output method. If 'echo', displays a list of holidays, otherwise returns an array of info about them. |
| 1713 | - * @return void|array Displays a list of holidays or returns an array of info about them depending on output_method |
|
| 1713 | + * @return null|string Displays a list of holidays or returns an array of info about them depending on output_method |
|
| 1714 | 1714 | */ |
| 1715 | 1715 | function ssi_todaysHolidays($output_method = 'echo') |
| 1716 | 1716 | { |
@@ -1734,7 +1734,7 @@ discard block |
||
| 1734 | 1734 | |
| 1735 | 1735 | /** |
| 1736 | 1736 | * @param string $output_method The output method. If 'echo', displays a list of events, otherwise returns an array of info about them. |
| 1737 | - * @return void|array Displays a list of events or returns an array of info about them depending on output_method |
|
| 1737 | + * @return null|string Displays a list of events or returns an array of info about them depending on output_method |
|
| 1738 | 1738 | */ |
| 1739 | 1739 | function ssi_todaysEvents($output_method = 'echo') |
| 1740 | 1740 | { |
@@ -1765,7 +1765,7 @@ discard block |
||
| 1765 | 1765 | /** |
| 1766 | 1766 | * Shows today's calendar items (events, birthdays and holidays) |
| 1767 | 1767 | * @param string $output_method The output method. If 'echo', displays a list of calendar items, otherwise returns an array of info about them. |
| 1768 | - * @return void|array Displays a list of calendar items or returns an array of info about them depending on output_method |
|
| 1768 | + * @return null|string Displays a list of calendar items or returns an array of info about them depending on output_method |
|
| 1769 | 1769 | */ |
| 1770 | 1770 | function ssi_todaysCalendar($output_method = 'echo') |
| 1771 | 1771 | { |
@@ -2147,7 +2147,7 @@ discard block |
||
| 2147 | 2147 | * @param int|string $id The ID or username of a user |
| 2148 | 2148 | * @param string $password The password to check |
| 2149 | 2149 | * @param bool $is_username If true, treats $id as a username rather than a user ID |
| 2150 | - * @return bool Whether or not the password is correct. |
|
| 2150 | + * @return null|boolean Whether or not the password is correct. |
|
| 2151 | 2151 | */ |
| 2152 | 2152 | function ssi_checkPassword($id = null, $password = null, $is_username = false) |
| 2153 | 2153 | { |
@@ -227,7 +227,7 @@ |
||
| 227 | 227 | * @param int|string $verify_id The verification control ID |
| 228 | 228 | * @param string $display_type What type to display. Can be 'single' to only show one verification option or 'all' to show all of them |
| 229 | 229 | * @param bool $reset Whether to reset the internal tracking counter |
| 230 | - * @return bool False if there's nothing else to show, true if $display_type is 'single', nothing otherwise |
|
| 230 | + * @return boolean|null False if there's nothing else to show, true if $display_type is 'single', nothing otherwise |
|
| 231 | 231 | */ |
| 232 | 232 | function template_control_verification($verify_id, $display_type = 'all', $reset = false) |
| 233 | 233 | { |
@@ -1101,7 +1101,7 @@ |
||
| 1101 | 1101 | /** |
| 1102 | 1102 | * CHMOD control form |
| 1103 | 1103 | * |
| 1104 | - * @return bool False if nothing to do. |
|
| 1104 | + * @return false|null False if nothing to do. |
|
| 1105 | 1105 | */ |
| 1106 | 1106 | function template_control_chmod() |
| 1107 | 1107 | { |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | * Display a list of upcoming events, birthdays, and holidays. |
| 69 | 69 | * |
| 70 | 70 | * @param string $grid_name The grid name |
| 71 | - * @return void|bool Returns false if the grid doesn't exist. |
|
| 71 | + * @return false|null Returns false if the grid doesn't exist. |
|
| 72 | 72 | */ |
| 73 | 73 | function template_show_upcoming_list($grid_name) |
| 74 | 74 | { |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | * |
| 239 | 239 | * @param string $grid_name The grid name |
| 240 | 240 | * @param bool $is_mini Is this a mini grid? |
| 241 | - * @return void|bool Returns false if the grid doesn't exist. |
|
| 241 | + * @return false|null Returns false if the grid doesn't exist. |
|
| 242 | 242 | */ |
| 243 | 243 | function template_show_month_grid($grid_name, $is_mini = false) |
| 244 | 244 | { |
@@ -523,7 +523,7 @@ discard block |
||
| 523 | 523 | * Shows a weekly grid |
| 524 | 524 | * |
| 525 | 525 | * @param string $grid_name The name of the grid |
| 526 | - * @return void|bool Returns false if the grid doesn't exist |
|
| 526 | + * @return false|null Returns false if the grid doesn't exist |
|
| 527 | 527 | */ |
| 528 | 528 | function template_show_week_grid($grid_name) |
| 529 | 529 | { |
@@ -2259,9 +2259,9 @@ discard block |
||
| 2259 | 2259 | * |
| 2260 | 2260 | * @uses the template_include() function to include the file. |
| 2261 | 2261 | * @param string $template_name The name of the template to load |
| 2262 | - * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2262 | + * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2263 | 2263 | * @param bool $fatal If true, dies with an error message if the template cannot be found |
| 2264 | - * @return boolean Whether or not the template was loaded |
|
| 2264 | + * @return boolean|null Whether or not the template was loaded |
|
| 2265 | 2265 | */ |
| 2266 | 2266 | function loadTemplate($template_name, $style_sheets = array(), $fatal = true) |
| 2267 | 2267 | { |
@@ -2444,7 +2444,7 @@ discard block |
||
| 2444 | 2444 | * - all code added with this function is added to the same <style> tag so do make sure your css is valid! |
| 2445 | 2445 | * |
| 2446 | 2446 | * @param string $css Some css code |
| 2447 | - * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2447 | + * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2448 | 2448 | */ |
| 2449 | 2449 | function addInlineCss($css) |
| 2450 | 2450 | { |
@@ -2558,7 +2558,7 @@ discard block |
||
| 2558 | 2558 | * |
| 2559 | 2559 | * @param string $javascript Some JS code |
| 2560 | 2560 | * @param bool $defer Whether the script should load in <head> or before the closing <html> tag |
| 2561 | - * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2561 | + * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2562 | 2562 | */ |
| 2563 | 2563 | function addInlineJavaScript($javascript, $defer = false) |
| 2564 | 2564 | { |
@@ -2791,7 +2791,7 @@ discard block |
||
| 2791 | 2791 | * It will try to choose only utf8 or non-utf8 languages. |
| 2792 | 2792 | * |
| 2793 | 2793 | * @param bool $use_cache Whether or not to use the cache |
| 2794 | - * @return array An array of information about available languages |
|
| 2794 | + * @return string An array of information about available languages |
|
| 2795 | 2795 | */ |
| 2796 | 2796 | function getLanguages($use_cache = true) |
| 2797 | 2797 | { |