<!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][11533] trunk: Add 'meta_id' orderby option to BP_Groups_Group::get().</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/11533">11533</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/11533","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-04-20 00:56:53 +0000 (Thu, 20 Apr 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add 'meta_id' orderby option to BP_Groups_Group::get().
Add `meta_id` orderby option to `groups_get_groups()` and its
underlying function `BP_Groups_Group::get()`. When searching for groups
by meta value, the found groups may now be ordered by the order in
which the found meta rows appear in the bp_groups_groupmeta table.
See <a href="http://buddypress.trac.wordpress.org/ticket/6014">#6014</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2017-04-20 00:19:36 UTC (rev 11532)
+++ trunk/src/bp-groups/bp-groups-functions.php 2017-04-20 00:56:53 UTC (rev 11533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -704,7 +704,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => false, // Active, newest, alphabetical, random, popular, most-forum-topics or most-forum-posts.
</span><span class="cx" style="display: block; padding: 0 10px"> 'order' => 'DESC', // 'ASC' or 'DESC'
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'orderby' => 'date_created', // date_created, last_activity, total_member_count, name, random.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'date_created', // date_created, last_activity, total_member_count, name, random, meta_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => false, // Pass a user_id to limit to only groups that this user is a member of.
</span><span class="cx" style="display: block; padding: 0 10px"> 'include' => false, // Only include these specific groups (group_ids).
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false, // Do not include these specific groups (group_ids).
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-04-20 00:19:36 UTC (rev 11532)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-04-20 00:56:53 UTC (rev 11533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -883,7 +883,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * When present, will override orderby and order params.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: null.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $orderby Optional. Property to sort by. 'date_created', 'last_activity',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'total_member_count', 'name', 'random'. Default: 'date_created'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'total_member_count', 'name', 'random', 'meta_id'.
+ * Default: 'date_created'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $order Optional. Sort order. 'ASC' or 'DESC'. Default: 'DESC'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $per_page Optional. Number of items to return per page of results.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: null (no limit).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -993,7 +994,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $r['status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r['status'] = preg_split( '/[\s,]+/', $r['status'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1140,6 +1140,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['last_activity'] = "gm_last_activity.meta_key = 'last_activity'";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If 'meta_id' is the requested order, and there's no meta query, fall back to the default.
+ if ( 'meta_id' === $orderby && empty( $meta_query_sql['join'] ) ) {
+ $orderby = 'date_created';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Sanitize 'order'.
</span><span class="cx" style="display: block; padding: 0 10px"> $order = bp_esc_sql_order( $order );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1442,6 +1447,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'random' :
</span><span class="cx" style="display: block; padding: 0 10px"> $order_by_term = 'rand()';
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ case 'meta_id' :
+ $order_by_term = buddypress()->groups->table_name_groupmeta . '.id';
+ break;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $order_by_term;
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-04-20 00:19:36 UTC (rev 11532)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-04-20 00:56:53 UTC (rev 11533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -956,6 +956,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( _BP_Groups_Group::_convert_orderby_to_order_by_term( 'date_created' ), _BP_Groups_Group::_convert_orderby_to_order_by_term( 'I am a bad boy' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @group groups_get_orderby_meta_id
+ */
+ public function test_get_orderby_meta_id() {
+ $g1 = $this->factory->group->create();
+ $g2 = $this->factory->group->create();
+ $g3 = $this->factory->group->create();
+
+ groups_update_groupmeta( $g2, 'orderup', 'sammy' );
+ groups_update_groupmeta( $g1, 'orderup', 'sammy' );
+
+ $args = array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'orderup',
+ 'value' => 'sammy'
+ ),
+ ),
+ 'orderby' => 'meta_id',
+ 'order' => 'ASC',
+ );
+ $groups = BP_Groups_Group::get( $args );
+
+ $found = wp_list_pluck( $groups['groups'], 'id' );
+ $this->assertEquals( array( $g2, $g1 ), $found );
+ }
+
+ /**
+ * @group groups_get_orderby_meta_id
+ */
+ public function test_get_orderby_meta_id_invalid_fallback_to_date_created() {
+ $time = time();
+ $g1 = $this->factory->group->create( array(
+ 'date_created' => gmdate( 'Y-m-d H:i:s', $time - 10000 ),
+ ) );
+ $g2 = $this->factory->group->create( array(
+ 'date_created' => gmdate( 'Y-m-d H:i:s', $time - 1000 ),
+ ) );
+ $g3 = $this->factory->group->create( array(
+ 'date_created' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ ) );
+
+ $args = array(
+ 'orderby' => 'meta_id',
+ );
+ $groups = BP_Groups_Group::get( $args );
+
+ // Orderby meta_id should be ignored if no meta query is present.
+ $found = wp_list_pluck( $groups['groups'], 'id' );
+ $this->assertEquals( array( $g3, $g2, $g1 ), $found );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_filter_user_groups_normal_search() {
</span><span class="cx" style="display: block; padding: 0 10px"> $g1 = $this->factory->group->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'Cool Group',
</span></span></pre>
</div>
</div>
</body>
</html>