@@ -12,6 +12,11 @@ |
||
12 | 12 | require_once($CONFIG->pluginspath.'event_calendar/models/model.php'); |
13 | 13 | |
14 | 14 | if( !function_exists('getLastDayOfMonth') ){ |
15 | + |
|
16 | + /** |
|
17 | + * @param string $month |
|
18 | + * @param string $year |
|
19 | + */ |
|
15 | 20 | function getLastDayOfMonth($month, $year) { |
16 | 21 | return idate('d', mktime(0, 0, 0, ($month + 1), 0, $year)); |
17 | 22 | } |
@@ -68,6 +68,10 @@ |
||
68 | 68 | * @return [ARRAY] [<ARRAY of user entities>] |
69 | 69 | * |
70 | 70 | */ |
71 | +/** |
|
72 | + * @param string $query_operand |
|
73 | + * @param integer $limit |
|
74 | + */ |
|
71 | 75 | function skill_search($query_array, $query_operand, $limit) |
72 | 76 | { |
73 | 77 | $options = array(); |
@@ -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'); |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | * Checks for invalid / external domains |
142 | 142 | * |
143 | 143 | * @param $domain <string> domain part of the user's email address |
144 | - * @return true if domain is invalid, false otherwise |
|
144 | + * @return boolean if domain is invalid, false otherwise |
|
145 | 145 | * |
146 | 146 | **/ |
147 | 147 | function checkInvalidDomain($dom) |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | * Array key is the character to remove and the associated item is what will replace it. |
196 | 196 | * |
197 | 197 | * @param $emailInput <string> users email address |
198 | - * @return always returns "" because we use the response text directly |
|
198 | + * @return string returns "" because we use the response text directly |
|
199 | 199 | * @author Matthew April <[email protected]> |
200 | 200 | */ |
201 | 201 |
@@ -194,7 +194,7 @@ discard block |
||
194 | 194 | * |
195 | 195 | * @param $domain <string> domain part of the user's email address |
196 | 196 | * @param $email <string> the user's full email address |
197 | - * @return true if domain is invalid, false otherwise |
|
197 | + * @return boolean if domain is invalid, false otherwise |
|
198 | 198 | * |
199 | 199 | **/ |
200 | 200 | function checkInvalidDomain($dom, $email){ |
@@ -251,7 +251,7 @@ discard block |
||
251 | 251 | * Array key is the character to remove and the associated item is what will replace it. |
252 | 252 | * |
253 | 253 | * @param $emailInput <string> users email address |
254 | - * @return always returns "" because we use the response text directly |
|
254 | + * @return string returns "" because we use the response text directly |
|
255 | 255 | * @author Matthew April <[email protected]> |
256 | 256 | */ |
257 | 257 |
@@ -561,7 +561,7 @@ |
||
561 | 561 | /** |
562 | 562 | * Return an array of fields which can be exported. |
563 | 563 | * |
564 | - * @return array |
|
564 | + * @return string[] |
|
565 | 565 | * @deprecated 1.9 Use toObject() |
566 | 566 | */ |
567 | 567 | public function getExportableValues() { |
@@ -561,7 +561,7 @@ |
||
561 | 561 | /** |
562 | 562 | * Return an array of fields which can be exported. |
563 | 563 | * |
564 | - * @return array |
|
564 | + * @return string[] |
|
565 | 565 | * @deprecated 1.9 Use toObject() |
566 | 566 | */ |
567 | 567 | public function getExportableValues() { |
@@ -724,6 +724,9 @@ |
||
724 | 724 | $this->message = $this->StripSlashes($_POST['message']); |
725 | 725 | } |
726 | 726 | |
727 | + /** |
|
728 | + * @param string $error |
|
729 | + */ |
|
727 | 730 | function add_error($error) |
728 | 731 | { |
729 | 732 | array_push($this->errors,$error); |
@@ -724,6 +724,9 @@ |
||
724 | 724 | $this->message = $this->StripSlashes($_POST['message']); |
725 | 725 | } |
726 | 726 | |
727 | + /** |
|
728 | + * @param string $error |
|
729 | + */ |
|
727 | 730 | function add_error($error) |
728 | 731 | { |
729 | 732 | array_push($this->errors,$error); |