mpociot / laravel-apidoc-generator

src/Extracting/Strategies/BodyParameters/GetFromBodyParamTag.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
         return $this->getBodyParametersFromDocBlock($methodDocBlock->getTags());
     }
 
+    /**
+     * @param Tag[] $tags
+     */
     private function getBodyParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)

Spacing +3 added lines, -3 removed lines

@@ -54,10 +54,10 @@ 
     private function getBodyParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
             })
-            ->mapWithKeys(function (Tag $tag) {
+            ->mapWithKeys(function(Tag $tag) {
                 // Format:
                 // @bodyParam <name> <type> <"required" (optional)> <description>
                 // Examples:
@@ -82,7 +82,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseParamDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag->getContent())
+                $value = is_null($example) && !$this->shouldExcludeExample($tag->getContent())
                     ? $this->generateDummyValue($type)
                     : $example;
 

src/Extracting/Strategies/QueryParameters/GetFromQueryParamTag.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
         return $this->getQueryParametersFromDocBlock($methodDocBlock->getTags());
     }
 
+    /**
+     * @param Tag[] $tags
+     */
     private function getQueryParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)

Spacing +3 added lines, -3 removed lines

@@ -55,10 +55,10 @@ 
     private function getQueryParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'queryParam';
             })
-            ->mapWithKeys(function (Tag $tag) {
+            ->mapWithKeys(function(Tag $tag) {
                 // Format:
                 // @queryParam <name> <"required" (optional)> <description>
                 // Examples:
@@ -82,7 +82,7 @@ 
                 }
 
                 list($description, $value) = $this->parseParamDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag->getContent())) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag->getContent())) {
                     $value = Str::contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');

src/Extracting/Strategies/Responses/UseApiResourceTags.php

Doc Comments +2 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
     /**
      * Get a response from the transformer tags.
      *
-     * @param array $tags
+     * @param Tag[] $tags
      *
      * @return array|null
      */
@@ -141,7 +141,7 @@ 
     /**
      * @param string $type
      *
-     * @return Model|object
+     * @return string
      */
     protected function instantiateApiResourceModel(string $type)
     {

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 use Mpociot\Reflection\DocBlock;
 use Mpociot\Reflection\DocBlock\Tag;
 use Illuminate\Database\Eloquent\Model;
-use League\Fractal\Resource\Collection;
 use Mpociot\ApiDoc\Extracting\RouteDocBlocker;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Mpociot\ApiDoc\Extracting\Strategies\Strategy;

Spacing +3 added lines, -3 removed lines

@@ -92,7 +92,7 @@ 
                 ],
             ];
         } catch (\Exception $e) {
-            echo 'Exception thrown when fetching Eloquent API resource response for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown when fetching Eloquent API resource response for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -125,7 +125,7 @@ 
      */
     private function getClassToBeTransformed(array $tags): string
     {
-        $modelTag = Arr::first(array_filter($tags, function ($tag) {
+        $modelTag = Arr::first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'apiresourcemodel';
         }));
 
@@ -186,7 +186,7 @@ 
     private function getApiResourceTag(array $tags)
     {
         $apiResourceTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['apiresource', 'apiresourcecollection']);
             })
         );

src/Extracting/Strategies/Responses/UseTransformerTags.php

Doc Comments +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
     /**
      * Get a response from the transformer tags.
      *
-     * @param array $tags
+     * @param Tag[] $tags
      *
      * @return array|null
      */
@@ -141,7 +141,7 @@ 
     /**
      * @param string $type
      *
-     * @return Model|object
+     * @return string
      */
     protected function instantiateTransformerModel(string $type)
     {

Spacing +5 added lines, -5 removed lines

@@ -63,7 +63,7 @@ 
 
             $fractal = new Manager();
 
-            if (! is_null(config('apidoc.fractal.serializer'))) {
+            if (!is_null(config('apidoc.fractal.serializer'))) {
                 $fractal->setSerializer(app(config('apidoc.fractal.serializer')));
             }
 
@@ -82,7 +82,7 @@ 
                 ],
             ];
         } catch (\Exception $e) {
-            echo 'Exception thrown when fetching transformer response for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown when fetching transformer response for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -116,7 +116,7 @@ 
      */
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod): string
     {
-        $modelTag = Arr::first(array_filter($tags, function ($tag) {
+        $modelTag = Arr::first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
         }));
 
@@ -125,7 +125,7 @@ 
             $type = $modelTag->getContent();
         } else {
             $parameter = Arr::first($transformerMethod->getParameters());
-            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
+            if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
                 // Ladies and gentlemen, we have a type!
                 $type = (string) $parameter->getType();
             }
@@ -186,7 +186,7 @@ 
     private function getTransformerTag(array $tags)
     {
         $transformerTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
             })
         );

src/Extracting/Strategies/UrlParameters/GetFromUrlParamTag.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
         return $this->getUrlParametersFromDocBlock($methodDocBlock->getTags());
     }
 
+    /**
+     * @param Tag[] $tags
+     */
     private function getUrlParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)

Spacing +3 added lines, -3 removed lines

