caoym / phpboot

src/Docgen/Swagger/Swagger.php

Doc Comments +9 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
     }
 
     /**
-     * @param $object
+     * @param Swagger $object
      * @return array
      */
     static public function objectToArray($object)
@@ -118,7 +118,7 @@ 
     /**
      * @param Application $app
      * @param ControllerContainer $controller
-     * @param $action
+     * @param integer $action
      * @param Route $route
      * @return array
      */
@@ -167,7 +167,7 @@ 
     /**
      * @param Application $app
      * @param ControllerContainer $controller
-     * @param $action
+     * @param integer $action
      * @param Route $route
      * @return null|ResponseObject
      */
@@ -305,6 +305,9 @@ 
         return new RefSchemaObject("#/definitions/$name");
     }
 
+    /**
+     * @param integer $action
+     */
     public function getParamsSchema(Application $app,
                                     ControllerContainer $controller,
                                     $action,
@@ -577,6 +580,9 @@ 
         return $className;
     }
 
+    /**
+     * @param string $glue
+     */
     static public function implode($glue , array $pieces )
     {
         $pieces = array_filter($pieces, function($i){return trim($i) !== '';});

Spacing +32 added lines, -32 removed lines

@@ -58,7 +58,7 @@ 
             $op->description = $route->getDescription();
 
             $op->parameters = $this->getParamsSchema($app, $controller, $action, $route);
-            if($this->hasFileParam($route)){
+            if ($this->hasFileParam($route)) {
                 $op->consumes = ['multipart/form-data'];
             }
 
@@ -108,7 +108,7 @@ 
             }
             if (is_array($v) || is_object($v)) {
                 $res[$k] = self::objectToArray($v);
-            } else {
+            }else {
                 $res[$k] = $v;
             }
         }
@@ -140,21 +140,21 @@ 
             //TODO status 重复怎么办
             if ($ins instanceof HttpException) {
                 $status = $ins->getStatusCode();
-            } else {
+            }else {
 
                 $status = 500;
             }
             if (isset($schemas[$status])) {
                 //$this->warnings[] = "status response $status has been used for $name, $desc";
                 $res = $schemas[$status];
-            } else {
+            }else {
                 $res = new ResponseObject();
             }
             $shortName = self::getShortClassName($name);
             $desc = "$shortName: $desc";
             $res->description = self::implode("\n", [$res->description, $desc]);
             $error = $app->get(ExceptionRenderer::class)->render($ins)->getContent();
-            if($error){
+            if ($error) {
                 $res->examples = [$shortName => $error];
             }
             //$res->schema = new RefSchemaObject("#/definitions/$name");
@@ -213,9 +213,9 @@ 
     {
         if ($content instanceof ReturnMeta || $content instanceof ParamMeta) {
             return $this->makeExample($content->container);
-        }elseif ($content instanceof TypeContainerInterface){
+        }elseif ($content instanceof TypeContainerInterface) {
             return $content->makeExample();
-        }elseif(is_array($content)) {
+        }elseif (is_array($content)) {
             $res = [];
             foreach ($content as $k => $v) {
                 $res[$k] = $this->makeExample($v);
@@ -240,7 +240,7 @@ 
                                    array $arr, $suffix)
     {
         $className = self::getShortClassName($controller->getClassName());
-        $name = $className . ucfirst($action) . $suffix;
+        $name = $className.ucfirst($action).$suffix;
 
         $schema = new SimpleModelSchemaObject();
 
@@ -258,7 +258,7 @@ 
                 } elseif ($v->container instanceof EntityContainer) {
                     $sub = $this->getRefSchema($app, $controller, $action, $route, $v->container);
                     //TODO array for validation
-                } else {
+                }else {
                     $sub = new PrimitiveSchemaObject();
                     $sub->type = self::mapType($v->type);
                     self::mapValidation($v->validation, $sub);
@@ -270,14 +270,14 @@ 
                     $schema->required[] = $k;
                 }
                 $schema->properties[$k] = $sub;
-            } else {
+            }else {
                 //TODO how to do?
             }
         }
         $unused = $name;
         $tempId = 0;
         while (isset($this->definitions[$unused])) {
-            $unused = $name . $tempId;
+            $unused = $name.$tempId;
             $tempId++;
         }
         $this->definitions[$unused] = $schema;
@@ -316,7 +316,7 @@ 
         $in = 'query';
 
         $bodyType = 'body'; // 当有文件上传时, 必须是formData方式
-        if($this->hasFileParam($route)){
+        if ($this->hasFileParam($route)) {
             $bodyType = 'formData';
         }
 
@@ -355,7 +355,7 @@ 
                     || $route->getMethod() == 'PATCH'
                 ) {
                     $in = $bodyType;
-                } else {
+                }else {
                     $in = 'query';
                 }
             }
