Add error to Symfony 2 form element

Question

I check some validation in my controller. And I want to add error to specific element of my form on failure. My form:

use Symfony\Component\Form\FormError;

// ...

$config = new Config();
$form = $this->createFormBuilder($config)
        ->add('googleMapKey', 'text', array('label' => 'Google Map key'))
        ->add('locationRadius', 'text', array('label' => 'Location radius (km)'))
        ->getForm();

// ...

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

addError() method adds error to form, not to element. How can I add an error to locationRadius element?

Mun Mun Das · Accepted Answer · 2012-09-14 07:15:09Z

187

You can do

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

As form elements are also of FormInterface type.

edited Sep 14, 2012 at 7:15

answered Sep 14, 2012 at 7:07

Mun Mun Das

15k2 gold badges46 silver badges43 bronze badges

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

6 Comments

Mick Over a year ago

@m2mdas, great answer! How would we translate this? because once we create a FormError instance, it won't translate it, am I right? I tried and it doesn't translate it, and I think it makes sense. How would you translate a FormError instance?

Mun Mun Das Over a year ago

Hello @Patt, sorry for late reply. Validator component takes care of translating form constraint violation messages before the error messages are added to the form. For adding custom error you have translate the message same way as you do for other strings e.g, $this->get('translator')->trans('error message')

Nat Naydenova Over a year ago

@m2mdas But how do you print this error in your view? I tried this, but it doesn't go in the form_errors(form) in my twig.

TMichel Over a year ago

@NatNaydenova I know it's been a while but try form_erros(form.my_field_name)

beterthanlife Over a year ago

Please note: to get an error to print using form_errors(form), add your error to the form itself e.g. $form->addError(new FormError('error msg');

|

Jekis · Accepted Answer · 2014-02-11 14:49:46Z

OK guys, I have another way. It is more complex and only for specific cases.

My case:

I have a form and after submit I post data to the API server. And errors I got from the API server as well.

API server error format is:

array(
    'message' => 'Invalid postal code',
    'propertyPath' => 'businessAdress.postalCode',
)

My goal is to get flexible solution. Lets set the error for the corresponding field.

$vm = new ViolationMapper();

// Format should be: children[businessAddress].children[postalCode]
$error['propertyPath'] = 'children['. str_replace('.', '].children[', $error['propertyPath']) .']';

// Convert error to violation.
$constraint = new ConstraintViolation(
    $error['message'], $error['message'], array(), '', $error['propertyPath'], null
);

$vm->mapViolation($constraint, $form);

That's it!

NOTE! addError() method bypasses error_mapping option.

My form (Address form embedded in the Company form):

Company

<?php

namespace Acme\DemoBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints;

class Company extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('companyName', 'text',
                array(
                    'label' => 'Company name',
                    'constraints' => array(
                        new Constraints\NotBlank()
                    ),
                )
            )
            ->add('businessAddress', new Address(),
                array(
                    'label' => 'Business address',
                )
            )
            ->add('update', 'submit', array(
                    'label' => 'Update',
                )
            )
        ;
    }

    public function getName()
    {
        return null;
    }
}

Address

<?php

namespace Acme\DemoBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints;

class Address extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            // ...
            ->add('postalCode', 'text',
                array(
                    'label' => 'Postal code',
                    'constraints' => array(
                        new Constraints\NotBlank()
                    ),
                )
            )
            ->add('town', 'text',
                array(
                    'label' => 'Town',
                    'constraints' => array(
                        new Constraints\NotBlank()
                    ),
                )
            )
            ->add('country', 'choice',
                array(
                    'label' => 'Country',
                    'choices' => $this->getCountries(),
                    'empty_value' => 'Select...',
                    'constraints' => array(
                        new Constraints\NotBlank()
                    ),
                )
            )
        ;
    }

    public function getName()
    {
        return null;
    }
}

where do you place these code ? $vm = new ViolationMapper();
@vidyvideni, Controller action where form submit will be handled. Also you could adjust this piece of code and move it to a separate method

Collectives™ on Stack Overflow

Add error to Symfony 2 form element

2 Answers 2

6 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

6 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related