@@ -43,7 +43,7 @@ |
||
43 | 43 | * Create a video chat |
44 | 44 | * @param int $fromUser The sender user |
45 | 45 | * @param int $toUser The receiver user |
46 | - * @return int The created video chat id. Otherwise return false |
|
46 | + * @return false|string The created video chat id. Otherwise return false |
|
47 | 47 | */ |
48 | 48 | public static function createRoom($fromUser, $toUser) |
49 | 49 | { |
@@ -500,7 +500,7 @@ discard block |
||
500 | 500 | * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if |
501 | 501 | * there is none. |
502 | 502 | * |
503 | - * @return mixed |
|
503 | + * @return integer |
|
504 | 504 | */ |
505 | 505 | function getRequestMode() |
506 | 506 | { |
@@ -1018,6 +1018,7 @@ discard block |
||
1018 | 1018 | * |
1019 | 1019 | * @param string the root tag of the XML |
1020 | 1020 | * @param string XML to convert |
1021 | + * @param string $rootTag |
|
1021 | 1022 | * @access private |
1022 | 1023 | * @return array |
1023 | 1024 | */ |
@@ -39,6 +39,7 @@ |
||
39 | 39 | * (used internally) |
40 | 40 | * |
41 | 41 | * @param string contains the Javascript code to compress |
42 | + * @param string $sJS |
|
42 | 43 | */ |
43 | 44 | function xajaxCompressJavascript($sJS) |
44 | 45 | { |
@@ -97,6 +97,7 @@ discard block |
||
97 | 97 | * @param string contains the character encoding string to use |
98 | 98 | * @param boolean lets you set if you want special characters in the output |
99 | 99 | * converted to HTML entities |
100 | + * @param string $sEncoding |
|
100 | 101 | * |
101 | 102 | */ |
102 | 103 | function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false) |
@@ -223,6 +224,8 @@ discard block |
||
223 | 224 | * @param string contains the id of an HTML element |
224 | 225 | * @param string the part of the element you wish to clear ("innerHTML", |
225 | 226 | * "value", etc.) |
227 | + * @param string $sTarget |
|
228 | + * @param string $sAttribute |
|
226 | 229 | */ |
227 | 230 | function addClear($sTarget,$sAttribute) |
228 | 231 | { |
@@ -279,6 +282,7 @@ discard block |
||
279 | 282 | * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd> |
280 | 283 | * |
281 | 284 | * @param string contains Javascript code to be executed |
285 | + * @param string $sJS |
|
282 | 286 | */ |
283 | 287 | function addScript($sJS) |
284 | 288 | { |
@@ -290,8 +294,6 @@ discard block |
||
290 | 294 | * |
291 | 295 | * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd> |
292 | 296 | * |
293 | - * @param string $sFunc the name of a Javascript function |
|
294 | - * @param mixed $args,... optional arguments to pass to the Javascript function |
|
295 | 297 | */ |
296 | 298 | function addScriptCall() { |
297 | 299 | $arguments = func_get_args(); |
@@ -121,6 +121,9 @@ |
||
121 | 121 | return $form->isSubmitted() == false || $form->validate(); |
122 | 122 | } |
123 | 123 | |
124 | + /** |
|
125 | + * @param string $format |
|
126 | + */ |
|
124 | 127 | function get_ceiling($format = null) |
125 | 128 | { |
126 | 129 | $result = Request::get('ceiling'); |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | * This function return the value of a php.ini setting if not "" or if exists, |
98 | 98 | * otherwise return false |
99 | 99 | * @param string $phpSetting The name of a PHP setting |
100 | - * @return mixed The value of the setting, or false if not found |
|
100 | + * @return string|false The value of the setting, or false if not found |
|
101 | 101 | */ |
102 | 102 | function checkPhpSettingExists($phpSetting) |
103 | 103 | { |
@@ -1268,6 +1268,10 @@ discard block |
||
1268 | 1268 | * @param string Extra notice (to show on the right side) |
1269 | 1269 | * @param boolean Whether to display in update mode |
1270 | 1270 | * @param string Additional attribute for the <tr> element |
1271 | + * @param string $installType |
|
1272 | + * @param string $parameterName |
|
1273 | + * @param string $formFieldName |
|
1274 | + * @param string $extra_notice |
|
1271 | 1275 | * @return void Direct output |
1272 | 1276 | */ |
1273 | 1277 | function displayDatabaseParameter( |
@@ -1481,6 +1485,11 @@ discard block |
||
1481 | 1485 | |
1482 | 1486 | <?php |
1483 | 1487 | } |
1488 | +/** |
|
1489 | + * @param string $content |
|
1490 | + * @param string $title |
|
1491 | + * @param string $id |
|
1492 | + */ |
|
1484 | 1493 | function panel($content = null, $title = null, $id = null, $style = null) { |
1485 | 1494 | $html = ''; |
1486 | 1495 | if (empty($style)) { |
@@ -1837,8 +1846,8 @@ discard block |
||
1837 | 1846 | } |
1838 | 1847 | |
1839 | 1848 | /** |
1840 | - * @param $current_value |
|
1841 | - * @param $wanted_value |
|
1849 | + * @param string $current_value |
|
1850 | + * @param string $wanted_value |
|
1842 | 1851 | * @return string |
1843 | 1852 | */ |
1844 | 1853 | function compare_setting_values($current_value, $wanted_value) |
@@ -1855,8 +1864,8 @@ discard block |
||
1855 | 1864 | } |
1856 | 1865 | |
1857 | 1866 | /** |
1858 | - * @param $course_dir |
|
1859 | - * @param $course_attempt_name |
|
1867 | + * @param string $course_dir |
|
1868 | + * @param string $course_attempt_name |
|
1860 | 1869 | * @param string $file |
1861 | 1870 | * @return bool |
1862 | 1871 | */ |
@@ -216,7 +216,7 @@ discard block |
||
216 | 216 | /** |
217 | 217 | * Import the aicc object (as a result from the parse_config_files function) into the database structure |
218 | 218 | * @param string $course_code |
219 | - * @return bool Returns -1 on error |
|
219 | + * @return false|null Returns -1 on error |
|
220 | 220 | */ |
221 | 221 | public function import_aicc($course_code) |
222 | 222 | { |
@@ -780,7 +780,8 @@ discard block |
||
780 | 780 | * Static function to parse AICC ini files. |
781 | 781 | * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()). |
782 | 782 | * @param string File path |
783 | - * @return array Structured array |
|
783 | + * @param string $f |
|
784 | + * @return string Structured array |
|
784 | 785 | */ |
785 | 786 | function parse_ini_file_quotes_safe($f) { |
786 | 787 | $null = ''; |
@@ -831,7 +832,7 @@ discard block |
||
831 | 832 | * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()). |
832 | 833 | * @param string INI File string |
833 | 834 | * @param array List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case |
834 | - * @return array Structured array |
|
835 | + * @return string Structured array |
|
835 | 836 | */ |
836 | 837 | function parse_ini_string_quotes_safe($s, $pure_strings = array()) { |
837 | 838 | $null = ''; |
@@ -894,6 +895,7 @@ discard block |
||
894 | 895 | * @param string CSV delimiter |
895 | 896 | * @param string CSV enclosure |
896 | 897 | * @param boolean Might one field name happen more than once on the same line? (then split by comma in the values) |
898 | + * @param string $f |
|
897 | 899 | * @return array Simple structured array |
898 | 900 | */ |
899 | 901 | function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) { |
@@ -60,6 +60,7 @@ |
||
60 | 60 | /** |
61 | 61 | * This function deletes an entire directory |
62 | 62 | * @param string The directory path |
63 | + * @param string $dir |
|
63 | 64 | * @return boolean True on success, false on failure |
64 | 65 | */ |
65 | 66 | function deldir($dir) { |
@@ -34,7 +34,7 @@ |
||
34 | 34 | * @param int $categoryId |
35 | 35 | * @param bool $ignoreCategoryFilter |
36 | 36 | * |
37 | - * @return void |
|
37 | + * @return false|null |
|
38 | 38 | */ |
39 | 39 | public function __construct( |
40 | 40 | $user_id, |