@@ -126,6 +126,9 @@ discard block |
||
126 | 126 | } |
127 | 127 | |
128 | 128 | /// recursively go through the forums and return group entity |
129 | +/** |
|
130 | + * @return integer |
|
131 | + */ |
|
129 | 132 | function gcforums_get_forum_in_group($entity_guid_static, $entity_guid) { |
130 | 133 | $entity = get_entity($entity_guid); |
131 | 134 | // (base) stop recursing when we reach group guid |
@@ -220,6 +223,9 @@ discard block |
||
220 | 223 | |
221 | 224 | |
222 | 225 | |
226 | +/** |
|
227 | + * @param ElggEntity $entity |
|
228 | + */ |
|
223 | 229 | function assemble_forum_breadcrumb($entity) { |
224 | 230 | $forum_guid = $entity->guid; |
225 | 231 | if ($entity instanceof ElggGroup) { |
@@ -511,6 +517,7 @@ discard block |
||
511 | 517 | * TOTAL_POST : 1 |
512 | 518 | * TOTAL_TOPICS : 2 |
513 | 519 | * RECENT_POST : 3 |
520 | + * @param integer $type |
|
514 | 521 | */ |
515 | 522 | function get_forums_statistics_information($container_guid, $type) { |
516 | 523 | $dbprefix = elgg_get_config('dbprefix'); |
@@ -662,6 +669,10 @@ discard block |
||
662 | 669 | |
663 | 670 | |
664 | 671 | |
672 | +/** |
|
673 | + * @param integer|null $forum_guid |
|
674 | + * @param integer|null $group_guid |
|
675 | + */ |
|
665 | 676 | function gcforums_menu_buttons($forum_guid, $group_guid, $is_topic=false) { |
666 | 677 | // main page if forum_guid is not present |
667 | 678 | elgg_load_css('gcforums-css'); |
@@ -446,7 +446,7 @@ |
||
446 | 446 | * @param int $group_guid the group GUID |
447 | 447 | * @param string $email the email address |
448 | 448 | * |
449 | - * @return boolean|string the invite code, or false on failure |
|
449 | + * @return string|false the invite code, or false on failure |
|
450 | 450 | */ |
451 | 451 | function group_tools_generate_email_invite_code($group_guid, $email) { |
452 | 452 | $result = false; |
@@ -939,7 +939,7 @@ discard block |
||
939 | 939 | * @param string $type |
940 | 940 | * @param string $return |
941 | 941 | * @param array $params |
942 | - * @return bool |
|
942 | + * @return false|null |
|
943 | 943 | */ |
944 | 944 | function discussion_comment_override($hook, $type, $return, $params) { |
945 | 945 | if (elgg_instanceof($params['entity'], 'object', 'groupforumtopic')) { |
@@ -1290,7 +1290,7 @@ discard block |
||
1290 | 1290 | /** |
1291 | 1291 | * Runs unit tests for groups |
1292 | 1292 | * |
1293 | - * @return array |
|
1293 | + * @return string[] |
|
1294 | 1294 | */ |
1295 | 1295 | function groups_test($hook, $type, $value, $params) { |
1296 | 1296 | global $CONFIG; |
@@ -472,7 +472,7 @@ |
||
472 | 472 | /** |
473 | 473 | * Runs unit tests for the wire |
474 | 474 | * |
475 | - * @return array |
|
475 | + * @return string[] |
|
476 | 476 | */ |
477 | 477 | function thewire_test($hook, $type, $value, $params) { |
478 | 478 | global $CONFIG; |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @param string $type |
63 | 63 | * @param bool $value |
64 | 64 | * @param array $params |
65 | - * @return bool |
|
65 | + * @return null|boolean |
|
66 | 66 | */ |
67 | 67 | function uservalidationbyemail_disable_new_user($hook, $type, $value, $params) { |
68 | 68 | $user = elgg_extract('user', $params); |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | * Checks if an account is validated |
156 | 156 | * |
157 | 157 | * @params array $credentials The username and password |
158 | - * @return bool |
|
158 | + * @return boolean|null |
|
159 | 159 | */ |
160 | 160 | function uservalidationbyemail_check_auth_attempt($credentials) { |
161 | 161 | |
@@ -234,7 +234,7 @@ discard block |
||
234 | 234 | * @param string $event |
235 | 235 | * @param string $type |
236 | 236 | * @param ElggUser $user |
237 | - * @return bool |
|
237 | + * @return false|null |
|
238 | 238 | * |
239 | 239 | * @throws LoginException |
240 | 240 | */ |
@@ -78,7 +78,7 @@ |
||
78 | 78 | * Download an attachment: thewire_image/download/<guid>/<title> |
79 | 79 | * |
80 | 80 | * @param array $page From the page_handler function |
81 | - * @return bool |
|
81 | + * @return boolean|null |
|
82 | 82 | */ |
83 | 83 | function thewire_image_page_handler($page) { |
84 | 84 | gatekeeper(); |