<!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][7182] trunk: Improvements to how group total_member_count is refreshed on membership events</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/7182">7182</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-06-07 02:06:51 +0000 (Fri, 07 Jun 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improvements to how group total_member_count is refreshed on membership events
- Use an actual member count when refreshing, rather than incrementing
- Centralize all of the updating in the database methods, rather than having
the updates spread throughout the groups component
Also adds integration tests for total_member_count as relates to the groups_*
functions.
See <a href="http://buddypress.trac.wordpress.org/ticket/5018">#5018</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupsclassesphp">trunk/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsfunctionsphp">trunk/bp-groups/bp-groups-functions.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="trunkbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-classes.php (7181 => 7182)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2013-06-07 01:35:15 UTC (rev 7181)
+++ trunk/bp-groups/bp-groups-classes.php 2013-06-07 02:06:51 UTC (rev 7182)
</span><span class="lines">@@ -1225,6 +1225,9 @@
</span><span class="cx"> // Update the user's group count
</span><span class="cx"> self::refresh_total_group_count_for_user( $this->user_id );
</span><span class="cx">
</span><ins>+ // Update the group's member count
+ self::refresh_total_member_count_for_group( $this->group_id );
+
</ins><span class="cx"> do_action_ref_array( 'groups_member_after_save', array( &$this ) );
</span><span class="cx">
</span><span class="cx"> return true;
</span><span class="lines">@@ -1255,27 +1258,21 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function ban() {
</span><del>-
</del><span class="cx"> if ( !empty( $this->is_admin ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> $this->is_mod = 0;
</span><span class="cx"> $this->is_banned = 1;
</span><span class="cx">
</span><del>- groups_update_groupmeta( $this->group_id, 'total_member_count', ( (int) groups_get_groupmeta( $this->group_id, 'total_member_count' ) - 1 ) );
-
</del><span class="cx"> return $this->save();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function unban() {
</span><del>-
</del><span class="cx"> if ( !empty( $this->is_admin ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> $this->is_banned = 0;
</span><span class="cx">
</span><del>- groups_update_groupmeta( $this->group_id, 'total_member_count', ( (int) groups_get_groupmeta( $this->group_id, 'total_member_count' ) + 1 ) );
-
</del><span class="cx"> return $this->save();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1298,20 +1295,39 @@
</span><span class="cx"> if ( !$result = $wpdb->query( $sql ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- groups_update_groupmeta( $this->group_id, 'total_member_count', ( (int) groups_get_groupmeta( $this->group_id, 'total_member_count' ) - 1 ) );
-
</del><span class="cx"> // Update the user's group count
</span><span class="cx"> self::refresh_total_group_count_for_user( $this->user_id );
</span><span class="cx">
</span><ins>+ // Update the group's member count
+ self::refresh_total_member_count_for_group( $this->group_id );
+
</ins><span class="cx"> return $result;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** Static Methods ********************************************************/
</span><span class="cx">
</span><ins>+ /**
+ * Refresh the total_group_count for a user
+ *
+ * @since BuddyPress (1.8)
+ * @param int $user_id
+ * @return bool True on success
+ */
</ins><span class="cx"> public static function refresh_total_group_count_for_user( $user_id ) {
</span><del>- bp_update_user_meta( $user_id, 'total_group_count', (int) self::total_group_count( $user_id ) );
</del><ins>+ return bp_update_user_meta( $user_id, 'total_group_count', (int) self::total_group_count( $user_id ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Refresh the total_member_count for a group
+ *
+ * @since BuddyPress (1.8)
+ * @param int $group_id
+ * @return bool True on success
+ */
+ public static function refresh_total_member_count_for_group( $group_id ) {
+ return groups_update_groupmeta( $group_id, 'total_member_count', (int) BP_Groups_Group::get_total_member_count( $group_id ) );
+ }
+
</ins><span class="cx"> function delete( $user_id, $group_id ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><span class="lines">@@ -1320,6 +1336,9 @@
</span><span class="cx"> // Update the user's group count
</span><span class="cx"> self::refresh_total_group_count_for_user( $user_id );
</span><span class="cx">
</span><ins>+ // Update the group's member count
+ self::refresh_total_member_count_for_group( $group_id );
+
</ins><span class="cx"> return $remove;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (7181 => 7182)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2013-06-07 01:35:15 UTC (rev 7181)
+++ trunk/bp-groups/bp-groups-functions.php 2013-06-07 02:06:51 UTC (rev 7182)
</span><span class="lines">@@ -123,7 +123,6 @@
</span><span class="cx"> $member->date_modified = bp_core_current_time();
</span><span class="cx"> $member->save();
</span><span class="cx">
</span><del>- groups_update_groupmeta( $group->id, 'total_member_count', 1 );
</del><span class="cx"> groups_update_groupmeta( $group->id, 'last_activity', bp_core_current_time() );
</span><span class="cx">
</span><span class="cx"> do_action( 'groups_create_group', $group->id, $member, $group );
</span><span class="lines">@@ -299,9 +298,6 @@
</span><span class="cx"> if ( !groups_uninvite_user( $user_id, $group_id ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- // Modify group member count
- groups_update_groupmeta( $group_id, 'total_member_count', (int) groups_get_groupmeta( $group_id, 'total_member_count') - 1 );
-
</del><span class="cx"> /**
</span><span class="cx"> * If the user joined this group less than five minutes ago, remove the
</span><span class="cx"> * joined_group activity so users cannot flood the activity stream by
</span><span class="lines">@@ -361,7 +357,6 @@
</span><span class="cx"> ) );
</span><span class="cx">
</span><span class="cx"> // Modify group meta
</span><del>- groups_update_groupmeta( $group_id, 'total_member_count', (int) groups_get_groupmeta( $group_id, 'total_member_count') + 1 );
</del><span class="cx"> groups_update_groupmeta( $group_id, 'last_activity', bp_core_current_time() );
</span><span class="cx">
</span><span class="cx"> do_action( 'groups_join_group', $group_id, $user_id );
</span><span class="lines">@@ -721,7 +716,6 @@
</span><span class="cx"> $member->delete_request( $user_id, $group_id );
</span><span class="cx">
</span><span class="cx"> // Modify group meta
</span><del>- groups_update_groupmeta( $group_id, 'total_member_count', (int) groups_get_groupmeta( $group_id, 'total_member_count') + 1 );
</del><span class="cx"> groups_update_groupmeta( $group_id, 'last_activity', bp_core_current_time() );
</span><span class="cx">
</span><span class="cx"> bp_core_delete_notifications_by_item_id( $user_id, $group_id, $bp->groups->id, 'group_invite' );
</span><span class="lines">@@ -919,9 +913,6 @@
</span><span class="cx"> if ( groups_check_user_has_invite( $membership->user_id, $membership->group_id ) )
</span><span class="cx"> groups_delete_invite( $membership->user_id, $membership->group_id );
</span><span class="cx">
</span><del>- // Modify group member count
- groups_update_groupmeta( $membership->group_id, 'total_member_count', (int) groups_get_groupmeta( $membership->group_id, 'total_member_count') + 1 );
-
</del><span class="cx"> // Record this in activity streams
</span><span class="cx"> $group = groups_get_group( array( 'group_id' => $membership->group_id ) );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkteststestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/functions.php (7181 => 7182)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php 2013-06-07 01:35:15 UTC (rev 7181)
+++ trunk/tests/testcases/groups/functions.php 2013-06-07 02:06:51 UTC (rev 7182)
</span><span class="lines">@@ -57,10 +57,9 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * @group total_group_count
</span><del>- * @group BP_Groups_Member
- * @group unban
</del><ins>+ * @group groups_unban_member
</ins><span class="cx"> */
</span><del>- public function test_total_group_count_BP_Groups_Member_unban() {
</del><ins>+ public function test_total_group_count_groups_unban_member() {
</ins><span class="cx"> $u1 = $this->create_user();
</span><span class="cx"> $u2 = $this->create_user();
</span><span class="cx"> $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
</span><span class="lines">@@ -112,6 +111,10 @@
</span><span class="cx"> $this->assertEquals( 1, bp_get_user_meta( $u, 'total_group_count', true ) );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @group total_group_count
+ * @group groups_remove_member
+ */
</ins><span class="cx"> public function test_total_group_count_groups_remove_member() {
</span><span class="cx"> $u1 = $this->create_user();
</span><span class="cx"> $u2 = $this->create_user();
</span><span class="lines">@@ -128,4 +131,142 @@
</span><span class="cx">
</span><span class="cx"> $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group total_member_count
+ * @group groups_join_group
+ */
+ public function test_total_member_count_groups_join_group() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+ groups_join_group( $g, $u2 );
+ $this->assertEquals( 2, groups_get_groupmeta( $g, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_leave_group
+ */
+ public function test_total_member_count_groups_leave_group() {
+ $u1 = $this->create_user();
+ $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+
+ groups_leave_group( $g1, $u2 );
+ $this->assertEquals( 1, groups_get_groupmeta( $g1, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_ban_member
+ */
+ public function test_total_member_count_groups_ban_member() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_ban_member( $u2, $g1 );
+
+ $this->assertEquals( 1, groups_get_groupmeta( $g1, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_unban_member
+ */
+ public function test_total_member_count_groups_unban_member() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_ban_member( $u2, $g1 );
+
+ groups_unban_member( $u2, $g1 );
+
+ $this->assertEquals( 2, groups_get_groupmeta( $g1, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_accept_invite
+ */
+ public function test_total_member_count_groups_accept_invite() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_invite_user( array(
+ 'user_id' => $u1,
+ 'group_id' => $g,
+ 'inviter_id' => $u2,
+ ) );
+
+ groups_accept_invite( $u2, $g );
+
+ $this->assertEquals( 2, groups_get_groupmeta( $g, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_accept_membership_request
+ */
+ public function test_total_member_count_groups_accept_membership_request() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_send_membership_request( $u2, $g );
+
+ groups_accept_membership_request( 0, $u2, $g );
+
+ $this->assertEquals( 2, groups_get_groupmeta( $g, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_remove_member
+ */
+ public function test_total_member_count_groups_remove_member() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_remove_member( $u2, $g1 );
+
+ $this->assertEquals( 1, groups_get_groupmeta( $g1, 'total_member_count' ) );
+ }
+
+ /**
+ * @group total_member_count
+ * @group groups_create_group
+ */
+ public function test_total_member_count_groups_create_group() {
+ $u1 = $this->create_user();
+ $g = groups_create_group( array(
+ 'creator_id' => $u1,
+ 'name' => 'Boone Is Handsome',
+ 'description' => 'Yes',
+ 'slug' => 'boone-is-handsome',
+ 'status' => 'public',
+ 'enable_forum' => 0,
+ 'date_created' => bp_core_current_time(),
+ ) );
+
+ $this->assertEquals( 1, groups_get_groupmeta( $g, 'total_member_count' ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>