aboutsummaryrefslogtreecommitdiff
path: root/engine
diff options
context:
space:
mode:
authorBrett Profitt <brett.profitt@gmail.com>2011-10-02 19:38:03 -0700
committerBrett Profitt <brett.profitt@gmail.com>2011-10-02 19:38:03 -0700
commit6da9015faa2147b2c8466db55005675a570f9b38 (patch)
tree6d759bdf006b861106b2bcc26612169593ce71f5 /engine
parentf423684b5303b4196c8c728eb06cbd6eb9aad8b1 (diff)
downloadelgg-6da9015faa2147b2c8466db55005675a570f9b38.tar.gz
elgg-6da9015faa2147b2c8466db55005675a570f9b38.tar.bz2
Merged docs update for getters from 1.7.
Diffstat (limited to 'engine')
-rw-r--r--engine/lib/access.php2
-rw-r--r--engine/lib/annotations.php2
-rw-r--r--engine/lib/entities.php2
-rw-r--r--engine/lib/metadata.php2
-rw-r--r--engine/lib/relationships.php2
5 files changed, 5 insertions, 5 deletions
diff --git a/engine/lib/access.php b/engine/lib/access.php
index 20f57ec41..1fe21861d 100644
--- 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 9ab5a1b39..14893aee6 100644
--- 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 abf7395e7..c8317d64d 100644
--- 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 2becc5f3c..e5389df38 100644
--- 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 f1da65a34..ede5ca1eb 100644
--- 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) {