@@ -121,6 +121,9 @@ |
||
121 | 121 | return $form->isSubmitted() == false || $form->validate(); |
122 | 122 | } |
123 | 123 | |
124 | + /** |
|
125 | + * @param string $format |
|
126 | + */ |
|
124 | 127 | function get_ceiling($format = null) |
125 | 128 | { |
126 | 129 | $result = Request::get('ceiling'); |
@@ -118,7 +118,7 @@ discard block |
||
118 | 118 | |
119 | 119 | /** |
120 | 120 | * This function retrieves the existing permissions of a user, group or role. |
121 | -* @param $content are we retrieving the rights of a user, a group or a role (the database depends on it) |
|
121 | +* @param string $content are we retrieving the rights of a user, a group or a role (the database depends on it) |
|
122 | 122 | * @param $id the id of the user, group or role |
123 | 123 | * @author Patrick Cool <[email protected]>, Ghent University |
124 | 124 | * @version 1.0 |
@@ -526,7 +526,7 @@ discard block |
||
526 | 526 | |
527 | 527 | /** |
528 | 528 | * This function gets all the roles that are defined |
529 | -* @param $content are we finding the roles for a user or a group (the database depends on it) |
|
529 | +* @param string $content are we finding the roles for a user or a group (the database depends on it) |
|
530 | 530 | * @param $id the id of the user or group |
531 | 531 | * @param string Deprecated parameter allowing use of 'platform' scope - the corresponding tables don't exist anymore so the scope is always set to 'course' |
532 | 532 | * @return array that contains the name of the roles the user has |
@@ -84,7 +84,7 @@ |
||
84 | 84 | } |
85 | 85 | |
86 | 86 | /** |
87 | - * @param $directoryPath |
|
87 | + * @param string $directoryPath |
|
88 | 88 | * @return bool |
89 | 89 | */ |
90 | 90 | function deleteDirectory($directoryPath) |
@@ -137,7 +137,7 @@ |
||
137 | 137 | /** |
138 | 138 | * Get a list of users of which the given conditions match with a LIKE '%cond%' |
139 | 139 | * @param array $conditions a list of condition (exemple : status=>STUDENT) |
140 | - * @param array $order_by a list of fields on which sort |
|
140 | + * @param string[] $order_by a list of fields on which sort |
|
141 | 141 | * @return array An array with all users of the platform. |
142 | 142 | * @todo optional course code parameter, optional sorting parameters... |
143 | 143 | *@todo Use the UserManager class |
@@ -370,7 +370,7 @@ discard block |
||
370 | 370 | * Register a user into a queue for a session |
371 | 371 | * @param $userId |
372 | 372 | * @param $sessionId |
373 | - * @return bool|int |
|
373 | + * @return false|string |
|
374 | 374 | */ |
375 | 375 | public function addToQueue($userId, $sessionId) |
376 | 376 | { |
@@ -396,7 +396,7 @@ discard block |
||
396 | 396 | * Register message with type and status |
397 | 397 | * @param $mailId |
398 | 398 | * @param $userId |
399 | - * @param $sessionId |
|
399 | + * @param integer $sessionId |
|
400 | 400 | * @return bool|int |
401 | 401 | */ |
402 | 402 | public function saveLastMessage($mailId, $userId, $sessionId) |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | |
510 | 510 | /** |
511 | 511 | * Check if session is open for subscription |
512 | - * @param $sessionId |
|
512 | + * @param integer $sessionId |
|
513 | 513 | * @param string $fieldVariable |
514 | 514 | * @return bool |
515 | 515 | */ |
@@ -531,8 +531,8 @@ discard block |
||
531 | 531 | |
532 | 532 | /** |
533 | 533 | * Check if user is in the session's target group based on its area |
534 | - * @param $userId |
|
535 | - * @param $sessionId |
|
534 | + * @param integer $userId |
|
535 | + * @param integer $sessionId |
|
536 | 536 | * @param string $userFieldVariable |
537 | 537 | * @param string $sessionFieldVariable |
538 | 538 | * @return bool |
@@ -1002,7 +1002,7 @@ discard block |
||
1002 | 1002 | /** |
1003 | 1003 | * Return the session details data from a session ID (including the extra |
1004 | 1004 | * fields used for the advanced subscription mechanism) |
1005 | - * @param $sessionId |
|
1005 | + * @param integer $sessionId |
|
1006 | 1006 | * @return bool|mixed |
1007 | 1007 | */ |
1008 | 1008 | public function getSessionDetails($sessionId) |
@@ -1102,7 +1102,7 @@ discard block |
||
1102 | 1102 | |
1103 | 1103 | /** |
1104 | 1104 | * Return the url to go to session |
1105 | - * @param $sessionId |
|
1105 | + * @param integer $sessionId |
|
1106 | 1106 | * |
1107 | 1107 | * @return string |
1108 | 1108 | */ |
@@ -213,7 +213,8 @@ |
||
213 | 213 | /** |
214 | 214 | * Returns a meeting "join" URL |
215 | 215 | * @param string The name of the meeting (usually the course code) |
216 | - * @return mixed The URL to join the meeting, or false on error |
|
216 | + * @param false|string $meetingId |
|
217 | + * @return false|null The URL to join the meeting, or false on error |
|
217 | 218 | * @todo implement moderator pass |
218 | 219 | * @assert ('') === false |
219 | 220 | * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false |
@@ -36,6 +36,11 @@ |
||
36 | 36 | private $_pass; |
37 | 37 | private $_url; |
38 | 38 | |
39 | + /** |
|
40 | + * @param string $host |
|
41 | + * @param string $user |
|
42 | + * @param string $pass |
|
43 | + */ |
|
39 | 44 | public function __construct($host, $user, $pass) |
40 | 45 | { |
41 | 46 | $this->_user = urlencode($user); |
@@ -27,6 +27,9 @@ discard block |
||
27 | 27 | */ |
28 | 28 | class OpenMeetingsRestService |
29 | 29 | { |
30 | + /** |
|
31 | + * @param string $request |
|
32 | + */ |
|
30 | 33 | function call($request, $returnAttribute = "return") |
31 | 34 | { |
32 | 35 | // This will allow you to view errors in the browser |
@@ -121,6 +124,9 @@ discard block |
||
121 | 124 | |
122 | 125 | } |
123 | 126 | |
127 | + /** |
|
128 | + * @param DOMDocument $node |
|
129 | + */ |
|
124 | 130 | function getArray($node) |
125 | 131 | { |
126 | 132 | if (is_null($node) || !is_object($node)) { |
@@ -99,7 +99,7 @@ |
||
99 | 99 | /** |
100 | 100 | * Gets a string from a boolean attribute |
101 | 101 | * @param string $attribute Name of the attribute |
102 | - * @param mixed $voidReturn What to return if the value is not defined |
|
102 | + * @param string $voidReturn What to return if the value is not defined |
|
103 | 103 | * @return string The boolean value expressed as string ('true' or 'false') |
104 | 104 | */ |
105 | 105 | public function getString($attribute, $voidReturn = false) |