@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | * @param string $return_value current return value |
158 | 158 | * @param array $params hook parameters |
159 | 159 | * |
160 | - * @return array |
|
160 | + * @return string |
|
161 | 161 | */ |
162 | 162 | function widget_manager_register_widget_menu($hook_name, $entity_type, $return_value, $params) { |
163 | 163 | $widget = $params['entity']; |
@@ -248,7 +248,7 @@ discard block |
||
248 | 248 | * @param string $return_value current return value |
249 | 249 | * @param array $params hook parameters |
250 | 250 | * |
251 | - * @return array |
|
251 | + * @return string |
|
252 | 252 | */ |
253 | 253 | function widget_manager_register_extras_menu($hook_name, $entity_type, $return_value, $params) { |
254 | 254 | if (!elgg_is_logged_in()) { |
@@ -339,7 +339,7 @@ discard block |
||
339 | 339 | * @param string $return_value current return value |
340 | 340 | * @param array $params hook parameters |
341 | 341 | * |
342 | - * @return boolean |
|
342 | + * @return boolean|string |
|
343 | 343 | */ |
344 | 344 | function widget_manager_widget_layout_permissions_check($hook_name, $entity_type, $return_value, $params) { |
345 | 345 | $page_owner = elgg_extract("page_owner", $params); |
@@ -577,7 +577,7 @@ discard block |
||
577 | 577 | * @param string $return_value current return value |
578 | 578 | * @param array $params hook parameters |
579 | 579 | * |
580 | - * @return boolean |
|
580 | + * @return string|boolean |
|
581 | 581 | */ |
582 | 582 | function widget_manager_permissions_check_site_hook_handler($hook_name, $entity_type, $return_value, $params) { |
583 | 583 | $user = elgg_extract("user", $params); |
@@ -602,7 +602,7 @@ discard block |
||
602 | 602 | * @param string $return_value current return value |
603 | 603 | * @param array $params hook parameters |
604 | 604 | * |
605 | - * @return boolean |
|
605 | + * @return string|boolean |
|
606 | 606 | */ |
607 | 607 | function widget_manager_permissions_check_object_hook_handler($hook_name, $entity_type, $return_value, $params) { |
608 | 608 | $user = elgg_extract("user", $params); |
@@ -725,7 +725,7 @@ discard block |
||
725 | 725 | * @param bool $return_value current return value |
726 | 726 | * @param array $params hook parameters |
727 | 727 | * |
728 | - * @return bool |
|
728 | + * @return boolean|null |
|
729 | 729 | */ |
730 | 730 | function widget_manager_all_widget_settings_hook_handler($hook_name, $entity_type, $return_value, $params) { |
731 | 731 | if (empty($params) || !is_array($params)) { |
@@ -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); |
@@ -13,6 +13,9 @@ |
||
13 | 13 | private $before = null; |
14 | 14 | private $limit = null; |
15 | 15 | |
16 | + /** |
|
17 | + * @param string $object_type |
|
18 | + */ |
|
16 | 19 | function __construct($object_type, $subtype = false, $guid = null, |
17 | 20 | $since = null, $before = null, $limit = null, $resume = null, |
18 | 21 | $sort = false) { |
@@ -10,6 +10,12 @@ discard block |
||
10 | 10 | /* |
11 | 11 | * Packs the language variables for a single language into a single string. |
12 | 12 | */ |
13 | +/** |
|
14 | + * @param string|null $lwc |
|
15 | + * @param string|null $lwe |
|
16 | + * @param string|null $lop |
|
17 | + * @param string|null $lang |
|
18 | + */ |
|
13 | 19 | function mm_pack_language($lwc, $lwe, $lop, $lang) |
14 | 20 | { |
15 | 21 | $returner = ''; |
@@ -41,6 +47,9 @@ discard block |
||
41 | 47 | /* |
42 | 48 | * Unpacks a language string into an array of its component variable. |
43 | 49 | */ |
50 | +/** |
|
51 | + * @param string|null $lang |
|
52 | + */ |
|
44 | 53 | function mm_unpack_language($data_string, $lang) |
45 | 54 | { |
46 | 55 | $returner = array(); |
@@ -71,6 +80,11 @@ discard block |
||
71 | 80 | /* |
72 | 81 | * Packs the time (hour and minute) into a single string. |
73 | 82 | */ |
83 | +/** |
|
84 | + * @param string|null $hour |
|
85 | + * @param string|null $min |
|
86 | + * @param string|null $day |
|
87 | + */ |
|
74 | 88 | function mm_pack_time($hour, $min, $day) |
75 | 89 | { |
76 | 90 | $returner = ''; |
@@ -95,6 +109,9 @@ discard block |
||
95 | 109 | /* |
96 | 110 | * Unpacks the time into an array of hour and minute. |
97 | 111 | */ |
112 | +/** |
|
113 | + * @param string|null $day |
|
114 | + */ |
|
98 | 115 | function mm_unpack_time($data_string, $day) |
99 | 116 | { |
100 | 117 | $returner = array(); |
@@ -429,6 +446,10 @@ discard block |
||
429 | 446 | * Notify user function which uses messages_send() to send on site notifications and mail() to send e-mail. |
430 | 447 | * This is here because notify_user() is currently not working. |
431 | 448 | */ |
449 | +/** |
|
450 | + * @param string $title_en |
|
451 | + * @param string $title_fr |
|
452 | + */ |
|
432 | 453 | function mm_notify_user($recipient, $sender, $subject, $title_en,$title_fr,$body_en, $body_fr) { |
433 | 454 | //notify_user($recipient, $sender, $subject, $body, array(), 'email'); |
434 | 455 | |
@@ -619,6 +640,9 @@ discard block |
||
619 | 640 | /* |
620 | 641 | * Returns an accept button to a user who has received an offer if the mission is not full. |
621 | 642 | */ |
643 | +/** |
|
644 | + * @param ElggUser|null $applicant |
|
645 | + */ |
|
622 | 646 | function mm_finalize_button($mission, $applicant) { |
623 | 647 | $relationship_count = elgg_get_entities_from_relationship(array( |
624 | 648 | 'relationship' => 'mission_accepted', |
@@ -784,6 +808,9 @@ discard block |
||
784 | 808 | /* |
785 | 809 | * Check if the user is opted in to any of the opt-in options. |
786 | 810 | */ |
811 | +/** |
|
812 | + * @param ElggEntity|null $current_user |
|
813 | + */ |
|
787 | 814 | function check_if_opted_in($current_user) { |
788 | 815 | //Nick - adding additional checks for other opportunity types |
789 | 816 | if($current_user->opt_in_missions == 'gcconnex_profile:opt:yes') { |