@@ -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 | */ |
@@ -59,6 +59,9 @@ |
||
| 59 | 59 | $this->_bbbServerBaseUrl = CONFIG_SERVER_BASE_URL; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | + /** |
|
| 63 | + * @param string $url |
|
| 64 | + */ |
|
| 62 | 65 | private function _processXmlResponse($url){ |
| 63 | 66 | /* |
| 64 | 67 | A private utility method used by other public methods to process XML responses. |
@@ -324,6 +324,8 @@ |
||
| 324 | 324 | * @nvpStr is nvp string. |
| 325 | 325 | * returns an associtive array containing the response from the server. |
| 326 | 326 | * |
| 327 | + * @param string $methodName |
|
| 328 | + * @param string $nvpStr |
|
| 327 | 329 | */ |
| 328 | 330 | function hash_call($methodName, $nvpStr) |
| 329 | 331 | {
|
@@ -14,7 +14,7 @@ |
||
| 14 | 14 | /** |
| 15 | 15 | * create (a singleton function that ensures ClockworksmsPlugin instance is |
| 16 | 16 | * created only once. If it is already created, it returns the instance) |
| 17 | - * @return object ClockworksmsPlugin instance |
|
| 17 | + * @return ClockworksmsPlugin ClockworksmsPlugin instance |
|
| 18 | 18 | */ |
| 19 | 19 | public static function create() |
| 20 | 20 | { |
@@ -471,6 +471,8 @@ discard block |
||
| 471 | 471 | * |
| 472 | 472 | * @param string method Clockwork method to call (sms/credit) |
| 473 | 473 | * @param string data Content of HTTP POST |
| 474 | + * @param string $method |
|
| 475 | + * @param string $data |
|
| 474 | 476 | * |
| 475 | 477 | * @return string Response from Clockwork |
| 476 | 478 | * @author Martin Steel |
@@ -505,6 +507,7 @@ discard block |
||
| 505 | 507 | * |
| 506 | 508 | * @param string url URL to send to |
| 507 | 509 | * @param string data Data to POST |
| 510 | + * @param string $url |
|
| 508 | 511 | * @return string Response returned by server |
| 509 | 512 | * @author Martin Steel |
| 510 | 513 | */ |
@@ -631,7 +634,7 @@ discard block |
||
| 631 | 634 | * Check if a number is a valid MSISDN |
| 632 | 635 | * |
| 633 | 636 | * @param string $val Value to check |
| 634 | - * @return bool True if valid MSISDN |
|
| 637 | + * @return integer True if valid MSISDN |
|
| 635 | 638 | * @author James Inman |
| 636 | 639 | * @since 1.3.0 |
| 637 | 640 | * @todo Take an optional country code and check that the number starts with it |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | * @param int $courseId |
| 63 | 63 | * @param int $sessionId |
| 64 | 64 | * |
| 65 | - * @return array |
|
| 65 | + * @return string |
|
| 66 | 66 | */ |
| 67 | 67 | public function getUserAcceptedLegal($userId, $courseId, $sessionId) |
| 68 | 68 | { |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | * @param int $courseCode |
| 113 | 113 | * @param int $sessionId |
| 114 | 114 | * @param boolean $sendEmail Optional. Indicate whether the mail must be sent. Default is true |
| 115 | - * @return mixed |
|
| 115 | + * @return false|string |
|
| 116 | 116 | */ |
| 117 | 117 | public function saveUserLegal($userId, $courseCode, $sessionId, $sendEmail = true) |
| 118 | 118 | { |
@@ -218,7 +218,7 @@ discard block |
||
| 218 | 218 | * @param int $courseId |
| 219 | 219 | * @param int $sessionId |
| 220 | 220 | * |
| 221 | - * @return bool |
|
| 221 | + * @return boolean|null |
|
| 222 | 222 | */ |
| 223 | 223 | public function saveUserMailLegal($link, $userId, $courseId, $sessionId) |
| 224 | 224 | { |
@@ -14,7 +14,7 @@ |
||
| 14 | 14 | /** |
| 15 | 15 | * create (a singleton function that ensures KannelsmsPlugin instance is |
| 16 | 16 | * created only once. If it is already created, it returns the instance) |
| 17 | - * @return object KannelsmsPlugin instance |
|
| 17 | + * @return KannelsmsPlugin KannelsmsPlugin instance |
|
| 18 | 18 | */ |
| 19 | 19 | public static function create() |
| 20 | 20 | { |
@@ -138,6 +138,7 @@ discard block |
||
| 138 | 138 | * |
| 139 | 139 | * @param string key Your Kannel API Key |
| 140 | 140 | * @param array options Optional parameters for sending SMS |
| 141 | + * @param string $key |
|
| 141 | 142 | * @author Martin Steel |
| 142 | 143 | */ |
| 143 | 144 | public function __construct($key, array $options = array()) { |
@@ -471,6 +472,8 @@ discard block |
||
| 471 | 472 | * |
| 472 | 473 | * @param string method Kannel method to call (sms/credit) |
| 473 | 474 | * @param string data Content of HTTP POST |
| 475 | + * @param string $method |
|
| 476 | + * @param string $data |
|
| 474 | 477 | * |
| 475 | 478 | * @return string Response from Kannel |
| 476 | 479 | * @author Martin Steel |
@@ -505,6 +508,7 @@ discard block |
||
| 505 | 508 | * |
| 506 | 509 | * @param string url URL to send to |
| 507 | 510 | * @param string data Data to POST |
| 511 | + * @param string $url |
|
| 508 | 512 | * @return string Response returned by server |
| 509 | 513 | * @author Martin Steel |
| 510 | 514 | */ |
@@ -631,7 +635,7 @@ discard block |
||
| 631 | 635 | * Check if a number is a valid MSISDN |
| 632 | 636 | * |
| 633 | 637 | * @param string $val Value to check |
| 634 | - * @return bool True if valid MSISDN |
|
| 638 | + * @return integer True if valid MSISDN |
|
| 635 | 639 | * @author James Inman |
| 636 | 640 | * @since 1.3.0 |
| 637 | 641 | * @todo Take an optional country code and check that the number starts with it |
@@ -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 |