added method, method parameters and return type

ahmetbarut · Nov 27, 2021 · 30f25a2 · 30f25a2
1 parent 6e926b6
commit 30f25a2
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 8 deletions.
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
         }
     ],
     "require": {
-        "php": "7.4 || >=8",
+        "php": ">=7.4 || 8.*",
         "laravel/framework": ">=v8.0.0"
     },
     "extra": {

diff --git a/src/Matcher.php b/src/Matcher.php
@@ -3,6 +3,8 @@
 namespace AhmetBarut\LaravelRouteDocs;
 
 use Illuminate\Routing\Router;
+use ReflectionMethod;
+use ReflectionParameter;
 
 class Matcher
 {
@@ -27,7 +29,6 @@ public function getDetails(): array
 
         foreach ($this->route->getRoutes()->getRoutes() as $route) {
 
-
             if ($route->getPrefix() !== '_ignition')
             {
                 if ($route->getAction('controller') === null)
@@ -50,13 +51,18 @@ public function getDetails(): array
                         'prefix' => $route->getAction('prefix'),
                     ],
                     'comment' => $this->getDocComment($reflection->getDocComment()),
+                    'method' => [
+                        'name' => $reflection->getName(),
+                        'parameters' => $this->getParameters($reflection->getParameters()),
+                        'return' => $reflection->getReturnType(),
+                    ],
                 ];
             }
         }
         return $array;
     }
 
-    public function getDocComment($text): mixed
+    public function getDocComment($text)
     {
         preg_match_all('/[a-zA-Z0-9öÖçÇğĞİşŞüÜı\@\-_\\\\]+/mu', $text, $res);
         return preg_replace_callback('#@route-doc(.*)@end-doc#', function ($matched){
@@ -71,4 +77,24 @@ public function resolve(string $namespace)
         $this->resolveMethod = $explode[1];
     }
 
+    public function getParameters(array $parameters): array
+    {
+        $array = [];
+        foreach ($parameters as $parameter) {
+            $array[] = [
+                'name' => $parameter->getName(),
+                'type' => $parameter->getType()->getName(),
+                'isOptional' => $parameter->isOptional(),
+                'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
+            ];
+        }
+        return $array;
+    }
+
+    public function getReturn($reflection): array
+    {
+        return [
+            'type' => $reflection->getName(),
+        ];
+    }
 }
diff --git a/src/RouteDocsCommand.php b/src/RouteDocsCommand.php
@@ -44,7 +44,9 @@ public function __construct(Router $route)
     public function handle()
     {
         $path = $this->argument('path') ?? './docs/routes.md';
-
+        if (!is_dir(dirname($path))) {
+            mkdir(dirname($path), 0777, false);
+        }
         $matcher = new Markdown();
         $matcher->write($this->routes->getDetails(), $path);
 

diff --git a/src/Template/Markdown.php b/src/Template/Markdown.php
@@ -19,9 +19,11 @@ public function write($data, $path = './docs/routes.md')
             $text = $stubText;
             $text = $this->replaceRouteName(trim($route['name']) ?? 'Undefined', $text);
             $text = $this->replaceRouteUri(trim($route['uri']), $text);
-            $text = $this->replaceRouteMethod(trim(implode(', ', $route['methods'])), $text);
+            $text = $this->replaceRouteRequestMethod(trim(implode(', ', $route['methods'])), $text);
             $text = $this->replaceRouteDescription(trim($route['comment']), $text);
-
+            $text = $this->replaceMethod($route['method']['name'], $text);
+            $text = $this->replaceParameter($route['method']['parameters'], $text);
+            $text = $this->replaceReturnType($route['method']['return'], $text);
             $allText .= $text;
          }
         file_put_contents($path, $allText);
@@ -70,8 +72,30 @@ public function replaceRouteDescription($replace, $text, string $search = '{{des
      * @param string $search
      * @return array|string|string[]
      */
-    public function replaceRouteMethod($replace, $text, string $search = '{{method}}')
+    public function replaceRouteRequestMethod($replace, $text, string $search = '{{RequestMethod}}')
+    {
+        return str_replace($search, $replace, $text);
+    }
+
+    public function replaceMethod($replace, $text, string $search = '{{method}}')
+    {
+        return str_replace($search, $replace, $text);
+    }
+
+    public function replaceParameter($replace, $text, string $search = '{{parameters}}')
+    {
+        $param = "";
+        foreach ($replace as $parameter) {
+            $param = "({$parameter['type']} \${$parameter['name']})";
+        }
+        return str_replace($search, $param, $text);
+    }
+
+    public function replaceReturnType($replace, $text, string $search = '{{return_type}}')
     {
+        if ($replace !== null) {
+            return str_replace($search, ': ' . $replace, $text);
+        }
         return str_replace($search, $replace, $text);
     }
 }
diff --git a/src/stubs.md b/src/stubs.md
@@ -1,6 +1,7 @@
 ### # {{route_name}}
 #### # {{uri}}
-#### # {{method}}
+#### # {{RequestMethod}}
+#### # {{method}} {{parameters}} {{return_type}}
 {{description}}
 
 ---------------------------