Merge branch '7.4' into 8.0

* 7.4:
  [Messenger] Allow to use custom http client for sqs messenger transport
  [JsonStreamer] Merge `PropertyMetadata` value transformers
  [Mailer] Relax regexp to parse message ids
  [Mailer] Fix parsing message ids in SMTP responses
  Reviewed translations
  [HttpClient] Consider cached responses without expiration as immediately stale
  [Routing] Indicate type of rejected object in CompiledUrlMatcherDumper
  [Workflow] Extract code from the data collector to a dedicated class
  [Messenger] Add `MessageSentToTransportsEvent`
  Add FormFlow for multistep forms management
  [HttpKernel][DebugBundle] Collect dumps when console profiling is enabled

Author: nicolas-grekas

CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
  * Add `input=date_point` to `DateTimeType`, `DateType` and `TimeType`
  * Add support for guessing form type of enum properties
  * Add `active_at`, `not_active_at` and `legal_tender` options to `CurrencyType`
+ * Add `FormFlow` for multistep forms management
 
 7.3
 ---

Extension/Core/CoreExtension.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory;
 use Symfony\Component\Form\ChoiceList\Factory\PropertyAccessDecorator;
 use Symfony\Component\Form\Extension\Core\Type\TransformationFailureExtension;
+use Symfony\Component\Form\Flow;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
@@ -78,6 +79,12 @@ protected function loadTypes(): array
             new Type\TelType(),
             new Type\ColorType($this->translator),
             new Type\WeekType(),
+            new Flow\Type\ButtonFlowType(),
+            new Flow\Type\FinishFlowType(),
+            new Flow\Type\NavigatorFlowType(),
+            new Flow\Type\NextFlowType(),
+            new Flow\Type\PreviousFlowType(),
+            new Flow\Type\FormFlowType($this->propertyAccessor),
         ];
     }
 

Extension/HttpFoundation/HttpFoundationExtension.php

@@ -24,6 +24,7 @@ protected function loadTypeExtensions(): array
     {
         return [
             new Type\FormTypeHttpFoundationExtension(),
+            new Type\FormFlowTypeSessionDataStorageExtension(),
         ];
     }
 }

Extension/HttpFoundation/Type/FormFlowTypeSessionDataStorageExtension.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Extension\HttpFoundation\Type;
+
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Flow\DataStorage\SessionDataStorage;
+use Symfony\Component\Form\Flow\FormFlowBuilderInterface;
+use Symfony\Component\Form\Flow\Type\FormFlowType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+class FormFlowTypeSessionDataStorageExtension extends AbstractTypeExtension
+{
+    public function __construct(
+        private readonly ?RequestStack $requestStack = null,
+    ) {
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        if (!$builder instanceof FormFlowBuilderInterface) {
+            throw new \InvalidArgumentException(\sprintf('The "%s" can only be used with FormFlowType.', self::class));
+        }
+
+        if (null === $this->requestStack || null !== $options['data_storage']) {
+            return;
+        }
+
+        $key = \sprintf('_sf_formflow.%s_%s', strtolower(str_replace('\\', '_', $builder->getType()->getInnerType()::class)), $builder->getName());
+        $builder->setDataStorage(new SessionDataStorage($key, $this->requestStack));
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [FormFlowType::class];
+    }
+}

Flow/AbstractButtonFlowType.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Flow\Type\ButtonFlowType;
+
+/**
+ * @author Yonel Ceruto <[email protected]>
+ */
+abstract class AbstractButtonFlowType extends AbstractType implements ButtonFlowTypeInterface
+{
+    public function getParent(): string
+    {
+        return ButtonFlowType::class;
+    }
+}

Flow/AbstractFlowType.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Flow\Type\FormFlowType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormView;
+
+/**
+ * @author Yonel Ceruto <[email protected]>
+ */
+abstract class AbstractFlowType extends AbstractType implements FormFlowTypeInterface
+{
+    final public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        if (!$builder instanceof FormFlowBuilderInterface) {
+            throw new \InvalidArgumentException(\sprintf('The "%s" can only be used with FormFlowType.', self::class));
+        }
+
+        $this->buildFormFlow($builder, $options);
+    }
+
+    final public function buildView(FormView $view, FormInterface $form, array $options): void
+    {
+        if (!$form instanceof FormFlowInterface) {
+            throw new \InvalidArgumentException(\sprintf('The "%s" can only be used with FormFlowType.', self::class));
+        }
+
+        $this->buildViewFlow($view, $form, $options);
+    }
+
+    final public function finishView(FormView $view, FormInterface $form, array $options): void
+    {
+        if (!$form instanceof FormFlowInterface) {
+            throw new \InvalidArgumentException(\sprintf('The "%s" can only be used with FormFlowType.', self::class));
+        }
+
+        $this->finishViewFlow($view, $form, $options);
+    }
+
+    public function buildFormFlow(FormFlowBuilderInterface $builder, array $options): void
+    {
+    }
+
+    public function buildViewFlow(FormView $view, FormFlowInterface $form, array $options): void
+    {
+    }
+
+    public function finishViewFlow(FormView $view, FormFlowInterface $form, array $options): void
+    {
+    }
+
+    public function getParent(): string
+    {
+        return FormFlowType::class;
+    }
+}

