Symfony2 How to get form validation errors after binding the request to the form

Question

Here s my saveAction code  where the form passes the data to   public function saveAction          user   OBUser          form    this- gt createForm new OBUserType     user        if   this- gt request- gt getMethod       POST                  form- gt bindRequest  this- gt request           if   form- gt isValid                return  this- gt redirect  this- gt generateUrl  success page             else             return  this- gt redirect  this- gt generateUrl  registration form           else         return new Response        My question is  how do I get the errors if  form- gt isValid   returns false

User · Accepted Answer

You have two possible ways of doing it    do not redirect user upon error and display    form errors form     within template file access error array as  form- gt getErrors

User · Answer

You can also use the validator service to get constraint violations    errors    this- gt get  validator  - gt validate  user

User · Answer

I came up with this solution  It works solid with the latest Symfony 2 4   I will try to give some explanations   Using separate validator  I think it s a bad idea to use separate validation to validate entities and return constraint violation messages  like suggested by other writers    You will need to manually validate all the entities  specify validation groups  etc  etc  With complex hierarchical forms it s not practical at all and will get out of hands quickly  This way you will be validating form twice  once with form and once with separate validator  This is a bad idea from the performance perspective    I suggest to recursively iterate form type with it s children to collect error messages   Using some suggested methods with exclusive IF statement  Some answers suggested by another authors contain mutually exclusive IF statements like this  if   form- gt count    gt  0  or if   form- gt hasChildren      As far as I can see  every form can have errors as well as children  I m not expert with Symfony Forms component  but in practice you will not get some errors of the form itself  like CSRF protection error or extra fields error  I suggest to remove this separation   Using denormalized result structure  Some authors suggest to put all errors inside of a plain array  So all the error messages of the form itself and of it s children will be added to the same array with different indexing strategies  number-based for type s own errors and name-based for children errors  I suggest to use normalized data structure of the form   errors      -  Self error      -  Another self error   children     -  some child           errors              -  Children error              -  Another children error           children             -  deeper child                   errors                      -  Children error                      -  Another children error       -  another child           errors              -  Children error              -  Another children error    That way result can be easily iterated later   My solution  So here s my solution to this problem   use Symfony Component Form Form           param Form  form     return array     protected function getFormErrors Form  form         result               No need for further processing if form is valid      if   form- gt isValid              return  result                Looking for own errors       errors    form- gt getErrors        if  count  errors              result  errors                 foreach   errors as  error                 result  errors        error- gt getMessage                            Looking for invalid children and collecting errors recursively      if   form- gt count               childErrors               foreach   form- gt all   as  child                if    child- gt isValid                       childErrors  child- gt getName       this- gt getFormErrors  child                                   if  count  childErrors                  result  children      childErrors                       return  result      I hope it ll help someone

User · Answer

form- getErrors   works for me

User · Answer

The function for symfony 2 1 and newer  without any deprecated function            param  Symfony Component Form Form  form        return array     private function getErrorMessages  Symfony Component Form Form  form         errors   array         if   form- gt count    gt  0            foreach   form- gt all   as  child                                    var  Symfony Component Form Form  child                             if    child- gt isValid                       errors  child- gt getName       this- gt getErrorMessages  child                                 else                           var  Symfony Component Form FormError  error                     foreach   form- gt getErrors   as  key   gt   error                 errors      error- gt getMessage                         return  errors

User · Answer

For my flash messages I was happy with  form- gt getErrorsAsString    Edit  from Benji X80   For SF3 use  form- gt getErrors true  false

User · Answer

If you re using custom validators  Symfony doesn t return errors generated by those validators in  form- gt getErrors     form- gt getErrorsAsString   will return all the errors you need  but its output is unfortunately formatted as a string  not an array   The method you use to get all the errors  regardless of where they came from   depends on which version of Symfony you re using   Most of the suggested solutions involve creating a recursive function that scans all child forms  and extracts the relevant errors into one array  Symfony 2 3 doesn t have the  form- gt hasChildren   function  but it does have  form- gt all     Here is a helper class for Symfony 2 3  which you can use to extract all errors from any form   It s based on code from a comment by yapro on a related bug ticket in Symfony s github account    namespace MyApp FormBundle Helpers   use Symfony Component Form Form   class FormErrorHelper                  Work-around for bug where Symfony  2 3  does not return errors from custom validaters         when you call  form- gt getErrors           Based on code submitted in a comment here by yapro         https   github com symfony symfony issues 7205                param Form  form         return array Associative array of all errors             public function getFormErrors  form                 errors   array             if   form instanceof Form                foreach   form- gt getErrors   as  error                     errors      error- gt getMessage                               foreach   form- gt all   as  key   gt   child                         var  child Form                    if   err    this- gt getFormErrors  child                          errors  key     err                                                     return  errors            Calling code   namespace MyApp ABCBundle Controller   use MyApp FormBundle Helpers   class MyController extends Controller       public function XYZAction                    Create form           if    form- gt isValid                   formErrorHelper   new FormErrorHelper                 formErrors    formErrorHelper- gt getFormErrors  form                   Set error array into twig template here