@@ -366,11 +366,11 @@ 
                 } elseif ($param->container instanceof EntityContainer) {
                     $paramSchema = $this->getRefSchema($app, $controller, $action, $route, $param->container);
                     //TODO array for validation
-                } else {
+                }else {
                     $paramSchema = new PrimitiveSchemaObject();
-                    if($isFile){
+                    if ($isFile) {
                         $paramSchema->type = 'file';
-                    }else{
+                    }else {
                         $paramSchema->type = self::mapType($param->type);
                         self::mapValidation($param->validation, $paramSchema);
                     }
@@ -382,10 +382,10 @@ 
                 $paramSchema->default = $param->default;
                 $paramSchema->required = !$param->isOptional;
                 $parameters[] = $paramSchema;
-            } else {
+            }else {
                 if (!$name) {
                     $body = $param;
-                } else {
+                }else {
                     ArrayHelper::set($body, $name, $param);
                 }
 
@@ -398,7 +398,7 @@ 
             $paramSchema->in = 'body';
             if (is_array($body)) {
                 $paramSchema->schema = $this->makeTempSchema($app, $controller, $action, $route, $body, 'Req');
-            } else {
+            }else {
                 $paramSchema->schema = $this->getAnySchema($app, $controller, $action, $route, $body->container);
             }
 
@@ -425,8 +425,8 @@ 
         } elseif ($container instanceof ScalarTypeContainer) {
             $schema = new PrimitiveSchemaObject();
             $schema->type = self::mapType($container->getType());
-        } elseif($container == null){
-            $schema = null ;//new PrimitiveSchemaObject();
+        } elseif ($container == null) {
+            $schema = null; //new PrimitiveSchemaObject();
             //$schema->type = null;
         }else {
             $schema = new PrimitiveSchemaObject();
@@ -458,7 +458,7 @@ 
         } elseif ($itemContainer instanceof ScalarTypeContainer) {
             $itemSchema = new PrimitiveSchemaObject();
             $itemSchema->type = self::mapType($itemContainer->getType());
-        } else {
+        }else {
             $itemSchema = new PrimitiveSchemaObject();
             //$itemSchema->type = 'mixed';
         }
@@ -484,7 +484,7 @@ 
                 $propertySchema = $this->getRefSchema($app, $controller, $action, $route, $property->container);
             } elseif ($property->container instanceof ArrayContainer) {
                 $propertySchema = $this->getArraySchema($app, $controller, $action, $route, $property->container);
-            } else {
+            }else {
                 $propertySchema = new PrimitiveSchemaObject();
                 $propertySchema->type = self::mapType($property->type);
                 $propertySchema->description = self::implode("\n", [$property->summary, $property->description]);
@@ -501,7 +501,7 @@ 
     {
         $params = $route->getRequestHandler()->getParamMetas();
         foreach ($params as $name => $param) {
-            if(strpos($param->source, 'request.files.')===0){
+            if (strpos($param->source, 'request.files.') === 0) {
                 return true;
             }
         }
@@ -514,7 +514,7 @@ 
      */
     static public function mapValidation($v, PrimitiveSchemaObject $schemaObject)
     {
-        if(!$v){
+        if (!$v) {
             return $schemaObject;
         }
         $rules = explode('|', $v);
@@ -530,15 +530,15 @@ 
             } elseif ($rule == 'lengthBetween' && isset($params[0]) && isset($params[1])) {
                 $schemaObject->minLength = intval($params[0]);
                 $schemaObject->maxLength = intval($params[1]);
-            } elseif ($rule == 'lengthMin'&& isset($params[0])) {
+            } elseif ($rule == 'lengthMin' && isset($params[0])) {
                 $schemaObject->minLength = intval($params[0]);
-            } elseif ($rule == 'lengthMax'&& isset($params[0])) {
+            } elseif ($rule == 'lengthMax' && isset($params[0])) {
                 $schemaObject->maxLength = intval($params[0]);
-            } elseif ($rule == 'min'&& isset($params[0])) {
+            } elseif ($rule == 'min' && isset($params[0])) {
                 $schemaObject->minimum = floatval($params[0]);
-            } elseif ($rule == 'max'&& isset($params[0])) {
+            } elseif ($rule == 'max' && isset($params[0])) {
                 $schemaObject->maximum = floatval($params[0]);
-            } elseif ($rule == 'regex'&& isset($params[0])) {
+            } elseif ($rule == 'regex' && isset($params[0])) {
                 $schemaObject->pattern = $params[0];
             } elseif ($rule == 'optional') {
                 $schemaObject->required = false;
@@ -577,9 +577,9 @@ 
         return $className;
     }
 
-    static public function implode($glue , array $pieces )
+    static public function implode($glue, array $pieces)
     {
-        $pieces = array_filter($pieces, function($i){return trim($i) !== '';});
+        $pieces = array_filter($pieces, function($i) {return trim($i) !== ''; });
         return implode($glue, $pieces);
     }
 }
\ No newline at end of file