supernova-ws / SuperNova

includes/classes/module.php

Doc Comments +3 added lines

@@ -239,6 +239,9 @@
     }
   }
 
+  /**
+   * @param string $arrayName
+   */
   protected function mergeArraySpecial($arrayName) {
     global $sn_mvc;
 

includes/classes/core_auth.php

Doc Comments +7 added lines, -1 removed lines

@@ -286,7 +286,6 @@ 
   /**
    * Функция пытается залогиниться по всем известным провайдерам
    *
-   * @param null $result
    */
   public function login() {
     if(empty(sn_module::$sn_module_list['auth'])) {
@@ -823,10 +822,17 @@ 
 
   // OK v4.5
   // TODO - REMEMBER_ME
+
+  /**
+   * @param integer $period
+   */
   protected static function cookie_set($value, $impersonate = false, $period = null) {
     sn_setcookie($impersonate ? SN_COOKIE_U_I : SN_COOKIE_U, $value, $period === null ? SN_TIME_NOW + PERIOD_YEAR : $period, SN_ROOT_RELATIVE);
   }
 
+  /**
+   * @param string $message
+   */
   protected static function flog($message, $die = false) {
     if(!defined('DEBUG_AUTH') || !DEBUG_AUTH) {
       return;

includes/classes/Account.php

Doc Comments +21 added lines

@@ -171,6 +171,10 @@ 
    * @return bool
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   */
   public function db_get_by_name($account_name_unsafe) {
     $this->reset();
 
@@ -207,6 +211,11 @@ 
    *
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $email_unsafe
+   */
   public function db_get_by_name_or_email($account_name_unsafe, $email_unsafe) {
     $this->reset();
 
@@ -223,6 +232,13 @@ 
    * @throws Exception
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $password_raw
+   * @param string $email_unsafe
+   * @param string $language_unsafe
+   */
   public function db_create($account_name_unsafe, $password_raw, $email_unsafe, $language_unsafe = null, $salt_unsafe = null) {
     $this->reset();
 
@@ -317,6 +333,11 @@ 
    * @return int|string
    */
   // OK 4.8
+
+  /**
+   * @param integer $change_type
+   * @param double $metamatter
+   */
   protected function db_mm_log_insert($comment, $change_type, $metamatter, $user_id_unsafe) {
     $provider_id_safe = intval(core_auth::$main_provider->provider_id);
     //$account_id_safe = $this->db->db_escape($this->account_id);

includes/db/db_queries.php

Doc Comments +20 added lines, -15 removed lines

@@ -188,6 +188,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);
@@ -220,7 +225,7 @@ 
 
 /**
  * @param $user
- * @param $username_safe
+ * @param string $username_safe
  */
 function db_player_name_history_replace($user, $username_safe) {
   doquery("REPLACE INTO {{player_name_history}} SET `player_id` = {$user['id']}, `player_name` = '{$username_safe}'");
@@ -228,7 +233,7 @@ 
 
 
 /**
- * @param $username_safe
+ * @param string $username_safe
  *
  * @return array|bool|mysqli_result|null
  */
@@ -485,12 +490,12 @@ 
 
 
 /**
- * @param $user_id
- * @param $change_type
+ * @param integer $user_id
+ * @param integer $change_type
  * @param $dark_matter
- * @param $comment
+ * @param string $comment
  * @param $row
- * @param $page_url
+ * @param string $page_url
  */
 function db_log_dark_matter_insert($user_id, $change_type, $dark_matter, $comment, $row, $page_url) {
   doquery(
@@ -506,7 +511,7 @@ 
 /**
  * @param $user_id_safe
  *
- * @return array|bool|mysqli_result|null
+ * @return integer
  */
 function db_referral_get_by_id($user_id_safe) {
   $old_referral = doquery("SELECT * FROM {{referrals}} WHERE `id` = {$user_id_safe} LIMIT 1 FOR UPDATE;", true);
@@ -534,9 +539,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
  */
@@ -580,11 +585,11 @@ 
 }
 
 /**
- * @param $quest_name
- * @param $quest_type
- * @param $quest_description
+ * @param string $quest_name
+ * @param integer $quest_type
+ * @param string $quest_description
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name, $quest_type, $quest_description, $quest_conditions, $quest_rewards, $quest_id) {
@@ -607,7 +612,7 @@ 
 /**
  * @param $banner
  * @param $banned
- * @param $reason
+ * @param string $reason
  * @param $ban_until
  */
 function db_ban_insert($banner, $banned, $reason, $ban_until) {
@@ -630,7 +635,7 @@ 
 /**
  * @param $banner
  * @param $banned
- * @param $reason
+ * @param string $reason
  */
 function db_ban_insert_unset($banner, $banned, $reason) {
   doquery(

includes/classes/cache.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:

includes/classes/Fleet.php

Doc Comments +5 added lines, -3 removed lines

@@ -591,6 +591,9 @@ 
     return max(0, $this->shipsGetCapacity() - $this->resourcesGetTotal());
   }
 
+  /**
+   * @param integer $ship_id
+   */
   public function shipsGetTotalById($ship_id) {
     return $this->unitList->unitsCountById($ship_id);
   }
@@ -705,7 +708,7 @@ 
   /**
    * Set current resource list from array of units
    *
-   * @param array $resource_list
+   * @param integer[] $resource_list
    */
   public function resourcesSet($resource_list) {
     if(!empty($this->propertiesAdjusted['resource_list'])) {
@@ -750,7 +753,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -781,7 +784,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int

includes/db/db_queries_fleet.php

Doc Comments +7 added lines, -3 removed lines

@@ -22,6 +22,10 @@ 
   doquery('DELETE FROM `{{aks}}` WHERE `id` NOT IN (SELECT DISTINCT `fleet_group` FROM `{{fleets}}`);');
 }
 
+/**
+ * @param double $arrival
+ * @param integer $target_structure
+ */
 function db_missile_insert($target_coord, $user, $planetrow, $arrival, $fleet_ship_count, $target_structure) {
   doquery(
     "INSERT INTO `{{iraks}}` SET
@@ -52,7 +56,7 @@ 
 /**
  * @param $user
  * @param $planet_dst
- * @param $time_limit
+ * @param integer $time_limit
  *
  * @return array|bool|mysqli_result|null
  */
@@ -113,14 +117,14 @@ 
 
 
 /**
- * @param $fleet_group_id_list
+ * @param string $fleet_group_id_list
  */
 function db_acs_delete_by_list($fleet_group_id_list) {
   doquery("DELETE FROM {{aks}} WHERE `id` IN ({$fleet_group_id_list})");
 }
 
 /**
- * @param $bashing_list
+ * @param string $bashing_list
  */
 function db_bashing_insert($bashing_list) {
   doquery("INSERT INTO {{bashing}} (bashing_user_id, bashing_planet_id, bashing_time) VALUES {$bashing_list};");

includes/db/db_queries_users.php

Doc Comments +6 added lines

@@ -47,6 +47,9 @@ 
 }
 
 
+/**
+ * @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);
 }
@@ -105,6 +108,9 @@ 
   return isset($result['user_count']) ? $result['user_count'] : 0;
 }
 
+/**
+ * @param integer $config_user_birthday_range
+ */
 function db_user_list_to_celebrate($config_user_birthday_range) {
   return doquery(
     "SELECT

includes/general.php

Doc Comments +29 added lines, -2 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()) {
   // All data in classSupernova::$functions should be normalized to valid 'callable' state: '<function_name>'|array('<object_name>', '<method_name>')
 
@@ -57,6 +60,9 @@ 
 
 // ----------------------------------------------------------------------------------------------------------------
 // Fonction de lecture / ecriture / exploitation de templates
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename) {
   return @file_get_contents($filename);
 }
@@ -99,7 +105,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -140,7 +146,7 @@ 
  * @param float     $n
  * @param int|bool  $floor
  * @param int|bool  $color
- * @param int|bool  $limit
+ * @param boolean  $limit
  * @param bool|null $style
  *
  * @return array|float|string
@@ -241,6 +247,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));
 }
@@ -273,6 +282,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));
 }
@@ -505,6 +517,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);
 
@@ -609,6 +624,9 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   $from = trim($from ? $from : classSupernova::$config->game_adminEmail);
 
@@ -863,6 +881,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -1110,6 +1131,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) {
@@ -1420,6 +1444,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;