From a9b8ea6f2bfa974be4fd22a073a3488be714c63b Mon Sep 17 00:00:00 2001
From: Arman <407448+armanist@users.noreply.github.com>
Date: Wed, 13 May 2026 16:01:48 +0400
Subject: [PATCH] [#516] Standardize middleware validation rule signatures

---
 CHANGELOG.md                                             | 1 +
 .../Templates/DemoApi/src/Middlewares/Activate.php.tpl   | 2 +-
 .../DemoApi/src/Middlewares/BaseMiddleware.php.tpl       | 9 +++------
 .../Templates/DemoApi/src/Middlewares/Comment.php.tpl    | 2 +-
 .../Templates/DemoApi/src/Middlewares/Editor.php.tpl     | 2 +-
 .../Templates/DemoApi/src/Middlewares/Password.php.tpl   | 2 +-
 .../Templates/DemoApi/src/Middlewares/Signup.php.tpl     | 2 +-
 .../Templates/DemoApi/src/Middlewares/Update.php.tpl     | 2 +-
 .../Templates/DemoApi/src/Middlewares/Verify.php.tpl     | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Activate.php.tpl   | 2 +-
 .../DemoWeb/src/Middlewares/BaseMiddleware.php.tpl       | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Comment.php.tpl    | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Editor.php.tpl     | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Forget.php.tpl     | 6 ++----
 .../Templates/DemoWeb/src/Middlewares/Password.php.tpl   | 2 +-
 .../Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl  | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Resend.php.tpl     | 5 ++---
 .../Templates/DemoWeb/src/Middlewares/Signup.php.tpl     | 2 +-
 .../Templates/DemoWeb/src/Middlewares/Update.php.tpl     | 6 ++----
 .../Templates/DemoWeb/src/Middlewares/Verify.php.tpl     | 2 +-
 20 files changed, 25 insertions(+), 32 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 215f7350..6df212f9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -80,6 +80,7 @@
 - Fixed deprecated `E_STRICT` constant usage in test bootstrap
 - Fixed cURL error message assertions for cross-version compatibility
 - Fixed SleekDB paginator query-state regression where `count()` could clear criteria before paginated data fetch on the same model instance (#514)
+- Standardized `defineValidationRules(Request $request): void` across DemoWeb and DemoApi middleware templates
 
 ### Added
 - `AppContext` class representing the runtime identity of a single application execution
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl
index d1e9f53b..e09347f0 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Activate.php.tpl
@@ -44,7 +44,7 @@ class Activate extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'token' => [
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl
index c49fec71..33ff31d2 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/BaseMiddleware.php.tpl
@@ -14,9 +14,9 @@
 
 namespace {{MODULE_NAMESPACE}}\Middlewares;
 
-use Quantum\Validation\Validator;
 use Quantum\Http\Enums\StatusCode;
 use Quantum\Middleware\Middleware;
+use Quantum\Validation\Validator;
 use Quantum\Http\Response;
 use Quantum\Http\Request;
 use Closure;
@@ -42,7 +42,7 @@ abstract class BaseMiddleware extends Middleware
     /**
      * Define validation rules specific to middleware.
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         // default no-op: subclasses override if needed
     }
@@ -62,10 +62,7 @@ abstract class BaseMiddleware extends Middleware
     /**
      * Handles error response logic.
      */
-    protected function respondWithError(Request $request,
-        $message,
-        int $status = StatusCode::UNPROCESSABLE_ENTITY
-    ): Response
+    protected function respondWithError(Request $request, $message, int $status = StatusCode::UNPROCESSABLE_ENTITY): Response
     {
         return response()->json([
             'status' => 'error',
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl
index abd87ab0..cc708552 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Comment.php.tpl
@@ -37,7 +37,7 @@ class Comment extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'content' => [
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl
index 18a1f93e..6f3f5e46 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Editor.php.tpl
@@ -63,7 +63,7 @@ class Editor extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         if ($request->hasFile('image')) {
             $this->validator->setRules([
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl
index 3dc1683f..075bb2cc 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Password.php.tpl
@@ -41,7 +41,7 @@ class Password extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->registerCustomRules($request);
 
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl
index 746ca6b4..6d8e8696 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Signup.php.tpl
@@ -38,7 +38,7 @@ class Signup extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'email' => [
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl
index 20c78f78..1334fb19 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Update.php.tpl
@@ -39,7 +39,7 @@ class Update extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'firstname' => [
diff --git a/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl b/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl
index a6214374..2750ed2a 100644
--- a/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl
+++ b/src/Module/Templates/DemoApi/src/Middlewares/Verify.php.tpl
@@ -40,7 +40,7 @@ class Verify extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'otp' => [
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl
index 5b49131e..15c1f44c 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Activate.php.tpl
@@ -45,7 +45,7 @@ class Activate extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'token' => [
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl
index 54565e98..cc4f9be2 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/BaseMiddleware.php.tpl
@@ -49,7 +49,7 @@ abstract class BaseMiddleware extends Middleware
     /**
      * Define validation rules specific to middleware.
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         // default no-op: subclasses override if needed
     }
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl
index 703bba01..61d441d0 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Comment.php.tpl
@@ -37,7 +37,7 @@ class Comment extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'content' => [
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl
index 2f3c362a..837c0ad9 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Editor.php.tpl
@@ -59,7 +59,7 @@ class Editor extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         if ($request->hasFile('image')) {
             $this->validator->setRules([
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl
index f213b104..dadc94bb 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Forget.php.tpl
@@ -40,7 +40,7 @@ class Forget extends BaseMiddleware
     /**
      * Define validation rules
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'email' => [
@@ -54,9 +54,7 @@ class Forget extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function respondWithError(Request $request,
-        $message
-    ): Response
+    protected function respondWithError(Request $request, $message): Response
     {
         $data = $request->all();
 
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl
index 37d41614..d7267e38 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Password.php.tpl
@@ -41,7 +41,7 @@ class Password extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->registerCustomRules($request);
 
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl
index 5347a80c..b22fc5fa 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/PostOwner.php.tpl
@@ -43,7 +43,7 @@ class PostOwner extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->registerCustomRules();
 
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl
index 350a5aba..90e4ac6d 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Resend.php.tpl
@@ -53,9 +53,8 @@ class Resend extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function respondWithError(Request $request,
-        $message,
-    ): Response {
+    protected function respondWithError(Request $request, $message): Response
+    {
         session()->setFlash('error', $message);
         return redirect(base_url(true) . '/' . current_lang() . '/signin');
     }
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl
index 7886aa78..7fbbe708 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Signup.php.tpl
@@ -49,7 +49,7 @@ class Signup extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'email' => [
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl
index 40bf6c2f..ad254988 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Update.php.tpl
@@ -39,7 +39,7 @@ class Update extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'firstname' => [
@@ -54,9 +54,7 @@ class Update extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function respondWithError(Request $request,
-        $message
-    ): Response
+    protected function respondWithError(Request $request, $message): Response
     {
         session()->setFlash('error', $message);
         return redirectWith(base_url(true) . '/' . current_lang() . '/account-settings#account_profile', $request->all());
diff --git a/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl b/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl
index 0a0dd16c..8e05011d 100644
--- a/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl
+++ b/src/Module/Templates/DemoWeb/src/Middlewares/Verify.php.tpl
@@ -43,7 +43,7 @@ class Verify extends BaseMiddleware
     /**
      * @inheritDoc
      */
-    protected function defineValidationRules(Request $request)
+    protected function defineValidationRules(Request $request): void
     {
         $this->validator->setRules([
             'otp' => [