<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][8514] trunk: Check `BP_User_Query` when using `friends_check_friendship_status()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8514">8514</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-06-14 18:49:55 +0000 (Sat, 14 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://buddypress.trac.wordpress.org/ticket/5703">#5703</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendsfiltersphp">trunk/src/bp-friends/bp-friends-filters.php</a></li>
<li><a href="#trunksrcbpfriendsbpfriendsfunctionsphp">trunk/src/bp-friends/bp-friends-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsfunctionsphp">trunk/tests/phpunit/testcases/friends/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendsfiltersphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-friends/bp-friends-filters.php (8513 => 8514)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-friends/bp-friends-filters.php 2014-06-14 18:43:47 UTC (rev 8513)
+++ trunk/src/bp-friends/bp-friends-filters.php 2014-06-14 18:49:55 UTC (rev 8514)
</span><span class="lines">@@ -38,7 +38,14 @@
</span><span class="cx"> $friend_id = bp_loggedin_user_id() == $fs->initiator_user_id ? $fs->friend_user_id : $fs->initiator_user_id;
</span><span class="cx">
</span><span class="cx"> if ( isset( $user_query->results[ $friend_id ] ) ) {
</span><del>- $user_query->results[ $friend_id ]->is_friend = $fs->is_confirmed;
</del><ins>+ 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;
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunksrcbpfriendsbpfriendsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-friends/bp-friends-functions.php (8513 => 8514)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-friends/bp-friends-functions.php 2014-06-14 18:43:47 UTC (rev 8513)
+++ trunk/src/bp-friends/bp-friends-functions.php 2014-06-14 18:49:55 UTC (rev 8514)
</span><span class="lines">@@ -195,13 +195,28 @@
</span><span class="cx"> /**
</span><span class="cx"> * Get the friendship status of two friends.
</span><span class="cx"> *
</span><del>- * Will return 'is_friends', 'not_friends', or 'pending'.
</del><ins>+ * Will return 'is_friends', 'not_friends', 'pending' or 'awaiting_response'.
</ins><span class="cx"> *
</span><span class="cx"> * @param int $user_id ID of the first user.
</span><span class="cx"> * @param int $possible_friend_id ID of the other user.
</span><span class="cx"> * @return string Friend status of the two users.
</span><span class="cx"> */
</span><span class="cx"> function friends_check_friendship_status( $user_id, $possible_friend_id ) {
</span><ins>+ 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';
+ }
+ }
+
</ins><span class="cx"> return BP_Friends_Friendship::check_is_friend( $user_id, $possible_friend_id );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesfriendsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/testcases/friends/functions.php (8513 => 8514)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/testcases/friends/functions.php 2014-06-14 18:43:47 UTC (rev 8513)
+++ trunk/tests/phpunit/testcases/friends/functions.php 2014-06-14 18:49:55 UTC (rev 8514)
</span><span class="lines">@@ -135,4 +135,96 @@
</span><span class="cx">
</span><span class="cx"> $this->assertTrue( friends_add_friend( $u1, $u2 ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @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 );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>