supernova-ws / SuperNova

includes/db/db_queries.php

Doc Comments +17 added lines, -12 removed lines

@@ -188,6 +188,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 = doquery("SELECT `{$db_id_field_name}` AS id_field FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE", true);
@@ -220,7 +225,7 @@ 
 
 /**
  * @param $user
- * @param $username_safe
+ * @param string $username_safe
  */
 function db_player_name_history_replace($user, $username_safe) {
   doquery("REPLACE INTO {{player_name_history}} SET `player_id` = {$user['id']}, `player_name` = '{$username_safe}'");
@@ -228,7 +233,7 @@ 
 
 
 /**
- * @param $username_safe
+ * @param string $username_safe
  *
  * @return array|bool|mysqli_result|null
  */
@@ -488,9 +493,9 @@ 
  * @param $user_id
  * @param $change_type
  * @param $dark_matter
- * @param $comment
+ * @param string $comment
  * @param $row
- * @param $page_url
+ * @param string $page_url
  */
 function db_log_dark_matter_insert($user_id, $change_type, $dark_matter, $comment, $row, $page_url) {
   doquery(
@@ -534,9 +539,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
  */
@@ -580,11 +585,11 @@ 
 }
 
 /**
- * @param $quest_name
- * @param $quest_type
- * @param $quest_description
+ * @param string $quest_name
+ * @param integer $quest_type
+ * @param string $quest_description
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name, $quest_type, $quest_description, $quest_conditions, $quest_rewards, $quest_id) {
@@ -607,7 +612,7 @@ 
 /**
  * @param $banner
  * @param $banned
- * @param $reason
+ * @param string $reason
  * @param $ban_until
  */
 function db_ban_insert($banner, $banned, $reason, $ban_until) {
@@ -630,7 +635,7 @@ 
 /**
  * @param $banner
  * @param $banned
- * @param $reason
+ * @param string $reason
  */
 function db_ban_insert_unset($banner, $banned, $reason) {
   doquery(

Spacing +4 added lines, -4 removed lines

@@ -85,7 +85,7 @@ 
 
 function db_stat_list_statistic($who, $is_common_stat, $Rank, $start, $source = false) {
 // pdump($source);
-  if(!$source) {
+  if (!$source) {
     $source = array(
       'statpoints' => 'statpoints',
       'users'      => 'users',
@@ -106,8 +106,8 @@ 
     );
   }
 // pdump($source);
-  if($who == 1) {
-    if($is_common_stat) { // , UNIX_TIMESTAMP(CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d'))) AS `nearest_birthday`
+  if ($who == 1) {
+    if ($is_common_stat) { // , UNIX_TIMESTAMP(CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d'))) AS `nearest_birthday`
       $query_str =
         "SELECT
       @rownum:=@rownum+1 rownum, subject.{$source['id']} as `id`, sp.{$Rank}_rank as rank, sp.{$Rank}_old_rank as rank_old, sp.{$Rank}_points as points, subject.{$source['username']} as `name`, subject.*
@@ -191,7 +191,7 @@ 
 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 = doquery("SELECT `{$db_id_field_name}` AS id_field FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE", true);
-  if(!isset($value_id['id_field']) || !$value_id['id_field']) {
+  if (!isset($value_id['id_field']) || !$value_id['id_field']) {
     doquery("INSERT INTO {{{$db_table_name}}} (`{$db_value_field_name}`) VALUES ('{$current_value_safe}');");
     $variable_id = db_insert_id();
   } else {

includes/db/db_queries_ally.php

Doc Comments +1 added lines, -1 removed lines

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

includes/db/db_queries_chat.php

Doc Comments +3 added lines, -3 removed lines

@@ -17,9 +17,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
@@ -55,7 +55,7 @@ 
  * @param $alliance
  * @param $where_add
  * @param $start_row
- * @param $page_limit
+ * @param integer $page_limit
  *
  * @return array|bool|mysqli_result|null
  */

includes/db/db_queries_fleet.php

Doc Comments +6 added lines, -2 removed lines

@@ -22,6 +22,10 @@ 
   doquery('DELETE FROM `{{aks}}` WHERE `id` NOT IN (SELECT DISTINCT `fleet_group` FROM `{{fleets}}`);');
 }
 
+/**
+ * @param double $arrival
+ * @param integer $target_structure
+ */
 function db_missile_insert($target_coord, $user, $planetrow, $arrival, $fleet_ship_count, $target_structure) {
   doquery(
     "INSERT INTO `{{iraks}}` SET
@@ -114,14 +118,14 @@ 
 
 
 /**
- * @param $fleet_group_id_list
+ * @param string $fleet_group_id_list
  */
 function db_acs_delete_by_list($fleet_group_id_list) {
   doquery("DELETE FROM {{aks}} WHERE `id` IN ({$fleet_group_id_list})");
 }
 
 /**
- * @param $bashing_list
+ * @param string $bashing_list
  */
 function db_bashing_insert($bashing_list) {
   doquery("INSERT INTO {{bashing}} (bashing_user_id, bashing_planet_id, bashing_time) VALUES {$bashing_list};");

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * DB ACS functions
- */
+   * DB ACS functions
+   */
 
 /* ACS ****************************************************************************************************************/
 /**

includes/db/db_queries_news_and_surveys.php

Doc Comments +4 added lines, -4 removed lines

@@ -79,9 +79,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
  */
@@ -105,7 +105,7 @@ 
  * @param $user
  * @param $survey_id
  * @param $survey_vote_id
- * @param $user_name_safe
+ * @param string $user_name_safe
  */
 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}';");

includes/functions/int_fleet_events.php

Doc Comments +2 added lines, -2 removed lines

@@ -69,8 +69,8 @@
 
 /**
  * @param Fleet $objFleet
- * @param       $ov_label
- * @param       $planet_end_type
+ * @param       integer $ov_label
+ * @param       integer $planet_end_type
  *
  * @return mixed
  */

Spacing +11 added lines, -11 removed lines

@@ -6,26 +6,26 @@ 
   $fleet_events = array();
   $fleet_number = 0;
 
-  if($objFleetList->count() <= 0) {
+  if ($objFleetList->count() <= 0) {
     return;
   }
 
-  foreach($objFleetList->_container as $objFleet) {
+  foreach ($objFleetList->_container as $objFleet) {
     $planet_start_type = $objFleet->fleet_start_type == PT_MOON ? PT_MOON : PT_PLANET;
     $planet_start = db_planet_by_gspt($objFleet->fleet_start_galaxy, $objFleet->fleet_start_system, $objFleet->fleet_start_planet, $planet_start_type, false, 'name');
     $objFleet->fleet_start_name = $planet_start['name'];
 
     $planet_end_type = $objFleet->fleet_end_type == PT_MOON ? PT_MOON : PT_PLANET;
-    if($objFleet->fleet_end_planet > $config->game_maxPlanet) {
+    if ($objFleet->fleet_end_planet > $config->game_maxPlanet) {
       $objFleet->fleet_end_name = $lang['ov_fleet_exploration'];
-    } elseif($objFleet->mission_type == MT_COLONIZE) {
+    } elseif ($objFleet->mission_type == MT_COLONIZE) {
       $objFleet->fleet_end_name = $lang['ov_fleet_colonization'];
     } else {
       $planet_end = db_planet_by_gspt($objFleet->fleet_end_galaxy, $objFleet->fleet_end_system, $objFleet->fleet_end_planet, $planet_end_type, false, 'name');
       $objFleet->fleet_end_name = $planet_end['name'];
     }
 
-    if($objFleet->time_arrive_to_target > SN_TIME_NOW && !$objFleet->isReturning() && $objFleet->mission_type != MT_MISSILE &&
+    if ($objFleet->time_arrive_to_target > SN_TIME_NOW && !$objFleet->isReturning() && $objFleet->mission_type != MT_MISSILE &&
       ($planet_scanned === false
         ||
         (
@@ -39,11 +39,11 @@ 
       $fleet_events[] = flt_register_event_objFleet($objFleet, 0, $planet_end_type);
     }
 
-    if($objFleet->time_mission_job_complete > SN_TIME_NOW && !$objFleet->isReturning() && $planet_scanned === false && $objFleet->mission_type != MT_MISSILE) {
+    if ($objFleet->time_mission_job_complete > SN_TIME_NOW && !$objFleet->isReturning() && $planet_scanned === false && $objFleet->mission_type != MT_MISSILE) {
       $fleet_events[] = flt_register_event_objFleet($objFleet, 1, $planet_end_type);
     }
 
-    if(
+    if (
       $objFleet->time_return_to_source > SN_TIME_NOW && $objFleet->mission_type != MT_MISSILE && ($objFleet->isReturning() || ($objFleet->mission_type != MT_RELOCATE && $objFleet->mission_type != MT_COLONIZE)) &&
       (
         ($planet_scanned === false && $objFleet->playerOwnerId == $user['id'])
@@ -59,7 +59,7 @@ 
       $fleet_events[] = flt_register_event_objFleet($objFleet, 2, $planet_end_type);
     }
 
-    if($objFleet->mission_type == MT_MISSILE) {
+    if ($objFleet->mission_type == MT_MISSILE) {
       $fleet_events[] = flt_register_event_objFleet($objFleet, 3, $planet_end_type);
     }
   }
@@ -79,7 +79,7 @@ 
 
   $is_this_planet = false;
 
-  switch($objFleet->ov_label = $ov_label) {
+  switch ($objFleet->ov_label = $ov_label) {
     case 0:
       $objFleet->event_time = $objFleet->time_arrive_to_target;
       $is_this_planet = (
@@ -110,9 +110,9 @@ 
 
   }
 
-  $objFleet->ov_this_planet = $is_this_planet;// || $planet_scanned != false;
+  $objFleet->ov_this_planet = $is_this_planet; // || $planet_scanned != false;
 
-  if($objFleet->playerOwnerId == $user['id']) {
+  if ($objFleet->playerOwnerId == $user['id']) {
     $user_data = $user;
   } else {
     $user_data = db_user_by_id($objFleet->playerOwnerId);

includes/functions/tpl_helpers.php

Doc Comments +3 added lines

@@ -185,6 +185,9 @@
   return $result;
 }
 
+/**
+ * @param integer $que_id
+ */
 function tpl_parse_planet_que($que, $planet, $que_id) {
   $hangar_que = array();
   $que_hangar = $que['ques'][$que_id][$planet['id_owner']][$planet['id']];

Spacing +29 added lines, -29 removed lines

@@ -2,8 +2,8 @@ 
 
 // Compare function to sort fleet in time order
 function tpl_assign_fleet_compare($a, $b) {
-  if($a['fleet']['OV_THIS_PLANET'] == $b['fleet']['OV_THIS_PLANET']) {
-    if($a['fleet']['OV_LEFT'] == $b['fleet']['OV_LEFT']) {
+  if ($a['fleet']['OV_THIS_PLANET'] == $b['fleet']['OV_THIS_PLANET']) {
+    if ($a['fleet']['OV_LEFT'] == $b['fleet']['OV_LEFT']) {
       return 0;
     }
 
@@ -19,17 +19,17 @@ 
  * @param string   $js_name
  */
 function tpl_assign_fleet(&$template, $fleets, $js_name = 'fleets') {
-  if(!$fleets) {
+  if (!$fleets) {
     return;
   }
 
   usort($fleets, 'tpl_assign_fleet_compare');
 
-  foreach($fleets as $fleet_data) {
+  foreach ($fleets as $fleet_data) {
     $template->assign_block_vars($js_name, $fleet_data['fleet']);
 
-    if($fleet_data['ships']) {
-      foreach($fleet_data['ships'] as $ship_data) {
+    if ($fleet_data['ships']) {
+      foreach ($fleet_data['ships'] as $ship_data) {
         $template->assign_block_vars("{$js_name}.ships", $ship_data);
       }
     }
@@ -50,8 +50,8 @@ 
     'DEUTERIUM' => $fleet[RES_DEUTERIUM],
   );
 
-  foreach($fleet as $ship_id => $ship_amount) {
-    if(in_array($ship_id, sn_get_groups('fleet'))) {
+  foreach ($fleet as $ship_id => $ship_amount) {
+    if (in_array($ship_id, sn_get_groups('fleet'))) {
       $single_ship_data = get_ship_data($ship_id, $user_data);
       $return['ships'][$ship_id] = array(
         'ID'          => $ship_id,
@@ -90,11 +90,11 @@ 
 
   $result = array();
 
-  if(!$user_data) {
+  if (!$user_data) {
     $user_data = $user;
   }
 
-  if(!$objFleet->isReturning() && $objFleet->mission_type == MT_AKS) {
+  if (!$objFleet->isReturning() && $objFleet->mission_type == MT_AKS) {
     $aks = db_acs_get_by_group_id($objFleet->group_id);
   }
 
@@ -135,14 +135,14 @@ 
     'STAY_LEFT' => floor($objFleet->time_mission_job_complete + 1 - SN_TIME_NOW),
   );
 
-  if(property_exists($objFleet, 'fleet_start_name')) {
+  if (property_exists($objFleet, 'fleet_start_name')) {
     $result['START_NAME'] = $objFleet->fleet_start_name;
   }
-  if(property_exists($objFleet, 'fleet_end_name')) {
+  if (property_exists($objFleet, 'fleet_end_name')) {
     $result['END_NAME'] = $objFleet->fleet_end_name;
   }
 
-  if(property_exists($objFleet, 'event_time')) {
+  if (property_exists($objFleet, 'event_time')) {
     $result['fleet'] = array_merge($result['fleet'], array(
       'OV_LABEL'        => $objFleet->ov_label,
       'EVENT_TIME_TEXT' => property_exists($objFleet, 'event_time') ? date(FMT_DATE_TIME, $objFleet->event_time + SN_CLIENT_TIME_DIFF) : '',
@@ -154,9 +154,9 @@ 
   $ship_list_fully_parsed = $objFleet->shipsGetArray();
 
   $ship_id = 0;
-  if($spy_level >= 6) {
-    foreach($ship_list_fully_parsed as $ship_sn_id => $ship_amount) {
-      if($spy_level >= 10) {
+  if ($spy_level >= 6) {
+    foreach ($ship_list_fully_parsed as $ship_sn_id => $ship_amount) {
+      if ($spy_level >= 10) {
         $single_ship_data = get_ship_data($ship_sn_id, $user_data);
         $result['ships'][$ship_sn_id] = array(
           'ID'          => $ship_sn_id,
@@ -188,8 +188,8 @@ 
 function tpl_parse_planet_que($que, $planet, $que_id) {
   $hangar_que = array();
   $que_hangar = $que['ques'][$que_id][$planet['id_owner']][$planet['id']];
-  if(!empty($que_hangar)) {
-    foreach($que_hangar as $que_item) {
+  if (!empty($que_hangar)) {
+    foreach ($que_hangar as $que_item) {
       $hangar_que['que'][] = array('id' => $que_item['que_unit_id'], 'count' => $que_item['que_unit_amount']);
       $hangar_que[$que_item['que_unit_id']] += $que_item['que_unit_amount'];
     }
@@ -252,10 +252,10 @@ 
     'PLANET_GOVERNOR_LEVEL_MAX' => get_unit_param($planet['PLANET_GOVERNOR_ID'], P_MAX_STACK),
   );
 
-  if(!empty($que['ques'][QUE_STRUCTURES][$planet['id_owner']][$planet['id']])) {
+  if (!empty($que['ques'][QUE_STRUCTURES][$planet['id_owner']][$planet['id']])) {
     $result['building_que'] = array();
     $building_que = &$que['ques'][QUE_STRUCTURES][$planet['id_owner']][$planet['id']];
-    foreach($building_que as $que_element) {
+    foreach ($building_que as $que_element) {
       $result['building_que'][] = que_tpl_parse_element($que_element);
     }
   }
@@ -271,19 +271,19 @@ 
 function flt_get_fleets_to_planet_by_array_of_Fleet($array_of_Fleet) {
   global $user;
 
-  if(empty($array_of_Fleet)) {
+  if (empty($array_of_Fleet)) {
     return false;
   }
 
   $fleet_list = array();
-  foreach($array_of_Fleet as $fleet) {
-    if($fleet->playerOwnerId == $user['id']) {
-      if($fleet->mission_type == MT_MISSILE) {
+  foreach ($array_of_Fleet as $fleet) {
+    if ($fleet->playerOwnerId == $user['id']) {
+      if ($fleet->mission_type == MT_MISSILE) {
         continue;
       }
       $fleet_ownage = 'own';
     } else {
-      switch($fleet->mission_type) {
+      switch ($fleet->mission_type) {
         case MT_ATTACK:
         case MT_AKS:
         case MT_DESTROY:
@@ -300,10 +300,10 @@ 
 
     $fleet_list[$fleet_ownage]['fleets'][$fleet->dbId] = $fleet;
 
-    if($fleet->isReturning() || (!$fleet->isReturning() && $fleet->mission_type == MT_RELOCATE) || ($fleet->target_owner_id != $user['id'])) {
+    if ($fleet->isReturning() || (!$fleet->isReturning() && $fleet->mission_type == MT_RELOCATE) || ($fleet->target_owner_id != $user['id'])) {
       $fleet_sn = $fleet->shipsGetArray();
-      foreach($fleet_sn as $ship_id => $ship_amount) {
-        if(in_array($ship_id, sn_get_groups('fleet'))) {
+      foreach ($fleet_sn as $ship_id => $ship_amount) {
+        if (in_array($ship_id, sn_get_groups('fleet'))) {
           $fleet_list[$fleet_ownage]['total'][$ship_id] += $ship_amount;
         }
       }
@@ -320,7 +320,7 @@ 
   return $fleet_list;
 }
 
-function tpl_set_resource_info(template &$template, $planet_row, $fleets_to_planet = array(), $round = 0) {
+function tpl_set_resource_info(template & $template, $planet_row, $fleets_to_planet = array(), $round = 0) {
   $template->assign_vars(array(
     'RESOURCE_ROUNDING' => $round,
 

includes/includes/coe_simulator_helpers.php

Doc Comments +3 added lines

@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @param string $type
+ */
 function sn_ube_simulator_encode_replay($combat, $type)
 {
   $strPacked = "{$type}!";

Spacing +8 added lines, -8 removed lines

@@ -4,9 +4,9 @@ 
 {
   $strPacked = "{$type}!";
 
-  foreach($combat as $fleetID => $fleetCompress)
+  foreach ($combat as $fleetID => $fleetCompress)
   {
-    foreach($fleetCompress as $key => $value)
+    foreach ($fleetCompress as $key => $value)
     {
       $value = intval($value);
       $strPacked .= "{$key},{$value};";
@@ -22,29 +22,29 @@ 
   $fleet_id = 0;
 
   $arr_data_unpacked = explode('!', $str_data);
-  foreach($arr_data_unpacked as $data_piece)
+  foreach ($arr_data_unpacked as $data_piece)
   {
-    if(!$data_piece)
+    if (!$data_piece)
     {
       continue;
     }
 
-    if($data_piece == 'A' || $data_piece == 'D')
+    if ($data_piece == 'A' || $data_piece == 'D')
     {
       $fleet_type = $data_piece;
       continue;
     }
 
     $arr_unit_strings = explode(';', $data_piece);
-    foreach($arr_unit_strings as $str_unit_string)
+    foreach ($arr_unit_strings as $str_unit_string)
     {
-      if(!$str_unit_string)
+      if (!$str_unit_string)
       {
         continue;
       }
 
       $arr_unit_data = explode(',', $str_unit_string);
-      if($arr_unit_data[1])
+      if ($arr_unit_data[1])
       {
         $unpacked[$fleet_type][$fleet_id][$arr_unit_data[0]] = intval($arr_unit_data[1]);
       }

includes/includes/flt_mission_attack.php

Doc Comments +1 added lines, -2 removed lines

@@ -10,9 +10,8 @@
 
 /**
  * @param Mission $objMission
- * @param array   $mission_data
  *
- * @return array|null
+ * @return null|boolean
  */
 function flt_mission_attack($objMission) {
   $objFleet = $objMission->fleet;

Spacing +2 added lines, -2 removed lines

@@ -17,14 +17,14 @@
 function flt_mission_attack($objMission) {
   $objFleet = $objMission->fleet;
 
-  if($objFleet->shipsGetTotal() <= 0) {
+  if ($objFleet->shipsGetTotal() <= 0) {
     return null;
   }
 
   $destination_user = $objMission->dst_user;
   $destination_planet = $objMission->dst_planet;
 
-  if(
+  if (
     // Нет данных о планете назначения или её владельце
     empty($destination_user) || empty($destination_planet) || !is_array($destination_user) || !is_array($destination_planet)
     ||