Fixes for FormBuilder validation to match expected behaviour as described in the docs (#373)

Co-authored-by: Pascal Baljet <[email protected]>

Author: Johan Montenij

app/app/Http/Controllers/FormBuilderController.php

@@ -44,7 +44,7 @@ public function simple()
 
     public function storeSimple(Request $request)
     {
-        $result = $this->simpleForm()->validate($request);
+        $result = $request->validate($this->simpleForm()->getRules());
 
         return response()->json(['result' => $result]);
     }
@@ -80,11 +80,9 @@ public function model()
         ]);
     }
 
-    public function storeModel(Request $request)
+    public function storeModel(Request $request, ModelbindingForm $form)
     {
-        $rules = ModelbindingForm::make()->getRules();
-
-        $result = $request->validate($rules);
+        $result = $form->validate($request);
 
         return response()->json(['result' => $result]);
     }

src/AbstractForm.php

@@ -2,6 +2,8 @@
 
 namespace ProtoneMedia\Splade;
 
+use Illuminate\Http\Request;
+
 abstract class AbstractForm
 {
     /**
@@ -10,7 +12,7 @@ abstract class AbstractForm
     private ?SpladeForm $for = null;
 
     /**
-     * Adds fields to the form
+     * Adds fields to the form.
      */
     public function fields(): array
     {
@@ -30,7 +32,7 @@ public static function make(...$arguments): SpladeForm
     }
 
     /**
-     * Creates a new SpladeForm instance from the 'build()' method of this class
+     * Creates a new SpladeForm instance from the 'build()' method of this class.
      */
     public function build(): SpladeForm
     {
@@ -59,12 +61,25 @@ public function configure(SpladeForm $form)
     }
 
     /**
-     * Get the rules that are configured for the form
+     * Get the rules that are configured for the form.
      *
      * @param  mixed  ...$arguments
      */
     public static function rules(...$arguments): array
     {
         return self::make(...$arguments)->getRules();
     }
+
+    /**
+     * Validate the request with the rules of the form.
+     *
+     * @param  mixed  ...$params
+     */
+    public function validate(?Request $request = null, ...$params): array
+    {
+        /** @var Request */
+        $request = $request ?? request();
+
+        return $this->build()->validate($request, ...$params);
+    }
 }

src/SpladeForm.php

@@ -2,14 +2,15 @@
 
 namespace ProtoneMedia\Splade;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 
 class SpladeForm
 {
     protected ?AbstractForm $configurator = null;
 
-    protected $data = [];
+    protected array|Model $data = [];
 
     protected array $fields = [];
 
@@ -51,7 +52,7 @@ public function setConfigurator(AbstractForm $configurator): self
     }
 
     /**
-     * Sets the id for the form
+     * Sets the id for the form.
      *
      * @return $this
      */
@@ -63,7 +64,7 @@ public function id(string $id = ''): self
     }
 
     /**
-     * Sets the action for the form
+     * Sets the action for the form.
      *
      * @return $this
      */
@@ -75,7 +76,7 @@ public function action(string $action = 'POST'): self
     }
 
     /**
-     * Add css-class(es) to the form
+     * Add css-class(es) to the form.
      *
      * @return $this
      */
@@ -112,7 +113,7 @@ public function confirm(
     }
 
     /**
-     * Sets the values for the form fields
+     * Sets the values for the form fields.
      *
      * @return $this
      */
@@ -124,7 +125,7 @@ public function fill($data): self
     }
 
     /**
-     * Adds fields to the form
+     * Adds fields to the form.
      *
      * @return $this
      */
@@ -136,7 +137,7 @@ public function fields(array $fields = []): self
     }
 
     /**
-     * Prevent the page from scrolling to the top after submit
+     * Prevent the page from scrolling to the top after submit.
      *
      * @param  bool  $stay
      * @return $this
@@ -149,9 +150,9 @@ public function preserveScroll(bool $preserve_scroll = true): self
     }
 
     /**
-     * Require the user to confirm their password within the confirmation dialog
+     * Require the user to confirm their password within the confirmation dialog.
      *
-     * Add `Route::spladePasswordConfirmation();` to your routes to make this work
+     * Add `Route::spladePasswordConfirmation();` to your routes to make this work.
      *
      * @return $this
      */
@@ -175,7 +176,7 @@ public function requirePassword(
     }
 
     /**
-     * Prevent navigation on submit
+     * Prevent navigation on submit.
      *
      * @param  string  $actionOnSuccess reset|restore
      * @return $this
@@ -194,7 +195,7 @@ public function stay(bool $stay = true, string $actionOnSuccess = ''): self
      * Submit the form whenever a value changes.
      *
      * If one or morge fieldnames are provided in $watch_fields,
-     * the form will only be submitted on changes on these fields
+     * the form will only be submitted on changes on these fields.
      *
      * @param  array|string|null  $watchFields
      * @return $this
@@ -213,7 +214,7 @@ public function submitOnChange(
     }
 
     /**
-     * Set the method of the form
+     * Set the method of the form.
      *
      * @return $this
      */
@@ -225,63 +226,63 @@ public function method(string $method = 'POST'): self
     }
 
     /**
-     * Returns the id for the form
+     * Returns the id for the form.
      */
     public function getId(): string
     {
         return $this->id;
     }
 
     /**
-     * Returns the action for the form
+     * Returns the action for the form.
      */
     public function getAction(): string
     {
         return $this->action;
     }
 
     /**
-     * Returns the data for the form
+     * Returns the data for the form.
      */
     public function getClass(): array|string
     {
         return $this->class;
     }
 
     /**
-     * Returns the data for the form
+     * Returns the data for the form.
      */
     public function getData()
     {
         return $this->data;
     }
 
     /**
-     * Returns all fields of the form
+     * Returns all fields of the form.
      */
     public function getFields(): array
     {
         return $this->fields;
     }
 
     /**
-     * Returns the method for the form
+     * Returns the method for the form.
      */
     public function getMethod(): string
     {
         return $this->method;
     }
 
     /**
-     * Return an option for the form arguments
+     * Return an option for the form arguments.
      */
     public function getOption(string $option): array|bool|string|null
     {
         return $this->options[$option] ?? false;
     }
 
     /**
-     * Returns the forms rules
+     * Returns the forms rules.
      */
     public function getRules(): array
     {
@@ -295,6 +296,7 @@ public function getRules(): array
      */
     public function validate(?Request $request = null, ...$params): array
     {
+        /** @var Request */
         $request = $request ?? request();
 
         return $request->validate($this->getRules(), ...$params);