supernova-ws / SuperNova

includes/includes/flt_mission_transport.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
 /**
  * Fleet mission "Relocate"
  *
- * @param $mission_data Mission
+ * @param Mission $mission_data Mission
  *
  * @return int
  *

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

@@ -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/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)
   {