supernova-ws / SuperNova

includes/functions/eco_planet_update.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
  *     [+] Full rewrote and optimization
  *
  */
+/**
+ * @param integer $UpdateTime
+ */
 function sys_o_get_updated($user, $planet, $UpdateTime, $simulation = false, $no_user_update = false) {
   sn_db_transaction_check(true);
 

includes/db/db_queries.php

Doc Comments +15 added lines, -10 removed lines

@@ -169,6 +169,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 = classSupernova::$db->doSelectFetch("SELECT `{$db_id_field_name}` FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE");
@@ -487,8 +492,8 @@ 
 
 
 /**
- * @param $user_id
- * @param $change_type
+ * @param integer $user_id
+ * @param integer $change_type
  * @param $dark_matter
  * @param $comment_unsafe
  * @param $rowUserNameUnsafe
@@ -509,7 +514,7 @@ 
 /**
  * @param $user_id_safe
  *
- * @return array|bool|mysqli_result|null
+ * @return integer
  */
 function db_referral_get_by_id($user_id_safe) {
   $old_referral = classSupernova::$db->doSelectFetch("SELECT * FROM {{referrals}} WHERE `id` = {$user_id_safe} LIMIT 1 FOR UPDATE;");
@@ -540,9 +545,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
  */
@@ -586,11 +591,11 @@ 
 }
 
 /**
- * @param $quest_name_unsafe
- * @param $quest_type
- * @param $quest_description_unsafe
+ * @param string $quest_name_unsafe
+ * @param integer $quest_type
+ * @param string $quest_description_unsafe
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name_unsafe, $quest_type, $quest_description_unsafe, $quest_conditions, $quest_rewards, $quest_id) {
@@ -674,7 +679,7 @@ 
 
 /**
  * @param $payment_id
- * @param $payment_status
+ * @param integer $payment_status
  * @param $comment_unsafe
  */
 function db_payment_update($payment_id, $payment_status, $comment_unsafe) {

includes/db.php

Doc Comments +3 added lines, -1 removed lines

@@ -16,7 +16,6 @@ 
  * @param       $user
  * @param       $planet
  * @param array $unit_list
- * @param null  $query
  */
 function db_change_resources(&$user, &$planet, $unit_list) {
   $group = sn_get_groups('resources_loot');
@@ -56,6 +55,9 @@ 
 
 }
 
+/**
+ * @param boolean $transaction_should_be_started
+ */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::$gc->db->getTransaction()->check($transaction_should_be_started);
 }

includes/general.php

Doc Comments +34 added lines, -3 removed lines

@@ -11,7 +11,7 @@ 
 require_once('general_pname.php');
 
 /**
- * @param       $func_name
+ * @param       string $func_name
  * @param array $func_arg
  *
  * @return mixed
@@ -62,6 +62,9 @@ 
 }
 
 // ----------------------------------------------------------------------------------------------------------------
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename) {
   return @file_get_contents($filename);
 }
@@ -104,7 +107,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -130,7 +133,7 @@ 
  *    - true    - colors number to green if positive or zero; red if negative
  *    - 0
  *    - numeric - colors number to green if less then $color; red if greater
- * @param int|bool  $limit - generally converts "15000" to "15k", "2000000" to "2kk" etc
+ * @param boolean  $limit - generally converts "15000" to "15k", "2000000" to "2kk" etc
  *    - 0/false - proceed with $floor
  *    - numeric - divides number to segments by power of $limit and adds 'k' for each segment
  *        - makes sense for 1000, but works with any number
@@ -229,6 +232,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));
 }
@@ -266,6 +272,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));
 }
@@ -434,6 +443,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);
 
@@ -538,6 +550,10 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $title
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   $from = trim($from ? $from : classSupernova::$config->game_adminEmail);
 
@@ -803,6 +819,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -990,6 +1009,9 @@ 
   return $result;
 }
 
+/**
+ * @param string $groups
+ */
 function isInGroup($groups, $unitId) {
   $group = sn_get_groups($groups);
 
@@ -1058,6 +1080,9 @@ 
   return $ranks;
 }
 
+/**
+ * @param boolean $planet_id
+ */
 function sys_player_new_adjust($user_id, $planet_id) { return sn_function_call(__FUNCTION__, array($user_id, $planet_id, &$result)); }
 
 function sn_sys_player_new_adjust($user_id, $planet_id, &$result) {
@@ -1216,6 +1241,9 @@ 
   return $rates;
 }
 
+/**
+ * @param integer $in_resource
+ */
 function get_unit_cost_in(&$cost, $in_resource = RES_METAL) {
   static $rates;
 
@@ -1382,6 +1410,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;
 

classes/auth_local.php

Doc Comments +7 added lines, -1 removed lines

@@ -134,7 +134,6 @@ 
   /**
    * Попытка залогиниться с использованием метода $method
    *
-   * @param string $method_name
    */
   public function login() {
     // TODO Проверяем поддерживаемость метода
@@ -162,6 +161,10 @@ 
    * @return array|bool|resource
    */
   // OK v4.5
+
+  /**
+   * @param string $salt_unsafe
+   */
   public function password_change($old_password_unsafe, $new_password_unsafe, $salt_unsafe = null) {
     $result = parent::password_change($old_password_unsafe, $new_password_unsafe, $salt_unsafe);
     if($result) {
@@ -171,6 +174,9 @@ 
     return $result;
   }
 
+  /**
+   * @param Account $account_to_impersonate
+   */
   public function impersonate($account_to_impersonate) {
     $this->cookie_set($account_to_impersonate);
   }

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
    */

classes/classCache.php

Doc Comments +7 added lines

@@ -81,6 +81,10 @@ 
   // -------------------------------------------------------------------------
   // Here comes low-level functions - those that directly works with cacher engines
   // -------------------------------------------------------------------------
+
+  /**
+   * @param string $name
+   */
   public function __set($name, $value) {
     switch ($name) {
       case '_MODE':
@@ -132,6 +136,9 @@ 
     return null;
   }
 
+  /**
+   * @param string $name
+   */
   public function __isset($name) {
     switch (self::$mode) {
       case CACHER_NO_CACHE:

classes/classLocale.php

Doc Comments +3 added lines

@@ -173,6 +173,9 @@
   }
 
 
+  /**
+   * @param string $path
+   */
   protected function lng_try_filepath($path, $file_path_relative) {
     $file_path = SN_ROOT_PHYSICAL . ($path && file_exists(SN_ROOT_PHYSICAL . $path . $file_path_relative) ? $path : '') . $file_path_relative;
     return file_exists($file_path) ? $file_path : false;

classes/Common/snMath.php

Doc Comments +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
    * @param int  $sigma
    * @param bool $strict
    *
-   * @return int
+   * @return double
    */
   public static function sn_rand_gauss($mu = 0, $sigma = 1, $strict = false) {
     // http://ru.wikipedia.org/wiki/Среднеквадратическое_отклонение
@@ -42,7 +42,7 @@ 
    *
    * @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 их слишком много
    *