Changeset 12868 for trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-field-type.php

Timestamp:

03/21/2021 02:17:21 PM (3 years ago)

Author:

imath

Message:

Field Types can now declare supported features & field visibility

• Edit the JavaScript file used by the xProfile Create field Administration screen to handle Field types requirements by showing/hiding screen metaboxes according to feature supports and to get ride of some jQuery deprecated methods.
• Improve the xProfile Field API to take in account xProfile Field Types declared feature supports by adding two new methods to get (BP_XProfile_Field->get_field_type_supports()) & check (BP_XProfile_Field->field_type_supports( $feature_name )) the field type supported features.
• The xProfile Create field Administration Screen Metaboxes displayed to set the field properties can now be disabled by the Field Type using the static variable $supported_features. See tests/phpunit/assets/bptest-xprofile-field-type.php for an example of use.
• Improve the xProfile Field API to take in account the xProfile Field Types visibility property to use as default field visibility. NB: setting this Field Type visibility and its allow_custom_visibility feature support to false, a Field Type can now enforce the visibility to use for a field.
• Introduce a new xProfile Fields loop argument $hide_field_types to avoid displaying fields according to an array of Field types. To customize this new argument you can use the bp_before_has_profile_parse_args filter for existing xProfile loop. For instance you can avoid to list xProfile fields according to their type from the WP-Admin/Extended profile screen checking the corresponding Administration Screen ID.
• Add PHP unit tests to verify these improvements are working the right way.

Props DJPaul, Offereins, needle, netweb, vapvarun

See #7162

File:

• trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-field-type.php (modified) (3 diffs)

trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-field-type.php

@@ -1 +1 @@
 <?php
+// Include the xProfile Test Type
+include_once BP_TESTS_DIR . 'assets/bptest-xprofile-field-type.php';
+
 /**
  * @group xprofile
@@ -5 +8 @@
  */
 class BP_Tests_XProfile_Field_Type extends BP_UnitTestCase {
+
+    public function setUp() {
+        parent::setUp();
+
+        add_filter( 'bp_xprofile_get_field_types', array( $this, 'get_field_types' ) );
+    }
+
+    public function tearDown() {
+        parent::tearDown();
+
+        remove_filter( 'bp_xprofile_get_field_types', array( $this, 'get_field_types' ) );
+    }
+
     public function test_unregistered_field_type_returns_textbox() {
         $field = bp_xprofile_create_field_type( 'fakeyfield' );
@@ -184 +200 @@
         $this->assertTrue( $field->is_valid( '(212) 664-7665' ) );
     }
+
+    /**
+     * @ticket BP7162
+     */
+    public function test_xprofile_field_type_test_supports() {
+        $group_id = self::factory()->xprofile_group->create();
+        $field_id = self::factory()->xprofile_field->create(
+            array(
+                'field_group_id' => $group_id,
+                'type'           => 'test-field-type',
+                'name'           => 'Test Supports',
+            )
+        );
+
+        $field = xprofile_get_field( $field_id, null, false );
+
+        $this->assertTrue( $field->field_type_supports( 'switch_fieldtype' ) );
+        $this->assertFalse( $field->field_type_supports( 'do_autolink' ) );
+        $this->assertFalse( $field->field_type_supports( 'allow_custom_visibility' ) );
+        $this->assertTrue( $field->field_type_supports( 'required' ) );
+        $this->assertTrue( $field->field_type_supports( 'member_types' ) );
+        $this->assertEquals( 'adminsonly', $field->get_default_visibility() );
+    }
+
+    public function get_field_types( $types ) {
+        $types['test-field-type'] = 'BPTest_XProfile_Field_Type';
+        return $types;
+    }
 }