[2.3] [Form] Support buttons in forms #6528

webmozart · 2012-12-31T17:16:35Z

Bug fix: no
Feature addition: yes
Backwards compatibility break: yes
Symfony2 tests pass: yes
Fixes the following tickets: #5383
Todo: -
License of the code: MIT
Documentation PR: symfony/symfony-docs#2489

The general idea of this PR is to be able to add buttons to forms like so:

$builder->add('clickme', 'submit');

You can then check in the controller whether the button was clicked:

if ($form->get('clickme')->isClicked()) {
   // do stuff
}

Button-specific validation groups are also supported:

$builder->add('clickme', 'submit', array(
    'validation_groups' => 'OnlyClickMe',
));

The validation group will then override the one defined in the form if that button is clicked.

This PR also introduces the disabling of form validation by passing the value false in the option validation_groups:

$builder->add('clickme', 'submit', array(
    'validation_groups' => false,
));

The same can be achieved (already before this PR) by passing an empty array:

$builder->add('clickme', 'submit', array(
    'validation_groups' => array(),
));

See the linked documentation for more information.

stof · 2012-12-31T17:21:06Z

src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig

+    {% if label is empty %}
+        {% set label = name|humanize %}
+    {% endif %}
+    <input type="submit" {{ block('button_attributes') }} value="{{ label }}" />


why not <button type="submit"> to be consistent with other buttons ?

There are problems with button as a submit in old versions of Internet Explorer.

@norzechowicz Problems regarding submit buttons are happening only when you don't specify the type of them. There were browsers using "button" as default type whereas others were using "submit".

I changed it to <button type="submit"> now.

webmozart · 2013-01-02T16:58:22Z

Apart from a few missing tests, this PR is pretty much complete now. Feedback welcome.

stof · 2013-01-02T17:01:16Z

src/Symfony/Component/Form/Extension/Core/Type/BaseType.php

+     */
+    public function buildView(FormView $view, FormInterface $form, array $options)
+    {
+        /* @var \Symfony\Component\Form\ClickableInterface $form */


this is wrong. It is not always a clickable one here

Thanks, fixed.

vicb · 2013-01-02T17:18:36Z

@bschussek could be a good nice to have... after the 100+ form issues are tackled !

webmozart · 2013-01-02T17:55:01Z

Support for validation groups in submit buttons added.

webmozart · 2013-01-02T17:57:03Z

This PR is now complete. I adapted the description above.

stof · 2013-01-02T18:13:11Z

src/Symfony/Component/Form/Extension/Validator/Type/FormTypeValidatorExtension.php

@@ -53,6 +53,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     */
    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
+        parent::setDefaultOptions($resolver);
+


You forgot to remove the validation group normalizer here when moving it to the base class

Thanks, fixed

marijn · 2013-01-02T23:28:15Z

@vicb I understand your frustration but I think your comment about the outstanding issues is uncalled for...

Nice addition @bschussek! I've long wondered why buttons are not a part of the framework 👍

willdurand · 2013-01-03T18:40:48Z

That's nice, really, it's really useful and well-designed, so thanks @bschussek.

But as @vicb there are (a few) issues related to the Form component, and it would be nice to focus on fixing them (IMO).

sstok · 2013-01-05T12:29:47Z

Changing validation_group depending on the button is great, but I wonder if its a good idea to allow a event (onclick) when a button is clicked. I have some forms that have a 'cancel' button and depending which button is clicked 'submit' or cancel the form is either processed or the user is redirected to another page.

But as binding/bounding a complete form to determine if cancel was clicked could a performance hit, I wonder if its better to keep using the 'old' method for that.

And the 's label, its not uncommon to use HTML (Twitter Bootstrap for instance) knowing that Twig automatically escapes the label.

webmozart · 2013-01-05T14:48:14Z

Changing validation_group depending on the button is great, but I wonder if its a good idea to allow a event (onclick) when a button is clicked.

@sstok What do you mean by that? Have you actually looked at the code of this PR?

But as binding/bounding a complete form to determine if cancel was clicked could a performance hit, I wonder if its better to keep using the 'old' method for that.

Performance is not affected (significantly) by this PR.

sstok · 2013-01-05T15:56:06Z

A was talking in general, in JavaScript you can apply an event handler on a button for when its clicked.
I was wondering if something similar would be useful for the Form component, as choosing the validation_group depending on which button was clicked can be seen as an event.

As an example I have form with a normal submit button for saving and a cancel button which when clicked redirects the user back to the viewing page. Currently I'm checking this with.

if ($this->request->request->has('cancel')) {
    $isCancelled = true;

    return $this->onCancel($items) ?: true;
}

$this->form->bind($this->request);
if ($this->form->isValid()) {
    $this->onConfirm($items);

    return true;
}

The form is only binded when its actually gonna be used, but as binding a form even tho I'm only checking if a button was checked could be performance hit (compared to what I'm using now). I was wondering if supporting events when clicked could be useful. It was just a thought.

