SimpleMachines /
SMF2.1
@@ -2262,9 +2262,9 @@ discard block |
||
| 2262 | 2262 | * |
| 2263 | 2263 | * @uses the template_include() function to include the file. |
| 2264 | 2264 | * @param string $template_name The name of the template to load |
| 2265 | - * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2265 | + * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2266 | 2266 | * @param bool $fatal If true, dies with an error message if the template cannot be found |
| 2267 | - * @return boolean Whether or not the template was loaded |
|
| 2267 | + * @return boolean|null Whether or not the template was loaded |
|
| 2268 | 2268 | */ |
| 2269 | 2269 | function loadTemplate($template_name, $style_sheets = array(), $fatal = true) |
| 2270 | 2270 | { |
@@ -2447,7 +2447,7 @@ discard block |
||
| 2447 | 2447 | * - all code added with this function is added to the same <style> tag so do make sure your css is valid! |
| 2448 | 2448 | * |
| 2449 | 2449 | * @param string $css Some css code |
| 2450 | - * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2450 | + * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2451 | 2451 | */ |
| 2452 | 2452 | function addInlineCss($css) |
| 2453 | 2453 | { |
@@ -2463,7 +2463,7 @@ discard block |
||
| 2463 | 2463 | /** |
| 2464 | 2464 | * Add a Javascript file for output later |
| 2465 | 2465 | * |
| 2466 | - * @param string $filename The name of the file to load |
|
| 2466 | + * @param string $fileName The name of the file to load |
|
| 2467 | 2467 | * @param array $params An array of parameter info |
| 2468 | 2468 | * Keys are the following: |
| 2469 | 2469 | * - ['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 |
@@ -2561,7 +2561,7 @@ discard block |
||
| 2561 | 2561 | * |
| 2562 | 2562 | * @param string $javascript Some JS code |
| 2563 | 2563 | * @param bool $defer Whether the script should load in <head> or before the closing <html> tag |
| 2564 | - * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2564 | + * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2565 | 2565 | */ |
| 2566 | 2566 | function addInlineJavaScript($javascript, $defer = false) |
| 2567 | 2567 | { |
@@ -28,7 +28,7 @@ discard block |
||
| 28 | 28 | * @param bool $single_file If true returns the contents of the file specified by destination if it exists |
| 29 | 29 | * @param bool $overwrite Whether to overwrite existing files |
| 30 | 30 | * @param null|array $files_to_extract Specific files to extract |
| 31 | - * @return array|false An array of information about extracted files or false on failure |
|
| 31 | + * @return string An array of information about extracted files or false on failure |
|
| 32 | 32 | */ |
| 33 | 33 | function read_tgz_file($gzfilename, $destination, $single_file = false, $overwrite = false, $files_to_extract = null) |
| 34 | 34 | { |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | * @param bool $single_file Whether to only extract a single file |
| 60 | 60 | * @param bool $overwrite Whether to overwrite existing data |
| 61 | 61 | * @param null|array $files_to_extract If set, only extracts the specified files |
| 62 | - * @return array|false An array of information about the extracted files or false on failure |
|
| 62 | + * @return string An array of information about the extracted files or false on failure |
|
| 63 | 63 | */ |
| 64 | 64 | function read_tgz_data($gzfilename, $destination, $single_file = false, $overwrite = false, $files_to_extract = null) |
| 65 | 65 | { |
@@ -3255,7 +3255,7 @@ discard block |
||
| 3255 | 3255 | * https://php.net/crc32#79567 |
| 3256 | 3256 | * |
| 3257 | 3257 | * @param string $number |
| 3258 | - * @return string The crc32 |
|
| 3258 | + * @return integer The crc32 |
|
| 3259 | 3259 | */ |
| 3260 | 3260 | function smf_crc32($number) |
| 3261 | 3261 | { |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | * |
| 174 | 174 | * @param string $post_errors A string of info about errors encountered trying to save this draft |
| 175 | 175 | * @param array $recipientList An array of data about who this PM is being sent to |
| 176 | - * @return boolean false if you can't save the draft, true if we're doing this via XML more than 5 seconds after the last save, nothing otherwise |
|
| 176 | + * @return boolean|null false if you can't save the draft, true if we're doing this via XML more than 5 seconds after the last save, nothing otherwise |
|
| 177 | 177 | */ |
| 178 | 178 | function SavePMDraft(&$post_errors, $recipientList) |
| 179 | 179 | { |
@@ -388,7 +388,7 @@ discard block |
||
| 388 | 388 | * |
| 389 | 389 | * @param int $id_draft The ID of the draft to delete |
| 390 | 390 | * @param boolean $check Whether or not to check that the draft belongs to the current user |
| 391 | - * @return boolean False if it couldn't be deleted (doesn't return anything otherwise) |
|
| 391 | + * @return false|null False if it couldn't be deleted (doesn't return anything otherwise) |
|
| 392 | 392 | */ |
| 393 | 393 | function DeleteDraft($id_draft, $check = true) |
| 394 | 394 | { |
@@ -422,7 +422,7 @@ discard block |
||
| 422 | 422 | * @param int $member_id ID of the member to show drafts for |
| 423 | 423 | * @param boolean|integer If $type is 1, this can be set to only load drafts for posts in the specific topic |
| 424 | 424 | * @param int $draft_type The type of drafts to show - 0 for post drafts, 1 for PM drafts |
| 425 | - * @return boolean False if the drafts couldn't be loaded, nothing otherwise |
|
| 425 | + * @return false|null False if the drafts couldn't be loaded, nothing otherwise |
|
| 426 | 426 | */ |
| 427 | 427 | function ShowDrafts($member_id, $topic = false, $draft_type = 0) |
| 428 | 428 | { |
@@ -676,7 +676,7 @@ discard block |
||
| 676 | 676 | * - caches the formatting data from the setting for optimization. |
| 677 | 677 | * |
| 678 | 678 | * @param float $number A number |
| 679 | - * @param bool|int $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined |
|
| 679 | + * @param integer $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined |
|
| 680 | 680 | * @return string A formatted number |
| 681 | 681 | */ |
| 682 | 682 | function comma_format($number, $override_decimal_count = false) |
@@ -5530,7 +5530,7 @@ discard block |
||
| 5530 | 5530 | * It assumes the data is already a string. |
| 5531 | 5531 | * @param string $data The data to print |
| 5532 | 5532 | * @param string $type The content type. Defaults to Json. |
| 5533 | - * @return void |
|
| 5533 | + * @return false|null |
|
| 5534 | 5534 | */ |
| 5535 | 5535 | function smf_serverResponse($data = '', $type = 'Content-Type: application/json') |
| 5536 | 5536 | { |
