feature #29680 [Form] Add new block_prefix option for an easy form theming (yceruto)

fabpot · fabpot · commit b841ea8f05e5 · 2019-01-03T16:01:11.000+01:00
This PR was merged into the 4.3-dev branch. Discussion ---------- [Form] Add new block_prefix option for an easy form theming | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #29651 | License | MIT | Doc PR | symfony/symfony-docs#10835 Commits ------- bd50ac44fc Add block_prefix option for an easy form theming
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * added `block_prefix` option to `BaseType`.
+
 4.2.0
 -----
 
diff --git a/Extension/Core/Type/BaseType.php b/Extension/Core/Type/BaseType.php
@@ -79,6 +79,9 @@ public function buildView(FormView $view, FormInterface $form, array $options)
         for ($type = $form->getConfig()->getType(); null !== $type; $type = $type->getParent()) {
             array_unshift($blockPrefixes, $type->getBlockPrefix());
         }
+        if (null !== $options['block_prefix']) {
+            $blockPrefixes[] = $options['block_prefix'];
+        }
         $blockPrefixes[] = $uniqueBlockPrefix;
 
         $view->vars = array_replace($view->vars, array(
@@ -111,6 +114,7 @@ public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults(array(
             'block_name' => null,
+            'block_prefix' => null,
             'disabled' => false,
             'label' => null,
             'label_format' => null,
@@ -119,6 +123,7 @@ public function configureOptions(OptionsResolver $resolver)
             'auto_initialize' => true,
         ));
 
+        $resolver->setAllowedTypes('block_prefix', array('null', 'string'));
         $resolver->setAllowedTypes('attr', 'array');
     }
 }
diff --git a/Tests/Extension/Core/Type/FormTypeTest.php b/Tests/Extension/Core/Type/FormTypeTest.php
@@ -639,4 +639,16 @@ public function testSubmitNull($expected = null, $norm = null, $view = null)
     {
         parent::testSubmitNull(array(), array(), array());
     }
+
+    public function testPassBlockPrefixToViewWithParent()
+    {
+        $view = $this->factory->createNamedBuilder('parent', static::TESTED_TYPE)
+            ->add('child', $this->getTestedType(), array(
+                'block_prefix' => 'child',
+            ))
+            ->getForm()
+            ->createView();
+
+        $this->assertSame(array('form', 'child', '_parent_child'), $view['child']->vars['block_prefixes']);
+    }
 }
diff --git a/Tests/Fixtures/Descriptor/resolved_form_type_1.json b/Tests/Fixtures/Descriptor/resolved_form_type_1.json
@@ -32,6 +32,7 @@
                 "attr",
                 "auto_initialize",
                 "block_name",
+                "block_prefix",
                 "by_reference",
                 "data",
                 "disabled",
diff --git a/Tests/Fixtures/Descriptor/resolved_form_type_1.txt b/Tests/Fixtures/Descriptor/resolved_form_type_1.txt
@@ -12,11 +12,12 @@ Symfony\Component\Form\Extension\Core\Type\ChoiceType (Block prefix: "choice")
   choice_translation_domain   empty_data           attr                      csrf_protection        
   choice_value                error_bubbling       auto_initialize           csrf_token_id          
   choices                     trim                 block_name                csrf_token_manager     
-  expanded                                         by_reference                                     
-  group_by                                         data                                             
-  multiple                                         disabled                                         
-  placeholder                                      help                                             
-  preferred_choices                                help_attr                                        
+  expanded                                         block_prefix                                     
+  group_by                                         by_reference                                     
+  multiple                                         data                                             
+  placeholder                                      disabled                                         
+  preferred_choices                                help                                             
+                                                   help_attr                                        
                                                    inherit_data                                     
                                                    label                                            
                                                    label_attr                                       
diff --git a/Tests/Fixtures/Descriptor/resolved_form_type_2.json b/Tests/Fixtures/Descriptor/resolved_form_type_2.json
@@ -8,6 +8,7 @@
             "attr",
             "auto_initialize",
             "block_name",
+            "block_prefix",
             "by_reference",
             "compound",
             "data",
diff --git a/Tests/Fixtures/Descriptor/resolved_form_type_2.txt b/Tests/Fixtures/Descriptor/resolved_form_type_2.txt
@@ -10,6 +10,7 @@ Symfony\Component\Form\Extension\Core\Type\FormType (Block prefix: "form")
   attr                     
   auto_initialize          
   block_name               
+  block_prefix             
   by_reference             
   compound                 
   data                     

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,9 @@ public function buildView(FormView $view, FormInterface $form, array $options)`
`79`	`79`	`for ($type = $form->getConfig()->getType(); null !== $type; $type = $type->getParent()) {`
`80`	`80`	`array_unshift($blockPrefixes, $type->getBlockPrefix());`
`81`	`81`	`}`
	`82`	`+ if (null !== $options['block_prefix']) {`
	`83`	`+ $blockPrefixes[] = $options['block_prefix'];`
	`84`	`+ }`
`82`	`85`	`$blockPrefixes[] = $uniqueBlockPrefix;`
`83`	`86`
`84`	`87`	`$view->vars = array_replace($view->vars, array(`
`@@ -111,6 +114,7 @@ public function configureOptions(OptionsResolver $resolver)`
`111`	`114`	`{`
`112`	`115`	`$resolver->setDefaults(array(`
`113`	`116`	`'block_name' => null,`
	`117`	`+ 'block_prefix' => null,`
`114`	`118`	`'disabled' => false,`
`115`	`119`	`'label' => null,`
`116`	`120`	`'label_format' => null,`
`@@ -119,6 +123,7 @@ public function configureOptions(OptionsResolver $resolver)`
`119`	`123`	`'auto_initialize' => true,`
`120`	`124`	`));`
`121`	`125`
	`126`	`+ $resolver->setAllowedTypes('block_prefix', array('null', 'string'));`
`122`	`127`	`$resolver->setAllowedTypes('attr', 'array');`
`123`	`128`	`}`
`124`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -639,4 +639,16 @@ public function testSubmitNull($expected = null, $norm = null, $view = null)`
`639`	`639`	`{`
`640`	`640`	`parent::testSubmitNull(array(), array(), array());`
`641`	`641`	`}`
	`642`	`+`
	`643`	`+ public function testPassBlockPrefixToViewWithParent()`
	`644`	`+ {`
	`645`	`+ $view = $this->factory->createNamedBuilder('parent', static::TESTED_TYPE)`
	`646`	`+ ->add('child', $this->getTestedType(), array(`
	`647`	`+ 'block_prefix' => 'child',`
	`648`	`+ ))`
	`649`	`+ ->getForm()`
	`650`	`+ ->createView();`
	`651`	`+`
	`652`	`+ $this->assertSame(array('form', 'child', '_parent_child'), $view['child']->vars['block_prefixes']);`
	`653`	`+ }`
`642`	`654`	`}`