Ticket #8339: 8339-xprofile.diff

src/bp-xprofile/bp-xprofile-functions.php

@@ -454 +454 @@
 
         // For certain fields, only certain parameters are acceptable, so add them to the list of allowed values.
         if ( $field_type_obj->supports_options ) {
-                $field_type_obj->set_whitelist_values( wp_list_pluck( $field->get_children(), 'name' ) );
+                $field_type_obj->set_allowed_values( wp_list_pluck( $field->get_children(), 'name' ) );
         }
 
         // Check the value is in an accepted format for this form field.

src/bp-xprofile/classes/class-bp-xprofile-field-type.php

@@ -31 +31 @@
          * @since 2.0.0
          * @var array Field type allowed values.
          */
-        protected $validation_whitelist = array();
+        protected $validation_allowed_values = array();
 
         /**
          * Name for field type.
@@ -153 +153 @@
         }
 
         /**
-         * Add a value to this type's whitelist that profile data will be asserted against.
-         *
-         * You can call this method multiple times to set multiple formats. When validation is performed,
-         * it's successful as long as the new value matches any one of the registered formats.
+         * Add a value to this type's list of allowed values that profile data will be asserted against.
          *
          * @since 2.0.0
+         * @deprecated 7.0.0 Use set_allowed_values() instead.
          *
          * @param string|array $values Whitelisted values.
          * @return BP_XProfile_Field_Type
          */
         public function set_whitelist_values( $values ) {
+                _deprecated_function( __METHOD__, '7.0.0', 'BP_XProfile_Field_Type::set_allowed_values()' );
+                $this->set_allowed_values( $values );
+        }
+
+        /**
+         * Add a value to this type's list of allowed values that profile data will be asserted against.
+         *
+         * You can call this method multiple times to set multiple formats. When validation is performed,
+         * it's successful as long as the new value matches any one of the registered formats.
+         *
+         * @since 7.0.0
+         *
+         * @param string|array $values Allowed values.
+         * @return BP_XProfile_Field_Type
+         */
+        public function set_allowed_values( $values ) {
                 foreach ( (array) $values as $value ) {
 
                         /**
-                         * Filters values for field type's whitelist that profile data will be asserted against.
+                         * Filters values for field type's list of allowed values that profile data will be asserted against.
                          *
                          * @since 2.0.0
+                         * @deprecated 7.0.0 Use 'bp_xprofile_field_type_set_allowed_values' instead.
+                         *
+                         * @param string                 $value  Field value.
+                         * @param array                  $values Original array of values.
+                         * @param BP_XProfile_Field_Type $this   Current instance of the BP_XProfile_Field_Type class.
+                         */
+                        $this->validation_allowed_values[] = apply_filters_deprecated( 'bp_xprofile_field_type_set_whitelist_values', array( $value, $values, $this ), '7.0.0', 'bp_xprofile_field_type_set_allowed_values' );
+
+                        /**
+                         * Filters values for field type's list of allowed values that profile data will be asserted against.
+                         *
+                         * @since 7.0.0
                          *
                          * @param string                 $value  Field value.
                          * @param array                  $values Original array of values.
                          * @param BP_XProfile_Field_Type $this   Current instance of the BP_XProfile_Field_Type class.
                          */
-                        $this->validation_whitelist[] = apply_filters( 'bp_xprofile_field_type_set_whitelist_values', $value, $values, $this );
+                        $this->validation_allowed_values[] = apply_filters( 'bp_xprofile_field_type_set_allowed_values', $value, $values, $this );
                 }
 
                 return $this;
@@ -214 +240 @@
                         $validated = true;
                 }
 
