feature #45605 [Form] Add prototype_options to CollectionType (michaelKaefer)

This PR was merged into the 6.1 branch.

Discussion
----------

[Form] Add prototype_options to CollectionType

| Q             | A
| ------------- | ---
| Branch?       | 6.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | symfony/symfony-docs#16664

Allows defining options for the form for new entries (the prototype form) which differ from the options for the form for existing entries.

My use case: I need this when using EasyAdminBundle. In the form for an entity `Person` I have a `CollectionType` for a related entity `Books`. There I can edit the `Books` that a `Person` already has and add new `Books`. The change would allow me to show (or disable, etc.) a form field in the `Book` form only when an existing `Book` is edited (and not show it when a new `Book` is added).

As far as I can tell it is not a BC break to add this new option. I can provide another PR for the docs if this should get merged.

Commits
-------

b1d40c16be [Form] Add prototype_options to CollectionType

Author: nicolas-grekas

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * Add a `prototype_options` option to `CollectionType`
+
 6.0
 ---
 

Extension/Core/Type/CollectionType.php

@@ -30,7 +30,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             $prototypeOptions = array_replace([
                 'required' => $options['required'],
                 'label' => $options['prototype_name'].'label__',
-            ], $options['entry_options']);
+            ], array_replace($options['entry_options'], $options['prototype_options']));
 
             if (null !== $options['prototype_data']) {
                 $prototypeOptions['data'] = $options['prototype_data'];
@@ -120,12 +120,15 @@ public function configureOptions(OptionsResolver $resolver)
             'prototype_name' => '__name__',
             'entry_type' => TextType::class,
             'entry_options' => [],
+            'prototype_options' => [],
             'delete_empty' => false,
             'invalid_message' => 'The collection is invalid.',
         ]);
 
         $resolver->setNormalizer('entry_options', $entryOptionsNormalizer);
+
         $resolver->setAllowedTypes('delete_empty', ['bool', 'callable']);
+        $resolver->setAllowedTypes('prototype_options', 'array');
     }
 
     /**

Tests/Extension/Core/Type/CollectionTypeTest.php

@@ -430,6 +430,23 @@ public function testPrototypeNotOverrideRequiredByEntryOptionsInFavorOfParent()
         $this->assertFalse($child->createView()->vars['prototype']->vars['required'], '"Prototype" should not be required');
     }
 
+    public function testPrototypeOptionsOverrideEntryOptions()
+    {
+        $form = $this->factory->create(static::TESTED_TYPE, [], [
+            'allow_add' => true,
+            'prototype' => true,
+            'entry_type' => TextTypeTest::TESTED_TYPE,
+            'entry_options' => [
+                'help' => null,
+            ],
+            'prototype_options' => [
+                'help' => 'foo',
+            ],
+        ]);
+
+        $this->assertSame('foo', $form->createView()->vars['prototype']->vars['help']);
+    }
+
     public function testEntriesBlockPrefixes()
     {
         $collectionView = $this->factory->createNamed('fields', static::TESTED_TYPE, [''], [