Fixes #3827 updated documentation on @return for elgg_get_entities* functions

diff --git a/engine/lib/access.php b/engine/lib/access.php
index 6da747463a550157a3bc9b08bf8c9a9abc3d9d12..20f57ec416f9bee8e5c713548d20a5efb36d4a32 100644 (file)
--- a/engine/lib/access.php
+++ b/engine/lib/access.php
@@ -776,7 +776,7 @@ function elgg_view_access_collections($owner_guid) {
  *     access_id => int The access ID of the entity.
  *
  * @see elgg_get_entities()
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @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 80ffbe74eb4f3312cff3d27d0ae2442067b7c290..9ab5a1b393b6f4b6f048b52946c0be2d668e0620 100644 (file)
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -285,14 +285,12 @@ function elgg_list_annotations($options) {
  */
 
 /**
- * Returns entities based upon annotations.  Accepts the same values as
- * elgg_get_entities_from_metadata() but uses the annotations table.
+ * Returns entities based upon annotations.  Also accepts all options available
+ * to elgg_get_entities() and elgg_get_entities_from_metadata().
  *
- * NB: Entity creation time is selected as max_time. To sort based upon
+ * Entity creation time is selected as max_time. To sort based upon
  * this, pass 'order_by' => 'maxtime asc' || 'maxtime desc'
  *
- * time_created in this case will be the time the annotation was created.
- *
  * @see elgg_get_entities
  * @see elgg_get_entities_from_metadata
  *
@@ -321,7 +319,7 @@ function elgg_list_annotations($options) {
  *
  *  annotation_ids => NULL|ARR Annotation IDs
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_annotations(array $options = array()) {

diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php
index a6b1bb43a85394707df89ffdda54edc5a452d6b6..2becc5f3c87670d7a639c98bc2d1fae7bf52889e 100644 (file)
--- a/engine/lib/metadata.php
+++ b/engine/lib/metadata.php
@@ -366,7 +366,6 @@ function elgg_enable_metadata(array $options) {
  * When in doubt, use name_value_pairs.
  *
  * @see elgg_get_entities
- * @see elgg_get_entities_from_annotations
  *
  * @param array $options Array in format:
  *
@@ -398,7 +397,7 @@ function elgg_enable_metadata(array $options) {
  *
  *  metadata_owner_guids => NULL|ARR guids for metadata owners
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @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 fd85ed9f09fd2a07c0b9caba7e892975aee2bfa8..365ef6fdf9962fd113431bed5cd6f34924b2a046 100644 (file)
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -978,7 +978,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
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  */
 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 e5e7b2213026b8926a9b2ad91ca437aa26728307..d7d819e1c482dca19590b85859324e3ad07c672d 100644 (file)
--- a/engine/lib/private_settings.php
+++ b/engine/lib/private_settings.php
@@ -38,7 +38,7 @@
  *                                     their own settings.
  *
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @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 9d5fd39b6a1fffe94f914a9935d30e31a944a906..f1da65a34118fc64b32de2206480163b11eb5289 100644 (file)
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -235,6 +235,11 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
 
 /**
  * Return entities matching a given query joining against a relationship.
+ * Also accepts all options available to elgg_get_entities() and
+ * elgg_get_entities_from_metadata().
+ *
+ * @see elgg_get_entities
+ * @see elgg_get_entities_from_metadata
  *
  * @param array $options Array in format:
  *
@@ -244,7 +249,7 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
  *
  *     inverse_relationship => BOOL Inverse the relationship
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_relationship($options) {
@@ -365,7 +370,7 @@ function elgg_list_entities_from_relationship(array $options = array()) {
  *
  * @param array $options An options array compatible with
  *                       elgg_get_entities_from_relationship()
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.8.0
  */
 function elgg_get_entities_from_relationship_count(array $options = array()) {