Fix bug where selects with optgroups weren't populated correctly

Author: Anahkiasen

CHANGELOG.md

@@ -1,6 +1,6 @@
 ## CHANGELOG
 
-3.3.0 (develop)
+3.3.0 (stable)
 -----
 
 - [add] Add ability to pass attributes to a select's options
@@ -10,10 +10,11 @@
 - [add] Allow switching to alternate icon fonts
 - [mod] Form classes are now framework-dependant
 - [mod] More work on the Bootstrap 3 integration
-- [fix] Prevent custom groups from responding to errors fro non-grouped fields
+- [fix] Prevent custom groups from responding to errors from non-grouped fields
 - [fix] Fix bug in selection false values in Selects
+- [fix] Fix bug where selects with optgroups weren't populated correctly
 
-3.2.0 (stable)
+3.2.0
 -----
 
 - **[mod] Updated TwitterBootstrap3 to the latest release**

composer.lock

@@ -91,9 +91,7 @@ public function render()
     // Mark selected values as selected
     if ($this->hasChildren() and !empty($this->value)) {
       foreach ($this->value as $value) {
-        if ($child = $this->getChild($value)) {
-          $child->selected('selected');
-        }
+        $this->selectValue($value);
       }
     }
 
@@ -107,6 +105,39 @@ public function render()
     return parent::render();
   }
 
+  /**
+   * Select a value in the field's children
+   *
+   * @param mixed   $value
+   * @param Element $parent
+   *
+   * @return void
+   */
+  protected function selectValue($value, $parent = null)
+  {
+    // If no parent element defined, use direct children
+    if (!$parent) {
+      $parent = $this;
+    }
+
+    // Look in direct childs
+    if ($child = $parent->getChild($value)) {
+      return $child->selected('selected');
+    }
+
+    foreach ($parent->getChildren() as $child) {
+      // Search by value
+      if ($child->getAttribute('value') == $value) {
+        $child->selected('selected');
+      }
+
+      // Else iterate over subchilds
+      if ($child->hasChildren()) {
+        $this->selectValue($value, $child);
+      }
+    }
+  }
+
   /**
    * Get the Select's placeholder
    *

src/Former/Form/Fields/Select.php

@@ -278,7 +278,7 @@ public function testCanCreateRangeSelects()
 
   public function testCanCreateSelectGroups()
   {
-    $values = array('foo' => array(1 => 'foo', 2 => 'bar'), 'bar' => array(1 => 'foo', 2 => 'bar'));
+    $values = array('foo' => array(1 => 'foo', 2 => 'bar'), 'bar' => array(3 => 'foo', 4 => 'bar'));
     $select = $this->former->select('foo')->options($values);
 
     $matcher =
@@ -287,8 +287,25 @@ public function testCanCreateSelectGroups()
         '<option value="1">foo</option><option value="2">bar</option>'.
       '</optgroup>'.
       '<optgroup label="bar">'.
+        '<option value="3">foo</option><option value="4">bar</option>'.
+      '</optgroup>'.
+    '</select>';
+    $this->assertEquals($matcher, $select->render());
+  }
+
+  public function testCanPopulateSelectGroups()
+  {
+    $values = array('foo' => array(1 => 'foo', 2 => 'bar'), 'bar' => array(3 => 'foo', 4 => 'bar'));
+    $select = $this->former->select('foo')->options($values)->select(4);
+
+    $matcher =
+    '<select id="foo" name="foo">'.
+      '<optgroup label="foo">'.
         '<option value="1">foo</option><option value="2">bar</option>'.
       '</optgroup>'.
+      '<optgroup label="bar">'.
+        '<option value="3">foo</option><option value="4" selected="selected">bar</option>'.
+      '</optgroup>'.
     '</select>';
     $this->assertEquals($matcher, $select->render());
   }