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)
     {

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']);
             })
         );

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 use Illuminate\Http\Response;
 use Illuminate\Routing\Route;
 use Illuminate\Support\Arr;
-use League\Fractal\Resource\Collection;
 use Mpociot\ApiDoc\Extracting\RouteDocBlocker;
 use Mpociot\ApiDoc\Extracting\Strategies\Strategy;
 use Mpociot\ApiDoc\Tools\Flags;

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/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/Strategies/Responses/ResponseCalls.php

Spacing +7 added lines, -7 removed lines

@@ -31,7 +31,7 @@ 
     public function __invoke(Route $route, \ReflectionClass $controller, \ReflectionMethod $method, array $routeRules, array $context = [])
     {
         $rulesToApply = $routeRules['response_calls'] ?? [];
-        if (! $this->shouldMakeApiCall($route, $rulesToApply, $context)) {
+        if (!$this->shouldMakeApiCall($route, $rulesToApply, $context)) {
             return null;
         }
 
@@ -52,7 +52,7 @@ 
                 ],
             ];
         } catch (\Exception $e) {
-            echo 'Exception thrown during response call for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown during response call for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -186,14 +186,14 @@ 
         // set URL and query parameters
         $uri = $request->getRequestUri();
         $query = $request->getQueryString();
-        if (! empty($query)) {
+        if (!empty($query)) {
             $uri .= "?$query";
         }
         $response = call_user_func_array([$dispatcher, strtolower($request->method())], [$uri]);
 
         // the response from the Dingo dispatcher is the 'raw' response from the controller,
         // so we have to ensure it's JSON first
-        if (! $response instanceof Response) {
+        if (!$response instanceof Response) {
             $response = response()->json($response);
         }
 
@@ -321,7 +321,7 @@ 
         }
 
         // Don't attempt a response call if there are already successful responses
-        $successResponses = collect($context['responses'])->filter(function ($response) {
+        $successResponses = collect($context['responses'])->filter(function($response) {
             return ((string) $response['status'])[0] == '2';
         })->count();
         if ($successResponses) {
@@ -357,8 +357,8 @@ 
         $prefix = 'HTTP_';
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
-            if (! Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
             $server[$name] = $value;
         }

src/ApiDoc.php

Spacing +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 {
     public static function routes($path = '/doc')
     {
-        return Route::get("$path{format?}", function (?string $format = null) {
+        return Route::get("$path{format?}", function(?string $format = null) {
             if ($format == '.json') {
                 return response(
                     Storage::disk('local')->get('apidoc/collection.json'),

src/Tools/Utils.php

Spacing +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
     public static function replaceUrlParameterPlaceholdersWithValues(string $uri, array $urlParameters)
     {
         $matches = preg_match_all('/{.+?}/i', $uri, $parameterPaths);
-        if (! $matches) {
+        if (!$matches) {
             return $uri;
         }
 
@@ -88,7 +88,7 @@ 
 
     public static function deleteDirectoryAndContents($dir)
     {
-        $adapter = new Local(realpath(__DIR__.'/../../'));
+        $adapter = new Local(realpath(__DIR__ . '/../../'));
         $fs = new Filesystem($adapter);
         $fs->deleteDir($dir);
     }
@@ -101,7 +101,7 @@ 
         $result = '';
         $padWith = str_repeat(' ', $indentationLevel);
         foreach ($split as $index => $line) {
-            $result .= ($index == 0 ? '' : "\n$padWith").$line;
+            $result .= ($index == 0 ? '' : "\n$padWith") . $line;
         }
 
         return $result;