mpociot / laravel-apidoc-generator

src/Mpociot/ApiDoc/Commands/UpdateDocumentation.php

Spacing +3 added lines, -3 removed lines

@@ -44,8 +44,8 @@ 
 
         $documentarian = new Documentarian();
 
-        if (! is_dir($outputPath)) {
-            $this->error('There is no generated documentation available at '.$outputPath.'.');
+        if (!is_dir($outputPath)) {
+            $this->error('There is no generated documentation available at ' . $outputPath . '.');
 
             return false;
         }
@@ -53,6 +53,6 @@ 
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/public/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
     }
 }

src/Mpociot/ApiDoc/Parsers/RuleDescriptionParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
     }
 
     /**
-     * @param null $rule
+     * @param string $rule
      *
      * @return static
      */

Spacing +2 added lines, -4 removed lines

@@ -34,8 +34,7 @@ 
     public function with($parameters)
     {
         is_array($parameters) ?
-            $this->parameters += $parameters :
-            $this->parameters[] = $parameters;
+            $this->parameters += $parameters : $this->parameters[] = $parameters;
 
         return $this;
     }
@@ -54,8 +53,7 @@ 
     protected function makeDescription()
     {
         $description = trans()->hasForLocale($this->rule) ?
-                            trans()->get($this->rule) :
-                            trans()->get($this->rule, [], self::DEFAULT_LOCALE);
+                            trans()->get($this->rule) : trans()->get($this->rule, [], self::DEFAULT_LOCALE);
 
         return $this->replaceAttributes($description);
     }

src/Mpociot/ApiDoc/ApiDocGeneratorServiceProvider.php

Spacing +7 added lines, -7 removed lines

@@ -15,12 +15,12 @@ 
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../../resources/views/', 'apidoc');
-        $this->loadTranslationsFrom(__DIR__.'/../../resources/lang', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../../resources/views/', 'apidoc');
+        $this->loadTranslationsFrom(__DIR__ . '/../../resources/lang', 'apidoc');
 
         $this->publishes([
-            __DIR__.'/../../resources/lang' => $this->resource_path('lang/vendor/apidoc'),
-            __DIR__.'/../../resources/views' => $this->resource_path('views/vendor/apidoc'),
+            __DIR__ . '/../../resources/lang' => $this->resource_path('lang/vendor/apidoc'),
+            __DIR__ . '/../../resources/views' => $this->resource_path('views/vendor/apidoc'),
         ]);
     }
 
