<!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][8044] trunk: Introduce 'inviter_id' and 'invite_sent' params to BP_Group_Member_Query</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/8044">8044</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-05 14:37:27 +0000 (Wed, 05 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce 'inviter_id' and 'invite_sent' params to BP_Group_Member_Query
These additional parameters make it possible to use BP_Group_Member_Query for
unconfirmed group memberships, as in the case of invitations and requests. This
will allow it to be swapped for the internals of bp_group_has_members(). See
Props dcavins for an initial patch</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupsclassesphp">trunk/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunkteststestcasesgroupsclassbpgroupmemberqueryphp">trunk/tests/testcases/groups/class-bp-group-member-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-classes.php (8043 => 8044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2014-03-05 03:35:17 UTC (rev 8043)
+++ trunk/bp-groups/bp-groups-classes.php 2014-03-05 14:37:27 UTC (rev 8044)
</span><span class="lines">@@ -1447,6 +1447,14 @@
</span><span class="cx"> /**
</span><span class="cx"> * Query for the members of a group.
</span><span class="cx"> *
</span><ins>+ * Special notes about the group members data schema:
+ * - *Members* are entries with is_confirmed = 1
+ * - *Pending requests* are entries with is_confirmed = 0 and inviter_id = 0
+ * - *Pending and sent invitations* are entries with is_confirmed = 0 and
+ * inviter_id != 0 and invite_sent = 1
+ * - *Pending and unsent invitations* are entries with is_confirmed = 0 and
+ * inviter_id != 0 and invite_sent = 0
+ *
</ins><span class="cx"> * @since BuddyPress (1.8.0)
</span><span class="cx"> *
</span><span class="cx"> * @param array $args {
</span><span class="lines">@@ -1514,6 +1522,8 @@
</span><span class="cx"> 'group_id' => 0,
</span><span class="cx"> 'group_role' => array( 'member' ),
</span><span class="cx"> 'is_confirmed' => true,
</span><ins>+ 'invite_sent' => null,
+ 'inviter_id' => null,
</ins><span class="cx"> 'type' => 'last_joined',
</span><span class="cx"> ) );
</span><span class="cx">
</span><span class="lines">@@ -1563,6 +1573,35 @@
</span><span class="cx"> $is_confirmed = ! empty( $this->query_vars['is_confirmed'] ) ? 1 : 0;
</span><span class="cx"> $sql['where'][] = $wpdb->prepare( "is_confirmed = %d", $is_confirmed );
</span><span class="cx">
</span><ins>+ // invite_sent
+ if ( ! is_null( $this->query_vars['invite_sent'] ) ) {
+ $invite_sent = ! empty( $this->query_vars['invite_sent'] ) ? 1 : 0;
+ $sql['where'][] = $wpdb->prepare( "invite_sent = %d", $invite_sent );
+ }
+
+ // inviter_id
+ if ( ! is_null( $this->query_vars['inviter_id'] ) ) {
+ $inviter_id = $this->query_vars['inviter_id'];
+
+ // Empty: inviter_id = 0. (pass false, 0, or empty array)
+ if ( empty( $inviter_id ) ) {
+ $sql['where'][] = "inviter_id = 0";
+
+ // The string 'any' matches any non-zero value (inviter_id != 0)
+ } else if ( 'any' === $inviter_id ) {
+ $sql['where'][] = "inviter_id != 0";
+
+ // Assume that a list of inviter IDs has been passed
+ } else {
+ // Parse and sanitize
+ $inviter_ids = wp_parse_id_list( $inviter_id );
+ if ( ! empty( $inviter_ids ) ) {
+ $inviter_ids_sql = implode( ',', $inviter_ids );
+ $sql['where'][] = "inviter_id IN ({$inviter_ids_sql})";
+ }
+ }
+ }
+
</ins><span class="cx"> // Role information is stored as follows: admins have
</span><span class="cx"> // is_admin = 1, mods have is_mod = 1, banned have is_banned =
</span><span class="cx"> // 1, and members have all three set to 0.
</span></span></pre></div>
<a id="trunkteststestcasesgroupsclassbpgroupmemberqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/class-bp-group-member-query.php (8043 => 8044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/class-bp-group-member-query.php 2014-03-05 03:35:17 UTC (rev 8043)
+++ trunk/tests/testcases/groups/class-bp-group-member-query.php 2014-03-05 14:37:27 UTC (rev 8044)
</span><span class="lines">@@ -422,4 +422,174 @@
</span><span class="cx"> $ids = wp_parse_id_list( array_keys( $query_members->results ) );
</span><span class="cx"> $this->assertEquals( array( $u1, $u3, $u2 ), $ids );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group invite_sent
+ */
+ public function test_with_invite_sent_true() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $time = time();
+
+ $this->add_user_to_group( $u1, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'is_confirmed' => 0,
+ 'invite_sent' => 0,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'is_confirmed' => 0,
+ 'invite_sent' => 1,
+ ) );
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'is_confirmed' => false,
+ 'invite_sent' => true,
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u2 ), $ids );
+ }
+
+ /**
+ * @group invite_sent
+ */
+ public function test_with_invite_sent_false() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $time = time();
+
+ $this->add_user_to_group( $u1, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'is_confirmed' => 0,
+ 'invite_sent' => 0,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'is_confirmed' => 0,
+ 'invite_sent' => 1,
+ ) );
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'is_confirmed' => false,
+ 'invite_sent' => false,
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u1 ), $ids );
+ }
+
+ /**
+ * @group inviter_id
+ */
+ public function test_with_inviter_id_false() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $time = time();
+
+ $this->add_user_to_group( $u1, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'inviter_id' => 0,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'inviter_id' => 1,
+ ) );
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'inviter_id' => false,
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u1 ), $ids );
+ }
+
+ /**
+ * @group inviter_id
+ */
+ public function test_with_inviter_id_specific() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $u3 = $this->create_user();
+ $u4 = $this->create_user();
+ $time = time();
+
+ $this->add_user_to_group( $u1, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'inviter_id' => 0,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ),
+ 'inviter_id' => 1,
+ ) );
+
+ $this->add_user_to_group( $u3, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ),
+ 'inviter_id' => 6,
+ ) );
+
+ $this->add_user_to_group( $u4, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 400 ),
+ 'inviter_id' => 2,
+ ) );
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'inviter_id' => array( 2, 6 ),
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u3, $u4 ), $ids );
+ }
+
+ /**
+ * @group inviter_id
+ */
+ public function test_with_inviter_id_any() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $u3 = $this->create_user();
+ $u4 = $this->create_user();
+ $time = time();
+
+ $this->add_user_to_group( $u1, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+ 'inviter_id' => 0,
+ ) );
+
+ $this->add_user_to_group( $u2, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ),
+ 'inviter_id' => 1,
+ ) );
+
+ $this->add_user_to_group( $u3, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ),
+ 'inviter_id' => 6,
+ ) );
+
+ $this->add_user_to_group( $u4, $g, array(
+ 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 400 ),
+ 'inviter_id' => 2,
+ ) );
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'inviter_id' => 'any',
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u2, $u3, $u4 ), $ids );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>