Feature Request: Support Multi-Step Forms

[shochdoerfer]

Symfony 7.4/8.0 added support for multi-step forms which allows us to split large forms into smaller, connected ones that users can navigate through.

I think it would be beneficial if the Resource Bundle is able to support these kinds of forms.

[loic425]

Hi @shochdoerfer, do you know what is required to support them?

[Prometee]

Hello @shochdoerfer !

I can see one main usage of this new component in Sylius (checkout tunnel) but I'm not able to see automated use cases inside the resource bundle.

Do you have an example of a scenario where this component can be used?

[shochdoerfer]

@loic425 according to the linked blog post (and a quick demo I did), it shouldn't be too much work to get it done

The form submit logic changes slightly, you need to add the $flow->isFinished() check like this:

$flow = $this->createForm(UserSignUpType::class, new UserSignUp())
    ->handleRequest($request);

if ($flow->isSubmitted() && $flow->isValid() && $flow->isFinished()) {
    // do something with $form->getData()

    return $this->redirectToRoute('app_signup_success');
}

And passing the form to the template needs a seperate call to the getStepForm():

return $this->render('signup/flow.html.twig', [
    'form' => $flow->getStepForm(),
]);

I am just doing that in a Sylius plugin in a custom controller I've built and it works quite well. So I would hope, it should be "easy" to add to the Resource Bundle. The form type you would extend the UserSignUpType from is a new one called Symfony\Component\Form\Flow\AbstractFlowType - that should make it easy to decide which logic to run when.

[shochdoerfer]

@Prometee I don't think this is an important feature to have for Sylius Core but in Sylius Stack context, it would allow to build completly custom form flows.

I was also thinking about the checkout but I am not sure if that would work. Not (yet) sure how flexible it is.

[loic425]

@shochdoerfer Could you make some tests on Resource package in a PR?

[Prometee]

@shochdoerfer I can see there is a way to refactor this line into a dedicated service (ex: FormRequestValidityProvider) then decorate it to add Multi-Step Form support:
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Component/src/Symfony/Validator/State/ValidateProvider.php#L73-L75

Same here if we want to support legacy ResourceController:
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L172
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L215

https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L249-L251
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L305

Then the form view can be also refactored into a dedicated service (ex: FormViewProvider) then decorate it to add Multi-Step Form support:
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Component/src/Twig/Context/Factory/RequestContextFactory.php#L47

And legacy spots:
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L234
https://github.com/Sylius/SyliusResourceBundle/blob/1.14/src/Bundle/Controller/ResourceController.php#L324

Do I miss something @loic425?

[shochdoerfer]

@loic425 will do

[loic425]

I don't want to add this feature to the legacy resource controller, we are very close to remove it 💃