webmozart · 2013-01-05T15:59:54Z

@sstok I see. You can drop your thoughts in #6576 if you like.

webmozart · 2013-01-08T12:44:50Z

Postponed to 2.3

webmozart · 2013-04-11T15:35:22Z

I rebased this branch on master now, fixed a few issues and wrote the documentation that is linked above. Unless reviews discover problems, this PR is ready for merging.

stof · 2013-04-11T21:45:36Z

src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig

@@ -218,6 +218,36 @@
 {% endspaceless %}
 {% endblock email_widget %}

+{% block button_widget %}
+{% spaceless %}
+    {% if type is not defined or type is empty %}


There is a simpler way: type="{{ type|default('button') }}"

not pushed yet?

webmozart · 2013-04-13T13:36:16Z

The latest build fail seems to be unrelated to the content of this PR. The build succeeded on 5.4.

stof · 2013-04-13T14:12:36Z

@bschussek see #7662

…rameterBag

…ble validation. This is identical to setting it to an empty array.

webmozart · 2013-04-13T14:47:10Z

Rebased again.

raziel057 · 2013-04-14T17:10:26Z

+1 Usefull to ease the creation of multi step forms. It would be interesting to write a simple usage case sample for multipage forms.

GromNaN · 2013-04-14T20:54:06Z

👍 Very useful to detect the clicked button (eg: save / preview).

What is the BC break you mention in the description ?

stof · 2013-04-14T21:58:43Z

@GromNaN copied from the changelog: [BC BREAK] setting the option "validation_groups" tofalsenow disables validation instead of assuming group "Default"
@bschussek it should be mentionned in the UPGRADE file at the root as it is a BC break

… false

webmozart · 2013-04-15T09:10:02Z

@stof Good point, added this.

This PR was merged into the master branch. Discussion ---------- [2.3] [Form] Support buttons in forms Bug fix: no Feature addition: yes Backwards compatibility break: yes Symfony2 tests pass: yes Fixes the following tickets: #5383 Todo: - License of the code: MIT Documentation PR: symfony/symfony-docs#2489 The general idea of this PR is to be able to add buttons to forms like so: ```php $builder->add('clickme', 'submit'); ``` You can then check in the controller whether the button was clicked: ```php if ($form->get('clickme')->isClicked()) { // do stuff } ``` Button-specific validation groups are also supported: ```php $builder->add('clickme', 'submit', array( 'validation_groups' => 'OnlyClickMe', )); ``` The validation group will then override the one defined in the form if that button is clicked. This PR also introduces the disabling of form validation by passing the value `false` in the option `validation_groups`: ```php $builder->add('clickme', 'submit', array( 'validation_groups' => false, )); ``` The same can be achieved (already before this PR) by passing an empty array: ```php $builder->add('clickme', 'submit', array( 'validation_groups' => array(), )); ``` See the linked documentation for more information. Commits ------- faf8d7a [Form] Added upgrade information about setting "validation_groups" => false d504732 [Form] Added leading backslashes to @exceptionMessage doc blocks c8afa88 [Form] Removed deprecated code scheduled for removal in 2.3 36ca056 [Form] Simplified Twig code ce29c70 [Form] Fixed incorrect doc comment 0bc7129 [Form] Fixed invalid use of FormException 600007b [Form] The option "validation_groups" can now be set to false to disable validation. This is identical to setting it to an empty array. 277d6df [Form] Fixed concatenation operator CS (see 7c47e34) 7b07925 [Form] Changed isset() to array_key_exists() to be consistent with ParameterBag 7b438a8 [Form] Made submit buttons able to convey validation groups cc2118d [Form] Implemented support for buttons

