Merged docs update for getters from 1.7.

diff --git a/engine/lib/access.php b/engine/lib/access.php
index 20f57ec416f9bee8e5c713548d20a5efb36d4a32..1fe21861d52d9b0b27648d5cada673060b66ce6b 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 mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed if count, int. if not count, array or false if no entities. false also 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 9ab5a1b393b6f4b6f048b52946c0be2d668e0620..14893aee668c0f79ab4bbb99e2f81894c81ff4a3 100644 (file)
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -319,7 +319,7 @@ function elgg_list_annotations($options) {
  *
  *  annotation_ids => NULL|ARR Annotation IDs
  *
- * @return mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed if count, int. if not count, array or false if no entities. false also on errors.
  * @since 1.7.0
  */
 function elgg_get_entities_from_annotations(array $options = array()) {

diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index abf7395e751e6861df4dfbbac6c3589fad08001f..c8317d64d94def50afe6cc9f1828987ab43ef4ee 100644 (file)
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -772,7 +772,7 @@ function elgg_entity_exists($guid) {
  *
  *     callback => string A callback function to pass each row through
  *
- * @return mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed if count, int. if not count, array or false if no entities. false also on errors.
  * @since 1.7.0
  * @see elgg_get_entities_from_metadata()
  * @see elgg_get_entities_from_relationship()

diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php
index 2becc5f3c87670d7a639c98bc2d1fae7bf52889e..e5389df388ac23d638d80916d3d1b5adfd970c27 100644 (file)
--- a/engine/lib/metadata.php
+++ b/engine/lib/metadata.php
@@ -397,7 +397,7 @@ function elgg_enable_metadata(array $options) {
  *
  *  metadata_owner_guids => NULL|ARR guids for metadata owners
  *
- * @return mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed  if count, int. if not count, array or false if no entities. false also on errors.
  * @since 1.7.0
  */
 function elgg_get_entities_from_metadata(array $options = array()) {

diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index f1da65a34118fc64b32de2206480163b11eb5289..ede5ca1eb6a81f3bbe99b13b178b17a541b39aff 100644 (file)
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -249,7 +249,7 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
  *
  *     inverse_relationship => BOOL Inverse the relationship
  *
- * @return mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed if count, int. if not count, array or false if no entities. false also on errors.
  * @since 1.7.0
  */
 function elgg_get_entities_from_relationship($options) {