[Form] Added entry_filter option to collection type.

Koc · Koc · commit d9703d6bf6ac · 2017-03-23T13:00:13.000+02:00
diff --git a/src/Symfony/Component/Form/Extension/Core/EventListener/ResizeFormListener.php b/src/Symfony/Component/Form/Extension/Core/EventListener/ResizeFormListener.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\FormInterface;
 
 /**
  * Resize a collection form element based on the data sent from the client.
@@ -52,13 +53,19 @@ class ResizeFormListener implements EventSubscriberInterface
      */
     private $deleteEmpty;
 
-    public function __construct($type, array $options = array(), $allowAdd = false, $allowDelete = false, $deleteEmpty = false)
+    /**
+     * @var callable|null
+     */
+    private $entryFilter;
+
+    public function __construct($type, array $options = array(), $allowAdd = false, $allowDelete = false, $deleteEmpty = false, callable $entryFilter = null)
     {
         $this->type = $type;
         $this->allowAdd = $allowAdd;
         $this->allowDelete = $allowDelete;
         $this->options = $options;
         $this->deleteEmpty = $deleteEmpty;
+        $this->entryFilter = $entryFilter;
     }
 
     public static function getSubscribedEvents()
@@ -149,13 +156,16 @@ public function onSubmit(FormEvent $event)
         }
 
         if ($this->deleteEmpty) {
-            $previousData = $event->getForm()->getData();
+            $previousData = $form->getData();
+            $entryFilter = $this->entryFilter;
             foreach ($form as $name => $child) {
+                /* @var $child FormInterface */
                 $isNew = !isset($previousData[$name]);
+                $needRemove = $child->isEmpty() || (null !== $entryFilter && !$entryFilter($child->getData()));
 
                 // $isNew can only be true if allowAdd is true, so we don't
                 // need to check allowAdd again
-                if ($child->isEmpty() && ($isNew || $this->allowDelete)) {
+                if ($needRemove && ($isNew || $this->allowDelete)) {
                     unset($data[$name]);
                     $form->remove($name);
                 }
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/CollectionType.php b/src/Symfony/Component/Form/Extension/Core/Type/CollectionType.php
@@ -45,7 +45,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             $options['entry_options'],
             $options['allow_add'],
             $options['allow_delete'],
-            $options['delete_empty']
+            $options['delete_empty'],
+            $options['entry_filter']
         );
 
         $builder->addEventSubscriber($resizeListener);
@@ -96,10 +97,12 @@ public function configureOptions(OptionsResolver $resolver)
             'prototype_name' => '__name__',
             'entry_type' => __NAMESPACE__.'\TextType',
             'entry_options' => array(),
+            'entry_filter' => null,
             'delete_empty' => false,
         ));
 
         $resolver->setNormalizer('entry_options', $entryOptionsNormalizer);
+        $resolver->setAllowedTypes('entry_filter', array('null', 'callable'));
     }
 
     /**
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/Type/CollectionTypeTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/Type/CollectionTypeTest.php
@@ -110,6 +110,26 @@ public function testResizedDownIfSubmittedWithEmptyDataAndDeleteEmpty()
         $this->assertEquals(array('foo@foo.com'), $form->getData());
     }
 
+    public function testResizedDownWithEntryFilter()
+    {
+        $form = $this->factory->create('Symfony\Component\Form\Extension\Core\Type\CollectionType', null, array(
+            'entry_type' => 'Symfony\Component\Form\Tests\Fixtures\AuthorType',
+            'allow_delete' => true,
+            'delete_empty' => true,
+            'entry_filter' => function ($obj) {
+                return $obj instanceof Author && !empty($obj->firstName);
+            },
+        ));
+
+        $form->setData(array(new Author('Bob'), new Author('Alice')));
+        $form->submit(array(array('firstName' => 'Bob'), array('firstName' => '')));
+
+        $this->assertTrue($form->has('0'));
+        $this->assertFalse($form->has('1'));
+        $this->assertEquals(new Author('Bob'), $form[0]->getData());
+        $this->assertEquals(array(new Author('Bob')), $form->getData());
+    }
+
     public function testDontAddEmptyDataIfDeleteEmpty()
     {
         $form = $this->factory->create(static::TESTED_TYPE, null, array(
diff --git a/src/Symfony/Component/Form/Tests/FormErrorIteratorTest.php b/src/Symfony/Component/Form/Tests/FormErrorIteratorTest.php
@@ -11,13 +11,14 @@
 
 namespace Symfony\Component\Form\Tests;
 
+use PHPUnit\Framework\TestCase;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Form\FormBuilder;
 use Symfony\Component\Form\FormError;
 use Symfony\Component\Form\FormErrorIterator;
 use Symfony\Component\Validator\ConstraintViolation;
 
-class FormErrorIteratorTest extends \PHPUnit_Framework_TestCase
+class FormErrorIteratorTest extends TestCase
 {
     /**
      * @dataProvider findByCodesProvider
@@ -32,7 +33,7 @@ public function testFindByCodes($code, $violationsCount)
             'form',
             null,
             new EventDispatcher(),
-            $this->getMock('Symfony\Component\Form\FormFactoryInterface'),
+            $this->getMockBuilder('Symfony\Component\Form\FormFactoryInterface')->getMock(),
             array()
         );
 