@@ -31,10 +31,10 @@ 
      */
     public function register()
     {
-        $this->app->singleton('apidoc.generate', function () {
+        $this->app->singleton('apidoc.generate', function() {
             return new GenerateDocumentation();
         });
-        $this->app->singleton('apidoc.update', function () {
+        $this->app->singleton('apidoc.update', function() {
             return new UpdateDocumentation();
         });
 
@@ -53,6 +53,6 @@ 
      */
     public function resource_path($path = '')
     {
-        return app()->basePath().'/resources'.($path ? '/'.$path : $path);
+        return app()->basePath() . '/resources' . ($path ? '/' . $path : $path);
     }
 }

src/Mpociot/ApiDoc/Generators/DingoGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      *
      * @param  bool $disable
      *
-     * @return  void
+     * @return  boolean
      */
     public function prepareMiddleware($disable = true)
     {

Spacing +2 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
         $routeDescription = $this->getRouteDescription($routeAction['uses']);
 
         return $this->getParameters([
-            'id' => md5($route->uri().':'.implode($route->getMethods())),
+            'id' => md5($route->uri() . ':' . implode($route->getMethods())),
             'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],
@@ -61,7 +61,7 @@ 
     {
         $dispatcher = app('Dingo\Api\Dispatcher')->raw();
 
-        collect($server)->map(function ($key, $value) use ($dispatcher) {
+        collect($server)->map(function($key, $value) use ($dispatcher) {
             $dispatcher->header($value, $key);
         });
 

src/Mpociot/ApiDoc/Postman/CollectionWriter.php

Spacing +3 added lines, -3 removed lines

@@ -32,11 +32,11 @@ 
                 '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) {
                         return [
                             'name' => $route['title'] != '' ? $route['title'] : url($route['uri']),
                             'request' => [
@@ -44,7 +44,7 @@ 
                                 'method' => $route['methods'][0],
                                 'body' => [
                                     'mode' => 'formdata',
-                                    'formdata' => collect($route['parameters'])->map(function ($parameter, $key) {
+                                    'formdata' => collect($route['parameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => isset($parameter['value']) ? $parameter['value'] : '',

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Spacing +26 added lines, -26 removed lines

@@ -71,7 +71,7 @@ 
 
         $this->setUserToBeImpersonated($this->option('actAsUserId'));
 
-        if ($routePrefix === null && ! count($allowedRoutes) && $middleware === null) {
+        if ($routePrefix === null && !count($allowedRoutes) && $middleware === null) {
             $this->error('You must provide either a route prefix or a route or a middleware to generate the documentation.');
 
             return false;
@@ -84,7 +84,7 @@ 
         } else {
             $parsedRoutes = $this->processDingoRoutes($generator, $allowedRoutes, $routePrefix, $middleware);
         }
-        $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function ($a, $b) {
+        $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function($a, $b) {
             return strcmp($a->first()['resource'], $b->first()['resource']);
         });
 
@@ -99,15 +99,15 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = $this->option('output');
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', ltrim($outputPath, 'public/'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'));
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'));
 
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
-            return $routeGroup->map(function ($route) {
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
+            return $routeGroup->map(function($route) {
                 $route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route)->render();
 
                 return $route;
@@ -131,16 +131,16 @@ 
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
             }
 
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch)) {
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch)) {
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
                         if ($routeDocumentationChanged === false || $this->option('force')) {
                             if ($routeDocumentationChanged) {
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             }
                         } else {
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             $route['modified_output'] = $routeMatch[0];
                         }
                     }
@@ -157,10 +157,10 @@ 
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
             ->with('outputPath', $this->option('output'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -173,23 +173,23 @@ 
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
             ->with('outputPath', $this->option('output'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->info('Wrote index.md to: '.$outputPath);
+        $this->info('Wrote index.md to: ' . $outputPath);
 
         $this->info('Generating API HTML code');
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/public/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
 
         if ($this->option('noPostmanCollection') !== true) {
             $this->info('Generating Postman collection');
 
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
         }
     }
 
@@ -217,7 +217,7 @@ 
      */
     private function setUserToBeImpersonated($actAs)
     {
-        if (! empty($actAs)) {
+        if (!empty($actAs)) {
             if (version_compare($this->laravel->version(), '5.2.0', '<')) {
                 $userModel = config('auth.model');
                 $user = $userModel::find((int) $actAs);
@@ -259,9 +259,9 @@ 
             if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $generator->getUri($route)) || in_array($middleware, $route->middleware())) {
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse);
-                    $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                    $this->info('Processed route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
                 } else {
-                    $this->warn('Skipping route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                    $this->warn('Skipping route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
                 }
             }
         }
@@ -286,9 +286,9 @@ 
             if (empty($allowedRoutes) || in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->uri()) || in_array($middleware, $route->middleware())) {
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse);
-                    $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->uri());
+                    $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri());
                 } else {
-                    $this->warn('Skipping route: ['.implode(',', $route->getMethods()).'] '.$route->uri());
+                    $this->warn('Skipping route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri());
                 }
             }
         }
@@ -303,7 +303,7 @@ 
      */
     private function isValidRoute($route)
     {
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
     }
 
     /**
@@ -320,7 +320,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

Doc Comments +4 added lines, -4 removed lines

@@ -35,9 +35,9 @@ 
     /**
      * Get the response from the docblock if available.
      *
-     * @param array $tags
+     * @param Tag[] $tags
      *
-     * @return mixed
+     * @return null|\Symfony\Component\HttpFoundation\Response
      */
     protected function getDocblockResponse($tags)
     {
@@ -339,7 +339,7 @@ 
      * @param  string $rule
      * @param  string $parameter
      *
-     * @return array
+     * @return string
      */
     protected function parseParameters($rule, $parameter)
     {
@@ -403,7 +403,7 @@ 
     }
 
     /**
-     * @param  $route
+     * @param  \Illuminate\Routing\Route $route
      * @param  $bindings
      * @param  $headers
      *

Spacing +12 added lines, -12 removed lines

@@ -92,7 +92,7 @@ 
 
         foreach ($reflectionMethod->getParameters() as $parameter) {
             $parameterType = $parameter->getClass();
-            if (! is_null($parameterType) && class_exists($parameterType->name)) {
+            if (!is_null($parameterType) && class_exists($parameterType->name)) {
                 $className = $parameterType->name;
 
                 if (is_subclass_of($className, FormRequest::class)) {
@@ -175,7 +175,7 @@ 
                 }
                 break;
             case 'between':
-                if (! isset($attributeData['type'])) {
+                if (!isset($attributeData['type'])) {
                     $attributeData['type'] = 'numeric';
                 }
                 $attributeData['description'][] = Description::parse($rule)->with($parameters)->getDescription();
@@ -378,8 +378,8 @@ 
      */
     protected function fancyImplode($arr, $first, $last)
     {
-        $arr = array_map(function ($value) {
-            return '`'.$value.'`';
+        $arr = array_map(function($value) {
+            return '`' . $value . '`';
         }, $arr);
         array_push($arr, implode($last, array_splice($arr, -2)));
 
@@ -389,8 +389,8 @@ 
     protected function splitValuePairs($parameters, $first = 'is ', $last = 'or ')
     {
         $attribute = '';
-        collect($parameters)->map(function ($item, $key) use (&$attribute, $first, $last) {
-            $attribute .= '`'.$item.'` ';
+        collect($parameters)->map(function($item, $key) use (&$attribute, $first, $last) {
+            $attribute .= '`' . $item . '` ';
             if (($key + 1) % 2 === 0) {
                 $attribute .= $last;
             } else {
@@ -416,7 +416,7 @@ 
         $methods = $this->getMethods($route);
 
         // Split headers into key - value pairs
-        $headers = collect($headers)->map(function ($value) {
+        $headers = collect($headers)->map(function($value) {
             $split = explode(':', $value);
 
             return [trim($split[0]) => trim($split[1])];
@@ -438,7 +438,7 @@ 
     {
         $uri = $this->getUri($route);
         foreach ($bindings as $model => $id) {
-            $uri = str_replace('{'.$model.'}', $id, $uri);
+            $uri = str_replace('{' . $model . '}', $id, $uri);
         }
 
         return $uri;
@@ -539,8 +539,8 @@ 
         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;
@@ -574,8 +574,8 @@ 
     {
         $names = \array_wrap($names);
 
-        return \array_filter($tags, function ($tag) use ($names) {
-            if (! ($tag instanceof Tag)) {
+        return \array_filter($tags, function($tag) use ($names) {
+            if (!($tag instanceof Tag)) {
                 return false;
             }
 

src/Mpociot/ApiDoc/Commands/ResponseMakeCommand.php

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
      */
     protected function getDefaultNamespace($rootNamespace)
     {
-        return $rootNamespace.'\Api\Responses';
+        return $rootNamespace . '\Api\Responses';
     }
 
     /**
@@ -45,6 +45,6 @@ 
      */
     protected function getStub()
     {
-        return __DIR__.'/stubs/response.stub';
+        return __DIR__ . '/stubs/response.stub';
     }
 }

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

Doc Comments +5 added lines, -5 removed lines

@@ -88,7 +88,7 @@ 
     /**
      * Get a response from the transformer tags.
      *
-     * @param array $tags
+     * @param \Mpociot\Reflection\DocBlock\Tag[] $tags
      *
      * @return mixed
      */
@@ -182,7 +182,7 @@ 
     /**
      * Get response content use responseclass tag.
      *
-     * @param $tags
+     * @param \Mpociot\Reflection\DocBlock\Tag[] $tags
      *
      * @return bool|void
      */
@@ -227,7 +227,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getMethods($route)
     {
@@ -325,7 +325,7 @@ 
      * Get Custom Data from data tag.
      *
      * @param $tags
-     * @param array $default
+     * @param null|false $default
      *
      * @return array|null
      */
@@ -350,7 +350,7 @@ 
     /**
      * Get Response use @data tag.
      *
-     * @param $tags
+     * @param \Mpociot\Reflection\DocBlock\Tag[] $tags
      *
      * @return bool|\Illuminate\Contracts\Routing\ResponseFactory|\Symfony\Component\HttpFoundation\Response
      */

Spacing +12 added lines, -12 removed lines

@@ -38,7 +38,7 @@ 
                 $response = $docblockResponse;
                 $showresponse = true;
             }
-            if (! $response) {
+            if (!$response) {
                 $transformerResponse = $this->getTransformerResponse($routeDescription['tags']);
                 if ($transformerResponse) {
                     // we have a transformer response from the docblock ( @transformer || @transformercollection )
@@ -46,7 +46,7 @@ 
                     $showresponse = true;
                 }
             }
-            if (! $response) {
+            if (!$response) {
                 $responseClassResponse = $this->getResponseClassResponse($routeDescription['tags']);
                 if ($responseClassResponse) {
                     // we have a class response from the docblock ( @responseClass )
@@ -54,7 +54,7 @@ 
                     $showresponse = true;
                 }
             }
-            if (! $response) {
+            if (!$response) {
                 $dataResponse = $this->getDataResponse($routeDescription['tags']);
                 if ($dataResponse) {
                     // we have a data response from the docblock ( @data )
@@ -62,7 +62,7 @@ 
                     $showresponse = true;
                 }
             }
-            if (! $response) {
+            if (!$response) {
                 $response = $this->getRouteResponse($route, $bindings, $headers);
             }
             if ($response->headers->get('Content-Type') === 'application/json') {
@@ -73,7 +73,7 @@ 
         }
 
         return $this->getParameters([
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],
@@ -104,7 +104,7 @@ 
 
             $modelTag = $this->getFirstTagFromDocblock($tags, ['transformermodel']);
             $transformer = $transFormerTag->getContent();
-            if (! \class_exists($transformer)) {
+            if (!\class_exists($transformer)) {
                 // if we can't find the transformer we can't generate a response
                 return;
             }
@@ -119,7 +119,7 @@ 
             }
             if (version_compare(PHP_VERSION, '7.0.0') >= 0 && \is_null($type)) {
                 // we can only get the type with reflection for PHP 7
-                if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && \class_exists((string) $parameter->getType())) {
+                if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && \class_exists((string) $parameter->getType())) {
                     //we have a type
                     $type = (string) $parameter->getType();
                 }
@@ -160,7 +160,7 @@ 
             $fractal = new Manager();
             $resource = [];
             // allow use custom serializer
-            if (! empty($serializer) && class_exists($serializer)) {
+            if (!empty($serializer) && class_exists($serializer)) {
                 $fractal->setSerializer(new $serializer());
             }
             if ($transFormerTag->getName() == 'transformer') {
@@ -197,7 +197,7 @@ 
             }
 
             $responseClass = $responseClassTag->getContent();
-            if (! \class_exists($responseClass)) {
+            if (!\class_exists($responseClass)) {
                 // if we can't find the response class we can't generate a response
                 return;
             }
@@ -277,7 +277,7 @@ 
 
         $kernel->terminate($request, $response);
 
-        if (file_exists($file = App::bootstrapPath().'/app.php')) {
+        if (file_exists($file = App::bootstrapPath() . '/app.php')) {
             $app = require $file;
             $app->make('Illuminate\Contracts\Console\Kernel')->bootstrap();
         }
@@ -299,7 +299,7 @@ 
 
         foreach ($reflectionMethod->getParameters() as $parameter) {
             $parameterType = $parameter->getClass();
-            if (! is_null($parameterType) && class_exists($parameterType->name)) {
+            if (!is_null($parameterType) && class_exists($parameterType->name)) {
                 $className = $parameterType->name;
 
                 if (is_subclass_of($className, FormRequest::class)) {
@@ -340,7 +340,7 @@ 
 
         $additionData = explode(',', $additionData->getContent());
 
-        $additionData = array_column(array_map(function ($v) {
+        $additionData = array_column(array_map(function($v) {
             return explode('|', $v);
         }, $additionData), 1, 0);