Changeset 8514

Timestamp:

06/14/2014 06:49:55 PM (11 years ago)

Author:

r-a-y

Message:

Check BP_User_Query when using friends_check_friendship_status().

Previously, friends_check_friendship_status() did not reference the data
already queried in the members loop via BP_User_Query. As a result, if
a user was logged in and viewing the member directory, this added twenty
additional DB queries to the page.

This commit:

• Adds an additional property - friendship_status - to bp_friends_filter_user_query_populate_extras(). This property references the various friendship statuses from BP_Friends_Friendship::check_is_friend()
• Checks this new property in friends_check_friendship_status() before querying the DB
• Adds unit tests

Props r-a-y, boonebgorges.

Fixes #5703.

Location:

trunk

Files:

• src/bp-friends/bp-friends-filters.php (modified) (1 diff)
• src/bp-friends/bp-friends-functions.php (modified) (2 diffs)
• tests/phpunit/testcases/friends/functions.php (modified) (1 diff)

trunk/src/bp-friends/bp-friends-filters.php

@@ -39 +39 @@
 
         if ( isset( $user_query->results[ $friend_id ] ) ) {
-            $user_query->results[ $friend_id ]->is_friend = $fs->is_confirmed;
+            if ( 0 == $fs->is_confirmed ) {
+                $status = $fs->initiator_user_id == bp_loggedin_user_id() ? 'pending' : 'awaiting_response';
+            } else {
+                $status = 'is_friend';
+            }
+
+            $user_query->results[ $friend_id ]->is_friend         = $fs->is_confirmed;
+            $user_query->results[ $friend_id ]->friendship_status = $status;
         }
     }

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

@@ -196 +196 @@
  * Get the friendship status of two friends.
  *
- * Will return 'is_friends', 'not_friends', or 'pending'.
+ * Will return 'is_friends', 'not_friends', 'pending' or 'awaiting_response'.
  *
  * @param int $user_id ID of the first user.
@@ -203 +203 @@
  */
 function friends_check_friendship_status( $user_id, $possible_friend_id ) {
+    global $members_template;
+
+    // check the BP_User_Query first
+    // @see bp_friends_filter_user_query_populate_extras()
+    if ( ! empty( $members_template->in_the_loop ) ) {
+        if ( isset( $members_template->member->friendship_status ) ) {
+            return $members_template->member->friendship_status;
+
+        // make sure that the friends BP_User_Query was registered before assuming
+        // status as 'not_friends'
+        } elseif ( has_filter( 'bp_user_query_populate_extras', 'bp_friends_filter_user_query_populate_extras' ) ) {
+            return 'not_friends';
+        }
+    }
+
     return BP_Friends_Friendship::check_is_friend( $user_id, $possible_friend_id );
 }

trunk/tests/phpunit/testcases/friends/functions.php

@@ -136 +136 @@
         $this->assertTrue( friends_add_friend( $u1, $u2 ) );
     }
+
+    /**
+     * @group friends_check_friendship_status
+     */
+    public function test_friends_check_friendship_status_in_members_loop() {
+        $now = time();
+        $u1 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now ),
+        ) );
+        $u2 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+        $u3 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 200 ),
+        ) );
+        $u4 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 300 ),
+        ) );
+        $u5 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 400 ),
+        ) );
+
+        friends_add_friend( $u1, $u2, true );
+        friends_add_friend( $u1, $u3, false );
+        friends_add_friend( $u4, $u1, false );
+
+        $old_user = get_current_user_id();
+        $this->set_current_user( $u1 );
+
+        $found = array();
+        if ( bp_has_members() ) : while ( bp_members() ) : bp_the_member();
+            $found[ bp_get_member_user_id() ] = friends_check_friendship_status( $u1, bp_get_member_user_id() );
+        endwhile; endif;
+
+        $expected = array(
+            $u1 => 'not_friends',
+            $u2 => 'is_friend',
+            $u3 => 'pending',
+            $u4 => 'awaiting_response',
+            $u5 => 'not_friends',
+        );
+
+        $this->assertSame( $expected, $found );
+
+        // clean up
+        $GLOBALS['members_template'] = null;
+        $this->set_current_user( $old_user );
+    }
+
+    /**
+     * @group friends_check_friendship_status
+     */
+    public function test_friends_check_friendship_status_not_in_members_loop() {
+        $now = time();
+        $u1 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now ),
+        ) );
+        $u2 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+        $u3 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 200 ),
+        ) );
+        $u4 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 300 ),
+        ) );
+        $u5 = $this->create_user( array(
+            'last_activity' => date( 'Y-m-d H:i:s', $now - 400 ),
+        ) );
+
+        friends_add_friend( $u1, $u2, true );
+        friends_add_friend( $u1, $u3, false );
+        friends_add_friend( $u4, $u1, false );
+
+        $found = array(
+            $u1 => friends_check_friendship_status( $u1, $u1 ),
+            $u2 => friends_check_friendship_status( $u1, $u2 ),
+            $u3 => friends_check_friendship_status( $u1, $u3 ),
+            $u4 => friends_check_friendship_status( $u1, $u4 ),
+            $u5 => friends_check_friendship_status( $u1, $u5 ),
+        );
+
+        $expected = array(
+            $u1 => 'not_friends',
+            $u2 => 'is_friend',
+            $u3 => 'pending',
+            $u4 => 'awaiting_response',
+            $u5 => 'not_friends',
+        );
+
+        $this->assertSame( $expected, $found );
+    }
 }