gctools-outilsgc / gcconnex

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.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
  */

engine/lib/elgglib.php

Doc Comments +8 added lines, -8 removed lines

@@ -329,7 +329,7 @@ 
  * @param string $directory  Directory to look in
  * @param array  $exceptions Array of filenames to ignore
  * @param array  $list       Array of files to append to
- * @param mixed  $extensions Array of extensions to allow, null for all. Use a dot: array('.php').
+ * @param string[]  $extensions Array of extensions to allow, null for all. Use a dot: array('.php').
  *
  * @return array Filenames in $directory, in the form $directory/filename.
  */
@@ -435,7 +435,7 @@ 
  *
  * @see system_messages()
  *
- * @param string|array $message Message or messages to add
+ * @param string $message Message or messages to add
  *
  * @return bool
  */
@@ -603,7 +603,7 @@ 
  * @param string $object_type The object type
  * @param string $object      The object involved in the event
  *
- * @return true
+ * @return boolean
  *
  * @see elgg_trigger_before_event
  */
@@ -876,7 +876,7 @@ 
  * @param int    $linenum  The line number the error was raised at
  * @param array  $vars     An array that points to the active symbol table where error occurred
  *
- * @return true
+ * @return boolean
  * @throws Exception
  * @access private
  * @todo Replace error_log calls with elgg_log calls.
@@ -967,7 +967,7 @@ 
  * A {@elgg_plugin_hook debug log} is called.  If a handler returns
  * false, it will stop the default logging method.
  *
- * @param mixed $value     The value
+ * @param string $value     The value
  * @param bool  $to_screen Display to screen?
  * @return void
  * @since 1.7.0
@@ -1469,7 +1469,7 @@ 
  * /ajax/form/<action_name>?<key/value params>
  *
  * @param string[] $segments URL segments (not including "ajax")
- * @return bool
+ * @return null|boolean
  *
  * @see elgg_register_ajax_view()
  * @elgg_pagehandler ajax
@@ -1785,7 +1785,7 @@ 
  * Serve walled garden sections
  *
  * @param array $page Array of URL segments
- * @return string
+ * @return boolean
  * @access private
  */
 function _elgg_walled_garden_ajax_handler($page) {
@@ -1955,7 +1955,7 @@ 
  * @param array  $params empty
  *
  * @elgg_plugin_hook unit_tests system
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_api_test($hook, $type, $value, $params) {

engine/lib/entities.php

Doc Comments +2 added lines, -2 removed lines

@@ -345,7 +345,7 @@ 
  *
  * @param int $guid The GUID of the object to extract
  *
- * @return \stdClass|false
+ * @return stdClass|null
  * @see entity_row_to_elggstar()
  * @access private
  */
@@ -965,7 +965,7 @@ 
  * @param string $type   system
  * @param array  $value  Array of tests
  *
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_entities_test($hook, $type, $value) {