Changeset 7898

Timestamp:

02/16/2014 09:47:18 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce $args param to BP_Groups_Group constructor and groups_get_group()

This argument array can contain the following toggles:

• update_meta_cache (pre-fetch all group metadata for the queried group)
• populate_extras (pre-fetch last activity, admin/mod lists, and current user access/membership status in queried group)

Both items default to false, for backward compatibility

Allowing these pre-fetch toggles to be set to false allows us to avoid large
numbers of unnecessary database queries in certain cases, such as when
secondary avatars are populated on activity directories.

See #5398

Location:

trunk/bp-groups

Files:

• bp-groups-classes.php (modified) (4 diffs)
• bp-groups-functions.php (modified) (2 diffs)

trunk/bp-groups/bp-groups-classes.php

@@ -147 +147 @@
 
     /**
+     * Raw arguments passed to the constructor.
+     *
+     * @since BuddyPress (2.0.0)
+     * @var array
+     */
+    protected $args;
+
+    /**
      * Constructor method.
      *
@@ -152 +160 @@
      *        the object will be pre-populated with info about that group.
      */
-    public function __construct( $id = null ) {
+    public function __construct( $id = null, $args = array() ) {
+        $this->args = $args;
+
         if ( !empty( $id ) ) {
             $this->id = $id;
@@ -166 +176 @@
 
         if ( $group = $wpdb->get_row( $wpdb->prepare( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id = %d", $this->id ) ) ) {
-            bp_groups_update_meta_cache( $this->id );
+            if ( ! empty( $this->args['update_meta_cache'] ) ) {
+                bp_groups_update_meta_cache( $this->id );
+            }
 
             $this->id                 = $group->id;
@@ -176 +188 @@
             $this->enable_forum       = $group->enable_forum;
             $this->date_created       = $group->date_created;
-            $this->last_activity      = groups_get_groupmeta( $this->id, 'last_activity' );
-            $this->total_member_count = groups_get_groupmeta( $this->id, 'total_member_count' );
-            $this->is_member          = BP_Groups_Member::check_is_member( bp_loggedin_user_id(), $this->id );
-            $this->is_invited         = BP_Groups_Member::check_has_invite( bp_loggedin_user_id(), $this->id );
-            $this->is_pending         = BP_Groups_Member::check_for_membership_request( bp_loggedin_user_id(), $this->id );
-
-            // If this is a private or hidden group, does the current user have access?
-            if ( 'private' == $this->status || 'hidden' == $this->status ) {
-                if ( $this->is_member && is_user_logged_in() || bp_current_user_can( 'bp_moderate' ) )
+
+            if ( ! empty( $this->args['populate_extras'] ) ) {
+                $this->last_activity      = groups_get_groupmeta( $this->id, 'last_activity' );
+                $this->total_member_count = groups_get_groupmeta( $this->id, 'total_member_count' );
+                $this->is_member          = BP_Groups_Member::check_is_member( bp_loggedin_user_id(), $this->id );
+                $this->is_invited         = BP_Groups_Member::check_has_invite( bp_loggedin_user_id(), $this->id );
+                $this->is_pending         = BP_Groups_Member::check_for_membership_request( bp_loggedin_user_id(), $this->id );
+
+                // If this is a private or hidden group, does the current user have access?
+                if ( 'private' == $this->status || 'hidden' == $this->status ) {
+                    if ( $this->is_member && is_user_logged_in() || bp_current_user_can( 'bp_moderate' ) )
+                        $this->user_has_access = true;
+                    else
+                        $this->user_has_access = false;
+                } else {
                     $this->user_has_access = true;
-                else
-                    $this->user_has_access = false;
-            } else {
-                $this->user_has_access = true;
-            }
-
-            // Get group admins and mods
-            $admin_mods = $wpdb->get_results( apply_filters( 'bp_group_admin_mods_user_join_filter', $wpdb->prepare( "SELECT u.ID as user_id, u.user_login, u.user_email, u.user_nicename, m.is_admin, m.is_mod FROM {$wpdb->users} u, {$bp->groups->table_name_members} m WHERE u.ID = m.user_id AND m.group_id = %d AND ( m.is_admin = 1 OR m.is_mod = 1 )", $this->id ) ) );
-            foreach( (array) $admin_mods as $user ) {
-                if ( (int) $user->is_admin )
-                    $this->admins[] = $user;
-                else
-                    $this->mods[] = $user;
+                }
+
+                // Get group admins and mods
+                $admin_mods = $wpdb->get_results( apply_filters( 'bp_group_admin_mods_user_join_filter', $wpdb->prepare( "SELECT u.ID as user_id, u.user_login, u.user_email, u.user_nicename, m.is_admin, m.is_mod FROM {$wpdb->users} u, {$bp->groups->table_name_members} m WHERE u.ID = m.user_id AND m.group_id = %d AND ( m.is_admin = 1 OR m.is_mod = 1 )", $this->id ) ) );
+                foreach( (array) $admin_mods as $user ) {
+                    if ( (int) $user->is_admin )
+                        $this->admins[] = $user;
+                    else
+                        $this->mods[] = $user;
+                }
             }
         } else {

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

@@ -42 +42 @@
 function groups_get_group( $args = '' ) {
     $defaults = array(
-        'group_id'   => false,
-        'load_users' => false
+        'group_id'          => false,
+        'load_users'        => false,
+        'populate_extras'   => true,
+        'update_meta_cache' => true,
     );
 
@@ -52 +54 @@
 
     if ( !$group = wp_cache_get( $cache_key, 'bp' ) ) {
-        $group = new BP_Groups_Group( $group_id, true, $load_users );
+        $group_args = array(
+            'populate_extras'   => $populate_extras,
+            'update_meta_cache' => $update_meta_cache,
+        );
+
+        $group = new BP_Groups_Group( $group_id, $group_args );
         wp_cache_set( $cache_key, $group, 'bp' );
     }