supernova-ws / SuperNova

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/classes/db_mysql.php

Doc Comments +10 added lines, -3 removed lines

@@ -124,7 +124,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    *
    * @return mixed
    */
@@ -140,8 +140,8 @@ 
   }
 
   /**
-   * @param       $query
-   * @param       $fetch
+   * @param       string $query
+   * @param       boolean $fetch
    */
   public function logQuery($query, $fetch) {
     if(!classSupernova::$config->debug) {
@@ -204,6 +204,10 @@ 
 
 
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   function security_watch_user_queries($query) {
     global $user;
 
@@ -227,6 +231,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   function security_query_check_bad_words($query) {
     global $user, $dm_change_legit, $mm_change_legit;
 

includes/classes/Vector.php

Doc Comments +2 added lines, -2 removed lines

@@ -10,8 +10,8 @@
   /**
    * UniverseVector constructor.
    *
-   * @param int|string       $galaxy
-   * @param int|Vector|array $system
+   * @param integer       $galaxy
+   * @param integer $system
    * @param int              $planet
    * @param int              $type
    */

includes/general.php

Doc Comments +27 added lines, -3 removed lines

@@ -12,7 +12,7 @@ 
 require_once('general_pname.php');
 
 /**
- * @param       $func_name
+ * @param       string $func_name
  * @param array $func_arg
  *
  * @return mixed
@@ -63,6 +63,9 @@ 
 
 // ----------------------------------------------------------------------------------------------------------------
 // Fonction de lecture / ecriture / exploitation de templates
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename) {
   return @file_get_contents($filename);
 }
@@ -105,7 +108,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -146,7 +149,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
@@ -247,6 +250,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));
 }
@@ -283,6 +289,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));
 }
@@ -515,6 +524,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);
 
@@ -619,6 +631,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);
 
@@ -873,6 +888,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -1120,6 +1138,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) {
@@ -1430,6 +1451,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;
 

includes/classes/Fleet.php

Doc Comments +5 added lines, -3 removed lines

@@ -972,7 +972,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'])) {
@@ -1020,7 +1020,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -1051,7 +1051,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int
@@ -1205,6 +1204,9 @@ 
   }
 
 
+  /**
+   * @param integer $missionStartTimeStamp
+   */
   protected function renderFleetCoordinates($missionStartTimeStamp = SN_TIME_NOW, $timeMissionJob = 0) {
     $timeToReturn = $this->travelData['duration'] * 2 + $timeMissionJob;
 

includes/debug.class.php

Doc Comments +6 added lines

@@ -70,6 +70,9 @@ 
     $this->numqueries = 0;
   }
 
+  /**
+   * @param string $mes
+   */
   function add($mes) {
     $this->log .= $mes;
     $this->numqueries++;
@@ -185,6 +188,9 @@ 
     return $error_backtrace;
   }
 
+  /**
+   * @param string $die_message
+   */
   function error_fatal($die_message, $details = 'There is a fatal error on page') {
     // TODO - Записывать детали ошибки в лог-файл
     die($die_message);

includes/classes/DBStaticRecord.php

Doc Comments +2 added lines, -2 removed lines

@@ -96,8 +96,8 @@
   }
 
   /**
-   * @param int|string $user_id
-   * @param array      $fieldList
+   * @param integer $user_id
+   * @param string[]      $fieldList
    * @param bool       $for_update
    *
    * @return array|null

includes/classes/DBStaticUser.php

Doc Comments +6 added lines

@@ -90,6 +90,9 @@ 
 
 
 
+  /**
+   * @param boolean $player
+   */
   public static 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);
   }
@@ -126,6 +129,9 @@ 
 
 
 
+  /**
+   * @param integer $config_user_birthday_range
+   */
   public static function db_user_list_to_celebrate($config_user_birthday_range) {
     return doquery(
       "SELECT

includes/classes/classSupernova.php

Doc Comments +6 added lines, -3 removed lines

@@ -323,7 +323,7 @@ 
    *   <p>null - транзакция НЕ должна быть запущена</p>
    *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
    *   <p>false - всё равно - для совместимости с $for_update</p>
-   * @return bool Текущий статус транзакции
+   * @return null|boolean Текущий статус транзакции
    */
   public static function db_transaction_check($status = null) {
     $error_msg = false;
@@ -399,7 +399,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */
@@ -587,6 +587,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $location_type
+   */
   public static function db_ins_field_set($location_type, $field_set, $serialize = false) {
     // TODO multiinsert
     !sn_db_field_set_is_safe($field_set) ? $field_set = sn_db_field_set_make_safe($field_set, $serialize) : false;
@@ -809,7 +812,7 @@ 
    * @param     $location_type
    * @param     $location_id
    *
-   * @return array|bool
+   * @return boolean
    */
   public static function db_get_unit_list_by_location($user_id = 0, $location_type, $location_id)
   {