<!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][12162] trunk: Introduce `BP_Groups_Member::get_user_memberships()`.</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 { white-space: pre-line; 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/12162">12162</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/12162","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-06-04 20:43:08 +0000 (Mon, 04 Jun 2018)</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'>Introduce `BP_Groups_Member::get_user_memberships()`.
This is a new low-level query method that allows a single syntax for fetching
a paginated set of results from the membership table, for different
values of `is_pending`, etc. Primarily for use in data exporters; see <a href="http://buddypress.trac.wordpress.org/ticket/7820">#7820</a>.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7859">#7859</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsmemberphp">trunk/src/bp-groups/classes/class-bp-groups-member.php</a></li>
<li><a href="#trunktestsphpunitincludestestcasephp">trunk/tests/phpunit/includes/testcase.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsmemberphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsclassesclassbpgroupsmemberphp"></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-member.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-member.php 2018-06-04 20:08:29 UTC (rev 12161)
+++ trunk/src/bp-groups/classes/class-bp-groups-member.php 2018-06-04 20:43:08 UTC (rev 12162)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -826,6 +826,81 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets memberships of a user for purposes of a personal data export.
+ *
+ * @since 4.0.0
+ *
+ * @param int $user_id ID of the user.
+ * @param array $args {
+ * Array of optional arguments.
+ * @type int $page Page of memberships being requested. Default 1.
+ * @type int $per_page Memberships to return per page. Default 20.
+ * @type string $type Membership type being requested. Accepts 'membership',
+ * 'pending_request', 'pending_received_invitation',
+ * 'pending_sent_invitation'. Default 'membership'.
+ * }
+ *
+ * @return array
+ */
+ public static function get_user_memberships( $user_id, $args = array() ) {
+ global $wpdb;
+
+ $bp = buddypress();
+
+ $r = array_merge( array(
+ 'page' => 1,
+ 'per_page' => 20,
+ 'type' => 'membership',
+ ), $args );
+
+ $sql = array(
+ 'select' => 'SELECT *',
+ 'from' => "FROM {$bp->groups->table_name_members}",
+ 'where' => '',
+ 'limits' => '',
+ );
+
+ switch ( $r['type'] ) {
+ case 'pending_request' :
+ $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 0 AND inviter_id = 0", $user_id );
+ break;
+
+ case 'pending_received_invitation' :
+ $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 0 AND inviter_id != 0", $user_id );
+ break;
+
+ case 'pending_sent_invitation' :
+ $sql['where'] = $wpdb->prepare( "inviter_id = %d AND is_confirmed = 0", $user_id );
+ break;
+
+ case 'membership' :
+ default :
+ $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 1", $user_id );
+ break;
+ }
+
+ if ( $r['page'] && $r['per_page'] ) {
+ $sql['limits'] = $wpdb->prepare( "LIMIT %d, %d", ( $r['page'] - 1 ) * $r['per_page'], $r['per_page'] );
+ }
+
+ $memberships = $wpdb->get_results( "{$sql['select']} {$sql['from']} WHERE {$sql['where']} {$sql['limits']}" );
+
+ foreach ( $memberships as &$membership ) {
+ $membership->id = (int) $membership->id;
+ $membership->group_id = (int) $membership->group_id;
+ $membership->user_id = (int) $membership->user_id;
+ $membership->inviter_id = (int) $membership->inviter_id;
+ $membership->is_admin = (int) $membership->is_admin;
+ $membership->is_mod = (int) $membership->is_mod;
+ $membership->is_banned = (int) $membership->is_banned;
+ $membership->is_confirmed = (int) $membership->is_confirmed;
+ $membership->invite_sent = (int) $membership->invite_sent;
+ }
+
+ return $memberships;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Check whether a user has an outstanding invitation to a given group.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.6.0
</span></span></pre></div>
<a id="trunktestsphpunitincludestestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase.php 2018-06-04 20:08:29 UTC (rev 12161)
+++ trunk/tests/phpunit/includes/testcase.php 2018-06-04 20:43:08 UTC (rev 12162)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -120,6 +120,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_activity_remove_all_user_data( $user_id );
</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">+ bp_core_remove_data( $user_id );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $deleted;
</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="trunktestsphpunittestcasesgroupsclassbpgroupsmemberphp"></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-member.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-member.php 2018-06-04 20:08:29 UTC (rev 12161)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php 2018-06-04 20:43:08 UTC (rev 12162)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,6 +4,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group BP_Groups_Member
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_Tests_BP_Groups_Member_TestCases extends BP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ static public $user_ids;
+ static public $group_ids;
+
+ public static function wpSetUpBeforeClass( $factory ) {
+ global $wpdb, $bp;
+ self::$user_ids = $factory->user->create_many( 4 );
+ self::$group_ids = $factory->group->create_many( 3, array(
+ 'creator_id' => self::$user_ids[3],
+ ) );
+ }
+
+ public static function wpTearDownAfterClass() {
+ array_map( array( __CLASS__, 'delete_user' ), self::$user_ids );
+ array_map( 'groups_delete_group', self::$group_ids );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function invite_user_to_group( $user_id, $group_id, $inviter_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $invite = new BP_Groups_Member;
</span><span class="cx" style="display: block; padding: 0 10px"> $invite->group_id = $group_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1371,4 +1387,71 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( is_array( $admins ) && empty( $admins ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket BP7859
+ */
+ public function test_get_user_memberships_type_membership() {
+ groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+
+ $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+ 'type' => 'membership',
+ ) );
+
+ $this->assertCount( 1, $memberships );
+ $this->assertSame( self::$group_ids[0], $memberships[0]->group_id );
+ }
+
+ /**
+ * @ticket BP7859
+ */
+ public function test_get_user_memberships_type_pending_request() {
+ groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+ groups_send_membership_request( self::$user_ids[0], self::$group_ids[1] );
+
+ $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+ 'type' => 'pending_request',
+ ) );
+
+ $this->assertCount( 1, $memberships );
+ $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+ }
+
+ /**
+ * @ticket BP7859
+ */
+ public function test_get_user_memberships_type_pending_received_invitation() {
+ groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+ groups_invite_user( array(
+ 'user_id' => self::$user_ids[0],
+ 'group_id' => self::$group_ids[1],
+ 'inviter_id' => self::$user_ids[1],
+ ) );
+
+ $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+ 'type' => 'pending_received_invitation',
+ ) );
+
+ $this->assertCount( 1, $memberships );
+ $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+ }
+
+ /**
+ * @ticket BP7859
+ */
+ public function test_get_user_memberships_type_pending_sent_invitation() {
+ groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+ groups_invite_user( array(
+ 'user_id' => self::$user_ids[1],
+ 'group_id' => self::$group_ids[1],
+ 'inviter_id' => self::$user_ids[0],
+ ) );
+
+ $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+ 'type' => 'pending_sent_invitation',
+ ) );
+
+ $this->assertCount( 1, $memberships );
+ $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>