aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/relationships.php
diff options
context:
space:
mode:
authorBrett Profitt <brett.profitt@gmail.com>2011-10-02 11:17:56 -0700
committerBrett Profitt <brett.profitt@gmail.com>2011-10-02 11:17:56 -0700
commitdd55b4b87cb1c89ceeb45ccf49ce648339a86041 (patch)
tree035059f5f06a2f6595110aff7c620380b46af103 /engine/lib/relationships.php
parentbfdb9bb8a87a29038ba1ae25355684ae19678fdd (diff)
parentad016fd1254aa03afa7c24fdb82b35faa3c5019f (diff)
downloadelgg-dd55b4b87cb1c89ceeb45ccf49ce648339a86041.tar.gz
elgg-dd55b4b87cb1c89ceeb45ccf49ce648339a86041.tar.bz2
Merge branch 'master' of github.com:Elgg/Elgg
Diffstat (limited to 'engine/lib/relationships.php')
-rw-r--r--engine/lib/relationships.php9
1 files changed, 7 insertions, 2 deletions
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 9d5fd39b6..f1da65a34 100644
--- 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()) {