Changeset 7145

Timestamp:

06/04/2013 03:04:29 AM (12 years ago)

Author:

boonebgorges

Message:

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 #4977

Location:

trunk

Files:

• bp-groups/bp-groups-classes.php (modified) (4 diffs)
• bp-groups/bp-groups-functions.php (modified) (2 diffs)
• tests/testcases/groups/class-bp-group-member-query.php (modified) (1 diff)
• tests/testcases/groups/template.php (modified) (1 diff)

trunk/bp-groups/bp-groups-classes.php

@@ -988 +988 @@
         // these defaults).
         $this->query_vars = wp_parse_args( $this->query_vars, array(
-            'group_id'       => 0,
-            'group_role'     => array( 'member' ),
-            'exclude_banned' => true,
+            'group_id'   => 0,
+            'group_role' => array( 'member' ),
         ) );
 
@@ -1051 +1050 @@
         // which there is no dedicated is_ column), figure out a list
         // of columns *not* to match
+        $roles_sql = '';
         if ( in_array( 'member', $roles ) ) {
             $role_columns = array();
@@ -1056 +1056 @@
                 $role_columns[] = 'is_' . $excluded_role . ' = 0';
             }
-            $roles_sql = '(' . implode( ' AND ', $role_columns ) . ')';
+
+            if ( ! empty( $role_columns ) ) {
+                $roles_sql = '(' . implode( ' AND ', $role_columns ) . ')';
+            }
 
         // When querying for a set of roles *not* containing 'member',
@@ -1065 +1068 @@
                 $role_columns[] = 'is_' . $role . ' = 1';
             }
-            $roles_sql = '(' . implode( ' OR ', $role_columns ) . ')';
+
+            if ( ! empty( $role_columns ) ) {
+                $roles_sql = '(' . implode( ' OR ', $role_columns ) . ')';
+            }
         }
 
         if ( ! empty( $roles_sql ) ) {
             $sql['where'][] = $roles_sql;
-        }
-
-        if ( ! empty( $this->query_vars['exclude_banned'] ) ) {
-            $sql['where'][] = "is_banned = 0";
         }
 

trunk/bp-groups/bp-groups-functions.php

@@ -405 +405 @@
     } else {
 
-        // exclude_admins_mods is a legacy argument. Convert to group_role
+        // exclude_admins_mods and exclude_banned are legacy arguments.
+        // Convert to group_role
         if ( empty( $group_role ) ) {
-            $group_role = $exclude_admins_mods ? array( 'member' ) : array( 'member', 'mod', 'admin' );
+            $group_role = array( 'member' );
+
+            if ( ! $exclude_admins_mods ) {
+                $group_role[] = 'mod';
+                $group_role[] = 'admin';
+            }
+
+            if ( ! $exclude_banned ) {
+                $group_role[] = 'banned';
+            }
         }
 
@@ -416 +426 @@
             'page'           => $page,
             'group_role'     => $group_role,
-            'exclude_banned' => $exclude_banned,
             'exclude'        => $exclude,
             'type'           => 'last_modified',

trunk/tests/testcases/groups/class-bp-group-member-query.php

@@ -223 +223 @@
     }
 
+    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 );
+    }
+
     public function test_group_has_no_members() {
         $g = $this->factory->group->create();

trunk/tests/testcases/groups/template.php

@@ -2 +2 @@
 /**
  * @group groups
+ * @group template
  */
 class BP_Tests_Groups_Template extends BP_UnitTestCase {