supernova-ws / SuperNova

includes/debug.class.php

Doc Comments +6 added lines

@@ -70,6 +70,9 @@ 
     $this->numqueries = 0;
   }
 
+  /**
+   * @param string $mes
+   */
   function add($mes) {
     $this->log .= $mes;
     $this->numqueries++;
@@ -185,6 +188,9 @@ 
     return $error_backtrace;
   }
 
+  /**
+   * @param string $die_message
+   */
   function error_fatal($die_message, $details = 'There is a fatal error on page') {
     // TODO - Записывать детали ошибки в лог-файл
     die($die_message);

includes/classes/classSupernova.php

Doc Comments +6 added lines, -3 removed lines

@@ -323,7 +323,7 @@ 
    *   <p>null - транзакция НЕ должна быть запущена</p>
    *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
    *   <p>false - всё равно - для совместимости с $for_update</p>
-   * @return bool Текущий статус транзакции
+   * @return null|boolean Текущий статус транзакции
    */
   public static function db_transaction_check($status = null) {
     $error_msg = false;
@@ -399,7 +399,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */
@@ -587,6 +587,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $location_type
+   */
   public static function db_ins_field_set($location_type, $field_set, $serialize = false) {
     // TODO multiinsert
     !sn_db_field_set_is_safe($field_set) ? $field_set = sn_db_field_set_make_safe($field_set, $serialize) : false;
@@ -809,7 +812,7 @@ 
    * @param     $location_type
    * @param     $location_id
    *
-   * @return array|bool
+   * @return boolean
    */
   public static function db_get_unit_list_by_location($user_id = 0, $location_type, $location_id)
   {

includes/classes/DBStaticPlanet.php

Doc Comments +14 added lines

@@ -21,11 +21,19 @@ 
     return empty($result) ? null : $result;
   }
 
+  /**
+   * @param integer $galaxy
+   * @param integer $system
+   * @param integer $planet
+   */
   public static function db_planet_by_gspt_safe($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     return classSupernova::db_get_record_list(LOC_PLANET,
       "{{planets}}.`galaxy` = {$galaxy} AND {{planets}}.`system` = {$system} AND {{planets}}.`planet` = {$planet} AND {{planets}}.`planet_type` = {$planet_type}", true);
   }
 
+  /**
+   * @param integer $planet_type
+   */
   public static function db_planet_by_gspt($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     $galaxy = intval($galaxy);
     $system = intval($system);
@@ -120,6 +128,9 @@ 
       "`id_owner` = '{$user_row['id']}' {$conditions} ORDER BY {$order_by}");
   }
 
+  /**
+   * @param integer $planet_id
+   */
   public static function db_planet_list_by_user_or_planet($user_id, $planet_id) {
     if(!($user_id = idval($user_id)) && !($planet_id = idval($planet_id))) {
       return false;
@@ -138,6 +149,9 @@ 
     return classSupernova::db_upd_record_by_id(LOC_PLANET, $planet_id, $set);
   }
 
+  /**
+   * @param integer $ui_planet_type
+   */
   public static function db_planet_set_by_gspt($ui_galaxy, $ui_system, $ui_planet, $ui_planet_type = PT_ALL, $set) {
     if(!($set = trim($set))) {
       return false;

includes/classes/DBStaticUnit.php

Doc Comments +6 added lines

@@ -56,6 +56,9 @@ 
     WHERE unit_player_id = {$user_id} AND unit_location_type = " . LOC_PLANET . " AND unit_level > 0 AND unit_snid IN (" . STRUC_LABORATORY . ", " . STRUC_LABORATORY_NANO . ");");
   }
 
+  /**
+   * @param string $set
+   */
   public static function db_unit_set_by_id($unit_id, $set) {
     return classSupernova::db_upd_record_by_id(LOC_UNIT, $unit_id, $set);
   }
@@ -69,6 +72,9 @@ 
     return classSupernova::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, $unit_snid = 0) {
     return classSupernova::db_del_record_list(LOC_UNIT,
       "`unit_location_type` = {$unit_location_type} AND `unit_location_id` = {$unit_location_id}" .

includes/classes/DBStaticAlly.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
   }
 
   /**
-   * @param $ranklist
+   * @param string $ranklist
    * @param $user
    */
   public static function db_ally_update_ranklist($ranklist, $user) {

includes/classes/DBStaticChat.php

Doc Comments +3 added lines, -3 removed lines

@@ -19,9 +19,9 @@ 
 
   /**
    * @param $user_id
-   * @param $nick
+   * @param string $nick
    * @param $ally_id
-   * @param $message
+   * @param string $message
    * @param $chat_message_sender_name
    * @param $chat_message_recipient_id
    * @param $chat_message_recipient_name
@@ -57,7 +57,7 @@ 
    * @param $alliance
    * @param $where_add
    * @param $start_row
-   * @param $page_limit
+   * @param integer $page_limit
    *
    * @return array|bool|mysqli_result|null
    */

includes/classes/DBStaticFleetACS.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 
 
   /**
-   * @param $fleet_group_id_list
+   * @param string $fleet_group_id_list
    */
   public static function db_acs_delete_by_list($fleet_group_id_list) {
     doquery("DELETE FROM {{aks}} WHERE `id` IN ({$fleet_group_id_list})");

includes/classes/DBStaticNews.php

Doc Comments +3 added lines, -3 removed lines

@@ -25,9 +25,9 @@
   }
 
   /**
-   * @param $template
-   * @param $query_where
-   * @param $query_limit
+   * @param template $template
+   * @param string $query_where
+   * @param integer $query_limit
    *
    * @return array|bool|mysqli_result|null
    */

includes/classes/DBStaticSurveyVote.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
    * @param $user
    * @param $survey_id
    * @param $survey_vote_id
-   * @param $user_name_safe
+   * @param string $user_name_safe
    */
   public static function db_survey_vote_insert(&$user, $survey_id, $survey_vote_id, $user_name_safe) {
     doquery("INSERT INTO {{survey_votes}} SET `survey_parent_id` = {$survey_id}, `survey_parent_answer_id` = {$survey_vote_id}, `survey_vote_user_id` = {$user['id']}, `survey_vote_user_name` = '{$user_name_safe}';");