<!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][7145] trunk: Deprecate exclude_banned arg of bp_group_has_members() in favor of 'banned' role</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/7145">7145</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-06-04 03:04:29 +0000 (Tue, 04 Jun 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Deprecate exclude_banned arg of bp_group_has_members() in favor of 'banned' role
This changeset introduces support for the 'banned' group_role filter in
BP_Group_Member_Query. This takes the place of the exclude_banned parameter.
Backward compatibility for exclude_banned is added in
groups_get_group_members().
See <a href="http://buddypress.trac.wordpress.org/ticket/4977">#4977</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="#trunkteststestcasesgroupsclassbpgroupmemberqueryphp">trunk/tests/testcases/groups/class-bp-group-member-query.php</a></li>
<li><a href="#trunkteststestcasesgroupstemplatephp">trunk/tests/testcases/groups/template.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 (7144 => 7145)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2013-06-04 03:04:23 UTC (rev 7144)
+++ trunk/bp-groups/bp-groups-classes.php 2013-06-04 03:04:29 UTC (rev 7145)
</span><span class="lines">@@ -987,9 +987,8 @@
</span><span class="cx"> // values passed to the constructor will, as usual, override
</span><span class="cx"> // these defaults).
</span><span class="cx"> $this->query_vars = wp_parse_args( $this->query_vars, array(
</span><del>- 'group_id' => 0,
- 'group_role' => array( 'member' ),
- 'exclude_banned' => true,
</del><ins>+ 'group_id' => 0,
+ 'group_role' => array( 'member' ),
</ins><span class="cx"> ) );
</span><span class="cx">
</span><span class="cx"> $group_member_ids = $this->get_group_member_ids();
</span><span class="lines">@@ -1050,13 +1049,17 @@
</span><span class="cx"> // When querying for a set of roles containing 'member' (for
</span><span class="cx"> // which there is no dedicated is_ column), figure out a list
</span><span class="cx"> // of columns *not* to match
</span><ins>+ $roles_sql = '';
</ins><span class="cx"> if ( in_array( 'member', $roles ) ) {
</span><span class="cx"> $role_columns = array();
</span><span class="cx"> foreach ( array_diff( $allowed_roles, $roles ) as $excluded_role ) {
</span><span class="cx"> $role_columns[] = 'is_' . $excluded_role . ' = 0';
</span><span class="cx"> }
</span><del>- $roles_sql = '(' . implode( ' AND ', $role_columns ) . ')';
</del><span class="cx">
</span><ins>+ if ( ! empty( $role_columns ) ) {
+ $roles_sql = '(' . implode( ' AND ', $role_columns ) . ')';
+ }
+
</ins><span class="cx"> // When querying for a set of roles *not* containing 'member',
</span><span class="cx"> // simply construct a list of is_* = 1 clauses
</span><span class="cx"> } else {
</span><span class="lines">@@ -1064,17 +1067,16 @@
</span><span class="cx"> foreach ( $roles as $role ) {
</span><span class="cx"> $role_columns[] = 'is_' . $role . ' = 1';
</span><span class="cx"> }
</span><del>- $roles_sql = '(' . implode( ' OR ', $role_columns ) . ')';
</del><ins>+
+ if ( ! empty( $role_columns ) ) {
+ $roles_sql = '(' . implode( ' OR ', $role_columns ) . ')';
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ( ! empty( $roles_sql ) ) {
</span><span class="cx"> $sql['where'][] = $roles_sql;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( ! empty( $this->query_vars['exclude_banned'] ) ) {
- $sql['where'][] = "is_banned = 0";
- }
-
</del><span class="cx"> $sql['where'] = ! empty( $sql['where'] ) ? 'WHERE ' . implode( ' AND ', $sql['where'] ) : '';
</span><span class="cx">
</span><span class="cx"> /** ORDER BY clause ***************************************************/
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (7144 => 7145)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2013-06-04 03:04:23 UTC (rev 7144)
+++ trunk/bp-groups/bp-groups-functions.php 2013-06-04 03:04:29 UTC (rev 7145)
</span><span class="lines">@@ -404,9 +404,19 @@
</span><span class="cx"> $retval = BP_Groups_Member::get_all_for_group( $group_id, $limit, $page, $exclude_admins_mods, $exclude_banned, $exclude );
</span><span class="cx"> } else {
</span><span class="cx">
</span><del>- // exclude_admins_mods is a legacy argument. Convert to group_role
</del><ins>+ // exclude_admins_mods and exclude_banned are legacy arguments.
+ // Convert to group_role
</ins><span class="cx"> if ( empty( $group_role ) ) {
</span><del>- $group_role = $exclude_admins_mods ? array( 'member' ) : array( 'member', 'mod', 'admin' );
</del><ins>+ $group_role = array( 'member' );
+
+ if ( ! $exclude_admins_mods ) {
+ $group_role[] = 'mod';
+ $group_role[] = 'admin';
+ }
+
+ if ( ! $exclude_banned ) {
+ $group_role[] = 'banned';
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Perform the group member query (extends BP_User_Query)
</span><span class="lines">@@ -415,7 +425,6 @@
</span><span class="cx"> 'per_page' => $limit,
</span><span class="cx"> 'page' => $page,
</span><span class="cx"> 'group_role' => $group_role,
</span><del>- 'exclude_banned' => $exclude_banned,
</del><span class="cx"> 'exclude' => $exclude,
</span><span class="cx"> 'type' => 'last_modified',
</span><span class="cx"> ) );
</span></span></pre></div>
<a id="trunkteststestcasesgroupsclassbpgroupmemberqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/class-bp-group-member-query.php (7144 => 7145)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/class-bp-group-member-query.php 2013-06-04 03:04:23 UTC (rev 7144)
+++ trunk/tests/testcases/groups/class-bp-group-member-query.php 2013-06-04 03:04:29 UTC (rev 7145)
</span><span class="lines">@@ -222,6 +222,54 @@
</span><span class="cx"> $this->assertEquals( array( $u1, $u2, $u3, ), $ids );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ public function test_with_group_role_member_mod_admin_banned() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $u3 = $this->create_user();
+ $u4 = $this->create_user();
+
+ $this->add_user_to_group( $u1, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ) ) );
+ $this->add_user_to_group( $u2, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ) ) );
+ $this->add_user_to_group( $u3, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ) ) );
+ $this->add_user_to_group( $u4, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ) ) );
+
+ $m1 = new BP_Groups_Member( $u1, $g );
+ $m1->promote( 'admin' );
+ $m2 = new BP_Groups_Member( $u2, $g );
+ $m2->promote( 'mod' );
+ $m3 = new BP_Groups_Member( $u3, $g );
+ $m3->ban();
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'group_role' => array( 'member', 'mod', 'admin', 'banned' ),
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u1, $u2, $u3, $u4, ), $ids );
+ }
+
+ public function test_with_group_role_banned() {
+ $g = $this->factory->group->create();
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+
+ $this->add_user_to_group( $u1, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ) ) );
+ $this->add_user_to_group( $u2, $g, array( 'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ) ) );
+
+ $m1 = new BP_Groups_Member( $u1, $g );
+ $m1->ban();
+
+ $query_members = new BP_Group_Member_Query( array(
+ 'group_id' => $g,
+ 'group_role' => array( 'banned' ),
+ ) );
+
+ $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+ $this->assertEquals( array( $u1, ), $ids );
+ }
+
</ins><span class="cx"> public function test_group_has_no_members() {
</span><span class="cx"> $g = $this->factory->group->create();
</span><span class="cx"> $u1 = $this->create_user();
</span></span></pre></div>
<a id="trunkteststestcasesgroupstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/template.php (7144 => 7145)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/template.php 2013-06-04 03:04:23 UTC (rev 7144)
+++ trunk/tests/testcases/groups/template.php 2013-06-04 03:04:29 UTC (rev 7145)
</span><span class="lines">@@ -1,6 +1,7 @@
</span><span class="cx"> <?php
</span><span class="cx"> /**
</span><span class="cx"> * @group groups
</span><ins>+ * @group template
</ins><span class="cx"> */
</span><span class="cx"> class BP_Tests_Groups_Template extends BP_UnitTestCase {
</span><span class="cx"> public function setUp() {
</span></span></pre>
</div>
</div>
</body>
</html>