Merge pull request #108 from bangnokia/main

add forStepClass method to get state more convenient
spatie · Feb 21, 2024 · 0f020ed · 0f020ed
2 parents 9c80e5a + 518053a
commit 0f020ed
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/usage/accessing-state.md b/docs/usage/accessing-state.md
@@ -15,13 +15,15 @@ On that state object you can call these methods:
 
 - `all()`: returns an array containing the values of all public properties of all steps in the wizard. The key of the items in the array is the name of the step. Optionally, you can pass is a key name to let the function only return the value for that key.
 - `forStep($stepname)`:  returns the values of all public properties of the given step.
+- `forStepClass(StepComponent::class)`: similar to `forStep`, but you can pass in the class name of the step component.
 - `currentStep()`: returns an array containing the values of all public properties of the current step. The result is almost identical to Livewire's native `all()` method, but with some internal properties filtered out.
 
 ```php
 // in a step component
 
 $this->state()->all(); // returns all state from all steps in the wizard
 $this->state()->forStep('delivery-address-step'); // returns all state of the given step
+$this->state()->forStepClass(App\Livewire\DevliveryAddressStep::class);
 $this->state()->currentStep(); // returns all state of the current step
 ```
 

diff --git a/src/Support/State.php b/src/Support/State.php
@@ -3,6 +3,7 @@
 namespace Spatie\LivewireWizard\Support;
 
 use Illuminate\Support\Arr;
+use Livewire\Mechanisms\ComponentRegistry;
 
 class State
 {
@@ -34,6 +35,13 @@ public function forStep(string $stepName): array
         return $state;
     }
 
+    public function forStepClass(string $stepClass): array
+    {
+        $stepName = app(ComponentRegistry::class)->getName($stepClass);
+
+        return $this->forStep($stepName);
+    }
+
     public function get(string $key)
     {
         return Arr::get($this->allState, $key);

diff --git a/tests/StateClassTest.php b/tests/StateClassTest.php
@@ -47,5 +47,8 @@
             $livewireComponent = $testableLivewire->instance();
             $state = $livewireComponent->state()->forStep('first-step');
             expect($state['order'])->toBe(1029);
+
+            $state = $livewireComponent->state()->forStepClass(FirstStepComponent::class);
+            expect($state['order'])->toBe(1029);
         });
 });
diff --git a/tests/__snapshots__/WizardTest__it_has_a_steps_property_to_render_navigation__1.html b/tests/__snapshots__/WizardTest__it_has_a_steps_property_to_render_navigation__1.html
@@ -1,12 +1,12 @@
 <html><body><div id="navigation">
         This is navigation
         <ul>
-            <!-- __BLOCK__ -->                In step
+            <!--[if BLOCK]><![endif]-->                In step
                 <li class="" wire:click="showStep('first-step')">First step</li>
                             In step
                 <li class="text-bold">Second step</li>
                             In step
                 <li class="">Third step</li>
-             <!-- __ENDBLOCK__ -->
+            <!--[if ENDBLOCK]><![endif]-->
         </ul>
     </div></body></html>