@@ -164,6 +164,9 @@ discard block |
||
164 | 164 | static::notEmpty($value, $message); |
165 | 165 | } |
166 | 166 | |
167 | + /** |
|
168 | + * @param integer $value |
|
169 | + */ |
|
167 | 170 | public static function integer($value, $message = '') |
168 | 171 | { |
169 | 172 | if (!is_int($value)) { |
@@ -204,6 +207,9 @@ discard block |
||
204 | 207 | } |
205 | 208 | } |
206 | 209 | |
210 | + /** |
|
211 | + * @param boolean $value |
|
212 | + */ |
|
207 | 213 | public static function boolean($value, $message = '') |
208 | 214 | { |
209 | 215 | if (!is_bool($value)) { |
@@ -334,6 +340,9 @@ discard block |
||
334 | 340 | } |
335 | 341 | } |
336 | 342 | |
343 | + /** |
|
344 | + * @param null|\phpDocumentor\Reflection\DocBlock\DescriptionFactory $value |
|
345 | + */ |
|
337 | 346 | public static function notNull($value, $message = '') |
338 | 347 | { |
339 | 348 | if (null === $value) { |
@@ -363,6 +372,9 @@ discard block |
||
363 | 372 | } |
364 | 373 | } |
365 | 374 | |
375 | + /** |
|
376 | + * @param integer $value |
|
377 | + */ |
|
366 | 378 | public static function eq($value, $value2, $message = '') |
367 | 379 | { |
368 | 380 | if ($value2 != $value) { |
@@ -712,6 +724,9 @@ discard block |
||
712 | 724 | } |
713 | 725 | } |
714 | 726 | |
727 | + /** |
|
728 | + * @param string $value |
|
729 | + */ |
|
715 | 730 | public static function classExists($value, $message = '') |
716 | 731 | { |
717 | 732 | if (!class_exists($value)) { |
@@ -733,6 +748,9 @@ discard block |
||
733 | 748 | } |
734 | 749 | } |
735 | 750 | |
751 | + /** |
|
752 | + * @param string $value |
|
753 | + */ |
|
736 | 754 | public static function implementsInterface($value, $interface, $message = '') |
737 | 755 | { |
738 | 756 | if (!in_array($interface, class_implements($value))) { |
@@ -937,6 +955,9 @@ discard block |
||
937 | 955 | return mb_strwidth($value, $encoding); |
938 | 956 | } |
939 | 957 | |
958 | + /** |
|
959 | + * @param string $message |
|
960 | + */ |
|
940 | 961 | protected static function reportInvalidArgument($message) |
941 | 962 | { |
942 | 963 | throw new InvalidArgumentException($message); |
@@ -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); |
@@ -43,6 +43,9 @@ |
||
43 | 43 | /** @var string The version vector. */ |
44 | 44 | private $version = ''; |
45 | 45 | |
46 | + /** |
|
47 | + * @param string $version |
|
48 | + */ |
|
46 | 49 | public function __construct($version = null, Description $description = null) |
47 | 50 | { |
48 | 51 | Assert::nullOrStringNotEmpty($version); |
@@ -43,6 +43,9 @@ |
||
43 | 43 | /** @var string The version vector. */ |
44 | 44 | private $version = ''; |
45 | 45 | |
46 | + /** |
|
47 | + * @param string $version |
|
48 | + */ |
|
46 | 49 | public function __construct($version = null, Description $description = null) |
47 | 50 | { |
48 | 51 | Assert::nullOrStringNotEmpty($version); |
@@ -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') { |