User · Answer

SYMFONY 3 1  I simply implemented a static method to handle the display of errors  static function serializeFormErrors Form Form  form         errors   array                    var   key         var Form Form  child             foreach   form- gt all   as  key   gt   child            if    child- gt isValid                  foreach   child- gt getErrors   as  error                     errors  key     error- gt getMessage                                       return  errors      Hoping to help

User · Answer

Translated Form Error Messages  Symfony2 3   My version of solving the problem    src Acme MyBundle Resources config services yml  services      form errors          class  Acme MyBundle Form FormErrors    src Acme MyBundle Form FormErrors php   lt  php namespace Acme MyBundle Form   class FormErrors       public function getArray  Symfony Component Form Form  form                return  this- gt getErrors  form              private function getErrors  form                 errors   array             if   form instanceof  Symfony Component Form Form                                                        foreach   form- gt getErrors   as  error                      errors      error- gt getMessage                                                                                foreach   form- gt all   as  key   gt   child                         var  child  Symfony Component Form Form                    if   err    this- gt getErrors  child                          errors  key     err                                                     return  errors             src Acme MyBundle Controller DefaultController php   form    this- gt createFormBuilder  entity - gt getForm     form errors    this- gt get  form errors  - gt getArray  form   return new JsonResponse  form errors     In Symfony 2 5 you can get all fields errors very easy        errors   array        foreach   form as  fieldName   gt   formField            foreach   formField- gt getErrors true  as  error                 errors  fieldName     error- gt getMessage

User · Answer

Symfony 2 3   2 4   This function get s all the errors  The ones on the form like  The CSRF token is invalid  Please try to resubmit the form   as well as additional errors on the form children which have no error bubbling   private function getErrorMessages  Symfony Component Form Form  form         errors   array         foreach   form- gt getErrors   as  key   gt   error            if   form- gt isRoot                   errors           error- gt getMessage              else                errors      error- gt getMessage                         foreach   form- gt all   as  child            if    child- gt isValid                   errors  child- gt getName       this- gt getErrorMessages  child                        return  errors      To get all errors as a string    string   var export  this- gt getErrorMessages  form   true       Symfony 2 5   3 0    string    string   form- gt getErrors true  false     Docs  https   github com symfony symfony blob master UPGRADE-2 5 md form https   github com symfony symfony blob master UPGRADE-3 0 md form  at the bottom  The method Form  getErrorsAsString   was removed

User · Answer

For Symfony 3 2 and above use this   public function buildErrorArray FormInterface  form         errors   array         foreach   form- gt getErrors   as  key   gt   error            if   form- gt isRoot                   errors           error- gt getMessage              else                errors      error- gt getMessage                         foreach   form- gt all   as  child            if    child- gt isValid                   errors  child- gt getName       string   child- gt getErrors true  false                       return  errors      Use str replace if you want to get rid of the annoying  Error   text in each error description text    errors  child- gt getName      str replace  ERROR         string   child- gt getErrors true  false

User · Answer

SYMFONY 3 X  Other SF 3 X methods given here did not work for me because I could submit empty data to the form  but I have NotNull NotBlanck constraints   In this case the error string would look like this    string 282   ERROR  This value should not be blank  ERROR  This value should not be blank  ERROR  This value should not be blank  ERROR  This value should not be blank  ERROR  This value should not be blank  ERROR  This value should not be null  name      ERROR  This value should not be blank      Which is not very usefull  So I made this   public function buildErrorArray FormInterface  form         errors            foreach   form- gt all   as  child             errors   array merge               errors               this- gt buildErrorArray  child                        foreach   form- gt getErrors   as  error             errors  error- gt getCause  - gt getPropertyPath       error- gt getMessage               return  errors      Which would return that    array 7        data name    gt    string 31   This value should not be blank       data street    gt    string 31   This value should not be blank       data zipCode    gt    string 31   This value should not be blank       data city    gt    string 31   This value should not be blank       data state    gt    string 31   This value should not be blank       data countryCode    gt    string 31   This value should not be blank       data organization    gt    string 30   This value should not be null

