Refs #1411. Deprecated get_entities_by_relationship_count() and list_entities_by_rela...

git-svn-id: http://code.elgg.org/elgg/trunk@7569 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 3e129bc79554dc3e7c7bb999830eeda56c9813b4..5e5bf4ecd0c04d98a4c96df02a573eb5974a4c8b 100644 (file)
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -443,6 +443,7 @@ $fullview = true, $listtypetoggle = false, $pagination = true) {
  * @param array $options An options array compatible with
  *                       elgg_get_entities_from_relationship()
  * @return array
+ * @since 1.8
  */
 function elgg_get_entities_from_relationship_count(array $options = array()) {
        $options['selects'][] = "COUNT(e.guid) as total";
@@ -456,6 +457,8 @@ function elgg_get_entities_from_relationship_count(array $options = array()) {
  * This is a good way to get out the users with the most friends, or the groups with the
  * most members.
  *
+ * @deprecated 1.8 Use elgg_get_entities_from_relationship_count()
+ *
  * @param string $relationship         The relationship eg "friends_of"
  * @param bool   $inverse_relationship Inverse relationship owners
  * @param string $type                 The type of entity (default: all)
@@ -471,85 +474,64 @@ function elgg_get_entities_from_relationship_count(array $options = array()) {
 
 function get_entities_by_relationship_count($relationship, $inverse_relationship = true, $type = "",
 $subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $count = false, $site_guid = 0) {
+       elgg_deprecated_notice('get_entities_by_relationship_count() is deprecated by elgg_get_entities_from_relationship_count()', 1.8);
 
-       global $CONFIG;
-
-       $relationship = sanitise_string($relationship);
-       $inverse_relationship = (bool)$inverse_relationship;
-       $type = sanitise_string($type);
-       if ($subtype AND !$subtype = get_subtype_id($type, $subtype)) {
-               return false;
-       }
-       $owner_guid = (int)$owner_guid;
-       $order_by = sanitise_string($order_by);
-       $limit = (int)$limit;
-       $offset = (int)$offset;
-       $site_guid = (int) $site_guid;
-       if ($site_guid == 0) {
-               $site_guid = $CONFIG->site_guid;
-       }
-
-       //$access = get_access_list();
+       $options = array();
 
-       $where = array();
+       $options['relationship'] = $relationship;
 
-       if ($relationship != "") {
-               $where[] = "r.relationship='$relationship'";
-       }
+       // this used to default to true, which is wrong.
+       // flip it for the new function
+       $options['inverse_relationship'] = !$inverse_relationship;
 
-       if ($inverse_relationship) {
-               $on = 'e.guid = r.guid_two';
-       } else {
-               $on = 'e.guid = r.guid_one';
-       }
-       if ($type != "") {
-               $where[] = "e.type='$type'";
+       if ($type) {
+               $options['types'] = $type;
        }
 
        if ($subtype) {
-               $where[] = "e.subtype=$subtype";
+               $options['subtypes'] = $subtype;
        }
 
-       if ($owner_guid != "") {
-               $where[] = "e.container_guid='$owner_guid'";
+       if ($owner_guid) {
+               $options['owner_guid'] = $owner_guid;
        }
 
-       if ($site_guid > 0) {
-               $where[] = "e.site_guid = {$site_guid}";
-       }
+       $options['limit'] = $limit;
 
-       if ($count) {
-               $query = "SELECT count(distinct e.guid) as total ";
-       } else {
-               $query = "SELECT e.*, count(e.guid) as total ";
+       if ($offset) {
+               $options['offset'] = $offset;
        }
 
-       $query .= " from {$CONFIG->dbprefix}entity_relationships r
-               JOIN {$CONFIG->dbprefix}entities e on {$on} where ";
-
-       if (!empty($where)) {
-               foreach ($where as $w) {
-                       $query .= " $w and ";
-               }
+       if ($site_guid) {
+               $options['site_guid'];
        }
-       $query .= get_access_sql_suffix("e");
 
-       if (!$count) {
-               $query .= " group by e.guid ";
-               $query .= " order by total desc limit {$offset}, {$limit}";
-               return get_data($query, "entity_row_to_elggstar");
-       } else {
-               if ($count = get_data_row($query)) {
-                       return $count->total;
-               }
+       if ($count) {
+               $options['count'] = $count;
        }
 
-       return false;
+       return elgg_get_entities_from_relationship_count($options);
+}
+
+/**
+ * Returns a list of entities by relationship count
+ *
+ * @see elgg_get_entities_from_relationship_count()
+ *
+ * @param array $options Options array
+ *
+ * @return array
+ * @since 1.8
+ */
+function elgg_list_entities_from_relationship_count($options) {
+       return elgg_list_entities($options, 'elgg_get_entities_from_relationship_count');
 }
 
 /**
  * Displays a human-readable list of entities
  *
+ * @deprecated 1.8
+ *
  * @param string $relationship         The relationship eg "friends_of"
  * @param bool   $inverse_relationship Inverse relationship owners
  * @param string $type                 The type of entity (eg 'object')
@@ -567,14 +549,33 @@ function list_entities_by_relationship_count($relationship, $inverse_relationshi
 $type = "", $subtype = "", $owner_guid = 0, $limit = 10, $fullview = true,
 $listtypetoggle = false, $pagination = true) {
 
-       $limit = (int) $limit;
-       $offset = (int) get_input('offset');
-       $count = get_entities_by_relationship_count($relationship, $inverse_relationship,
-               $type, $subtype, $owner_guid, 0, 0, true);
-       $entities = get_entities_by_relationship_count($relationship, $inverse_relationship,
-               $type, $subtype, $owner_guid, $limit, $offset);
+       elgg_deprecated_notice('list_entities_by_relationship_count() was deprecated by elgg_list_entities_from_relationship_count()', 1.8);
+
+       $options = array();
+
+       $options['relationship'] = $relationship;
+
+       // this used to default to true, which is wrong.
+       // flip it for the new function
+       $options['inverse_relationship'] = !$inverse_relationship;
+
+       if ($type) {
+               $options['types'] = $type;
+       }
+
+       if ($subtype) {
+               $options['subtypes'] = $subtype;
+       }
+
+       if ($owner_guid) {
+               $options['owner_guid'] = $owner_guid;
+       }
+
+       $options['limit'] = $limit;
+
+       $options['full_view'] = $fullview;
 
-       return elgg_view_entity_list($entities, $count, $offset, $limit, $fullview, $listtypetoggle, $pagination);
+       return elgg_list_entities_from_relationship_count($options);
 }
 
 /**