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);

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;

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 Унифицировать проверки
 

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;

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;

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);

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);