@@ -20,6 +20,9 @@ |
||
20 | 20 | return $this->id; |
21 | 21 | } |
22 | 22 | |
23 | + /** |
|
24 | + * @return string |
|
25 | + */ |
|
23 | 26 | public function getName() |
24 | 27 | { |
25 | 28 | return $this->name; |
@@ -334,6 +334,9 @@ |
||
334 | 334 | return preg_replace('/, $/','',$result); |
335 | 335 | } |
336 | 336 | |
337 | + /** |
|
338 | + * @param string $paramString |
|
339 | + */ |
|
337 | 340 | private function _parseParameterString ($paramString) |
338 | 341 | { |
339 | 342 | $elements = explode('&',$paramString); |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | * Returns the name without extension, used for the title |
54 | 54 | * |
55 | 55 | * @param string $name |
56 | - * @return name without the extension |
|
56 | + * @return string without the extension |
|
57 | 57 | */ |
58 | 58 | function get_document_title($name) |
59 | 59 | { |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | * This function checks if the upload succeeded |
68 | 68 | * |
69 | 69 | * @param array $uploaded_file ($_FILES) |
70 | - * @return true if upload succeeded |
|
70 | + * @return boolean if upload succeeded |
|
71 | 71 | */ |
72 | 72 | function process_uploaded_file($uploaded_file, $show_output = true) |
73 | 73 | { |
@@ -1025,7 +1025,7 @@ discard block |
||
1025 | 1025 | * @param array $courseInfo |
1026 | 1026 | * @param array $userInfo |
1027 | 1027 | * @param array $uploaded_file - follows the $_FILES Structure |
1028 | - * @param string $upload_path - destination of the upload. |
|
1028 | + * @param string $uploadPath - destination of the upload. |
|
1029 | 1029 | * This path is to append to $base_work_dir |
1030 | 1030 | * @param string $base_work_dir - base working directory of the module |
1031 | 1031 | * @param int $maxFilledSpace - amount of bytes to not exceed in the base |
@@ -1212,7 +1212,7 @@ discard block |
||
1212 | 1212 | * @param int $session_id Session ID, if any |
1213 | 1213 | * @param int $userId creator id |
1214 | 1214 | * |
1215 | - * @return int id if inserted document |
|
1215 | + * @return string|false id if inserted document |
|
1216 | 1216 | */ |
1217 | 1217 | function add_document( |
1218 | 1218 | $_course, |
@@ -1346,7 +1346,7 @@ discard block |
||
1346 | 1346 | * |
1347 | 1347 | * @author Olivier Cauberghe <[email protected]> |
1348 | 1348 | * @param path+filename eg: /main/document/document.php |
1349 | - * @return The directory depth |
|
1349 | + * @return integer directory depth |
|
1350 | 1350 | */ |
1351 | 1351 | function get_levels($filename) { |
1352 | 1352 | $levels = explode('/', $filename); |
@@ -1363,6 +1363,8 @@ discard block |
||
1363 | 1363 | * @author Olivier Cauberghe <[email protected]> |
1364 | 1364 | * @param path,filename |
1365 | 1365 | * action: Adds an entry to the document table with the default settings. |
1366 | + * @param string $upload_path |
|
1367 | + * @param string $filename |
|
1366 | 1368 | */ |
1367 | 1369 | function set_default_settings($upload_path, $filename, $filetype = 'file') |
1368 | 1370 | { |
@@ -1818,7 +1820,6 @@ discard block |
||
1818 | 1820 | * @param int $groupId |
1819 | 1821 | * @param bool $output |
1820 | 1822 | * @param array $parent |
1821 | - * @param string $uploadPath |
|
1822 | 1823 | * |
1823 | 1824 | */ |
1824 | 1825 | function add_all_documents_in_folder_to_database( |
@@ -371,7 +371,7 @@ discard block |
||
371 | 371 | * @author Bart Mollet |
372 | 372 | * @param int $groupId iid |
373 | 373 | * @param string $course_code Default is current course |
374 | - * @return integer - number of groups deleted. |
|
374 | + * @return boolean - number of groups deleted. |
|
375 | 375 | */ |
376 | 376 | public static function delete_groups($groupId, $course_code = null) |
377 | 377 | { |
@@ -563,7 +563,7 @@ discard block |
||
563 | 563 | * @param bool Whether self registration is allowed or not |
564 | 564 | * @param bool Whether self unregistration is allowed or not |
565 | 565 | * @param int $categoryId |
566 | - * @return bool TRUE if properties are successfully changed, false otherwise |
|
566 | + * @return Statement|null TRUE if properties are successfully changed, false otherwise |
|
567 | 567 | */ |
568 | 568 | public static function set_group_properties( |
569 | 569 | $group_id, |
@@ -716,7 +716,7 @@ discard block |
||
716 | 716 | * @param int $group_id The iid of the group |
717 | 717 | * @param string $course_code The course in which the group is (default = |
718 | 718 | * current course) |
719 | - * @return array The category |
|
719 | + * @return integer The category |
|
720 | 720 | */ |
721 | 721 | public static function get_category_from_group($group_id, $course_code = null) |
722 | 722 | { |
@@ -782,9 +782,9 @@ discard block |
||
782 | 782 | * Create group category |
783 | 783 | * @param string $title The title of the new category |
784 | 784 | * @param string $description The description of the new category |
785 | - * @param bool $self_registration_allowed |
|
786 | - * @param bool $self_unregistration_allowed |
|
787 | - * @param int $max_number_of_students |
|
785 | + * @param integer $self_registration_allowed |
|
786 | + * @param integer $self_unregistration_allowed |
|
787 | + * @param int $maximum_number_of_students |
|
788 | 788 | * @param int $groups_per_user |
789 | 789 | */ |
790 | 790 | public static function create_category( |
@@ -990,6 +990,8 @@ discard block |
||
990 | 990 | * @param int $limit |
991 | 991 | * @param bool $getCount |
992 | 992 | * @param int $courseId |
993 | + * @param string $column |
|
994 | + * @param string $direction |
|
993 | 995 | * @return array list of user id |
994 | 996 | */ |
995 | 997 | public static function get_users( |
@@ -1583,7 +1585,7 @@ discard block |
||
1583 | 1585 | /** |
1584 | 1586 | * Subscribe tutor(s) to a specified group in current course |
1585 | 1587 | * @param mixed $user_ids Can be an array with user-id's or a single user-id |
1586 | - * @param int $group_id iid |
|
1588 | + * @param int $groupId iid |
|
1587 | 1589 | * @param int $course_id |
1588 | 1590 | * |
1589 | 1591 | * @author Patrick Cool <[email protected]>, Ghent University |
@@ -1614,7 +1616,7 @@ discard block |
||
1614 | 1616 | * Unsubscribe user(s) from a specified group in current course |
1615 | 1617 | * @param mixed $user_ids Can be an array with user-id's or a single user-id |
1616 | 1618 | * @param int $group_id iid |
1617 | - * @return bool TRUE if successful |
|
1619 | + * @return boolean|null TRUE if successful |
|
1618 | 1620 | */ |
1619 | 1621 | public static function unsubscribe_users($user_ids, $group_id) |
1620 | 1622 | { |
@@ -1633,7 +1635,7 @@ discard block |
||
1633 | 1635 | |
1634 | 1636 | /** |
1635 | 1637 | * Unsubscribe all users from one or more groups |
1636 | - * @param int $group_id iid |
|
1638 | + * @param integer $groupId iid |
|
1637 | 1639 | * @return bool TRUE if successful |
1638 | 1640 | */ |
1639 | 1641 | public static function unsubscribe_all_users($groupId) |
@@ -1781,6 +1783,7 @@ discard block |
||
1781 | 1783 | * |
1782 | 1784 | * @param $user_array_in list of users (must be sorted). |
1783 | 1785 | * @param string $compare_field, the field to be compared |
1786 | + * @param string $compare_field |
|
1784 | 1787 | */ |
1785 | 1788 | public static function filter_duplicates($user_array_in, $compare_field) |
1786 | 1789 | { |
@@ -37,6 +37,8 @@ discard block |
||
37 | 37 | * |
38 | 38 | * @param int Error code |
39 | 39 | * @param string Error message |
40 | + * @param integer $code |
|
41 | + * @param string $message |
|
40 | 42 | */ |
41 | 43 | public function __construct($code, $message) |
42 | 44 | { |
@@ -48,6 +50,7 @@ discard block |
||
48 | 50 | * Sets the error handler |
49 | 51 | * |
50 | 52 | * @param WSErrorHandler Error handler |
53 | + * @param WSCMSoapErrorHandler $handler |
|
51 | 54 | */ |
52 | 55 | public static function setErrorHandler($handler) |
53 | 56 | { |
@@ -86,6 +89,7 @@ discard block |
||
86 | 89 | * Handle method |
87 | 90 | * |
88 | 91 | * @param WSError Error |
92 | + * @return void |
|
89 | 93 | */ |
90 | 94 | public function handle($error); |
91 | 95 | } |
@@ -114,7 +118,7 @@ discard block |
||
114 | 118 | * Verifies the API key |
115 | 119 | * |
116 | 120 | * @param string Secret key |
117 | - * @return mixed WSError in case of failure, null in case of success |
|
121 | + * @return WSCMError|null WSError in case of failure, null in case of success |
|
118 | 122 | */ |
119 | 123 | protected function verifyKey($secret_key) |
120 | 124 | { |
@@ -1619,7 +1619,7 @@ discard block |
||
1619 | 1619 | * @param array $user_list |
1620 | 1620 | * @param int $session_visibility |
1621 | 1621 | * @param bool $empty_users |
1622 | - * @return bool |
|
1622 | + * @return false|null |
|
1623 | 1623 | */ |
1624 | 1624 | public static function suscribe_users_to_session( |
1625 | 1625 | $id_session, |
@@ -1891,7 +1891,7 @@ discard block |
||
1891 | 1891 | * @param array $courseInfo |
1892 | 1892 | * @param int $status |
1893 | 1893 | * @param bool $updateTotal |
1894 | - * @return bool |
|
1894 | + * @return false|null |
|
1895 | 1895 | */ |
1896 | 1896 | public static function removeUsersFromCourseSession( |
1897 | 1897 | $userList, |
@@ -1957,7 +1957,7 @@ discard block |
||
1957 | 1957 | * @param string $course_code |
1958 | 1958 | * @param int $session_visibility |
1959 | 1959 | * @param bool $removeUsersNotInList |
1960 | - * @return bool |
|
1960 | + * @return false|null |
|
1961 | 1961 | */ |
1962 | 1962 | public static function subscribe_users_to_session_course( |
1963 | 1963 | $user_list, |
@@ -2140,7 +2140,7 @@ discard block |
||
2140 | 2140 | * @param bool $removeExistingCoursesWithUsers Whether to unsubscribe |
2141 | 2141 | * existing courses and users (true, default) or not (false) |
2142 | 2142 | * @param $copyEvaluation from base course to session course |
2143 | - * @return void Nothing, or false on error |
|
2143 | + * @return false|null Nothing, or false on error |
|
2144 | 2144 | * */ |
2145 | 2145 | public static function add_courses_to_session( |
2146 | 2146 | $sessionId, |
@@ -2336,6 +2336,8 @@ discard block |
||
2336 | 2336 | * |
2337 | 2337 | * @param int Session id |
2338 | 2338 | * @param int Course id |
2339 | + * @param integer $session_id |
|
2340 | + * @param integer $course_id |
|
2339 | 2341 | * @return bool True in case of success, false otherwise |
2340 | 2342 | */ |
2341 | 2343 | public static function unsubscribe_course_from_session($session_id, $course_id) |
@@ -2391,7 +2393,7 @@ discard block |
||
2391 | 2393 | * @param string $variable Field's internal variable name |
2392 | 2394 | * @param int $fieldType Field's type |
2393 | 2395 | * @param string $displayText Field's language var name |
2394 | - * @return int new extra field id |
|
2396 | + * @return boolean new extra field id |
|
2395 | 2397 | */ |
2396 | 2398 | public static function create_session_extra_field($variable, $fieldType, $displayText) |
2397 | 2399 | { |
@@ -2615,7 +2617,7 @@ discard block |
||
2615 | 2617 | * @param array id_checked |
2616 | 2618 | * @param bool include delete session |
2617 | 2619 | * @param bool optional, true if the function is called by a webservice, false otherwise. |
2618 | - * @return void Nothing, or false on error |
|
2620 | + * @return boolean Nothing, or false on error |
|
2619 | 2621 | * The parameters is a array to delete sessions |
2620 | 2622 | * */ |
2621 | 2623 | public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false) |
@@ -3381,8 +3383,8 @@ discard block |
||
3381 | 3383 | /** |
3382 | 3384 | * Gets the list of courses by session filtered by access_url |
3383 | 3385 | * |
3384 | - * @param $userId |
|
3385 | - * @param $sessionId |
|
3386 | + * @param integer $userId |
|
3387 | + * @param null|integer $sessionId |
|
3386 | 3388 | * @param null $from |
3387 | 3389 | * @param null $limit |
3388 | 3390 | * @param null $column |
@@ -3507,6 +3509,7 @@ discard block |
||
3507 | 3509 | /** |
3508 | 3510 | * Gets the count of courses by session filtered by access_url |
3509 | 3511 | * @param int session id |
3512 | + * @param integer $session_id |
|
3510 | 3513 | * @return array list of courses |
3511 | 3514 | */ |
3512 | 3515 | public static function getCourseCountBySessionId($session_id, $keyword = null) |
@@ -3758,6 +3761,7 @@ discard block |
||
3758 | 3761 | * Updates a session status |
3759 | 3762 | * @param int session id |
3760 | 3763 | * @param int status |
3764 | + * @param integer $status |
|
3761 | 3765 | */ |
3762 | 3766 | public static function set_session_status($session_id, $status) |
3763 | 3767 | { |
@@ -3966,7 +3970,7 @@ discard block |
||
3966 | 3970 | * Protect a session to be edited. |
3967 | 3971 | * @param int $id |
3968 | 3972 | * @param bool $checkSession |
3969 | - * @return mixed | bool true if pass the check, api_not_allowed otherwise |
|
3973 | + * @return boolean|null | bool true if pass the check, api_not_allowed otherwise |
|
3970 | 3974 | */ |
3971 | 3975 | public static function protectSession($id, $checkSession = true) |
3972 | 3976 | { |
@@ -4074,7 +4078,7 @@ discard block |
||
4074 | 4078 | |
4075 | 4079 | /** |
4076 | 4080 | * @param $id |
4077 | - * @return bool |
|
4081 | + * @return null|boolean |
|
4078 | 4082 | */ |
4079 | 4083 | public static function protect_teacher_session_edit($id) |
4080 | 4084 | { |
@@ -4138,7 +4142,7 @@ discard block |
||
4138 | 4142 | * true: if the session exists it will be updated. |
4139 | 4143 | * false: if session exists a new session will be created adding a counter session1, session2, etc |
4140 | 4144 | * @param int $defaultUserId |
4141 | - * @param mixed $logger |
|
4145 | + * @param Logger $logger |
|
4142 | 4146 | * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will |
4143 | 4147 | * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id') |
4144 | 4148 | * @param string $extraFieldId |
@@ -5441,7 +5445,6 @@ discard block |
||
5441 | 5445 | * @param string $lastConnectionDate |
5442 | 5446 | * @param array $sessionIdList |
5443 | 5447 | * @param array $studentIdList |
5444 | - * @param int $userStatus STUDENT|COURSEMANAGER constants |
|
5445 | 5448 | * |
5446 | 5449 | * @return array|int |
5447 | 5450 | */ |
@@ -5593,7 +5596,7 @@ discard block |
||
5593 | 5596 | /** |
5594 | 5597 | * Get the list of course tools that have to be dealt with in case of |
5595 | 5598 | * registering any course to a session |
5596 | - * @return array The list of tools to be dealt with (literal names) |
|
5599 | + * @return string[] The list of tools to be dealt with (literal names) |
|
5597 | 5600 | */ |
5598 | 5601 | public static function getCourseToolToBeManaged() |
5599 | 5602 | { |
@@ -5607,7 +5610,7 @@ discard block |
||
5607 | 5610 | * Calls the methods bound to each tool when a course is registered into a session |
5608 | 5611 | * @param int $sessionId |
5609 | 5612 | * @param int $courseId |
5610 | - * @return void |
|
5613 | + * @return boolean|null |
|
5611 | 5614 | */ |
5612 | 5615 | public static function installCourse($sessionId, $courseId) |
5613 | 5616 | { |
@@ -6247,6 +6250,7 @@ discard block |
||
6247 | 6250 | * @param int $categoryId The internal ID of the session category |
6248 | 6251 | * @param string $target Value to search for in the session field values |
6249 | 6252 | * @param array $extraFields A list of fields to be scanned and returned |
6253 | + * @param DateTime $publicationDate |
|
6250 | 6254 | * @return mixed |
6251 | 6255 | */ |
6252 | 6256 | public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null) |
@@ -7577,7 +7581,7 @@ discard block |
||
7577 | 7581 | /** |
7578 | 7582 | * Get link to the admin page for this session |
7579 | 7583 | * @param int $id Session ID |
7580 | - * @return mixed URL to the admin page to manage the session, or false on error |
|
7584 | + * @return false|string URL to the admin page to manage the session, or false on error |
|
7581 | 7585 | */ |
7582 | 7586 | public static function getAdminPath($id) |
7583 | 7587 | { |
@@ -7594,7 +7598,7 @@ discard block |
||
7594 | 7598 | * If a course is provided, build the link to the course |
7595 | 7599 | * @param int $id Session ID |
7596 | 7600 | * @param int $courseId Course ID (optional) in case the link has to send straight to the course |
7597 | - * @return mixed URL to the page to use the session, or false on error |
|
7601 | + * @return false|string URL to the page to use the session, or false on error |
|
7598 | 7602 | */ |
7599 | 7603 | public static function getPath($id, $courseId = 0) |
7600 | 7604 | { |
@@ -47,7 +47,7 @@ discard block |
||
47 | 47 | * Deletes all survey invitations of a user |
48 | 48 | * @param int $user_id |
49 | 49 | * |
50 | - * @return boolean |
|
50 | + * @return false|null |
|
51 | 51 | * @assert ('') === false |
52 | 52 | */ |
53 | 53 | public static function delete_all_survey_invitations_by_user($user_id) |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | * Retrieves all the survey information |
105 | 105 | * |
106 | 106 | * @param integer $survey_id the id of the survey |
107 | - * @param boolean $shared this parameter determines if |
|
107 | + * @param integer $shared this parameter determines if |
|
108 | 108 | * we have to get the information of a survey from the central (shared) database or from the |
109 | 109 | * course database |
110 | 110 | * @param string course code optional |
@@ -571,7 +571,7 @@ discard block |
||
571 | 571 | * This function deletes a survey (and also all the question in that survey |
572 | 572 | * |
573 | 573 | * @param int $survey_id id of the survey that has to be deleted |
574 | - * @return true |
|
574 | + * @return boolean |
|
575 | 575 | * |
576 | 576 | * @author Patrick Cool <[email protected]>, Ghent University |
577 | 577 | * @version January 2007 |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | * |
757 | 757 | * @param int $survey_id id of the survey that has to be duplicated |
758 | 758 | * @param int $courseId id of the course which survey has to be duplicated |
759 | - * @return true |
|
759 | + * @return boolean |
|
760 | 760 | * |
761 | 761 | * @author Eric Marguin <[email protected]>, Elixir Interactive |
762 | 762 | * @version October 2007 |
@@ -796,7 +796,7 @@ discard block |
||
796 | 796 | /** |
797 | 797 | * This function recalculates the number of people who have taken the survey (=filled at least one question) |
798 | 798 | * |
799 | - * @param int $survey_id the id of the survey somebody |
|
799 | + * @param int $survey_data the id of the survey somebody |
|
800 | 800 | * @return true |
801 | 801 | * |
802 | 802 | * @author Patrick Cool <[email protected]>, Ghent University |
@@ -1367,7 +1367,7 @@ discard block |
||
1367 | 1367 | * This function deletes a shared survey question from the main database and all its options |
1368 | 1368 | * |
1369 | 1369 | * @param int $question_id the id of the question |
1370 | - * @param int $shared |
|
1370 | + * @param integer $survey_id |
|
1371 | 1371 | * |
1372 | 1372 | * @todo delete all the options of this question |
1373 | 1373 | * |
@@ -1494,8 +1494,8 @@ discard block |
||
1494 | 1494 | * This function deletes all the options of the questions of a given survey |
1495 | 1495 | * This function is normally only called when a survey is deleted |
1496 | 1496 | * |
1497 | - * @param $survey_id the id of the survey that has to be deleted |
|
1498 | - * @return true |
|
1497 | + * @param integer $survey_id the id of the survey that has to be deleted |
|
1498 | + * @return boolean |
|
1499 | 1499 | * |
1500 | 1500 | * @author Patrick Cool <[email protected]>, Ghent University |
1501 | 1501 | * @version January 2007 |
@@ -1562,8 +1562,8 @@ discard block |
||
1562 | 1562 | * This function deletes all the answers anyone has given on this survey |
1563 | 1563 | * This function is normally only called when a survey is deleted |
1564 | 1564 | * |
1565 | - * @param $survey_id the id of the survey that has to be deleted |
|
1566 | - * @return true |
|
1565 | + * @param integer $survey_id the id of the survey that has to be deleted |
|
1566 | + * @return boolean |
|
1567 | 1567 | * |
1568 | 1568 | * @todo write the function |
1569 | 1569 | * |
@@ -1838,7 +1838,7 @@ discard block |
||
1838 | 1838 | /** |
1839 | 1839 | * This function checks the parameters that are used in this page |
1840 | 1840 | * |
1841 | - * @return string The header, an error and the footer if any parameter fails, else it returns true |
|
1841 | + * @return null|boolean The header, an error and the footer if any parameter fails, else it returns true |
|
1842 | 1842 | * @author Patrick Cool <[email protected]>, Ghent University |
1843 | 1843 | * @version February 2007 |
1844 | 1844 | */ |
@@ -2389,6 +2389,7 @@ discard block |
||
2389 | 2389 | * Display score data about a survey question |
2390 | 2390 | * @param array Question info |
2391 | 2391 | * @param integer The offset of results shown |
2392 | + * @param integer $offset |
|
2392 | 2393 | * @return void (direct output) |
2393 | 2394 | */ |
2394 | 2395 | public static function display_question_report_score($survey_data, $question, $offset) |
@@ -3024,7 +3025,7 @@ discard block |
||
3024 | 3025 | * Quite similar to display_complete_report(), returns an HTML string |
3025 | 3026 | * that can be used in a csv file |
3026 | 3027 | * @todo consider merging this function with display_complete_report |
3027 | - * @return string The contents of a csv file |
|
3028 | + * @return false|null The contents of a csv file |
|
3028 | 3029 | * @author Patrick Cool <[email protected]>, Ghent University |
3029 | 3030 | * @version February 2007 |
3030 | 3031 | */ |
@@ -3246,7 +3247,7 @@ discard block |
||
3246 | 3247 | * @param array User's answers |
3247 | 3248 | * @param mixed User ID or user details as string - Used as a string in the result string |
3248 | 3249 | * @param boolean Whether to display user fields or not |
3249 | - * @return string One line of the csv file |
|
3250 | + * @return string[] One line of the csv file |
|
3250 | 3251 | */ |
3251 | 3252 | public static function export_complete_report_row_xls( |
3252 | 3253 | $survey_data, |
@@ -3552,6 +3553,7 @@ discard block |
||
3552 | 3553 | * |
3553 | 3554 | * @param integer Survey ID |
3554 | 3555 | * @param integer Question ID |
3556 | + * @param integer $survey_id |
|
3555 | 3557 | * @return Array Array containing all answers of all users, grouped by user |
3556 | 3558 | * |
3557 | 3559 | * @author Patrick Cool <[email protected]>, Ghent University |
@@ -3846,7 +3848,7 @@ discard block |
||
3846 | 3848 | |
3847 | 3849 | /** |
3848 | 3850 | * @param $params |
3849 | - * @return bool|int |
|
3851 | + * @return false|string |
|
3850 | 3852 | */ |
3851 | 3853 | public static function save_invitation($params) |
3852 | 3854 | { |
@@ -3900,6 +3902,7 @@ discard block |
||
3900 | 3902 | * |
3901 | 3903 | * @param int invitedUser - the userId (course user) or emailaddress of additional user |
3902 | 3904 | * $param string $invitation_code - the unique invitation code for the URL |
3905 | + * @param string|null $invitation_text |
|
3903 | 3906 | * @return void |
3904 | 3907 | */ |
3905 | 3908 | public static function send_invitation_mail($invitedUser, $invitation_code, $invitation_title, $invitation_text) |
@@ -4794,7 +4797,7 @@ discard block |
||
4794 | 4797 | * @author Isaac Flores Paz <[email protected]> |
4795 | 4798 | * @param int $user_id - User ID |
4796 | 4799 | * @param string $survey_code |
4797 | - * @param int $user_id_answer - User in survey answer table (user id or anonymus) |
|
4800 | + * @param int $user_answer - User in survey answer table (user id or anonymus) |
|
4798 | 4801 | * |
4799 | 4802 | * @return boolean |
4800 | 4803 | */ |
@@ -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, |
@@ -588,6 +593,8 @@ discard block |
||
588 | 593 | * @param int Whether this answer is correct (1) or not (0) |
589 | 594 | * @param string Coordinates of this point (e.g. 123;324) |
590 | 595 | * @param bool update results? |
596 | + * @param integer $exe_id |
|
597 | + * @param integer $correct |
|
591 | 598 | * @return boolean Result of the insert query |
592 | 599 | * @uses Course code and user_id from global scope $_cid and $_user |
593 | 600 | */ |
@@ -800,11 +807,11 @@ discard block |
||
800 | 807 | /** |
801 | 808 | * Save the new message for one event and for one language |
802 | 809 | * |
803 | - * @param string $eventName |
|
810 | + * @param string $event_name |
|
804 | 811 | * @param array $users |
805 | 812 | * @param string $message |
806 | 813 | * @param string $subject |
807 | - * @param string $eventMessageLanguage |
|
814 | + * @param string $event_message_language |
|
808 | 815 | * @param int $activated |
809 | 816 | */ |
810 | 817 | public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated) |
@@ -938,10 +945,10 @@ discard block |
||
938 | 945 | } |
939 | 946 | |
940 | 947 | /** |
941 | - * @param $user_id |
|
948 | + * @param integer $user_id |
|
942 | 949 | * @param $exerciseId |
943 | - * @param $lp_id |
|
944 | - * @param $lp_item_id |
|
950 | + * @param integer $lp_id |
|
951 | + * @param integer $lp_item_id |
|
945 | 952 | * @return int |
946 | 953 | */ |
947 | 954 | public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id) |
@@ -1118,6 +1125,7 @@ discard block |
||
1118 | 1125 | * @param int exercise id |
1119 | 1126 | * @param int $courseId |
1120 | 1127 | * @param int session id |
1128 | + * @param integer $user_id |
|
1121 | 1129 | * @return array with the results |
1122 | 1130 | * |
1123 | 1131 | */ |
@@ -1213,6 +1221,7 @@ discard block |
||
1213 | 1221 | * @param int exercise id |
1214 | 1222 | * @param int $courseId |
1215 | 1223 | * @param int session id |
1224 | + * @param integer $user_id |
|
1216 | 1225 | * @return array with the results |
1217 | 1226 | * |
1218 | 1227 | */ |
@@ -1301,6 +1310,8 @@ discard block |
||
1301 | 1310 | * @param int lp id |
1302 | 1311 | * @param int lp item id |
1303 | 1312 | * @param string order asc or desc |
1313 | + * @param integer $courseId |
|
1314 | + * @param string $order |
|
1304 | 1315 | * @return array with the results |
1305 | 1316 | * |
1306 | 1317 | */ |
@@ -1367,7 +1378,7 @@ discard block |
||
1367 | 1378 | * @param int exercise id |
1368 | 1379 | * @param int $courseId |
1369 | 1380 | * @param int session id |
1370 | - * @return array with the results |
|
1381 | + * @return string with the results |
|
1371 | 1382 | * |
1372 | 1383 | */ |
1373 | 1384 | public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0) |
@@ -1538,7 +1549,7 @@ discard block |
||
1538 | 1549 | * @param int exercise id |
1539 | 1550 | * @param int course id |
1540 | 1551 | * @param int session id |
1541 | - * @return array with the results |
|
1552 | + * @return integer with the results |
|
1542 | 1553 | * |
1543 | 1554 | */ |
1544 | 1555 | public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0) |
@@ -209,11 +209,11 @@ discard block |
||
209 | 209 | /** |
210 | 210 | * Gives a list of people online now (and in the last $valid minutes) |
211 | 211 | * |
212 | - * @param $from |
|
212 | + * @param integer $from |
|
213 | 213 | * @param $number_of_items |
214 | 214 | * @param null $column |
215 | 215 | * @param null $direction |
216 | - * @param null $time_limit |
|
216 | + * @param integer $time_limit |
|
217 | 217 | * @param bool $friends |
218 | 218 | * @return array|bool For each line, a list of user IDs and login dates, or FALSE on error or empty results |
219 | 219 | */ |
@@ -435,6 +435,9 @@ discard block |
||
435 | 435 | } |
436 | 436 | } |
437 | 437 | |
438 | +/** |
|
439 | + * @param integer $uid |
|
440 | + */ |
|
438 | 441 | function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null) |
439 | 442 | { |
440 | 443 | if (empty($coursecode)) { |