Remove useless comments and translate comments

swoft-cloud · Mar 9, 2018 · 01690a8 · 01690a8
1 parent 9ed9341
commit 01690a8
Show file tree

Hide file tree

Showing 10 changed files with 156 additions and 216 deletions.
diff --git a/src/DbCoResult.php b/src/DbCoResult.php
@@ -8,30 +8,32 @@
 use Swoft\Db\Helper\EntityHelper;
 
 /**
- * The cor result of db
+ * Class DbCoResult
+ *
+ * @package Swoft\Db
  */
 class DbCoResult extends AbstractCoResult
 {
     /**
-     * 是否是插入操作
+     * Is insert operation
      *
      * @var bool
      */
-    private $isInsert = false;
+    private $insert = false;
 
     /**
-     * 是否是更新或删除操作
+     * Is update or delete operation
      *
      * @var bool
      */
-    private $isUpdateOrDelete = false;
+    private $updateOrDelete = false;
 
     /**
-     * 是否查找一条数据
+     * Is find one entity operation
      *
      * @var bool
      */
-    private $isFindOne = false;
+    private $findOne = false;
 
     /**
      * @var string
@@ -40,25 +42,24 @@ class DbCoResult extends AbstractCoResult
 
     /**
      * @param array ...$params
-     *
      * @return mixed
      */
     public function getResult(...$params)
     {
-        $className = "";
-        if (!empty($params)) {
+        $className = '';
+        if (! empty($params)) {
             list($className) = $params;
         }
 
         $result = $this->recv(true);
         $result = $this->transferResult($result);
 
-        // 日志记录处理
+        // Logger
         list(, $sqlId) = explode('.', $this->profileKey);
         App::debug("SQL语句执行结果(defer) sqlId=$sqlId result=" . json_encode($result));
 
-        // fill data to entity
-        if (is_array($result) && !empty($className)) {
+        // Fill data to Entity
+        if (\is_array($result) && ! empty($className)) {
             $result = EntityHelper::resultToEntity($result, $className);
         }
 
@@ -67,48 +68,45 @@ public function getResult(...$params)
 
     /**
      * @param bool $defer
-     *
      * @return mixed
      */
     public function recv($defer = false)
     {
         $result = $this->client->recv();
 
-        // 重置延迟设置
-        if ($defer) {
-            $this->client->setDefer(false);
-        }
+        // Reset defer status
+        $defer && $this->client->setDefer(false);
 
         $isSqlSession = DbHelper::isContextTransaction($this->poolId);
-        if ($this->connectPool !== null && $isSqlSession == false) {
+        if ($this->connectPool !== null && ! $isSqlSession) {
             $this->connectPool->release($this->client);
         }
 
         return $result;
     }
 
     /**
-     * @param bool $isInsert
+     * @param bool $insert
      */
-    public function setIsInsert(bool $isInsert)
+    public function setInsert(bool $insert)
     {
-        $this->isInsert = $isInsert;
+        $this->insert = $insert;
     }
 
     /**
-     * @param bool $isUpdateOrDelete
+     * @param bool $updateOrDelete
      */
-    public function setIsUpdateOrDelete(bool $isUpdateOrDelete)
+    public function setUpdateOrDelete(bool $updateOrDelete)
     {
-        $this->isUpdateOrDelete = $isUpdateOrDelete;
+        $this->updateOrDelete = $updateOrDelete;
     }
 
     /**
-     * @param bool $isFindOne
+     * @param bool $findOne
      */
-    public function setIsFindOne(bool $isFindOne)
+    public function setFindOne(bool $findOne)
     {
-        $this->isFindOne = $isFindOne;
+        $this->findOne = $findOne;
     }
 
     /**
@@ -123,16 +121,15 @@ public function setPoolId(string $poolId)
      * 转换结果
      *
      * @param mixed $result 查询结果
-     *
      * @return mixed
      */
     private function transferResult($result)
     {
-        if ($this->isInsert && $result !== false) {
+        if ($this->insert && $result !== false) {
             $result = $this->client->getInsertId();
-        } elseif ($this->isUpdateOrDelete && $result !== false) {
+        } elseif ($this->updateOrDelete && $result !== false) {
             $result = $this->client->getAffectedRows();
-        } elseif ($this->isFindOne && $result != false) {
+        } elseif ($this->findOne && $result !== false) {
             $result = $result[0] ?? [];
         }
         return $result;

diff --git a/src/DbDataResult.php b/src/DbDataResult.php
@@ -6,25 +6,26 @@
 use Swoft\Db\Helper\EntityHelper;
 
 /**
- * The sync result of db
+ * Class DbDataResult
+ *
+ * @package Swoft\Db
  */
 class DbDataResult extends AbstractDataResult
 {
     /**
      * @param array ...$params
-     *
      * @return mixed
      */
     public function getResult(...$params)
     {
-        $className = "";
+        $className = '';
         $result = $this->data;
-        if (!empty($params)) {
+        if (! empty($params)) {
             list($className) = $params;
         }
 
-        // fill data to entity
-        if (is_array($result) && !empty($className)) {
+        // Fill data to Entity
+        if (\is_array($result) && ! empty($className)) {
             $result = EntityHelper::resultToEntity($result, $className);
         }
 

diff --git a/src/Driver/Mysql/QueryBuilder.php b/src/Driver/Mysql/QueryBuilder.php
@@ -11,34 +11,27 @@
 use Swoft\Helper\JsonHelper;
 
 /**
- * Mysql查询器
- *
- * @uses      QueryBuilder
- * @version   2017年09月01日
- * @author    stelin <[email protected]>
- * @copyright Copyright 2010-2016 swoft software
- * @license   PHP Version 7.x {@link http://www.php.net/license/3_0.txt}
+ * Mysql query builder
  */
 class QueryBuilder extends \Swoft\Db\QueryBuilder
 {
     /**
      * @var string
      */
-    private $profilePrefix = "mysql";
+    private $profilePrefix = 'mysql';
 
     /**
      * @return ResultInterface
      */
     public function execute()
     {
-        if(App::isCoContext()){
+        if (App::isCoContext()) {
             return $this->getCorResult();
         }
         return $this->getSyncResult();
     }
 
     /**
-     *
      * @return DbDataResult
      */
     private function getSyncResult()
@@ -52,15 +45,15 @@ private function getSyncResult()
         $result = $this->connect->execute($this->parameters);
 
         App::profileEnd($profileKey);
-        App::debug(sprintf("sql execute sqlId=%s, result=%s, sql=%s", $sqlId, JsonHelper::encode($result, JSON_UNESCAPED_UNICODE), $sql));
+        App::debug(sprintf('sql execute sqlId=%s, result=%s, sql=%s', $sqlId, JsonHelper::encode($result, JSON_UNESCAPED_UNICODE), $sql));
 
         $result = $this->transferResult($result);
 
-        if (is_array($result) && !empty($className)) {
+        if (is_array($result) && ! empty($className)) {
             $result = EntityHelper::resultToEntity($result, $className);
         }
 
-        if (!DbHelper::isContextTransaction($this->poolId)) {
+        if (! DbHelper::isContextTransaction($this->poolId)) {
             $this->pool->release($this->connect);
         }
 
@@ -81,28 +74,27 @@ private function getCorResult()
         $this->connect->prepare($sql);
         $result = $this->connect->execute($this->parameters);
 
-        App::debug(sprintf("sql execute sqlId=%s, sql=%s", $sqlId, $sql));
+        App::debug(sprintf('sql execute sqlId=%s, sql=%s', $sqlId, $sql));
         $isUpdateOrDelete = $this->isDelete() || $this->isUpdate();
-        $isFindOne        = $this->isSelect() && isset($this->limit['limit']) && $this->limit['limit'] == 1;
-        $corResult        = new DbCoResult($this->connect, $profileKey, $this->pool);
+        $isFindOne = $this->isSelect() && isset($this->limit['limit']) && $this->limit['limit'] === 1;
+        $corResult = new DbCoResult($this->connect, $profileKey, $this->pool);
 
         // 结果转换参数
         $corResult->setPoolId($this->poolId);
-        $corResult->setIsInsert($this->isInsert());
-        $corResult->setIsUpdateOrDelete($isUpdateOrDelete);
-        $corResult->setIsFindOne($isFindOne);
+        $corResult->setInsert($this->isInsert());
+        $corResult->setUpdateOrDelete($isUpdateOrDelete);
+        $corResult->setFindOne($isFindOne);
 
         return $corResult;
     }
 
     /**
      * @param string $sql
-     *
      * @return array
      */
     private function getSqlIdAndProfileKey(string $sql)
     {
-        $sqlId      = md5($sql);
+        $sqlId = md5($sql);
         $profileKey = sprintf('%s.%s', $sqlId, $this->profilePrefix);
 
         return [$sqlId, $profileKey];

diff --git a/src/Entity/Stub/Model.stub b/src/Entity/Stub/Model.stub
@@ -10,9 +10,6 @@ namespace App\Models\Entity;
  * @Table(name="{{entity}}")
  * @uses      {{entityClass}}
  * @version   {{entityDate}}
- * @author    swoft <https://github.com/swoft-cloud/swoft>
- * @copyright Copyright 2010-2016 Swoft software
- * @license   PHP Version 7.x {@link http://www.php.net/license/3_0.txt}
  */
 class {{entityClass}} extends {{extends}}
 {{{property}}