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/Generators/LaravelGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
     /**
      * @param Route $route
-     * @return mixed
+     * @return string
      */
     protected function getUri(Route $route)
     {

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
         }
 
         return $this->getParameters([
-            'id' => md5($route->getUri().':'.implode($route->getMethods())),
+            'id' => md5($route->getUri() . ':' . implode($route->getMethods())),
             'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
     }
 
     /**
-     * @param  $route
+     * @param  \Illuminate\Routing\Route $route
      *
      * @return \Illuminate\Http\Response
      */
@@ -410,7 +410,7 @@ 
      * @param  string  $rule
      * @param  string  $parameter
      *
-     * @return array
+     * @return string
      */
     protected function parseParameters($rule, $parameter)
     {

Spacing +6 added lines, -6 removed lines

@@ -78,7 +78,7 @@ 
     {
         $uri = $this->getUri($route);
         foreach ($bindings as $model => $id) {
-            $uri = str_replace('{'.$model.'}', $id, $uri);
+            $uri = str_replace('{' . $model . '}', $id, $uri);
         }
 
         return $uri;
@@ -139,7 +139,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;
                 $parameterReflection = new $className;
                 if ($parameterReflection instanceof FormRequest) {
@@ -164,8 +164,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)));
 
@@ -375,8 +375,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;

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 +6 added lines, -6 removed lines

@@ -15,11 +15,11 @@ 
      */
     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/lang' => $this->resource_path('lang/vendor/apidoc'),
         ]);
     }
 
@@ -30,10 +30,10 @@ 
      */
     public function register()
     {
-        $this->app['apidoc.generate'] = $this->app->share(function () {
+        $this->app['apidoc.generate'] = $this->app->share(function() {
             return new GenerateDocumentation();
         });
-        $this->app['apidoc.update'] = $this->app->share(function () {
+        $this->app['apidoc.update'] = $this->app->share(function() {
             return new UpdateDocumentation();
         });
 
@@ -52,6 +52,6 @@ 
      */
     public function resource_path($path = '')
     {
-        return app()->basePath().'/resources'.($path ? '/'.$path : $path);
+        return app()->basePath() . '/resources' . ($path ? '/' . $path : $path);
     }
 }

src/Mpociot/ApiDoc/Postman/CollectionWriter.php

Spacing +3 added lines, -3 removed lines

@@ -31,11 +31,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' => [
@@ -43,7 +43,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/Generators/DingoGenerator.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,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'],

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Spacing +19 added lines, -19 removed lines

@@ -67,7 +67,7 @@ 
 
         $this->setUserToBeImpersonated($this->option('actAsUserId'));
 
-        if ($routePrefix === null && ! count($allowedRoutes)) {
+        if ($routePrefix === null && !count($allowedRoutes)) {
             $this->error('You must provide either a route prefix or a route to generate the documentation.');
 
             return false;
@@ -91,14 +91,14 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = $this->option('output');
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', $this->option('output'))
-            ->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);
 
                 return $route;
@@ -121,9 +121,9 @@ 
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
             }
 
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation) {
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation) {
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch) && ! $this->option('force')) {
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation) {
+                return $routeGroup->transform(function($route) use ($generatedDocumentation) {
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch) && !$this->option('force')) {
                         $route['output'] = $routeMatch[0];
                     }
 
@@ -138,28 +138,28 @@ 
             ->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);
         }
 
         file_put_contents($targetFile, $markdown);
 
-        $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));
         }
     }
 
@@ -187,7 +187,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($actAs);
@@ -229,9 +229,9 @@ 
             if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->getUri())) {
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse);
-                    $this->info('Processed route: '.$route->getUri());
+                    $this->info('Processed route: ' . $route->getUri());
                 } else {
-                    $this->warn('Skipping route: '.$route->getUri());
+                    $this->warn('Skipping route: ' . $route->getUri());
                 }
             }
         }
@@ -255,7 +255,7 @@ 
         foreach ($routes as $route) {
             if (empty($allowedRoutes) || in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->uri())) {
                 $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse);
-                $this->info('Processed route: '.$route->uri());
+                $this->info('Processed route: ' . $route->uri());
             }
         }
 
@@ -269,7 +269,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']);
     }
 
     /**
@@ -286,7 +286,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();