From 5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea Mon Sep 17 00:00:00 2001 From: cash Date: Tue, 1 Nov 2011 21:17:21 -0400 Subject: standardized the elgg_get_entities* function @return documentation --- engine/lib/access.php | 2 +- engine/lib/annotations.php | 4 ++-- engine/lib/entities.php | 2 +- engine/lib/location.php | 2 +- engine/lib/metadata.php | 2 +- engine/lib/plugins.php | 2 +- engine/lib/private_settings.php | 2 +- engine/lib/relationships.php | 4 ++-- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/engine/lib/access.php b/engine/lib/access.php index 002413baa..97f744fb9 100644 --- a/engine/lib/access.php +++ b/engine/lib/access.php @@ -792,7 +792,7 @@ function get_members_of_access_collection($collection, $idonly = FALSE) { * access_id => int The access ID of the entity. * * @see elgg_get_entities() - * @return mixed if count, int. if not count, array. false on errors. + * @return mixed If count, int. If not count, array. false on errors. * @since 1.7.0 */ function elgg_get_entities_from_access_id(array $options = array()) { diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php index 66c6454c3..e40ab2e39 100644 --- a/engine/lib/annotations.php +++ b/engine/lib/annotations.php @@ -320,7 +320,7 @@ function elgg_list_annotations($options) { * * annotation_ids => NULL|ARR Annotation IDs * - * @return mixed if count, int. if not count, array or false if no entities. false also on errors. + * @return mixed If count, int. If not count, array. false on errors. * @since 1.7.0 */ function elgg_get_entities_from_annotations(array $options = array()) { @@ -397,7 +397,7 @@ function elgg_list_entities_from_annotations($options = array()) { * 'metadata_names' => The name of metadata on the entity. * 'metadata_values' => The value of metadata on the entitiy. * - * @return mixed + * @return mixed If count, int. If not count, array. false on errors. */ function elgg_get_entities_from_annotation_calculation($options) { $db_prefix = elgg_get_config('dbprefix'); diff --git a/engine/lib/entities.php b/engine/lib/entities.php index fcd4544bf..8b3431c8a 100644 --- a/engine/lib/entities.php +++ b/engine/lib/entities.php @@ -774,7 +774,7 @@ function elgg_entity_exists($guid) { * * callback => string A callback function to pass each row through * - * @return mixed if count, int. if not count, array or false if no entities. false also on errors. + * @return mixed If count, int. If not count, array. false on errors. * @since 1.7.0 * @see elgg_get_entities_from_metadata() * @see elgg_get_entities_from_relationship() diff --git a/engine/lib/location.php b/engine/lib/location.php index 7e2c38fc8..5b889509b 100644 --- a/engine/lib/location.php +++ b/engine/lib/location.php @@ -74,7 +74,7 @@ function elgg_geocode_location($location) { * * @see ElggEntity::setLatLong() * - * @return array + * @return mixed If count, int. If not count, array. false on errors. * @since 1.8.0 */ function elgg_get_entities_from_location(array $options = array()) { diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php index 0220e6c1f..050e69526 100644 --- a/engine/lib/metadata.php +++ b/engine/lib/metadata.php @@ -398,7 +398,7 @@ function elgg_enable_metadata(array $options) { * * metadata_owner_guids => NULL|ARR guids for metadata owners * - * @return mixed if count, int. if not count, array or false if no entities. false also on errors. + * @return mixed If count, int. If not count, array. false on errors. * @since 1.7.0 */ function elgg_get_entities_from_metadata(array $options = array()) { diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php index fac52b152..be871d025 100644 --- a/engine/lib/plugins.php +++ b/engine/lib/plugins.php @@ -1007,7 +1007,7 @@ function elgg_unset_all_plugin_settings($plugin_id = null) { * plugin_user_setting_name_value_pairs_operator => NULL|STR The operator to use for combining * (name = value) OPERATOR (name = value); default AND * - * @return mixed int if count is true, an array of entity objects, or false on failure + * @return mixed int If count, int. If not count, array. false on errors. */ function elgg_get_entities_from_plugin_user_settings(array $options = array()) { // if they're passing it don't bother diff --git a/engine/lib/private_settings.php b/engine/lib/private_settings.php index 95b1afa57..386af5279 100644 --- a/engine/lib/private_settings.php +++ b/engine/lib/private_settings.php @@ -38,7 +38,7 @@ * their own settings. * * - * @return mixed int if count is true, an array of entity objects, or false on failure + * @return mixed int If count, int. If not count, array. false on errors. * @since 1.8.0 */ function elgg_get_entities_from_private_settings(array $options = array()) { diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php index 1a5833732..929d3841d 100644 --- a/engine/lib/relationships.php +++ b/engine/lib/relationships.php @@ -250,7 +250,7 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) { * * inverse_relationship => BOOL Inverse the relationship * - * @return mixed if count, int. if not count, array or false if no entities. false also on errors. + * @return mixed If count, int. If not count, array. false on errors. * @since 1.7.0 */ function elgg_get_entities_from_relationship($options) { @@ -372,7 +372,7 @@ function elgg_list_entities_from_relationship(array $options = array()) { * * @param array $options An options array compatible with * elgg_get_entities_from_relationship() - * @return mixed int if count is true, an array of entity objects, or false on failure + * @return mixed int If count, int. If not count, array. false on errors. * @since 1.8.0 */ function elgg_get_entities_from_relationship_count(array $options = array()) { -- cgit v1.2.3