mpociot / laravel-apidoc-generator

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

Doc Comments +5 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
     /**
      * @param $route
      *
-     * @return mixed
+     * @return string
      */
     abstract public function getDomain($route);
 
@@ -99,7 +99,6 @@ 
     /**
      * Prepares / Disables route middlewares.
      *
-     * @param  bool $disable
      *
      * @return  void
      */
@@ -110,7 +109,7 @@ 
      *
      * @param array $tags
      *
-     * @return mixed
+     * @return null|\Symfony\Component\HttpFoundation\Response
      */
     protected function getDocblockResponse($tags)
     {
@@ -183,7 +182,7 @@ 
     }
 
     /**
-     * @param  $route
+     * @param  \Illuminate\Routing\Route $route
      * @param  $bindings
      * @param  $headers
      *
@@ -633,7 +632,7 @@ 
      * @param  string  $rule
      * @param  string  $parameter
      *
-     * @return array
+     * @return string
      */
     protected function parseParameters($rule, $parameter)
     {
@@ -664,7 +663,7 @@ 
     }
 
     /**
-     * @param $response
+     * @param null|\Symfony\Component\HttpFoundation\Response $response
      *
      * @return mixed
      */

Spacing +25 added lines, -25 removed lines

@@ -65,7 +65,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 )
@@ -73,18 +73,18 @@ 
                 $showresponse = true;
             }
         }
-        if (! $response && $withResponse) {
+        if (!$response && $withResponse) {
             try {
                 $response = $this->getRouteResponse($route, $bindings, $headers);
             } catch (\Exception $e) {
-                dump("Couldn't get response for route: ".implode(',', $this->getMethods($route)).'] '.$route->uri().'', $e->getMessage());
+                dump("Couldn't get response for route: " . implode(',', $this->getMethods($route)) . '] ' . $route->uri() . '', $e->getMessage());
             }
         }
 
         $content = $this->getResponseContent($response);
 
         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'],
@@ -114,8 +114,8 @@ 
      */
     protected function getDocblockResponse($tags)
     {
-        $responseTags = array_filter($tags, function ($tag) {
-            if (! ($tag instanceof Tag)) {
+        $responseTags = array_filter($tags, function($tag) {
+            if (!($tag instanceof Tag)) {
                 return false;
             }
 
@@ -173,9 +173,9 @@ 
         }
 
         $values = collect($simplifiedRules)
-            ->filter(function ($values) {
+            ->filter(function($values) {
                 return in_array('array', $values);
-            })->map(function ($val, $key) {
+            })->map(function($val, $key) {
                 return [''];
             })->all();
 
@@ -196,7 +196,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); // explode to get key + values
             $key = array_shift($split); // extract the key and keep the values in the array
             $value = implode(':', $split); // implode values into string again
@@ -220,8 +220,8 @@ 
     {
         $uri = $this->getUri($route);
         foreach ($bindings as $model => $id) {
-            $uri = str_replace('{'.$model.'}', $id, $uri);
-            $uri = str_replace('{'.$model.'?}', $id, $uri);
+            $uri = str_replace('{' . $model . '}', $id, $uri);
+            $uri = str_replace('{' . $model . '?}', $id, $uri);
         }
 
         return $uri;
@@ -285,7 +285,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)) {
@@ -321,8 +321,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)));
 
@@ -332,8 +332,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 @@ 
                 }
                 break;
             case 'between':
-                if (! isset($attributeData['type'])) {
+                if (!isset($attributeData['type'])) {
                     $attributeData['type'] = 'numeric';
                 }
                 $attributeData['description'][] = Description::parse($rule)->with($parameters)->getDescription();
@@ -594,8 +594,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;
@@ -692,8 +692,8 @@ 
     protected function getTransformerResponse($tags)
     {
         try {
-            $transFormerTags = array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $transFormerTags = array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -704,8 +704,8 @@ 
                 return false;
             }
 
-            $modelTag = array_first(array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $modelTag = array_first(array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -713,7 +713,7 @@ 
             }));
             $tag = \array_first($transFormerTags);
             $transformer = $tag->getContent();
-            if (! \class_exists($transformer)) {
+            if (!\class_exists($transformer)) {
                 // if we can't find the transformer we can't generate a response
                 return;
             }
@@ -729,7 +729,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() &&
+                    !$parameter->getType()->isBuiltin() &&
                     \class_exists((string) $parameter->getType())) {
                     //we have a type
                     $type = (string) $parameter->getType();

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      */
     public function prepareMiddleware($enable = true)
     {
-        App::instance('middleware.disable', ! $enable);
+        App::instance('middleware.disable', !$enable);
     }
 
     /**