supernova-ws / SuperNova

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);
   }

Spacing +51 added lines, -51 removed lines

@@ -95,12 +95,12 @@ 
     $this->prepare();
 
     $this->manifest['active'] = false;
-    if(!empty($this->config) && is_array($this->config['db'])) {
+    if (!empty($this->config) && is_array($this->config['db'])) {
       // БД, отличная от стандартной
       $this->db = classSupernova::$gc->db;
 
       $this->db->sn_db_connect($this->config['db']);
-      if($this->manifest['active'] = $this->db->connected) {
+      if ($this->manifest['active'] = $this->db->connected) {
         $this->provider_id = ACCOUNT_PROVIDER_CENTRAL;
 
         $this->domain = $this->config['domain'];
@@ -114,7 +114,7 @@ 
     }
 
     // Fallback to local DB
-    if(!$this->manifest['active']) {
+    if (!$this->manifest['active']) {
       $this->db = classSupernova::$db;
 
       $this->provider_id = ACCOUNT_PROVIDER_LOCAL;
@@ -166,7 +166,7 @@ 
   // OK v4.5
   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) {
+    if ($result) {
       $this->cookie_set();
     }
 
@@ -194,12 +194,12 @@ 
    */
   // OK v4.6
   protected function password_reset_send_code() {
-    if(!$this->is_password_reset) {
+    if (!$this->is_password_reset) {
       return $this->account_login_status;
     }
 
     // Проверяем поддержку сброса пароля
-    if(!$this->is_feature_supported(AUTH_FEATURE_PASSWORD_RESET)) {
+    if (!$this->is_feature_supported(AUTH_FEATURE_PASSWORD_RESET)) {
       return $this->account_login_status;
     }
 
@@ -209,7 +209,7 @@ 
       unset($this->account);
       $this->account = new Account($this->db);
 
-      if(!$this->account->db_get_by_email($email_unsafe)) {
+      if (!$this->account->db_get_by_email($email_unsafe)) {
         throw new Exception(PASSWORD_RESTORE_ERROR_EMAIL_NOT_EXISTS, ERR_ERROR);
         // return $this->account_login_status;
       }
@@ -219,14 +219,14 @@ 
 
       // TODO - Проверять уровень доступа аккаунта!
       // Аккаунты с АУТЛЕВЕЛ больше 0 - НЕ СБРАСЫВАЮТ ПАРОЛИ!
-      foreach($user_list as $user_id => $user_data) {
-        if($user_data['authlevel'] > AUTH_LEVEL_REGISTERED) {
+      foreach ($user_list as $user_id => $user_data) {
+        if ($user_data['authlevel'] > AUTH_LEVEL_REGISTERED) {
           throw new Exception(PASSWORD_RESTORE_ERROR_ADMIN_ACCOUNT, ERR_ERROR);
         }
       }
 
       $confirmation = $this->confirmation->db_confirmation_get_latest_by_type_and_email(CONFIRM_PASSWORD_RESET, $email_unsafe); // OK 4.5
-      if(isset($confirmation['create_time']) && SN_TIME_NOW - strtotime($confirmation['create_time']) < PERIOD_MINUTE_10) {
+      if (isset($confirmation['create_time']) && SN_TIME_NOW - strtotime($confirmation['create_time']) < PERIOD_MINUTE_10) {
         throw new Exception(PASSWORD_RESTORE_ERROR_TOO_OFTEN, ERR_ERROR);
       }
 
@@ -243,7 +243,7 @@ 
       );
 
       $result = $result ? PASSWORD_RESTORE_SUCCESS_CODE_SENT : PASSWORD_RESTORE_ERROR_SENDING;
-    } catch(Exception $e) {
+    } catch (Exception $e) {
       sn_db_transaction_rollback();
       $result = $e->getMessage();
     }
@@ -256,46 +256,46 @@ 
    * @return int|string
    */
   protected function password_reset_confirm() {
-    if(!$this->is_password_reset_confirm) {
+    if (!$this->is_password_reset_confirm) {
       return $this->account_login_status;
     }
 
-    if($this->account_login_status != LOGIN_UNDEFINED) {
+    if ($this->account_login_status != LOGIN_UNDEFINED) {
       return $this->account_login_status;
     }
 
     // Проверяем поддержку сброса пароля
-    if(!$this->is_feature_supported(AUTH_FEATURE_PASSWORD_RESET)) {
+    if (!$this->is_feature_supported(AUTH_FEATURE_PASSWORD_RESET)) {
       return $this->account_login_status;
     }
 
     try {
       $code_unsafe = sys_get_param_str_unsafe('password_reset_code');
-      if(empty($code_unsafe)) {
+      if (empty($code_unsafe)) {
         throw new Exception(PASSWORD_RESTORE_ERROR_CODE_EMPTY, ERR_ERROR);
       }
 
       sn_db_transaction_start();
       $confirmation = $this->confirmation->db_confirmation_get_by_type_and_code(CONFIRM_PASSWORD_RESET, $code_unsafe); // OK 4.5
 
-      if(empty($confirmation)) {
+      if (empty($confirmation)) {
         throw new Exception(PASSWORD_RESTORE_ERROR_CODE_WRONG, ERR_ERROR);
       }
 
-      if(SN_TIME_NOW - strtotime($confirmation['create_time']) > AUTH_PASSWORD_RESET_CONFIRMATION_EXPIRE) {
+      if (SN_TIME_NOW - strtotime($confirmation['create_time']) > AUTH_PASSWORD_RESET_CONFIRMATION_EXPIRE) {
         throw new Exception(PASSWORD_RESTORE_ERROR_CODE_TOO_OLD, ERR_ERROR);
       }
 
       unset($this->account);
       $this->account = new Account($this->db);
 
-      if(!$this->account->db_get_by_email($confirmation['email'])) {
+      if (!$this->account->db_get_by_email($confirmation['email'])) {
         throw new Exception(PASSWORD_RESTORE_ERROR_CODE_OK_BUT_NO_ACCOUNT_FOR_EMAIL, ERR_ERROR);
       }
 
       $new_password_unsafe = $this->make_random_password();
       $salt_unsafe = $this->password_salt_generate();
-      if(!$this->account->db_set_password($new_password_unsafe, $salt_unsafe)) {
+      if (!$this->account->db_set_password($new_password_unsafe, $salt_unsafe)) {
         // Ошибка смены пароля
         throw new Exception(AUTH_ERROR_INTERNAL_PASSWORD_CHANGE_ON_RESTORE, ERR_ERROR);
       }
@@ -305,7 +305,7 @@ 
       $this->cookie_set();
       $this->login_cookie();
 
-      if($this->account_login_status == LOGIN_SUCCESS) {
+      if ($this->account_login_status == LOGIN_SUCCESS) {
         // TODO - НЕ ОБЯЗАТЕЛЬНО ОТПРАВЛЯТЬ ЧЕРЕЗ ЕМЕЙЛ! ЕСЛИ ЭТО ФЕЙСБУЧЕК ИЛИ ВКШЕЧКА - МОЖНО ЧЕРЕЗ ЛС ПИСАТЬ!!
         $message_header = sprintf(classLocale::$lang['log_lost_email_title'], classSupernova::$config->game_name);
         $message = sprintf(classLocale::$lang['log_lost_email_pass'], classSupernova::$config->game_name, $this->account->account_name, $new_password_unsafe);
@@ -313,7 +313,7 @@ 
         mymail($confirmation['email'], $message_header, htmlspecialchars($message));
 
         $users_translated = PlayerToAccountTranslate::db_translate_get_users_from_account_list($this->provider_id, $this->account->account_id); // OK 4.5
-        if(!empty($users_translated)) {
+        if (!empty($users_translated)) {
           // Отправляем в лички письмо о сбросе пароля
 
           // ПО ОПРЕДЕЛЕНИЮ в $users_translated только
@@ -324,7 +324,7 @@ 
           $message = sprintf(classLocale::$lang['sys_password_reset_message_body'], $new_password_unsafe);
           $message = sys_bbcodeParse($message) . '<br><br>';
 
-          foreach($users_translated as $user_id => $providers_list) {
+          foreach ($users_translated as $user_id => $providers_list) {
             DBStaticMessages::msgSendFromAdmin($user_id, classLocale::$lang['sys_login_register_message_title'], $message);
           }
         } else {
@@ -377,7 +377,7 @@ 
     $this->flog('Регистрация: начинаем. Провайдер ' . $this->provider_id);
 
     try {
-      if(!$this->is_register) {
+      if (!$this->is_register) {
         $this->flog('Регистрация: не выставлен флаг регистрации - пропускаем');
         throw new Exception(LOGIN_UNDEFINED, ERR_ERROR);
       }
@@ -387,8 +387,8 @@ 
       sn_db_transaction_start();
 
       $this->account->db_get_by_name_or_email($this->input_login_unsafe, $this->input_email_unsafe);
-      if($this->account->is_exists) {
-        if($this->account->account_email == $this->input_email_unsafe) {
+      if ($this->account->is_exists) {
+        if ($this->account->account_email == $this->input_email_unsafe) {
           throw new Exception(REGISTER_ERROR_EMAIL_EXISTS, ERR_ERROR);
         } else {
           throw new Exception(REGISTER_ERROR_ACCOUNT_NAME_EXISTS, ERR_ERROR);
@@ -410,7 +410,7 @@ 
       // А вот это пока не нужно. Трансляцией аккаунтов в юзеров и созданием новых юзеров для новозашедших аккаунтов занимается Auth
       // $this->register_account();
       sn_db_transaction_commit();
-    } catch(Exception $e) {
+    } catch (Exception $e) {
       sn_db_transaction_rollback();
       $this->account_login_status == LOGIN_UNDEFINED ? $this->account_login_status = $e->getMessage() : false;
     }
@@ -424,19 +424,19 @@ 
    * @return int Результат попытки
    */
   protected function login_cookie() {
-    if($this->account_login_status != LOGIN_UNDEFINED) {
+    if ($this->account_login_status != LOGIN_UNDEFINED) {
       return $this->account_login_status;
     }
 
     // Пытаемся войти по куке
-    if(!empty($_COOKIE[$this->cookie_name])) {
-      if(count(explode("/%/", $_COOKIE[$this->cookie_name])) < 4) {
+    if (!empty($_COOKIE[$this->cookie_name])) {
+      if (count(explode("/%/", $_COOKIE[$this->cookie_name])) < 4) {
         list($account_id_unsafe, $cookie_password_hash_salted, $user_remember_me) = explode(AUTH_COOKIE_DELIMETER, $_COOKIE[$this->cookie_name]);
       } else {
         list($account_id_unsafe, $user_name, $cookie_password_hash_salted, $user_remember_me) = explode("/%/", $_COOKIE[$this->cookie_name]);
       }
 
-      if(
+      if (
         $this->account->db_get_by_id($account_id_unsafe)
         && ($this->password_encode_for_cookie($this->account->account_password) == $cookie_password_hash_salted)
       ) {
@@ -445,7 +445,7 @@ 
       }
     }
 
-    if($this->account_login_status != LOGIN_SUCCESS) {
+    if ($this->account_login_status != LOGIN_SUCCESS) {
       // Невалидная кука - чистим
       $this->cookie_clear();
     }
@@ -462,29 +462,29 @@ 
   protected function login_username() {
     // TODO - Логин по старым именам
     try {
-      if(!$this->is_login) {
+      if (!$this->is_login) {
         $this->flog('Логин: не выставлен флаг входа в игру - это не логин');
         throw new Exception(LOGIN_UNDEFINED, ERR_ERROR);
       }
 
       // TODO Пустое имя аккаунта
-      if(!$this->input_login_unsafe) {
+      if (!$this->input_login_unsafe) {
         throw new Exception(LOGIN_UNDEFINED, ERR_ERROR);
       }
 
       $this->login_validate_input();
 
-      if(!$this->account->db_get_by_name($this->input_login_unsafe) && !$this->account->db_get_by_email($this->input_login_unsafe)) {
+      if (!$this->account->db_get_by_name($this->input_login_unsafe) && !$this->account->db_get_by_email($this->input_login_unsafe)) {
         throw new Exception(LOGIN_ERROR_USERNAME, ERR_ERROR);
       }
 
-      if(!$this->account->password_check($this->input_login_password_raw)) {
+      if (!$this->account->password_check($this->input_login_password_raw)) {
         throw new Exception(LOGIN_ERROR_PASSWORD, ERR_ERROR);
       }
 
       $this->cookie_set();
       $this->account_login_status = LOGIN_SUCCESS;
-    } catch(Exception $e) {
+    } catch (Exception $e) {
       $this->account_login_status == LOGIN_UNDEFINED ? $this->account_login_status = $e->getMessage() : false;
     }
 
@@ -506,11 +506,11 @@ 
   protected function cookie_set($account_to_impersonate = null) {
     $this_account = is_object($account_to_impersonate) ? $account_to_impersonate : $this->account;
 
-    if(!is_object($this_account) || !$this_account->is_exists) {
+    if (!is_object($this_account) || !$this_account->is_exists) {
       throw new Exception(LOGIN_ERROR_NO_ACCOUNT_FOR_COOKIE_SET, ERR_ERROR);
     }
 
-    if(is_object($account_to_impersonate) && $account_to_impersonate->is_exists) {
+    if (is_object($account_to_impersonate) && $account_to_impersonate->is_exists) {
       sn_setcookie($this->cookie_name_impersonate, $_COOKIE[$this->cookie_name], SN_TIME_NOW + PERIOD_YEAR, $this->sn_root_path, $this->domain);
     }
 
@@ -528,7 +528,7 @@ 
   // OK v4.1
   protected function cookie_clear() {
     // Автоматически вообще-то - если установлена кука имперсонатора - то чистим обычную, а куку имперсонатора - копируем в неё
-    if(!empty($_COOKIE[$this->cookie_name_impersonate])) {
+    if (!empty($_COOKIE[$this->cookie_name_impersonate])) {
       sn_setcookie($this->cookie_name, $_COOKIE[$this->cookie_name_impersonate], SN_TIME_NOW + PERIOD_YEAR, $this->sn_root_path, $this->domain);
       sn_setcookie($this->cookie_name_impersonate, '', SN_TIME_NOW - PERIOD_WEEK, $this->sn_root_path, $this->domain);
     } else {
@@ -547,10 +547,10 @@ 
   protected function login_validate_input() {
     // Проверяем, что бы в начале и конце не было пустых символов
     // TODO - при копировании Эксель -> Опера - в конце образуются пустые места. Это не должно быть проблемой! Вынести проверку пароля в регистрацию!
-    if($this->input_login_password_raw != trim($this->input_login_password_raw)) {
+    if ($this->input_login_password_raw != trim($this->input_login_password_raw)) {
       throw new Exception(LOGIN_ERROR_PASSWORD_TRIMMED, ERR_ERROR);
     }
-    if(!$this->input_login_password_raw) {
+    if (!$this->input_login_password_raw) {
       throw new Exception(LOGIN_ERROR_PASSWORD_EMPTY, ERR_ERROR);
     }
   }
@@ -566,37 +566,37 @@ 
     $this->login_validate_input();
 
     // Если нет имени пользователя - NO GO!
-    if(!$this->input_login_unsafe) {
+    if (!$this->input_login_unsafe) {
       throw new Exception(LOGIN_ERROR_USERNAME_EMPTY, ERR_ERROR);
     }
     // Если логин имеет запрещенные символы - NO GO!
-    if(strpbrk($this->input_login_unsafe, LOGIN_REGISTER_CHARACTERS_PROHIBITED)) {
+    if (strpbrk($this->input_login_unsafe, LOGIN_REGISTER_CHARACTERS_PROHIBITED)) {
       throw new Exception(LOGIN_ERROR_USERNAME_RESTRICTED_CHARACTERS, ERR_ERROR);
     }
     // Если логин меньше минимальной длины - NO GO!
-    if(strlen($this->input_login_unsafe) < LOGIN_LENGTH_MIN) {
+    if (strlen($this->input_login_unsafe) < LOGIN_LENGTH_MIN) {
       throw new Exception(REGISTER_ERROR_USERNAME_SHORT, ERR_ERROR);
     }
     // Если пароль меньше минимальной длины - NO GO!
-    if(strlen($this->input_login_password_raw) < PASSWORD_LENGTH_MIN) {
+    if (strlen($this->input_login_password_raw) < PASSWORD_LENGTH_MIN) {
       throw new Exception(REGISTER_ERROR_PASSWORD_INSECURE, ERR_ERROR);
     }
     // Если пароль имеет пробельные символы в начале или конце - NO GO!
-    if($this->input_login_password_raw != trim($this->input_login_password_raw)) {
+    if ($this->input_login_password_raw != trim($this->input_login_password_raw)) {
       throw new Exception(LOGIN_ERROR_PASSWORD_TRIMMED, ERR_ERROR);
     }
     // Если пароль не совпадает с подтверждением - NO GO! То, что у пароля нет пробельных символов в начале/конце - мы уже проверили выше
     //Если они есть у повтора - значит пароль и повтор не совпадут
-    if($this->input_login_password_raw <> $this->input_login_password_raw_repeat) {
+    if ($this->input_login_password_raw <> $this->input_login_password_raw_repeat) {
       throw new Exception(REGISTER_ERROR_PASSWORD_DIFFERENT, ERR_ERROR);
     }
     // Если нет емейла - NO GO!
     // TODO - регистрация без емейла
-    if(!$this->input_email_unsafe) {
+    if (!$this->input_email_unsafe) {
       throw new Exception(REGISTER_ERROR_EMAIL_EMPTY, ERR_ERROR);
     }
     // Если емейл не является емейлом - NO GO!
-    if(!is_email($this->input_email_unsafe)) {
+    if (!is_email($this->input_email_unsafe)) {
       throw new Exception(REGISTER_ERROR_EMAIL_WRONG, ERR_ERROR);
     }
   }
@@ -625,7 +625,7 @@ 
     return core_auth::make_random_password();
   }
   protected function flog($message, $die = false) {
-    if(!defined('DEBUG_AUTH') || !DEBUG_AUTH) {
+    if (!defined('DEBUG_AUTH') || !DEBUG_AUTH) {
       return;
     }
     list($called, $caller) = debug_backtrace(false);
@@ -639,7 +639,7 @@ 
     $_SERVER['SERVER_NAME'] == 'localhost' ? print("<div class='debug'>$message - $caller_name\r\n</div>") : false;
 
     classSupernova::log_file("$message - $caller_name");
-    if($die) {
+    if ($die) {
       $die && die("<div class='negative'>СТОП! Функция {$caller_name} при вызове в " . get_called_class() . " (располагается в " . get_class() . "). СООБЩИТЕ АДМИНИСТРАЦИИ!</div>");
     }
   }

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

Spacing +7 added lines, -7 removed lines

@@ -28,12 +28,12 @@ 
    * @param $unit_level
    */
   public function add_unit_by_snid($unit_id, $unit_level) {
-    if(!$unit_level) {
+    if (!$unit_level) {
       return;
     }
 
-    foreach(static::$_bonus_group as $param_name => $unit_list) {
-      if(!empty($unit_list[$unit_id])) {
+    foreach (static::$_bonus_group as $param_name => $unit_list) {
+      if (!empty($unit_list[$unit_id])) {
         // Простейший вариант - мультипликатор по базе
         // Общий мультипликатор добавляется в конец
         $this->grants[$param_name][$unit_id] = $unit_level;
@@ -82,16 +82,16 @@ 
 //    $this->grants[$param_name][$unit_id] = $unit_level * get_unit_param($unit_id, P_BONUS_VALUE) / 100;;
     $value_add = floatval($base_value);
     $cumulative = 1.0; // Для случая BONUS_PERCENT
-    if(!empty($this->grants[$param]) && is_array($this->grants[$param])) {
-      foreach($this->grants[$param] as $unit_id => $unit_level) {
+    if (!empty($this->grants[$param]) && is_array($this->grants[$param])) {
+      foreach ($this->grants[$param] as $unit_id => $unit_level) {
         $unit_bonus = 0;
-        if($unit_id < 0) {
+        if ($unit_id < 0) {
           // Meta-unit - leave as is
         } else {
           // TODO - Подумать, что будет при смешивании разных бонусов и как этого избежать
           $bonus_value = get_unit_param($unit_id, P_BONUS_VALUE);
           $bonus_type = get_unit_param($unit_id, P_BONUS_TYPE);
-          switch($bonus_type) {
+          switch ($bonus_type) {
             case BONUS_PERCENT:
               $unit_bonus = $unit_level * $bonus_value / 100;
               $cumulative += $unit_bonus;

classes/classConfig.php

Unused Use Statements -1 removed lines

@@ -1,5 +1,4 @@
 <?php
-use DBStatic\DBStaticUser;
 
 /**
  *

Spacing +16 added lines, -16 removed lines

@@ -190,9 +190,9 @@ 
     'advGoogleLeftMenuCode'        => '(Place here code for banner)',
 
     // Alliance bonus calculations
-    'ali_bonus_algorithm'          => 0,  // Bonus calculation algorithm
+    'ali_bonus_algorithm'          => 0, // Bonus calculation algorithm
     'ali_bonus_brackets'           => 10, // Brackets count for ALI_BONUS_BY_RANK
-    'ali_bonus_brackets_divisor'   => 10,// Bonus divisor for ALI_BONUS_BY_RANK
+    'ali_bonus_brackets_divisor'   => 10, // Bonus divisor for ALI_BONUS_BY_RANK
     'ali_bonus_divisor'            => 10000000, // Rank divisor for ALI_BONUS_BY_POINTS
     'ali_bonus_members'            => 10, // Minumum alliace size to start using bonus
 
@@ -223,25 +223,25 @@ 
     'deuterium_basic_income'       => 0,
     'eco_scale_storage'            => 1,
     'eco_stockman_fleet'           => '', // Black Market - Starting amount of s/h ship merchant to sell
-    'eco_stockman_fleet_populate'  => 1,  // Populate empty Stockman fleet with ships or not
+    'eco_stockman_fleet_populate'  => 1, // Populate empty Stockman fleet with ships or not
     'empire_mercenary_base_period' => PERIOD_MONTH, // Base
     'empire_mercenary_temporary'   => 0, // Temporary empire-wide mercenaries
     'energy_basic_income'          => 0,
 
     // Bashing protection settings
-    'fleet_bashing_attacks'        => 3,      // Max amount of attack per wave - 3 by default
-    'fleet_bashing_interval'       => 1800,   // Maximum interval between attacks when they still count as one wave - 30m by default
-    'fleet_bashing_scope'          => 86400,  // Interval on which bashing waves counts - 24h by default
-    'fleet_bashing_war_delay'      => 43200,  // Delay before start bashing after declaring war to alliance - 12h by default
-    'fleet_bashing_waves'          => 3,      // Max amount of waves per day - 3 by default
+    'fleet_bashing_attacks'        => 3, // Max amount of attack per wave - 3 by default
+    'fleet_bashing_interval'       => 1800, // Maximum interval between attacks when they still count as one wave - 30m by default
+    'fleet_bashing_scope'          => 86400, // Interval on which bashing waves counts - 24h by default
+    'fleet_bashing_war_delay'      => 43200, // Delay before start bashing after declaring war to alliance - 12h by default
+    'fleet_bashing_waves'          => 3, // Max amount of waves per day - 3 by default
 
     'Fleet_Cdr'   => 30,
     'fleet_speed' => 1,
 
     'fleet_update_interval' => 4,
 
-    'game_adminEmail'       => 'root@localhost',    // Admin's email to show to users
-    'game_counter'          => 0,  // Does built-in page hit counter is on?
+    'game_adminEmail'       => 'root@localhost', // Admin's email to show to users
+    'game_counter'          => 0, // Does built-in page hit counter is on?
     // Defaults
     'game_default_language' => 'ru',
     'game_default_skin'     => 'skins/EpicBlue/',
@@ -255,13 +255,13 @@ 
     'game_maxSystem'      => 199,
     'game_maxPlanet'      => 15,
     // Game global settings
-    'game_mode'           => 0,           // 0 - SuperNova, 1 - oGame
+    'game_mode'           => 0, // 0 - SuperNova, 1 - oGame
     'game_name'           => 'SuperNova', // Server name (would be on banners and on top of left menu)
 
     'game_news_actual'   => 259200, // How long announcement would be marked as "New". In seconds. Default - 3 days
-    'game_news_overview' => 3,    // How much last news to show in Overview page
+    'game_news_overview' => 3, // How much last news to show in Overview page
     // Noob protection
-    'game_noob_factor'   => 5,    // Multiplier to divide "stronger" and "weaker" users
+    'game_noob_factor'   => 5, // Multiplier to divide "stronger" and "weaker" users
     'game_noob_points'   => 5000, // Below this point user threated as noob. 0 to disable
 
     'game_multiaccount_enabled' => 0, // 1 - allow interactions for players with same IP (multiaccounts)
@@ -311,8 +311,8 @@ 
     'payment_currency_exchange_wmu' => 30,
     'payment_currency_exchange_wmz' => 1,
 
-    'payment_lot_price' => 1,     // Lot price in default currency
-    'payment_lot_size'  => 2500,  // Lot size. Also service as minimum amount of DM that could be bought with one transaction
+    'payment_lot_price' => 1, // Lot price in default currency
+    'payment_lot_size'  => 2500, // Lot size. Also service as minimum amount of DM that could be bought with one transaction
 
     'planet_teleport_cost'    => 50000, //
     'planet_teleport_timeout' => 86400, //
@@ -330,7 +330,7 @@ 
     'resource_multiplier'     => 1,
 
     //Roleplay system
-    'rpg_bonus_divisor'       => 10,    // Amount of DM referral shoud get for partner have 1 DM bonus
+    'rpg_bonus_divisor'       => 10, // Amount of DM referral shoud get for partner have 1 DM bonus
     'rpg_bonus_minimum'       => 10000, // Minimum DM ammount for starting paying bonuses to affiliate
 
     // Black Market - General

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;

Spacing +40 added lines, -40 removed lines

@@ -35,13 +35,13 @@ 
 
     $this->container = array();
 
-    if(classSupernova::$cache->getMode() != CACHER_NO_CACHE && !classSupernova::$config->locale_cache_disable) {
+    if (classSupernova::$cache->getMode() != CACHER_NO_CACHE && !classSupernova::$config->locale_cache_disable) {
       $this->cache = classSupernova::$cache;
       classSupernova::log_file('locale.__constructor: Cache is present');
 //$this->cache->unset_by_prefix($this->cache_prefix); // TODO - remove? 'cause debug!
     }
 
-    if($enable_stat_usage && empty($this->stat_usage)) {
+    if ($enable_stat_usage && empty($this->stat_usage)) {
       $this->enable_stat_usage = $enable_stat_usage;
       $this->usage_stat_load();
       // TODO shutdown function
@@ -67,9 +67,9 @@ 
     unset($fallback[$this->active]);
 
     // Проходим по оставшимся локалям
-    foreach($fallback as $try_language) {
+    foreach ($fallback as $try_language) {
       // Если нет такой строки - пытаемся вытащить из кэша
-      if(!isset($this->container[$try_language][$offset]) && $this->cache) {
+      if (!isset($this->container[$try_language][$offset]) && $this->cache) {
         $this->container[$try_language][$offset] = $this->cache->__get($this->cache_prefix . $try_language . '_' . $offset);
 // Записываем результат работы кэша
 $locale_cache_statistic['queries']++;
@@ -78,7 +78,7 @@ 
       }
 
       // Если мы как-то где-то нашли строку...
-      if(isset($this->container[$try_language][$offset])) {
+      if (isset($this->container[$try_language][$offset])) {
         // ...значит она получена в результате фоллбэка и записываем её в кэш и контейнер
         $this[$offset] = $this->container[$try_language][$offset];
         $locale_cache_statistic['fallbacks']++;
@@ -94,16 +94,16 @@ 
       $this->container[$this->active][] = $value;
     } else {
       $this->container[$this->active][$offset] = $value;
-      if($this->cache) {
+      if ($this->cache) {
         $this->cache->__set($this->cache_prefix_lang . $offset, $value);
       }
     }
   }
   public function offsetExists($offset) {
     // Шорткат если у нас уже есть строка в памяти PHP
-    if(!isset($this->container[$this->active][$offset])) {
+    if (!isset($this->container[$this->active][$offset])) {
 //        pdump($this->cache_prefix_lang . $offset);
-      if(!$this->cache || !($this->container[$this->active][$offset] = $this->cache->__get($this->cache_prefix_lang . $offset))) {
+      if (!$this->cache || !($this->container[$this->active][$offset] = $this->cache->__get($this->cache_prefix_lang . $offset))) {
 //        pdump($this->cache_prefix_lang . $offset);
         // Если нету такой строки - делаем фоллбэк
         $this->locale_string_fallback($offset);
@@ -119,7 +119,7 @@ 
   }
   public function offsetGet($offset) {
     $value = $this->offsetExists($offset) ? $this->container[$this->active][$offset] : null;
-    if($this->enable_stat_usage) {
+    if ($this->enable_stat_usage) {
       $this->usage_stat_log($offset, $value);
     }
     return $value;
@@ -134,16 +134,16 @@ 
 
 
   public function usage_stat_load() {
-    $this->stat_usage = classSupernova::$cache->lng_stat_usage  = array();
-    if(empty($this->stat_usage)) {
+    $this->stat_usage = classSupernova::$cache->lng_stat_usage = array();
+    if (empty($this->stat_usage)) {
       $query = classSupernova::$db->doSelect("SELECT * FROM `{{lng_usage_stat}}`");
-      while($row = db_fetch($query)) {
+      while ($row = db_fetch($query)) {
         $this->stat_usage[$row['lang_code'] . ':' . $row['string_id'] . ':' . $row['file'] . ':' . $row['line']] = $row['is_empty'];
       }
     }
   }
   public function usage_stat_save() {
-    if(!empty($this->stat_usage_new)) {
+    if (!empty($this->stat_usage_new)) {
       classSupernova::$cache->lng_stat_usage = $this->stat_usage;
       classSupernova::$db->doSelect("SELECT 1 FROM `{{lng_usage_stat}}` LIMIT 1");
 //      foreach($this->stat_usage_new as &$value) {
@@ -172,7 +172,7 @@ 
     $file = str_replace('\\', '/', substr($trace[1]['file'], strlen(SN_ROOT_PHYSICAL) - 1));
 
     $string_id = $this->active . ':' . $offset . ':' . $file . ':' . $trace[1]['line'];
-    if(!isset($this->stat_usage[$string_id]) || $this->stat_usage[$string_id] != empty($value)) {
+    if (!isset($this->stat_usage[$string_id]) || $this->stat_usage[$string_id] != empty($value)) {
       $this->stat_usage[$string_id] = empty($value);
       $this->stat_usage_new[] = array(
         'lang_code' => $this->active,
@@ -212,11 +212,11 @@ 
     $cache_file_key = $this->cache_prefix_lang . '__' . $filename;
 
     // Подключен ли внешний кэш?
-    if($this->cache) {
+    if ($this->cache) {
       // Загружен ли уже данный файл?
       $cache_file_status = $this->cache->__get($cache_file_key);
       classSupernova::log_file("locale.include: Cache - '{$filename}' has key '{$cache_file_key}' and is " . ($cache_file_status ? 'already loaded - EXIT' : 'EMPTY'), $cache_file_status ? -1 : 0);
-      if($cache_file_status) {
+      if ($cache_file_status) {
         // Если да - повторять загрузку нет смысла
         return null;
       }
@@ -230,36 +230,36 @@ 
     $this->make_fallback($language);
 
     $file_path = '';
-    foreach($this->fallback as $lang_try) {
-      if(!$lang_try /* || isset($language_tried[$lang_try]) */) {
+    foreach ($this->fallback as $lang_try) {
+      if (!$lang_try /* || isset($language_tried[$lang_try]) */) {
         continue;
       }
 
-      if($file_path = $this->lng_try_filepath($path, "language/{$lang_try}/{$filename_ext}")) {
+      if ($file_path = $this->lng_try_filepath($path, "language/{$lang_try}/{$filename_ext}")) {
         break;
       }
 
-      if($file_path = $this->lng_try_filepath($path, "language/{$filename}_{$lang_try}{$ext}")) {
+      if ($file_path = $this->lng_try_filepath($path, "language/{$filename}_{$lang_try}{$ext}")) {
         break;
       }
 
       $file_path = '';
     }
 
-    if($file_path) {
+    if ($file_path) {
       $a_lang_array = array();
       include($file_path);
 
-      if(!empty($a_lang_array)) {
+      if (!empty($a_lang_array)) {
         $this->merge($a_lang_array);
 
         // Загрузка данных из файла в кэш
-        if($this->cache) {
+        if ($this->cache) {
           classSupernova::log_file("Locale: loading '{$filename}' into cache");
-          foreach($a_lang_array as $key => $value) {
+          foreach ($a_lang_array as $key => $value) {
             $value_cache_key = $this->cache_prefix_lang . $key;
-            if($this->cache->__isset($value_cache_key)) {
-              if(is_array($value)) {
+            if ($this->cache->__isset($value_cache_key)) {
+              if (is_array($value)) {
                 $alt_value = $this->cache->__get($value_cache_key);
                 $value = array_replace_recursive($alt_value, $value);
                 // pdump($alt_value, $alt_value);
@@ -270,7 +270,7 @@ 
         }
       }
 
-      if($this->cache) {
+      if ($this->cache) {
         $this->cache->__set($cache_file_key, true);
       }
 
@@ -283,14 +283,14 @@ 
   }
 
   public function lng_load_i18n($i18n) {
-    if(!isset($i18n)) {
+    if (!isset($i18n)) {
       return;
     }
 
-    foreach($i18n as $i18n_data) {
-      if(is_string($i18n_data)) {
+    foreach ($i18n as $i18n_data) {
+      if (is_string($i18n_data)) {
         $this->lng_include($i18n_data);
-      } elseif(is_array($i18n_data)) {
+      } elseif (is_array($i18n_data)) {
         $this->lng_include($i18n_data['file'], $i18n_data['path']);
       }
     }
@@ -308,7 +308,7 @@ 
 
     classSupernova::log_file("locale.switch: Trying to switch language to '{$language_new}'");
 
-    if($language_new == $this->active) {
+    if ($language_new == $this->active) {
       classSupernova::log_file("locale.switch: New language '{$language_new}' is equal to current language '{$this->active}' - EXIT", -1);
       return false;
     }
@@ -319,10 +319,10 @@ 
     $this['LANG_INFO'] = $this->lng_get_info($this->active);
     $this->make_fallback($this->active);
 
-    if($this->cache) {
+    if ($this->cache) {
       $cache_lang_init_status = $this->cache->__get($this->cache_prefix_lang . '__INIT');
       classSupernova::log_file("locale.switch: Cache for '{$this->active}' prefixed '{$this->cache_prefix_lang}' is " . ($cache_lang_init_status ? 'already loaded. Doing nothing - EXIT' : 'EMPTY'), $cache_lang_init_status ? -1 : 0);
-      if($cache_lang_init_status) {
+      if ($cache_lang_init_status) {
         return false;
       }
 
@@ -338,7 +338,7 @@ 
     // Loading global language files
     $this->lng_load_i18n(classSupernova::$sn_mvc['i18n']['']);
 
-    if($this->cache) {
+    if ($this->cache) {
       classSupernova::log_file("locale.switch: Cache - setting flag " . $this->cache_prefix_lang . '__INIT');
       $this->cache->__set($this->cache_prefix_lang . '__INIT', true);
     }
@@ -352,7 +352,7 @@ 
   public function lng_get_info($entry) {
     $file_name = SN_ROOT_PHYSICAL . 'language/' . $entry . '/language.mo.php';
     $lang_info = array();
-    if(file_exists($file_name)) {
+    if (file_exists($file_name)) {
       include($file_name);
     }
 
@@ -360,15 +360,15 @@ 
   }
 
   public function lng_get_list() {
-    if(empty($this->lang_list)) {
+    if (empty($this->lang_list)) {
       $this->lang_list = array();
 
       $path = SN_ROOT_PHYSICAL . 'language/';
       $dir = dir($path);
-      while(false !== ($entry = $dir->read())) {
-        if(is_dir($path . $entry) && $entry[0] != '.') {
+      while (false !== ($entry = $dir->read())) {
+        if (is_dir($path . $entry) && $entry[0] != '.') {
           $lang_info = $this->lng_get_info($entry);
-          if($lang_info['LANG_NAME_ISO2'] == $entry) {
+          if ($lang_info['LANG_NAME_ISO2'] == $entry) {
             $this->lang_list[$lang_info['LANG_NAME_ISO2']] = $lang_info;
           }
         }

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 их слишком много
    *

classes/DBAL/DbTransaction.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
    *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
    *   <p>false - всё равно - для совместимости с $for_update</p>
    *
-   * @return bool Текущий статус транзакции
+   * @return null|boolean Текущий статус транзакции
    */
   public function check($status = null) {
     $error_msg = false;

classes/DbSqlLiteral.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
   }
 
   /**
-   * @param mixed $value
+   * @param string $value
    *
    * @return $this
    */

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
    * @return $this
    */
   public function literal($value) {
-    $this->literal = (string)$value;
+    $this->literal = (string) $value;
 
     return $this;
   }

classes/DBStatic/DBStaticChat.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
 
   /**
    * @param $user_id
-   * @param $nickUnsafe
+   * @param string $nickUnsafe
    * @param $ally_id
    * @param $message_unsafe
    * @param $chat_message_sender_name_unsafe
@@ -54,7 +54,7 @@ 
    * @param $alliance
    * @param $where_add
    * @param $start_row
-   * @param $page_limit
+   * @param integer $page_limit
    *
    * @return array|bool|mysqli_result|null
    */

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
    * @return array|bool|mysqli_result|null
    */
   public static function db_chat_player_get($player_id, $fields) {
-    return classSupernova::$db->doSelectFetchArray("SELECT {$fields} FROM {{chat_player}} WHERE `chat_player_player_id` = {$player_id} LIMIT 1");
+    return classSupernova::$db->doSelectFetchArray("select {$fields} FROM {{chat_player}} WHERE `chat_player_player_id` = {$player_id} LIMIT 1");
   }
 
 

classes/DBStatic/DBStaticMessages.php

Doc Comments +6 added lines

@@ -467,6 +467,12 @@
   {$StartRec}, 25;");
   }
 
+  /**
+   * @param integer $message_type
+   * @param string $from_unsafe
+   * @param string $subject_unsafe
+   * @param string $text_unsafe
+   */
   public static function db_message_insert_all($message_type, $from_unsafe, $subject_unsafe, $text_unsafe) {
     $message_type_safe = intval($message_type);
     $from_safe = db_escape($from_unsafe);