@@ -82,7 +82,7 @@ |
||
| 82 | 82 | * Download an attachment: thewire_image/download/<guid>/<title> |
| 83 | 83 | * |
| 84 | 84 | * @param array $page From the page_handler function |
| 85 | - * @return bool |
|
| 85 | + * @return boolean|null |
|
| 86 | 86 | */ |
| 87 | 87 | function thewire_image_page_handler($page) { |
| 88 | 88 | |
@@ -606,6 +606,10 @@ |
||
| 606 | 606 | |
| 607 | 607 | |
| 608 | 608 | /// recursively go through the nested forums to create the breadcrumb |
| 609 | +/** |
|
| 610 | + * @param integer $forum_guid |
|
| 611 | + * @param integer $recurse_forum_guid |
|
| 612 | + */ |
|
| 609 | 613 | function assemble_nested_forums($breadcrumb, $forum_guid, $recurse_forum_guid) { |
| 610 | 614 | $lang = get_current_language(); |
| 611 | 615 | $entity = get_entity($recurse_forum_guid); |
@@ -82,7 +82,7 @@ |
||
| 82 | 82 | * |
| 83 | 83 | * @param int $guid The GUID |
| 84 | 84 | * |
| 85 | - * @return \ElggUser|false |
|
| 85 | + * @return ElggEntity |
|
| 86 | 86 | */ |
| 87 | 87 | function get_user($guid) { |
| 88 | 88 | return _elgg_services()->entityTable->get($guid, 'user'); |
@@ -69,6 +69,10 @@ |
||
| 69 | 69 | return delete_data("DELETE FROM pleio_request_access WHERE id = {$this->id}"); |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | + /** |
|
| 73 | + * @param string $subject |
|
| 74 | + * @param string $body |
|
| 75 | + */ |
|
| 72 | 76 | private function sendEmail($subject, $body, $params = null) { |
| 73 | 77 | $site = elgg_get_site_entity(); |
| 74 | 78 | |
@@ -2,6 +2,10 @@ |
||
| 2 | 2 | namespace ModPleio; |
| 3 | 3 | |
| 4 | 4 | class Helpers { |
| 5 | + |
|
| 6 | + /** |
|
| 7 | + * @return string |
|
| 8 | + */ |
|
| 5 | 9 | public static function generateUsername($username) { |
| 6 | 10 | $hidden = access_show_hidden_entities(true); |
| 7 | 11 | |
@@ -109,6 +109,9 @@ |
||
| 109 | 109 | false |
| 110 | 110 | ); |
| 111 | 111 | |
| 112 | +/** |
|
| 113 | + * @param ElggUser $user_entity |
|
| 114 | + */ |
|
| 112 | 115 | function wires_foreach($wire_posts, $user_entity) |
| 113 | 116 | { |
| 114 | 117 | foreach ($wire_posts as $wire_post) { |
@@ -48,7 +48,7 @@ |
||
| 48 | 48 | * @param mixed $var Anything that does not include an object (strings, ints, arrays) |
| 49 | 49 | * This includes multi-dimensional arrays. |
| 50 | 50 | * |
| 51 | - * @return mixed The filtered result - everything will be strings |
|
| 51 | + * @return string The filtered result - everything will be strings |
|
| 52 | 52 | */ |
| 53 | 53 | function filter_tags($var) { |
| 54 | 54 | return elgg_trigger_plugin_hook('validate', 'input', null, $var); |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | * @param int $access_id Public/private etc |
| 259 | 259 | * @param int $parent_guid Parent post guid (if any) |
| 260 | 260 | * @param string $method The method (default: 'site') |
| 261 | - * @return guid or false if failure |
|
| 261 | + * @return integer or false if failure |
|
| 262 | 262 | */ |
| 263 | 263 | function thewire_save_post($text, $userid, $access_id, $parent_guid = 0, $method = "site") { |
| 264 | 264 | $post = new ElggObject(); |
@@ -473,7 +473,7 @@ discard block |
||
| 473 | 473 | /** |
| 474 | 474 | * Runs unit tests for the wire |
| 475 | 475 | * |
| 476 | - * @return array |
|
| 476 | + * @return string[] |
|
| 477 | 477 | */ |
| 478 | 478 | function thewire_test($hook, $type, $value, $params) { |
| 479 | 479 | global $CONFIG; |
@@ -85,6 +85,9 @@ |
||
| 85 | 85 | false |
| 86 | 86 | ); |
| 87 | 87 | |
| 88 | +/** |
|
| 89 | + * @param ElggUser $user_entity |
|
| 90 | + */ |
|
| 88 | 91 | function foreach_blogs($blogs, $user_entity, $lang) |
| 89 | 92 | { |
| 90 | 93 | foreach ($blogs as $blog_post) { |