Symfony Form Event add Error to specific field

Question

My scenario is the following:

If the user choose true from "maxRedemptionForDiscount" and type "0" into the "maxRedemptionForDiscountValue" there should be an error message rendering to the specific field (at the position of the TextType field)

This is the form with an eventListener:

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder->add(
        'maxRedemptionForDiscount',
        ChoiceType::class,
        [
            'placeholder'        => false,
            'multiple'           => false,
            'choices'            => [
                true  => 'discount.form_fields.set_max_redemptions',
                false => 'discount.form_fields.unlimited',
            ],
            'label'              => 'discount.form_fields.max_redemption_for_discount',
            'translation_domain' => 'entities',
            'required'           => false,
            'error_bubbling'     => true,
            'attr'               => [
                'class' => 'maxRedemptionForDiscountSelect',
            ],
        ]
    )->add(
        'maxRedemptionForDiscountValue',
        TextType::class,
        [
            'label'              => 'discount.form_fields.set_max_redemptions',
            'translation_domain' => 'entities',
            'required'           => false,
        ]
    )->addEventListener(
        FormEvents::PRE_SUBMIT,
        [$this, 'onPreSubmit']
    );
}

and this is the onPreSubmit function:

/**
 * @param FormEvent $event
 */
public function onPreSubmit(FormEvent $event)
{
    $data = $event->getData();
    $form = $event->getForm();

    if ($data['maxRedemptionForDiscount'] == 1) {
        if ($data['maxRedemptionForDiscountValue'] == 0) {
            $form->addError(new FormError('error message'));
        }
    }
    $event->setData($data);
}

Here is the twig code:

{{ form_row(form.maxRedemptionForDiscount) }}

<div id="maxRedemptionForDiscountValue">
    {{ form_row(form.maxRedemptionForDiscountValue) }}
</div>

This render a error message above the form. But what I want i to render a error message to the specific field.

This does not work:

$form->get('maxRedemptionForDiscountValue')->addError(new FormError('error message'));

If I try this the error message will disappear at the top of my form, but not showing up at the specific field position.

What I am doing wrong here?

DonCallisto · Accepted Answer · 2017-02-08 09:47:28Z

6

First, you should set error_bubbling to false (or remove it as it's default behavior).

As documentation states

If true, any errors for this field will be passed to the parent field or form. For example, if set to true on a normal field, any errors for that field will be attached to the main form, not to the specific field.

Particularly for ChoiceType

Set that error on this field must be attached to the field instead of the parent field (the form in most cases).

Second, you should add error to specific form field

$form
  ->get('maxRedemptionForDiscountValue')
  ->addError(new FormError('error message'));

Third, you should edit your template

<div id="maxRedemptionForDiscountValue">
    {{ form_errors(form.maxRedemptionForDiscountValue) }}
    {{ form_row(form.maxRedemptionForDiscountValue) }}
</div>

edited Feb 8, 2017 at 9:47

answered Feb 8, 2017 at 9:15

DonCallisto

30k9 gold badges74 silver badges104 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

goldlife Over a year ago

Ok, thanks I remove the error_bubling. As I write in my question I had try your solution "$form ->get('maxRedemptionForDiscountValue') ->addError(new FormError('error message'));" but this does not work for me. If I use this the error will only remove from the top of the form and not showing at the specific field.

DonCallisto Over a year ago

@goldlife did you tried both solutions: error_bubbling removed + add error to specific field?

DonCallisto Over a year ago

@goldlife and what's the result?

goldlife Over a year ago

as i say, the error message will disappear at the top of my form, but not showing up at the specific field position.

goldlife Over a year ago

that sadly does not work to. If I try this - the form is valid although I choose true and and type 0. If I remove ->get('maxRedemptionForDiscountValue') and use only $form->addError an error message will display above the form.

|

daniel · Accepted Answer · 2023-08-04 22:46:49Z

0

remplace the pre-submit events for the post-submit events

->addEventListener(
    FormEvents::POST_SUBMIT,
    [$this, 'onPostSubmit']
);

answered Aug 4, 2023 at 22:46

daniel

1

Comments

martti · Accepted Answer · 2023-09-21 09:23:39Z

0

As suggested by @daniel, use a POST_SUBMIT event. Here is the issue with PRE_SUBMIT.

Personally I would not use a form event listener but attach a data_class on the form and then use a custom class constraint validator on that data_class. The validator can then add a violation on the specific field. See the documentation.

answered Sep 21, 2023 at 9:23

martti

2,0851 gold badge15 silver badges10 bronze badges

Collectives™ on Stack Overflow

Symfony Form Event add Error to specific field

3 Answers 3

9 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

9 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related