PHPnews.io

Display Symfony form errors, without any submit

Written by JoliCode / Original link on Sep. 30, 2021

Imagine our database contains some invalid entries and we build a form allowing us to complete the entity: how can our users know which fields are invalid and need completion?!

Building a Form with that invalid entity and displaying it to the user is not enough, no errors are going to be displayed until the user submit the form.

In Symfony, form validation is done when the form is submitted thanks to the ValidationListener POST_SUBMIT handler.

Upon submit, an action is basically splitted in two paths:

What if we want this second path, with all the invalid states of our data, as soon as the form is displayed the first time?

Here is how I did it, hope it helps!

Submit the form artificially

We are going to change the typical action logic a bit, to introduce a new code path when the form is not submitted:

        $form = $this->createForm(EmployeeType::class, $employee);

        $form->handleRequest($request);
-        if ($form->isSubmitted() && $form->isValid()) {
-            // Save the object
-            return $this->redirectToRoute('home');
+        if ($form->isSubmitted()) {
+            if ($form->isValid()) {
+                // Save the object
+                return $this->redirectToRoute('home');
+            }
+        } else {
+            $form->submit(null, false);
         }

The important call is $form->submit(null, false);. It will trick the form to run all the "submit" events, including the ValidationListener POST_SUBMIT. So all our initial data (the $employee object here) are run against validation and our user knows what's missing.

But I would not write an article just to show this. There is a catch: the CSRF protection is also triggered and will return an error, because the token is not part of the initial data (and that's the same for all the fields added dynamically).

One way of dealing with it without disabling this important security feature is to get a valid token from the token manager attached to the form. This is kind of hacky but as we do it only when the form is not submitted, there is no issue:

$csrfManager = $form->getConfig()->getOption('csrf_token_manager');
$csrfId = $form->getConfig()->getOption('csrf_token_id');
$csrfField = $form->getConfig()->getOption('csrf_field_name');
$tokenId = $csrfId ?: ($form->getName() ?: \get_class($form->getConfig()->getType()->getInnerType()));

$form->submit([$csrfField => (string) $csrfManager->getToken($tokenId)], false);

(We use the same logic as FormTypeCsrfExtension.)

With this version, our initial page load displays the complete form with nice errors on fields that need to be completed and no unsolicited CSRF error.

Final action code

The complete action code is:

$form->handleRequest($request);
if ($form->isSubmitted()) {
    if ($form->isValid()) {
        // Save the object
        return $this->redirectToRoute('home');
    }
} else {
    // Build the CSRF like FormTypeCsrfExtension to fake form submit (used to display initial errors)
    $csrfManager = $form->getConfig()->getOption('csrf_token_manager');
    $csrfId = $form->getConfig()->getOption('csrf_token_id');
    $csrfField = $form->getConfig()->getOption('csrf_field_name');
    $tokenId = $csrfId ?: ($form->getName() ?: \get_class($form->getConfig()->getType()->getInnerType()));

    $form->submit([$csrfField => (string) $csrfManager->getToken($tokenId)], false);
}

At the moment, I don't see any other place this could be done (FormExtension or FormEvent), so if needed on multiple forms and actions, a refactoring must be done.

This feature / need has not gained much attention on Github when it was suggested so I guess this is not a common need - anyway I hope it solves something for you!

beberlei jolicode

« RSS Only Post - CodeSwing — Interactive Coding Playground (like CodePen, JSFiddle, etc.) Extension for Visual Studio Code »