Changeset 8045

Timestamp:

03/05/2014 02:37:30 PM (11 years ago)

Author:

boonebgorges

Message:

Swap bp_group_has_invites() internals for BP_Group_Member_Query, and introduce pagination arguments

See #5423

Props boonebgorges, dcavins

Location:

trunk

Files:

• bp-groups/bp-groups-template.php (modified) (4 diffs)
• tests/testcases/groups/template.php (modified) (2 diffs)

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

@@ -3095 +3095 @@
     var $total_invite_count;
 
-    function __construct( $user_id, $group_id ) {
-        $this->invites      = groups_get_invites_for_group( $user_id, $group_id );
-        $this->invite_count = count( $this->invites );
+    public function __construct( $args = array() ) {
+
+        // Backward compatibility with old method of passing arguments
+        if ( ! is_array( $args ) || func_num_args() > 1 ) {
+            _deprecated_argument( __METHOD__, '2.0.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+            $old_args_keys = array(
+                0  => 'user_id',
+                1  => 'group_id',
+            );
+
+            $func_args = func_get_args();
+            $args      = bp_core_parse_args_array( $old_args_keys, $func_args );
+        }
+
+        $r = wp_parse_args( $args, array(
+            'user_id'  => bp_loggedin_user_id(),
+            'group_id' => bp_get_current_group_id(),
+            'page'     => 1,
+            'per_page' => 10,
+        ) );
+
+        $this->pag_num  = intval( $r['per_page'] );
+        $this->pag_page = isset( $_REQUEST['invitepage'] ) ? intval( $_REQUEST['invitepage'] ) : $r['page'];
+
+        $iquery = new BP_Group_Member_Query( array(
+            'group_id' => $r['group_id'],
+            'type'     => 'first_joined',
+            'per_page' => $this->pag_num,
+            'page'     => $this->pag_page,
+
+            // These filters ensure we get only pending invites
+            'is_confirmed' => false,
+            'inviter_id'   => $r['user_id'],
+        ) );
+        $this->invite_data = $iquery->results;
+
+        $this->total_invite_count = $iquery->total_users;
+        $this->invites        = array_values( wp_list_pluck( $this->invite_data, 'ID' ) );
+        $this->invite_count       = count( $this->invites );
+
+        $this->pag_links = paginate_links( array(
+            'base'      => add_query_arg( 'invitepage', '%#%' ),
+            'format'    => '',
+            'total'     => ceil( $this->total_invite_count / $this->pag_num ),
+            'current'   => $this->pag_page,
+            'prev_text' => '←',
+            'next_text' => '→',
+            'mid_size'  => 1,
+        ) );
     }
 
@@ -3135 +3182 @@
     function the_invite() {
         global $group_id;
-
         $this->in_the_loop      = true;
         $user_id                = $this->next_invite();
+
         $this->invite           = new stdClass;
-        $this->invite->user     = new BP_Core_User( $user_id );
+        $this->invite->user     = $this->invite_data[ $user_id ];
+
+        // This method previously populated the user object with
+        // BP_Core_User. We manually configure BP_Core_User data for
+        // backward compatibility.
+        if ( bp_is_active( 'xprofile' ) ) {
+            $this->invite->user->profile_data = BP_XProfile_ProfileData::get_all_for_user( $user_id );
+        }
+
+        $this->invite->user->avatar       = bp_core_fetch_avatar( array( 'item_id' => $user_id, 'type' => 'full', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->invite->user->fullname ) ) );
+        $this->invite->user->avatar_thumb = bp_core_fetch_avatar( array( 'item_id' => $user_id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->invite->user->fullname ) ) );
+        $this->invite->user->avatar_mini  = bp_core_fetch_avatar( array( 'item_id' => $user_id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->invite->user->fullname ), 'width' => 30, 'height' => 30 ) );
+        $this->invite->user->email        = $this->invite->user->user_email;
+        $this->invite->user->user_url     = bp_core_get_user_domain( $user_id, $this->invite->user->user_nicename, $this->invite->user->user_login );
+        $this->invite->user->user_link    = "<a href='{$this->invite->user->user_url}' title='{$this->invite->user->fullname}'>{$this->invite->user->fullname}</a>";
+        $this->invite->user->last_active  = bp_core_get_last_activity( $this->invite->user->last_activity, __( 'active %s', 'buddypress' ) );
+
+        if ( bp_is_active( 'groups' ) ) {
+            $total_groups = BP_Groups_Member::total_group_count( $user_id );
+            $this->invite->user->total_groups = sprintf( _n( '%d group', '%d groups', $total_groups, 'buddypress' ), $total_groups );
+        }
+
+        if ( bp_is_active( 'friends' ) ) {
+            $this->invite->user->total_friends = BP_Friends_Friendship::total_friend_count( $user_id );
+        }
+
+        if ( bp_is_active( 'friends' ) ) {
+            $this->invite->user->total_friends = BP_Friends_Friendship::total_friend_count( $user_id );
+        }
+
+        $this->invite->user->total_blogs = null;
+
         $this->invite->group_id = $group_id; // Globaled in bp_group_has_invites()
 
@@ -3152 +3230 @@
     $r = wp_parse_args( $args, array(
         'group_id' => false,
-        'user_id' => bp_loggedin_user_id()
+        'user_id'  => bp_loggedin_user_id(),
+        'per_page' => 10,
+        'page'     => 1,
     ) );
 
@@ -3172 +3252 @@
     }
 
-    $invites_template = new BP_Groups_Invite_Template( $r['user_id'], $r['group_id'] );
+    $invites_template = new BP_Groups_Invite_Template( $r );
     return apply_filters( 'bp_group_has_invites', $invites_template->has_invites(), $invites_template );
 }

trunk/tests/testcases/groups/template.php

@@ -476 +476 @@
             $this_user = new BP_Core_User( $found_users[ $counter ] );
             foreach ( get_object_vars( $this_user ) as $k => $v ) {
+                // Doesn't matter if the backpat provides *more*
+                // details than the old method, so we skip cases
+                // where the BP_Core_User value is empty
+                if ( empty( $v ) ) {
+                    continue;
+                }
+
                 $this->assertEquals( $v, $invites_template->invite->user->{$k} );
             }
@@ -481 +488 @@
         endwhile;
     }
+
+    /**
+     * @group bp_group_has_invites
+     * @group BP_Groups_Invite_Template
+     */
+    public function test_bp_group_has_invites_pagination() {
+        $u1 = $this->create_user( array(
+            'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 60 ),
+        ) );
+
+        $g = $this->factory->group->create( array(
+            'creator_id' => $u1,
+        ) );
+
+        $users = array();
+        for ( $i = 1; $i < 15; $i++ ) {
+            $users[ $i ] = $this->create_user( array(
+                'last_activity' => gmdate( 'Y-m-d H:i:s', time() - $i ),
+            ) );
+
+            $this->add_user_to_group( $users[ $i ], $g, array(
+                'date_modified' => gmdate( 'Y-m-d H:i:s', time() - $i ),
+                'is_confirmed' => 0,
+                'inviter_id' => $u1,
+                'invite_sent' => true,
+            ) );
+        }
+
+        // Populate the global
+        bp_group_has_invites( array(
+            'group_id' => $g,
+            'user_id' => $u1,
+            'page' => 2,
+            'per_page' => 5,
+        ) );
+
+        global $invites_template;
+
+        $this->assertEquals( array( $users[ 9 ], $users[ 8 ], $users[ 7 ], $users[ 6 ], $users[ 5 ], ), $invites_template->invites );
+    }
 }