Changeset 9711

Timestamp:

04/07/2015 12:54:07 AM (10 years ago)

Author:

boonebgorges

Message:

Improve parameter sanitization in xprofile_insert_field().

The overzealous empty() checks meant that it was impossible to set certain
values on existing fields to falsey values.

Fixes #6354.

Location:

trunk

Files:

• src/bp-xprofile/bp-xprofile-functions.php (modified) (3 diffs)
• tests/phpunit/testcases/xprofile/functions.php (modified) (1 diff)

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

@@ -231 +231 @@
         'is_default_option' => false,
         'option_order' => null,
+        'field_order' => null,
     ) );
 
@@ -238 +239 @@
     }
 
-    // Check this is a valid field type
+    // Check this is a non-empty, valid field type.
     if ( ! in_array( $r['type'], (array) buddypress()->profile->field_types ) ) {
         return false;
@@ -251 +252 @@
 
     $field->group_id = $r['field_group_id'];
-
-    if ( ! empty( $r['parent_id'] ) ) {
-        $field->parent_id = $r['parent_id'];
-    }
-
-    if ( ! empty( $r['type'] ) ) {
-        $field->type = $r['type'];
-    }
-
+    $field->type     = $r['type'];
+
+    // The 'name' field cannot be empty.
     if ( ! empty( $r['name'] ) ) {
         $field->name = $r['name'];
     }
 
-    if ( ! empty( $r['description'] ) ) {
-        $field->description = $r['description'];
-    }
-
-    if ( ! empty( $r['is_required'] ) ) {
-        $field->is_required = $r['is_required'];
-    }
-
-    if ( ! empty( $r['can_delete'] ) ) {
-        $field->can_delete = $r['can_delete'];
-    }
-
-    if ( ! empty( $r['field_order'] ) ) {
-        $field->field_order = $r['field_order'];
-    }
-
-    if ( ! empty( $r['order_by'] ) ) {
-        $field->order_by = $r['order_by'];
-    }
-
+    $field->description       = $r['description'];
+    $field->order_by          = $r['order_by'];
+    $field->parent_id         = (int) $r['parent_id'];
+    $field->field_order       = (int) $r['field_order'];
+    $field->option_order      = (int) $r['option_order'];
+    $field->is_required       = (bool) $r['is_required'];
+    $field->can_delete        = (bool) $r['can_delete'];
     $field->is_default_option = (bool) $r['is_default_option'];
-
-    if ( ! empty( $r['option_order'] ) ) {
-        $field->option_order = $r['option_order'];
-    }
 
     return $field->save();

trunk/tests/phpunit/testcases/xprofile/functions.php

@@ -646 +646 @@
     /**
      * @group xprofile_insert_field
+     * @ticket BP6354
+     */
+    public function test_xprofile_insert_field_should_process_falsey_values_for_boolean_params_on_existing_fields() {
+        $g = $this->factory->xprofile_group->create();
+        $f = xprofile_insert_field( array(
+            'field_group_id' => $g,
+            'type' => 'textbox',
+            'name' => 'Foo',
+            'is_required' => true,
+            'can_delete' => true,
+            'is_default_option' => true,
+            'parent_id' => 13,
+            'field_order' => 5,
+            'option_order' => 8,
+            'description' => 'foo',
+            'order_by' => 'custom',
+        ) );
+
+        $this->assertNotEmpty( $f );
+
+        $field = new BP_XProfile_Field( $f );
+        $this->assertEquals( 1, $field->is_required );
+        $this->assertEquals( 1, $field->can_delete );
+        $this->assertEquals( 1, $field->is_default_option );
+        $this->assertEquals( 13, $field->parent_id );
+        $this->assertEquals( 5, $field->field_order );
+        $this->assertEquals( 8, $field->option_order );
+        $this->assertEquals( 'foo', $field->description );
+        $this->assertEquals( 'custom', $field->order_by );
+
+        $f = xprofile_insert_field( array(
+            'field_group_id' => $g,
+            'type' => 'textbox',
+            'name' => 'Foo',
+            'is_required' => false,
+            'can_delete' => false,
+            'is_default_option' => false,
+            'parent_id' => 0,
+            'field_order' => 0,
+            'option_order' => 0,
+            'description' => '',
+            'order_by' => '',
+        ) );
+
+        $this->assertNotEmpty( $f );
+
+        $field = new BP_XProfile_Field( $f );
+        $this->assertEquals( 0, $field->is_required );
+        $this->assertEquals( 0, $field->can_delete );
+        $this->assertEquals( 0, $field->is_default_option );
+        $this->assertEquals( 0, $field->parent_id );
+        $this->assertEquals( 0, $field->field_order );
+        $this->assertEquals( 0, $field->option_order );
+        $this->assertEquals( '', $field->description );
+        $this->assertEquals( '', $field->order_by );
+    }
+
+    /**
+     * @group xprofile_insert_field
      */
     public function test_xprofile_insert_field_type_option_option_order() {