supernova-ws / SuperNova

includes/db/db_queries_planets.php

Doc Comments +15 added lines

@@ -4,11 +4,20 @@ 
 {
   return classSupernova::db_get_record_by_id(LOC_PLANET, $planet_id, $for_update, $fields);
 }
+/**
+ * @param integer $galaxy
+ * @param integer $system
+ * @param integer $planet
+ * @param integer $planet_type
+ */
 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
+ */
 function db_planet_by_gspt($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*')
 {
   $galaxy = intval($galaxy);
@@ -79,6 +88,9 @@ 
   return classSupernova::db_get_record_list(LOC_PLANET,
     "`id_owner` = '{$user_row['id']}' {$conditions} ORDER BY {$order_by}");
 }
+/**
+ * @param integer $planet_id
+ */
 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;
 
@@ -92,6 +104,9 @@ 
   if(!($planet_id = idval($planet_id))) return false;
   return classSupernova::db_upd_record_by_id(LOC_PLANET, $planet_id, $set);
 }
+/**
+ * @param integer $ui_planet_type
+ */
 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/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/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);
 

includes/functions/uni_functions.php

Doc Comments +3 added lines

@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @param double $planet_sectors
+ */
 function uni_create_planet_get_density($position_data, $user_row, $planet_sectors) {
   $density_list = sn_get_groups('planet_density');
   $density_min = reset($density_list);

includes/general.php

Doc Comments +29 added lines, -1 removed lines

@@ -11,6 +11,9 @@ 
 require_once('general/math.php');
 require_once('general_pname.php');
 
+/**
+ * @param string $func_name
+ */
 function sn_function_call($func_name, $func_arg = array())
 {
   global $functions; // All data in $functions should be normalized to valid 'callable' state: '<function_name>'|array('<object_name>', '<method_name>')
@@ -58,6 +61,9 @@ 
 
 // ----------------------------------------------------------------------------------------------------------------
 // Fonction de lecture / ecriture / exploitation de templates
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename)
 {
   return @file_get_contents($filename);
@@ -106,7 +112,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -143,6 +149,7 @@ 
    null  - standard result
    true  - return only style class for current params
    false - return array('text' => $ret, 'class' => $class), where $ret - unstyled
+ * @param boolean $style
  */
 
 function pretty_number($n, $floor = true, $color = false, $limit = false, $style = null)
@@ -262,6 +269,9 @@ 
   return preg_replace($ListCensure, '*', $String);
 }
 
+/**
+ * @param string $email
+ */
 function is_email($email) {
   return(preg_match("/^[-_.[:alnum:]]+@((([[:alnum:]]|[[:alnum:]][[:alnum:]-]*[[:alnum:]])\.)+(ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|at|au|aw|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|com|coop|cr|cs|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gh|gi|gl|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|in|info|int|io|iq|ir|is|it|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mil|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no|np|nr|nt|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)$|(([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5])\.){3}([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5]))$/i", $email));
 }
@@ -298,6 +308,9 @@ 
   return floatval(sys_get_param($param_name, $default));
 }
 
+/**
+ * @param string $param_name
+ */
 function sys_get_param_escaped($param_name, $default = '')
 {
   return db_escape(sys_get_param($param_name, $default));
@@ -542,6 +555,9 @@ 
 }
 
 // Generates random string of $length symbols from $allowed_chars charset
+/**
+ * @param string $allowed_chars
+ */
 function sys_random_string($length = 16, $allowed_chars = SN_SYS_SEC_CHARS_ALLOWED) {
   $allowed_length = strlen($allowed_chars);
 
@@ -667,6 +683,9 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   global $config, $lang;
 
@@ -954,6 +973,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -1237,6 +1259,9 @@ 
   return $ranks;
 }
 
+/**
+ * @param boolean $planet_id
+ */
 function sys_player_new_adjust($user_id, $planet_id){return sn_function_call('sys_player_new_adjust', array($user_id, $planet_id, &$result));}
 function sn_sys_player_new_adjust($user_id, $planet_id, &$result) {
   return $result;
@@ -1589,6 +1614,9 @@ 
   return version_compare(sn_version_compare_extra($ver1), sn_version_compare_extra($ver2));
 }
 
+/**
+ * @param string $name
+ */
 function sn_setcookie($name, $value = null, $expire = null, $path = SN_ROOT_RELATIVE, $domain = null, $secure = null, $httponly = null) {
   $_COOKIE[$name] = $value;
   return setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);