Skip to content

Instantly share code, notes, and snippets.

@Graceas
Created September 10, 2013 06:26
Show Gist options
  • Save Graceas/6505663 to your computer and use it in GitHub Desktop.
Save Graceas/6505663 to your computer and use it in GitHub Desktop.
Symfony 2 Form Error Serializer. May be used for AJAX form validation. Allows tree and flat array styles for errors.
class FormErrorsSerializer {
public function serializeFormErrors(\Symfony\Component\Form\Form $form, $flat_array = false, $add_form_name = false, $glue_keys = '_')
{
$errors = array();
$errors['global'] = array();
$errors['fields'] = array();
foreach ($form->getErrors() as $error) {
$errors['global'][] = $error->getMessage();
}
$errors['fields'] = $this->serialize($form);
if ($flat_array) {
$errors['fields'] = $this->arrayFlatten($errors['fields'],
$glue_keys, (($add_form_name) ? $form->getName() : ''));
}
return $errors;
}
private function serialize(\Symfony\Component\Form\Form $form)
{
$local_errors = array();
foreach ($form->getIterator() as $key => $child) {
foreach ($child->getErrors() as $error){
$local_errors[$key] = $error->getMessage();
}
if (count($child->getIterator()) > 0) {
$local_errors[$key] = $this->serialize($child);
}
}
return $local_errors;
}
private function arrayFlatten($array, $separator = "_", $flattened_key = '') {
$flattenedArray = array();
foreach ($array as $key => $value) {
if(is_array($value)) {
$flattenedArray = array_merge($flattenedArray,
$this->arrayFlatten($value, $separator,
(strlen($flattened_key) > 0 ? $flattened_key . $separator : "") . $key)
);
} else {
$flattenedArray[(strlen($flattened_key) > 0 ? $flattened_key . $separator : "") . $key] = $value;
}
}
return $flattenedArray;
}
}
@Graceas
Copy link
Author

Graceas commented Sep 10, 2013

In action you may use:

$ajax = $request->isXmlHttpRequest();
if ($request->getMethod() == 'POST') {
  $form->handleRequest($request);

  if ($form->isValid()) {
    // ...
  } else {
    if ($ajax) {
      $errors = $this->get('form_serializer')->serializeFormErrors($form, true, true);

      return new Response(json_encode(array(
        'status' => 'error',
        'errors' => $errors
      )));
    }
  }
}

@sseidenthal
Copy link

Thanks for this, works great !

@asentner
Copy link

asentner commented Jul 7, 2015

Thanks for the code! I know this is now dated, consider using Symfony\Component\Form\FormInterface instead. Everything seems to be working fine with that small edit on 2.6.

@julienwebdev
Copy link

Good job :)

Tested on symfony 2.8

@angelo-msg
Copy link

+1 for the Symfony\Component\Form\FormInterface usage. It solved my issues.

@linxlad
Copy link

linxlad commented Feb 19, 2016

Nice little script, tested on 3.0.2 and works but it through an exception when the submit button came into the foreach so I had to make sure that wasn't serialized.

private function serialize(\Symfony\Component\Form\Form $form)
    {
        $local_errors = array();
        foreach ($form->getIterator() as $key => $child) {

            foreach ($child->getErrors() as $error){
                $local_errors[$key] = $error->getMessage();
            }

            if (count($child->getIterator()) > 0) {
                if (!$child instanceof \Symfony\Component\Form\SubmitButton) {
                    $local_errors[$key] = $this->serialize($child);
                }
            }
        }

        return $local_errors;
    }

Great for simply returning the template error string to the view via AJAX. +1

Copy link

ghost commented Mar 21, 2016

it does not return dates and choices in radio in the serialized response

@linxlad
Copy link

linxlad commented Jul 29, 2016

Updated version of this to keep all the error properties intact. Added an unserializer to apply the errors back to the form if you intend to store the errors into a database or cache.

https://gist.github.com/linxlad/3ec76c181f717fba532bf43484b7c970

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment