Changeset 11762

Timestamp:

12/06/2017 04:18:11 PM (7 years ago)

Author:

djpaul

Message:

Groups: add 'fields' parameter to BP_Groups_Group::get().

Allows return of only group IDs instead of entire objects when fields=ids is set, similiar to the fields parameter in WP_Query.

Fixes #7609

Props dcavins

Location:

trunk

Files:

• src/bp-groups/bp-groups-functions.php (modified) (2 diffs)
• src/bp-groups/classes/class-bp-groups-group.php (modified) (4 diffs)
• tests/phpunit/testcases/groups/class-bp-groups-group.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-functions.php

@@ -797 +797 @@
         'update_meta_cache'  => true,           // Pre-fetch groupmeta for queried groups.
         'update_admin_cache' => false,
+        'fields'             => 'all',          // Return BP_Groups_Group objects or a list of ids.
     );
 
@@ -822 +823 @@
         'order'              => $r['order'],
         'orderby'            => $r['orderby'],
+        'fields'             => $r['fields'],
     ) );
 

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -1026 +1026 @@
      *                                            results to. If specified, $show_hidden is ignored.
      *                                            Default: empty array.
+     *     @type string       $fields             Which fields to return. Specify 'ids' to fetch a list of IDs.
+     *                                            Default: 'all' (return BP_Groups_Group objects).
+     *                                            If set, meta and admin caches will not be prefetched.
      * }
      * @return array {
      *     @type array $groups Array of group objects returned by the
-     *                         paginated query.
+     *                         paginated query. (IDs only if `fields` is set to `ids`.)
      *     @type int   $total  Total count of all groups matching non-
      *                         paginated query params.
@@ -1076 +1079 @@
             'exclude'            => false,
             'show_hidden'        => false,
-            'status'             => array()
+            'status'             => array(),
+            'fields'             => 'all',
         );
 
@@ -1300 +1304 @@
         }
 
-        $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
-        if ( $uncached_group_ids ) {
-            $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
-            $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
-            foreach ( $group_data_objects as $group_data_object ) {
-                wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+        if ( 'ids' === $r['fields'] ) {
+            // We only want the IDs.
+            $paged_groups = array_map( 'intval', $paged_group_ids );
+        } else {
+            $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
+            if ( $uncached_group_ids ) {
+                $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
+                $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
+                foreach ( $group_data_objects as $group_data_object ) {
+                    wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+                }
             }
-        }
-
-        $paged_groups = array();
-        foreach ( $paged_group_ids as $paged_group_id ) {
-            $paged_groups[] = new BP_Groups_Group( $paged_group_id );
-        }
-
+
+            $paged_groups = array();
+            foreach ( $paged_group_ids as $paged_group_id ) {
+                $paged_groups[] = new BP_Groups_Group( $paged_group_id );
+            }
+
+            $group_ids = array();
+            foreach ( (array) $paged_groups as $group ) {
+                $group_ids[] = $group->id;
+            }
+
+            // Grab all groupmeta.
+            if ( ! empty( $r['update_meta_cache'] ) ) {
+                bp_groups_update_meta_cache( $group_ids );
+            }
+
+            // Prefetch all administrator IDs, if requested.
+            if ( $r['update_admin_cache'] ) {
+                BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
+            }
+
+            // Set up integer properties needing casting.
+            $int_props = array(
+                'id', 'creator_id', 'enable_forum'
+            );
+
+            // Integer casting.
+            foreach ( $paged_groups as $key => $g ) {
+                foreach ( $int_props as $int_prop ) {
+                    $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
+                }
+            }
+
+        }
+
+        // Find the total number of groups in the results set.
         $total_groups_sql = "SELECT COUNT(DISTINCT g.id) FROM {$sql['from']} $where";
 
@@ -1334 +1372 @@
             $total_groups = (int) $cached;
         }
-
-        $group_ids = array();
-        foreach ( (array) $paged_groups as $group ) {
-            $group_ids[] = $group->id;
-        }
-
-        // Grab all groupmeta.
-        if ( ! empty( $r['update_meta_cache'] ) ) {
-            bp_groups_update_meta_cache( $group_ids );
-        }
-
-        // Prefetch all administrator IDs, if requested.
-        if ( $r['update_admin_cache'] ) {
-            BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
-        }
-
-        // Set up integer properties needing casting.
-        $int_props = array(
-            'id', 'creator_id', 'enable_forum'
-        );
-
-        // Integer casting.
-        foreach ( $paged_groups as $key => $g ) {
-            foreach ( $int_props as $int_prop ) {
-                $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
-            }
-        }
-
-        unset( $sql, $total_sql );
 
         return array( 'groups' => $paged_groups, 'total' => $total_groups );

trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -2235 +2235 @@
     }
 
+    /**
+     * @group get_ids_only
+     */
+    public function test_get_return_ids_only() {
+        $now = time();
+        $g1 = $this->factory->group->create( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60 ),
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*2 ),
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*3 ),
+        )  );
+
+        $groups = BP_Groups_Group::get( array(
+            'fields' => 'ids',
+        ) );
+
+        $this->assertSame( array( $g1, $g2, $g3 ), $groups['groups'] );
+    }
+
 }