@@ -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) { |
@@ -236,6 +236,7 @@ discard block |
||
| 236 | 236 | * @param PENSRequest Original collect request |
| 237 | 237 | * @param PENSResponse Reponse to send in the receipt or the alert |
| 238 | 238 | * @param string Mode (alert | receipt) |
| 239 | + * @param string $mode |
|
| 239 | 240 | * @return PENSResponse Response |
| 240 | 241 | */ |
| 241 | 242 | protected function sendAlertOrReceipt($request, $response, $mode) { |
@@ -283,6 +284,7 @@ discard block |
||
| 283 | 284 | * |
| 284 | 285 | * @param PENSRequest Original collect request |
| 285 | 286 | * @param PENSResponse Response to send in the receipt |
| 287 | + * @param PENSResponse $receipt |
|
| 286 | 288 | * @return PENSResponse Response |
| 287 | 289 | */ |
| 288 | 290 | protected function sendReceipt($request, $receipt) { |
@@ -294,6 +296,7 @@ discard block |
||
| 294 | 296 | * |
| 295 | 297 | * @param PENSRequest Original collect request |
| 296 | 298 | * @param string Path to the package on the hard drive |
| 299 | + * @param string $path_to_package |
|
| 297 | 300 | */ |
| 298 | 301 | protected function processPackage($request, $path_to_package) { |
| 299 | 302 | return $this->_package_handler->processPackage($request, $path_to_package); |
@@ -76,6 +76,11 @@ |
||
| 76 | 76 | return PENSRequestFactory::createPENSRequest($myargs); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | + /** |
|
| 80 | + * @param string $key |
|
| 81 | + * @param string|null $value |
|
| 82 | + * @param integer $code |
|
| 83 | + */ |
|
| 79 | 84 | public function exceptionTestForValue($key, $value, $code) { |
| 80 | 85 | try { |
| 81 | 86 | $myargs = $this->args; |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | /** |
| 58 | 58 | * Handle the subscribe action. |
| 59 | 59 | * |
| 60 | - * @return bool |
|
| 60 | + * @return null|boolean |
|
| 61 | 61 | */ |
| 62 | 62 | function action_subscribe_user() |
| 63 | 63 | { |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | |
| 152 | 152 | /** |
| 153 | 153 | * |
| 154 | - * @param type $course_code |
|
| 154 | + * @param string $course_code |
|
| 155 | 155 | * @return type |
| 156 | 156 | */ |
| 157 | 157 | function retrieve_course($course_code) |
@@ -40,11 +40,19 @@ |
||
| 40 | 40 | return isset($_GET[$key]) ? $_GET[$key] : $default; |
| 41 | 41 | } |
| 42 | 42 | |
| 43 | + /** |
|
| 44 | + * @param string $key |
|
| 45 | + * |
|
| 46 | + * @return string |
|
| 47 | + */ |
|
| 43 | 48 | public static function server($key, $default = '') |
| 44 | 49 | { |
| 45 | 50 | return isset($_SERVER[$key]) ? $_SERVER[$key] : $default; |
| 46 | 51 | } |
| 47 | 52 | |
| 53 | + /** |
|
| 54 | + * @param string $name |
|
| 55 | + */ |
|
| 48 | 56 | public static function get_lang($name) |
| 49 | 57 | { |
| 50 | 58 | return SearchCoursePlugin::create()->get_lang($name); |
@@ -94,7 +94,7 @@ |
||
| 94 | 94 | /** |
| 95 | 95 | * @param array $templates |
| 96 | 96 | * |
| 97 | - * @return null |
|
| 97 | + * @return null|string |
|
| 98 | 98 | */ |
| 99 | 99 | public function formatTemplates($templates) |
| 100 | 100 | { |
@@ -84,7 +84,7 @@ |
||
| 84 | 84 | |
| 85 | 85 | /** |
| 86 | 86 | * Available driver list. |
| 87 | - * @return array |
|
| 87 | + * @return string[] |
|
| 88 | 88 | */ |
| 89 | 89 | private function getDefaultDriverList() |
| 90 | 90 | { |