Changeset 9611

Timestamp:

03/10/2015 03:43:27 PM (5 years ago)

Author:

boonebgorges

Message:

Introduce bp_has_member_type().

This function allows developers to test whether a given user has a given member
type. Thus the clever function name.

Props Offereins, Mamaduka.
Fixes #6138.

Location:

trunk

Files:

• src/bp-members/bp-members-functions.php (modified) (1 diff)
• tests/phpunit/testcases/members/types.php (modified) (1 diff)

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

@@ -2682 +2682 @@
 
 /**
+ * Check whether the given user has a certain member type.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param  int    $user_id     $user_id ID of the user.
+ * @param  string $member_type Member Type.
+ * @return bool Whether the user has the given member type.
+ */
+function bp_has_member_type( $user_id, $member_type ) {
+    // Bail if no valid member type was passed.
+    if ( empty( $member_type ) || ! bp_get_member_type_object( $member_type ) ) {
+        return false;
+    }
+
+    // Get all user's member types.
+    $types = bp_get_member_type( $user_id, false );
+
+    if ( ! is_array( $types ) ) {
+        return false;
+    }
+
+    return in_array( $member_type, $types );
+}
+
+/**
  * Delete a user's member type when the user when the user is deleted.
  *

trunk/tests/phpunit/testcases/members/types.php

@@ -279 +279 @@
         $this->assertEquals( array( 'bar' ), $types );
     }
+
+    /**
+     * @group BP6138
+     */
+    function test_bp_has_member_type_should_return_false_when_member_type_is_empty() {
+        $this->assertFalse( bp_has_member_type( 5, '' ) );
+    }
+
+    /**
+     * @group BP6138
+     */
+    function test_bp_has_member_type_should_return_false_when_member_type_is_invalid() {
+        $this->assertFalse( bp_has_member_type( 5, 'foo' ) );
+    }
+
+    /**
+     * @group BP6138
+     */
+    public function test_bp_has_member_type_should_return_false_when_member_id_is_empty() {
+        bp_register_member_type( 'foo' );
+
+        $this->assertFalse( bp_has_member_type( '', 'foo' ) );
+    }
+
+    /**
+     * @group BP6138
+     */
+    public function test_bp_has_member_type_should_return_false_when_member_is_not_of_provided_type() {
+        $u1 = $this->factory->user->create();
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+        bp_set_member_type( $u1, 'bar' );
+
+        $this->assertFalse( bp_has_member_type( $u1, 'foo' ) );
+    }
+
+    /**
+     * @group BP6138
+     */
+    public function test_bp_has_member_type_should_return_true_on_success() {
+        $u1 = $this->factory->user->create();
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+        bp_set_member_type( $u1, 'foo' );
+        bp_set_member_type( $u1, 'bar', true );
+
+        $this->assertTrue( bp_has_member_type( $u1, 'foo' ) );
+        $types = bp_get_member_type( $u1, false );
+        $this->assertEqualSets( array( 'bar', 'foo' ), $types );
+    }
 }