Changeset 11604

Timestamp:

06/21/2017 10:37:23 PM (9 years ago)

Author:

r-a-y

Message:

Groups: Add fine-grained querying of invite sent status in groups_get_invites_for_group().

This commit introduces a new $sent parameter to groups_get_invites_for_group()
and BP_Groups_Group::get_invites(). With this parameter, developers can
now query group invites by sent status or not.

See #7397.

Location:

trunk

Files:

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

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

@@ -1626 +1626 @@
  *
  * @since 1.0.0
- *
- * @param int $user_id  ID of the inviting user.
- * @param int $group_id ID of the group.
- * @return array $value IDs of users who have been invited to the group by the
- *                      user but have not yet accepted.
- */
-function groups_get_invites_for_group( $user_id, $group_id ) {
-        return BP_Groups_Group::get_invites( $user_id, $group_id );
+ * @since 2.9.0 Added $sent as a parameter.
+ *
+ * @param  int      $user_id  ID of the inviting user.
+ * @param  int      $group_id ID of the group.
+ * @param  int|null $sent     Query for a specific invite sent status. If 0, this will query for users
+ *                            that haven't had an invite sent to them yet. If 1, this will query for
+ *                            users that have had an invite sent to them. If null, no invite status will
+ *                            queried. Default: null.
+ * @return array    IDs of users who have been invited to the group by the user but have not
+ *                  yet accepted.
+ */
+function groups_get_invites_for_group( $user_id, $group_id, $sent = null ) {
+        return BP_Groups_Group::get_invites( $user_id, $group_id, $sent );
 }
 

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -753 +753 @@
          *
          * @since 1.6.0
-         *
-         * @param int $user_id ID of the inviting user.
-         * @param int $group_id ID of the group.
-         * @return array IDs of users who have been invited to the group by the
-         *               user but have not yet accepted.
-         */
-        public static function get_invites( $user_id, $group_id ) {
+         * @since 2.9.0 Added $sent as a parameter.
+         *
+         * @param  int      $user_id  ID of the inviting user.
+         * @param  int      $group_id ID of the group.
+         * @param  int|null $sent     Query for a specific invite sent status. If 0, this will query for users
+         *                            that haven't had an invite sent to them yet. If 1, this will query for
+         *                            users that have had an invite sent to them. If null, no invite status will
+         *                            queried. Default: null.
+         * @return array    IDs of users who have been invited to the group by the user but have not
+         *                  yet accepted.
+         */
+        public static function get_invites( $user_id, $group_id, $sent = null ) {
                 global $wpdb;
 
-                $bp = buddypress();
-
-                return $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d and is_confirmed = 0 AND inviter_id = %d", $group_id, $user_id ) );
+                $bp  = buddypress();
+                $sql = $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d and is_confirmed = 0 AND inviter_id = %d", $group_id, $user_id );
+
+                // Query for a specific invite sent status.
+                if ( ! is_null( $sent ) ) {
+                        $sql .= $wpdb->prepare( ' AND invite_sent = %d', $sent );
+                }
+
+                return $wpdb->get_col( $sql );
         }
 

trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php

@@ -1151 +1151 @@
 
         /**
-         * @group groups_send_membership_request
-         * @group group_membership_requests
-         * @group group_membership
-         */
-        public function test_groups_send_membership_request() {
-                $u1 = $this->factory->user->create();
-                $g1 = $this->factory->group->create();
-
-                // Create membership request
-                groups_send_membership_request( $u1, $g1 );
-
-                $request = groups_check_for_membership_request( $u1, $g1 );
-                $this->assertTrue( is_numeric( $request ) && $request > 0 );
-        }
-
-        /**
-         * @group groups_accept_membership_request
-         * @group group_membership_requests
-         * @group group_membership
-         */
-        public function test_groups_accept_membership_request_by_membership_id() {
-                $u1 = $this->factory->user->create();
-                $g1 = $this->factory->group->create();
-
-                // Create membership request
-                groups_send_membership_request( $u1, $g1 );
-
-                // Get group invitations of any type, from any user in the group.
-                $member = new BP_Groups_Member( $u1, $g1 );
-
-                groups_accept_membership_request( $member->id );
-
-                // User should now be a group member.
-                $member = groups_is_user_member( $u1, $g1 );
-
-                $this->assertTrue( is_numeric( $member ) && $member > 0 );
-        }
-
-        /**
-         * @group groups_accept_membership_request
-         * @group group_membership_requests
-         * @group group_membership
-         */
-        public function test_groups_accept_membership_request_by_user_id_group_id() {
-                $u1 = $this->factory->user->create();
-                $g1 = $this->factory->group->create();
-
-                // Create membership request
-                groups_send_membership_request( $u1, $g1 );
-
-                groups_accept_membership_request( null, $u1, $g1 );
-
-                // User should now be a group member
-                $member = groups_is_user_member( $u1, $g1 );
-                $this->assertTrue( is_numeric( $member ) && $member > 0 );
-        }
-
-        /**
-         * @group groups_send_invites
-         * @group group_invitations
-         * @group group_membership_requests
-         * @group group_membership
-         */
-        public function test_groups_membership_request_plus_invite_equals_member() {
-                $u1 = $this->factory->user->create();
-                $u2 = $this->factory->user->create();
-                $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
-
-                // Create membership request
-                groups_send_membership_request( $u2, $g1 );
+         * @group groups_get_invites_for_group
+         * @group group_send_invites
+         * @group group_invitations
+         * @group group_membership
+         */
+        public function test_groups_get_invites_for_group_with_sent_parameter() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+                $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
 
                 // Create draft invitation
@@ -1231 +1170 @@
                 ) );
 
+                // Send the invitation; this will set the 'invite_sent' value to 1.
+                groups_send_invites( $u1, $g1 );
+
+                // Default groups_get_invites_for_group() call
+                $i = groups_get_invites_for_group( $u1, $g1 );
+                $this->assertEqualSets( array( $u2 ), $i );
+
+                // Fetch users whose invites have been sent out; should be the same as above.
+                $i = groups_get_invites_for_group( $u1, $g1 );
+                $this->assertEqualSets( array( $u2 ), $i );
+
+                // Fetch users whose invites haven't been sent yet.
+                $i = groups_get_invites_for_group( $u1, $g1, 0 );
+                $this->assertEmpty( $i );
+        }
+
+        /**
+         * @group groups_send_membership_request
+         * @group group_membership_requests
+         * @group group_membership
+         */
+        public function test_groups_send_membership_request() {
+                $u1 = $this->factory->user->create();
+                $g1 = $this->factory->group->create();
+
+                // Create membership request
+                groups_send_membership_request( $u1, $g1 );
+
+                $request = groups_check_for_membership_request( $u1, $g1 );
+                $this->assertTrue( is_numeric( $request ) && $request > 0 );
+        }
+
+        /**
+         * @group groups_accept_membership_request
+         * @group group_membership_requests
+         * @group group_membership
+         */
+        public function test_groups_accept_membership_request_by_membership_id() {
+                $u1 = $this->factory->user->create();
+                $g1 = $this->factory->group->create();
+
+                // Create membership request
+                groups_send_membership_request( $u1, $g1 );
+
+                // Get group invitations of any type, from any user in the group.
+                $member = new BP_Groups_Member( $u1, $g1 );
+
+                groups_accept_membership_request( $member->id );
+
+                // User should now be a group member.
+                $member = groups_is_user_member( $u1, $g1 );
+
+                $this->assertTrue( is_numeric( $member ) && $member > 0 );
+        }
+
+        /**
+         * @group groups_accept_membership_request
+         * @group group_membership_requests
+         * @group group_membership
+         */
+        public function test_groups_accept_membership_request_by_user_id_group_id() {
+                $u1 = $this->factory->user->create();
+                $g1 = $this->factory->group->create();
+
+                // Create membership request
+                groups_send_membership_request( $u1, $g1 );
+
+                groups_accept_membership_request( null, $u1, $g1 );
+
+                // User should now be a group member
+                $member = groups_is_user_member( $u1, $g1 );
+                $this->assertTrue( is_numeric( $member ) && $member > 0 );
+        }
+
+        /**
+         * @group groups_send_invites
+         * @group group_invitations
+         * @group group_membership_requests
+         * @group group_membership
+         */
+        public function test_groups_membership_request_plus_invite_equals_member() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+                $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+                // Create membership request
+                groups_send_membership_request( $u2, $g1 );
+
+                // Create draft invitation
+                groups_invite_user( array(
+                        'user_id'       => $u2,
+                        'group_id'      => $g1,
+                        'inviter_id'    => $u1,
+                        'date_modified' => bp_core_current_time(),
+                        'is_confirmed'  => 0
+                ) );
+
                 // Send the invitation
                 groups_send_invites( $u1, $g1 );