@@ -55,10 +55,10 @@ 
     private function getUrlParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'urlParam';
             })
-            ->mapWithKeys(function (Tag $tag) {
+            ->mapWithKeys(function(Tag $tag) {
                 // Format:
                 // @urlParam <name> <"required" (optional)> <description>
                 // Examples:
@@ -82,7 +82,7 @@ 
                 }
 
                 list($description, $value) = $this->parseParamDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag->getContent())) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag->getContent())) {
                     $value = Str::contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');

src/Writing/PostmanCollectionWriter.php

Spacing +8 added lines, -8 removed lines

@@ -40,32 +40,32 @@ 
         $collection = [
             'variables' => [],
             'info' => [
-                'name' => config('apidoc.postman.name') ?: config('app.name').' API',
+                'name' => config('apidoc.postman.name') ?: config('app.name') . ' API',
                 '_postman_id' => Uuid::uuid4()->toString(),
                 'description' => config('apidoc.postman.description') ?: '',
                 'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
             ],
-            'item' => $this->routeGroups->map(function ($routes, $groupName) {
+            'item' => $this->routeGroups->map(function($routes, $groupName) {
                 return [
                     'name' => $groupName,
                     'description' => '',
-                    'item' => $routes->map(function ($route) {
+                    'item' => $routes->map(function($route) {
                         $mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';
 
                         return [
                             'name' => $route['metadata']['title'] != '' ? $route['metadata']['title'] : url($route['uri']),
                             'request' => [
-                                'url' => url($route['uri']).(collect($route['queryParameters'])->isEmpty()
+                                'url' => url($route['uri']) . (collect($route['queryParameters'])->isEmpty()
                                         ? ''
-                                        : ('?'.implode('&', collect($route['queryParameters'])->map(function ($parameter, $key) {
-                                            return urlencode($key).'='.urlencode($parameter['value'] ?? '');
+                                        : ('?' . implode('&', collect($route['queryParameters'])->map(function($parameter, $key) {
+                                            return urlencode($key) . '=' . urlencode($parameter['value'] ?? '');
                                         })->all()))),
                                 'method' => $route['methods'][0],
                                 'header' => collect($route['headers'])
                                     ->union([
                                         'Accept' => 'application/json',
                                     ])
-                                    ->map(function ($value, $header) {
+                                    ->map(function($value, $header) {
                                         return [
                                             'key' => $header,
                                             'value' => $value,
@@ -74,7 +74,7 @@ 
                                     ->values()->all(),
                                 'body' => [
                                     'mode' => $mode,
-                                    $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
+                                    $mode => collect($route['bodyParameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => $parameter['value'] ?? '',

src/Writing/Writer.php

Spacing +20 added lines, -20 removed lines

@@ -83,8 +83,8 @@ 
      */
     public function writeMarkdownAndSourceFiles(Collection $parsedRoutes, string $sourceOutputPath)
     {
-        $targetFile = $sourceOutputPath.'/source/index.md';
-        $compareFile = $sourceOutputPath.'/source/.compare.md';
+        $targetFile = $sourceOutputPath . '/source/index.md';
+        $compareFile = $sourceOutputPath . '/source/.compare.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', 'docs')
@@ -106,16 +106,16 @@ 
             $generatedDocumentation = file_get_contents($targetFile);
             $compareDocumentation = file_get_contents($compareFile);
 
-            $parsedRouteOutput->transform(function (Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) {
-                return $routeGroup->transform(function (array $route) use ($generatedDocumentation, $compareDocumentation) {
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $existingRouteDoc)) {
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
+            $parsedRouteOutput->transform(function(Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) {
+                return $routeGroup->transform(function(array $route) use ($generatedDocumentation, $compareDocumentation) {
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) {
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
                         if ($routeDocumentationChanged === false || $this->forceIt) {
                             if ($routeDocumentationChanged) {
-                                $this->output->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                                $this->output->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             }
                         } else {
-                            $this->output->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                            $this->output->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             $route['modified_output'] = $existingRouteDoc[0];
                         }
                     }
@@ -138,9 +138,9 @@ 
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection)
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        $this->output->info('Writing index.md and source files to: '.$sourceOutputPath);
+        $this->output->info('Writing index.md and source files to: ' . $sourceOutputPath);
 
-        if (! is_dir($sourceOutputPath)) {
+        if (!is_dir($sourceOutputPath)) {
             $documentarian = new Documentarian();
             $documentarian->create($sourceOutputPath);
         }
@@ -161,14 +161,14 @@ 
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->output->info('Wrote index.md and source files to: '.$sourceOutputPath);
+        $this->output->info('Wrote index.md and source files to: ' . $sourceOutputPath);
     }
 
     public function generateMarkdownOutputForEachRoute(Collection $parsedRoutes, array $settings): Collection
     {
-        $parsedRouteOutput = $parsedRoutes->map(function (Collection $routeGroup) use ($settings) {
-            return $routeGroup->map(function (array $route) use ($settings) {
-                if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) {
+        $parsedRouteOutput = $parsedRoutes->map(function(Collection $routeGroup) use ($settings) {
+            return $routeGroup->map(function(array $route) use ($settings) {
+                if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) {
                     // Set content type if the user forgot to set it
                     $route['headers']['Content-Type'] = 'application/json';
                 }
@@ -224,9 +224,9 @@ 
      */
     protected function getMarkdownToPrepend(string $sourceOutputPath): string
     {
-        $prependFile = $sourceOutputPath.'/source/prepend.md';
+        $prependFile = $sourceOutputPath . '/source/prepend.md';
         $prependFileContents = file_exists($prependFile)
-            ? file_get_contents($prependFile)."\n" : '';
+            ? file_get_contents($prependFile) . "\n" : '';
 
         return $prependFileContents;
     }
@@ -238,9 +238,9 @@ 
      */
     protected function getMarkdownToAppend(string $sourceOutputPath): string
     {
-        $appendFile = $sourceOutputPath.'/source/append.md';
+        $appendFile = $sourceOutputPath . '/source/append.md';
         $appendFileContents = file_exists($appendFile)
-            ? "\n".file_get_contents($appendFile) : '';
+            ? "\n" . file_get_contents($appendFile) : '';
 
         return $appendFileContents;
     }
@@ -248,7 +248,7 @@ 
     protected function copyAssetsFromSourceFolderToPublicFolder(string $sourceOutputPath, bool $isStatic = true): void
     {
         $publicPath = 'public/docs';
-        if (! is_dir($publicPath)) {
+        if (!is_dir($publicPath)) {
             mkdir($publicPath, 0777, true);
             mkdir("{$publicPath}/css");
             mkdir("{$publicPath}/js");
@@ -271,7 +271,7 @@ 
             rename("{$sourceOutputPath}/index.html", "{$outputPath}/index.html");
         } else {
             // Move output to resources/views
-            if (! is_dir($outputPath)) {
+            if (!is_dir($outputPath)) {
                 mkdir($outputPath);
             }
             rename("{$sourceOutputPath}/index.html", "$outputPath/index.blade.php");

src/Matching/RouteMatcher.php

Spacing +3 added lines, -3 removed lines

@@ -64,14 +64,14 @@ 
 
     private function getAllRoutes(bool $usingDingoRouter)
     {
-        if (! $usingDingoRouter) {
+        if (!$usingDingoRouter) {
             return RouteFacade::getRoutes();
         }
 
         $allRouteCollections = app(\Dingo\Api\Routing\Router::class)->getRoutes();
 
         return collect($allRouteCollections)
-            ->flatMap(function (RouteCollection $collection) {
+            ->flatMap(function(RouteCollection $collection) {
                 return $collection->getRoutes();
             })->toArray();
     }
@@ -79,7 +79,7 @@ 
     private function shouldIncludeRoute(Route $route, array $routeRule, array $mustIncludes, bool $usingDingoRouter)
     {
         $matchesVersion = $usingDingoRouter
-            ? ! empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
+            ? !empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
             : true;
 
         return Str::is($mustIncludes, $route->getName())

src/Extracting/Generator.php

Spacing +7 added lines, -7 removed lines

@@ -56,7 +56,7 @@ 
         $method = $controller->getMethod($methodName);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'methods' => $this->getMethods($route),
             'uri' => $this->getUri($route),
         ];
@@ -78,7 +78,7 @@ 
 
         $responses = $this->fetchResponses($controller, $method, $route, $routeRules, $parsedRoute);
         $parsedRoute['responses'] = $responses;
-        $parsedRoute['showresponse'] = ! empty($responses);
+        $parsedRoute['showresponse'] = !empty($responses);
 
         $parsedRoute['headers'] = $routeRules['headers'] ?? [];
 
@@ -117,7 +117,7 @@ 
     {
         $responses = $this->iterateThroughStrategies('responses', $context, [$route, $controller, $method, $rulesToApply]);
         if (count($responses)) {
-            return array_filter($responses, function ($response) {
+            return array_filter($responses, function($response) {
                 return $response['content'] != null;
             });
         }
@@ -157,7 +157,7 @@ 
             $strategyArgs = $arguments;
             $strategyArgs[] = $context;
             $results = $strategy(...$strategyArgs);
-            if (! is_null($results)) {
+            if (!is_null($results)) {
                 foreach ($results as $index => $item) {
                     if ($stage == 'responses') {
                         // Responses are additive
@@ -169,7 +169,7 @@ 
                     // and also allows values to be overwritten
 
                     // Don't allow overwriting if an empty value is trying to replace a set one
-                    if (! in_array($context[$stage], [null, ''], true) && in_array($item, [null, ''], true)) {
+                    if (!in_array($context[$stage], [null, ''], true) && in_array($item, [null, ''], true)) {
                         continue;
                     } else {
                         $context[$stage][$index] = $item;
@@ -194,8 +194,8 @@ 
         $values = [];
 
         // Remove params which have no examples.
-        $params = array_filter($params, function ($details) {
-            return ! is_null($details['value']);
+        $params = array_filter($params, function($details) {
+            return !is_null($details['value']);
         });
 
         foreach ($params as $paramName => $details) {