Changeset 7141 for trunk/tests/testcases/groups/template.php

Timestamp:

06/03/2013 05:12:54 PM (10 years ago)

Author:

boonebgorges

Message:

Introduces BP_Group_Member_Query and refactors bp_group_has_members() to use it

BP_Group_Member_Query extends BP_User_Query, which has a number of notable
benefits:

• Group member queries no longer JOIN against global user tables
• Less code duplication, since general logic like 'exclude' is handled by BP_User_Query
• Future access to the additional parameters of BP_User_Query, such as 'type'

Using the new BP_Group_Member_Query, this changeset also changes the way that
group member queries filter by group roles (member, mod, admin). The new
group_role parameter in the bp_group_has_members() stack accepts an array of
group roles. The legacy argument 'exclude_admins_mods' is still accepted, and
translates to 'group_role' => array( 'member' ) when true. These group_role
enhancements will allow for future enhancements in the Groups Admin section of
the Dashboard, and other places where it might be useful to query for the
members of a group matching a specific role. See #4977.

Fixes #4482

Props trishasalas for early patches and feedback. Props johnjamesjacoby for
review.

File:

• trunk/tests/testcases/groups/template.php (modified) (1 diff)

trunk/tests/testcases/groups/template.php

@@ -119 +119 @@
 
     /**
+     * Switching from BP_Groups_Member to BP_Group_Member_Query meant a
+     * change in the format of the values returned from the query. For
+     * backward compatibility, we translate some of the return values
+     * of BP_Group_Member_Query to the older format. This test makes sure
+     * that the translation happens properly.
+     *
+     * @group bp_group_has_members
+     */
+    public function test_bp_group_has_members_backpat_retval_format() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+
+        $date_modified = gmdate( 'Y-m-d H:i:s', time() - 100 );
+
+        $new_member                = new BP_Groups_Member;
+        $new_member->group_id      = $g;
+        $new_member->user_id       = $u1;
+        $new_member->inviter_id    = $u2;
+        $new_member->is_admin      = 0;
+        $new_member->user_title    = '';
+        $new_member->date_modified = $date_modified;
+        $new_member->is_confirmed  = 1;
+        $new_member->save();
+
+        global $members_template;
+        bp_group_has_members( array(
+            'group_id' => $g,
+        ) );
+
+        $u1_object = new WP_User( $u1 );
+
+        $expected = new stdClass;
+        $expected->user_id = $u1;
+        $expected->date_modified = $date_modified;
+        $expected->is_banned = 0;
+        $expected->user_login = $u1_object->user_login;
+        $expected->user_nicename = $u1_object->user_nicename;
+        $expected->user_email = $u1_object->user_email;
+        $expected->display_name = $u1_object->display_name;
+
+        // In order to use assertEquals, we need to discard the
+        // irrelevant properties of the found object. Hack alert
+        $found = new stdClass;
+        foreach ( array( 'user_id', 'date_modified', 'is_banned', 'user_login', 'user_nicename', 'user_email', 'display_name' ) as $key ) {
+            if ( isset( $members_template->members[0]->{$key} ) ) {
+                $found->{$key} = $members_template->members[0]->{$key};
+            }
+        }
+
+        $this->assertEquals( $expected, $found );
+    }
+
+    /**
      * @group bp_group_has_members
      */