mpociot / laravel-apidoc-generator

src/Mpociot/ApiDoc/ApiDocGenerator.php

Doc Comments +3 added lines, -3 removed lines

@@ -109,8 +109,8 @@ 
 
     /**
      * @param $arr
-     * @param $first
-     * @param $last
+     * @param string $first
+     * @param string $last
      * @return string
      */
     protected function fancyImplode($arr, $first, $last)
@@ -335,7 +335,7 @@ 
      *
      * @param  string $rule
      * @param  string $parameter
-     * @return array
+     * @return string
      */
     protected function parseParameters($rule, $parameter)
     {

Spacing +26 added lines, -26 removed lines

@@ -97,7 +97,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) {
@@ -122,8 +122,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)));
 
@@ -153,7 +153,7 @@ 
                 break;
             case 'after':
                 $attributeData['type'] = 'date';
-                $attributeData['description'][] = 'Must be a date after: `'.date(DATE_RFC850, strtotime($parameters[0])).'`';
+                $attributeData['description'][] = 'Must be a date after: `' . date(DATE_RFC850, strtotime($parameters[0])) . '`';
                 $attributeData['value'] = date(DATE_RFC850, strtotime('+1 day', strtotime($parameters[0])));
                 break;
             case 'alpha':
@@ -171,40 +171,40 @@ 
                 $attributeData['value'] = $faker->randomElement($parameters);
                 break;
             case 'not_in':
-                $attributeData['description'][] = 'Not in: '.$this->fancyImplode($parameters, ', ', ' or ');
+                $attributeData['description'][] = 'Not in: ' . $this->fancyImplode($parameters, ', ', ' or ');
                 $attributeData['value'] = $faker->word;
                 break;
             case 'min':
-                $attributeData['description'][] = 'Minimum: `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Minimum: `' . $parameters[0] . '`';
                 break;
             case 'max':
-                $attributeData['description'][] = 'Maximum: `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Maximum: `' . $parameters[0] . '`';
                 break;
             case 'between':
                 $attributeData['type'] = 'numeric';
-                $attributeData['description'][] = 'Between: `'.$parameters[0].'` and `'.$parameters[1].'`';
+                $attributeData['description'][] = 'Between: `' . $parameters[0] . '` and `' . $parameters[1] . '`';
                 $attributeData['value'] = $faker->numberBetween($parameters[0], $parameters[1]);
                 break;
             case 'before':
                 $attributeData['type'] = 'date';
-                $attributeData['description'][] = 'Must be a date preceding: `'.date(DATE_RFC850, strtotime($parameters[0])).'`';
+                $attributeData['description'][] = 'Must be a date preceding: `' . date(DATE_RFC850, strtotime($parameters[0])) . '`';
                 $attributeData['value'] = date(DATE_RFC850, strtotime('-1 day', strtotime($parameters[0])));
                 break;
             case 'date_format':
                 $attributeData['type'] = 'date';
-                $attributeData['description'][] = 'Date format: `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Date format: `' . $parameters[0] . '`';
                 break;
             case 'different':
-                $attributeData['description'][] = 'Must have a different value than parameter: `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Must have a different value than parameter: `' . $parameters[0] . '`';
                 break;
             case 'digits':
                 $attributeData['type'] = 'numeric';
-                $attributeData['description'][] = 'Must have an exact length of `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Must have an exact length of `' . $parameters[0] . '`';
                 $attributeData['value'] = $faker->randomNumber($parameters[0], true);
                 break;
             case 'digits_between':
                 $attributeData['type'] = 'numeric';
-                $attributeData['description'][] = 'Must have a length between `'.$parameters[0].'` and `'.$parameters[1].'`';
+                $attributeData['description'][] = 'Must have a length between `' . $parameters[0] . '` and `' . $parameters[1] . '`';
                 break;
             case 'image':
                 $attributeData['type'] = 'image';
@@ -217,38 +217,38 @@ 
                 break;
             case 'mimetypes':
             case 'mimes':
-                $attributeData['description'][] = 'Allowed mime types: '.$this->fancyImplode($parameters, ', ', ' or ');
+                $attributeData['description'][] = 'Allowed mime types: ' . $this->fancyImplode($parameters, ', ', ' or ');
                 break;
             case 'required_if':
