supernova-ws / SuperNova

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

includes/general/math.php

Doc Comments +2 added lines, -2 removed lines

@@ -37,11 +37,11 @@
 /**
  * @param float      $range_start - Начало диапазона
  * @param float      $range_end - Конец диапазона
- * @param bool|int  $round - До скольки знаков округлять результат. False - не округлять, True - округлять до целого, 1 - округлять до десятков, 2 - до сотен итд
+ * @param boolean  $round - До скольки знаков округлять результат. False - не округлять, True - округлять до целого, 1 - округлять до десятков, 2 - до сотен итд
  * @param int        $strict - В сколько сигм надо уложить результат
  * @param bool|false $cut_extreme - надо ли обрезать крайние значения. Например, при $strict = 2 их слишком много
  *
- * @return float|int
+ * @return double
  */
 function sn_rand_gauss_range($range_start, $range_end, $round = true, $strict = 4, $cut_extreme = false)  {
   if($cut_extreme) {

includes/includes/flt_functions.php

Doc Comments +3 added lines

@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @return double
+ */
 function flt_fleet_speed($user, $fleet)
 {
   if (!is_array($fleet))

includes/includes/flt_mission_spy.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
   }
 }
 
+/**
+ * @param string $group_name
+ */
 function flt_spy_scan($target_planet, $group_name, $section_title, $target_user = array())
 {
   global $lang;

includes/includes/mrc_mercenary.php

Doc Comments +4 added lines

@@ -26,6 +26,10 @@
   return true;
 }
 
+/**
+ * @param integer $mode
+ * @param integer $mercenary_id
+ */
 function mrc_mercenary_hire($mode, $user, $mercenary_id) {
   global $config, $lang, $sn_powerup_buy_discounts;
 

includes/classes/Bonus.php

Doc Comments +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
   /**
    * Добавляет юнит к списку бонусов
    *
-   * @param $unit_id
+   * @param integer $unit_id
    * @param $unit_level
    */
   public function add_unit_by_snid($unit_id, $unit_level) {
@@ -67,7 +67,7 @@ 
    *
    * Выдает финальный бонус в виде множителя
    *
-   * @param string|int $param - ИД бонуса
+   * @param string $param - ИД бонуса
    *
    * @return float
    */

includes/classes/DBRow.php

Doc Comments +2 added lines, -2 removed lines

@@ -266,7 +266,7 @@ 
   /**
    * Inserts record to DB
    *
-   * @return int|string
+   * @return integer
    */
   public function dbInsert() {
     if(!$this->isNew()) {
@@ -398,7 +398,7 @@ 
   /**
    * @param array $field_set
    *
-   * @return int|string
+   * @return integer
    */
   protected function db_field_set_create(array $field_set) {
     !sn_db_field_set_is_safe($field_set) ? $field_set = sn_db_field_set_make_safe($field_set) : false;

includes/classes/Fleet.php

Doc Comments +8 added lines, -1 removed lines

@@ -296,6 +296,10 @@ 
    * @return array|bool|mysqli_result|null
    */
   // TODO - унести куда-то глубоко. Например в DBAware или даже в БД-драйвер
+
+  /**
+   * @param string $set_safe_string
+   */
   protected function db_fleet_update_set_safe_string($set_safe_string) {
     $fleet_id_safe = idval($this->_dbId);
     if(!empty($fleet_id_safe) && !empty($set_safe_string)) {
@@ -561,6 +565,9 @@ 
     $this->core_field_set_list['fleet_mission'] = $this->mission_type = $mission_id;
   }
 
+  /**
+   * @param integer $ship_id
+   */
   public function shipCountById($ship_id) {
     return $this->unitList->unitCountById($ship_id);
   }
@@ -672,7 +679,7 @@ 
   /**
    * Set current resource list from array of units
    *
-   * @param array $resource_list
+   * @param integer[] $resource_list
    */
   public function replace_resources($resource_list) {
     // TODO - Resets also delta and changes?!