bug #40018 [TwigBridge] take into account all label related options (xabbuh)

nicolas-grekas · nicolas-grekas · commit 37166f79e271 · 2021-01-28T18:00:39.000+01:00
This PR was merged into the 5.2 branch. Discussion ---------- [TwigBridge] take into account all label related options | Q | A | ------------- | --- | Branch? | 5.2 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #40007 | License | MIT | Doc PR | Commits ------- adb0fd1 take into account all label related options
diff --git a/src/Symfony/Bridge/Twig/Extension/FormExtension.php b/src/Symfony/Bridge/Twig/Extension/FormExtension.php
@@ -113,8 +113,18 @@ public function getFieldValue(FormView $view)
 
     public function getFieldLabel(FormView $view): ?string
     {
+        if (false === $label = $view->vars['label']) {
+            return null;
+        }
+
+        if (!$label && $labelFormat = $view->vars['label_format']) {
+            $label = str_replace(['%id%', '%name%'], [$view->vars['id'], $view->vars['name']], $labelFormat);
+        } elseif (!$label) {
+            $label = ucfirst(strtolower(trim(preg_replace(['/([A-Z])/', '/[_\s]+/'], ['_$1', ' '], $view->vars['name']))));
+        }
+
         return $this->createFieldTranslation(
-            $view->vars['label'],
+            $label,
             $view->vars['label_translation_parameters'] ?: [],
             $view->vars['translation_domain']
         );
diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/FormExtensionFieldHelpersTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/FormExtensionFieldHelpersTest.php
@@ -81,6 +81,7 @@ protected function setUp(): void
                     ],
                 ],
                 'choice_translation_domain' => 'forms',
+                'label_format' => 'label format for field "%name%" with id "%id%"',
             ])
             ->add('choice_multiple', ChoiceType::class, [
                 'choices' => [
@@ -89,6 +90,7 @@ protected function setUp(): void
                 ],
                 'multiple' => true,
                 'expanded' => true,
+                'label' => false,
             ])
             ->getForm()
         ;
@@ -121,6 +123,21 @@ public function testFieldTranslatedLabel()
         $this->assertSame('[trans]base.username[/trans]', $this->translatorExtension->getFieldLabel($this->view->children['username']));
     }
 
+    public function testFieldLabelFromFormat()
+    {
+        $this->assertSame('label format for field "choice_grouped" with id "register_choice_grouped"', $this->rawExtension->getFieldLabel($this->view->children['choice_grouped']));
+    }
+
+    public function testFieldLabelFallsBackToName()
+    {
+        $this->assertSame('Choice flat', $this->rawExtension->getFieldLabel($this->view->children['choice_flat']));
+    }
+
+    public function testFieldLabelReturnsNullWhenLabelIsDisabled()
+    {
+        $this->assertNull($this->rawExtension->getFieldLabel($this->view->children['choice_multiple']));
+    }
+
     public function testFieldHelp()
     {
         $this->assertSame('base.username_help', $this->rawExtension->getFieldHelp($this->view->children['username']));
