supernova-ws / SuperNova

includes/template.php

Doc Comments +5 added lines, -6 removed lines

@@ -34,7 +34,7 @@ 
  * @param string    $title
  * @param string    $dest
  * @param int       $time
- * @param bool|true $show_header
+ * @param boolean $show_header
  */
 function message($mes, $title = 'Error', $dest = '', $time = 5, $show_header = true) {
   $template = gettemplate('message_body', true);
@@ -195,7 +195,7 @@ 
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
  * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
+ * @param boolean       $isDisplayMenu
  *
  * @return mixed
  */
@@ -208,7 +208,6 @@ 
  * @param string          $title
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
- * @param bool|false      $AdminPage
  * @param bool|true       $isDisplayMenu
  * @param bool|int|string $exitStatus - Код или сообщение выхода
  */
@@ -385,10 +384,10 @@ 
 
 /**
  * @param       $time
- * @param       $event
+ * @param       integer $event
  * @param       $msg
  * @param       $coordinates
- * @param       $is_decrease
+ * @param       boolean $is_decrease
  * @param Fleet $objFleet
  * @param       $fleet_flying_sorter
  * @param       $fleet_flying_events
@@ -708,7 +707,7 @@ 
 }
 
 /**
- * @param array|string  $files
+ * @param string  $files
  * @param template|bool $template
  * @param string|bool   $template_path
  *

includes/classes/UBE/UBEFleet.php

Doc Comments +11 added lines, -4 removed lines

@@ -150,7 +150,7 @@ 
   }
 
   /**
-   * @param $ube_report_id
+   * @param integer $ube_report_id
    *
    * @return array
    *
@@ -288,7 +288,7 @@ 
 
 
   /**
-   * @param $ube_report_id
+   * @param integer $ube_report_id
    *
    * @return array
    */
@@ -336,7 +336,7 @@ 
   // Рендерит таблицу общего результата боя
   /**
    * @param $array
-   * @param $lang_header_index
+   * @param string $lang_header_index
    *
    * @return array
    */
@@ -362,6 +362,9 @@ 
   }
 
 
+  /**
+   * @param integer $ube_report_id
+   */
   public function sql_generate_outcome_unit_array(&$sql_perform_report_unit, $ube_report_id) {
     $fleet_id = $this->db_id;
 
@@ -468,6 +471,10 @@ 
     $this->fleet_capacity -= $fleet_total_resources;
   }
 
+  /**
+   * @param integer $is_small_fleet_recce
+   * @param integer $reapers_status
+   */
   public function db_save_combat_result_fleet($is_small_fleet_recce, $reapers_status) {
     $ship_count_initial = $this->unit_list->unitsCount();
     $ship_count_lost = $this->unit_list->unitCountLost();
@@ -535,7 +542,7 @@ 
 
   /**
    * @param UBEFleetList $fleet_list
-   * @param              $is_simulator
+   * @param              boolean $is_simulator
    *
    * @version 2016-02-25 23:42:45 41a4.68
    */

includes/includes/flt_flying_fleet_handler2.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
  *
  * @param Fleet $objFleet
  * @param bool  $start
- * @param null  $result
+ * @param integer  $result
  *
  * @return mixed
  */

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

Doc Comments +14 added lines

@@ -21,11 +21,19 @@ 
     return empty($result) ? null : $result;
   }
 
+  /**
+   * @param integer $galaxy
+   * @param integer $system
+   * @param integer $planet
+   */
   public static function db_planet_by_gspt_safe($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     return classSupernova::db_get_record_list(LOC_PLANET,
       "{{planets}}.`galaxy` = {$galaxy} AND {{planets}}.`system` = {$system} AND {{planets}}.`planet` = {$planet} AND {{planets}}.`planet_type` = {$planet_type}", true);
   }
 
+  /**
+   * @param integer $planet_type
+   */
   public static function db_planet_by_gspt($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     $galaxy = intval($galaxy);
     $system = intval($system);
@@ -120,6 +128,9 @@ 
       "`id_owner` = '{$user_row['id']}' {$conditions} ORDER BY {$order_by}");
   }
 
+  /**
+   * @param integer $planet_id
+   */
   public static function db_planet_list_by_user_or_planet($user_id, $planet_id) {
     if(!($user_id = idval($user_id)) && !($planet_id = idval($planet_id))) {
       return false;
@@ -138,6 +149,9 @@ 
     return classSupernova::db_upd_record_by_id(LOC_PLANET, $planet_id, $set);
   }
 
+  /**
+   * @param integer $ui_planet_type
+   */
   public static function db_planet_set_by_gspt($ui_galaxy, $ui_system, $ui_planet, $ui_planet_type = PT_ALL, $set) {
     if(!($set = trim($set))) {
       return false;