@@ -728,7 +728,7 @@ discard block |
||
728 | 728 | * @author Bert Vanderkimpen |
729 | 729 | * @author Yannick Warnier <[email protected]> Adaptation for work tool |
730 | 730 | * @param string $base_work_dir Base work dir (.../work) |
731 | - * @param string $desiredDirName complete path of the desired name |
|
731 | + * @param string $desired_dir_name complete path of the desired name |
|
732 | 732 | * |
733 | 733 | * @return string actual directory name if it succeeds, boolean false otherwise |
734 | 734 | */ |
@@ -750,7 +750,7 @@ discard block |
||
750 | 750 | /** |
751 | 751 | * Delete a work-tool directory |
752 | 752 | * @param int $id work directory id to delete |
753 | - * @return integer -1 on error |
|
753 | + * @return boolean|null -1 on error |
|
754 | 754 | */ |
755 | 755 | function deleteDirWork($id) |
756 | 756 | { |
@@ -907,7 +907,7 @@ discard block |
||
907 | 907 | * Update the url of a dir in the student_publication table |
908 | 908 | * @param array $work_data work original data |
909 | 909 | * @param string $newPath Example: "folder1" |
910 | - * @return bool |
|
910 | + * @return boolean|null |
|
911 | 911 | */ |
912 | 912 | function updateDirName($work_data, $newPath) |
913 | 913 | { |
@@ -966,6 +966,7 @@ discard block |
||
966 | 966 | /** |
967 | 967 | * Transform an all directory structure (only directories) in an array |
968 | 968 | * @param string path of the directory |
969 | + * @param string $directory |
|
969 | 970 | * @return array the directory structure into an array |
970 | 971 | * @author Julio Montoya |
971 | 972 | * @version April 2008 |
@@ -1040,7 +1041,7 @@ discard block |
||
1040 | 1041 | * @param string the path of the directory |
1041 | 1042 | * @param boolean true if we want the total quantity of files |
1042 | 1043 | * include in others child directories, false only files in the directory |
1043 | - * @return array the first element is an integer with the number of files |
|
1044 | + * @return integer[] the first element is an integer with the number of files |
|
1044 | 1045 | * in the folder, the second element is the number of directories |
1045 | 1046 | * @author Julio Montoya |
1046 | 1047 | * @version April 2008 |
@@ -2804,7 +2805,7 @@ discard block |
||
2804 | 2805 | * @param int $userId |
2805 | 2806 | * @param int $workId |
2806 | 2807 | * @param int $courseId |
2807 | - * @return bool |
|
2808 | + * @return boolean|null |
|
2808 | 2809 | */ |
2809 | 2810 | function allowOnlySubscribedUser($userId, $workId, $courseId) |
2810 | 2811 | { |
@@ -3081,6 +3082,7 @@ discard block |
||
3081 | 3082 | * @param array $parentInfo |
3082 | 3083 | * @param array $courseInfo |
3083 | 3084 | * @param int $sessionId |
3085 | + * @param integer $userId |
|
3084 | 3086 | * @return int |
3085 | 3087 | */ |
3086 | 3088 | function getLastWorkStudentFromParentByUser( |
@@ -3226,7 +3228,7 @@ discard block |
||
3226 | 3228 | * @param int $userId |
3227 | 3229 | * @param array $work |
3228 | 3230 | * @param array $data |
3229 | - * @return int |
|
3231 | + * @return false|null |
|
3230 | 3232 | */ |
3231 | 3233 | function addWorkComment($courseInfo, $userId, $parentWork, $work, $data) |
3232 | 3234 | { |
@@ -4409,7 +4411,7 @@ discard block |
||
4409 | 4411 | } |
4410 | 4412 | |
4411 | 4413 | /** |
4412 | - * @return array |
|
4414 | + * @return string[] |
|
4413 | 4415 | */ |
4414 | 4416 | function getUploadDocumentType() |
4415 | 4417 | { |
@@ -4797,7 +4799,7 @@ discard block |
||
4797 | 4799 | * @param int Session ID |
4798 | 4800 | * @param $correction |
4799 | 4801 | * |
4800 | - * @return array|bool |
|
4802 | + * @return boolean |
|
4801 | 4803 | */ |
4802 | 4804 | function getFileContents($id, $course_info, $sessionId = 0, $correction = false) |
4803 | 4805 | { |
@@ -4915,7 +4917,7 @@ discard block |
||
4915 | 4917 | * @param int $userId |
4916 | 4918 | * @param array $courseInfo |
4917 | 4919 | * @param string $format |
4918 | - * @return bool |
|
4920 | + * @return false|null |
|
4919 | 4921 | */ |
4920 | 4922 | function exportAllWork($userId, $courseInfo, $format = 'pdf') |
4921 | 4923 | { |
@@ -4961,7 +4963,7 @@ discard block |
||
4961 | 4963 | * @param array $courseInfo |
4962 | 4964 | * @param int $sessionId |
4963 | 4965 | * @param string $format |
4964 | - * @return bool |
|
4966 | + * @return false|null |
|
4965 | 4967 | */ |
4966 | 4968 | function exportAllStudentWorkFromPublication( |
4967 | 4969 | $workId, |
@@ -5096,7 +5098,7 @@ discard block |
||
5096 | 5098 | * Downloads all user files per user |
5097 | 5099 | * @param int $userId |
5098 | 5100 | * @param array $courseInfo |
5099 | - * @return bool |
|
5101 | + * @return false|null |
|
5100 | 5102 | */ |
5101 | 5103 | function downloadAllFilesPerUser($userId, $courseInfo) |
5102 | 5104 | { |
@@ -5210,7 +5212,7 @@ discard block |
||
5210 | 5212 | /** |
5211 | 5213 | * @param array $courseInfo |
5212 | 5214 | * @param int $workId |
5213 | - * @return bool |
|
5215 | + * @return boolean|null |
|
5214 | 5216 | */ |
5215 | 5217 | function protectWork($courseInfo, $workId) |
5216 | 5218 | { |
@@ -337,7 +337,7 @@ discard block |
||
337 | 337 | * Save a participant in a meeting room |
338 | 338 | * @param int $meetingId |
339 | 339 | * @param int $participantId |
340 | - * @return false|int The last inserted ID. Otherwise return false |
|
340 | + * @return false|string The last inserted ID. Otherwise return false |
|
341 | 341 | */ |
342 | 342 | public function saveParticipant($meetingId, $participantId) |
343 | 343 | { |
@@ -410,7 +410,7 @@ discard block |
||
410 | 410 | /** |
411 | 411 | * Returns a meeting "join" URL |
412 | 412 | * @param string The name of the meeting (usually the course code) |
413 | - * @return mixed The URL to join the meeting, or false on error |
|
413 | + * @return false|string The URL to join the meeting, or false on error |
|
414 | 414 | * @todo implement moderator pass |
415 | 415 | * @assert ('') === false |
416 | 416 | * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false |
@@ -791,7 +791,7 @@ discard block |
||
791 | 791 | * @param string The internal ID of the meeting (id field for this meeting) |
792 | 792 | * @param string $courseCode |
793 | 793 | * |
794 | - * @return void |
|
794 | + * @return false|null |
|
795 | 795 | * @assert (0) === false |
796 | 796 | */ |
797 | 797 | public function endMeeting($id, $courseCode = null) |
@@ -1270,7 +1270,7 @@ discard block |
||
1270 | 1270 | * @param array $recordInfo |
1271 | 1271 | * @param bool $isGlobal |
1272 | 1272 | * @param bool $isAdminReport |
1273 | - * @return array |
|
1273 | + * @return string[] |
|
1274 | 1274 | */ |
1275 | 1275 | private function getActionLinks($meetingInfo, $recordInfo, $isGlobal = false, $isAdminReport = false) |
1276 | 1276 | { |
@@ -745,8 +745,8 @@ discard block |
||
745 | 745 | /** |
746 | 746 | * Attachment files when a message is sent |
747 | 747 | * @param $file_attach |
748 | - * @param $ticket_id |
|
749 | - * @param $message_id |
|
748 | + * @param integer $ticket_id |
|
749 | + * @param integer $message_id |
|
750 | 750 | * @return array |
751 | 751 | */ |
752 | 752 | public static function save_message_attachment_file( |
@@ -2022,7 +2022,7 @@ discard block |
||
2022 | 2022 | } |
2023 | 2023 | |
2024 | 2024 | /** |
2025 | - * @param $id |
|
2025 | + * @param integer $id |
|
2026 | 2026 | * @return Project |
2027 | 2027 | */ |
2028 | 2028 | public static function getProject($id) |
@@ -2142,7 +2142,7 @@ discard block |
||
2142 | 2142 | } |
2143 | 2143 | |
2144 | 2144 | /** |
2145 | - * @param $id |
|
2145 | + * @param integer $id |
|
2146 | 2146 | * @return Project |
2147 | 2147 | */ |
2148 | 2148 | public static function getStatus($id) |
@@ -2265,7 +2265,7 @@ discard block |
||
2265 | 2265 | } |
2266 | 2266 | |
2267 | 2267 | /** |
2268 | - * @param $id |
|
2268 | + * @param integer $id |
|
2269 | 2269 | * @return Priority |
2270 | 2270 | */ |
2271 | 2271 | public static function getPriority($id) |
@@ -2335,7 +2335,7 @@ discard block |
||
2335 | 2335 | } |
2336 | 2336 | |
2337 | 2337 | /** |
2338 | - * @return array |
|
2338 | + * @return string[] |
|
2339 | 2339 | */ |
2340 | 2340 | public static function getDefaultStatusList() { |
2341 | 2341 | return [ |
@@ -2348,7 +2348,7 @@ discard block |
||
2348 | 2348 | } |
2349 | 2349 | |
2350 | 2350 | /** |
2351 | - * @return array |
|
2351 | + * @return string[] |
|
2352 | 2352 | */ |
2353 | 2353 | public static function getDefaultPriorityList() { |
2354 | 2354 | return [ |
@@ -1275,6 +1275,7 @@ discard block |
||
1275 | 1275 | * Gets the list of courses a specific user is subscribed to |
1276 | 1276 | * @param int User ID |
1277 | 1277 | * @param boolean $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED |
1278 | + * @param integer $userid |
|
1278 | 1279 | * @return array Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d) |
1279 | 1280 | */ |
1280 | 1281 | function api_get_user_courses($userid, $fetch_session = true) |
@@ -3049,7 +3050,7 @@ discard block |
||
3049 | 3050 | * on the session visibility |
3050 | 3051 | * @param bool $tutor Whether to check if the user has the tutor role |
3051 | 3052 | * @param bool $coach Whether to check if the user has the coach role |
3052 | -* @return boolean true: the user has the rights to edit, false: he does not |
|
3053 | +* @return boolean|null true: the user has the rights to edit, false: he does not |
|
3053 | 3054 | */ |
3054 | 3055 | function api_is_allowed_to_session_edit($tutor = false, $coach = false) |
3055 | 3056 | { |
@@ -5228,6 +5229,7 @@ discard block |
||
5228 | 5229 | * @param string Whether we want a simple list (display a category) or |
5229 | 5230 | * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group' |
5230 | 5231 | * @param int Access URL's ID. Optional. Uses 1 by default, which is the unique URL |
5232 | + * @param string $cat |
|
5231 | 5233 | * @return array Array of database results for the current settings of the current access URL |
5232 | 5234 | */ |
5233 | 5235 | function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0) |
@@ -6621,7 +6623,7 @@ discard block |
||
6621 | 6623 | /** |
6622 | 6624 | * Returns an array of global configuration settings which should be ignored |
6623 | 6625 | * when printing the configuration settings screens |
6624 | - * @return array Array of strings, each identifying one of the excluded settings |
|
6626 | + * @return string[] Array of strings, each identifying one of the excluded settings |
|
6625 | 6627 | */ |
6626 | 6628 | function api_get_locked_settings() { |
6627 | 6629 | return array( |
@@ -6662,6 +6664,7 @@ discard block |
||
6662 | 6664 | * false if he isn't. If the user ID is given and is an integer, then the same |
6663 | 6665 | * ID is simply returned |
6664 | 6666 | * @param integer User ID |
6667 | + * @param integer $user_id |
|
6665 | 6668 | * @return boolean Integer User ID is logged in, or false otherwise |
6666 | 6669 | */ |
6667 | 6670 | function api_user_is_login($user_id = null) { |
@@ -7082,6 +7085,7 @@ discard block |
||
7082 | 7085 | /** |
7083 | 7086 | * Gets memory limit in bytes |
7084 | 7087 | * @param string The memory size (128M, 1G, 1000K, etc) |
7088 | + * @param string $mem |
|
7085 | 7089 | * @return int |
7086 | 7090 | * @assert (null) === false |
7087 | 7091 | * @assert ('1t') === 1099511627776 |
@@ -8100,8 +8104,8 @@ discard block |
||
8100 | 8104 | * Adds or Subtract a time in hh:mm:ss to a datetime |
8101 | 8105 | * |
8102 | 8106 | * @param $datetime |
8103 | - * @param $time |
|
8104 | - * @param $operation - True for Add, False to Subtract |
|
8107 | + * @param string $time |
|
8108 | + * @param boolean $operation - True for Add, False to Subtract |
|
8105 | 8109 | * @return string |
8106 | 8110 | */ |
8107 | 8111 | function api_add_sub_hours_to_date_time($datetime, $time, $operation) |
@@ -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, |
@@ -591,6 +596,8 @@ discard block |
||
591 | 596 | * @param int Whether this answer is correct (1) or not (0) |
592 | 597 | * @param string Coordinates of this point (e.g. 123;324) |
593 | 598 | * @param bool update results? |
599 | + * @param integer $exe_id |
|
600 | + * @param integer $correct |
|
594 | 601 | * @return boolean Result of the insert query |
595 | 602 | * @uses Course code and user_id from global scope $_cid and $_user |
596 | 603 | */ |
@@ -808,11 +815,11 @@ discard block |
||
808 | 815 | /** |
809 | 816 | * Save the new message for one event and for one language |
810 | 817 | * |
811 | - * @param string $eventName |
|
818 | + * @param string $event_name |
|
812 | 819 | * @param array $users |
813 | 820 | * @param string $message |
814 | 821 | * @param string $subject |
815 | - * @param string $eventMessageLanguage |
|
822 | + * @param string $event_message_language |
|
816 | 823 | * @param int $activated |
817 | 824 | */ |
818 | 825 | public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated) |
@@ -946,10 +953,10 @@ discard block |
||
946 | 953 | } |
947 | 954 | |
948 | 955 | /** |
949 | - * @param $user_id |
|
956 | + * @param integer $user_id |
|
950 | 957 | * @param $exerciseId |
951 | - * @param $lp_id |
|
952 | - * @param $lp_item_id |
|
958 | + * @param integer $lp_id |
|
959 | + * @param integer $lp_item_id |
|
953 | 960 | * @return int |
954 | 961 | */ |
955 | 962 | public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id) |
@@ -1126,6 +1133,7 @@ discard block |
||
1126 | 1133 | * @param int exercise id |
1127 | 1134 | * @param int $courseId |
1128 | 1135 | * @param int session id |
1136 | + * @param integer $user_id |
|
1129 | 1137 | * @return array with the results |
1130 | 1138 | * |
1131 | 1139 | */ |
@@ -1222,6 +1230,7 @@ discard block |
||
1222 | 1230 | * @param int exercise id |
1223 | 1231 | * @param int $courseId |
1224 | 1232 | * @param int session id |
1233 | + * @param integer $user_id |
|
1225 | 1234 | * @return array with the results |
1226 | 1235 | * |
1227 | 1236 | */ |
@@ -1313,6 +1322,8 @@ discard block |
||
1313 | 1322 | * @param int lp id |
1314 | 1323 | * @param int lp item id |
1315 | 1324 | * @param string order asc or desc |
1325 | + * @param integer $courseId |
|
1326 | + * @param string $order |
|
1316 | 1327 | * @return array with the results |
1317 | 1328 | * |
1318 | 1329 | */ |
@@ -1379,7 +1390,7 @@ discard block |
||
1379 | 1390 | * @param int exercise id |
1380 | 1391 | * @param int $courseId |
1381 | 1392 | * @param int session id |
1382 | - * @return array with the results |
|
1393 | + * @return string with the results |
|
1383 | 1394 | * |
1384 | 1395 | */ |
1385 | 1396 | public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0) |
@@ -1551,7 +1562,7 @@ discard block |
||
1551 | 1562 | * @param int exercise id |
1552 | 1563 | * @param int course id |
1553 | 1564 | * @param int session id |
1554 | - * @return array with the results |
|
1565 | + * @return integer with the results |
|
1555 | 1566 | * |
1556 | 1567 | */ |
1557 | 1568 | public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0) |
@@ -1795,6 +1806,10 @@ discard block |
||
1795 | 1806 | CourseManager::update_course_ranking(null, null, null, null, true, false); |
1796 | 1807 | } |
1797 | 1808 | |
1809 | + /** |
|
1810 | + * @param integer $userId |
|
1811 | + * @param integer $sessionId |
|
1812 | + */ |
|
1798 | 1813 | public static function eventCourseVirtualLogin($courseId, $userId, $sessionId, $virtualTime = '') |
1799 | 1814 | { |
1800 | 1815 | $courseTrackingTable = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS); |