-                // If there's a whitelist set, make sure that each value is a whitelisted value.
-                if ( ( true === $validated ) && ! empty( $values ) && ! empty( $this->validation_whitelist ) ) {
+                // If there's a list of allowed values, make sure that each value is on that list.
+                if ( ( true === $validated ) && ! empty( $values ) && ! empty( $this->validation_allowed_values ) ) {
                         foreach ( (array) $values as $value ) {
-                                if ( ! in_array( $value, $this->validation_whitelist, true ) ) {
+                                if ( ! in_array( $value, $this->validation_allowed_values, true ) ) {
                                         $validated = false;
                                         break;
                                 }

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

@@ -24 +24 @@
                 $this->assertTrue( $field->is_valid( 123 ) );
         }
 
-        public function test_textbox_validate_whitelisted_string() {
+        public function test_textbox_validate_allowed_string() {
                 $field = bp_xprofile_create_field_type( 'textbox' );
 
                 $this->assertTrue( $field->is_valid( 'a string' ) );
-                $this->assertFalse( $field->set_whitelist_values( 'pizza' )->is_valid( 'pasta' ) );
+                $this->assertFalse( $field->set_allowed_values( 'pizza' )->is_valid( 'pasta' ) );
                 $this->assertTrue( $field->is_valid( 'pizza' ) );
         }
 
-        public function test_multiselectbox_validate_whitelisted_array() {
+        public function test_multiselectbox_validate_allowed_array() {
                 $field = bp_xprofile_create_field_type( 'multiselectbox' );
-                $field->set_whitelist_values( array( 'cheese', 'pepporoni' ) );
+                $field->set_allowed_values( array( 'cheese', 'pepporoni' ) );
 
                 $this->assertTrue( $field->is_valid( array( 'cheese', 'pepporoni' ) ) );
                 $this->assertTrue( $field->is_valid( array( 'cheese' ) ) );
@@ -44 +44 @@
 
         public function test_multiselectbox_validate_null_value() {
                 $field = bp_xprofile_create_field_type( 'multiselectbox' );
-                $field->set_whitelist_values( array( 'cheese', 'pepporoni' ) );
+                $field->set_allowed_values( array( 'cheese', 'pepporoni' ) );
 
                 $this->assertFalse( $field->is_valid( array( '' ) ) );
                 $this->assertFalse( $field->is_valid( '' ) );
@@ -98 +98 @@
                 $this->assertFalse( $field->is_valid( '' ) );
         }
 
-        public function test_number_validate_whitelisted_array() {
+        public function test_number_validate_allowed_array() {
                 $field = bp_xprofile_create_field_type( 'number' );
-                $field->set_whitelist_values( array( 123, 456 ) );
+                $field->set_allowed_values( array( 123, 456 ) );
 
                 $this->assertTrue( $field->is_valid( array( 123 ) ) );
                 $this->assertTrue( $field->is_valid( array( 456 ) ) );
@@ -108 +108 @@
                 $this->assertFalse( $field->is_valid( array( 789 ) ) );
         }
 
-        public function test_radiobutton_validate_whitelisted_array() {
+        public function test_radiobutton_validate_allowed_array() {
                 $field = bp_xprofile_create_field_type( 'radio' );
-                $field->set_whitelist_values( array( 'cheese', 'pepporoni' ) );
+                $field->set_allowed_values( array( 'cheese', 'pepporoni' ) );
 
                 $this->assertTrue( $field->is_valid( array( 'cheese', 'pepporoni' ) ) );
                 $this->assertTrue( $field->is_valid( array( 'cheese' ) ) );
@@ -119 +119 @@
                 $this->assertFalse( $field->is_valid( '' ) );
         }
 
-        public function test_radiobutton_do_not_validate_empty_items_in_whitelist() {
+        public function test_radiobutton_do_not_validate_empty_items_in_allowed_list() {
                 $field = bp_xprofile_create_field_type( 'radio' );
-                $field->set_whitelist_values( array( '' ) );
+                $field->set_allowed_values( array( '' ) );
 
                 $this->assertFalse( $field->is_valid( array( '' ) ) );
         }
 
-        public function test_checkbox_validate_whitelisted_array() {
+        public function test_checkbox_validate_allowed_array() {
                 $field = bp_xprofile_create_field_type( 'checkbox' );
-                $field->set_whitelist_values( array( 'cheese', 'pepporoni' ) );
+                $field->set_allowed_values( array( 'cheese', 'pepporoni' ) );
 
                 $this->assertTrue( $field->is_valid( array( 'cheese', 'pepporoni' ) ) );
                 $this->assertTrue( $field->is_valid( array( 'cheese' ) ) );
@@ -139 +139 @@
 
         public function test_checkbox_validate_null_value() {
                 $field = bp_xprofile_create_field_type( 'checkbox' );
-                $field->set_whitelist_values( array( 'cheese', 'pepporoni' ) );
+                $field->set_allowed_values( array( 'cheese', 'pepporoni' ) );
 
                 $this->assertFalse( $field->is_valid( array( '' ) ) );
                 $this->assertFalse( $field->is_valid( '' ) );