[6.x] Forms 2: Multi-page forms & SubmitForm action

config/forms.php

@@ -40,13 +40,16 @@
     | Partial Submissions
     |--------------------------------------------------------------------------
     |
-    | Partial submissions are automatically deleted after a set number
-    | of days. Set this to null to prevent their automatic deletion.
+    | Partial submissions are automatically deleted after a set number of days.
+    | Set this to null to prevent their automatic deletion. You may also enable
+    | garbage collection to delete related assets at the same time.
     |
     */
 
     'delete_partial_submissions_after' => 7,
 
+    'garbage_collect_assets' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Exporters

routes/web.php

@@ -27,6 +27,7 @@
 use Statamic\Http\Middleware\AuthGuard;
 use Statamic\Http\Middleware\CP\AuthGuard as CPAuthGuard;
 use Statamic\Http\Middleware\CP\HandleInertiaRequests;
+use Statamic\Http\Middleware\HandleFormPrecognitiveRequests;
 use Statamic\Http\Middleware\RedirectIfTwoFactorSetupIncomplete;
 use Statamic\Http\Middleware\RequireElevatedSession;
 use Statamic\Statamic;
@@ -36,7 +37,7 @@
 
 Route::name('statamic.')->group(function () {
     Route::group(['prefix' => config('statamic.routes.action')], function () {
-        Route::post('forms/{form}', [FormController::class, 'submit'])->middleware([HandlePrecognitiveRequests::class, 'throttle:statamic.forms'])->name('forms.submit');
+        Route::post('forms/{form}', [FormController::class, 'submit'])->middleware([HandleFormPrecognitiveRequests::class, 'throttle:statamic.forms'])->name('forms.submit');
 
         Route::get('protect/password', [PasswordProtectController::class, 'show'])->name('protect.password.show')->middleware([HandleInertiaRequests::class]);
         Route::post('protect/password', [PasswordProtectController::class, 'store'])->name('protect.password.store');

src/Exceptions/SilentFormFailureException.php

@@ -2,7 +2,17 @@
 
 namespace Statamic\Exceptions;
 
+use Statamic\Contracts\Forms\Submission;
+
 class SilentFormFailureException extends \Exception
 {
-    //
+    public function __construct(protected ?Submission $submission = null)
+    {
+        parent::__construct();
+    }
+
+    public function submission(): ?Submission
+    {
+        return $this->submission;
+    }
 }

src/Forms/Fields/FormFields.php

@@ -35,12 +35,13 @@ public function contents(): array
 
     public function pages(): Collection
     {
-        if (isset($this->contents['pages'])) {
-            return collect($this->contents['pages']);
-        }
+        $pages = isset($this->contents['pages'])
+            ? collect($this->contents['pages'])
+            : collect([['sections' => $this->contents['sections'] ?? []]]);
 
-        return collect([
-            ['sections' => $this->contents['sections'] ?? []],
+        return $pages->map(fn (array $page, int $index): array => [
+            ...$page,
+            'id' => $page['id'] ?? ($pages->count() === 1 ? 'main' : 'page_'.($index + 1)),
         ]);
     }
 
@@ -78,8 +79,6 @@ public function toBlueprint(): Blueprint
     {
         $tabs = $this->pages()
             ->mapWithKeys(function (array $page, int $index): array {
-                $id = $page['id'] ?? ($this->pages()->count() === 1 ? 'main' : 'page_'.($index + 1));
-
                 $sections = collect($page['sections'] ?? [])
                     ->map(function (array $section): array {
                         return [
@@ -105,8 +104,8 @@ public function toBlueprint(): Blueprint
                     ->all();
 
                 return [
-                    $id => [
-                        ...$page,
+                    $page['id'] => [
+                        ...Arr::except($page, 'id'),
                         'display' => $page['display'] ?? __('Page :current of :total', ['current' => $index + 1, 'total' => $this->pages()->count()]),
                         'sections' => $sections,
                     ],

src/Forms/Form.php

@@ -218,6 +218,15 @@ private function convertFieldsFromBlueprint(Blueprint $blueprint): array
         return ['sections' => $sections];
     }
 
+    public function hasMultiplePages(): bool
+    {
+        if (! Statamic::formsProInstalled()) {
+            return false;
+        }
+
+        return $this->formFields()->pages()->count() > 1;
+    }
+
     /**
      * Get the blueprint.
      *

src/Forms/JsDrivers/AbstractJsDriver.php

@@ -76,6 +76,18 @@ public function addToRenderableFieldAttributes($field)
         return [];
     }
 
+    /**
+     * Add to renderable page view data.
+     *
+     * @param  \Statamic\Fields\Tab  $page
+     * @param  array  $data
+     * @return array
+     */
+    public function addToRenderablePageData($page, $data)
+    {
+        return [];
+    }
+
     /**
      * Render form html.
      *

src/Forms/JsDrivers/JsDriver.php

@@ -10,6 +10,8 @@ public function addToFormAttributes();
 
     public function addToRenderableFieldData($field, $data);
 
+    // public function addToRenderablePageData($page, array $data): array;
+
     public function addToRenderableFieldAttributes($field);
 
     public function render($html);

src/Forms/Logic/PageLogic.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace Statamic\Forms\Logic;
+
+use Illuminate\Support\Collection;
+use Statamic\Contracts\Forms\Form;
+use Statamic\Support\Arr;
+
+class PageLogic
+{
+    private ?Collection $pages = null;
+
+    public function __construct(private readonly Form $form)
+    {
+    }
+
+    public function path(array $data): array
+    {
+        return $this->buildPath($data, null);
+    }
+
+    public function pathTo(array $data, string $page): array
+    {
+        return $this->buildPath($data, $page);
+    }
+
+    private function buildPath(array $data, ?string $until): array
+    {
+        $path = [];
+        $pageId = Arr::get($this->pages()->first(), 'id');
+
+        // The "not in path" guard stops a cyclical rule from looping forever.
+        while ($pageId !== null && ! in_array($pageId, $path, true)) {
+            $path[] = $pageId;
+
+            if ($pageId === $until) {
+                break;
+            }
+
+            $pageId = $this->nextPage($pageId, $data);
+        }
+
+        return $path;
+    }
+
+    public function nextPage(string $currentPageId, array $data): ?string
+    {
+        $pages = $this->pages();
+        $currentIndex = $pages->search(fn (array $page): bool => $page['id'] === $currentPageId);
+
+        if ($currentIndex === false) {
+            return null;
+        }
+
+        if ($destination = $this->matchingDestination($pages->get($currentIndex), $data)) {
+            return $destination;
+        }
+
+        $nextPage = $pages->get($currentIndex + 1);
+
+        return $nextPage ? $nextPage['id'] : null;
+    }
+
+    public function isFinalPage(string $currentPageId, array $data): bool
+    {
+        return $this->nextPage($currentPageId, $data) === null;
+    }
+
+    private function matchingDestination(array $page, array $data): ?string
+    {
+        $evaluator = new RuleEvaluator;
+
+        foreach ($page['rules'] ?? [] as $rule) {
+            $destination = $rule['destination'] ?? null;
+
+            if (! $destination || ! $this->pageExists($destination)) {
+                continue;
+            }
+
+            if ($evaluator->passes($rule['conditions'] ?? [], $data)) {
+                return $destination;
+            }
+        }
+
+        return null;
+    }
+
+    private function pageExists(string $id): bool
+    {
+        return $this->pages()->contains(fn (array $page): bool => $page['id'] === $id);
+    }
+
+    private function pages(): Collection
+    {
+        return $this->pages ??= $this->form->formFields()->pages();
+    }
+}