Changeset 8044

Timestamp:

03/05/2014 02:37:27 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce 'inviter_id' and 'invite_sent' params to BP_Group_Member_Query

These additional parameters make it possible to use BP_Group_Member_Query for
unconfirmed group memberships, as in the case of invitations and requests. This
will allow it to be swapped for the internals of bp_group_has_members(). See

Props dcavins for an initial patch

Location:

trunk

Files:

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

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

@@ -1448 +1448 @@
  * Query for the members of a group.
  *
+ * Special notes about the group members data schema:
+ * - *Members* are entries with is_confirmed = 1
+ * - *Pending requests* are entries with is_confirmed = 0 and inviter_id = 0
+ * - *Pending and sent invitations* are entries with is_confirmed = 0 and
+ *   inviter_id != 0 and invite_sent = 1
+ * - *Pending and unsent invitations* are entries with is_confirmed = 0 and
+ *   inviter_id != 0 and invite_sent = 0
+ *
  * @since BuddyPress (1.8.0)
  *
@@ -1515 +1523 @@
             'group_role'   => array( 'member' ),
             'is_confirmed' => true,
+            'invite_sent'  => null,
+            'inviter_id'   => null,
             'type'         => 'last_joined',
         ) );
@@ -1563 +1573 @@
         $is_confirmed = ! empty( $this->query_vars['is_confirmed'] ) ? 1 : 0;
         $sql['where'][] = $wpdb->prepare( "is_confirmed = %d", $is_confirmed );
+
+        // invite_sent
+        if ( ! is_null( $this->query_vars['invite_sent'] ) ) {
+            $invite_sent = ! empty( $this->query_vars['invite_sent'] ) ? 1 : 0;
+            $sql['where'][] = $wpdb->prepare( "invite_sent = %d", $invite_sent );
+        }
+
+        // inviter_id
+        if ( ! is_null( $this->query_vars['inviter_id'] ) ) {
+            $inviter_id = $this->query_vars['inviter_id'];
+
+            // Empty: inviter_id = 0. (pass false, 0, or empty array)
+            if ( empty( $inviter_id ) ) {
+                $sql['where'][] = "inviter_id = 0";
+
+            // The string 'any' matches any non-zero value (inviter_id != 0)
+            } else if ( 'any' === $inviter_id ) {
+                $sql['where'][] = "inviter_id != 0";
+
+            // Assume that a list of inviter IDs has been passed
+            } else {
+                // Parse and sanitize
+                $inviter_ids = wp_parse_id_list( $inviter_id );
+                if ( ! empty( $inviter_ids ) ) {
+                    $inviter_ids_sql = implode( ',', $inviter_ids );
+                    $sql['where'][] = "inviter_id IN ({$inviter_ids_sql})";
+                }
+            }
+        }
 
         // Role information is stored as follows: admins have

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

@@ -423 +423 @@
         $this->assertEquals( array( $u1, $u3, $u2 ), $ids );
     }
+
+    /**
+     * @group invite_sent
+     */
+    public function test_with_invite_sent_true() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'is_confirmed' => 0,
+            'invite_sent' => 0,
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'is_confirmed' => 0,
+            'invite_sent' => 1,
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'is_confirmed' => false,
+            'invite_sent' => true,
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u2 ), $ids );
+    }
+
+    /**
+     * @group invite_sent
+     */
+    public function test_with_invite_sent_false() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'is_confirmed' => 0,
+            'invite_sent' => 0,
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'is_confirmed' => 0,
+            'invite_sent' => 1,
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'is_confirmed' => false,
+            'invite_sent' => false,
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u1 ), $ids );
+    }
+
+    /**
+     * @group inviter_id
+     */
+    public function test_with_inviter_id_false() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'inviter_id' => 0,
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'inviter_id' => 1,
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'inviter_id' => false,
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u1 ), $ids );
+    }
+
+    /**
+     * @group inviter_id
+     */
+    public function test_with_inviter_id_specific() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $u3 = $this->create_user();
+        $u4 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'inviter_id' => 0,
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ),
+            'inviter_id' => 1,
+        ) );
+
+        $this->add_user_to_group( $u3, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ),
+            'inviter_id' => 6,
+        ) );
+
+        $this->add_user_to_group( $u4, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 400 ),
+            'inviter_id' => 2,
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'inviter_id' => array( 2, 6 ),
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u3, $u4 ), $ids );
+    }
+
+    /**
+     * @group inviter_id
+     */
+    public function test_with_inviter_id_any() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $u3 = $this->create_user();
+        $u4 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+            'inviter_id' => 0,
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ),
+            'inviter_id' => 1,
+        ) );
+
+        $this->add_user_to_group( $u3, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ),
+            'inviter_id' => 6,
+        ) );
+
+        $this->add_user_to_group( $u4, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 400 ),
+            'inviter_id' => 2,
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'inviter_id' => 'any',
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u2, $u3, $u4 ), $ids );
+    }
 }