supernova-ws / SuperNova

includes/db/db_queries.php

Doc Comments +15 added lines, -10 removed lines

@@ -169,6 +169,11 @@ 
  */
 // OK v4
 // TODO - вынести в отдельный класс
+/**
+ * @param string $db_id_field_name
+ * @param string $db_table_name
+ * @param string $db_value_field_name
+ */
 function db_get_set_unique_id_value($current_value_unsafe, $db_id_field_name, $db_table_name, $db_value_field_name) {
   $current_value_safe = db_escape($current_value_unsafe);
   $value_id = classSupernova::$db->doSelectFetch("SELECT `{$db_id_field_name}` FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE");
@@ -487,8 +492,8 @@ 
 
 
 /**
- * @param $user_id
- * @param $change_type
+ * @param integer $user_id
+ * @param integer $change_type
  * @param $dark_matter
  * @param $comment_unsafe
  * @param $rowUserNameUnsafe
@@ -509,7 +514,7 @@ 
 /**
  * @param $user_id_safe
  *
- * @return array|bool|mysqli_result|null
+ * @return integer
  */
 function db_referral_get_by_id($user_id_safe) {
   $old_referral = classSupernova::$db->doSelectFetch("SELECT * FROM {{referrals}} WHERE `id` = {$user_id_safe} LIMIT 1 FOR UPDATE;");
@@ -540,9 +545,9 @@ 
 
 // Quests ***********************************************************************************************************
 /**
- * @param $query_add_select
+ * @param string $query_add_select
  * @param $query_add_from
- * @param $query_add_where
+ * @param string $query_add_where
  *
  * @return array|bool|mysqli_result|null
  */
@@ -586,11 +591,11 @@ 
 }
 
 /**
- * @param $quest_name_unsafe
- * @param $quest_type
- * @param $quest_description_unsafe
+ * @param string $quest_name_unsafe
+ * @param integer $quest_type
+ * @param string $quest_description_unsafe
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name_unsafe, $quest_type, $quest_description_unsafe, $quest_conditions, $quest_rewards, $quest_id) {
@@ -674,7 +679,7 @@ 
 
 /**
  * @param $payment_id
- * @param $payment_status
+ * @param integer $payment_status
  * @param $comment_unsafe
  */
 function db_payment_update($payment_id, $payment_status, $comment_unsafe) {

includes/classes/db_mysql.php

Doc Comments +33 added lines, -5 removed lines

@@ -162,7 +162,7 @@ 
   /**
    * @param string $query
    *
-   * @return mixed|string
+   * @return string
    */
   public function replaceTablePlaceholders($query) {
     $sql = $query;
@@ -176,7 +176,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    */
   protected function logQuery($query) {
     if (!classSupernova::$config->debug) {
@@ -306,10 +306,16 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function doInsertComplex($query) {
     return $this->doExecute($query);
   }
 
+  /**
+   * @param integer $replace
+   */
   protected function doSet($table, $fieldsAndValues, $replace = DB_INSERT_PLAIN) {
     $tableSafe = $this->db_escape($table);
     $safeFieldsAndValues = implode(',', $this->safeFieldsEqualValues($fieldsAndValues));
@@ -342,6 +348,9 @@ 
     return $this->doSet($table, $fieldsAndValues, $replace);
   }
 
+  /**
+   * @param string $table
+   */
   public function doReplaceSet($table, $fieldsAndValues) {
     return $this->doSet($table, $fieldsAndValues, DB_INSERT_REPLACE);
   }
@@ -376,7 +385,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
@@ -411,7 +420,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
    */
@@ -419,6 +428,9 @@ 
     return $this->doExecute($query);
   }
 
+  /**
+   * @param boolean $isOneRecord
+   */
   protected function doUpdateWhere($table, $fieldsSet, $fieldsAdjust = array(), $where = array(), $isOneRecord = DB_RECORDS_ALL) {
     $tableSafe = $this->db_escape($table);
 
@@ -442,10 +454,16 @@ 
     return $this->doExecute($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);
   }
@@ -454,6 +472,9 @@ 
     return $this->doUpdateWhere($table, $fieldsSet, $fieldsAdjust, $where, DB_RECORD_ONE);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateTableAdjust($table, $fieldsSet, $fieldsAdjust, $where) {
     return $this->doUpdateWhere($table, $fieldsSet, $fieldsAdjust, $where, DB_RECORDS_ALL);
   }
@@ -526,7 +547,7 @@ 
    *
    * Usually used for mallformed $where conditions
    *
-   * @param $table
+   * @param string $table
    * @param $where
    *
    * @return array|bool|mysqli_result|null
@@ -693,6 +714,10 @@ 
   }
 
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   protected function security_watch_user_queries($query) {
     global $user;
 
@@ -716,6 +741,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function security_query_check_bad_words($query) {
     if ($this->skipQueryCheck) {
       return;

includes/classes/DBStaticUnit.php

Doc Comments +3 added lines

@@ -118,6 +118,9 @@
     return classSupernova::$gc->cacheOperator->db_ins_record(LOC_UNIT, $set);
   }
 
+  /**
+   * @param integer $unit_location_type
+   */
   public static function db_unit_list_delete($user_id = 0, $unit_location_type, $unit_location_id = 0, $unit_snid = 0) {
     $where = array('unit_location_type' => $unit_location_type);
     ($unit_location_id = idval($unit_location_id)) ? $where['unit_location_id'] = $unit_location_id : false;

includes/db.php

Doc Comments +7 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
 
 /**
  * @param $adjust
- * @param $location
+ * @param integer $location
  * @param $object_id
  */
 function db_change_units_perform($adjust, $location, $object_id) {
@@ -32,7 +32,6 @@ 
  * @param       $user
  * @param       $planet
  * @param array $unit_list
- * @param null  $query
  */
 function db_change_units(&$user, &$planet, $unit_list) {
   $query = array(
@@ -74,6 +73,9 @@ 
   db_change_units_perform($query[LOC_USER], LOC_USER, $user['id']);
   db_change_units_perform($query[LOC_PLANET], LOC_PLANET, $planet['id']);
 }
+/**
+ * @param string $table
+ */
 function sn_db_perform($table, $values, $type = 'insert', $options = false) {
   $field_set = '';
 
@@ -163,6 +165,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);
 }