supernova-ws / SuperNova

includes/classes/DBStaticUser.php

Doc Comments +8 added lines, -3 removed lines

@@ -104,6 +104,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $config_user_birthday_range
+   */
   public static function db_user_list_to_celebrate($config_user_birthday_range) {
     $query = static::buildDBQ()
       ->field('id', 'username', 'user_birthday', 'user_birthday_celebrated')
@@ -193,6 +196,9 @@ 
   }
 
 
+  /**
+   * @param string $username_unsafe
+   */
   public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {
     // TODO Проверить, кстати - а везде ли нужно выбирать юзеров или где-то все-таки ищутся Альянсы ?
     if (!($username_unsafe = trim($username_unsafe))) {
@@ -247,7 +253,6 @@ 
 
   /**
    * @param $user_id
-   * @param array $set
    * @param array $adjust
    *
    * @return array|bool|mysqli_result|null
@@ -264,8 +269,8 @@ 
    *    <p>array - запись пользователя с установленным полем ['id']</p>
    * @param bool      $for_update @deprecated
    * @param string    $fields @deprecated список полей или '*'/'' для всех полей
-   * @param null      $player
-   * @param bool|null $player Признак выбора записи пользователь типа "игрок"
+   * @param boolean      $player
+   * @param boolean $player Признак выбора записи пользователь типа "игрок"
    *    <p>null - Можно выбрать запись любого типа</p>
    *    <p>true - Выбирается только запись типа "игрок"</p>
    *    <p>false - Выбирается только запись типа "альянс"</p>

includes/db.php

Doc Comments +3 added lines, -1 removed lines

@@ -16,7 +16,6 @@ 
  * @param       $user
  * @param       $planet
  * @param array $unit_list
- * @param null  $query
  */
 function db_change_resources(&$user, &$planet, $unit_list) {
   $group = sn_get_groups('resources_loot');
@@ -56,6 +55,9 @@ 
 
 }
 
+/**
+ * @param boolean $transaction_should_be_started
+ */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::$gc->db->getTransaction()->check($transaction_should_be_started);
 }

includes/classes/db_mysql.php

Doc Comments +31 added lines, -5 removed lines

@@ -157,7 +157,7 @@ 
   /**
    * @param string $query
    *
-   * @return mixed|string
+   * @return string
    */
   public function replaceTablePlaceholders($query) {
     $sql = $query;
@@ -171,7 +171,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    */
   protected function logQuery($query) {
     if (!classSupernova::$config->debug) {
@@ -286,6 +286,7 @@ 
    * @param array  $fields
    * @param array  $where
    * @param bool   $isOneRecord
+   * @param boolean $forUpdate
    *
    * @return array|bool|mysqli_result|null
    */
@@ -332,6 +333,11 @@ 
 
 
   // INSERT/REPLACE
+
+  /**
+   * @param string $table
+   * @param integer $replace
+   */
   protected function doSet($table, $fieldsAndValues, $replace = DB_INSERT_PLAIN) {
     $query = DbQuery::build($this)
       ->setTable($table)
@@ -369,6 +375,10 @@ 
 
 
   // INSERTERS
+
+  /**
+   * @param string $query
+   */
   public function doInsertComplex($query) {
     return $this->doSql($query);
   }
@@ -386,7 +396,7 @@ 
    * Values should be passed as-is
    *
    * @param string   $table
-   * @param array    $fields
+   * @param string[]    $fields
    * @param string[] $values
    *
    * @return array|bool|mysqli_result|null
@@ -438,7 +448,7 @@ 
    * Self-contained - means no params used
    * Such queries usually used to make large amount of in-base calculations
    *
-   * @param $query
+   * @param string $query
    *
    * @return array|bool|mysqli_result|null
    */
@@ -456,13 +466,16 @@ 
   }
 
   /**
-   * @param $DbQuery DbQuery
+   * @param DbQuery $DbQuery DbQuery
    */
   public function doUpdateDbQueryAdjust($DbQuery) {
     return $this->doUpdateDbQuery($DbQuery);
   }
 
 
+  /**
+   * @param boolean $isOneRecord
+   */
   protected function doUpdateWhere($table, $fieldsSet, $fieldsAdjust = array(), $where = array(), $isOneRecord = DB_RECORDS_ALL, $whereDanger = array()) {
 //    $query = DbQuery::build($this)
 //      ->setTable($table)
@@ -498,10 +511,16 @@ 
     return $this->doSql($query);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateRowSet($table, $fieldsAndValues, $where) {
     return $this->doUpdateWhere($table, $fieldsAndValues, array(), $where, DB_RECORD_ONE);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateTableSet($table, $fieldsAndValues, $where = array()) {
     return $this->doUpdateWhere($table, $fieldsAndValues, array(), $where, DB_RECORDS_ALL);
   }
@@ -708,6 +727,10 @@ 
   }
 
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   protected function security_watch_user_queries($query) {
     global $user;
 
@@ -731,6 +754,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function security_query_check_bad_words($query) {
     if ($this->skipQueryCheck) {
       return;

includes/classes/DbQueryConstructor.php

Doc Comments +8 added lines, -3 removed lines

@@ -155,10 +155,17 @@ 
     return $this->field(DbSqlLiteral::build($this->db)->literal($field));
   }
 
+  /**
+   * @param string $functionName
+   * @param string $alias
+   */
   public function fieldSingleFunction($functionName, $field = '*', $alias = DbSqlLiteral::SQL_LITERAL_ALIAS_NONE) {
     return $this->field(DbSqlLiteral::build($this->db)->buildSingleArgument($functionName, $field, $alias));
   }
 
+  /**
+   * @param string $alias
+   */
   public function fieldCount($field = '*', $alias = DbSqlLiteral::SQL_LITERAL_ALIAS_NONE) {
     return $this->field(DbSqlLiteral::build($this->db)->count($field, $alias));
   }
@@ -240,7 +247,7 @@ 
 
   /**
    * @param db_mysql|null $db
-   * @param string|object|DBStaticRecord|DbSqlAware $className
+   * @param string $className
    *
    * @return static
    */
@@ -444,7 +451,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return array
    */
@@ -455,7 +461,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return mixed|null
    */