gctools-outilsgc / gcconnex

engine/lib/access.php

Doc Comments +2 added lines, -2 removed lines

@@ -552,7 +552,7 @@ 
  * @param string $type
  * @param bool $value
  * @param array $params
- * @return true|null
+ * @return boolean|null
  * @access private
  */
 function elgg_override_permissions($hook, $type, $value, $params) {
@@ -589,7 +589,7 @@ 
  * @param string $type
  * @param array $value
  * @param array $params
- * @return array
+ * @return string[]
  *
  * @access private
  */

engine/lib/actions.php

Doc Comments +2 added lines, -2 removed lines

@@ -139,7 +139,7 @@ 
  *
  * @param string $action The action being performed 
  *
- * @return mixed True if valid or redirects.
+ * @return boolean|null True if valid or redirects.
  * @access private
  */
 function action_gatekeeper($action) {
@@ -175,7 +175,7 @@ 
  *
  * Note: Old secrets were hex encoded.
  *
- * @return mixed The site secret hash or false
+ * @return string|false The site secret hash or false
  * @access private
  * @todo Move to better file.
  */

engine/lib/admin.php

Doc Comments +1 added lines, -1 removed lines

@@ -806,7 +806,7 @@
  * @param string $type
  * @param \ElggUser $user
  *
- * @return null|true
+ * @return boolean|null
  * @access private
  */
 function _elgg_add_admin_widgets($event, $type, $user) {

engine/lib/annotations.php

Doc Comments +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
  *
  * @param int $id The id of the annotation object being retrieved.
  *
- * @return \ElggAnnotation|false
+ * @return ElggExtender
  */
 function elgg_get_annotation_from_id($id) {
 	return _elgg_services()->annotations->get($id);
@@ -57,7 +57,7 @@ 
  * @param int    $owner_guid  Owner of annotation (default is logged in user)
  * @param int    $access_id   Access level of annotation
  *
- * @return int|bool id on success or false on failure
+ * @return integer id on success or false on failure
  */
 function create_annotation($entity_guid, $name, $value, $value_type = '',
 		$owner_guid = 0, $access_id = ACCESS_PRIVATE) {
@@ -329,7 +329,7 @@ 
  * @param string $hook
  * @param string $type
  * @param array  $tests
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_annotations_test($hook, $type, $tests) {

engine/lib/cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
  * Deletes all cached views in the simplecache and sets the lastcache and
  * lastupdate time to 0 for every valid viewtype.
  *
- * @return bool
+ * @return boolean|null
  * @since 1.7.4
  */
 function elgg_invalidate_simplecache() {

engine/lib/comments.php

Doc Comments +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
  * Page handler for generic comments manipulation.
  *
  * @param array $page
- * @return bool
+ * @return boolean|null
  * @access private
  */
 function _elgg_comments_page_handler($page) {
@@ -158,7 +158,7 @@ 
  * @param \ElggMenuItem[] $return Array of \ElggMenuItem objects
  * @param array          $params Array of view vars
  *
- * @return array
+ * @return ElggMenuItem[]
  * @access private
  */
 function _elgg_comment_setup_entity_menu($hook, $type, $return, $params) {
@@ -224,7 +224,7 @@ 
  * @param boolean $return Can the current user write to this container?
  * @param array   $params Array of parameters (container, user, subtype)
  *
- * @return array
+ * @return boolean
  * @access private
  * @todo this doesn't seem to make a difference if a user can comment or not
  */

engine/lib/deprecated-1.7.php

Doc Comments +4 added lines, -4 removed lines

@@ -683,7 +683,7 @@ 
  * @param string $order_by            Optional ordering.
  * @param int    $site_guid           Site GUID. 0 for current, -1 for any.
  * @param bool   $count               Return a count instead of entities
- * @param bool   $meta_array_operator Operator for metadata values
+ * @param string|boolean   $meta_array_operator Operator for metadata values
  *
  * @return int|array A list of entities, or a count if $count is set to true
  */
@@ -819,7 +819,7 @@ 
  * @param mixed  $returnvalue Previous return value
  * @param mixed  $tag         Search term
  *
- * @return array
+ * @return string|null
  */
 function search_list_objects_by_name($hook, $user, $returnvalue, $tag) {
 	elgg_deprecated_notice('search_list_objects_by_name was deprecated by new search plugin.', 1.7);
@@ -1043,7 +1043,7 @@ 
  * @param mixed  $returnvalue Previous hook's return value
  * @param mixed  $tag         Tag to search against
  *
- * @return void
+ * @return string|null
  */
 function search_list_users_by_name($hook, $user, $returnvalue, $tag) {
 	elgg_deprecated_notice('search_list_users_by_name() was deprecated by new search', 1.7);
@@ -1106,7 +1106,7 @@ 
  * Constructs and returns a register object.
  *
  * @param string $register_name  The name of the register
- * @param mixed  $register_value The value of the register
+ * @param string  $register_value The value of the register
  * @param array  $children_array Optionally, an array of children
  *
  * @return false|\stdClass Depending on success

engine/lib/deprecated-1.8.php

Doc Comments +53 added lines, -62 removed lines

@@ -275,7 +275,7 @@ 
  * @param mixed  $subregister_value The value of the subregister
  * @param array  $children_array    Optionally, an array of children
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  */
 function add_to_register($register_name, $subregister_name, $subregister_value, $children_array = array()) {
 	elgg_deprecated_notice("add_to_register() has been deprecated", 1.8);
@@ -315,7 +315,7 @@ 
  * @param string $register_name    The name of the top-level register
  * @param string $subregister_name The name of the subregister
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * @since 1.7.0
  */
 function remove_from_register($register_name, $subregister_name) {
@@ -392,7 +392,7 @@ 
  * @param boolean $call        Set to true to call the event rather than add to it (default false)
  * @param mixed   $object      Optionally, the object the event is being performed on (eg a user)
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  */
 function events($event = "", $object_type = "", $function = "", $priority = 500, $call = false, $object = null) {
 
@@ -413,8 +413,7 @@ 
  * 
  * @param string $event The event type
  * @param string $object_type The object type
- * @param string $function The function name
- * @return true|false Depending on success
+ * @return boolean Depending on success
  */
 function register_elgg_event_handler($event, $object_type, $callback, $priority = 500) {
 	elgg_deprecated_notice("register_elgg_event_handler() was deprecated by elgg_register_event_handler()", 1.8);
@@ -428,7 +427,6 @@ 
  *
  * @param string $event The event type
  * @param string $object_type The object type
- * @param string $function The function name
  * @since 1.7.0
  */
 function unregister_elgg_event_handler($event, $object_type, $callback) {
@@ -443,8 +441,7 @@ 
  * 
  * @param string $event The event type
  * @param string $object_type The object type
- * @param string $function The function name
- * @return true|false Depending on success
+ * @return boolean Depending on success
  */
 function trigger_elgg_event($event, $object_type, $object = null) {
 	elgg_deprecated_notice('trigger_elgg_event() was deprecated by elgg_trigger_event()', 1.8);
@@ -471,10 +468,8 @@ 
  * $params is an array containing a set of parameters (or nothing).
  *
  * @param string $hook The name of the hook
- * @param string $entity_type The name of the type of entity (eg "user", "object" etc)
- * @param string $function The name of a valid function to be run
- * @param string $priority The priority - 0 is first, 1000 last, default is 500
- * @return true|false Depending on success
+ * @param integer $priority The priority - 0 is first, 1000 last, default is 500
+ * @return boolean Depending on success
  */
 function register_plugin_hook($hook, $type, $callback, $priority = 500) {
 	elgg_deprecated_notice("register_plugin_hook() was deprecated by elgg_register_plugin_hook_handler()", 1.8);
@@ -488,7 +483,6 @@ 
  * 
  * @param string $hook The name of the hook
  * @param string $entity_type The name of the type of entity (eg "user", "object" etc)
- * @param string $function The name of a valid function to be run
  * @since 1.7.0
  */
 function unregister_plugin_hook($hook, $entity_type, $callback) {
@@ -507,7 +501,6 @@ 
  *
  * @see register_plugin_hook
  * @param string $hook The name of the hook to trigger
- * @param string $entity_type The name of the entity type to trigger it for (or "all", or "none")
  * @param array $params Any parameters. It's good practice to name the keys, i.e. by using array('name' => 'value', 'name2' => 'value2')
  * @param mixed $returnvalue An initial return value
  * @return mixed|null The cumulative return value for the plugin hook functions
@@ -617,7 +610,7 @@ 
  *                                called by something on $path, if false the whole call stack is
  *                                searched.
  *
- * @return void
+ * @return boolean
  *
  * @deprecated 1.8 A neat but pointless function
  */
@@ -1215,8 +1208,8 @@ 
  *
  * @deprecated 1.8 Use elgg_list_entities_from_metadata
  *
- * @param mixed  $meta_name      Metadata name to search on
- * @param mixed  $meta_value     The value to match, optionally
+ * @param string  $meta_name      Metadata name to search on
+ * @param string  $meta_value     The value to match, optionally
  * @param string $entity_type    The type of entity to look for, eg 'site' or 'object'
  * @param string $entity_subtype The subtype of the entity
  * @param int    $owner_guid     Owner GUID
@@ -1341,7 +1334,7 @@ 
  *
  * @param string $label The item label
  * @param string $group The submenu group (default "a")
- * @return bool whether the item was removed or not
+ * @return ElggMenuItem|null whether the item was removed or not
  * @since 1.7.8
  */
 function remove_submenu_item($label, $group = 'a') {
@@ -1375,7 +1368,7 @@ 
  * @param array  $menu_children Optionally, an array of submenu items (not used)
  * @param string $context       (not used)
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * @deprecated 1.8 use elgg_register_menu_item() for the menu 'site'
  */
 function add_menu($menu_name, $menu_url, $menu_children = array(), $context = "") {
@@ -1390,7 +1383,7 @@ 
  *
  * @param string $menu_name The name of the menu item
  *
- * @return true|false Depending on success
+ * @return ElggMenuItem|null Depending on success
  * @deprecated 1.8 Use the new menu system
  */
 function remove_menu($menu_name) {
@@ -1469,7 +1462,7 @@ 
  *
  * @param string $input A word
  *
- * @return true|false
+ * @return string|boolean
  */
 function remove_blacklist($input) {
 	elgg_deprecated_notice('remove_blacklist() was deprecated!', 1.8);
@@ -1542,7 +1535,7 @@ 
  *
  * @param string $context The context of the page
  *
- * @return mixed Either the context string, or false on failure
+ * @return false|string Either the context string, or false on failure
  */
 function set_context($context) {
 	elgg_deprecated_notice('set_context() was deprecated by elgg_set_context().', 1.8);
@@ -1606,7 +1599,7 @@ 
  *
  * @param array $pluginorder Optionally, a list of existing plugins and their orders
  *
- * @return array The new list of plugins and their orders
+ * @return boolean The new list of plugins and their orders
  */
 function regenerate_plugin_list($pluginorder = FALSE) {
 	$msg = 'regenerate_plugin_list() is (sorta) deprecated by elgg_generate_plugin_entities() and'
@@ -1772,7 +1765,7 @@ 
  * @param string $plugin    The plugin name.
  * @param int    $site_guid The site id, if not specified then this is detected.
  *
- * @return array
+ * @return boolean
  * @throws InvalidClassException
  */
 function enable_plugin($plugin, $site_guid = null) {
@@ -1935,7 +1928,7 @@ 
  * Get entities based on their private data by multiple keys.
  *
  * @param string $name           The name of the setting
- * @param mixed  $type           Entity type
+ * @param string  $type           Entity type
  * @param string $subtype        Entity subtype
  * @param int    $owner_guid     The GUID of the owning user
  * @param string $order_by       The field to order by; by default, time_created desc
@@ -2029,9 +2022,9 @@ 
  * @param int $owner_guid The owner (default: all)
  * @param int $limit The number of entities to display on a page
  * @param true|false $fullview Whether or not to display the full view (default: true)
- * @param true|false $viewtypetoggle Whether or not to allow gallery view
+ * @param true|false $listtypetoggle Whether or not to allow gallery view
  * @param true|false $pagination Whether to display pagination (default: true)
- * @param bool $order_by SQL order by clause
+ * @param string|boolean $order_by SQL order by clause
  * @return string The viewable list of entities
  */
 function list_entities_from_relationship($relationship, $relationship_guid,
@@ -2237,8 +2230,8 @@ 
 /**
  * Retrieves items from the river. All parameters are optional.
  *
- * @param int|array $subject_guid         Acting entity to restrict to. Default: all
- * @param int|array $object_guid          Entity being acted on to restrict to. Default: all
+ * @param integer $subject_guid         Acting entity to restrict to. Default: all
+ * @param integer $object_guid          Entity being acted on to restrict to. Default: all
  * @param string    $subject_relationship If set to a relationship type, this will use
  * 	                                      $subject_guid as the starting point and set the
  *                                        subjects to be all users this
@@ -2305,8 +2298,8 @@ 
 /**
  * Returns a human-readable version of the river.
  *
- * @param int|array $subject_guid         Acting entity to restrict to. Default: all
- * @param int|array $object_guid          Entity being acted on to restrict to. Default: all
+ * @param integer $subject_guid         Acting entity to restrict to. Default: all
+ * @param integer $object_guid          Entity being acted on to restrict to. Default: all
  * @param string    $subject_relationship If set to a relationship type, this will use
  * 	                                      $subject_guid as the starting point and set
  *                                        the subjects to be all users this entity has this
@@ -2598,7 +2591,7 @@ 
  * @param int $site_guid       Site GUID
  * @param int $collection_guid Collection GUID
  *
- * @return mixed
+ * @return boolean
  * @deprecated 1.8 Don't use this.
  */
 function remove_site_collection($site_guid, $collection_guid) {
@@ -2903,7 +2896,7 @@ 
  * @param string $view              The view to extend, by default this is 'usersettings/main'.
  * @param int    $priority          Optional priority to govern the appearance in the list.
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.8 Extend one of the views in core/settings
  */
 function extend_elgg_settings_page($new_settings_view, $view = 'usersettings/main',
@@ -3151,12 +3144,12 @@ 
  * Set a setting for a plugin.
  *
  * @param string $name      The name - note, can't be "title".
- * @param mixed  $value     The value.
+ * @param string  $value     The value.
  * @param string $plugin_id Optional plugin name, if not specified
  *                          then it is detected from where you are calling from.
  *
  * @deprecated 1.8 Use elgg_set_plugin_setting() or \ElggPlugin->setSetting()
- * @return int|false
+ * @return boolean
  */
 function set_plugin_setting($name, $value, $plugin_id = null) {
 	elgg_deprecated_notice('set_plugin_setting() is deprecated by elgg_set_plugin_setting()', 1.8);
@@ -3212,12 +3205,12 @@ 
 /**
  * Get a list of annotations for a given object/user/annotation type.
  *
- * @param int|array $entity_guid       GUID to return annotations of (falsey for any)
+ * @param integer $entity_guid       GUID to return annotations of (falsey for any)
  * @param string    $entity_type       Type of entity
  * @param string    $entity_subtype    Subtype of entity
  * @param string    $name              Name of annotation
  * @param mixed     $value             Value of annotation
- * @param int|array $owner_guid        Owner(s) of annotation
+ * @param integer $owner_guid        Owner(s) of annotation
  * @param int       $limit             Limit
  * @param int       $offset            Offset
  * @param string    $order_by          Order annotations by SQL
@@ -3314,15 +3307,15 @@ 
 /**
  * Helper function to deprecate annotation calculation functions. Don't use.
  *
- * @param unknown_type $entity_guid
+ * @param integer $entity_guid
  * @param unknown_type $entity_type
  * @param unknown_type $entity_subtype
  * @param unknown_type $name
  * @param unknown_type $value
  * @param unknown_type $value_type
- * @param unknown_type $owner_guid
- * @param unknown_type $timelower
- * @param unknown_type $timeupper
+ * @param integer $owner_guid
+ * @param integer $timelower
+ * @param integer $timeupper
  * @param unknown_type $calculation
  * @internal Don't use this at all.
  * @deprecated 1.8 Use elgg_get_annotations()
@@ -3603,7 +3596,7 @@ 
  * @param string $function_name The function to register
  * @param string $entity_type The entity type
  * @param string $entity_subtype The entity subtype
- * @return true|false Depending on success
+ * @return boolean Depending on success
  *
  * @deprecated 1.8 Use elgg_register_entity_url_handler()
  */
@@ -3724,7 +3717,7 @@ 
  *
  * @param int $id The id of the metadata being retrieved.
  *
- * @return mixed False on failure or \ElggMetadata
+ * @return ElggExtender False on failure or \ElggMetadata
  * @deprecated 1.8 Use elgg_get_metadata_from_id()
  */
 function get_metadata($id) {
@@ -3737,7 +3730,7 @@ 
  *
  * @param int $guid Entity GUID
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.8 Use elgg_delete_metadata()
  */
 function clear_metadata($guid) {
@@ -3753,7 +3746,7 @@ 
  *
  * @param int $owner_guid The owner
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.8 Use elgg_delete_metadata()
  */
 function clear_metadata_by_owner($owner_guid) {
@@ -3769,7 +3762,7 @@ 
  *
  * @param int $id The id of metadata to delete.
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.8 Use elgg_delete_metadata()
  */
 function delete_metadata($id) {
@@ -3787,7 +3780,7 @@ 
  * @param string $name  The name of the metadata
  * @param string $value The value of the metadata (useful to remove a single item of a set)
  *
- * @return bool Depending on success
+ * @return boolean|null Depending on success
  * @deprecated 1.8 Use elgg_delete_metadata()
  */
 function remove_metadata($guid, $name, $value = "") {
@@ -3829,7 +3822,7 @@ 
  *
  * @param int $id The annotation id
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.8 Use elgg_delete_annotations()
  */
 function delete_annotation($id) {
@@ -3846,7 +3839,7 @@ 
  * @param int    $guid The entity guid
  * @param string $name The name of the annotation to delete.
  *
- * @return int Number of annotations deleted or false if an error
+ * @return boolean|null Number of annotations deleted or false if an error
  * @deprecated 1.8 Use elgg_delete_annotations()
  */
 function clear_annotations($guid, $name = "") {
@@ -3873,7 +3866,7 @@ 
  *
  * @param int $owner_guid The owner
  *
- * @return int Number of annotations deleted
+ * @return boolean|null Number of annotations deleted
  * @deprecated 1.8 Use elgg_delete_annotations()
  */
 function clear_annotations_by_owner($owner_guid) {
@@ -3911,7 +3904,7 @@ 
  *
  * @param string $handler The page type to handle
  * @param string $function Your function name
- * @return true|false Depending on success
+ * @return boolean Depending on success
  *
  * @deprecated 1.8 Use {@link elgg_register_page_handler()}
  */
@@ -3938,7 +3931,7 @@ 
 /**
  * Register an annotation url handler.
  *
- * @param string $function_name The function.
+ * @param string $function The function.
  * @param string $extender_name The name, default 'all'.
  *
  * @deprecated 1.8 Use {@link elgg_register_annotation_url_handler()}
@@ -3953,10 +3946,8 @@ 
  * It is recommended that you do not call this directly, instead use one of the wrapper functions in the
  * subtype files.
  *
- * @param string $function_name The function to register
- * @param string $extender_type Extender type
- * @param string $extender_name The name of the extender
- * @return true|false Depending on success
+ * @param string $function The function to register
+ * @return boolean Depending on success
  *
  * @deprecated 1.8 Use {@link elgg_register_extender_url_handler()}
  */
@@ -3972,7 +3963,7 @@ 
  *
  * @param string $type The type of entity (object, site, user, group)
  * @param string $subtype The subtype to register (may be blank)
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * 
  * @deprecated 1.8 Use {@link elgg_register_entity_type()}
  */
@@ -3984,7 +3975,7 @@ 
 /**
  * Register a metadata url handler.
  *
- * @param string $function_name The function.
+ * @param string $function The function.
  * @param string $extender_name The name, default 'all'.
  * 
  * @deprecated 1.8 Use {@link elgg_register_metadata_url_handler()}
@@ -3998,7 +3989,7 @@ 
  *
  * @param string $function_name The function to register
  * @param string $relationship_type The relationship type.
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * 
  * @deprecated 1.8 Use {@link elgg_register_relationship_url_handler()}
  */
@@ -4310,7 +4301,7 @@ 
  *
  * @param string $handler The identifier for the widget handler
  *
- * @return void
+ * @return boolean
  * @since 1.7.1
  * @deprecated 1.8 Use elgg_unregister_widget_type
  */
@@ -4409,7 +4400,7 @@ 
  * @param string $context      Profile or dashboard
  * @param int    $owner        Owner guid
  *
- * @return void
+ * @return boolean
  * @deprecated 1.8 Don't use.
  */
 function reorder_widgets_from_panel($panelstring1, $panelstring2, $panelstring3, $context, $owner) {
@@ -4654,7 +4645,7 @@ 
  * @param array  $page    The page URL elements
  * @param string $handler The base handler
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * @deprecated 1.8
  */
 function default_page_handler($page, $handler) {

engine/lib/deprecated-1.9.php

Doc Comments +10 added lines, -10 removed lines

@@ -212,7 +212,7 @@ 
  *
  * @param int $id Annotation id
  *
- * @return string|bool False on failure
+ * @return string|false False on failure
  * @deprecated 1.9 Use method getURL() on annotation object
  */
 function get_annotation_url($id) {
@@ -245,7 +245,7 @@ 
  * @param string $extender_name The name, default 'all'.
  * @param string $function_name The function.
  *
- * @return string
+ * @return boolean
  * @deprecated 1.9 Use the plugin hook in \ElggExtender::getURL()
  */
 function elgg_register_annotation_url_handler($extender_name = "all", $function_name) {
@@ -2007,7 +2007,7 @@ 
  * @param string $type    The type of entity (object, site, user, group)
  * @param string $subtype The subtype to register (may be blank)
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  * @deprecated 1.9 Use {@link elgg_unregister_entity_type()}
  */
 function unregister_entity_type($type, $subtype) {
@@ -2086,7 +2086,7 @@ 
  * @param int $guid_one This is the target object
  * @param int $guid_two This is the object trying to attach to $guid_one
  *
- * @return true|void
+ * @return boolean|null
  * @access private
  * @deprecated 1.9 Use add_entity_relationship()
  */
@@ -2343,7 +2343,7 @@ 
  *
  * @param string $handler  Web services type
  * @param string $function Your function name
- * @return bool Depending on success
+ * @return boolean|null Depending on success
  * @deprecated 1.9 Enable the web services plugin and use elgg_ws_register_service_handler().
  */
 function register_service_handler($handler, $function) {
@@ -2621,7 +2621,7 @@ 
  *
  * @param XmlElement $element The element(s)
  *
- * @return mixed An ODD object if the element can be handled, or false.
+ * @return ODD An ODD object if the element can be handled, or false.
  * @access private
  * @deprecated 1.9
  */
@@ -3354,7 +3354,7 @@ 
  * @param array  $params  An associated array of other parameters for this handler
  *                        defining some properties eg. supported msg length or rich text support.
  *
- * @return bool
+ * @return boolean|null
  * @deprecated 1.9 Use elgg_register_notification_method()
  */
 function register_notification_handler($method, $handler, $params = NULL) {
@@ -3389,7 +3389,7 @@ 
  * @param mixed  $returnvalue Value from previous hook
  * @param mixed  $params      Array of params
  *
- * @return mixed
+ * @return ElggEntity|null
  * @elgg_plugin_hook_handler import all
  * @todo document
  * @access private
@@ -3565,7 +3565,7 @@ 
  * @param string $returnvalue Return value from previous hook
  * @param array  $params      The parameters
  *
- * @return null
+ * @return boolean|null
  * @elgg_plugin_hook_handler volatile metadata
  * @todo investigate more.
  * @throws ImportException
@@ -3724,7 +3724,7 @@ 
  * @param mixed  $returnvalue Value from previous hook
  * @param mixed  $params      Array of params
  *
- * @return mixed
+ * @return ElggRelationship|null
  * @access private
  * @deprecated 1.9
  */