@@ -357,7 +357,7 @@ |
||
357 | 357 | * @param int $delta |
358 | 358 | * @param int $numpoints |
359 | 359 | * @param bool $firsttime |
360 | - * @return int New bias |
|
360 | + * @return double New bias |
|
361 | 361 | */ |
362 | 362 | protected static function adapt($delta, $numpoints, $firsttime) { |
363 | 363 | # function adapt(delta,numpoints,firsttime): |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | * |
250 | 250 | * Returns false if $base is not absolute, otherwise an IRI. |
251 | 251 | * |
252 | - * @param IRI|string $base (Absolute) Base IRI |
|
252 | + * @param string $base (Absolute) Base IRI |
|
253 | 253 | * @param IRI|string $relative Relative IRI |
254 | 254 | * @return IRI|false |
255 | 255 | */ |
@@ -984,6 +984,7 @@ discard block |
||
984 | 984 | * Convert an IRI to a URI (or parts thereof) |
985 | 985 | * |
986 | 986 | * @param string|bool IRI to convert (or false from {@see get_iri}) |
987 | + * @param false|string $string |
|
987 | 988 | * @return string|false URI if IRI is valid, false otherwise. |
988 | 989 | */ |
989 | 990 | protected function to_uri($string) { |
@@ -232,7 +232,7 @@ |
||
232 | 232 | * |
233 | 233 | * @param array $request Request data (same form as {@see request_multiple}) |
234 | 234 | * @param boolean $merge_options Should we merge options as well? |
235 | - * @return array Request data |
|
235 | + * @return string Request data |
|
236 | 236 | */ |
237 | 237 | protected function merge_request($request, $merge_options = true) { |
238 | 238 | if ($this->url !== null) { |
@@ -170,7 +170,6 @@ |
||
170 | 170 | |
171 | 171 | /** |
172 | 172 | * Return the active logo of the portal, based on a series of settings |
173 | - * @param string $theme The name of the theme folder from web/css/themes/ |
|
174 | 173 | * @return string HTML string with logo as an HTML element |
175 | 174 | */ |
176 | 175 | function return_logo() |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | } |
100 | 100 | |
101 | 101 | /** |
102 | - * @param array $array |
|
102 | + * @param string[] $array |
|
103 | 103 | */ |
104 | 104 | public function set_tools_to_build($array) |
105 | 105 | { |
@@ -512,8 +512,6 @@ discard block |
||
512 | 512 | |
513 | 513 | /** |
514 | 514 | * Build a link category |
515 | - * @param int $id Internal link ID |
|
516 | - * @param int $courseId Internal course ID |
|
517 | 515 | * @return int |
518 | 516 | */ |
519 | 517 | public function build_link_category($category) |
@@ -146,7 +146,7 @@ |
||
146 | 146 | /** |
147 | 147 | * Read the CSV-file |
148 | 148 | * @param string $file Path to the CSV-file |
149 | - * @return array All course-information read from the file |
|
149 | + * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file |
|
150 | 150 | */ |
151 | 151 | function parse_csv_courses_data($file) |
152 | 152 | { |
@@ -671,7 +671,7 @@ discard block |
||
671 | 671 | * @param int $allDay is all day 'true' or 'false' |
672 | 672 | * @param string $title |
673 | 673 | * @param string $content |
674 | - * @param array $usersToSend |
|
674 | + * @param string[] $usersToSend |
|
675 | 675 | * @param array $attachmentArray |
676 | 676 | * @param array $attachmentCommentList |
677 | 677 | * @param string $comment |
@@ -679,7 +679,7 @@ discard block |
||
679 | 679 | * @param bool $addAnnouncement |
680 | 680 | * @param bool $updateContent |
681 | 681 | * |
682 | - * @return null|false |
|
682 | + * @return null|boolean |
|
683 | 683 | */ |
684 | 684 | public function editEvent( |
685 | 685 | $id, |
@@ -1380,6 +1380,7 @@ discard block |
||
1380 | 1380 | * Gets a single event |
1381 | 1381 | * |
1382 | 1382 | * @param int event id |
1383 | + * @param integer $id |
|
1383 | 1384 | * @return array |
1384 | 1385 | */ |
1385 | 1386 | public function get_event($id) |
@@ -20,7 +20,7 @@ discard block |
||
20 | 20 | } |
21 | 21 | |
22 | 22 | /** |
23 | - * @return array |
|
23 | + * @return string[] |
|
24 | 24 | */ |
25 | 25 | public static function get_tags() |
26 | 26 | { |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | * @param string $course_code |
43 | 43 | * @param int $session_id |
44 | 44 | * |
45 | - * @return mixed |
|
45 | + * @return string |
|
46 | 46 | */ |
47 | 47 | public static function parse_content($userId, $content, $course_code, $session_id = 0) |
48 | 48 | { |
@@ -230,7 +230,7 @@ discard block |
||
230 | 230 | * @param int $courseId |
231 | 231 | * @param int $userId |
232 | 232 | * |
233 | - * @return array |
|
233 | + * @return integer |
|
234 | 234 | */ |
235 | 235 | public static function getAnnouncementInfoById($announcementId, $courseId, $userId) |
236 | 236 | { |
@@ -450,7 +450,7 @@ discard block |
||
450 | 450 | * @param bool $sendToUsersInSession |
451 | 451 | * @param int $authorId |
452 | 452 | * |
453 | - * @return int false on failure, ID of the announcement on success |
|
453 | + * @return false|string false on failure, ID of the announcement on success |
|
454 | 454 | */ |
455 | 455 | public static function add_announcement( |
456 | 456 | $courseInfo, |
@@ -585,7 +585,7 @@ discard block |
||
585 | 585 | * @param string $file_comment |
586 | 586 | * @param bool $sendToUsersInSession |
587 | 587 | * |
588 | - * @return bool|int |
|
588 | + * @return false|string |
|
589 | 589 | */ |
590 | 590 | public static function add_group_announcement( |
591 | 591 | $title, |
@@ -826,7 +826,7 @@ discard block |
||
826 | 826 | |
827 | 827 | /** |
828 | 828 | * @param int $insert_id |
829 | - * @return bool |
|
829 | + * @return false|null |
|
830 | 830 | */ |
831 | 831 | public static function update_mail_sent($insert_id) |
832 | 832 | { |
@@ -846,6 +846,7 @@ discard block |
||
846 | 846 | * Gets all announcements from a user by course |
847 | 847 | * @param string course db |
848 | 848 | * @param int user id |
849 | + * @param integer $user_id |
|
849 | 850 | * @return array html with the content and count of announcements or false otherwise |
850 | 851 | */ |
851 | 852 | public static function get_all_annoucement_by_user_course($course_code, $user_id) |
@@ -1099,6 +1100,7 @@ discard block |
||
1099 | 1100 | * has been sent to |
1100 | 1101 | * @param string The tool (announcement, agenda, ...) |
1101 | 1102 | * @param int ID of the element of the corresponding type |
1103 | + * @param string $tool |
|
1102 | 1104 | * @return array Array of users and groups to whom the element has been sent |
1103 | 1105 | */ |
1104 | 1106 | public static function sent_to($tool, $id) |
@@ -1170,6 +1172,7 @@ discard block |
||
1170 | 1172 | * @param int announcement id |
1171 | 1173 | * @param string file comment |
1172 | 1174 | * @param array uploaded file $_FILES |
1175 | + * @param string|null $file_comment |
|
1173 | 1176 | * @return int -1 if failed, 0 if unknown (should not happen), 1 if success |
1174 | 1177 | */ |
1175 | 1178 | public static function add_announcement_attachment_file($announcement_id, $file_comment, $file) |
@@ -1228,6 +1231,8 @@ discard block |
||
1228 | 1231 | * @param int attach id |
1229 | 1232 | * @param array uploaded file $_FILES |
1230 | 1233 | * @param string file comment |
1234 | + * @param integer $id_attach |
|
1235 | + * @param string $file_comment |
|
1231 | 1236 | * @return int |
1232 | 1237 | */ |
1233 | 1238 | public static function edit_announcement_attachment_file($id_attach, $file, $file_comment) |
@@ -1271,6 +1271,7 @@ discard block |
||
1271 | 1271 | * Gets the list of courses a specific user is subscribed to |
1272 | 1272 | * @param int User ID |
1273 | 1273 | * @param boolean $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED |
1274 | + * @param integer $userid |
|
1274 | 1275 | * @return array Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d) |
1275 | 1276 | */ |
1276 | 1277 | function api_get_user_courses($userid, $fetch_session = true) |
@@ -3016,7 +3017,7 @@ discard block |
||
3016 | 3017 | * on the session visibility |
3017 | 3018 | * @param bool $tutor Whether to check if the user has the tutor role |
3018 | 3019 | * @param bool $coach Whether to check if the user has the coach role |
3019 | -* @return boolean true: the user has the rights to edit, false: he does not |
|
3020 | +* @return boolean|null true: the user has the rights to edit, false: he does not |
|
3020 | 3021 | */ |
3021 | 3022 | function api_is_allowed_to_session_edit($tutor = false, $coach = false) |
3022 | 3023 | { |
@@ -5197,6 +5198,7 @@ discard block |
||
5197 | 5198 | * @param string Whether we want a simple list (display a category) or |
5198 | 5199 | * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group' |
5199 | 5200 | * @param int Access URL's ID. Optional. Uses 1 by default, which is the unique URL |
5201 | + * @param string $cat |
|
5200 | 5202 | * @return array Array of database results for the current settings of the current access URL |
5201 | 5203 | */ |
5202 | 5204 | function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0) |
@@ -6590,7 +6592,7 @@ discard block |
||
6590 | 6592 | /** |
6591 | 6593 | * Returns an array of global configuration settings which should be ignored |
6592 | 6594 | * when printing the configuration settings screens |
6593 | - * @return array Array of strings, each identifying one of the excluded settings |
|
6595 | + * @return string[] Array of strings, each identifying one of the excluded settings |
|
6594 | 6596 | */ |
6595 | 6597 | function api_get_locked_settings() { |
6596 | 6598 | return array( |
@@ -6631,6 +6633,7 @@ discard block |
||
6631 | 6633 | * false if he isn't. If the user ID is given and is an integer, then the same |
6632 | 6634 | * ID is simply returned |
6633 | 6635 | * @param integer User ID |
6636 | + * @param integer $user_id |
|
6634 | 6637 | * @return boolean Integer User ID is logged in, or false otherwise |
6635 | 6638 | */ |
6636 | 6639 | function api_user_is_login($user_id = null) { |
@@ -7051,6 +7054,7 @@ discard block |
||
7051 | 7054 | /** |
7052 | 7055 | * Gets memory limit in bytes |
7053 | 7056 | * @param string The memory size (128M, 1G, 1000K, etc) |
7057 | + * @param string $mem |
|
7054 | 7058 | * @return int |
7055 | 7059 | * @assert (null) === false |
7056 | 7060 | * @assert ('1t') === 1099511627776 |