User · Answer

Below is the solution that worked for me  This function is in a controller and will return a structured array of all the error messages and the field that caused them     Symfony 2 0   private function getErrorMessages  Symfony Component Form Form  form         errors   array        foreach   form- gt getErrors   as  key   gt   error             template    error- gt getMessageTemplate             parameters    error- gt getMessageParameters             foreach  parameters as  var   gt   value                template   str replace  var   value   template                       errors  key     template            if   form- gt hasChildren              foreach   form- gt getChildren   as  child                if    child- gt isValid                       errors  child- gt getName       this- gt getErrorMessages  child                                      return  errors      Symfony 2 1 and newer   private function getErrorMessages  Symfony Component Form Form  form               errors   array         if   form- gt hasChildren              foreach   form- gt getChildren   as  child                if    child- gt isValid                       errors  child- gt getName       this- gt getErrorMessages  child                                 else           foreach   form- gt getErrors   as  key   gt   error                 errors      error- gt getMessage                            return  errors

User · Answer

For Symfony 2 1 onwards for use with Twig error display I altered the function to add a FormError instead of simply retrieving them  this way you have more control over errors and do not have to use error bubbling on each individual input  If you do not set it in the manner below    form errors form     will remain blank           param  Symfony Component Form Form  form        return void     private function setErrorMessages  Symfony Component Form Form  form               if   form- gt count    gt  0            foreach   form- gt all   as  child                if    child- gt isValid                      if  isset  this- gt getErrorMessages  child  0                            error   new FormError   this- gt getErrorMessages  child  0                          form- gt addError  error

User · Answer

Based on  Jay Seth s answer  I made a version of FormErrors class especially for Ajax Forms      src AppBundle Form FormErrors php namespace AppBundle Form   class FormErrors                    param  Symfony Component Form Form  form                return array  errors             public function getArray  Symfony Component Form Form  form                return  this- gt getErrors  form   form- gt getName                            param  Symfony Component Form Form  baseForm         param  Symfony Component Form Form  baseFormName                return array  errors             private function getErrors  baseForm   baseFormName             errors   array            if   baseForm instanceof  Symfony Component Form Form                foreach  baseForm- gt getErrors   as  error                     errors     array                       mess         gt   error- gt getMessage                         key          gt   baseFormName                                               foreach   baseForm- gt all   as  key   gt   child                    if   child instanceof  Symfony Component Form Form                          cErrors    this- gt getErrors  child   baseFormName          child- gt getName                          errors   array merge  errors   cErrors                                                     return  errors            Usage  e g  in your action      errors    this- gt get  form errors  - gt getArray  form     Symfony version  2 8 4  Example JSON response           success   false       errors               mess    error message            key    RegistrationForm user firstname                    mess    error message            key    RegistrationForm user lastname                    mess    error message            key    RegistrationForm user email                    mess    error message            key    RegistrationForm user zipCode                    mess    error message            key    RegistrationForm user password password                    mess    error message            key    RegistrationForm terms                    mess    error message2            key    RegistrationForm terms                    mess    error message            key    RegistrationForm marketing                    mess    error message2            key    RegistrationForm marketing             The error object contains the  key  field  which is the id of the input DOM element  so you can easily populate error messages   If you have child forms inside the parent  don t forget to add the cascade validation option inside the parent form s setDefaults

User · Answer

To get proper  translatable  messages  currently using SF 2 6 3  here is my final function  as none of above s seem to work anymore     private function getErrorMessages  Symfony Component Form Form  form               errors   array        foreach   form- gt getErrors true  false  as  error               My personnal need was to get translatable messages             errors      this- gt trans  error- gt current  - gt getMessage              errors      error- gt current  - gt getMessage               return  errors      as the Form  getErrors   method now returns an instance of FormErrorIterator  unless you switch the second argument   flatten  to true   It will then return a FormError instance  and you will have to call the getMessage   method directly  without the current   method    private function getErrorMessages  Symfony Component Form Form  form               errors   array        foreach   form- gt getErrors true  true  as  error               My personnal need was to get translatable messages             errors      this- gt trans  error- gt getMessage              errors      error- gt getMessage               return  errors         The most important thing is actually to set the first argument to true in order to get the errors  Leaving the second argument   flatten  to his default value  true  will return FormError instances  while it will return FormErrorIterator instances when set to false

