Changeset 7374

Timestamp:

09/07/2013 01:02:33 AM (13 years ago)

Author:

boonebgorges

Message:

Rework "Cancel Friendship Request" button UX in member directories

Member directories have friendship action buttons for each user: notably,
Add Friend for non-friends and Remove Friend for existing friends. When
A has sent a friendship request to B, the button becomes "Cancel Friendship
Request". However, it makes no sense for B to see the same button text for
the pending request, since it's not hers to cancel.

This changeset makes it so that B will see "Friendship Requested", and
the button will lead to B's Friend Requests page, so that she can accept
or reject the request using the latter existing UI.

Fixes #5157

Props terraling

Location:

trunk

Files:

• bp-friends/bp-friends-classes.php (modified) (1 diff)
• bp-friends/bp-friends-template.php (modified) (1 diff)
• tests/testcases/friends/class-bp-friends-friendship.php (modified) (1 diff)

trunk/bp-friends/bp-friends-classes.php

@@ -183 +183 @@
         }
 
-        public static function check_is_friend( $loggedin_userid, $possible_friend_userid ) {
-                global $wpdb, $bp;
-
-                if ( empty( $loggedin_userid ) || empty( $possible_friend_userid ) )
-                        return false;
-
-                $result = $wpdb->get_results( $wpdb->prepare( "SELECT id, is_confirmed FROM {$bp->friends->table_name} WHERE (initiator_user_id = %d AND friend_user_id = %d) OR (initiator_user_id = %d AND friend_user_id = %d)", $loggedin_userid, $possible_friend_userid, $possible_friend_userid, $loggedin_userid ) );
-
-                if ( !empty( $result ) ) {
+        /**
+         * Check friendship status between two users
+         *
+         * Note that 'pending' means that $initiator_userid has sent a friend
+         * request to $possible_friend_userid that has not yet been approved,
+         * while 'awaiting_response' is the other way around ($possible_friend_userid
+         * sent the initial request)
+         *
+         * @param int $initiator_userid The id of the user who is the initiator
+         *   of the potential friendship/request.
+         * @param int $possible_friend_userid The id of the user who is the
+         *   recipient of the potential friendship/request.
+         * @return string The friendship status, from among 'not_friends',
+         *   'is_friend', 'pending', and 'awaiting_response'
+         */
+        public static function check_is_friend( $initiator_userid, $possible_friend_userid ) {
+                global $wpdb, $bp;
+
+                if ( empty( $initiator_userid ) || empty( $possible_friend_userid ) ) {
+                        return false;
+                }
+
+                $result = $wpdb->get_results( $wpdb->prepare( "SELECT id, initiator_user_id, is_confirmed FROM {$bp->friends->table_name} WHERE (initiator_user_id = %d AND friend_user_id = %d) OR (initiator_user_id = %d AND friend_user_id = %d)", $initiator_userid, $possible_friend_userid, $possible_friend_userid, $initiator_userid ) );
+
+                if ( ! empty( $result ) ) {
                         if ( 0 == (int) $result[0]->is_confirmed ) {
-                                return 'pending';
+                                $status = $initiator_userid == $result[0]->initiator_user_id ? 'pending' : 'awaiting_response';
                         } else {
-                                return 'is_friend';
+                                $status = 'is_friend';
                         }
                 } else {
-                        return 'not_friends';
-                }
+                        $status = 'not_friends';
+                }
+
+                return $status;
         }
 

trunk/bp-friends/bp-friends-template.php

@@ -291 +291 @@
                                 break;
 
+                        case 'awaiting_response' :
+                                $button = array(
+                                        'id'                => 'awaiting_response',
+                                        'component'         => 'friends',
+                                        'must_be_logged_in' => true,
+                                        'block_self'        => true,
+                                        'wrapper_class'     => 'friendship-button awaiting_response_friend',
+                                        'wrapper_id'        => 'friendship-button-' . $potential_friend_id,
+                                        'link_href'         => bp_loggedin_user_domain() . bp_get_friends_slug() . '/requests/',
+                                        'link_text'         => __( 'Friendship Requested', 'buddypress' ),
+                                        'link_title'        => __( 'Friendship Requested', 'buddypress' ),
+                                        'link_id'           => 'friend-' . $potential_friend_id,
+                                        'link_rel'          => 'remove',
+                                        'link_class'        => 'friendship-button awaiting_response_friend requested'
+                                );
+                                break;
+
                         case 'is_friend' :
                                 $button = array(

trunk/tests/testcases/friends/class-bp-friends-friendship.php

@@ -78 +78 @@
         }
 
+        /**
+         * @group check_is_friend
+         */
+        public function test_check_is_friend_not_friends() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                $this->assertEquals( 'not_friends', BP_Friends_Friendship::check_is_friend( $u1, $u2 ) );
+        }
 
+        /**
+         * @group check_is_friend
+         */
+        public function test_check_is_friend_pending() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                friends_add_friend( $u1, $u2, false );
+                $this->assertEquals( 'pending', BP_Friends_Friendship::check_is_friend( $u1, $u2 ) );
+        }
 
+        /**
+         * @group check_is_friend
+         */
+        public function test_check_is_friend_awaiting_response() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                friends_add_friend( $u1, $u2, false );
+                $this->assertEquals( 'awaiting_response', BP_Friends_Friendship::check_is_friend( $u2, $u1 ) );
+        }
+
+        /**
+         * @group check_is_friend
+         */
+        public function test_check_is_friend_is_friend() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                friends_add_friend( $u1, $u2, true );
+                $this->assertEquals( 'is_friend', BP_Friends_Friendship::check_is_friend( $u1, $u2 ) );
+        }
 }