<!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][8200] trunk: Cache the group invite count for a user.</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/8200">8200</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-03-29 00:35:30 +0000 (Sat, 29 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Cache the group invite count for a user.
This commit:
- Caches calls to BP_Groups_Member::get_invite_count_for_user()
- Invalidates the group invite count cache on various actions
- Adds a unit test
See <a href="http://buddypress.trac.wordpress.org/ticket/5414">#5414</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupscachephp">trunk/bp-groups/bp-groups-cache.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsclassesphp">trunk/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunkteststestcasesgroupsfunctionsphp">trunk/tests/testcases/groups/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpgroupsbpgroupscachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-cache.php (8199 => 8200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-cache.php 2014-03-29 00:24:56 UTC (rev 8199)
+++ trunk/bp-groups/bp-groups-cache.php 2014-03-29 00:35:30 UTC (rev 8200)
</span><span class="lines">@@ -112,10 +112,56 @@
</span><span class="cx"> add_action( 'bp_groups_delete_group', 'bp_groups_clear_group_members_caches', 10, 2 );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Clear a user's cached total group invite count.
+ *
+ * Count is cleared when an invite is accepted, rejected or deleted.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $user_id The user ID.
+ */
+function bp_groups_clear_invite_count_for_user( $user_id ) {
+ wp_cache_delete( $user_id, 'bp_group_invite_count' );
+}
+add_action( 'groups_accept_invite', 'bp_groups_clear_invite_count_for_user' );
+add_action( 'groups_reject_invite', 'bp_groups_clear_invite_count_for_user' );
+add_action( 'groups_delete_invite', 'bp_groups_clear_invite_count_for_user' );
+
+/**
+ * Clear a user's cached total group invite count when a user is uninvited.
+ *
+ * Groan. Our API functions are not consistent.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $group_id The group ID. Not used in this function.
+ * @param int $user_id The user ID.
+ */
+function bp_groups_clear_invite_count_on_uninvite( $group_id, $user_id ) {
+ bp_groups_clear_invite_count_for_user( $user_id );
+}
+add_action( 'groups_uninvite_user', 'bp_groups_clear_invite_count_on_uninvite', 10, 2 );
+
+/**
+ * Clear a user's cached total group invite count when a new invite is sent.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $group_id The group ID. Not used in this function.
+ * @param array $invited_users Array of invited user IDs.
+ */
+function bp_groups_clear_invite_count_on_send( $group_id, $invited_users ) {
+ foreach ( $invited_users as $user_id ) {
+ bp_groups_clear_invite_count_for_user( $user_id );
+ }
+}
+add_action( 'groups_send_invites', 'bp_groups_clear_invite_count_on_send', 10, 2 );
+
+/**
</ins><span class="cx"> * Clear a user's cached group count.
</span><span class="cx"> *
</span><del>- * @param int $group_id ID of the group. Not used in this function.
- * @param int $user_id ID of the user whose group count is being changed.
</del><ins>+ * @param int $group_id The group ID. Not used in this function.
+ * @param int $user_id The user ID.
</ins><span class="cx"> */
</span><span class="cx"> function groups_clear_group_user_object_cache( $group_id, $user_id ) {
</span><span class="cx"> wp_cache_delete( 'bp_total_groups_for_user_' . $user_id, 'bp' );
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-classes.php (8199 => 8200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2014-03-29 00:24:56 UTC (rev 8199)
+++ trunk/bp-groups/bp-groups-classes.php 2014-03-29 00:35:30 UTC (rev 8200)
</span><span class="lines">@@ -2362,7 +2362,14 @@
</span><span class="cx">
</span><span class="cx"> $bp = buddypress();
</span><span class="cx">
</span><del>- return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(DISTINCT m.group_id) FROM {$bp->groups->table_name_members} m, {$bp->groups->table_name} g WHERE m.group_id = g.id AND m.is_confirmed = 0 AND m.inviter_id != 0 AND m.invite_sent = 1 AND m.user_id = %d ORDER BY date_modified ASC", $user_id ) );
</del><ins>+ $count = wp_cache_get( $user_id, 'bp_group_invite_count' );
+
+ if ( false === $count ) {
+ $count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(DISTINCT m.group_id) FROM {$bp->groups->table_name_members} m, {$bp->groups->table_name} g WHERE m.group_id = g.id AND m.is_confirmed = 0 AND m.inviter_id != 0 AND m.invite_sent = 1 AND m.user_id = %d", $user_id ) );
+ wp_cache_set( $user_id, $count, 'bp_group_invite_count' );
+ }
+
+ return $count;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkteststestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/functions.php (8199 => 8200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php 2014-03-29 00:24:56 UTC (rev 8199)
+++ trunk/tests/testcases/groups/functions.php 2014-03-29 00:35:30 UTC (rev 8200)
</span><span class="lines">@@ -577,4 +577,33 @@
</span><span class="cx">
</span><span class="cx"> $this->set_current_user( $old_user );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group counts
+ */
+ public function test_get_invite_count_for_user() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+ // create invitation
+ groups_invite_user( array(
+ 'user_id' => $u2,
+ 'group_id' => $g,
+ 'inviter_id' => $u1,
+ ) );
+
+ // send the invite
+ // this function is imperative to set the 'invite_sent' flag in the DB
+ // why is this separated from groups_invite_user()?
+ // @see groups_screen_group_invite()
+ groups_send_invites( $u1, $g );
+
+ // assert invite count
+ $this->assertEquals( 1, groups_get_invite_count_for_user( $u2 ) );
+
+ // accept the invite and reassert
+ groups_accept_invite( $u2, $g );
+ $this->assertEquals( 0, groups_get_invite_count_for_user( $u2 ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>