Cherry-Pie / ApiDocs

src/ApiDocs.php

Doc Comments +6 added lines

@@ -179,6 +179,9 @@ 
         return isset($matches[1]) ? $matches[1] : [];
     } // end getUriParams
     
+    /**
+     * @param string $key
+     */
     private function generateHashForUrl($key, $route, $method)
     {
         $path = preg_replace('~\s+~', '-', $key);
@@ -203,6 +206,9 @@ 
         return preg_split($splitCamelCaseRegexp, $chunk);
     } // end splitCamelCaseToWords
     
+    /**
+     * @param string $param
+     */
     private function getRouteParam($route, $param)
     {
         $route = (array) $route;

Spacing +6 added lines, -7 removed lines

@@ -113,7 +113,7 @@ 
     
     private function isPrefixedRoute($route, $routePrefix)
     {
-        $regexp = '~^'. preg_quote($routePrefix) .'~';
+        $regexp = '~^'.preg_quote($routePrefix).'~';
         
         return preg_match($regexp, $this->getRouteParam($route, 'uri'));
     } // end isPrefixedRoute
@@ -165,7 +165,7 @@ 
         $checkForLongDescription = true;
         foreach ($docs as $line) {
             if ($checkForLongDescription && !preg_match('~^@\w+~', $line)) {
-                $description .= trim($line) .' ';
+                $description .= trim($line).' ';
             } elseif (preg_match('~^@\w+~', $line)) {
                 $checkForLongDescription = false;
                 if (preg_match('~^@param~', $line)) {
@@ -185,7 +185,7 @@ 
 
         // TODO:
         $rules = [];
-        foreach($reflectorMethod->getParameters() as $reflectorParam) {
+        foreach ($reflectorMethod->getParameters() as $reflectorParam) {
             $paramClass = $reflectorParam->getClass();
             if ($paramClass instanceof ReflectionClass) {
                 $name = $paramClass->getName();
@@ -297,7 +297,7 @@ 
         $httpMethod = $this->getRouteParam($route, 'methods.0');
         $classMethod = implode('-', $this->splitCamelCaseToWords($method));
         
-        $hash = $path .'::'. $httpMethod .'::'. $classMethod;
+        $hash = $path.'::'.$httpMethod.'::'.$classMethod;
         
         return strtolower($hash);
     } // end generateHashForUrl
@@ -330,8 +330,7 @@ 
     private function ins(&$ary, $keys, $val) 
     {
         $keys ? 
-            $this->ins($ary[array_shift($keys)], $keys, $val) :
-            $ary = $val;
+            $this->ins($ary[array_shift($keys)], $keys, $val) : $ary = $val;
     } // end ins
     
     private function arrayGet($array, $key, $default = null)
@@ -345,7 +344,7 @@ 
         }
         
         foreach (explode('.', $key) as $segment) {
-            if (!is_array($array) || ! array_key_exists($segment, $array)) {
+            if (!is_array($array) || !array_key_exists($segment, $array)) {
                 return $default;
             }
             $array = $array[$segment];

src/Blueprint.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         $this->endpoints = $endpoints;
     }
     
+    /**
+     * @return string
+     */
     public function render()
     {
         $host = $this->config->get('yaro.apidocs.blueprint.host');

Spacing +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
 
     public function create(string $snapshotName = '', string $diskName = '')
     {
-        $snapshotName = $snapshotName ?: 'blueprint_'. date('Y-m-d_H-i-s');
+        $snapshotName = $snapshotName ?: 'blueprint_'.date('Y-m-d_H-i-s');
         $diskName = $diskName ?: $this->config->get('yaro.apidocs.blueprint.disc');
         
         $disk = $this->getDisk($diskName);

src/ServiceProvider.php

Spacing +3 added lines, -3 removed lines

@@ -12,10 +12,10 @@ 
     public function boot()
     {
         $this->publishes([
-            __DIR__ . '/../config/apidocs.php' => config_path('yaro.apidocs.php'),
+            __DIR__.'/../config/apidocs.php' => config_path('yaro.apidocs.php'),
         ], 'config');
         
-        $this->app['view']->addNamespace('apidocs', __DIR__ . '/../resources/views');
+        $this->app['view']->addNamespace('apidocs', __DIR__.'/../resources/views');
         
         $this->app->bind('command.apidocs:blueprint-create', BlueprintCreate::class);
         $this->commands([
@@ -25,7 +25,7 @@ 
 
     public function register()
     {
-        $configPath = __DIR__ . '/../config/apidocs.php';
+        $configPath = __DIR__.'/../config/apidocs.php';
         $this->mergeConfigFrom($configPath, 'yaro.apidocs');
         
         $this->app->singleton('yaro.apidocs', function($app) {

config/apidocs.php

Indentation +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
     /**
      * Exclude specific routes from documentation. Asterisks may be used to indicate wildcards.
      */
-     'exclude' => [
+        'exclude' => [
         'classes' => [
             // 'App\Http\Controllers\*' - exclude all controllers from docs.
             // 'App\Http\Controllers\MyController@*' - remove all methods for specific controller from docs.
@@ -34,7 +34,7 @@ 
             // 'payment/test',
             // 'simulate/*',
         ],
-     ],
+        ],
     
     /**
      * Image src for logo.