gctools-outilsgc / gcconnex

engine/lib/filestore.php

Doc Comments +5 added lines, -5 removed lines

@@ -38,7 +38,7 @@ 
  *
  * @param string $input_name The name of the file input field on the submission form
  *
- * @return mixed|false The contents of the file, or false on failure.
+ * @return false|string The contents of the file, or false on failure.
  */
 function get_uploaded_file($input_name) {
 	$files = _elgg_services()->request->files;
@@ -70,7 +70,7 @@ 
  *                           dimensions on all size; the image will be cropped.
  * @param bool   $upscale    Resize images smaller than $maxwidth x $maxheight?
  *
- * @return false|mixed The contents of the resized image, or false on failure
+ * @return false|string The contents of the resized image, or false on failure
  */
 function get_resized_image_from_uploaded_file($input_name, $maxwidth, $maxheight,
 $square = false, $upscale = false) {
@@ -110,7 +110,7 @@ 
  * @param int    $y2         y coordinate for bottom, right corner
  * @param bool   $upscale    Resize images smaller than $maxwidth x $maxheight?
  *
- * @return false|mixed The contents of the resized image, or false on failure
+ * @return false|string The contents of the resized image, or false on failure
  */
 function get_resized_image_from_existing_file($input_name, $maxwidth, $maxheight, $square = false,
 $x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0, $upscale = false) {
@@ -204,7 +204,7 @@ 
  * @param int   $height  Height of the original image
  * @param array $options See $defaults for the options
  *
- * @return array or false
+ * @return resource or false
  * @since 1.7.2
  */
 function get_image_resize_parameters($width, $height, $options) {
@@ -440,7 +440,7 @@ 
  *
  * @param \ElggFilestore $filestore An \ElggFilestore object.
  *
- * @return true
+ * @return boolean
  */
 function set_default_filestore(\ElggFilestore $filestore) {
 	global $DEFAULT_FILE_STORE;

engine/lib/group.php

Doc Comments +1 added lines, -1 removed lines

@@ -106,7 +106,7 @@
  * @param string $type  Hook type
  * @param array  $value Array of unit test locations
  *
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_groups_test($hook, $type, $value) {

engine/lib/languages.php

Doc Comments +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
  * @param string $country_code   Standard country code (eg 'en', 'nl', 'es')
  * @param array  $language_array Formatted array of strings
  *
- * @return true|false Depending on success
+ * @return boolean Depending on success
  */
 function add_translation($country_code, $language_array) {
 	return _elgg_services()->translator->addTranslation($country_code, $language_array);
@@ -65,7 +65,7 @@ 
  * to translate something to a language not loaded by default for
  * the current user.
  *
- * @param $language Language code
+ * @param string $language Language code
  * @return bool
  *
  * @since 1.9.4
@@ -137,7 +137,7 @@ 
  * @param bool   $load_all If true all languages are loaded, if
  *                         false only the current language + en are loaded
  *
- * @return void
+ * @return boolean
  */
 function register_translations($path, $load_all = false) {
 	return _elgg_services()->translator->registerTranslations($path, $load_all);
@@ -201,7 +201,7 @@ 
  *
  * @todo Better on demand loading based on language_paths array
  *
- * @return bool
+ * @return boolean|null
  */
 function reload_all_translations() {
 	return _elgg_services()->translator->reloadAllTranslations();
@@ -222,7 +222,7 @@ 
  *
  * @param string $language Language
  *
- * @return int
+ * @return double
  */
 function get_language_completeness($language) {
 	return _elgg_services()->translator->getLanguageCompleteness($language);

engine/lib/metadata.php

Doc Comments +4 added lines, -4 removed lines

@@ -30,7 +30,7 @@ 
  *
  * @param int $id The id of the metadata object being retrieved.
  *
- * @return \ElggMetadata|false  false if not found
+ * @return ElggExtender  false if not found
  */
 function elgg_get_metadata_from_id($id) {
 	return _elgg_services()->metadataTable->get($id);
@@ -263,7 +263,7 @@ 
  *
  * @param array $options Options array
  *
- * @return array
+ * @return string
  * @since 1.7.0
  */
 function elgg_list_entities_from_metadata($options) {
@@ -327,7 +327,7 @@ 
  *
  * @param int $id Metadata ID
  *
- * @return mixed
+ * @return string|false
  */
 function get_metadata_url($id) {
 	return _elgg_services()->metadataTable->getUrl($id);
@@ -366,7 +366,7 @@ 
  * @param string     $object_type The type of object
  * @param \ElggEntity $object      The entity itself
  *
- * @return true
+ * @return boolean
  * @access private Set as private in 1.9.0
  */
 function metadata_update($event, $object_type, $object) {

engine/lib/metastrings.php

Doc Comments +1 added lines, -1 removed lines

@@ -741,7 +741,7 @@
  * @param string $type  system
  * @param array  $value Array of other tests
  *
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_metastrings_test($hook, $type, $value) {

engine/lib/notification.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
  *
  * @param string $object_type    'object', 'user', 'group', 'site'
  * @param string $object_subtype The subtype or name of the entity
- * @param array  $actions        Array of actions or empty array for the action event.
+ * @param string[]  $actions        Array of actions or empty array for the action event.
  *                                An event is usually described by the first string passed
  *                                to elgg_trigger_event(). Examples include
  *                                'create', 'update', and 'publish'. The default is 'create'.
@@ -344,7 +344,7 @@ 
  * @param string $subject          Message subject.
  * @param string $message          Message body.
  * @param array  $params           Misc additional parameters specific to various methods.
- * @param mixed  $methods_override A string, or an array of strings specifying the delivery
+ * @param string[]  $methods_override A string, or an array of strings specifying the delivery
  *                                 methods to use - or leave blank for delivery using the
  *                                 user's chosen delivery methods.
  *

engine/lib/relationships.php

Doc Comments +3 added lines, -3 removed lines

@@ -38,7 +38,7 @@ 
  *
  * @param int $id The relationship ID
  *
- * @return \stdClass|false False if no row found
+ * @return stdClass|null False if no row found
  * @access private
  */
 function _elgg_get_relationship_row($id) {
@@ -113,7 +113,7 @@ 
  *                                     subject of the relationships.
  * @param string $type                 The type of entity related to $guid (defaults to all)
  *
- * @return true
+ * @return boolean
  */
 function remove_entity_relationships($guid, $relationship = "", $inverse_relationship = false, $type = '') {
 	return _elgg_services()->relationshipsTable->removeAll($guid, $relationship, $inverse_relationship, $type);
@@ -286,7 +286,7 @@ 
  * @param string $hook
  * @param string $type
  * @param array  $tests
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_relationships_test($hook, $type, $tests) {

engine/lib/sessions.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
  * @param string $username The username
  * @param string $password The password
  *
- * @return true|string True or an error message on failure
+ * @return string|boolean True or an error message on failure
  * @access private
  */
 function elgg_authenticate($username, $password) {
@@ -314,7 +314,7 @@ 
  * @param \ElggUser $user       A valid Elgg user object
  * @param boolean   $persistent Should this be a persistent login?
  *
- * @return true or throws exception
+ * @return boolean or throws exception
  * @throws LoginException
  */
 function login(\ElggUser $user, $persistent = false) {

engine/lib/system_log.php

Doc Comments +2 added lines, -2 removed lines

@@ -300,7 +300,7 @@ 
  * @param string   $object_type Object type
  * @param Loggable $object      Object to log
  *
- * @return true
+ * @return boolean
  */
 function system_log_default_logger($event, $object_type, $object) {
 	system_log($object['object'], $object['event']);
@@ -316,7 +316,7 @@ 
  * @param String   $object_type Type of object
  * @param Loggable $object      Object to log
  *
- * @return true
+ * @return boolean
  * @access private
  */
 function system_log_listener($event, $object_type, $object) {