@@ -552,7 +552,7 @@ discard block |
||
| 552 | 552 | * @param string $type |
| 553 | 553 | * @param bool $value |
| 554 | 554 | * @param array $params |
| 555 | - * @return true|null |
|
| 555 | + * @return boolean|null |
|
| 556 | 556 | * @access private |
| 557 | 557 | */ |
| 558 | 558 | function elgg_override_permissions($hook, $type, $value, $params) { |
@@ -589,7 +589,7 @@ discard block |
||
| 589 | 589 | * @param string $type |
| 590 | 590 | * @param array $value |
| 591 | 591 | * @param array $params |
| 592 | - * @return array |
|
| 592 | + * @return string[] |
|
| 593 | 593 | * |
| 594 | 594 | * @access private |
| 595 | 595 | */ |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | * |
| 140 | 140 | * @param string $action The action being performed |
| 141 | 141 | * |
| 142 | - * @return mixed True if valid or redirects. |
|
| 142 | + * @return boolean|null True if valid or redirects. |
|
| 143 | 143 | * @access private |
| 144 | 144 | */ |
| 145 | 145 | function action_gatekeeper($action) { |
@@ -175,7 +175,7 @@ discard block |
||
| 175 | 175 | * |
| 176 | 176 | * Note: Old secrets were hex encoded. |
| 177 | 177 | * |
| 178 | - * @return mixed The site secret hash or false |
|
| 178 | + * @return string|false The site secret hash or false |
|
| 179 | 179 | * @access private |
| 180 | 180 | * @todo Move to better file. |
| 181 | 181 | */ |
@@ -806,7 +806,7 @@ |
||
| 806 | 806 | * @param string $type |
| 807 | 807 | * @param \ElggUser $user |
| 808 | 808 | * |
| 809 | - * @return null|true |
|
| 809 | + * @return boolean|null |
|
| 810 | 810 | * @access private |
| 811 | 811 | */ |
| 812 | 812 | function _elgg_add_admin_widgets($event, $type, $user) { |
@@ -31,7 +31,7 @@ discard block |
||
| 31 | 31 | * |
| 32 | 32 | * @param int $id The id of the annotation object being retrieved. |
| 33 | 33 | * |
| 34 | - * @return \ElggAnnotation|false |
|
| 34 | + * @return ElggExtender |
|
| 35 | 35 | */ |
| 36 | 36 | function elgg_get_annotation_from_id($id) { |
| 37 | 37 | return _elgg_services()->annotations->get($id); |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | * @param int $owner_guid Owner of annotation (default is logged in user) |
| 58 | 58 | * @param int $access_id Access level of annotation |
| 59 | 59 | * |
| 60 | - * @return int|bool id on success or false on failure |
|
| 60 | + * @return integer id on success or false on failure |
|
| 61 | 61 | */ |
| 62 | 62 | function create_annotation($entity_guid, $name, $value, $value_type = '', |
| 63 | 63 | $owner_guid = 0, $access_id = ACCESS_PRIVATE) { |
@@ -329,7 +329,7 @@ discard block |
||
| 329 | 329 | * @param string $hook |
| 330 | 330 | * @param string $type |
| 331 | 331 | * @param array $tests |
| 332 | - * @return array |
|
| 332 | + * @return string[] |
|
| 333 | 333 | * @access private |
| 334 | 334 | */ |
| 335 | 335 | function _elgg_annotations_test($hook, $type, $tests) { |
@@ -214,7 +214,7 @@ |
||
| 214 | 214 | * Deletes all cached views in the simplecache and sets the lastcache and |
| 215 | 215 | * lastupdate time to 0 for every valid viewtype. |
| 216 | 216 | * |
| 217 | - * @return bool |
|
| 217 | + * @return boolean|null |
|
| 218 | 218 | * @since 1.7.4 |
| 219 | 219 | */ |
| 220 | 220 | function elgg_invalidate_simplecache() { |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * Page handler for generic comments manipulation. |
| 33 | 33 | * |
| 34 | 34 | * @param array $page |
| 35 | - * @return bool |
|
| 35 | + * @return boolean|null |
|
| 36 | 36 | * @access private |
| 37 | 37 | */ |
| 38 | 38 | function _elgg_comments_page_handler($page) { |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | * @param \ElggMenuItem[] $return Array of \ElggMenuItem objects |
| 159 | 159 | * @param array $params Array of view vars |
| 160 | 160 | * |
| 161 | - * @return array |
|
| 161 | + * @return ElggMenuItem[] |
|
| 162 | 162 | * @access private |
| 163 | 163 | */ |
| 164 | 164 | function _elgg_comment_setup_entity_menu($hook, $type, $return, $params) { |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | * @param boolean $return Can the current user write to this container? |
| 225 | 225 | * @param array $params Array of parameters (container, user, subtype) |
| 226 | 226 | * |
| 227 | - * @return array |
|
| 227 | + * @return boolean |
|
| 228 | 228 | * @access private |
| 229 | 229 | * @todo this doesn't seem to make a difference if a user can comment or not |
| 230 | 230 | */ |
@@ -683,7 +683,7 @@ discard block |
||
| 683 | 683 | * @param string $order_by Optional ordering. |
| 684 | 684 | * @param int $site_guid Site GUID. 0 for current, -1 for any. |
| 685 | 685 | * @param bool $count Return a count instead of entities |
| 686 | - * @param bool $meta_array_operator Operator for metadata values |
|
| 686 | + * @param string|boolean $meta_array_operator Operator for metadata values |
|
| 687 | 687 | * |
| 688 | 688 | * @return int|array A list of entities, or a count if $count is set to true |
| 689 | 689 | */ |
@@ -819,7 +819,7 @@ discard block |
||
| 819 | 819 | * @param mixed $returnvalue Previous return value |
| 820 | 820 | * @param mixed $tag Search term |
| 821 | 821 | * |
| 822 | - * @return array |
|
| 822 | + * @return string|null |
|
| 823 | 823 | */ |
| 824 | 824 | function search_list_objects_by_name($hook, $user, $returnvalue, $tag) { |
| 825 | 825 | elgg_deprecated_notice('search_list_objects_by_name was deprecated by new search plugin.', 1.7); |
@@ -1043,7 +1043,7 @@ discard block |
||
| 1043 | 1043 | * @param mixed $returnvalue Previous hook's return value |
| 1044 | 1044 | * @param mixed $tag Tag to search against |
| 1045 | 1045 | * |
| 1046 | - * @return void |
|
| 1046 | + * @return string|null |
|
| 1047 | 1047 | */ |
| 1048 | 1048 | function search_list_users_by_name($hook, $user, $returnvalue, $tag) { |
| 1049 | 1049 | elgg_deprecated_notice('search_list_users_by_name() was deprecated by new search', 1.7); |
@@ -1106,7 +1106,7 @@ discard block |
||
| 1106 | 1106 | * Constructs and returns a register object. |
| 1107 | 1107 | * |
| 1108 | 1108 | * @param string $register_name The name of the register |
| 1109 | - * @param mixed $register_value The value of the register |
|
| 1109 | + * @param string $register_value The value of the register |
|
| 1110 | 1110 | * @param array $children_array Optionally, an array of children |
| 1111 | 1111 | * |
| 1112 | 1112 | * @return false|\stdClass Depending on success |
@@ -212,7 +212,7 @@ discard block |
||
| 212 | 212 | * |
| 213 | 213 | * @param int $id Annotation id |
| 214 | 214 | * |
| 215 | - * @return string|bool False on failure |
|
| 215 | + * @return string|false False on failure |
|
| 216 | 216 | * @deprecated 1.9 Use method getURL() on annotation object |
| 217 | 217 | */ |
| 218 | 218 | function get_annotation_url($id) { |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | * @param string $extender_name The name, default 'all'. |
| 246 | 246 | * @param string $function_name The function. |
| 247 | 247 | * |
| 248 | - * @return string |
|
| 248 | + * @return boolean |
|
| 249 | 249 | * @deprecated 1.9 Use the plugin hook in \ElggExtender::getURL() |
| 250 | 250 | */ |
| 251 | 251 | function elgg_register_annotation_url_handler($extender_name = "all", $function_name) { |
@@ -2007,7 +2007,7 @@ discard block |
||
| 2007 | 2007 | * @param string $type The type of entity (object, site, user, group) |
| 2008 | 2008 | * @param string $subtype The subtype to register (may be blank) |
| 2009 | 2009 | * |
| 2010 | - * @return true|false Depending on success |
|
| 2010 | + * @return boolean Depending on success |
|
| 2011 | 2011 | * @deprecated 1.9 Use {@link elgg_unregister_entity_type()} |
| 2012 | 2012 | */ |
| 2013 | 2013 | function unregister_entity_type($type, $subtype) { |
@@ -2086,7 +2086,7 @@ discard block |
||
| 2086 | 2086 | * @param int $guid_one This is the target object |
| 2087 | 2087 | * @param int $guid_two This is the object trying to attach to $guid_one |
| 2088 | 2088 | * |
| 2089 | - * @return true|void |
|
| 2089 | + * @return boolean|null |
|
| 2090 | 2090 | * @access private |
| 2091 | 2091 | * @deprecated 1.9 Use add_entity_relationship() |
| 2092 | 2092 | */ |
@@ -2343,7 +2343,7 @@ discard block |
||
| 2343 | 2343 | * |
| 2344 | 2344 | * @param string $handler Web services type |
| 2345 | 2345 | * @param string $function Your function name |
| 2346 | - * @return bool Depending on success |
|
| 2346 | + * @return boolean|null Depending on success |
|
| 2347 | 2347 | * @deprecated 1.9 Enable the web services plugin and use elgg_ws_register_service_handler(). |
| 2348 | 2348 | */ |
| 2349 | 2349 | function register_service_handler($handler, $function) { |
@@ -2621,7 +2621,7 @@ discard block |
||
| 2621 | 2621 | * |
| 2622 | 2622 | * @param XmlElement $element The element(s) |
| 2623 | 2623 | * |
| 2624 | - * @return mixed An ODD object if the element can be handled, or false. |
|
| 2624 | + * @return ODD An ODD object if the element can be handled, or false. |
|
| 2625 | 2625 | * @access private |
| 2626 | 2626 | * @deprecated 1.9 |
| 2627 | 2627 | */ |
@@ -3354,7 +3354,7 @@ discard block |
||
| 3354 | 3354 | * @param array $params An associated array of other parameters for this handler |
| 3355 | 3355 | * defining some properties eg. supported msg length or rich text support. |
| 3356 | 3356 | * |
| 3357 | - * @return bool |
|
| 3357 | + * @return boolean|null |
|
| 3358 | 3358 | * @deprecated 1.9 Use elgg_register_notification_method() |
| 3359 | 3359 | */ |
| 3360 | 3360 | function register_notification_handler($method, $handler, $params = NULL) { |
@@ -3389,7 +3389,7 @@ discard block |
||
| 3389 | 3389 | * @param mixed $returnvalue Value from previous hook |
| 3390 | 3390 | * @param mixed $params Array of params |
| 3391 | 3391 | * |
| 3392 | - * @return mixed |
|
| 3392 | + * @return ElggEntity|null |
|
| 3393 | 3393 | * @elgg_plugin_hook_handler import all |
| 3394 | 3394 | * @todo document |
| 3395 | 3395 | * @access private |
@@ -3565,7 +3565,7 @@ discard block |
||
| 3565 | 3565 | * @param string $returnvalue Return value from previous hook |
| 3566 | 3566 | * @param array $params The parameters |
| 3567 | 3567 | * |
| 3568 | - * @return null |
|
| 3568 | + * @return boolean|null |
|
| 3569 | 3569 | * @elgg_plugin_hook_handler volatile metadata |
| 3570 | 3570 | * @todo investigate more. |
| 3571 | 3571 | * @throws ImportException |
@@ -3724,7 +3724,7 @@ discard block |
||
| 3724 | 3724 | * @param mixed $returnvalue Value from previous hook |
| 3725 | 3725 | * @param mixed $params Array of params |
| 3726 | 3726 | * |
| 3727 | - * @return mixed |
|
| 3727 | + * @return ElggRelationship|null |
|
| 3728 | 3728 | * @access private |
| 3729 | 3729 | * @deprecated 1.9 |
| 3730 | 3730 | */ |
@@ -329,7 +329,7 @@ discard block |
||
| 329 | 329 | * @param string $directory Directory to look in |
| 330 | 330 | * @param array $exceptions Array of filenames to ignore |
| 331 | 331 | * @param array $list Array of files to append to |
| 332 | - * @param mixed $extensions Array of extensions to allow, null for all. Use a dot: array('.php'). |
|
| 332 | + * @param string[] $extensions Array of extensions to allow, null for all. Use a dot: array('.php'). |
|
| 333 | 333 | * |
| 334 | 334 | * @return array Filenames in $directory, in the form $directory/filename. |
| 335 | 335 | */ |
@@ -435,7 +435,7 @@ discard block |
||
| 435 | 435 | * |
| 436 | 436 | * @see system_messages() |
| 437 | 437 | * |
| 438 | - * @param string|array $message Message or messages to add |
|
| 438 | + * @param string $message Message or messages to add |
|
| 439 | 439 | * |
| 440 | 440 | * @return bool |
| 441 | 441 | */ |
@@ -603,7 +603,7 @@ discard block |
||
| 603 | 603 | * @param string $object_type The object type |
| 604 | 604 | * @param string $object The object involved in the event |
| 605 | 605 | * |
| 606 | - * @return true |
|
| 606 | + * @return boolean |
|
| 607 | 607 | * |
| 608 | 608 | * @see elgg_trigger_before_event |
| 609 | 609 | */ |
@@ -876,7 +876,7 @@ discard block |
||
| 876 | 876 | * @param int $linenum The line number the error was raised at |
| 877 | 877 | * @param array $vars An array that points to the active symbol table where error occurred |
| 878 | 878 | * |
| 879 | - * @return true |
|
| 879 | + * @return boolean |
|
| 880 | 880 | * @throws Exception |
| 881 | 881 | * @access private |
| 882 | 882 | * @todo Replace error_log calls with elgg_log calls. |
@@ -967,7 +967,7 @@ discard block |
||
| 967 | 967 | * A {@elgg_plugin_hook debug log} is called. If a handler returns |
| 968 | 968 | * false, it will stop the default logging method. |
| 969 | 969 | * |
| 970 | - * @param mixed $value The value |
|
| 970 | + * @param string $value The value |
|
| 971 | 971 | * @param bool $to_screen Display to screen? |
| 972 | 972 | * @return void |
| 973 | 973 | * @since 1.7.0 |
@@ -1469,7 +1469,7 @@ discard block |
||
| 1469 | 1469 | * /ajax/form/<action_name>?<key/value params> |
| 1470 | 1470 | * |
| 1471 | 1471 | * @param string[] $segments URL segments (not including "ajax") |
| 1472 | - * @return bool |
|
| 1472 | + * @return null|boolean |
|
| 1473 | 1473 | * |
| 1474 | 1474 | * @see elgg_register_ajax_view() |
| 1475 | 1475 | * @elgg_pagehandler ajax |
@@ -1785,7 +1785,7 @@ discard block |
||
| 1785 | 1785 | * Serve walled garden sections |
| 1786 | 1786 | * |
| 1787 | 1787 | * @param array $page Array of URL segments |
| 1788 | - * @return string |
|
| 1788 | + * @return boolean |
|
| 1789 | 1789 | * @access private |
| 1790 | 1790 | */ |
| 1791 | 1791 | function _elgg_walled_garden_ajax_handler($page) { |
@@ -1955,7 +1955,7 @@ discard block |
||
| 1955 | 1955 | * @param array $params empty |
| 1956 | 1956 | * |
| 1957 | 1957 | * @elgg_plugin_hook unit_tests system |
| 1958 | - * @return array |
|
| 1958 | + * @return string[] |
|
| 1959 | 1959 | * @access private |
| 1960 | 1960 | */ |
| 1961 | 1961 | function _elgg_api_test($hook, $type, $value, $params) { |