Merge pull request #64 from Mdhesari/custom-params

Custom param rules and make lrd documents available for all route methods

Author: kevincobain2000

README.md

@@ -119,6 +119,26 @@ Example of using it in controller
     {
 ```
 
+# Custom Params
+
+You write extra params with rules with @QAparam comment line
+
+```php
+    /**
+     * @QAparam search string
+     */
+    public function index(MyIndexRequest $request): Resource
+    {
+```
+
+```php
+    /**
+     * @QAparam search string nullable max:32
+     */
+    public function index(MyIndexRequest $request): Resource
+    {
+```
+
 # Testing
 
 ```bash

src/LaravelRequestDocs.php

@@ -117,6 +117,7 @@ public function appendRequestRules(array $controllersInfo)
             $method           = $controllerInfo['method'];
             $reflectionMethod = new ReflectionMethod($controller, $method);
             $params           = $reflectionMethod->getParameters();
+            $customRules = $this->customParamsDocComment($reflectionMethod->getDocComment());
 
             foreach ($params as $param) {
                 if (!$param->getType()) {
@@ -144,8 +145,14 @@ public function appendRequestRules(array $controllersInfo)
                             throw $e;
                         }
                     }
-                    $controllersInfo[$index]['docBlock'] = $this->lrdDocComment($reflectionMethod->getDocComment());
                 }
+
+                $controllersInfo[$index]['docBlock'] = $this->lrdDocComment($reflectionMethod->getDocComment());
+
+                $controllersInfo[$index]['rules'] = array_merge(
+                    $controllersInfo[$index]['rules'] ?? [],
+                    $customRules,
+                );
             }
         }
         return $controllersInfo;
@@ -236,4 +243,23 @@ public function rulesByRegex($requestClassName)
 
         return $rules;
     }
+
+    private function customParamsDocComment($docComment): array
+    {
+        $params = [];
+
+        foreach (explode("\n", $docComment) as $comment) {
+            if ( Str::contains($comment, '@QAparam') ) {
+                $comment = trim(Str::replace(['@QAparam', '*'], '', $comment));
+
+                $comment = explode(' ', $comment);
+
+                if (count($comment) > 0) {
+                    $params[$comment[0]] = array_values(array_filter($comment, fn($item) => $item != $comment[0]));
+                }
+            }
+        }
+
+        return $params;
+    }
 }