Support additional methods in custom form requests (#169)

Author: duncanmcclean

src/Exceptions/FormRequestDoesNotExist.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace DuncanMcClean\Cargo\Exceptions;
+
+use Exception;
+
+class FormRequestDoesNotExist extends Exception
+{
+    //
+}

src/Http/Requests/Cart/AddLineItemRequest.php

@@ -3,26 +3,16 @@
 namespace DuncanMcClean\Cargo\Http\Requests\Cart;
 
 use DuncanMcClean\Cargo\Facades\Product;
-use DuncanMcClean\Cargo\Http\Requests\Concerns\AcceptsCustomFormRequests;
-use Illuminate\Foundation\Http\FormRequest;
+use DuncanMcClean\Cargo\Http\Requests\CustomizableFormRequest;
 use Illuminate\Support\Traits\Localizable;
 use Illuminate\Validation\Rule;
 use Statamic\Facades\Site;
 
-class AddLineItemRequest extends FormRequest
+class AddLineItemRequest extends CustomizableFormRequest
 {
-    use AcceptsCustomFormRequests, Localizable;
+    use Localizable;
 
-    public function authorize()
-    {
-        if ($this->hasCustomFormRequest()) {
-            return $this->resolveCustomFormRequest()->authorize();
-        }
-
-        return true;
-    }
-
-    public function rules()
+    public function rules(): array
     {
         if ($this->hasCustomFormRequest()) {
             return $this->resolveCustomFormRequest()->rules();

src/Http/Requests/Cart/UpdateCartRequest.php

@@ -4,23 +4,22 @@
 
 use DuncanMcClean\Cargo\Facades\Cart;
 use DuncanMcClean\Cargo\Facades\Order;
-use DuncanMcClean\Cargo\Http\Requests\Concerns\AcceptsCustomFormRequests;
+use DuncanMcClean\Cargo\Http\Requests\CustomizableFormRequest;
 use DuncanMcClean\Cargo\Rules\ValidDiscountCode;
 use Illuminate\Contracts\Validation\Validator;
-use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Traits\Localizable;
 use Illuminate\Validation\ValidationException;
 use Statamic\Exceptions\NotFoundHttpException;
 use Statamic\Facades\Site;
 use Statamic\Facades\URL;
 
-class UpdateCartRequest extends FormRequest
+class UpdateCartRequest extends CustomizableFormRequest
 {
-    use AcceptsCustomFormRequests, Localizable;
+    use Localizable;
 
     private $cachedFields;
 
-    public function authorize()
+    public function authorize(): bool
     {
         throw_if(! Cart::hasCurrentCart(), NotFoundHttpException::class);
 
@@ -31,9 +30,6 @@ public function authorize()
         return true;
     }
 
-    /**
-     * Optionally override the redirect url based on the presence of _error_redirect
-     */
     protected function getRedirectUrl()
     {
         $url = $this->redirector->getUrlGenerator();
@@ -47,8 +43,12 @@ protected function getRedirectUrl()
         return $url->previous();
     }
 
-    public function rules()
+    public function rules(): array
     {
+        if ($this->hasCustomFormRequest()) {
+            return $this->resolveCustomFormRequest()->rules();
+        }
+
         $fields = $this->getFormFields();
 
         return $fields

src/Http/Requests/Cart/UpdateLineItemRequest.php

@@ -3,17 +3,16 @@
 namespace DuncanMcClean\Cargo\Http\Requests\Cart;
 
 use DuncanMcClean\Cargo\Facades\Cart;
-use DuncanMcClean\Cargo\Http\Requests\Concerns\AcceptsCustomFormRequests;
-use Illuminate\Foundation\Http\FormRequest;
+use DuncanMcClean\Cargo\Http\Requests\CustomizableFormRequest;
 use Illuminate\Support\Traits\Localizable;
 use Statamic\Exceptions\NotFoundHttpException;
 use Statamic\Facades\Site;
 
-class UpdateLineItemRequest extends FormRequest
+class UpdateLineItemRequest extends CustomizableFormRequest
 {
-    use AcceptsCustomFormRequests, Localizable;
+    use Localizable;
 
-    public function authorize()
+    public function authorize(): bool
     {
         throw_if(! Cart::hasCurrentCart(), NotFoundHttpException::class);
 
@@ -24,7 +23,7 @@ public function authorize()
         return true;
     }
 
-    public function rules()
+    public function rules(): array
     {
         if ($this->hasCustomFormRequest()) {
             return $this->resolveCustomFormRequest()->rules();

src/Http/Requests/Concerns/AcceptsCustomFormRequests.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace DuncanMcClean\Cargo\Http\Requests;
+
+use DuncanMcClean\Cargo\Exceptions\FormRequestDoesNotExist;
+use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Foundation\Http\FormRequest;
+
+abstract class CustomizableFormRequest extends FormRequest
+{
+    private ?FormRequest $customFormRequestInstance = null;
+
+    public function authorize(): bool
+    {
+        if ($this->hasCustomFormRequest()) {
+            return $this->resolveCustomFormRequest()->authorize();
+        }
+
+        return true;
+    }
+
+    public function rules(): array
+    {
+        if ($this->hasCustomFormRequest()) {
+            return $this->resolveCustomFormRequest()->rules();
+        }
+
+        return [];
+    }
+
+    public function messages(): array
+    {
+        if ($this->hasCustomFormRequest()) {
+            return $this->resolveCustomFormRequest()->messages();
+        }
+
+        return [];
+    }
+
+    public function attributes(): array
+    {
+        if ($this->hasCustomFormRequest()) {
+            return $this->resolveCustomFormRequest()->attributes();
+        }
+
+        return [];
+    }
+
+    protected function prepareForValidation(): void
+    {
+        if (! $this->hasCustomFormRequest()) {
+            return;
+        }
+
+        $customRequest = $this->resolveCustomFormRequest();
+
+        if (method_exists($customRequest, 'prepareForValidation')) {
+            $customRequest->prepareForValidation();
+            $this->merge($customRequest->all());
+        }
+    }
+
+    public function withValidator(Validator $validator): void
+    {
+        if (! $this->hasCustomFormRequest()) {
+            return;
+        }
+
+        $customRequest = $this->resolveCustomFormRequest();
+
+        if (method_exists($customRequest, 'withValidator')) {
+            $customRequest->withValidator($validator);
+        }
+    }
+
+    protected function passedValidation(): void
+    {
+        if (! $this->hasCustomFormRequest()) {
+            return;
+        }
+
+        $customRequest = $this->resolveCustomFormRequest();
+
+        if (method_exists($customRequest, 'passedValidation')) {
+            $customRequest->passedValidation();
+        }
+    }
+
+    protected function hasCustomFormRequest(): bool
+    {
+        return $this->has('_request');
+    }
+
+    protected function resolveCustomFormRequest(): FormRequest
+    {
+        if ($this->customFormRequestInstance) {
+            return $this->customFormRequestInstance;
+        }
+
+        $formRequest = decrypt($this->input('_request'));
+
+        if (! class_exists($formRequest)) {
+            throw new FormRequestDoesNotExist("Form Request [{$formRequest}] does not exist.");
+        }
+
+        return $this->customFormRequestInstance = app($formRequest, [
+            $this->query(),
+            $this->all(),
+            $this->attributes->all(),
+            $this->cookies->all(),
+            $this->files->all(),
+            $this->server->all(),
+            $this->content,
+        ]);
+    }
+}