<!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][11762] trunk: Groups: add 'fields' parameter 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/11762">11762</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/11762","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>djpaul</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-12-06 16:18:11 +0000 (Wed, 06 Dec 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'>Groups: add 'fields' parameter to `BP_Groups_Group::get()`.
Allows return of only group IDs instead of entire objects when `fields=ids` is set, similiar to the `fields` parameter in `WP_Query`.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7609">#7609</a>
Props dcavins</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-12-06 15:46:07 UTC (rev 11761)
+++ trunk/src/bp-groups/bp-groups-functions.php 2017-12-06 16:18:11 UTC (rev 11762)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -796,6 +796,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => 1, // The page to return if limiting per page.
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true, // Pre-fetch groupmeta for queried groups.
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_admin_cache' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields' => 'all', // Return BP_Groups_Group objects or a list of ids.
</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"> $r = bp_parse_args( $args, $defaults, 'groups_get_groups' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -821,6 +822,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_admin_cache' => $r['update_admin_cache'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'order' => $r['order'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'orderby' => $r['orderby'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields' => $r['fields'],
</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"> /**
</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-12-06 15:46:07 UTC (rev 11761)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-12-06 16:18:11 UTC (rev 11762)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1025,10 +1025,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $status Optional. Array or comma-separated list of group statuses to limit
</span><span class="cx" style="display: block; padding: 0 10px"> * results to. If specified, $show_hidden is ignored.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: empty array.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $fields Which fields to return. Specify 'ids' to fetch a list of IDs.
+ * Default: 'all' (return BP_Groups_Group objects).
+ * If set, meta and admin caches will not be prefetched.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $groups Array of group objects returned by the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * paginated query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * paginated query. (IDs only if `fields` is set to `ids`.)
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type int $total Total count of all groups matching non-
</span><span class="cx" style="display: block; padding: 0 10px"> * paginated query params.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1075,7 +1078,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_admin_cache' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'status' => array()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'status' => array(),
+ 'fields' => 'all',
</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"> $r = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1299,20 +1303,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_group_ids = $cached;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
- if ( $uncached_group_ids ) {
- $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
- $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
- foreach ( $group_data_objects as $group_data_object ) {
- wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'ids' === $r['fields'] ) {
+ // We only want the IDs.
+ $paged_groups = array_map( 'intval', $paged_group_ids );
+ } else {
+ $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
+ if ( $uncached_group_ids ) {
+ $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
+ $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
+ foreach ( $group_data_objects as $group_data_object ) {
+ wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+ }
</ins><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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $paged_groups = array();
- foreach ( $paged_group_ids as $paged_group_id ) {
- $paged_groups[] = new BP_Groups_Group( $paged_group_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $paged_groups = array();
+ foreach ( $paged_group_ids as $paged_group_id ) {
+ $paged_groups[] = new BP_Groups_Group( $paged_group_id );
+ }
+
+ $group_ids = array();
+ foreach ( (array) $paged_groups as $group ) {
+ $group_ids[] = $group->id;
+ }
+
+ // Grab all groupmeta.
+ if ( ! empty( $r['update_meta_cache'] ) ) {
+ bp_groups_update_meta_cache( $group_ids );
+ }
+
+ // Prefetch all administrator IDs, if requested.
+ if ( $r['update_admin_cache'] ) {
+ BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
+ }
+
+ // Set up integer properties needing casting.
+ $int_props = array(
+ 'id', 'creator_id', 'enable_forum'
+ );
+
+ // Integer casting.
+ foreach ( $paged_groups as $key => $g ) {
+ foreach ( $int_props as $int_prop ) {
+ $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
+ }
+ }
+
</ins><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">+ // Find the total number of groups in the results set.
</ins><span class="cx" style="display: block; padding: 0 10px"> $total_groups_sql = "SELECT COUNT(DISTINCT g.id) FROM {$sql['from']} $where";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1334,35 +1372,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $total_groups = (int) $cached;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $group_ids = array();
- foreach ( (array) $paged_groups as $group ) {
- $group_ids[] = $group->id;
- }
-
- // Grab all groupmeta.
- if ( ! empty( $r['update_meta_cache'] ) ) {
- bp_groups_update_meta_cache( $group_ids );
- }
-
- // Prefetch all administrator IDs, if requested.
- if ( $r['update_admin_cache'] ) {
- BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
- }
-
- // Set up integer properties needing casting.
- $int_props = array(
- 'id', 'creator_id', 'enable_forum'
- );
-
- // Integer casting.
- foreach ( $paged_groups as $key => $g ) {
- foreach ( $int_props as $int_prop ) {
- $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
- }
- }
-
- unset( $sql, $total_sql );
-
</del><span class="cx" style="display: block; padding: 0 10px"> return array( 'groups' => $paged_groups, 'total' => $total_groups );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</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-12-06 15:46:07 UTC (rev 11761)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-12-06 16:18:11 UTC (rev 11762)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2234,6 +2234,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( $g1, $g3 ), $found );
</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 get_ids_only
+ */
+ public function test_get_return_ids_only() {
+ $now = time();
+ $g1 = $this->factory->group->create( array(
+ 'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60 ),
+ ) );
+ $g2 = $this->factory->group->create( array(
+ 'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*2 ),
+ ) );
+ $g3 = $this->factory->group->create( array(
+ 'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*3 ),
+ ) );
+
+ $groups = BP_Groups_Group::get( array(
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertSame( array( $g1, $g2, $g3 ), $groups['groups'] );
+ }
+
</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"> /**
</span></span></pre>
</div>
</div>
</body>
</html>