feature #29862 Add block prefix to csrf token field (alexander-schranz)

fabpot · fabpot · commit 38247ddf7842 · 2019-01-16T10:22:19.000+01:00
This PR was squashed before being merged into the 4.3-dev branch (closes #29862). Discussion ---------- Add block prefix to csrf token field | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #... | License | MIT | Doc PR | symfony/symfony-docs#10867 Currently I use the following code snippet to overwrite the token rendering: ```twig {%- block hidden_widget -%} {%- if form.vars.name == '_token' -%} {{ block('app__token_widget') }} {%- else -%} {{ block('hidden_widget', 'form_div_layout.html.twig') }} {%- endif -%} {%- endblock hidden_widget -%} {%- block app__token_widget %} {{ render_esi(controller('SuluFormBundle:FormWebsite:token', { 'form': form.parent.vars.name })) }} {%- endblock app__token_widget -%} ``` With the change of https://symfony.com/blog/new-in-symfony-4-3-simpler-form-theming this workaround can now be removed and the following can be used: ```twig {%- block token_widget %} {{ render_esi(controller('SuluFormBundle:FormWebsite:token', { 'form': form.parent.vars.name })) }} {%- endblock token_widget -%} ``` Commits ------- 02bd689 Add block prefix to csrf token field
diff --git a/src/Symfony/Component/Form/Extension/Csrf/Type/FormTypeCsrfExtension.php b/src/Symfony/Component/Form/Extension/Csrf/Type/FormTypeCsrfExtension.php
@@ -90,9 +90,10 @@ public function finishView(FormView $view, FormInterface $form, array $options)
             $tokenId = $options['csrf_token_id'] ?: ($form->getName() ?: \get_class($form->getConfig()->getType()->getInnerType()));
             $data = (string) $options['csrf_token_manager']->getToken($tokenId);
 
-            $csrfForm = $factory->createNamed($options['csrf_field_name'], 'Symfony\Component\Form\Extension\Core\Type\HiddenType', $data, array(
+            $csrfForm = $factory->createNamed($options['csrf_field_name'], 'Symfony\Component\Form\Extension\Core\Type\HiddenType', $data, [
+                'block_prefix' => 'csrf_token',
                 'mapped' => false,
-            ));
+            ]);
 
             $view->children[$options['csrf_field_name']] = $csrfForm->createView($view);
         }
@@ -103,20 +104,20 @@ public function finishView(FormView $view, FormInterface $form, array $options)
      */
     public function configureOptions(OptionsResolver $resolver)
     {
-        $resolver->setDefaults(array(
+        $resolver->setDefaults([
             'csrf_protection' => $this->defaultEnabled,
             'csrf_field_name' => $this->defaultFieldName,
             'csrf_message' => 'The CSRF token is invalid. Please try to resubmit the form.',
             'csrf_token_manager' => $this->defaultTokenManager,
             'csrf_token_id' => null,
-        ));
+        ]);
     }
 
     /**
      * {@inheritdoc}
      */
     public static function getExtendedTypes(): iterable
     {
-        return array(FormType::class);
+        return [FormType::class];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -90,9 +90,10 @@ public function finishView(FormView $view, FormInterface $form, array $options)`
`90`	`90`	`$tokenId = $options['csrf_token_id'] ?: ($form->getName() ?: \get_class($form->getConfig()->getType()->getInnerType()));`
`91`	`91`	`$data = (string) $options['csrf_token_manager']->getToken($tokenId);`
`92`	`92`
`93`		`- $csrfForm = $factory->createNamed($options['csrf_field_name'], 'Symfony\Component\Form\Extension\Core\Type\HiddenType', $data, array(`
	`93`	`+ $csrfForm = $factory->createNamed($options['csrf_field_name'], 'Symfony\Component\Form\Extension\Core\Type\HiddenType', $data, [`
	`94`	`+ 'block_prefix' => 'csrf_token',`
`94`	`95`	`'mapped' => false,`
`95`		`- ));`
	`96`	`+ ]);`
`96`	`97`
`97`	`98`	`$view->children[$options['csrf_field_name']] = $csrfForm->createView($view);`
`98`	`99`	`}`
`@@ -103,20 +104,20 @@ public function finishView(FormView $view, FormInterface $form, array $options)`
`103`	`104`	`*/`
`104`	`105`	`public function configureOptions(OptionsResolver $resolver)`
`105`	`106`	`{`
`106`		`- $resolver->setDefaults(array(`
	`107`	`+ $resolver->setDefaults([`
`107`	`108`	`'csrf_protection' => $this->defaultEnabled,`
`108`	`109`	`'csrf_field_name' => $this->defaultFieldName,`
`109`	`110`	`'csrf_message' => 'The CSRF token is invalid. Please try to resubmit the form.',`
`110`	`111`	`'csrf_token_manager' => $this->defaultTokenManager,`
`111`	`112`	`'csrf_token_id' => null,`
`112`		`- ));`
	`113`	`+ ]);`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`/**`
`116`	`117`	`* {@inheritdoc}`
`117`	`118`	`*/`
`118`	`119`	`public static function getExtendedTypes(): iterable`
`119`	`120`	`{`
`120`		`- return array(FormType::class);`
	`121`	`+ return [FormType::class];`
`121`	`122`	`}`
`122`	`123`	`}`