Changeset 10022 for trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-group.php

Timestamp:

07/21/2015 02:00:38 PM (11 years ago)

Author:

boonebgorges

Message:

Allow xProfile fields to be restricted to users belonging to one or more member types.

A new metabox on the profile field edit panel allows the administrator to
select the member types to which the field is applicable. Admins can also
choose to have a field apply to users who do not belong to any member type.
Information about a field's member type associations is displayed on the
Users > Profile Fields page, alongside each field name.

During registration, the only fields that are displayed are those that are
unrestricted - that is, those available to all users, regardless of member type
(or lack thereof).

This changeset introduces a number of new methods on BP_XProfile_Field that
developers should use to manipulate member type information:
get_member_types(), set_member_types(), and the static
get_fields_for_member_type(). In addition to member types that have been
explicitly registered, 'null' is a pseudo-type representing users who do not
belong to a member type.

This changeset introduces a blacklist of illegal member type names. By default,
the blacklist includes 'any', 'null', and '_none'. Use the
'bp_member_type_illegal_names' filter to add names to the blacklist.

Props Offereins, boonebgorges, tanner m, imath.
See #5192.

File:

• trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-group.php (modified) (1 diff)

trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-group.php

@@ -114 +114 @@
 
     /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_restrictions_should_be_ignored_when_user_id_is_null_and_member_type_is_not_explicitly_provided() {
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+
+        $field = new BP_XProfile_Field( $f );
+        $field->set_member_types( array( 'foo' ) );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'user_id' => false,
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertContains( $f, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_restrictions_should_be_ignored_when_user_id_is_0_and_member_type_is_false() {
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+
+        $field = new BP_XProfile_Field( $f );
+        $field->set_member_types( array( 'foo' ) );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'user_id' => 0,
+            'member_type' => false,
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertContains( $f, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_restrictions_should_be_obeyed_for_nonzero_user_id() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f3 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f4 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        // Field 1 is visible only to 'foo' users.
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+
+        // Field 2 is visible only to 'bar' users.
+        $field2 = new BP_XProfile_Field( $f2 );
+        $field2->set_member_types( array( 'bar' ) );
+
+        // Field 3 is visible to all users (no member type set).
+
+        // Field 4 is visible to no one.
+        $field4 = new BP_XProfile_Field( $f4 );
+        $field4->set_member_types( array() );
+
+        // User is in 'foo', so should have f1 and f3 only.
+        $u = $this->factory->user->create();
+        bp_set_member_type( $u, 'foo' );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'user_id' => $u,
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f3, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertNotContains( $f2, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertNotContains( $f4, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_restrictions_should_be_obeyed_for_nonzero_user_id_with_no_member_types() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f3 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        // Field 1 is visible only to 'foo' users.
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+
+        // Field 2 is visible only to 'null' users.
+        $field2 = new BP_XProfile_Field( $f2 );
+        $field2->set_member_types( array( 'null' ) );
+
+        // Field 3 is visible to all users (no member type set).
+
+        // User has no member types, so should see f2 and f3 .
+        $u = $this->factory->user->create();
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'user_id' => $u,
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertNotContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f2, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f3, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_types_of_provided_user_id_should_take_precedence_over_provided_member_type() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+        $field2 = new BP_XProfile_Field( $f2 );
+        $field2->set_member_types( array( 'bar' ) );
+
+        $u = $this->factory->user->create();
+        bp_set_member_type( $u, 'foo' );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'user_id' => $u,
+            'member_type' => 'bar',
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_single_value_should_be_respected() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+        $field2 = new BP_XProfile_Field( $f2 );
+        $field2->set_member_types( array( 'bar' ) );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'member_type' => 'bar',
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertNotContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f2, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_array_value_should_be_respected() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+        $field2 = new BP_XProfile_Field( $f2 );
+        $field2->set_member_types( array( 'bar' ) );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'member_type' => array( 'bar' ),
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertNotContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f2, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
+     * @group member_types
+     * @ticket BP5192
+     */
+    public function test_member_type_null_should_be_respected() {
+        $g = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        $f2 = $this->factory->xprofile_field->create( array( 'field_group_id' => $g ) );
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+
+        $field1 = new BP_XProfile_Field( $f1 );
+        $field1->set_member_types( array( 'foo' ) );
+
+        $found_groups = BP_XProfile_Group::get( array(
+            'member_type' => array( 'null' ),
+            'fetch_fields' => true,
+        ) );
+
+        // The groups aren't indexed, so we have to go looking for it.
+        foreach ( $found_groups as $fg ) {
+            if ( $g == $fg->id ) {
+                $the_group = $fg;
+            }
+        }
+
+        $this->assertNotContains( $f1, wp_list_pluck( $the_group->fields, 'id' ) );
+        $this->assertContains( $f2, wp_list_pluck( $the_group->fields, 'id' ) );
+    }
+
+    /**
      * @group save_xprofile_group_name
      */