Changeset 8069

Timestamp:

03/06/2014 07:58:49 PM (11 years ago)

Author:

boonebgorges

Message:

Replace internals of BP_Group_Membership_Requests_Template with BP_Group_Member_Query

This brings us more in line with the Invites template functions, and is another
step toward centralizing all of our group queries.

The change also allows for true pagination. This changeset also adds the 'page'
parameter to the stack.

See #5440

Props dcavins

Location:

trunk

Files:

• bp-groups/bp-groups-classes.php (modified) (3 diffs)
• bp-groups/bp-groups-template.php (modified) (4 diffs)
• tests/testcases/groups/template.php (modified) (1 diff)

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

@@ -1455 +1455 @@
  * - *Pending and unsent invitations* are entries with is_confirmed = 0 and
  *   inviter_id != 0 and invite_sent = 0
+ * - *Membership requests* are entries with is_confirmed = 0 and
+ *   inviter_id = 0 (and invite_sent = 0)
  *
  * @since BuddyPress (1.8.0)
@@ -1723 +1725 @@
 
         $bp     = buddypress();
-        $extras = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified, is_banned FROM {$bp->groups->table_name_members} WHERE user_id IN ({$user_ids_sql}) AND group_id = %d", $this->query_vars['group_id'] ) );
+        $extras = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, date_modified, is_admin, is_mod, comments, user_title, invite_sent, is_confirmed, inviter_id, is_banned FROM {$bp->groups->table_name_members} WHERE user_id IN ({$user_ids_sql}) AND group_id = %d", $this->query_vars['group_id'] ) );
 
         foreach ( (array) $extras as $extra ) {
@@ -1729 +1731 @@
                 // user_id is provided for backward compatibility
                 $this->results[ $extra->user_id ]->user_id       = (int) $extra->user_id;
+                $this->results[ $extra->user_id ]->is_admin      = (int) $extra->is_admin;
+                $this->results[ $extra->user_id ]->is_mod        = (int) $extra->is_mod;
                 $this->results[ $extra->user_id ]->is_banned     = (int) $extra->is_banned;
                 $this->results[ $extra->user_id ]->date_modified = $extra->date_modified;
+                $this->results[ $extra->user_id ]->user_title    = $extra->user_title;
+                $this->results[ $extra->user_id ]->comments      = $extra->comments;
+                $this->results[ $extra->user_id ]->invite_sent   = (int) $extra->invite_sent;
+                $this->results[ $extra->user_id ]->inviter_id    = (int) $extra->inviter_id;
+                $this->results[ $extra->user_id ]->is_confirmed  = (int) $extra->is_confirmed;
+                $this->results[ $extra->user_id ]->membership_id = (int) $extra->id;
             }
         }

trunk/bp-groups/bp-groups-template.php

@@ -2937 +2937 @@
      *     @type int $per_page Number of records to return per page of
      *           results. Default: 10.
+     *     @type int $page Page of results to show. Default: 1.
      *     @type int $max Max items to return. Default: false (show all)
      * }
@@ -2959 +2960 @@
             'group_id' => bp_get_current_group_id(),
             'per_page' => 10,
-            'max' => false,
+            'page'     => 1,
+            'max'      => false,
+            'type'     => 'first_joined',
         ) );
 
-        $this->pag_page = isset( $_REQUEST['mrpage'] ) ? intval( $_REQUEST['mrpage'] ) : 1;
+        $this->pag_page = isset( $_REQUEST['mrpage'] ) ? intval( $_REQUEST['mrpage'] ) : $r['page'];
         $this->pag_num  = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $r['per_page'];
-        $this->requests = BP_Groups_Group::get_membership_requests( $r['group_id'], $this->pag_num, $this->pag_page );
-
-        if ( !$r['max'] || $r['max'] >= (int) $this->requests['total'] )
-            $this->total_request_count = (int) $this->requests['total'];
+
+        $mquery = new BP_Group_Member_Query( array(
+            'group_id' => $r['group_id'],
+            'type'     => $r['type'],
+            'per_page' => $this->pag_num,
+            'page'     => $this->pag_page,
+
+            // These filters ensure we only get pending requests
+            'is_confirmed' => false,
+            'inviter_id'   => 0,
+        ) );
+
+        $this->requests      = array_values( $mquery->results );
+        $this->request_count = count( $this->requests );
+
+        // Compatibility with legacy format of request data objects
+        foreach ( $this->requests as $rk => $rv ) {
+            // For legacy reasons, the 'id' property of each
+            // request must match the membership id, not the ID of
+            // the user (as it's returned by BP_Group_Member_Query)
+            $this->requests[ $rk ]->user_id = $rv->ID;
+            $this->requests[ $rk ]->id      = $rv->membership_id;
+
+            // Miscellaneous values
+            $this->requests[ $rk ]->group_id   = $r['group_id'];
+        }
+
+        if ( !$r['max'] || $r['max'] >= (int) $mquery->total_users )
+            $this->total_request_count = (int) $mquery->total_users;
         else
             $this->total_request_count = (int) $r['max'];
-
-        $this->requests = $this->requests['requests'];
 
         if ( $r['max'] ) {
@@ -3036 +3062 @@
 }
 
+/**
+ * Initialize a group membership request template loop.
+ *
+ * @param array $args {
+ *     @type int $group_id ID of the group. Defaults to current group.
+ *     @type int $per_page Number of records to return per page. Default: 10.
+ *     @type int $page Page of results to return. Default: 1.
+ *     @type int $max Max number of items to return. Default: false.
+ * }
+ * @return bool True if there are requests, otherwise false.
+ */
 function bp_group_has_membership_requests( $args = '' ) {
     global $requests_template, $groups_template;
@@ -3042 +3079 @@
         'group_id' => $groups_template->group->id,
         'per_page' => 10,
+        'page'     => 1,
         'max'      => false
     );

trunk/tests/testcases/groups/template.php

@@ -548 +548 @@
         for ( $i = 1; $i < 15; $i++ ) {
             $users[ $i ] = $this->create_user( array(
-                'last_activity' => gmdate( 'Y-m-d H:i:s', time() - $i ),
+                'last_activity' => gmdate( 'Y-m-d H:i:s', time() - ( 100 - $i ) ),
             ) );
 
             $memberships[ $i ] = $this->add_user_to_group( $users[ $i ], $g, array(
-                'date_modified' => gmdate( 'Y-m-d H:i:s', time() - $i ),
+                // this date_modified ensures that order will match
+                // id order. necessary due to a quirk in the legacy
+                // implementation
+                'date_modified' => gmdate( 'Y-m-d H:i:s', time() - ( 100 - $i ) ),
                 'is_confirmed' => 0,
                 'inviter_id' => 0,