New in Symfony 5.3: Form Handler Helper

Contributed by Kévin Dunglas in #40799.

The recommended way of processing Symfony forms is to use a single action for both rendering the form and handling the form submit. This is how it looks in practice: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21// src/Controller/ConferenceController.php // ...

[Route('/{id}/edit', name: 'conference_edit', methods: ['GET', 'POST'])]

public function edit(Request $request, Conference $conference): Response { $form = $this->createForm(ConferenceType::class, $conference);

$form->handleRequest($request);
if ($form->isSubmitted() && $form->isValid()) {
    // do something with the $conference object
    // (e.g. persist it in the database)

    return $this->redirectToRoute('conference_show', [
        'id' => $conference->getId(),
    ]);
}

return $this->render('conference/edit.html.twig', [
    'form' => $form->createView(),
]);

}

When using libraries such as Symfony UX Turbo this simple form handling is not enough and you have to follow the HTTP protocol strictly (e.g. if the form is submitted but invalid, the response must have a HTTP 422 status code). In order to simplify the form handling in those cases, Symfony 5.3 adds a new (optional) helper to handle forms. This helper is defined in the AbstractController base controller as a new method called handleForm(). This is how the previous example looks when using the new helper: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25// src/Controller/ConferenceController.php // ...

[Route('/{id}/edit', name: 'conference_edit', methods: ['GET', 'POST'])]

public function edit(Request $request, Conference $conference): Response { return $this->handleForm( $this->createForm(ConferenceType::class, $conference), $request, function (FormInterface $form) use ($conference) { // do something with the $conference object // (e.g. persist it in the database)

        return $this->redirectToRoute(
            'conference_show',
            ['id' => $conference->getId()],
            Response::HTTP_SEE_OTHER
        );
    },
    function (FormInterface $form) {
        return $this->render('conference/edit.html.twig', [
            'form' => $form->createView(),
        ]);
    }
);

}

The signature of the handleForm() method is: 1handleForm(FormInterface $form, Request $request, callable $onSuccess, callable $render): Response

Both $onSuccess and $render callables must return a Response object. This is how it works in practice:

if the form is not submitted, the $render callable is called; if the form is submitted but invalid, the $render callable is called and a 422 HTTP status code is set if the current status hasn’t been customized; if the form is submitted and valid, the $onSuccess callable is called (which is usually where you persist the data and return the 303 HTTP redirection).

                Sponsor the Symfony project.

http://feedproxy.google.com/~r/symfony/blog/~3/tgna0PcoiTE/new-in-symfony-5-3-form-handler-helper

Created 4y | Apr 30, 2021, 7:20:07 AM


Login to add comment

Other posts in this group

SymfonyLive Paris 2025 : Rôles & permissions : développez une marque blanche avec du Feature Flipping

SymfonyLive Paris 2025, conference in French language only, will take place from March 27 to 28! The schedule is currently being revealed as we go along. More details are available here.

Al

Jan 23, 2025, 4:50:03 PM | Symfony
SymfonyLive Berlin 2025: So you think you know PHPUnit

SymfonyLive Berlin 2025, conference held in English, will take place from April 1 to 4! The schedule is being revealed gradually. More details are available here.

First, a big thank you to

Jan 22, 2025, 8:20:10 AM | Symfony
SymfonyLive Paris 2025 : Passkeys pour une authentification fluide et sécurisée

SymfonyLive Paris 2025, conference in French language only, will take place from March 27 to 28! The schedule is currently being revealed as we go along. More details are available here.

To

Jan 21, 2025, 11:30:10 AM | Symfony
Join us for SymfonyDay Chicago – March 17, 2025!

Mark your calendars for March 17, 2025 because SymfonyDay Chicago 2025 promises to be a one-of-a-kind event that you won’t want to miss! This full day is dedicated to celebrating the incredible contri

Jan 20, 2025, 7:20:03 PM | Symfony
A Week of Symfony #942 (13-19 January 2025)

This week, Symfony celebrated the SymfonyOnline January 2025 conference. In addition, it announced the new Symfony UX Core Team. Lastly, the upcoming Symfony 7.3 version simplified the configuration o

Jan 19, 2025, 8:30:08 AM | Symfony
Announcing the Symfony UX Core Team

The Symfony UX initiative was announced in December 2020. It was introduced to enhance the developer experience by integrating JavaScript tools and libraries more seamlessly with Symfony applications,

Jan 13, 2025, 3:40:04 PM | Symfony
A Week of Symfony #941 (6-12 January 2025)

This week, Symfony development activity was very intense. The upcoming Symfony 7.3 version added a Slug constraint, introduced support for union types in OptionsResolver, enabled using HTTP/3 with the

Jan 12, 2025, 9:30:12 AM | Symfony