mpociot / laravel-apidoc-generator

src/Tools/Traits/ParamHelpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
      *
      * @param string $type
      *
-     * @return mixed|string
+     * @return string
      */
     protected function normalizeParameterType(string $type)
     {

Spacing +7 added lines, -7 removed lines

@@ -13,25 +13,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/Strategies/QueryParameters/GetFromQueryParamTag.php

Spacing +3 added lines, -3 removed lines

@@ -56,10 +56,10 @@ 
     private function getQueryParametersFromDocBlock($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)) {
@@ -78,7 +78,7 @@ 
                 }
 
                 list($description, $value) = $this->parseParamDescription($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');

src/Strategies/Responses/UseTransformerTags.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']);
             })
         );

src/Strategies/BodyParameters/GetFromBodyParamTag.php

Spacing +3 added lines, -3 removed lines

@@ -55,10 +55,10 @@ 
     private function getBodyParametersFromDocBlock($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)) {
@@ -78,7 +78,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseParamDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag)
+                $value = is_null($example) && !$this->shouldExcludeExample($tag)
                     ? $this->generateDummyValue($type)
                     : $example;
 

src/Tools/Generator.php

Spacing +7 added lines, -7 removed lines

@@ -54,7 +54,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),
             'boundUri' => Utils::getFullUrl($route, $rulesToApply['bindings'] ?? ($rulesToApply['response_calls']['bindings'] ?? [])),
@@ -71,7 +71,7 @@ 
 
         $responses = $this->fetchResponses($controller, $method, $route, $rulesToApply, $parsedRoute);
         $parsedRoute['response'] = $responses;
-        $parsedRoute['showresponse'] = ! empty($responses);
+        $parsedRoute['showresponse'] = !empty($responses);
 
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -107,7 +107,7 @@ 
     {
         $responses = $this->iterateThroughStrategies('responses', $context, [$route, $controller, $method, $rulesToApply]);
         if (count($responses)) {
-            return collect($responses)->map(function (string $response, int $status) {
+            return collect($responses)->map(function(string $response, int $status) {
                 return [
                     'status' => $status ?: 200,
                     'content' => $response,
@@ -126,14 +126,14 @@ 
             $strategy = new $strategyClass($stage, $this->config);
             $arguments[] = $context;
             $results = $strategy(...$arguments);
-            if (! is_null($results)) {
+            if (!is_null($results)) {
                 foreach ($results as $index => $item) {
                     // Using a for loop rather than array_merge or +=
                     // so it does not renumber numeric keys
                     // 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;
@@ -158,8 +158,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) {

src/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;
         }
 
@@ -46,7 +46,7 @@ 
             $response = $this->makeApiCall($request);
             $response = [$response->getStatusCode() => $response->getContent()];
         } 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 {
@@ -179,14 +179,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);
         }
 
@@ -306,7 +306,7 @@ 
             return false;
         }
 
-        if (! empty($context['responses'])) {
+        if (!empty($context['responses'])) {
             // Don't attempt a response call if there are already responses
             return false;
         }
@@ -340,8 +340,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/Strategies/BodyParameters/GetFromRequestClass.php

Spacing +9 added lines, -9 removed lines

@@ -10,7 +10,7 @@ 
 use Mpociot\ApiDoc\Strategies\Strategy;
 use Mpociot\ApiDoc\Tools\Traits\DocBlockParamHelpers;
 
-class GetFromRequestClass extends Strategy{
+class GetFromRequestClass extends Strategy {
     
     use DocBlockParamHelpers;
     
@@ -27,7 +27,7 @@ 
                 ? $paramType->__toString()
                 : $paramType->getName();
 
-            $parameters = array_merge($parameters , $this->getBodyParametersFromRequestClass($parameterClassName));
+            $parameters = array_merge($parameters, $this->getBodyParametersFromRequestClass($parameterClassName));
         }
 
         return $parameters;
@@ -41,7 +41,7 @@ 
             $instance = $r->newInstanceWithoutConstructor();
             $parameters = $instance->rules();
                 foreach ($parameters as $key => $value) {
-                    $arrayParams  = array_merge($arrayParams,$this->explodeParams($key , $value));
+                    $arrayParams = array_merge($arrayParams, $this->explodeParams($key, $value));
                 }
         } catch (Throwable $e) {
             echo $e->getMessage();
@@ -50,19 +50,19 @@ 
         return $arrayParams;
     }
 
-    public function explodeParams($field , $paramsValue){
+    public function explodeParams($field, $paramsValue) {
         $params = explode('|', $paramsValue);
         $required = false;
         $description = [];
         $type = '';
-        foreach($params as $param){
-            if($param === 'required'){
+        foreach ($params as $param) {
+            if ($param === 'required') {
                 $required = true;
             }
-            elseif($param === 'string' || $param === 'integer' ||$param === 'array' ||$param === 'boolean' ||$param === 'float' ||$param === 'number'|| $param === 'object'){
+            elseif ($param === 'string' || $param === 'integer' || $param === 'array' || $param === 'boolean' || $param === 'float' || $param === 'number' || $param === 'object') {
                 $type = $param;
             }
-            else{
+            else {
                 $description [] = $param;
             }
         }
@@ -70,7 +70,7 @@ 
         return [
             $field=> [
                 'type'=> $type,
-                'description'=> implode(" ",$description),
+                'description'=> implode(" ", $description),
                 'required'=>$required,
                 'value'=>$this->generateDummyValue($type)
             ]

Braces +2 added lines, -4 removed lines

@@ -58,11 +58,9 @@
         foreach($params as $param){
             if($param === 'required'){
                 $required = true;
-            }
-            elseif($param === 'string' || $param === 'integer' ||$param === 'array' ||$param === 'boolean' ||$param === 'float' ||$param === 'number'|| $param === 'object'){
+            } elseif($param === 'string' || $param === 'integer' ||$param === 'array' ||$param === 'boolean' ||$param === 'float' ||$param === 'number'|| $param === 'object'){
                 $type = $param;
-            }
-            else{
+            } else{
                 $description [] = $param;
             }
         }