@@ -106,7 +106,7 @@ |
||
106 | 106 | * @param string $type Hook type |
107 | 107 | * @param array $value Array of unit test locations |
108 | 108 | * |
109 | - * @return array |
|
109 | + * @return string[] |
|
110 | 110 | * @access private |
111 | 111 | */ |
112 | 112 | function _elgg_groups_test($hook, $type, $value) { |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | * @param string $country_code Standard country code (eg 'en', 'nl', 'es') |
34 | 34 | * @param array $language_array Formatted array of strings |
35 | 35 | * |
36 | - * @return true|false Depending on success |
|
36 | + * @return boolean Depending on success |
|
37 | 37 | */ |
38 | 38 | function add_translation($country_code, $language_array) { |
39 | 39 | return _elgg_services()->translator->addTranslation($country_code, $language_array); |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | * to translate something to a language not loaded by default for |
66 | 66 | * the current user. |
67 | 67 | * |
68 | - * @param $language Language code |
|
68 | + * @param string $language Language code |
|
69 | 69 | * @return bool |
70 | 70 | * |
71 | 71 | * @since 1.9.4 |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * @param bool $load_all If true all languages are loaded, if |
138 | 138 | * false only the current language + en are loaded |
139 | 139 | * |
140 | - * @return void |
|
140 | + * @return boolean |
|
141 | 141 | */ |
142 | 142 | function register_translations($path, $load_all = false) { |
143 | 143 | return _elgg_services()->translator->registerTranslations($path, $load_all); |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | * |
202 | 202 | * @todo Better on demand loading based on language_paths array |
203 | 203 | * |
204 | - * @return bool |
|
204 | + * @return boolean|null |
|
205 | 205 | */ |
206 | 206 | function reload_all_translations() { |
207 | 207 | return _elgg_services()->translator->reloadAllTranslations(); |
@@ -222,7 +222,7 @@ discard block |
||
222 | 222 | * |
223 | 223 | * @param string $language Language |
224 | 224 | * |
225 | - * @return int |
|
225 | + * @return double |
|
226 | 226 | */ |
227 | 227 | function get_language_completeness($language) { |
228 | 228 | return _elgg_services()->translator->getLanguageCompleteness($language); |
@@ -30,7 +30,7 @@ discard block |
||
30 | 30 | * |
31 | 31 | * @param int $id The id of the metadata object being retrieved. |
32 | 32 | * |
33 | - * @return \ElggMetadata|false false if not found |
|
33 | + * @return ElggExtender false if not found |
|
34 | 34 | */ |
35 | 35 | function elgg_get_metadata_from_id($id) { |
36 | 36 | return _elgg_services()->metadataTable->get($id); |
@@ -263,7 +263,7 @@ discard block |
||
263 | 263 | * |
264 | 264 | * @param array $options Options array |
265 | 265 | * |
266 | - * @return array |
|
266 | + * @return string |
|
267 | 267 | * @since 1.7.0 |
268 | 268 | */ |
269 | 269 | function elgg_list_entities_from_metadata($options) { |
@@ -327,7 +327,7 @@ discard block |
||
327 | 327 | * |
328 | 328 | * @param int $id Metadata ID |
329 | 329 | * |
330 | - * @return mixed |
|
330 | + * @return string|false |
|
331 | 331 | */ |
332 | 332 | function get_metadata_url($id) { |
333 | 333 | return _elgg_services()->metadataTable->getUrl($id); |
@@ -366,7 +366,7 @@ discard block |
||
366 | 366 | * @param string $object_type The type of object |
367 | 367 | * @param \ElggEntity $object The entity itself |
368 | 368 | * |
369 | - * @return true |
|
369 | + * @return boolean |
|
370 | 370 | * @access private Set as private in 1.9.0 |
371 | 371 | */ |
372 | 372 | function metadata_update($event, $object_type, $object) { |
@@ -741,7 +741,7 @@ |
||
741 | 741 | * @param string $type system |
742 | 742 | * @param array $value Array of other tests |
743 | 743 | * |
744 | - * @return array |
|
744 | + * @return string[] |
|
745 | 745 | * @access private |
746 | 746 | */ |
747 | 747 | function _elgg_metastrings_test($hook, $type, $value) { |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | * |
52 | 52 | * @param string $object_type 'object', 'user', 'group', 'site' |
53 | 53 | * @param string $object_subtype The subtype or name of the entity |
54 | - * @param array $actions Array of actions or empty array for the action event. |
|
54 | + * @param string[] $actions Array of actions or empty array for the action event. |
|
55 | 55 | * An event is usually described by the first string passed |
56 | 56 | * to elgg_trigger_event(). Examples include |
57 | 57 | * 'create', 'update', and 'publish'. The default is 'create'. |
@@ -344,7 +344,7 @@ discard block |
||
344 | 344 | * @param string $subject Message subject. |
345 | 345 | * @param string $message Message body. |
346 | 346 | * @param array $params Misc additional parameters specific to various methods. |
347 | - * @param mixed $methods_override A string, or an array of strings specifying the delivery |
|
347 | + * @param string[] $methods_override A string, or an array of strings specifying the delivery |
|
348 | 348 | * methods to use - or leave blank for delivery using the |
349 | 349 | * user's chosen delivery methods. |
350 | 350 | * |
@@ -38,7 +38,7 @@ discard block |
||
38 | 38 | * |
39 | 39 | * @param int $id The relationship ID |
40 | 40 | * |
41 | - * @return \stdClass|false False if no row found |
|
41 | + * @return stdClass|null False if no row found |
|
42 | 42 | * @access private |
43 | 43 | */ |
44 | 44 | function _elgg_get_relationship_row($id) { |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | * subject of the relationships. |
114 | 114 | * @param string $type The type of entity related to $guid (defaults to all) |
115 | 115 | * |
116 | - * @return true |
|
116 | + * @return boolean |
|
117 | 117 | */ |
118 | 118 | function remove_entity_relationships($guid, $relationship = "", $inverse_relationship = false, $type = '') { |
119 | 119 | return _elgg_services()->relationshipsTable->removeAll($guid, $relationship, $inverse_relationship, $type); |
@@ -286,7 +286,7 @@ discard block |
||
286 | 286 | * @param string $hook |
287 | 287 | * @param string $type |
288 | 288 | * @param array $tests |
289 | - * @return array |
|
289 | + * @return string[] |
|
290 | 290 | * @access private |
291 | 291 | */ |
292 | 292 | function _elgg_relationships_test($hook, $type, $tests) { |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | * @param string $username The username |
131 | 131 | * @param string $password The password |
132 | 132 | * |
133 | - * @return true|string True or an error message on failure |
|
133 | + * @return string|boolean True or an error message on failure |
|
134 | 134 | * @access private |
135 | 135 | */ |
136 | 136 | function elgg_authenticate($username, $password) { |
@@ -314,7 +314,7 @@ discard block |
||
314 | 314 | * @param \ElggUser $user A valid Elgg user object |
315 | 315 | * @param boolean $persistent Should this be a persistent login? |
316 | 316 | * |
317 | - * @return true or throws exception |
|
317 | + * @return boolean or throws exception |
|
318 | 318 | * @throws LoginException |
319 | 319 | */ |
320 | 320 | function login(\ElggUser $user, $persistent = false) { |
@@ -300,7 +300,7 @@ discard block |
||
300 | 300 | * @param string $object_type Object type |
301 | 301 | * @param Loggable $object Object to log |
302 | 302 | * |
303 | - * @return true |
|
303 | + * @return boolean |
|
304 | 304 | */ |
305 | 305 | function system_log_default_logger($event, $object_type, $object) { |
306 | 306 | system_log($object['object'], $object['event']); |
@@ -316,7 +316,7 @@ discard block |
||
316 | 316 | * @param String $object_type Type of object |
317 | 317 | * @param Loggable $object Object to log |
318 | 318 | * |
319 | - * @return true |
|
319 | + * @return boolean |
|
320 | 320 | * @access private |
321 | 321 | */ |
322 | 322 | function system_log_listener($event, $object_type, $object) { |
@@ -136,7 +136,7 @@ |
||
136 | 136 | * @param bool $move True to move, false to copy. |
137 | 137 | * @param string $preference to|from If file collisions, which dir has preference. |
138 | 138 | * |
139 | - * @return bool |
|
139 | + * @return false|null |
|
140 | 140 | */ |
141 | 141 | function merge_directories($from, $to, $move = false, $preference = 'to') { |
142 | 142 | if (!$entries = scandir($from)) { |