Changeset 12162

Timestamp:

06/04/2018 08:43:08 PM (8 years ago)

Author:

boonebgorges

Message:

Introduce BP_Groups_Member::get_user_memberships().

This is a new low-level query method that allows a single syntax for fetching
a paginated set of results from the membership table, for different
values of is_pending, etc. Primarily for use in data exporters; see #7820.

Fixes #7859.

Location:

trunk

Files:

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

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

@@ -827 +827 @@
 
         /**
+         * Gets memberships of a user for purposes of a personal data export.
+         *
+         * @since 4.0.0
+         *
+         * @param int $user_id ID of the user.
+         * @param array $args {
+         *    Array of optional arguments.
+         *    @type int    $page     Page of memberships being requested. Default 1.
+         *    @type int    $per_page Memberships to return per page. Default 20.
+         *    @type string $type     Membership type being requested. Accepts 'membership',
+         *                           'pending_request', 'pending_received_invitation',
+         *                           'pending_sent_invitation'. Default 'membership'.
+         * }
+         *
+         * @return array
+         */
+        public static function get_user_memberships( $user_id, $args = array() ) {
+                global $wpdb;
+
+                $bp = buddypress();
+
+                $r = array_merge( array(
+                        'page'     => 1,
+                        'per_page' => 20,
+                        'type'     => 'membership',
+                ), $args );
+
+                $sql = array(
+                        'select' => 'SELECT *',
+                        'from'   => "FROM {$bp->groups->table_name_members}",
+                        'where'  => '',
+                        'limits' => '',
+                );
+
+                switch ( $r['type'] ) {
+                        case 'pending_request' :
+                                $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 0 AND inviter_id = 0", $user_id );
+                        break;
+
+                        case 'pending_received_invitation' :
+                                $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 0 AND inviter_id != 0", $user_id );
+                        break;
+
+                        case 'pending_sent_invitation' :
+                                $sql['where'] = $wpdb->prepare( "inviter_id = %d AND is_confirmed = 0", $user_id );
+                        break;
+
+                        case 'membership' :
+                        default :
+                                $sql['where'] = $wpdb->prepare( "user_id = %d AND is_confirmed = 1", $user_id );
+                        break;
+                }
+
+                if ( $r['page'] && $r['per_page'] ) {
+                        $sql['limits'] = $wpdb->prepare( "LIMIT %d, %d", ( $r['page'] - 1 ) * $r['per_page'], $r['per_page'] );
+                }
+
+                $memberships = $wpdb->get_results( "{$sql['select']} {$sql['from']} WHERE {$sql['where']} {$sql['limits']}" );
+
+                foreach ( $memberships as &$membership ) {
+                        $membership->id           = (int) $membership->id;
+                        $membership->group_id     = (int) $membership->group_id;
+                        $membership->user_id      = (int) $membership->user_id;
+                        $membership->inviter_id   = (int) $membership->inviter_id;
+                        $membership->is_admin     = (int) $membership->is_admin;
+                        $membership->is_mod       = (int) $membership->is_mod;
+                        $membership->is_banned    = (int) $membership->is_banned;
+                        $membership->is_confirmed = (int) $membership->is_confirmed;
+                        $membership->invite_sent  = (int) $membership->invite_sent;
+                }
+
+                return $memberships;
+        }
+
+        /**
          * Check whether a user has an outstanding invitation to a given group.
          *

trunk/tests/phpunit/includes/testcase.php

@@ -120 +120 @@
                         bp_activity_remove_all_user_data( $user_id );
                 }
+
+                bp_core_remove_data( $user_id );
 
                 return $deleted;

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

@@ -5 +5 @@
  */
 class BP_Tests_BP_Groups_Member_TestCases extends BP_UnitTestCase {
+        static public $user_ids;
+        static public $group_ids;
+
+        public static function wpSetUpBeforeClass( $factory ) {
+                global $wpdb, $bp;
+                self::$user_ids  = $factory->user->create_many( 4 );
+                self::$group_ids = $factory->group->create_many( 3, array(
+                        'creator_id' => self::$user_ids[3],
+                ) );
+        }
+
+        public static function wpTearDownAfterClass() {
+                array_map( array( __CLASS__, 'delete_user' ), self::$user_ids );
+                array_map( 'groups_delete_group', self::$group_ids );
+        }
+
         public static function invite_user_to_group( $user_id, $group_id, $inviter_id ) {
                 $invite                = new BP_Groups_Member;
@@ -1372 +1388 @@
                 $this->assertTrue( is_array( $admins ) && empty( $admins ) );
         }
+
+        /**
+         * @ticket BP7859
+         */
+        public function test_get_user_memberships_type_membership() {
+                groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+
+                $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+                        'type' => 'membership',
+                ) );
+
+                $this->assertCount( 1, $memberships );
+                $this->assertSame( self::$group_ids[0], $memberships[0]->group_id );
+        }
+
+        /**
+         * @ticket BP7859
+         */
+        public function test_get_user_memberships_type_pending_request() {
+                groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+                groups_send_membership_request( self::$user_ids[0], self::$group_ids[1] );
+
+                $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+                        'type' => 'pending_request',
+                ) );
+
+                $this->assertCount( 1, $memberships );
+                $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+        }
+
+        /**
+         * @ticket BP7859
+         */
+        public function test_get_user_memberships_type_pending_received_invitation() {
+                groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+                groups_invite_user( array(
+                        'user_id'    => self::$user_ids[0],
+                        'group_id'   => self::$group_ids[1],
+                        'inviter_id' => self::$user_ids[1],
+                ) );
+
+                $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+                        'type' => 'pending_received_invitation',
+                ) );
+
+                $this->assertCount( 1, $memberships );
+                $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+        }
+
+        /**
+         * @ticket BP7859
+         */
+        public function test_get_user_memberships_type_pending_sent_invitation() {
+                groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+                groups_invite_user( array(
+                        'user_id'    => self::$user_ids[1],
+                        'group_id'   => self::$group_ids[1],
+                        'inviter_id' => self::$user_ids[0],
+                ) );
+
+                $memberships = BP_Groups_Member::get_user_memberships( self::$user_ids[0], array(
+                        'type' => 'pending_sent_invitation',
+                ) );
+
+                $this->assertCount( 1, $memberships );
+                $this->assertSame( self::$group_ids[1], $memberships[0]->group_id );
+        }
 }