Flow/ButtonFlow.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\SubmitButton;
+
+/**
+ * A button that submits the form and handles an action.
+ *
+ * @author Yonel Ceruto <[email protected]>
+ */
+class ButtonFlow extends SubmitButton implements ButtonFlowInterface
+{
+    private mixed $data = null;
+    private bool $handled = false;
+
+    public function submit(array|string|null $submittedData, bool $clearMissing = true): static
+    {
+        if ($this->isSubmitted()) {
+            return $this; // ignore double submit
+        }
+
+        parent::submit($submittedData, $clearMissing);
+
+        if ($this->isSubmitted()) {
+            $this->data = $submittedData;
+        }
+
+        return $this;
+    }
+
+    public function getViewData(): mixed
+    {
+        return $this->data;
+    }
+
+    public function handle(): void
+    {
+        /** @var FormInterface $form */
+        $form = $this->getParent();
+        $data = $form->getData();
+
+        while ($form && !$form instanceof FormFlowInterface) {
+            $form = $form->getParent();
+        }
+
+        $handler = $this->getConfig()->getOption('handler');
+        $handler($data, $this, $form);
+
+        $this->handled = true;
+    }
+
+    public function isHandled(): bool
+    {
+        return $this->handled;
+    }
+
+    public function isResetAction(): bool
+    {
+        return 'reset' === $this->getConfig()->getAttribute('action');
+    }
+
+    public function isPreviousAction(): bool
+    {
+        return 'previous' === $this->getConfig()->getAttribute('action');
+    }
+
+    public function isNextAction(): bool
+    {
+        return 'next' === $this->getConfig()->getAttribute('action');
+    }
+
+    public function isFinishAction(): bool
+    {
+        return 'finish' === $this->getConfig()->getAttribute('action');
+    }
+
+    public function isClearSubmission(): bool
+    {
+        return $this->getConfig()->getOption('clear_submission');
+    }
+}

Flow/ButtonFlowBuilder.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\ButtonBuilder;
+
+/**
+ * A builder for {@link ButtonFlow} instances.
+ *
+ * @author Yonel Ceruto <[email protected]>
+ */
+class ButtonFlowBuilder extends ButtonBuilder
+{
+    public function getForm(): ButtonFlow
+    {
+        return new ButtonFlow($this->getFormConfig());
+    }
+}

Flow/ButtonFlowInterface.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\ClickableInterface;
+use Symfony\Component\Form\FormInterface;
+
+/**
+ * @author Yonel Ceruto <[email protected]>
+ */
+interface ButtonFlowInterface extends FormInterface, ClickableInterface
+{
+    /**
+     * Executes the callable handler.
+     */
+    public function handle(): void;
+
+    /**
+     * Checks if the callable handler was already called.
+     */
+    public function isHandled(): bool;
+
+    /**
+     * Checks if the button's action is 'reset'.
+     */
+    public function isResetAction(): bool;
+
+    /**
+     * Checks if the button's action is 'previous'.
+     */
+    public function isPreviousAction(): bool;
+
+    /**
+     * Checks if the button's action is 'next'.
+     */
+    public function isNextAction(): bool;
+
+    /**
+     * Checks if the button's action is 'finish'.
+     */
+    public function isFinishAction(): bool;
+
+    /**
+     * Checks if the button is configured to clear submission data.
+     */
+    public function isClearSubmission(): bool;
+}

Flow/ButtonFlowTypeInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Flow;
+
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A type that should be converted into a {@link ButtonFlow} instance.
+ *
+ * @author Yonel Ceruto <[email protected]>
+ */
+interface ButtonFlowTypeInterface extends FormTypeInterface
+{
+}