<!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][7296] branches/1.8: Tell BP_Group_Member_Query queries to order by FIELD()</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/7296">7296</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-07-23 17:31:39 +0000 (Tue, 23 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Tell BP_Group_Member_Query queries to order by FIELD()
BP_Group_Member_Query works by first querying for a list of group members
that match the query params, sorted by date_modified. Then, it feeds those ids
to the BP_User_Query parent class. In order to maintain the proper
date_modified sort, we have to override BP_User_Query's ORDER BY param, and
replace it with ORDER BY FIELD(), using the user ids from the first query.
This fixes a regression in BP 1.8, where the default sort order for
bp_group_has_members() was inadvertantly changed to user_id DESC, rather than
the legacy date_modified that existed before the introduction of
BP_Group_Member_Query.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5106">#5106</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches18bpgroupsbpgroupsclassesphp">branches/1.8/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#branches18teststestcasesgroupstemplatephp">branches/1.8/tests/testcases/groups/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches18bpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: branches/1.8/bp-groups/bp-groups-classes.php (7295 => 7296)</h4>
<pre class="diff"><span>
<span class="info">--- branches/1.8/bp-groups/bp-groups-classes.php 2013-07-23 15:35:17 UTC (rev 7295)
+++ branches/1.8/bp-groups/bp-groups-classes.php 2013-07-23 17:31:39 UTC (rev 7296)
</span><span class="lines">@@ -966,6 +966,14 @@
</span><span class="cx"> */
</span><span class="cx"> class BP_Group_Member_Query extends BP_User_Query {
</span><span class="cx"> /**
</span><ins>+ * Array of group member ids, cached to prevent redundant lookups
+ *
+ * @var null|array Null if not yet defined, otherwise an array of ints
+ * @since BuddyPress (1.8.1)
+ */
+ protected $group_member_ids;
+
+ /**
</ins><span class="cx"> * Set up action hooks
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.8)
</span><span class="lines">@@ -978,6 +986,9 @@
</span><span class="cx"> $this->query_vars_raw['type'] = 'last_modified';
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Set the sort order
+ add_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
+
</ins><span class="cx"> // Set up our populate_extras method
</span><span class="cx"> add_action( 'bp_user_query_populate_extras', array( $this, 'populate_group_member_extras' ), 10, 2 );
</span><span class="cx"> }
</span><span class="lines">@@ -1028,6 +1039,10 @@
</span><span class="cx"> protected function get_group_member_ids() {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><ins>+ if ( is_array( $this->group_member_ids ) ) {
+ return $this->group_member_ids;
+ }
+
</ins><span class="cx"> $bp = buddypress();
</span><span class="cx"> $sql = array(
</span><span class="cx"> 'select' => "SELECT user_id FROM {$bp->groups->table_name_members}",
</span><span class="lines">@@ -1106,10 +1121,34 @@
</span><span class="cx"> $sql['order'] = "DESC";
</span><span class="cx">
</span><span class="cx"> /** LIMIT clause ******************************************************/
</span><ins>+ $this->group_member_ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
</ins><span class="cx">
</span><del>- $ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
</del><ins>+ return $this->group_member_ids;
+ }
</ins><span class="cx">
</span><del>- return $ids;
</del><ins>+ /**
+ * Tell BP_User_Query to order by the order of our query results
+ *
+ * This implementation assumes the 'last_modified' sort order
+ * hardcoded in BP_Group_Member_Query::get_group_member_ids().
+ *
+ * @param object $query BP_User_Query object
+ */
+ public function set_orderby( $query ) {
+ $gm_ids = $this->get_group_member_ids();
+ if ( empty( $gm_ids ) ) {
+ $gm_ids = array( 0 );
+ }
+
+ // The first param in the FIELD() clause is the sort column id
+ $gm_ids = array_merge( array( 'u.id' ), wp_parse_id_list( $gm_ids ) );
+ $gm_ids_sql = implode( ',', $gm_ids );
+
+ $query->uid_clauses['orderby'] = "ORDER BY FIELD(" . $gm_ids_sql . ")";
+
+ // Prevent this filter from running on future BP_User_Query
+ // instances on the same page
+ remove_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="branches18teststestcasesgroupstemplatephp"></a>
<div class="modfile"><h4>Modified: branches/1.8/tests/testcases/groups/template.php (7295 => 7296)</h4>
<pre class="diff"><span>
<span class="info">--- branches/1.8/tests/testcases/groups/template.php 2013-07-23 15:35:17 UTC (rev 7295)
+++ branches/1.8/tests/testcases/groups/template.php 2013-07-23 17:31:39 UTC (rev 7296)
</span><span class="lines">@@ -351,4 +351,44 @@
</span><span class="cx"> $this->assertEquals( array( $u1, $u2, ), $ids );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Default sort order should be the joined date
+ *
+ * @tickett BP5106
+ * @group bp_group_has_members
+ */
+ public function test_bp_group_has_members_default_order() {
+ $u1 = $this->create_user( array(
+ 'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 60 ),
+ ) );
+ $u2 = $this->create_user( array(
+ 'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 600 ),
+ ) );
+ $u3 = $this->create_user( array(
+ 'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 6000 ),
+ ) );
+
+
+ $g = $this->factory->group->create( array(
+ 'creator_id' => $u1,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', time() - 60*60*24 ),
+ ) );
+
+ $this->add_user_to_group( $u3, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', time() - 60*60*12 ),
+ ) );
+
+ global $members_template;
+ bp_group_has_members( array(
+ 'group_id' => $g,
+ 'exclude_banned' => 0,
+ 'exclude_admins_mods' => false,
+ ) );
+
+ $ids = wp_parse_id_list( wp_list_pluck( $members_template->members, 'user_id' ) );
+ $this->assertEquals( array( $u1, $u3, $u2, ), $ids );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>