supernova-ws / SuperNova

includes/db.php

Doc Comments +8 added lines, -5 removed lines

@@ -11,6 +11,9 @@ 
 
 require_once('db/db_queries.php');
 
+/**
+ * @param string $tablename
+ */
 function db_change_units_perform($query, $tablename, $object_id) {
   $query = implode(',', $query);
   if($query && $object_id) {
@@ -63,6 +66,9 @@ 
   db_change_units_perform($query[LOC_USER], 'users', $user['id']);
   db_change_units_perform($query[LOC_PLANET], 'planets', $planet['id']);
 }
+/**
+ * @param string $table
+ */
 function sn_db_perform($table, $values, $type = 'insert', $options = false) {
   $mass_perform = false;
 
@@ -171,11 +177,8 @@ 
 /**
  * Функция проверяет статус транзакции
  *
- * @param null|true|false $status Должна ли быть запущена транзакция в момент проверки
- *   <p>null - транзакция НЕ должна быть запущена</p>
- *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
- *   <p>false - всё равно - для совместимости с $for_update</p>
- * @return bool Текущий статус транзакции
+ * @param boolean $transaction_should_be_started
+ * @return null|boolean Текущий статус транзакции
  */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::db_transaction_check($transaction_should_be_started);

includes/db/db_queries.php

Doc Comments +5 added lines

@@ -337,6 +337,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);

Braces +14 added lines, -28 removed lines

@@ -7,8 +7,7 @@ 
 require_once('db_queries_fleet.php');
 
 
-function db_planet_list_admin_list($table_parent_columns, $planet_active, $active_time, $planet_type)
-{
+function db_planet_list_admin_list($table_parent_columns, $planet_active, $active_time, $planet_type) {
   return doquery(
     "SELECT p.*, u.username" . ($table_parent_columns ? ', p1.name AS parent_name' : '') .
     " FROM {{planets}} AS p
@@ -17,8 +16,7 @@ 
     " WHERE " . ($planet_active ? "p.last_update >= {$active_time}" : "p.planet_type = {$planet_type}"));
 }
 
-function db_planet_list_search($searchtext)
-{
+function db_planet_list_search($searchtext) {
   return doquery(
     "SELECT
       p.galaxy, p.system, p.planet, p.planet_type, p.name as planet_name,
@@ -38,8 +36,7 @@ 
 
 
 
-function db_user_list_search($searchtext)
-{
+function db_user_list_search($searchtext) {
   return doquery(
     "SELECT
       pn.player_name, u.id as uid, u.username, u.ally_id, u.id_planet, u.total_points, u.total_rank,
@@ -57,8 +54,7 @@ 
   );
 }
 
-function db_buddy_list_by_user($user_id)
-{
+function db_buddy_list_by_user($user_id) {
 //  return ($user_id = intval($user_id)) ? doquery(
   return ($user_id = idval($user_id)) ? doquery(
     "SELECT
@@ -84,8 +80,7 @@ 
 
 
 
-function db_message_list_outbox_by_user_id($user_id)
-{
+function db_message_list_outbox_by_user_id($user_id) {
   // return ($user_id = intval($user_id))
   return ($user_id = idval($user_id))
     ? doquery("SELECT {{messages}}.message_id, {{messages}}.message_owner, {{users}}.id AS message_sender, {{messages}}.message_time,
@@ -101,8 +96,7 @@ 
 
 
 
-function db_unit_records_sum($unit_id, $user_skip_list_unit)
-{
+function db_unit_records_sum($unit_id, $user_skip_list_unit) {
   return doquery (
     "SELECT unit_player_id, username, sum(unit_level) as unit_level
           FROM {{unit}} JOIN {{users}} AS u ON u.id = unit_player_id
@@ -113,8 +107,7 @@ 
     , true);
 }
 
-function db_unit_records_plain($unit_id, $user_skip_list_unit)
-{
+function db_unit_records_plain($unit_id, $user_skip_list_unit) {
   return doquery (
     "SELECT unit_player_id, username, unit_level
           FROM {{unit}} JOIN {{users}} AS u ON u.id = unit_player_id
@@ -198,25 +191,21 @@ 
 }
 
 
-function db_stat_list_update_user_stats()
-{
+function db_stat_list_update_user_stats() {
   return doquery("UPDATE {{users}} AS u JOIN {{statpoints}} AS sp ON sp.id_owner = u.id AND sp.stat_code = 1 AND sp.stat_type = 1 SET u.total_rank = sp.total_rank, u.total_points = sp.total_points WHERE user_as_ally IS NULL;");
 }
 
-function db_stat_list_update_ally_stats()
-{
+function db_stat_list_update_ally_stats() {
   return doquery("UPDATE {{alliance}} AS a JOIN {{statpoints}} AS sp ON sp.id_ally = a.id AND sp.stat_code = 1 AND sp.stat_type = 2 SET a.total_rank = sp.total_rank, a.total_points = sp.total_points;");
 }
 
-function db_stat_list_delete_ally_player()
-{
+function db_stat_list_delete_ally_player() {
   return doquery('DELETE s FROM {{statpoints}} AS s JOIN {{users}} AS u ON u.id = s.id_owner WHERE s.id_ally IS NULL AND u.user_as_ally IS NOT NULL');
 }
 
 
 
-function db_chat_player_list_online($chat_refresh_rate, $ally_add)
-{
+function db_chat_player_list_online($chat_refresh_rate, $ally_add) {
   $sql_date = SN_TIME_NOW - $chat_refresh_rate * 2;
 
   return doquery(
@@ -230,13 +219,11 @@ 
     ORDER BY authlevel DESC, `username`");
 }
 
-function db_referrals_list_by_id($user_id)
-{
+function db_referrals_list_by_id($user_id) {
   return doquery("SELECT r.*, u.username, u.register_time FROM {{referrals}} AS r LEFT JOIN {{users}} AS u ON u.id = r.id WHERE id_partner = {$user_id}");
 }
 
-function db_message_list_admin_by_type($int_type_selected, $StartRec)
-{
+function db_message_list_admin_by_type($int_type_selected, $StartRec) {
   return doquery("SELECT
   message_id as `ID`,
   message_from as `FROM`,
@@ -255,8 +242,7 @@ 
 }
 
 
-function db_message_insert_all($message_type, $from, $subject, $text)
-{
+function db_message_insert_all($message_type, $from, $subject, $text) {
   return doquery($QryInsertMessage = 'INSERT INTO {{messages}} (`message_owner`, `message_sender`, `message_time`, `message_type`, `message_from`, `message_subject`, `message_text`) ' .
     "SELECT `id`, 0, unix_timestamp(now()), {$message_type}, '{$from}', '{$subject}', '{$text}' FROM {{users}}");
 }

includes/db/db_queries_users.php

Doc Comments +3 added lines

@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @param boolean $player
+ */
 function db_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) {
   return classSupernova::db_get_user_by_id($user_id_unsafe, $for_update, $fields, $player);
 }

includes/functions/eco_get_build_data.php

Doc Comments +4 added lines

@@ -10,6 +10,7 @@ 
  *
  * 1.0 - copyright (c) 2010 by Gorlum for http://supernova.ws
  * @version 1.0
+ * @param integer $lab_require
  */
 function eco_get_lab_max_effective_level(&$user, $lab_require)
 {
@@ -193,6 +194,9 @@ 
   return $result;
 }
 
+/**
+ * @param integer[] $unit_list
+ */
 function eco_is_builds_in_que($planet_que, $unit_list)
 {
   $eco_is_builds_in_que = false;

Braces +6 added lines, -12 removed lines

@@ -1,7 +1,6 @@ 
 <?php
 
-function eco_lab_sort_effectivness($a, $b)
-{
+function eco_lab_sort_effectivness($a, $b) {
   return $a['laboratory_effective_level'] > $b['laboratory_effective_level'] ? -1 : ($a['laboratory_effective_level'] < $b['laboratory_effective_level'] ? 1 : 0);
 }
 
@@ -11,8 +10,7 @@ 
  * 1.0 - copyright (c) 2010 by Gorlum for http://supernova.ws
  * @version 1.0
  */
-function eco_get_lab_max_effective_level(&$user, $lab_require)
-{
+function eco_get_lab_max_effective_level(&$user, $lab_require) {
   if(!$user['user_as_ally'] && !isset($user['laboratories_active']))
   {
     $user['laboratories_active'] = array();
@@ -38,8 +36,7 @@ 
     if($user['user_as_ally'])
     {
       $lab_level = doquery("SELECT ally_members AS effective_level FROM {{alliance}} WHERE id = {$user['user_as_ally']} LIMIT 1", true);
-    }
-    else
+    } else
     {
       $tech_intergalactic = mrc_get_level($user, false, TECH_RESEARCH) + 1;
       $lab_level['effective_level'] = 0;
@@ -193,8 +190,7 @@ 
   return $result;
 }
 
-function eco_is_builds_in_que($planet_que, $unit_list)
-{
+function eco_is_builds_in_que($planet_que, $unit_list) {
   $eco_is_builds_in_que = false;
 
   $unit_list = is_array($unit_list) ? $unit_list : array($unit_list => $unit_list);
@@ -216,8 +212,7 @@ 
 }
 
 function eco_unit_busy(&$user, &$planet, $unit_id){return sn_function_call('eco_unit_busy', array(&$user, &$planet, $unit_id, &$result));}
-function sn_eco_unit_busy(&$user, &$planet, $unit_id, &$result)
-{
+function sn_eco_unit_busy(&$user, &$planet, $unit_id, &$result) {
   global $config;
 
   $result = isset($result) ? $result : false;
@@ -238,8 +233,7 @@ 
       //{
       //  $result = true;
       //}
-    }
-    elseif(($unit_id == UNIT_TECHNOLOGIES || in_array($unit_id, sn_get_groups('tech'))) && !$config->BuildLabWhileRun && $planet['que'])
+    } elseif(($unit_id == UNIT_TECHNOLOGIES || in_array($unit_id, sn_get_groups('tech'))) && !$config->BuildLabWhileRun && $planet['que'])
     {
       $result = eco_is_builds_in_que($planet['que'], array(STRUC_LABORATORY, STRUC_LABORATORY_NANO));
     }

includes/functions/eco_queue.php

Doc Comments +6 added lines

@@ -55,6 +55,9 @@ 
 }
 
 
+/**
+ * @param integer $build_mode
+ */
 function que_build($user, $planet, $build_mode = BUILD_CREATE, $redirect = true) {
   global $lang, $config;
 
@@ -378,6 +381,9 @@ 
   return classSupernova::db_que_list_by_type_location($user_id, $planet_id, $que_type, $for_update);
 }
 
+/**
+ * @param integer $unit_id
+ */
 function que_add_unit($unit_id, $user = array(), $planet = array(), $build_data, $unit_level = 0, $unit_amount = 1, $build_mode = BUILD_CREATE) {
   // TODO Унифицировать проверки
 

Braces +1 added lines, -2 removed lines

@@ -458,8 +458,7 @@
 
     if(is_numeric($planet['id'])) {
       DBStaticPlanet::db_planet_set_by_id($planet['id'], "`que_processed` = UNIX_TIMESTAMP(NOW())");
-    }
-    elseif(is_numeric($user['id'])) {
+    } elseif(is_numeric($user['id'])) {
       db_user_set_by_id($user['id'], '`que_processed` = UNIX_TIMESTAMP(NOW())');
     }
 

includes/functions/int_fleet_events.php

Doc Comments +4 added lines

@@ -135,6 +135,10 @@
   return $fleet_events;
 }
 
+/**
+ * @param integer $ov_label
+ * @param integer $planet_end_type
+ */
 function flt_register_fleet_event($fleet, $ov_label, $planet_end_type)
 {
   global $user, $planetrow, $fleet_number;

Braces +6 added lines, -12 removed lines

@@ -1,8 +1,7 @@ 
 <?php
 
 
-function flt_parse_fleets_to_events($fleet_list, $planet_scanned = false)
-{
+function flt_parse_fleets_to_events($fleet_list, $planet_scanned = false) {
   global $config, $user, $fleet_number, $lang;
 
   $fleet_events = array();
@@ -23,12 +22,10 @@ 
     if($fleet['fleet_end_planet'] > $config->game_maxPlanet)
     {
       $fleet['fleet_end_name'] = $lang['ov_fleet_exploration'];
-    }
-    elseif($fleet['fleet_mission'] == MT_COLONIZE)
+    } elseif($fleet['fleet_mission'] == MT_COLONIZE)
     {
       $fleet['fleet_end_name'] = $lang['ov_fleet_colonization'];
-    }
-    else
+    } else
     {
       $planet_end = DBStaticPlanet::db_planet_by_gspt($fleet['fleet_end_galaxy'], $fleet['fleet_end_system'], $fleet['fleet_end_planet'], $planet_end_type, false, 'name');
       $fleet['fleet_end_name'] = $planet_end['name'];
@@ -80,8 +77,7 @@ 
   return $fleet_events;
 }
 
-function flt_register_fleet_event($fleet, $ov_label, $planet_end_type)
-{
+function flt_register_fleet_event($fleet, $ov_label, $planet_end_type) {
   global $user, $planetrow, $fleet_number;
 
   switch($fleet['ov_label'] = $ov_label)
@@ -121,8 +117,7 @@ 
   if($fleet['fleet_owner'] == $user['id'])
   {
     $user_data = $user;
-  }
-  else
+  } else
   {
     $user_data = db_user_by_id($fleet['fleet_owner']);
   }
@@ -130,8 +125,7 @@ 
   return tpl_parse_fleet_db($fleet, ++$fleet_number, $user_data);
 }
 
-function int_planet_pretemplate($planetrow, &$template)
-{
+function int_planet_pretemplate($planetrow, &$template) {
   global $lang, $user;
 
   $governor_id = $planetrow['PLANET_GOVERNOR_ID'];

includes/functions/msg_send_simple_message.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
   return $list;
 }
 
+/**
+ * @param integer $message_type
+ */
 function msg_send_simple_message($owners, $sender, $timestamp, $message_type, $from, $subject, $text, $escaped = false, $force = false)
 {
   global $config, $user, $sn_message_class_list;

Braces +4 added lines, -8 removed lines

@@ -15,8 +15,7 @@ 
    1.5 - copyright (c) 2010-2011 by Gorlum for http://supernova.ws
          [+] SuperMassMailing - authlevel=3 player can send messages to whole server ('*' as $owners)
  */
-function msg_ali_send($message, $subject, $ally_rank_id = 0, $ally_id = 0)
-{
+function msg_ali_send($message, $subject, $ally_rank_id = 0, $ally_id = 0) {
   global $user;
 
   $ally_id = $ally_id ? $ally_id : $user['ally_id'];
@@ -37,8 +36,7 @@ 
   return $list;
 }
 
-function msg_send_simple_message($owners, $sender, $timestamp, $message_type, $from, $subject, $text, $escaped = false, $force = false)
-{
+function msg_send_simple_message($owners, $sender, $timestamp, $message_type, $from, $subject, $text, $escaped = false, $force = false) {
   global $config, $user, $sn_message_class_list;
 
   if(!$owners)
@@ -79,8 +77,7 @@ 
     // TODO Добавить $sender - рассылка может быть и от кого-то
     db_message_insert_all($message_type, $from, $subject, $text);
     $owners = array();
-  }
-  else
+  } else
   {
     $insert_values = array();
     $insert_template = "('%u'," . str_replace('%', '%%', " '{$sender}', '{$timestamp}', '{$message_type}', '{$from}', '{$subject}', '{$text}')");
@@ -90,8 +87,7 @@ 
       if($user['id'] != $owner)
       {
         $owner_row = db_user_by_id($owner);
-      }
-      else
+      } else
       {
         $owner_row = $user;
       }

includes/functions/rpg_points.php

Doc Comments +10 added lines

@@ -161,6 +161,9 @@ 
   return $rows_affected;
 }
 
+/**
+ * @param integer $type
+ */
 function rpg_level_up(&$user, $type, $xp_to_add = 0)
 {
   $q = 1.03;
@@ -223,6 +226,10 @@ 
   }
 }
 
+/**
+ * @param integer $b1
+ * @param double $q
+ */
 function rpg_xp_for_level($level, $b1, $q)
 {
   return floor($b1 * (pow($q, $level) - 1)/($q - 1));
@@ -233,6 +240,9 @@ 
   return rpg_xp_for_level($level, 50, 1.03);
 }
 
+/**
+ * @param integer $level
+ */
 function RPG_get_raider_xp($level)
 {
   return rpg_xp_for_level($level, 10, 1.03);

Braces +6 added lines, -12 removed lines

@@ -161,8 +161,7 @@ 
   return $rows_affected;
 }
 
-function rpg_level_up(&$user, $type, $xp_to_add = 0)
-{
+function rpg_level_up(&$user, $type, $xp_to_add = 0) {
   $q = 1.03;
 
   switch($type)
@@ -223,27 +222,22 @@ 
   }
 }
 
-function rpg_xp_for_level($level, $b1, $q)
-{
+function rpg_xp_for_level($level, $b1, $q) {
   return floor($b1 * (pow($q, $level) - 1)/($q - 1));
 }
 
-function rpg_get_miner_xp($level)
-{
+function rpg_get_miner_xp($level) {
   return rpg_xp_for_level($level, 50, 1.03);
 }
 
-function RPG_get_raider_xp($level)
-{
+function RPG_get_raider_xp($level) {
   return rpg_xp_for_level($level, 10, 1.03);
 }
 
-function rpg_get_tech_xp($level)
-{
+function rpg_get_tech_xp($level) {
   return rpg_xp_for_level($level, 50, 1.03);
 }
 
-function rpg_get_explore_xp($level)
-{
+function rpg_get_explore_xp($level) {
   return rpg_xp_for_level($level, 10, 1.05);
 }

includes/functions/sys_user.php

Doc Comments +3 added lines

@@ -141,6 +141,9 @@
   ");
 }
 
+/**
+ * @param string $email_unsafe
+ */
 function player_create($username_unsafe, $email_unsafe, $options) {
   sn_db_transaction_check(true);