Fix key casting in form_dropdown helper. (#5035)

codeigniter4 · Aug 31, 2021 · ab580ba · ab580ba
1 parent 3d6b3bd
commit ab580ba
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 1 deletion.
diff --git a/system/Helpers/form_helper.php b/system/Helpers/form_helper.php
@@ -298,7 +298,7 @@ function form_dropdown($data = '', $options = [], $selected = [], $extra = ''):
             }
         }
 
-        // standardize selected as strings, like  the option keys will be.
+        // Standardize selected as strings, like the option keys will be
         foreach ($selected as $key => $item) {
             $selected[$key] = (string) $item;
         }
@@ -308,6 +308,7 @@ function form_dropdown($data = '', $options = [], $selected = [], $extra = ''):
         $form     = '<select ' . rtrim(parse_form_attributes($data, $defaults)) . $extra . $multiple . ">\n";
 
         foreach ($options as $key => $val) {
+            // Keys should always be strings for strict comparison
             $key = (string) $key;
 
             if (is_array($val)) {
@@ -318,6 +319,9 @@ function form_dropdown($data = '', $options = [], $selected = [], $extra = ''):
                 $form .= '<optgroup label="' . $key . "\">\n";
 
                 foreach ($val as $optgroupKey => $optgroupVal) {
+                    // Keys should always be strings for strict comparison
+                    $optgroupKey = (string) $optgroupKey;
+
                     $sel = in_array($optgroupKey, $selected, true) ? ' selected="selected"' : '';
                     $form .= '<option value="' . htmlspecialchars($optgroupKey) . '"' . $sel . '>' . $optgroupVal . "</option>\n";
                 }

diff --git a/tests/system/Helpers/FormHelperTest.php b/tests/system/Helpers/FormHelperTest.php
@@ -435,6 +435,34 @@ public function testFormDropdownUnselected()
         $this->assertSame($expected, form_dropdown('cars', $options));
     }
 
+    public function testFormDropdownKeyCasting()
+    {
+        $options = [
+            'Swedish Cars' => [
+                '1' => 'Volvo',
+                '2' => 'Saab',
+            ],
+            2 => [
+                3   => 'Mercedes',
+                '4' => 'Audi',
+            ],
+        ];
+        $selected = [2];
+        $expected = <<<EOH
+            <select name="cars">
+            <optgroup label="Swedish Cars">
+            <option value="1">Volvo</option>
+            <option value="2" selected="selected">Saab</option>
+            </optgroup>
+            <optgroup label="2">
+            <option value="3">Mercedes</option>
+            <option value="4">Audi</option>
+            </optgroup>
+            </select>\n
+            EOH;
+        $this->assertSame($expected, form_dropdown('cars', $options, $selected));
+    }
+
     public function testFormDropdownInferred()
     {
         $options = [