Merge pull request #19 from svycka/hotfix/does-not-hydrate-empty-collection

Fix collection hydration problem

Author: weierophinney

src/Fieldset.php

@@ -11,6 +11,7 @@
 
 use Traversable;
 use Zend\Code\Reflection\ClassReflection;
+use Zend\Form\Element\Collection;
 use Zend\Hydrator;
 use Zend\Hydrator\HydratorAwareInterface;
 use Zend\Hydrator\HydratorInterface;
@@ -564,12 +565,18 @@ public function bindValues(array $values = [])
         $hydrator = $this->getHydrator();
         $hydratableData = [];
 
-        foreach ($values as $name => $value) {
-            if (!$this->has($name)) {
-                continue;
+        foreach ($this->iterator as $element) {
+            $name = $element->getName();
+
+            if (!array_key_exists($name, $values)) {
+                if (!($element instanceof Collection)) {
+                    continue;
+                }
+
+                $values[$name] = [];
             }
 
-            $element = $this->iterator->get($name);
+            $value = $values[$name];
 
             if ($element instanceof FieldsetInterface && $element->allowValueBinding()) {
                 $value = $element->bindValues($value);

test/Element/CollectionTest.php

@@ -527,17 +527,17 @@ public function testAddingCollectionElementAfterBind()
      */
     public function testDoesNotCreateNewObjectsWhenUsingNestedCollections()
     {
-        $addressesFieldeset = new \ZendTest\Form\TestAsset\AddressFieldset();
-        $addressesFieldeset->setHydrator(new \Zend\Hydrator\ClassMethods());
-        $addressesFieldeset->remove('city');
+        $addressesFieldset = new \ZendTest\Form\TestAsset\AddressFieldset();
+        $addressesFieldset->setHydrator(new \Zend\Hydrator\ClassMethods());
+        $addressesFieldset->remove('city');
 
         $form = new Form();
         $form->setHydrator(new ObjectPropertyHydrator());
         $form->add([
             'name' => 'addresses',
             'type' => 'Collection',
             'options' => [
-                'target_element' => $addressesFieldeset,
+                'target_element' => $addressesFieldset,
                 'count' => 1
             ],
         ]);

test/FormTest.php

@@ -377,10 +377,10 @@ public function testCanAddFileEnctypeFromCollectionAttribute()
 
         $fileCollection = new Element\Collection('collection');
         $fileCollection->setOptions([
-             'count' => 2,
-             'allow_add' => false,
-             'allow_remove' => false,
-             'target_element' => $file,
+            'count' => 2,
+            'allow_add' => false,
+            'allow_remove' => false,
+            'target_element' => $file,
         ]);
         $this->form->add($fileCollection);
 
@@ -2158,4 +2158,39 @@ public function testGetInputFilterInjectsFormInputFilterFactoryInstanceWhenObjec
         $inputFilter = $this->form->getInputFilter();
         $this->assertSame($inputFilterFactory, $inputFilter->getFactory());
     }
+
+    public function testShouldHydrateEmptyCollection()
+    {
+        $fieldset = new Fieldset('example');
+        $fieldset->add([
+            'type' => 'Zend\Form\Element\Collection',
+            'name' => 'foo',
+            'options' => [
+                'label' => 'InputFilterProviderFieldset',
+                'count' => 1,
+                'target_element' => [
+                    'type' => 'text'
+                ]
+            ],
+        ]);
+
+        $this->form->add($fieldset);
+        $this->form->setBaseFieldset($fieldset);
+        $this->form->setHydrator(new \Zend\Hydrator\ObjectProperty());
+
+        $object = new Entity\SimplePublicProperty();
+        $object->foo = ['item 1', 'item 2'];
+
+        $this->form->bind($object);
+
+        $this->form->setData([
+            'submit' => 'Confirm',
+            'example' => [
+                //'foo' => [] // $_POST does't have this if collection is empty
+            ]
+        ]);
+
+        $this->assertTrue($this->form->isValid());
+        $this->assertEquals([], $this->form->getObject()->foo);
+    }
 }

test/TestAsset/PhoneFieldset.php

@@ -12,9 +12,10 @@
 use Zend\Form\Fieldset;
 use Zend\Form\Element;
 use Zend\Hydrator\ClassMethods as ClassMethodsHydrator;
+use Zend\InputFilter\InputFilterProviderInterface;
 use ZendTest\Form\TestAsset\Entity\Phone;
 
-class PhoneFieldset extends Fieldset
+class PhoneFieldset extends Fieldset implements InputFilterProviderInterface
 {
     public function __construct()
     {
@@ -31,4 +32,13 @@ public function __construct()
                ->setAttribute('class', 'form-control');
         $this->add($number);
     }
+
+    public function getInputFilterSpecification()
+    {
+        return [
+            'number' => [
+                'required' => true,
+            ]
+        ];
+    }
 }