standardized the elgg_get_entities* function @return documentation

diff --git a/engine/lib/access.php b/engine/lib/access.php
index 002413baa41d9db71b90d549b8c7efa266598ced..97f744fb940ec7c3c1dd40460164a476ef903106 100644 (file)
--- 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 66c6454c34c20b61223bf2bb00f03c0a00b8247d..e40ab2e39179dc09fef438304c1c1da902895496 100644 (file)
--- 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 fcd4544bf3a9a5e1e6f85d3fb38b7ff9be6acd6d..8b3431c8a293f646077c2dd491ab3d67c086e2d6 100644 (file)
--- 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 7e2c38fc8c17a3b5c9c3a72b5d42d422a70d052c..5b889509ba29ce26cd34edadaf6f5913bf046332 100644 (file)
--- 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 0220e6c1fa6b2f7afb7bd0eacd2e2930c425c3cc..050e695261a94adddaa1fd53001705cdb53e43a0 100644 (file)
--- 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 fac52b152d91d410f4eb63526efe1bc6f34cf1ee..be871d025c4fc3852c898fe6583d4028eddf738d 100644 (file)
--- 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 95b1afa57e32223acef5a37042e4527be4da5435..386af5279a517995807854656b39c816c9695fac 100644 (file)
--- 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 1a58337327574fb608ce170df4033e8aac84e9dc..929d3841d8dca53c830be6ab697d7b2550d627f9 100644 (file)
--- 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()) {