@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | |
68 | 68 | $this->setUserToBeImpersonated($this->option('actAsUserId')); |
69 | 69 | |
70 | - if ($routePrefix === null && ! count($allowedRoutes)) { |
|
70 | + if ($routePrefix === null && !count($allowedRoutes)) { |
|
71 | 71 | $this->error('You must provide either a route prefix or a route to generate the documentation.'); |
72 | 72 | |
73 | 73 | return false; |
@@ -91,15 +91,15 @@ discard block |
||
91 | 91 | private function writeMarkdown($parsedRoutes) |
92 | 92 | { |
93 | 93 | $outputPath = $this->option('output'); |
94 | - $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md'; |
|
95 | - $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md'; |
|
94 | + $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md'; |
|
95 | + $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md'; |
|
96 | 96 | |
97 | 97 | $infoText = view('apidoc::partials.info') |
98 | 98 | ->with('outputPath', $this->option('output')) |
99 | - ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')); |
|
99 | + ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')); |
|
100 | 100 | |
101 | - $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) { |
|
102 | - return $routeGroup->map(function ($route) { |
|
101 | + $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) { |
|
102 | + return $routeGroup->map(function($route) { |
|
103 | 103 | $route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route); |
104 | 104 | |
105 | 105 | return $route; |
@@ -123,16 +123,16 @@ discard block |
||
123 | 123 | $frontmatter = trim($generatedFrontmatter[1], "\n"); |
124 | 124 | } |
125 | 125 | |
126 | - $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
127 | - return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) { |
|
128 | - if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch)) { |
|
129 | - $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]); |
|
130 | - if ($routeDocumentationChanged === false || $this->option('force')) { |
|
126 | + $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
127 | + return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) { |
|
128 | + if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch)) { |
|
129 | + $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]); |
|
130 | + if ($routeDocumentationChanged === false || $this->option('force')) { |
|
131 | 131 | if ($routeDocumentationChanged) { |
132 | - $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
132 | + $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
133 | 133 | } |
134 | 134 | } else { |
135 | - $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
135 | + $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
136 | 136 | $route['modified_output'] = $routeMatch[0]; |
137 | 137 | } |
138 | 138 | } |
@@ -149,10 +149,10 @@ discard block |
||
149 | 149 | ->with('frontmatter', $frontmatter) |
150 | 150 | ->with('infoText', $infoText) |
151 | 151 | ->with('outputPath', $this->option('output')) |
152 | - ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')) |
|
152 | + ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')) |
|
153 | 153 | ->with('parsedRoutes', $parsedRouteOutput); |
154 | 154 | |
155 | - if (! is_dir($outputPath)) { |
|
155 | + if (!is_dir($outputPath)) { |
|
156 | 156 | $documentarian->create($outputPath); |
157 | 157 | } |
158 | 158 | |
@@ -165,24 +165,24 @@ discard block |
||
165 | 165 | ->with('frontmatter', $frontmatter) |
166 | 166 | ->with('infoText', $infoText) |
167 | 167 | ->with('outputPath', $this->option('output')) |
168 | - ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')) |
|
168 | + ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')) |
|
169 | 169 | ->with('parsedRoutes', $parsedRouteOutput); |
170 | 170 | |
171 | 171 | file_put_contents($compareFile, $compareMarkdown); |
172 | 172 | |
173 | - $this->info('Wrote index.md to: '.$outputPath); |
|
173 | + $this->info('Wrote index.md to: ' . $outputPath); |
|
174 | 174 | |
175 | 175 | $this->info('Generating API HTML code'); |
176 | 176 | |
177 | 177 | $documentarian->generate($outputPath); |
178 | 178 | |
179 | - $this->info('Wrote HTML documentation to: '.$outputPath.'/public/index.html'); |
|
179 | + $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html'); |
|
180 | 180 | |
181 | 181 | |
182 | 182 | if ($this->option('noPostmanCollection') !== true) { |
183 | 183 | $this->info('Generating Postman collection'); |
184 | 184 | |
185 | - file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes)); |
|
185 | + file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes)); |
|
186 | 186 | } |
187 | 187 | } |
188 | 188 | |
@@ -210,7 +210,7 @@ discard block |
||
210 | 210 | */ |
211 | 211 | private function setUserToBeImpersonated($actAs) |
212 | 212 | { |
213 | - if (! empty($actAs)) { |
|
213 | + if (!empty($actAs)) { |
|
214 | 214 | if (version_compare($this->laravel->version(), '5.2.0', '<')) { |
215 | 215 | $userModel = config('auth.model'); |
216 | 216 | $user = $userModel::find($actAs); |
@@ -252,9 +252,9 @@ discard block |
||
252 | 252 | if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->getUri())) { |
253 | 253 | if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) { |
254 | 254 | $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse); |
255 | - $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->getUri()); |
|
255 | + $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri()); |
|
256 | 256 | } else { |
257 | - $this->warn('Skipping route: ['.implode(',', $route->getMethods()).'] '.$route->getUri()); |
|
257 | + $this->warn('Skipping route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri()); |
|
258 | 258 | } |
259 | 259 | } |
260 | 260 | } |
@@ -278,7 +278,7 @@ discard block |
||
278 | 278 | foreach ($routes as $route) { |
279 | 279 | if (empty($allowedRoutes) || in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->uri())) { |
280 | 280 | $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse); |
281 | - $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->uri()); |
|
281 | + $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri()); |
|
282 | 282 | } |
283 | 283 | } |
284 | 284 | |
@@ -292,7 +292,7 @@ discard block |
||
292 | 292 | */ |
293 | 293 | private function isValidRoute($route) |
294 | 294 | { |
295 | - return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']); |
|
295 | + return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']); |
|
296 | 296 | } |
297 | 297 | |
298 | 298 | /** |
@@ -309,7 +309,7 @@ discard block |
||
309 | 309 | $phpdoc = new DocBlock($comment); |
310 | 310 | |
311 | 311 | return collect($phpdoc->getTags()) |
312 | - ->filter(function ($tag) use ($route) { |
|
312 | + ->filter(function($tag) use ($route) { |
|
313 | 313 | return $tag->getName() === 'hideFromAPIDocumentation'; |
314 | 314 | }) |
315 | 315 | ->isEmpty(); |