[DX][Form] Defining validation groups on form field level should throw an error #12342

umpirsky · 2014-10-28T17:18:25Z

Talk is cheap, show me the code:

class MyFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('foo', 'text', [
            'constraints'       => new Constraints\Length(['min' => 6]),
            'validation_groups' => 'Bar',
        ]);
    }
 }

I expected this code to be equivalent to:

class MyFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('foo', 'text', [
            'constraints'  => new Constraints\Length(['min' => 6, 'groups' => 'Bar']),
        ]);
    }
 }

But it is not, validation groups are not respected in the first case.

If it cannot be fixed before 3.0, then it can at least throw an error like:

You cannot define validation groups to a form field, consider passing it as an option to your constraints.

The text was updated successfully, but these errors were encountered:

docteurklein · 2014-10-28T20:03:28Z

you meant

'constraints'  => new Constraints\Length(['min' => 6, 'groups' => 'Bar']),

umpirsky · 2014-10-28T20:09:17Z

@docteurklein Yes, typo, fixed. Thanks Flo!

webmozart · 2014-10-31T11:12:00Z

@umpirski Apparently you misunderstood how this option works. The "validation_groups" option is only supported on the root form where the validation is triggered. On fields and nested forms, this option is ignored.

The value of the option controls which validation group the form's data is validated in, i.e. (figuratively):

// $form is the root form
$data = $form->getData();
$groups = $form->getOption('validation_groups');

$violations = $validator->validate($data, null, $groups);

Does this answer your question?

umpirsky · 2014-10-31T13:14:33Z

@webmozart I know. This have sense when you know that every field is a form as well, and that it is respected only when validation is triggered on that very form.

But DX I was talking about is that form field behaves same with or without 'validation_groups' => 'Bar' option. I want to say, if I can set validation_groups option on form field, then it is logical to expect it to be respected, and not ignored.

Implementation should be simple, if it is not a root form, and have validation_groups option set, throw error.

webmozart · 2014-11-03T09:22:02Z

8000

Implementation should be simple, if it is not a root form, and have validation_groups option set, throw error.

To do that, we'd need to break BC. For example, if you hardcode the "validation_groups" option in a Type class and then embed that type in another form, you'll get an exception, where previously the option was simply ignored.

Do you think that's worth it?

In the long term, I think that the "validation_groups" option could be replaced by a new @DefaultGroup annotation for the Validator: #11880

umpirsky · 2014-11-03T09:51:52Z

@webmozart Well, I am not sure if it is worth it, I just felt it does not feel natural and decided to open new issue.

What is important is that we agree with this and that we are aware that problem exists. For me it is enough to fix it in 3.0.

flip111 · 2014-11-05T14:55:18Z

I'm not really in favor of any code that checks this on runtime during normal application operation. Possible there can be a seperate version of the Form class that has additional checks while debugging. Or a check can be performed during "compile time" (when generating cache takes place as well), or manually invoke some (static?) checker.

hanneskaeufler · 2014-11-20T17:47:45Z

@umpirski Apparently you misunderstood how this option works. The "validation_groups" option is only supported on the root form where the validation is triggered. On fields and nested forms, this option is ignored.

@webmozart Uh, this should be noted in the documentation maybe? I think this has cost me a few times.

Say you have a FormType with a collection field, whose entities you want to validate depending on their type? If you cannot set the validation_group in the child type, do you reach deep down into the collection from the root form to set the validation_groups?

See this example, validate based on submitted data with a closure.
http://symfony.com/doc/current/book/forms.html#groups-based-on-the-submitted-data

Or with tags

class Category {
    public $tags;
}

class Tag {
    const FOO_TYPE  = 1;
    const BAR_TYPE = 2;

    public $type;
    public $name;
}

class CategoryType extends AbstractFormType {
    ....
    $builder->add('tags', 'collection')
    ....

    function setDefaultOptions() {
         // set validation groups here???
    }
}

# tag.yml
name:
    - NotBlank: { groups: [TypeFooGroup] }

xabbuh · 2015-10-05T08:52:14Z

Closing here as I think we won't change the behaviour of the Form component's Validator extension.

However, the bahaviour of how the option is evaluated (only on the root form) is something that must be document to mitigate confusion. We have an issue for this in the docs repository (see symfony/symfony-docs#4401) and we will appreciate any contribution to fix that long standing issue.

webmozart added Form Unconfirmed labels Oct 31, 2014

webmozart mentioned this issue Oct 31, 2014

Add description for the "validation_groups" option symfony/symfony-docs#4401

Closed

xabbuh closed this as completed Oct 5, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[DX][Form] Defining validation groups on form field level should throw an error #12342

[DX][Form] Defining validation groups on form field level should throw an error #12342

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[DX][Form] Defining validation groups on form field level should throw an error #12342

[DX][Form] Defining validation groups on form field level should throw an error #12342

Comments

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!