@@ -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 |
@@ -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) |
@@ -79,6 +79,7 @@ |
||
79 | 79 | * |
80 | 80 | * @param int Exception code |
81 | 81 | * @param string Message to display |
82 | + * @param integer $code |
|
82 | 83 | * @return PENSException Exception created |
83 | 84 | */ |
84 | 85 | public function __construct($code, $message = null) { |