feature #20887 [Form] DateIntervalType: Allow to configure labels & enhance form theme (ogizanagi)

This PR was merged into the 3.3-dev branch.

Discussion
----------

[Form] DateIntervalType: Allow to configure labels & enhance form theme

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no (unless someone relies on this non themed type)
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | Should document the new `labels` option

I just realized by using it for last fixes in #20886 and #20877 that this type was not really themed:

### before

<img width="861" alt="screenshot 2016-12-13 a 00 54 35" src="https://cloud.githubusercontent.com/assets/2211145/21121792/c589d27a-c0ce-11e6-8368-a396fda3bc7a.PNG">

At least labels should appear, but this also means being able to change them (thus the new `labels` option).

I think the form themes should provide a functional & minimalistic integration like this:

### after

<img width="862" alt="screenshot 2016-12-13 a 00 54 17" src="https://cloud.githubusercontent.com/assets/2211145/21121814/d9c4ead6-c0ce-11e6-94e1-41e6c14884a7.PNG">

---
(On screenshots above, I've only added a css rule to remove the 100% width of the `.table` class. See symfony/symfony#20887 (comment))

Commits
-------

bfd9e50bbb [Form] DateIntervalType: Allow to configure labels & enhance form theme

Author: fabpot

Extension/Core/Type/DateIntervalType.php

@@ -99,8 +99,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             $childOptions = array();
             foreach ($this->timeParts as $part) {
                 if ($options['with_'.$part]) {
-                    $childOptions[$part] = array();
-                    $childOptions[$part]['error_bubbling'] = true;
+                    $childOptions[$part] = array(
+                        'error_bubbling' => true,
+                        'label' => $options['labels'][$part],
+                    );
                     if ('choice' === $options['widget']) {
                         $childOptions[$part]['choice_translation_domain'] = false;
                         $childOptions[$part]['choices'] = $options[$part];
@@ -131,6 +133,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             }
             if ($options['with_invert']) {
                 $builder->add('invert', 'Symfony\Component\Form\Extension\Core\Type\CheckboxType', array(
+                    'label' => $options['labels']['invert'],
                     'error_bubbling' => true,
                     'required' => false,
                     'translation_domain' => $options['translation_domain'],
@@ -192,6 +195,21 @@ public function configureOptions(OptionsResolver $resolver)
             return array_fill_keys($timeParts, $placeholder);
         };
 
+        $labelsNormalizer = function (Options $options, array $labels) {
+            return array_replace(array(
+                'years' => null,
+                'months' => null,
+                'days' => null,
+                'weeks' => null,
+                'hours' => null,
+                'minutes' => null,
+                'seconds' => null,
+                'invert' => 'Negative interval',
+            ), array_filter($labels, function ($label) {
+                return null !== $label;
+            }));
+        };
+
         $resolver->setDefaults(
             array(
                 'with_years' => true,
@@ -220,9 +238,11 @@ public function configureOptions(OptionsResolver $resolver)
                 // this option.
                 'data_class' => null,
                 'compound' => $compound,
+                'labels' => array(),
             )
         );
         $resolver->setNormalizer('placeholder', $placeholderNormalizer);
+        $resolver->setNormalizer('labels', $labelsNormalizer);
 
         $resolver->setAllowedValues(
             'input',
@@ -260,6 +280,7 @@ public function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedTypes('with_minutes', 'bool');
         $resolver->setAllowedTypes('with_seconds', 'bool');
         $resolver->setAllowedTypes('with_invert', 'bool');
+        $resolver->setAllowedTypes('labels', 'array');
     }
 
     /**

Tests/Extension/Core/Type/DateIntervalTypeTest.php

@@ -399,4 +399,53 @@ public function testInvertDoesNotInheritRequiredOption()
         );
         $this->assertFalse($form->get('invert')->getConfig()->getOption('required'));
     }
+
+    public function testCanChangeTimeFieldsLabels()
+    {
+        $form = $this->factory->create(
+            DateIntervalType::class,
+            null,
+            array(
+                'required' => true,
+                'with_invert' => true,
+                'with_hours' => true,
+                'with_minutes' => true,
+                'with_seconds' => true,
+                'labels' => array(
+                    'invert' => 'form.trans.invert',
+                    'years' => 'form.trans.years',
+                    'months' => 'form.trans.months',
+                    'days' => 'form.trans.days',
+                    'hours' => 'form.trans.hours',
+                    'minutes' => 'form.trans.minutes',
+                    'seconds' => 'form.trans.seconds',
+                ),
+            )
+        );
+
+        $view = $form->createView();
+        $this->assertSame('form.trans.invert', $view['invert']->vars['label']);
+        $this->assertSame('form.trans.years', $view['years']->vars['label']);
+        $this->assertSame('form.trans.months', $view['months']->vars['label']);
+        $this->assertSame('form.trans.days', $view['days']->vars['label']);
+        $this->assertSame('form.trans.hours', $view['hours']->vars['label']);
+        $this->assertSame('form.trans.minutes', $view['minutes']->vars['label']);
+        $this->assertSame('form.trans.seconds', $view['seconds']->vars['label']);
+    }
+
+    public function testInvertDefaultLabel()
+    {
+        $form = $this->factory->create(DateIntervalType::class, null, array('with_invert' => true));
+
+        $view = $form->createView();
+        $this->assertSame('Negative interval', $view['invert']->vars['label']);
+
+        $form = $this->factory->create(DateIntervalType::class, null, array(
+            'with_invert' => true,
+            'labels' => array('invert' => null),
+        ));
+
+        $view = $form->createView();
+        $this->assertSame('Negative interval', $view['invert']->vars['label']);
+    }
 }