@@ -191,7 +191,7 @@ discard block |
||
191 | 191 | * @param string $prompt text prompt, should include possible options |
192 | 192 | * @param string $default default value when enter pressed |
193 | 193 | * @param array $options list of allowed options, empty means any text |
194 | - * @param bool $casesensitive true if options are case sensitive |
|
194 | + * @param bool $casesensitiveoptions true if options are case sensitive |
|
195 | 195 | * @return string entered text |
196 | 196 | */ |
197 | 197 | function cli_input($prompt, $default='', array $options=null, $casesensitiveoptions=false) { |
@@ -288,7 +288,7 @@ discard block |
||
288 | 288 | /** |
289 | 289 | * Print or return section separator string |
290 | 290 | * @param bool $return false means print, true return as string |
291 | - * @return mixed void or string |
|
291 | + * @return string|null void or string |
|
292 | 292 | */ |
293 | 293 | function cli_separator($return=false) { |
294 | 294 | $separator = str_repeat('-', 79)."\n"; |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | * |
94 | 94 | * @param string $rank |
95 | 95 | * |
96 | - * @return Question |
|
96 | + * @return Category |
|
97 | 97 | */ |
98 | 98 | public function setRank($rank) |
99 | 99 | { |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | /** |
202 | 202 | * Get questions |
203 | 203 | * |
204 | - * @return \Doctrine\Common\Collections\Collection |
|
204 | + * @return Question[] |
|
205 | 205 | */ |
206 | 206 | public function getQuestions() |
207 | 207 | { |
@@ -19,7 +19,7 @@ |
||
19 | 19 | * @Route("/contact") |
20 | 20 | * |
21 | 21 | * @param Request $request |
22 | - * @return mixed |
|
22 | + * @return Response |
|
23 | 23 | */ |
24 | 24 | public function indexAction(Request $request) |
25 | 25 | { |
@@ -239,7 +239,7 @@ discard block |
||
239 | 239 | } |
240 | 240 | |
241 | 241 | /** |
242 | - * @param doc_id id of document (id in mainDb.document table) |
|
242 | + * @param doc_id string of document (id in mainDb.document table) |
|
243 | 243 | * @author Sebastien Piraux <[email protected]> |
244 | 244 | * @desc Record information for upload event |
245 | 245 | * used in the works tool to record informations when |
@@ -313,6 +313,9 @@ discard block |
||
313 | 313 | * @param int session_id |
314 | 314 | * @param int learnpath_id (id of the learnpath) |
315 | 315 | * @param int learnpath_item_id (id of the learnpath_item) |
316 | + * @param integer $score |
|
317 | + * @param integer $weighting |
|
318 | + * @param integer $session_id |
|
316 | 319 | * |
317 | 320 | * @author Sebastien Piraux <[email protected]> |
318 | 321 | * @author Julio Montoya Armas <[email protected]> Reworked 2010 |
@@ -414,7 +417,9 @@ discard block |
||
414 | 417 | * @param integer Session ID (from the session table). Default value of null means "get from context". |
415 | 418 | * @param integer Learnpath ID (from c_lp table). Default value of null means "get from context". |
416 | 419 | * @param integer Learnpath item ID (from the c_lp_item table). Default value of null means "get from context". |
417 | - * @return boolean Result of the insert query |
|
420 | + * @param integer $exe_id |
|
421 | + * @param integer $position |
|
422 | + * @return false|string Result of the insert query |
|
418 | 423 | */ |
419 | 424 | public static function saveQuestionAttempt( |
420 | 425 | $score, |
@@ -581,6 +586,7 @@ discard block |
||
581 | 586 | * @param int Whether this answer is correct (1) or not (0) |
582 | 587 | * @param string Coordinates of this point (e.g. 123;324) |
583 | 588 | * @param bool update results? |
589 | + * @param integer $exe_id |
|
584 | 590 | * @return boolean Result of the insert query |
585 | 591 | * @uses Course code and user_id from global scope $_cid and $_user |
586 | 592 | */ |
@@ -720,7 +726,6 @@ discard block |
||
720 | 726 | /** |
721 | 727 | * Get every email stored in the database |
722 | 728 | * |
723 | - * @param int $etId |
|
724 | 729 | * @return type |
725 | 730 | * @assert () !== false |
726 | 731 | */ |
@@ -788,11 +793,11 @@ discard block |
||
788 | 793 | /** |
789 | 794 | * Save the new message for one event and for one language |
790 | 795 | * |
791 | - * @param string $eventName |
|
796 | + * @param string $event_name |
|
792 | 797 | * @param array $users |
793 | 798 | * @param string $message |
794 | 799 | * @param string $subject |
795 | - * @param string $eventMessageLanguage |
|
800 | + * @param string $event_message_language |
|
796 | 801 | * @param int $activated |
797 | 802 | */ |
798 | 803 | public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated) |
@@ -926,10 +931,10 @@ discard block |
||
926 | 931 | } |
927 | 932 | |
928 | 933 | /** |
929 | - * @param $user_id |
|
934 | + * @param integer $user_id |
|
930 | 935 | * @param $exerciseId |
931 | - * @param $lp_id |
|
932 | - * @param $lp_item_id |
|
936 | + * @param integer $lp_id |
|
937 | + * @param integer $lp_item_id |
|
933 | 938 | * @return int |
934 | 939 | */ |
935 | 940 | public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id) |
@@ -1106,6 +1111,7 @@ discard block |
||
1106 | 1111 | * @param int exercise id |
1107 | 1112 | * @param int $courseId |
1108 | 1113 | * @param int session id |
1114 | + * @param integer $user_id |
|
1109 | 1115 | * @return array with the results |
1110 | 1116 | * |
1111 | 1117 | */ |
@@ -1201,6 +1207,7 @@ discard block |
||
1201 | 1207 | * @param int exercise id |
1202 | 1208 | * @param int $courseId |
1203 | 1209 | * @param int session id |
1210 | + * @param integer $user_id |
|
1204 | 1211 | * @return array with the results |
1205 | 1212 | * |
1206 | 1213 | */ |
@@ -1241,6 +1248,7 @@ discard block |
||
1241 | 1248 | * @param int exercise id |
1242 | 1249 | * @param string course code |
1243 | 1250 | * @param int session id |
1251 | + * @param integer $exe_id |
|
1244 | 1252 | * @return array with the results |
1245 | 1253 | * |
1246 | 1254 | */ |
@@ -1290,6 +1298,8 @@ discard block |
||
1290 | 1298 | * @param int lp id |
1291 | 1299 | * @param int lp item id |
1292 | 1300 | * @param string order asc or desc |
1301 | + * @param integer $courseId |
|
1302 | + * @param string $order |
|
1293 | 1303 | * @return array with the results |
1294 | 1304 | * |
1295 | 1305 | */ |
@@ -1349,7 +1359,7 @@ discard block |
||
1349 | 1359 | * @param int exercise id |
1350 | 1360 | * @param int $courseId |
1351 | 1361 | * @param int session id |
1352 | - * @return array with the results |
|
1362 | + * @return string with the results |
|
1353 | 1363 | * |
1354 | 1364 | */ |
1355 | 1365 | public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0) |
@@ -1525,7 +1535,7 @@ discard block |
||
1525 | 1535 | * @param int exercise id |
1526 | 1536 | * @param int course id |
1527 | 1537 | * @param int session id |
1528 | - * @return array with the results |
|
1538 | + * @return integer with the results |
|
1529 | 1539 | * |
1530 | 1540 | */ |
1531 | 1541 | public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0) |
@@ -13,9 +13,9 @@ discard block |
||
13 | 13 | |
14 | 14 | /** |
15 | 15 | * ChamiloForm constructor. |
16 | - * @param $mode |
|
17 | - * @param $returnurl |
|
18 | - * @param $cancelurl |
|
16 | + * @param string $mode |
|
17 | + * @param string $returnurl |
|
18 | + * @param string $cancelurl |
|
19 | 19 | * @param $customdata |
20 | 20 | */ |
21 | 21 | public function __construct($mode, $returnurl, $cancelurl, $customdata = []) |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * Check that form data is valid. |
138 | 138 | * You should almost always use this, rather than {@see validate_defined_fields} |
139 | 139 | * |
140 | - * @return bool true if form data valid |
|
140 | + * @return boolean|null true if form data valid |
|
141 | 141 | */ |
142 | 142 | public function is_validated() |
143 | 143 | { |
@@ -166,7 +166,7 @@ discard block |
||
166 | 166 | * is NOT to validate the form when a no submit button has been pressed. |
167 | 167 | * pass true here to override this behaviour |
168 | 168 | * |
169 | - * @return bool true if form data valid |
|
169 | + * @return boolean|null true if form data valid |
|
170 | 170 | */ |
171 | 171 | public function validate_defined_fields($validateonnosubmit=false) |
172 | 172 | { |
@@ -428,7 +428,7 @@ discard block |
||
428 | 428 | * @param $stok |
429 | 429 | * @param $code |
430 | 430 | * @param $search_term |
431 | - * @return html |
|
431 | + * @return string |
|
432 | 432 | */ |
433 | 433 | function return_register_button($course, $stok, $code, $search_term) |
434 | 434 | { |
@@ -443,7 +443,7 @@ discard block |
||
443 | 443 | * @param $stok |
444 | 444 | * @param $search_term |
445 | 445 | * @param $code |
446 | - * @return html |
|
446 | + * @return string |
|
447 | 447 | */ |
448 | 448 | function return_unregister_button($course, $stok, $search_term, $code) |
449 | 449 | { |
@@ -42,7 +42,7 @@ |
||
42 | 42 | } |
43 | 43 | |
44 | 44 | /** |
45 | - * @return BBBPlugin|null |
|
45 | + * @return BBBPlugin |
|
46 | 46 | */ |
47 | 47 | public static function create() |
48 | 48 | { |
@@ -63,6 +63,9 @@ discard block |
||
63 | 63 | return $image; |
64 | 64 | } |
65 | 65 | |
66 | + /** |
|
67 | + * @param string $convert_file_to |
|
68 | + */ |
|
66 | 69 | public function send_image( |
67 | 70 | $file = '', |
68 | 71 | $compress = -1, |
@@ -144,6 +147,9 @@ discard block |
||
144 | 147 | public $image; |
145 | 148 | public $filter = Imagick::FILTER_LANCZOS; |
146 | 149 | |
150 | + /** |
|
151 | + * @param string $path |
|
152 | + */ |
|
147 | 153 | public function __construct($path) |
148 | 154 | { |
149 | 155 | parent::__construct($path); |
@@ -191,6 +197,10 @@ discard block |
||
191 | 197 | } |
192 | 198 | |
193 | 199 | //@todo implement border logic case for Imagick |
200 | + |
|
201 | + /** |
|
202 | + * @param integer $border |
|
203 | + */ |
|
194 | 204 | public function resize($thumbw, $thumbh, $border, $specific_size = false) |
195 | 205 | { |
196 | 206 | if (!$this->image_validated) return false; |
@@ -272,6 +282,9 @@ discard block |
||
272 | 282 | { |
273 | 283 | public $bg; |
274 | 284 | |
285 | + /** |
|
286 | + * @param string $path |
|
287 | + */ |
|
275 | 288 | function __construct($path) { |
276 | 289 | parent::__construct($path); |
277 | 290 | } |
@@ -329,6 +342,9 @@ discard block |
||
329 | 342 | } |
330 | 343 | } |
331 | 344 | |
345 | + /** |
|
346 | + * @param integer $border |
|
347 | + */ |
|
332 | 348 | public function resize($thumbw, $thumbh, $border, $specific_size = false) |
333 | 349 | { |
334 | 350 | if (!$this->image_validated) return false; |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | * Adds a mandatory requirement in form of a php.ini configuration. |
221 | 221 | * |
222 | 222 | * @param string $cfgName The configuration name used for ini_get() |
223 | - * @param bool|callback $evaluation Either a boolean indicating whether the configuration should evaluate to true or false, |
|
223 | + * @param boolean|string $evaluation Either a boolean indicating whether the configuration should evaluate to true or false, |
|
224 | 224 | * or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement |
225 | 225 | * @param bool $approveCfgAbsence If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false. |
226 | 226 | * This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin. |
@@ -238,7 +238,7 @@ discard block |
||
238 | 238 | * Adds an optional recommendation in form of a php.ini configuration. |
239 | 239 | * |
240 | 240 | * @param string $cfgName The configuration name used for ini_get() |
241 | - * @param bool|callback $evaluation Either a boolean indicating whether the configuration should evaluate to true or false, |
|
241 | + * @param string|false $evaluation Either a boolean indicating whether the configuration should evaluate to true or false, |
|
242 | 242 | * or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement |
243 | 243 | * @param bool $approveCfgAbsence If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false. |
244 | 244 | * This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin. |
@@ -359,7 +359,7 @@ discard block |
||
359 | 359 | /** |
360 | 360 | * Returns the PHP configuration file (php.ini) path. |
361 | 361 | * |
362 | - * @return string|false php.ini file path |
|
362 | + * @return string php.ini file path |
|
363 | 363 | */ |
364 | 364 | public function getPhpIniConfigPath() |
365 | 365 | { |