bug #10777 [Form] Automatically add step attribute to HTML5 time widgets to display seconds if needed (tucksaun)

fabpot · fabpot · commit 0762bae05902 · 2014-05-16T13:54:17.000+02:00
This PR was squashed before being merged into the 2.3 branch (closes #10777). Discussion ---------- [Form] Automatically add step attribute to HTML5 time widgets to display seconds if needed | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #9976, #10203 | License | MIT | Doc PR | none Same issue as #9976 and #10203: when you add a `time` field to a form with options `single_text` (so HTML5) and `with_seconds`, the generated input does not contain the `step` attribute, therefore the browser does not show them, leading to an error at the submit because of an invalid format. Compared to #9976/#10203: * Unit testable * Available directly in the component * Available in other templating format than twig * Still able to customise the step attribute by hand Commits ------- a379298 [Form] Automatically add step attribute to HTML5 time widgets to display seconds if needed
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/TimeType.php b/src/Symfony/Component/Form/Extension/Core/Type/TimeType.php
@@ -140,6 +140,14 @@ public function buildView(FormView $view, FormInterface $form, array $options)
 
         if ('single_text' === $options['widget']) {
             $view->vars['type'] = 'time';
+
+            // we need to force the browser to display the seconds by
+            // adding the HTML attribute step if not already defined.
+            // Otherwise the browser will not display and so not send the seconds
+            // therefore the value will always be considered as invalid.
+            if ($options['with_seconds'] && !isset($view->vars['attr']['step'])) {
+                $view->vars['attr']['step'] = 1;
+            }
         }
     }
 
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/Type/TimeTypeTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/Type/TimeTypeTest.php
@@ -492,6 +492,33 @@ public function testSingleTextWidgetShouldUseTheRightInputType()
         $this->assertEquals('time', $view->vars['type']);
     }
 
+    public function testSingleTextWidgetWithSecondsShouldHaveRightStepAttribute()
+    {
+        $form = $this->factory->create('time', null, array(
+            'widget' => 'single_text',
+            'with_seconds' => true,
+        ));
+
+        $view = $form->createView();
+        $this->assertArrayHasKey('step', $view->vars['attr']);
+        $this->assertEquals(1, $view->vars['attr']['step']);
+    }
+
+    public function testSingleTextWidgetWithSecondsShouldNotOverrideStepAttribute()
+    {
+        $form = $this->factory->create('time', null, array(
+            'widget' => 'single_text',
+            'with_seconds' => true,
+            'attr' => array(
+                'step' => 30
+            )
+        ));
+
+        $view = $form->createView();
+        $this->assertArrayHasKey('step', $view->vars['attr']);
+        $this->assertEquals(30, $view->vars['attr']['step']);
+    }
+
     public function testPassDefaultEmptyValueToViewIfNotRequired()
     {
         $form = $this->factory->create('time', null, array(

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,14 @@ public function buildView(FormView $view, FormInterface $form, array $options)`
`140`	`140`
`141`	`141`	`if ('single_text' === $options['widget']) {`
`142`	`142`	`$view->vars['type'] = 'time';`
	`143`	`+`
	`144`	`+ // we need to force the browser to display the seconds by`
	`145`	`+ // adding the HTML attribute step if not already defined.`
	`146`	`+ // Otherwise the browser will not display and so not send the seconds`
	`147`	`+ // therefore the value will always be considered as invalid.`
	`148`	`+ if ($options['with_seconds'] && !isset($view->vars['attr']['step'])) {`
	`149`	`+ $view->vars['attr']['step'] = 1;`
	`150`	`+ }`
`143`	`151`	`}`
`144`	`152`	`}`
`145`	`153`