mpociot / laravel-apidoc-generator

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

src/Mpociot/ApiDoc/Transformers/ResponseApiDataAbstract.php

Spacing +5 added lines, -5 removed lines

@@ -144,7 +144,7 @@ 
      */
     public function toArray()
     {
-        return array_map(function ($value) {
+        return array_map(function($value) {
             return $value instanceof Arrayable ? $value->toArray() : $value;
         }, $this->response());
     }
@@ -178,7 +178,7 @@ 
      */
     public function jsonSerialize()
     {
-        return array_map(function ($value) {
+        return array_map(function($value) {
             if ($value instanceof JsonSerializable) {
                 return $value->jsonSerialize();
             } elseif ($value instanceof Jsonable) {
@@ -208,13 +208,13 @@ 
         $response->setData($this->toArray());
 
         if (is_int($statusCode)) {
-            $statusCode = function (JsonResponse $response) use ($statusCode) {
+            $statusCode = function(JsonResponse $response) use ($statusCode) {
                 return $response->setStatusCode($statusCode);
             };
         }
 
         if (is_array($headers)) {
-            $headers = function (JsonResponse $response) use ($headers) {
+            $headers = function(JsonResponse $response) use ($headers) {
                 return $response->withHeaders($headers);
             };
         }
@@ -240,7 +240,7 @@ 
      */
     public function __call($name, $arguments)
     {
-        if (! method_exists($this, $name)) {
+        if (!method_exists($this, $name)) {
             return $this->getData()->$name(...$arguments);
         }