@@ -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)) { |
@@ -51,7 +51,6 @@ |
||
51 | 51 | * interface is passed as alias then every time that interface is requested the provided service will be returned. |
52 | 52 | * |
53 | 53 | * @param object $service |
54 | - * @param string $alias |
|
55 | 54 | * |
56 | 55 | * @return void |
57 | 56 | */ |
@@ -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); |
@@ -219,6 +219,9 @@ |
||
219 | 219 | return $arguments; |
220 | 220 | } |
221 | 221 | |
222 | + /** |
|
223 | + * @return string |
|
224 | + */ |
|
222 | 225 | private static function stripRestArg($argument) |
223 | 226 | { |
224 | 227 | if (strpos($argument, '...') === 0) { |
@@ -31,6 +31,10 @@ |
||
31 | 31 | /** @var int|null The number of lines, relative to the starting line. NULL means "to the end". */ |
32 | 32 | private $lineCount = null; |
33 | 33 | |
34 | + /** |
|
35 | + * @param integer $startingLine |
|
36 | + * @param integer $lineCount |
|
37 | + */ |
|
34 | 38 | public function __construct($startingLine, $lineCount = null, Description $description = null) |
35 | 39 | { |
36 | 40 | Assert::integerish($startingLine); |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | } |
64 | 64 | |
65 | 65 | /** |
66 | - * @param object|string $docblock A string containing the DocBlock to parse or an object supporting the |
|
66 | + * @param \ReflectionClass $docblock A string containing the DocBlock to parse or an object supporting the |
|
67 | 67 | * getDocComment method (such as a ReflectionClass object). |
68 | 68 | * @param Types\Context $context |
69 | 69 | * @param Location $location |
@@ -103,6 +103,10 @@ discard block |
||
103 | 103 | ); |
104 | 104 | } |
105 | 105 | |
106 | + /** |
|
107 | + * @param integer $tagName |
|
108 | + * @param string $handler |
|
109 | + */ |
|
106 | 110 | public function registerTagHandler($tagName, $handler) |
107 | 111 | { |
108 | 112 | $this->tagFactory->registerTagHandler($tagName, $handler); |
@@ -254,7 +258,7 @@ discard block |
||
254 | 258 | } |
255 | 259 | |
256 | 260 | /** |
257 | - * @param $tags |
|
261 | + * @param string $tags |
|
258 | 262 | * @return string |
259 | 263 | */ |
260 | 264 | private function filterTagBlock($tags) |
@@ -270,6 +270,9 @@ discard block |
||
270 | 270 | return self::mb_detect_encoding($var, array($encoding)) || false !== @iconv($encoding, $encoding, $var); |
271 | 271 | } |
272 | 272 | |
273 | + /** |
|
274 | + * @return string |
|
275 | + */ |
|
273 | 276 | public static function mb_detect_encoding($str, $encodingList = null, $strict = false) |
274 | 277 | { |
275 | 278 | if (null === $encodingList) { |
@@ -574,6 +577,9 @@ discard block |
||
574 | 577 | return $code; |
575 | 578 | } |
576 | 579 | |
580 | + /** |
|
581 | + * @param boolean $part |
|
582 | + */ |
|
577 | 583 | private static function getSubpart($pos, $part, $haystack, $encoding) |
578 | 584 | { |
579 | 585 | if (false === $pos) { |
@@ -621,6 +627,9 @@ discard block |
||
621 | 627 | return self::mb_convert_case($s[0], MB_CASE_UPPER, 'UTF-8'); |
622 | 628 | } |
623 | 629 | |
630 | + /** |
|
631 | + * @param string $file |
|
632 | + */ |
|
624 | 633 | private static function getData($file) |
625 | 634 | { |
626 | 635 | if (file_exists($file = __DIR__.'/Resources/unidata/'.$file.'.php')) { |
@@ -64,6 +64,7 @@ |
||
64 | 64 | } |
65 | 65 | |
66 | 66 | /** |
67 | + * @param string $content |
|
67 | 68 | * @return string Path to the new file |
68 | 69 | */ |
69 | 70 | private function createFile($content) |
@@ -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); |