@@ -954,7 +954,7 @@ |
||
| 954 | 954 | /** |
| 955 | 955 | * This function has been created for avoiding changes directly within QuickForm class. |
| 956 | 956 | * When we use it, the element is threated as 'required' to be dealt during validation. |
| 957 | - * @param array $element The array of elements |
|
| 957 | + * @param array $elements The array of elements |
|
| 958 | 958 | * @param string $message The message displayed |
| 959 | 959 | */ |
| 960 | 960 | public function add_multiple_required_rule($elements, $message) |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | * This function saves a change in a wiki page |
| 259 | 259 | * @author Patrick Cool <[email protected]>, Ghent University |
| 260 | 260 | * @param array $values |
| 261 | - * @return language string saying that the changes are stored |
|
| 261 | + * @return string string saying that the changes are stored |
|
| 262 | 262 | **/ |
| 263 | 263 | public function save_wiki($values) |
| 264 | 264 | { |
@@ -1196,6 +1196,7 @@ discard block |
||
| 1196 | 1196 | * Checks if this navigation tab has to be set to active |
| 1197 | 1197 | * @author Patrick Cool <[email protected]>, Ghent University |
| 1198 | 1198 | * |
| 1199 | + * @param string $paramwk |
|
| 1199 | 1200 | * @return string html code |
| 1200 | 1201 | */ |
| 1201 | 1202 | public function is_active_navigation_tab($paramwk) |
@@ -1711,6 +1712,7 @@ discard block |
||
| 1711 | 1712 | |
| 1712 | 1713 | /** |
| 1713 | 1714 | * Sends pending e-mails |
| 1715 | + * @param string $type |
|
| 1714 | 1716 | */ |
| 1715 | 1717 | public function check_emailcue($id_or_ref, $type, $lastime='', $lastuser='') |
| 1716 | 1718 | { |
@@ -2011,6 +2013,7 @@ discard block |
||
| 2011 | 2013 | |
| 2012 | 2014 | /** |
| 2013 | 2015 | * Exports the wiki page to PDF |
| 2016 | + * @param string $course_code |
|
| 2014 | 2017 | */ |
| 2015 | 2018 | public function export_to_pdf($id, $course_code) |
| 2016 | 2019 | { |
@@ -2478,6 +2481,7 @@ discard block |
||
| 2478 | 2481 | /** |
| 2479 | 2482 | * Draws an HTML form select with the given options |
| 2480 | 2483 | * |
| 2484 | + * @param string $name |
|
| 2481 | 2485 | */ |
| 2482 | 2486 | public function make_select($name,$values,$checked='') |
| 2483 | 2487 | { |
@@ -2514,7 +2518,7 @@ discard block |
||
| 2514 | 2518 | /** |
| 2515 | 2519 | * Get wiki information |
| 2516 | 2520 | * @param int|bool wiki id |
| 2517 | - * @return array wiki data |
|
| 2521 | + * @return string wiki data |
|
| 2518 | 2522 | */ |
| 2519 | 2523 | public function getWikiDataFromDb($id) |
| 2520 | 2524 | { |
@@ -2561,6 +2565,7 @@ discard block |
||
| 2561 | 2565 | * Get wiki information |
| 2562 | 2566 | * @param string wiki id |
| 2563 | 2567 | * @param int $courseId |
| 2568 | + * @param string $title |
|
| 2564 | 2569 | * @return array wiki data |
| 2565 | 2570 | */ |
| 2566 | 2571 | public function getPageByTitle($title, $courseId = null) |
@@ -2593,6 +2598,8 @@ discard block |
||
| 2593 | 2598 | * @param int $courseId |
| 2594 | 2599 | * @param string |
| 2595 | 2600 | * @param string |
| 2601 | + * @param string $groupfilter |
|
| 2602 | + * @param string $condition_session |
|
| 2596 | 2603 | * @return bool |
| 2597 | 2604 | */ |
| 2598 | 2605 | public function deletePage($title, $courseId, $groupfilter = null, $condition_session = null) |
@@ -3644,6 +3651,7 @@ discard block |
||
| 3644 | 3651 | |
| 3645 | 3652 | /** |
| 3646 | 3653 | * Show all pages |
| 3654 | + * @param string $action |
|
| 3647 | 3655 | */ |
| 3648 | 3656 | public function allPages($action) |
| 3649 | 3657 | { |
@@ -4200,7 +4208,7 @@ discard block |
||
| 4200 | 4208 | |
| 4201 | 4209 | /** |
| 4202 | 4210 | * Restore page |
| 4203 | - * @return bool |
|
| 4211 | + * @return false|null |
|
| 4204 | 4212 | */ |
| 4205 | 4213 | public function restorePage() |
| 4206 | 4214 | { |
@@ -4302,7 +4310,7 @@ discard block |
||
| 4302 | 4310 | } |
| 4303 | 4311 | |
| 4304 | 4312 | /** |
| 4305 | - * @param int|bool $wikiId |
|
| 4313 | + * @param false|string $wikiId |
|
| 4306 | 4314 | */ |
| 4307 | 4315 | public function setWikiData($wikiId) |
| 4308 | 4316 | { |
@@ -1415,7 +1415,7 @@ discard block |
||
| 1415 | 1415 | |
| 1416 | 1416 | /** |
| 1417 | 1417 | * Get the emoji list to include in chat |
| 1418 | - * @return array |
|
| 1418 | + * @return string[] |
|
| 1419 | 1419 | */ |
| 1420 | 1420 | public static function getEmojisToInclude() |
| 1421 | 1421 | { |
@@ -1738,7 +1738,7 @@ discard block |
||
| 1738 | 1738 | |
| 1739 | 1739 | /** |
| 1740 | 1740 | * Get the number of users connected in chat |
| 1741 | - * @return mixed |
|
| 1741 | + * @return integer |
|
| 1742 | 1742 | */ |
| 1743 | 1743 | public function countUsersOnline() |
| 1744 | 1744 | { |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | * |
| 96 | 96 | * @param array $values Array of title + description (name => $title, description => $comment) |
| 97 | 97 | * |
| 98 | - * @return mixed Term id on success, false on failure |
|
| 98 | + * @return false|string Term id on success, false on failure |
|
| 99 | 99 | * |
| 100 | 100 | */ |
| 101 | 101 | public static function save_glossary($values, $showMessage = true) |
@@ -448,7 +448,7 @@ discard block |
||
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | 450 | * Display the glossary terms in a list |
| 451 | - * @return bool true |
|
| 451 | + * @return string true |
|
| 452 | 452 | */ |
| 453 | 453 | public static function displayGlossaryList() |
| 454 | 454 | { |
@@ -585,7 +585,7 @@ discard block |
||
| 585 | 585 | * Update action icons column |
| 586 | 586 | * |
| 587 | 587 | * @param integer $glossary_id |
| 588 | - * @param array $url_params Parameters to use to affect links |
|
| 588 | + * @param string $url_params Parameters to use to affect links |
|
| 589 | 589 | * @param array $row The line of results from a query on the glossary table |
| 590 | 590 | * |
| 591 | 591 | * @return string HTML string for the action icons columns |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | } |
| 141 | 141 | |
| 142 | 142 | /** |
| 143 | - * @return array |
|
| 143 | + * @return string[] |
|
| 144 | 144 | */ |
| 145 | 145 | public static function getValidExtraFieldTypes() |
| 146 | 146 | { |
@@ -217,7 +217,7 @@ discard block |
||
| 217 | 217 | |
| 218 | 218 | /** |
| 219 | 219 | * @param array $conditions |
| 220 | - * @param null $order_field_options_by |
|
| 220 | + * @param string $order_field_options_by |
|
| 221 | 221 | * |
| 222 | 222 | * @return array |
| 223 | 223 | */ |
@@ -375,7 +375,7 @@ discard block |
||
| 375 | 375 | /** |
| 376 | 376 | * @param string $handler |
| 377 | 377 | * |
| 378 | - * @return array |
|
| 378 | + * @return string[] |
|
| 379 | 379 | */ |
| 380 | 380 | public static function get_extra_fields_by_handler($handler) |
| 381 | 381 | { |
@@ -574,7 +574,7 @@ discard block |
||
| 574 | 574 | } |
| 575 | 575 | |
| 576 | 576 | /** |
| 577 | - * @return array |
|
| 577 | + * @return string[] |
|
| 578 | 578 | */ |
| 579 | 579 | public function get_field_types() |
| 580 | 580 | { |
@@ -584,7 +584,7 @@ discard block |
||
| 584 | 584 | /** |
| 585 | 585 | * @param int $id |
| 586 | 586 | * |
| 587 | - * @return null |
|
| 587 | + * @return string|null |
|
| 588 | 588 | */ |
| 589 | 589 | public function get_field_type_by_id($id) |
| 590 | 590 | { |
@@ -1826,7 +1826,7 @@ discard block |
||
| 1826 | 1826 | } |
| 1827 | 1827 | |
| 1828 | 1828 | /** |
| 1829 | - * @return array |
|
| 1829 | + * @return string[] |
|
| 1830 | 1830 | */ |
| 1831 | 1831 | public function getJqgridColumnNames() |
| 1832 | 1832 | { |
@@ -2086,7 +2086,7 @@ discard block |
||
| 2086 | 2086 | } |
| 2087 | 2087 | |
| 2088 | 2088 | /** |
| 2089 | - * @param array $columns |
|
| 2089 | + * @param string[] $columns |
|
| 2090 | 2090 | * @param array $column_model |
| 2091 | 2091 | * @param array $extraFields |
| 2092 | 2092 | * @return array |
@@ -96,6 +96,9 @@ |
||
| 96 | 96 | echo PHP_EOL; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | +/** |
|
| 100 | + * @param string $message |
|
| 101 | + */ |
|
| 99 | 102 | function echo_style($style, $message) |
| 100 | 103 | { |
| 101 | 104 | // ANSI color codes |
@@ -183,6 +183,7 @@ discard block |
||
| 183 | 183 | * (moving a course to a different course category) |
| 184 | 184 | * @param int $courseId |
| 185 | 185 | * @param int Category id |
| 186 | + * @param integer $newcategory |
|
| 186 | 187 | * @return bool True if it success |
| 187 | 188 | */ |
| 188 | 189 | public function updateCourseCategory($courseId, $newcategory) |
@@ -215,6 +216,9 @@ discard block |
||
| 215 | 216 | * @param string Direction (up/down) |
| 216 | 217 | * @param string Course code |
| 217 | 218 | * @param int Category id |
| 219 | + * @param string $direction |
|
| 220 | + * @param string $course2move |
|
| 221 | + * @param integer $category |
|
| 218 | 222 | * @return bool True if it success |
| 219 | 223 | */ |
| 220 | 224 | public function move_course($direction, $course2move, $category) |
@@ -285,6 +289,8 @@ discard block |
||
| 285 | 289 | * Moves the course one place up or down |
| 286 | 290 | * @param string Direction up/down |
| 287 | 291 | * @param string Category id |
| 292 | + * @param string $direction |
|
| 293 | + * @param integer $category2move |
|
| 288 | 294 | * @return bool True If it success |
| 289 | 295 | */ |
| 290 | 296 | public function move_category($direction, $category2move) |
@@ -348,6 +354,8 @@ discard block |
||
| 348 | 354 | * Updates the user course category in the chamilo_user database |
| 349 | 355 | * @param string Category title |
| 350 | 356 | * @param int Category id |
| 357 | + * @param string $title |
|
| 358 | + * @param integer $category_id |
|
| 351 | 359 | * @return bool True if it success |
| 352 | 360 | */ |
| 353 | 361 | public function store_edit_course_category($title, $category_id) |
@@ -1103,7 +1103,7 @@ |
||
| 1103 | 1103 | * @param String $type |
| 1104 | 1104 | * @param Integer $blog_id |
| 1105 | 1105 | * @param Integer $item_id |
| 1106 | - * @return array |
|
| 1106 | + * @return double |
|
| 1107 | 1107 | */ |
| 1108 | 1108 | public static function display_rating($type, $blog_id, $item_id) |
| 1109 | 1109 | { |
@@ -359,7 +359,7 @@ discard block |
||
| 359 | 359 | |
| 360 | 360 | /** |
| 361 | 361 | * Get description titles by default |
| 362 | - * @return array |
|
| 362 | + * @return string[] |
|
| 363 | 363 | */ |
| 364 | 364 | public function get_default_description_title() |
| 365 | 365 | { |
@@ -378,7 +378,7 @@ discard block |
||
| 378 | 378 | |
| 379 | 379 | /** |
| 380 | 380 | * Get description titles editable by default |
| 381 | - * @return array |
|
| 381 | + * @return boolean[] |
|
| 382 | 382 | */ |
| 383 | 383 | public function get_default_description_title_editable() |
| 384 | 384 | { |
@@ -397,7 +397,7 @@ discard block |
||
| 397 | 397 | |
| 398 | 398 | /** |
| 399 | 399 | * Get description icons by default |
| 400 | - * @return array |
|
| 400 | + * @return string[] |
|
| 401 | 401 | */ |
| 402 | 402 | public function get_default_description_icon() |
| 403 | 403 | { |
@@ -417,7 +417,7 @@ discard block |
||
| 417 | 417 | |
| 418 | 418 | /** |
| 419 | 419 | * Get questions by default for help |
| 420 | - * @return array |
|
| 420 | + * @return string[] |
|
| 421 | 421 | */ |
| 422 | 422 | public function get_default_question() |
| 423 | 423 | { |
@@ -436,7 +436,7 @@ discard block |
||
| 436 | 436 | |
| 437 | 437 | /** |
| 438 | 438 | * Get informations by default for help |
| 439 | - * @return array |
|
| 439 | + * @return string[] |
|
| 440 | 440 | */ |
| 441 | 441 | public function get_default_information() |
| 442 | 442 | { |
@@ -574,7 +574,7 @@ discard block |
||
| 574 | 574 | /** |
| 575 | 575 | * get progress of a description |
| 576 | 576 | * |
| 577 | - * @return int |
|
| 577 | + * @return string |
|
| 578 | 578 | */ |
| 579 | 579 | public function get_progress() |
| 580 | 580 | { |