-                $attributeData['description'][] = 'Required if `'.$parameters[0].'` is `'.$parameters[1].'`';
+                $attributeData['description'][] = 'Required if `' . $parameters[0] . '` is `' . $parameters[1] . '`';
                 break;
             case 'required_unless':
-                $attributeData['description'][] = 'Required unless `'.$parameters[0].'` is `'.$parameters[1].'`';
+                $attributeData['description'][] = 'Required unless `' . $parameters[0] . '` is `' . $parameters[1] . '`';
                 break;
             case 'required_with':
-                $attributeData['description'][] = 'Required if the parameters '.$this->fancyImplode($parameters, ', ', ' or ').' are present.';
+                $attributeData['description'][] = 'Required if the parameters ' . $this->fancyImplode($parameters, ', ', ' or ') . ' are present.';
                 break;
             case 'required_with_all':
-                $attributeData['description'][] = 'Required if the parameters '.$this->fancyImplode($parameters, ', ', ' and ').' are present.';
+                $attributeData['description'][] = 'Required if the parameters ' . $this->fancyImplode($parameters, ', ', ' and ') . ' are present.';
                 break;
             case 'required_without':
-                $attributeData['description'][] = 'Required if the parameters '.$this->fancyImplode($parameters, ', ', ' or ').' are not present.';
+                $attributeData['description'][] = 'Required if the parameters ' . $this->fancyImplode($parameters, ', ', ' or ') . ' are not present.';
                 break;
             case 'required_without_all':
-                $attributeData['description'][] = 'Required if the parameters '.$this->fancyImplode($parameters, ', ', ' and ').' are not present.';
+                $attributeData['description'][] = 'Required if the parameters ' . $this->fancyImplode($parameters, ', ', ' and ') . ' are not present.';
                 break;
             case 'same':
-                $attributeData['description'][] = 'Must be the same as `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Must be the same as `' . $parameters[0] . '`';
                 break;
             case 'size':
-                $attributeData['description'][] = 'Must have the size of `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Must have the size of `' . $parameters[0] . '`';
                 break;
             case 'timezone':
                 $attributeData['description'][] = 'Must be a valid timezone identifier';
                 $attributeData['value'] = $faker->timezone;
                 break;
             case 'exists':
-                $attributeData['description'][] = 'Valid '.Str::singular($parameters[0]).' '.$parameters[1];
+                $attributeData['description'][] = 'Valid ' . Str::singular($parameters[0]) . ' ' . $parameters[1];
                 break;
             case 'active_url':
                 $attributeData['type'] = 'url';
@@ -256,7 +256,7 @@ 
                 break;
             case 'regex':
                 $attributeData['type'] = 'string';
-                $attributeData['description'][] = 'Must match this regular expression: `'.$parameters[0].'`';
+                $attributeData['description'][] = 'Must match this regular expression: `' . $parameters[0] . '`';
                 break;
             case 'boolean':
                 $attributeData['value'] = true;
@@ -351,8 +351,8 @@ 
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
 
-            if (! starts_with($name, $prefix) && $name != 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!starts_with($name, $prefix) && $name != 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
 
             $server[$name] = $value;

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     /**
      * Execute the console command.
      *
-     * @return mixed
+     * @return false|null
      */
     public function handle()
     {

Spacing +6 added lines, -6 removed lines

@@ -50,7 +50,7 @@ 
         $routePrefix = $this->option('routePrefix');
         $actAs = $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;
@@ -75,7 +75,7 @@ 
         foreach ($routes as $route) {
             if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->getUri())) {
                 $parsedRoutes[] = $generator->processRoute($route);
-                $this->info('Processed route: '.$route->getUri());
+                $this->info('Processed route: ' . $route->getUri());
             }
         }
 
@@ -93,18 +93,18 @@ 
 
         $markdown = view('apidoc::documentarian')->with('parsedRoutes', $parsedRoutes);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
-        file_put_contents($outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md', $markdown);
+        file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md', $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');
     }
 }

src/Mpociot/ApiDoc/Commands/UpdateDocumentation.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     /**
      * Execute the console command.
      *
-     * @return mixed
+     * @return false|null
      */
     public function handle()
     {

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/ApiDocGeneratorServiceProvider.php

Spacing +3 added lines, -3 removed lines

@@ -16,7 +16,7 @@ 
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../../resources/views/', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../../resources/views/', 'apidoc');
     }
 
     /**
@@ -24,10 +24,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();
         });