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) !== '';});

src/DB/impls.php

Doc Comments +84 added lines, -1 removed lines

@@ -8,6 +8,11 @@ 
 use PhpBoot\DB\Context;
 
 class ExecResult{
+
+    /**
+     * @param \PDO $pdo
+     * @param \PDOStatement $st
+     */
     public function __construct($success, $pdo, $st){
         $this->pdo = $pdo;
         $this->st = $st;
@@ -41,6 +46,10 @@ 
 
 class SelectImpl
 {
+    /**
+     * @param Context $context
+     * @param string $columns
+     */
     static  public function select($context, $columns){
         $context->appendSql("SELECT $columns");
     }
@@ -48,6 +57,10 @@ 
 
 class FromImpl
 {
+    /**
+     * @param Context $context
+     * @param string $tables
+     */
     static public function from($context, $tables,$as=null){
         if($tables instanceof BasicRule){
             $context->appendSql("FROM (".$tables->context->sql.')');
@@ -63,6 +76,10 @@ 
 
 class DeleteImpl
 {
+    /**
+     * @param Context $context
+     * @param string $from
+     */
     static public function deleteFrom($context, $from)
     {
         $context->appendSql("DELETE FROM ".DB::wrap($from));
@@ -71,6 +88,11 @@ 
 
 class JoinImpl
 {
+    /**
+     * @param Context $context
+     * @param null|string $type
+     * @param string $table
+     */
     static public function join($context, $type, $table) {
         $table = DB::wrap($table);
         if($type){
@@ -83,6 +105,10 @@ 
 
 class JoinOnImpl
 {
+    /**
+     * @param Context $context
+     * @param string $condition
+     */
     static public function on($context, $condition) {
         $context->appendSql("ON $condition");
     }
@@ -90,6 +116,9 @@ 
 
 class ForUpdateImpl
 {
+    /**
+     * @param Context $context
+     */
     static public function forUpdate($context){
         $context->appendSql("FOR UPDATE");
     }
@@ -97,6 +126,10 @@ 
 
 class ForUpdateOfImpl
 {
+    /**
+     * @param Context $context
+     * @param string $column
+     */
     static public function of($context, $column){
         $column = DB::wrap($column);
         $context->appendSql("OF $column");
@@ -105,6 +138,10 @@ 
 
 class InsertImpl
 {
+    /**
+     * @param Context $context
+     * @param string $table
+     */
     static public function insertInto($context, $table) {
         $table = DB::wrap($table);
         $context->appendSql("INSERT INTO $table");
@@ -112,6 +149,10 @@ 
 }
 class ReplaceImpl
 {
+    /**
+     * @param Context $context
+     * @param string $table
+     */
     static public function replaceInto($context, $table) {
         $table = DB::wrap($table);
         $context->appendSql("REPLACE INTO $table");
@@ -119,6 +160,9 @@ 
 }
 class ValuesImpl
 {
+    /**
+     * @param Context $context
+     */
     static public function values($context, $values){
         $params = [];
         $stubs = [];
@@ -148,6 +192,10 @@ 
 
 class UpdateImpl
 {
+    /**
+     * @param Context $context
+     * @param string $table
+     */
     static public function update($context, $table){
         $table = DB::wrap($table);
         $context->appendSql("UPDATE $table");
@@ -164,6 +212,9 @@ 
         }
     }
 
+    /**
+     * @param string $expr
+     */
     public function setExpr(Context $context, $expr, $args){
         if($this->first){
             $this->first = false;
@@ -226,6 +277,11 @@ 
         }
         return $this;
     }
+
+    /**
+     * @param string $column
+     * @param string $order
+     */
     public function orderBy(Context $context, $column, $order=null){
         if(is_string($column)){
             if($order === null){
@@ -243,12 +299,20 @@ 
 
 class LimitImpl
 {
+    /**
+     * @param integer $size
+     */
     static public function limit(Context $context, $size){
         $intSize = intval($size);
         strval($intSize) == $size or \PhpBoot\abort(
             new \InvalidArgumentException("invalid params for limit($size)"));
         $context->appendSql("LIMIT $size");
     }
+
+    /**
+     * @param integer $start
+     * @param integer $size
+     */
     static public function limitWithOffset(Context $context, $start, $size){
         $intStart = intval($start);
         $intSize = intval($size);
@@ -260,6 +324,9 @@ 
 
 class WhereImpl{
 
+    /**
+     * @param string $str
+     */
     static private function findQ($str,$offset = 0,$no=0){
         $found = strpos($str, '?', $offset);
         if($no == 0 || $found === false){
@@ -268,6 +335,9 @@ 
         return self::findQ($str, $found+1, $no-1);
     }
 
+    /**
+     * @param string $prefix
+     */
     static public function where(Context $context, $prefix, $expr, $args){
         if(empty($expr)){
             return;
@@ -373,6 +443,10 @@ 
 
         self::condition($context, $prefix, implode(' AND ', $exprs), $params);
     }
+
+    /**
+     * @param string $expr
+     */
     static public function condition(Context $context, $prefix, $expr, $args){
         if(!empty($expr)){
             $expr = "($expr)";
@@ -441,6 +515,10 @@ 
 }
 
 class GroupByImpl{
+
+    /**
+     * @param string $column
+     */
     static public function groupBy(Context $context, $column){
         $column = DB::wrap($column);
         $context->appendSql("GROUP BY $column");
@@ -463,7 +541,6 @@ 
     /**
      *
      * @param Context $context
-     * @param string|false $asDict return  as dict or array
      * @return false|array
      */
     static public function get($context, $dictAs=false){
@@ -522,6 +599,9 @@ 
 }
 class OnDuplicateKeyUpdateImpl
 {
+    /**
+     * @param Context $context
+     */
     public function set($context, $column, $value){
         if(is_string($column)){
             $this->setExpr($context, $column, $value);
@@ -530,6 +610,9 @@ 
         }
     }
 
+    /**
+     * @param string $expr
+     */
     public function setExpr($context, $expr, $args){
         $prefix = '';
         if($this->first){

src/DB/rules/basic.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
 
 class OrderByRule extends LimitRule
 {
+    /**
+     * @param Context $context
+     */
     public function __construct($context){
         parent::__construct($context);
         $this->impl = new OrderByImpl();

src/DB/rules/select.php

Doc Comments +4 added lines, -1 removed lines

@@ -113,6 +113,9 @@ 
 
 class OrderByRule extends LimitRule
 {
+    /**
+     * @param Context $context
+     */
     public function __construct($context){
         parent::__construct($context);
         $this->order = new OrderByImpl();
@@ -260,7 +263,7 @@ 
      *      "WHERE a=1 AND b IN(1,2) AND c BETWEEN 1 AND 2 AND d<>1"
      *
      * @param string|array|callable $conditions
-     * @param mixed $_
+     * @param string $_
      * @return \PhpBoot\DB\rules\select\WhereRule
      */
     public function where($conditions=null, $_=null) {

src/DB/rules/update.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 
 class UpdateSetRule extends BasicRule
 {
+    /**
+     * @param \PhpBoot\DB\Context $context
+     */
     public function __construct($context){
         parent::__construct($context);
         $this->impl = new UpdateSetImpl();

src/ORM/ModelWithClass.php

Doc Comments +1 added lines, -2 removed lines

@@ -49,7 +49,6 @@ 
 
     /**
      * where 语法见 @see WhereRule
-     * @param array|string $expr
      * @param mixed|null $_
      * @return \PhpBoot\DB\rules\basic\WhereRule
      */
@@ -91,7 +90,7 @@ 
     /**
      * @param int|string $id
      * @param array $values
-     * @return int updated row count
+     * @return \PhpBoot\DB\impls\ExecResult updated row count
      */
     public function update($id, $values)
     {