mpociot / laravel-apidoc-generator

src/Tools/Generator.php

Doc Comments +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -163,7 +163,7 @@ 
      * @param ReflectionMethod $method
      * @param array $tags
      *
-     * @return array
+     * @return Route
      */
     protected function getQueryParameters(ReflectionMethod $method, array $tags)
     {

Spacing +17 added lines, -17 removed lines

@@ -69,7 +69,7 @@ 
         ]);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'groupName' => $routeGroupName,
             'groupDescription' => $routeGroupDescription,
             'title' => $routeTitle ?: $docBlock['short'],
@@ -83,7 +83,7 @@ 
             'cleanQueryParameters' => $this->cleanParams($queryParameters),
             'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']),
             'response' => $content,
-            'showresponse' => ! empty($content),
+            'showresponse' => !empty($content),
         ];
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -129,10 +129,10 @@ 
     protected function getBodyParametersFromDocBlock(array $tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -152,7 +152,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
+                $value = is_null($example) && !$this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
 
                 return [$name => compact('type', 'description', 'required', 'value')];
             })->toArray();
@@ -205,10 +205,10 @@ 
     protected function getQueryParametersFromDocBlock(array $tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'queryParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -227,7 +227,7 @@ 
                 }
 
                 list($description, $value) = $this->parseDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag)) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag)) {
                     $value = Str::contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');
@@ -247,7 +247,7 @@ 
     protected function getAuthStatusFromDocBlock(array $tags)
     {
         $authTag = collect($tags)
-            ->first(function ($tag) {
+            ->first(function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
             });
 
@@ -280,7 +280,7 @@ 
     protected function getRouteGroup(ReflectionClass $controller, array $methodDocBlock)
     {
         // @group tag on the method overrides that on the controller
-        if (! empty($methodDocBlock['tags'])) {
+        if (!empty($methodDocBlock['tags'])) {
             foreach ($methodDocBlock['tags'] as $tag) {
                 if ($tag->getName() === 'group') {
                     $routeGroupParts = explode("\n", trim($tag->getContent()));
@@ -347,25 +347,25 @@ 
             $faker->seed($this->config->get('faker_seed'));
         }
         $fakeFactories = [
-            'integer' => function () use ($faker) {
+            'integer' => function() use ($faker) {
                 return $faker->numberBetween(1, 20);
             },
-            'number' => function () use ($faker) {
+            'number' => function() use ($faker) {
                 return $faker->randomFloat();
             },
-            'float' => function () use ($faker) {
+            'float' => function() use ($faker) {
                 return $faker->randomFloat();
             },
-            'boolean' => function () use ($faker) {
+            'boolean' => function() use ($faker) {
                 return $faker->boolean();
             },
-            'string' => function () use ($faker) {
+            'string' => function() use ($faker) {
                 return $faker->word;
             },
-            'array' => function () {
+            'array' => function() {
                 return [];
             },
-            'object' => function () {
+            'object' => function() {
                 return new \stdClass;
             },
         ];

src/Tools/RouteMatcher.php

Spacing +3 added lines, -3 removed lines

@@ -54,14 +54,14 @@ 
     // for each ruleset in the config file. Not a high priority, though.
     private function getAllRoutes(bool $usingDingoRouter, array $versions = [])
     {
-        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();
     }
@@ -69,7 +69,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/Tools/ResponseStrategies/TransformerTagsStrategy.php

Spacing +4 added lines, -4 removed lines

@@ -49,7 +49,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')));
             }
 
@@ -81,7 +81,7 @@ 
      */
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod)
     {
-        $modelTag = Arr::first(array_filter($tags, function ($tag) {
+        $modelTag = Arr::first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
         }));
 
@@ -90,7 +90,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();
             }
@@ -142,7 +142,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']);
             })
         );