User · Answer

Symfony 3 and newer  I recently made a function which creates a tree of form errors  This will be helpful for returning list of errors back to front-end  This is based on form types having    error bubbling    gt  false   Code   public static function getFormErrorsTree FormInterface  form   array        errors            if  count  form- gt getErrors     gt  0            foreach   form- gt getErrors   as  error                 errors      error- gt getMessage                    else           foreach   form- gt all   as  child                 childTree   self  getFormErrorsTree  child                if  count  childTree   gt  0                     errors  child- gt getName       childTree                                     return  errors      Output   Array        name    gt  Array                        0    gt  This value is not valid                  emails    gt  Array                        0    gt  Array                                        0    gt  Given e-mail is not valid                       1    gt  Given e-mail is not valid  2                                 1    gt  Array                                        0    gt  Given e-mail is not valid                       1    gt  Given e-mail is not valid  2                                     Notice  I know that errors from deeper level fields can be overwritten if higher level has errors  but this is on purpose for my usage

User · Answer

Translated Form Error Messages  Symfony2 1   I have been struggling a lot to find this information so I think it s definitely worth adding a note on translation of form errors    Icode4food answer will return all errors of a form  However  the array that is returned does not take into account either message pluralization or translation   You can modify the foreach loop of  Icode4food answer to have a combo    Get all errors of a particular form Return a translated error  Take pluralization into account if necessary   Here it is     foreach   form- gt getErrors   as  key   gt   error          If the message requires pluralization     if  error- gt getMessagePluralization       null             errors      this- gt container- gt get  translator  - gt transChoice               error- gt getMessage                  error- gt getMessagePluralization                  error- gt getMessageParameters                  validators                              Otherwise  we do a classic translation     else            errors      this- gt container- gt get  translator  - gt trans               error- gt getMessage                 array                  validators                             This answer has been put together from 3 different posts     Symfony2     Getting translated validation errors in controller  How to use Symfony2 validator component without forms  Entities and data arrays   Symfony2     Getting All Errors From a Form in a Controller

User · Answer

Use the Validator to get the errors for a specific entity  if   form- gt isValid                    else          get a ConstraintViolationList      errors    this- gt get  validator  - gt validate   user          result               iterate on it     foreach   errors as  error                    Do stuff with                error- gt getPropertyPath     the field that caused the error               error- gt getMessage     the error message           API reference    ConstraintViolationList ConstraintViolation

User · Answer

For Symfony 2 1   This is my final solution putting in together many others solutions   protected function getAllFormErrorMessages  form         retval   array        foreach   form- gt getErrors   as  key   gt   error            if  error- gt getMessagePluralization       null                 retval  message      this- gt get  translator  - gt transChoice                   error- gt getMessage                      error- gt getMessagePluralization                      error- gt getMessageParameters                      validators                           else                retval  message      this- gt get  translator  - gt trans  error- gt getMessage    array     validators                        foreach   form- gt all   as  name   gt   child             errors    this- gt getAllFormErrorMessages  child           if   empty  errors                 retval  name     errors                       return  retval

User · Answer

For Symfony 5 I got this working   public function getErrorMessages Form  form            errors                    foreach   form- gt all   as  child            foreach   child- gt getErrors   as  error                     name    child- gt getName                     errors  name     error- gt getMessage                         return  errors     I got this kind of JSON thing with it   errors        firstname   quot The firstname must be between 2 and 30 characters long  quot       lastname   quot The lastname must be between 2 and 40 characters long  quot      subject   quot Please choose a subject  quot      text   quot Empty messages are not allowed  quot     It s nice and sweet enough for me  but I guess it will not pick up errors at the global level  like timed out tokens or other stuff like that  Anyway  I ve been quite a bit longtime looking for a solution suiting my case  and I m happy contributing here hoping it ll help some developer somewhere sometime somehow

[symfony] Symfony2 : How to get form validation errors after binding the request to the form

Examples related to symfony