Support redirection passing parameters

ycs77 · Sep 17, 2024 · 6b6d725 · 6b6d725
1 parent 0faffdf
commit 6b6d725
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 13 deletions.
diff --git a/src/Wizard.php b/src/Wizard.php
@@ -192,9 +192,10 @@ public function getActionUrl(string $method, $parameters = [])
      *
      * @param  string|\Ycs77\LaravelWizard\Step|null  $step
      * @param  bool  $setLastIndex
+     * @param  array  $parameters
      * @return \Illuminate\Http\RedirectResponse
      */
-    public function redirectToStep($step = null, $setLastIndex = true)
+    public function redirectToStep($step = null, $setLastIndex = true, array $parameters = [])
     {
         if (is_null($step)) {
             $step = $this->stepRepo()->next();
@@ -206,7 +207,7 @@ public function redirectToStep($step = null, $setLastIndex = true)
             $this->setLastProcessedIndex($step->index());
         }
 
-        return redirect($this->getActionUrl('create', [$step->slug()]));
+        return redirect($this->getActionUrl('create', ['step' => $step->slug(), ...$parameters]));
     }
 
     /**

diff --git a/src/Wizardable.php b/src/Wizardable.php
@@ -5,6 +5,7 @@
 use Closure;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
 
 trait Wizardable
 {
@@ -31,14 +32,21 @@ trait Wizardable
      */
     public function create(Request $request, $step = null)
     {
+        // Get the query parameters.
+        $parameters = $request->query();
+        unset($parameters['_trigger']);
+        $resetParam = Arr::pull($parameters, '_reset');
+
         // Reset the wizard cache when passing the `_reset` query parameter.
-        if ($request->query('_reset') === '1') {
+        if ($resetParam === '1') {
             $this->wizard()->cache()->clear();
 
             // Clean up the wizard event.
             $this->cleanUpWizard($request);
 
-            return $this->redirectToLastProcessedStep($request, 0);
+            return $this->redirectToLastProcessedStep(
+                $request, 0, $parameters
+            );
         }
 
         // Before wizard step create event.
@@ -51,7 +59,7 @@ public function create(Request $request, $step = null)
         // If step is null, redirect to last processed index.
         if (is_null($step)) {
             return $this->redirectToLastProcessedStep(
-                $request, $lastProcessedIndex
+                $request, $lastProcessedIndex, $parameters
             );
         }
 
@@ -61,7 +69,7 @@ public function create(Request $request, $step = null)
         if ($step->index() !== $lastProcessedIndex) {
             // Redirect to last processed step.
             return $this->redirectToLastProcessedStep(
-                $request, $lastProcessedIndex
+                $request, $lastProcessedIndex, $parameters
             );
         }
 
@@ -202,13 +210,14 @@ protected function renderDoneView(Request $request)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  int  $lastProcessedIndex
+     * @param  array  $parameters
      * @return \Illuminate\Http\RedirectResponse
      */
-    protected function redirectToLastProcessedStep(Request $request, int $lastProcessedIndex)
+    protected function redirectToLastProcessedStep(Request $request, int $lastProcessedIndex, array $parameters = [])
     {
         $lastProcessedStep = $this->wizard()->stepRepo()->get($lastProcessedIndex);
 
-        return $this->redirectToStep($lastProcessedStep->slug(), false);
+        return $this->redirectToStep($lastProcessedStep->slug(), false, $parameters);
     }
 
     /**
@@ -227,11 +236,12 @@ protected function canValidate(Request $request)
      *
      * @param  string|\Ycs77\LaravelWizard\Step|null  $step
      * @param  bool  $setLastIndex
+     * @param  array  $parameters
      * @return \Illuminate\Http\RedirectResponse
      */
-    protected function redirectToStep($step = null, $setLastIndex = true)
+    protected function redirectToStep($step = null, $setLastIndex = true, array $parameters = [])
     {
-        return $this->wizard()->redirectToStep($step, $setLastIndex);
+        return $this->wizard()->redirectToStep($step, $setLastIndex, $parameters);
     }
 
     /**
@@ -241,11 +251,12 @@ protected function redirectToStep($step = null, $setLastIndex = true)
      *
      * @param  string|\Ycs77\LaravelWizard\Step|null  $step
      * @param  bool  $setLastIndex
+     * @param  array  $parameters
      * @return \Illuminate\Http\RedirectResponse
      */
-    protected function redirectTo($step = null, $setLastIndex = true)
+    protected function redirectTo($step = null, $setLastIndex = true, array $parameters = [])
     {
-        return $this->redirectToStep($step, $setLastIndex);
+        return $this->redirectToStep($step, $setLastIndex, $parameters);
     }
 
     /**

diff --git a/tests/Unit/WizardTest.php b/tests/Unit/WizardTest.php
@@ -197,7 +197,7 @@ public function testRedirectToOtherStep()
         $this->wizard->setStepRepo($stepRepo);
 
         $this->wizard->resolveActionUrlUsing(function (string $method, $parameters = []) {
-            return url('/wizard/test-wizard/'.$parameters[0]);
+            return url('/wizard/test-wizard/'.$parameters['step']);
         });
 
         // act