… option (xabbuh) This PR was merged into the 2.3 branch. Discussion ---------- [Reference] add description for the `validation_groups` option | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#6528) | Applies to | all | Fixed tickets | #3358 Commits ------- c41b17c add description for the `validation_groups` option

stof reviewed Dec 31, 2012
View reviewed changes

stof reviewed Jan 2, 2013
View reviewed changes

webmozart mentioned this pull request Apr 11, 2013

Added documentation for buttons in forms symfony/symfony-docs#2489

Merged

stof reviewed Apr 11, 2013
View reviewed changes

webmozart added 10 commits April 13, 2013 16:46

[Form] Implemented support for buttons

cc2118d

[Form] Made submit buttons able to convey validation groups

7b438a8

[Form] Changed isset() to array_key_exists() to be consistent with Pa…

7b07925

…rameterBag

[Form] Fixed concatenation operator CS (see 7c47e34)

277d6df

[Form] The option "validation_groups" can now be set to false to disa…

600007b

…ble validation. This is identical to setting it to an empty array.

[Form] Fixed invalid use of FormException

0bc7129

[Form] Fixed incorrect doc comment

ce29c70

[Form] Simplified Twig code

36ca056

[Form] Removed deprecated code scheduled for removal in 2.3

c8afa88

[Form] Added leading backslashes to @exceptionMessage doc blocks

d504732

[Form] Added upgrade information about setting "validation_groups" =>…

faf8d7a

… false

fabpot merged commit faf8d7a into symfony:master Apr 17, 2013

xabbuh mentioned this pull request Sep 17, 2014

[Reference] add description for the validation_groups option symfony/symfony-docs#4246

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.3] [Form] Support buttons in forms #6528

[2.3] [Form] Support buttons in forms #6528

webmozart commented Dec 31, 2012

stof Dec 31, 2012

norberttech Dec 31, 2012

Ninir Dec 31, 2012

webmozart Jan 1, 2013

webmozart commented Jan 2, 2013

stof Jan 2, 2013

webmozart Jan 2, 2013

vicb commented Jan 2, 2013

webmozart commented Jan 2, 2013

webmozart commented Jan 2, 2013

stof Jan 2, 2013

webmozart Jan 2, 2013

marijn commented Jan 2, 2013

willdurand commented Jan 3, 2013

sstok commented Jan 5, 2013

webmozart commented Jan 5, 2013

sstok commented Jan 5, 2013

webmozart commented Jan 5, 2013

webmozart commented Jan 8, 2013

webmozart commented Apr 11, 2013

stof Apr 11, 2013

webmozart Apr 13, 2013

fabpot Apr 13, 2013

webmozart Apr 13, 2013

webmozart commented Apr 13, 2013

stof commented Apr 13, 2013

webmozart commented Apr 13, 2013

raziel057 commented Apr 14, 2013

GromNaN commented Apr 14, 2013

stof commented Apr 14, 2013

webmozart commented Apr 15, 2013

[2.3] [Form] Support buttons in forms #6528

[2.3] [Form] Support buttons in forms #6528

Conversation

webmozart commented Dec 31, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webmozart commented Jan 2, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vicb commented Jan 2, 2013

webmozart commented Jan 2, 2013

webmozart commented Jan 2, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marijn commented Jan 2, 2013

willdurand commented Jan 3, 2013

sstok commented Jan 5, 2013

webmozart commented Jan 5, 2013

sstok commented Jan 5, 2013

webmozart commented Jan 5, 2013

webmozart commented Jan 8, 2013

webmozart commented Apr 11, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webmozart commented Apr 13, 2013

stof commented Apr 13, 2013

webmozart commented Apr 13, 2013

raziel057 commented Apr 14, 2013

GromNaN commented Apr 14, 2013

stof commented Apr 14, 2013

webmozart commented Apr 15, 2013