supernova-ws / SuperNova

includes/classes/auth_local.php

Doc Comments +7 added lines

@@ -209,6 +209,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) {
@@ -218,6 +222,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

@@ -136,12 +136,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 = new db_mysql();
 
       $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'];
@@ -155,7 +155,7 @@ 
     }
 
     // Fallback to local DB
-    if(!$this->manifest['active']) {
+    if (!$this->manifest['active']) {
       $this->db = classSupernova::$db;
 
       $this->provider_id = ACCOUNT_PROVIDER_LOCAL;
@@ -211,7 +211,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();
     }
 
@@ -241,12 +241,12 @@ 
   protected function password_reset_send_code() {
     global $lang, $config;
 
-    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;
     }
 
@@ -256,7 +256,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;
       }
@@ -266,14 +266,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);
       }
 
@@ -290,7 +290,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();
     }
@@ -306,46 +306,46 @@ 
   protected function password_reset_confirm() {
     global $lang, $config;
 
-    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);
       }
@@ -355,7 +355,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($lang['log_lost_email_title'], $config->game_name);
         $message = sprintf($lang['log_lost_email_pass'], $config->game_name, $this->account->account_name, $new_password_unsafe);
@@ -363,7 +363,7 @@ 
 
         // $users_translated = classSupernova::$auth->db_translate_get_users_from_account_list($this->provider_id, $this->account->account_id); // OK 4.5
         $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 только
@@ -375,7 +375,7 @@ 
           $message = sys_bbcodeParse($message) . '<br><br>';
           // msg_send_simple_message($found_provider->data[F_USER_ID], 0, SN_TIME_NOW, MSG_TYPE_ADMIN, $lang['sys_administration'], $lang['sys_login_register_message_title'], $message);
 
-          foreach($users_translated as $user_id => $providers_list) {
+          foreach ($users_translated as $user_id => $providers_list) {
             msg_send_simple_message($user_id, 0, SN_TIME_NOW, MSG_TYPE_ADMIN, $lang['sys_administration'], $lang['sys_login_register_message_title'], $message);
           }
         } else {
@@ -430,7 +430,7 @@ 
     $this->flog('Регистрация: начинаем. Провайдер ' . $this->provider_id);
 
     try {
-      if(!$this->is_register) {
+      if (!$this->is_register) {
         $this->flog('Регистрация: не выставлен флаг регистрации - пропускаем');
         throw new Exception(LOGIN_UNDEFINED, ERR_ERROR);
       }
@@ -442,8 +442,8 @@ 
       // $this->account_check_duplicate_name_or_email($this->input_login_unsafe, $this->input_email_unsafe);
 
       $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);
@@ -482,7 +482,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;
     }
@@ -498,15 +498,15 @@ 
    */
   // OK v4.5
   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 (!empty($_COOKIE[$this->cookie_name])) {
 // Кто хотел - уже сконвертировал старые куки в новые
 // Update оказывается - не все...
-      if(count(explode("/%/", $_COOKIE[$this->cookie_name])) < 4) {
+      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]);
@@ -514,7 +514,7 @@ 
 
       // $account = $this->db_account_get_by_id($account_id_unsafe);
 
-      if(
+      if (
         $this->account->db_get_by_id($account_id_unsafe)
         && ($this->password_encode_for_cookie($this->account->account_password) == $cookie_password_hash_salted)
       ) {
@@ -524,7 +524,7 @@ 
       }
     }
 
-    if($this->account_login_status != LOGIN_SUCCESS) {
+    if ($this->account_login_status != LOGIN_SUCCESS) {
       // Невалидная кука - чистим
       $this->cookie_clear();
     }
@@ -542,13 +542,13 @@ 
   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);
       }
 
@@ -558,11 +558,11 @@ 
 //      if(empty($account)) {
 //        throw new Exception(LOGIN_ERROR_USERNAME, ERR_ERROR);
 //      }
-      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);
       }
 
@@ -570,7 +570,7 @@ 
 
       $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;
     }
 
@@ -592,11 +592,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);
     }
 
@@ -614,7 +614,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 {
@@ -633,10 +633,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);
     }
   }
@@ -652,37 +652,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);
     }
   }
@@ -715,7 +715,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);
@@ -731,7 +731,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) {
       // pdump($caller);
       // pdump(debug_backtrace(false));
       $die && die("<div class='negative'>СТОП! Функция {$caller_name} при вызове в " . get_called_class() . " (располагается в " . get_class() . "). СООБЩИТЕ АДМИНИСТРАЦИИ!</div>");

includes/classes/Confirmation.php

Doc Comments +19 added lines

@@ -18,6 +18,11 @@ 
 
   // TODO - НЕ ОБЯЗАТЕЛЬНО ОТПРАВЛЯТЬ ЧЕРЕЗ ЕМЕЙЛ! ЕСЛИ ЭТО ФЕЙСБУЧЕК ИЛИ ВКШЕЧКА - МОЖНО ЧЕРЕЗ ЛС ПИСАТЬ!!
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $email_unsafe
+   */
   public function db_confirmation_get_latest_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
@@ -26,12 +31,21 @@ 
           `type` = {$confirmation_type_safe} AND `email` = '{$email_safe}' ORDER BY create_time DESC LIMIT 1;", true);
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   */
   public function db_confirmation_delete_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
     return $this->db->doquery("DELETE FROM {{confirmations}} WHERE `type` = {$confirmation_type_safe} AND `email` = '{$email_safe}'");
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $email_unsafe
+   */
   public function db_confirmation_get_unique_code_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
@@ -50,6 +64,11 @@ 
     return $confirm_code_unsafe;
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $confirmation_code_unsafe
+   */
   public function db_confirmation_get_by_type_and_code($confirmation_type_safe, $confirmation_code_unsafe) {
     $confirmation_code_safe = $this->db->db_escape($confirmation_code_unsafe);
 

Spacing +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
       // $query = static::$db->doquery("SELECT `id` FROM {{confirmations}} WHERE `code` = '{$confirm_code_safe}' AND `type` = {$confirmation_type_safe} FOR UPDATE", true);
       // Тип не нужен для проверки - код подтверждения должен быть уникален от слова "совсем"
       $query = $this->db->doquery("SELECT `id` FROM {{confirmations}} WHERE `code` = '{$confirm_code_safe}' FOR UPDATE", true);
-    } while($query);
+    } while ($query);
 
     $this->db->doquery(
       "REPLACE INTO {{confirmations}}

includes/classes/db_mysql_v4.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
     return true;
   }
 
+  /**
+   * @param string $query_string
+   */
   function mysql_query($query_string) {
     return mysql_query($query_string, $this->link);
   }

Spacing +4 added lines, -4 removed lines

@@ -30,17 +30,17 @@ 
 
     static $need_keys = array('server', 'user', 'pass', 'name', 'prefix');
 
-    if($this->connected) {
+    if ($this->connected) {
       return true;
     }
 
-    if(empty($settings) || !is_array($settings) || array_intersect($need_keys, array_keys($settings)) != $need_keys) {
+    if (empty($settings) || !is_array($settings) || array_intersect($need_keys, array_keys($settings)) != $need_keys) {
       $debug->error_fatal('There is missconfiguration in your config.php. Check it again', $this->mysql_error());
     }
 
     // TODO !!!!!! DEBUG -> error!!!!
     @$this->link = mysql_connect($settings['server'], $settings['user'], $settings['pass']);
-    if(!is_resource($this->link)) {
+    if (!is_resource($this->link)) {
       $debug->error_fatal('DB Error - cannot connect to server', $this->mysql_error());
     }
 
@@ -68,7 +68,7 @@ 
     return mysql_real_escape_string($unescaped_string, $this->link);
   }
   function mysql_close_link() {
-    if($this->connected) {
+    if ($this->connected) {
       $this->connected = false;
       mysql_close($this->link);
       unset($this->link);

includes/classes/functions_template.php

Doc Comments +8 added lines

@@ -47,6 +47,7 @@ 
 
   /**
   * constuctor
+  * @param template $template
   */
   function template_compile(&$template)
   {
@@ -463,6 +464,7 @@ 
   * Compile IF tags - much of this is from Smarty with
   * some adaptions for our block level methods
   * @access private
+  * @param boolean $elseif
   */
   function compile_tag_if($tag_args, $elseif)
   {
@@ -620,6 +622,7 @@ 
   /**
   * Compile DEFINE tags
   * @access private
+  * @param boolean $op
   */
   function compile_tag_define($tag_args, $op)
   {
@@ -698,6 +701,7 @@ 
   * parse expression
   * This is from Smarty
   * @access private
+  * @param string $is_arg
   */
   function _parse_is_expr($is_arg, $tokens)
   {
@@ -794,6 +798,8 @@ 
   * If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above.
   * NOTE: does not expect a trailing "." on the blockname.
   * @access private
+  * @param string $blockname
+  * @param boolean $include_last_iterator
   */
   function generate_block_data_ref($blockname, $include_last_iterator, $defop = false)
   {
@@ -832,6 +838,7 @@ 
   /**
   * Write compiled file to cache directory
   * @access private
+  * @param string $data
   */
   function compile_write($handle, $data)
   {
@@ -857,6 +864,7 @@ 
   /**
   * Minifies template w/i PHP code by removing extra spaces
   * @access private
+  * @return string
   */
   function minify($html)
   {

Spacing +13 added lines, -13 removed lines

@@ -138,9 +138,9 @@ 
 
     preg_match_all('#<!-- INCLUDE (\{\$?[A-Z0-9\-_]+\}|[a-zA-Z0-9\_\-\+\./]+) -->#', $code, $matches);
     $include_blocks = $matches[1];
-    if($include_blocks)
+    if ($include_blocks)
     {
-      foreach($include_blocks as &$included_file)
+      foreach ($include_blocks as &$included_file)
       {
         $included_file .= '.tpl.html';
       }
@@ -446,8 +446,8 @@ 
 
     $tag_template_php .= 'for ($_' . $tag_args . '_i = ' . $loop_start . '; $_' . $tag_args . '_i < ' . $loop_end . '; ++$_' . $tag_args . '_i){';
 //    $tag_template_php .= '$this->_block_counter["'. $tag_args . '"] = $_' . $tag_args . '_i;';
-    $tag_template_php .= '$_'. $tag_args . '_val = &' . $varref . '[$_'. $tag_args. '_i];';
-    $tag_template_php .= '$this->_block_value["'. $tag_args . '"] = &' . $varref . '[$_'. $tag_args. '_i];';
+    $tag_template_php .= '$_' . $tag_args . '_val = &' . $varref . '[$_' . $tag_args . '_i];';
+    $tag_template_php .= '$this->_block_value["' . $tag_args . '"] = &' . $varref . '[$_' . $tag_args . '_i];';
 
     return $tag_template_php;
   }
@@ -551,10 +551,10 @@ 
         break;
 
         case 'is':
-          $is_arg_start = ($tokens[$i-1] == ')') ? array_pop($is_arg_stack) : $i-1;
+          $is_arg_start = ($tokens[$i - 1] == ')') ? array_pop($is_arg_stack) : $i - 1;
           $is_arg = implode(' ', array_slice($tokens, $is_arg_start, $i - $is_arg_start));
 
-          $new_tokens = $this->_parse_is_expr($is_arg, array_slice($tokens, $i+1));
+          $new_tokens = $this->_parse_is_expr($is_arg, array_slice($tokens, $i + 1));
 
           array_splice($tokens, $is_arg_start, sizeof($tokens), $new_tokens);
 
@@ -814,11 +814,11 @@ 
     }
     else if ($include_last_iterator)
     {
-      return '$_'. $blocks[$blockcount] . '_val';
+      return '$_' . $blocks[$blockcount] . '_val';
     }
     else
     {
-      return '$_'. $blocks[$blockcount - 1] . '_val[\''. $blocks[$blockcount]. '\']';
+      return '$_' . $blocks[$blockcount - 1] . '_val[\'' . $blocks[$blockcount] . '\']';
     }
   }
 
@@ -835,7 +835,7 @@ 
     if ($fp = @fopen($filename, 'wb'))
     {
       @flock($fp, LOCK_EX);
-      @fwrite ($fp, $data);
+      @fwrite($fp, $data);
       @flock($fp, LOCK_UN);
       @fclose($fp);
 
@@ -852,7 +852,7 @@ 
   */
   private function minify($html)
   {
-    if(!classSupernova::$config->tpl_minifier)
+    if (!classSupernova::$config->tpl_minifier)
     {
       return $html;
     }
@@ -862,14 +862,14 @@ 
     $html = preg_replace('/(<script[^>]*?>.*?<\/script>)/si', '#pre#', $html);
     $html = preg_replace('/>[\s]*</', '><', $html); // Strip spacechars between tags
     $html = preg_replace('/[\s]+/', ' ', $html); // Replace several spacechars with one space
-    if(!empty($pre[0]))
+    if (!empty($pre[0]))
     {
-      foreach($pre[0] as $tag)
+      foreach ($pre[0] as $tag)
       {
         $tag = preg_replace('/^\ *\/\/[^\<]*?$/m', ' ', $tag); // Strips comments - except those that contains HTML comment inside
         $tag = preg_replace('/[\ \t]{2,}/', ' ', $tag); // Replace several spaces by one
         $tag = preg_replace('/\s{2,}/', "\r\n", $tag); // Replace several linefeeds by one
-        $html = preg_replace('/#pre#/', $tag, $html,1);
+        $html = preg_replace('/#pre#/', $tag, $html, 1);
       }
     }
 

includes/classes/locale.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 +43 added lines, -43 removed lines

@@ -28,13 +28,13 @@ 
 
     $this->container = array();
 
-    if(classSupernova::$cache->_MODE != CACHER_NO_CACHE && !classSupernova::$config->locale_cache_disable) {
+    if (classSupernova::$cache->_MODE != 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
@@ -60,9 +60,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']++;
@@ -71,7 +71,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']++;
@@ -87,16 +87,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);
@@ -112,7 +112,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;
@@ -129,24 +129,24 @@ 
   public function usage_stat_load() {
     global $sn_cache;
 
-    $this->stat_usage = $sn_cache->lng_stat_usage  = array(); // TODO for debug
-    if(empty($this->stat_usage)) {
+    $this->stat_usage = $sn_cache->lng_stat_usage = array(); // TODO for debug
+    if (empty($this->stat_usage)) {
       $query = doquery("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)) {
       global $sn_cache;
       $sn_cache->lng_stat_usage = $this->stat_usage;
       doquery("SELECT 1 FROM {{lng_usage_stat}} LIMIT 1");
-      foreach($this->stat_usage_new as &$value) {
-        foreach($value as &$value2) {
+      foreach ($this->stat_usage_new as &$value) {
+        foreach ($value as &$value2) {
           $value2 = '"' . db_escape($value2) . '"';
         }
-        $value = '(' . implode(',', $value) .')';
+        $value = '(' . implode(',', $value) . ')';
       }
       doquery("REPLACE INTO {{lng_usage_stat}} (lang_code,string_id,`file`,line,is_empty,locale) VALUES " . implode(',', $this->stat_usage_new));
     }
@@ -159,7 +159,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) {
+    if (!isset($this->stat_usage[$string_id]) || $this->stat_usage[$string_id] != $empty) {
       $this->stat_usage[$string_id] = empty($value);
       $this->stat_usage_new[] = array(
         'lang_code' => $this->active,
@@ -199,11 +199,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;
       }
@@ -217,35 +217,35 @@ 
     $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) {
       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);
@@ -256,7 +256,7 @@ 
         }
       }
 
-      if($this->cache) {
+      if ($this->cache) {
         $this->cache->__set($cache_file_key, true);
       }
 
@@ -269,14 +269,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']);
       }
     }
@@ -294,7 +294,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;
     }
@@ -305,10 +305,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;
       }
 
@@ -324,7 +324,7 @@ 
     // Loading global language files
     $this->lng_load_i18n($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);
     }
@@ -338,7 +338,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);
     }
 
@@ -346,15 +346,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;
           }
         }

includes/classes/sn_module_payment.php

Doc Comments +7 added lines, -1 removed lines

@@ -702,7 +702,7 @@ 
    * Рассчёт бонуса ММ
    *
    * @param            $dark_matter
-   * @param bool|true  $direct
+   * @param boolean  $direct
    * @param bool|false $return_bonus
    *
    * @return float|int
@@ -738,6 +738,12 @@ 
 
   // Дополнительная ре-трансляция адреса, если в каком-то случае платежная система ожидает нелогичный ответ
   // Пример: иксолла при неправильно заданном пользователе в ордере ожидает НЕПРАВИЛЬНЫЙ_ОРДЕР, а не НЕПРАВИЛЬНЫЙ_ПОЛЬЗОВАТЕЛЬ
+
+  /**
+   * @param integer $error_code
+   *
+   * @return integer|null
+   */
   function retranslate_error($error_code, $options = array()) {
     return isset($options['retranslate_error'][$error_code]) ? $options['retranslate_error'][$error_code] : $error_code;
   }

Spacing +55 added lines, -55 removed lines

@@ -450,7 +450,7 @@ 
   public function compile_request($request) {
     global $config, $user;
 
-    if(!(classSupernova::$auth->account instanceof Account)) {
+    if (!(classSupernova::$auth->account instanceof Account)) {
       // TODO - throw new Exception($lang['pay_msg_mm_request_amount_invalid'], SN_PAYMENT_REQUEST_ERROR_UNIT_AMOUNT);
     }
     $this->account = classSupernova::$auth->account;
@@ -471,15 +471,15 @@ 
     $this->payment_currency = $config->payment_currency_default;
     $this->payment_amount = self::currency_convert($this->payment_dark_matter_paid, 'MM_', $this->payment_currency);
 
-    if(empty($this->payment_external_currency) && !empty($this->config['currency'])) {
+    if (empty($this->payment_external_currency) && !empty($this->config['currency'])) {
       $this->payment_external_currency = $this->config['currency'];
     }
-    if(empty($this->payment_external_currency)) {
+    if (empty($this->payment_external_currency)) {
       throw new Exception(classLocale::$lang['pay_error_internal_no_external_currency_set'], SN_PAYMENT_ERROR_INTERNAL_NO_EXTERNAL_CURRENCY_SET);
     }
 
     $this->payment_external_amount = self::currency_convert($this->payment_dark_matter_paid, 'MM_', $this->payment_external_currency);
-    if($this->payment_external_amount < 0.01) {
+    if ($this->payment_external_amount < 0.01) {
       throw new Exception(classLocale::$lang['pay_msg_mm_request_amount_invalid'], SN_PAYMENT_REQUEST_ERROR_UNIT_AMOUNT);
     }
 
@@ -488,7 +488,7 @@ 
     $this->generate_description();
 
     $this->db_insert();
-    if(!$this->is_exists) {
+    if (!$this->is_exists) {
       throw new Exception(classLocale::$lang['pay_msg_request_error_db_payment_create'], SN_PAYMENT_REQUEST_DB_ERROR_PAYMENT_CREATE);
     }
   }
@@ -503,24 +503,24 @@ 
   protected function payment_request_process($options = array()) {
     global $lang, $config;
 
-    if(!$this->manifest['active']) {
+    if (!$this->manifest['active']) {
       throw new Exception(classLocale::$lang['pay_msg_module_disabled'], SN_MODULE_DISABLED);
     }
 
     // Если есть payment_id - загружаем под него данные
-    if(!empty($this->payment_params['payment_id'])) {
+    if (!empty($this->payment_params['payment_id'])) {
       $this->request_payment_id = sys_get_param_id($this->payment_params['payment_id']);
-      if(!$this->request_payment_id) {
+      if (!$this->request_payment_id) {
         throw new Exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_INTERNAL_ID_WRONG);
       }
 
-      if(!$this->db_get_by_id($this->request_payment_id)) {
+      if (!$this->db_get_by_id($this->request_payment_id)) {
         throw new Exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_INTERNAL_ID_WRONG);
       }
 
       // Проверяем - был ли этот платеж обработан?
       // TODO - Статусы бывают разные. Нужен спецфлаг payment_processed
-      if($this->payment_status != PAYMENT_STATUS_NONE) {
+      if ($this->payment_status != PAYMENT_STATUS_NONE) {
         sn_db_transaction_rollback();
         sys_redirect(SN_ROOT_VIRTUAL . 'metamatter.php?payment_id=' . $this->payment_id);
         die();
@@ -530,89 +530,89 @@ 
     // Пытаемся получить из запроса ИД аккаунта
     $request_account_id = !empty($this->payment_params['account_id']) ? sys_get_param_id($this->payment_params['account_id']) : 0;
     // Если в запросе нет ИД аккаунта - пытаемся использовать payment_account_id
-    if(empty($request_account_id) && !empty($this->payment_account_id)) {
+    if (empty($request_account_id) && !empty($this->payment_account_id)) {
       $request_account_id = $this->payment_account_id;
     }
     // Если теперь у нас нету ИД аккаунта ни в запросе, ни в записи таблицы - можно паниковать
-    if(empty($request_account_id)) {
+    if (empty($request_account_id)) {
       // TODO - аккаунт
       throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'], $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
     // Если нет записи в таблице - тогда берем payment_account_id из запроса
-    if(empty($this->payment_account_id)) {
+    if (empty($this->payment_account_id)) {
       $this->payment_account_id = $request_account_id;
     }
     // Если у нас отличаются ИД аккаунта в запросе и ИД аккаунта в записи - тоже можно паниковать
-    if($this->payment_account_id != $request_account_id) {
+    if ($this->payment_account_id != $request_account_id) {
       // TODO - Поменять сообщение об ошибке
       throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'], $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
     // Проверяем существование аккаунта с данным ИД
-    if(!$this->account->db_get_by_id($this->payment_account_id)) {
+    if (!$this->account->db_get_by_id($this->payment_account_id)) {
       throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'] . ' ID ' . $this->payment_account_id, $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
 
     // TODO Проверка на сервер_ид - как бы и не нужна, наверное?
-    if(!empty($this->payment_params['server_id'])) {
+    if (!empty($this->payment_params['server_id'])) {
       $this->request_server_id = sys_get_param_str($this->payment_params['server_id']);
-      if(SN_ROOT_VIRTUAL != $this->request_server_id) {
+      if (SN_ROOT_VIRTUAL != $this->request_server_id) {
         throw new Exception(classLocale::$lang['pay_msg_request_server_wrong'] . " {$this->request_server_id} вместо " . SN_ROOT_VIRTUAL, SN_PAYMENT_REQUEST_SERVER_WRONG);
       }
     }
 
     // Сверка количества оплаченной ММ с учётом бонусов
-    if(!empty($this->payment_params['payment_dark_matter_gained'])) {
+    if (!empty($this->payment_params['payment_dark_matter_gained'])) {
       $request_mm_amount = sys_get_param_id($this->payment_params['payment_dark_matter_gained']);
-      if($request_mm_amount != $this->payment_dark_matter_gained && $this->is_loaded) {
+      if ($request_mm_amount != $this->payment_dark_matter_gained && $this->is_loaded) {
         throw new Exception(classLocale::$lang['pay_msg_mm_request_amount_invalid'] . " пришло {$request_mm_amount} ММ вместо {$this->payment_dark_matter_gained} ММ", SN_PAYMENT_REQUEST_MM_AMOUNT_INVALID);
       }
       empty($this->payment_dark_matter_gained) ? $this->payment_dark_matter_gained = $request_mm_amount : false;
     }
-    if(empty($this->payment_dark_matter_paid)) {
+    if (empty($this->payment_dark_matter_paid)) {
       // TODO - обратный расчёт из gained
     }
 
     // Проверка наличия внешнего ИД платежа
-    if(!empty($this->payment_params['payment_external_id'])) {
+    if (!empty($this->payment_params['payment_external_id'])) {
       $request_payment_external_id = sys_get_param_id($this->payment_params['payment_external_id']);
-      if(empty($request_payment_external_id)) {
+      if (empty($request_payment_external_id)) {
         throw new exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_EXTERNAL_ID_WRONG);
-      } elseif(!empty($this->payment_external_id) && $this->payment_external_id != $request_payment_external_id) {
+      } elseif (!empty($this->payment_external_id) && $this->payment_external_id != $request_payment_external_id) {
         // TODO - Может быть поменять сообщение
         throw new exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_EXTERNAL_ID_WRONG);
       }
       $this->payment_external_id = $request_payment_external_id;
     }
     // Сверка суммы, запрошенной СН к оплате
-    if(!empty($this->payment_params['payment_external_money'])) {
+    if (!empty($this->payment_params['payment_external_money'])) {
       $request_money_out = sys_get_param_float($this->payment_params['payment_external_money']);
-      if($request_money_out != $this->payment_external_amount && $this->is_loaded) {
+      if ($request_money_out != $this->payment_external_amount && $this->is_loaded) {
         throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid'] . " пришло {$request_money_out} денег вместо {$this->payment_external_amount} денег", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
       }
       empty($this->payment_external_amount) ? $this->payment_external_amount = $request_money_out : false;
     }
     // Заполняем поле валюты платёжной системы
-    if(!empty($this->payment_params['payment_external_currency'])) {
+    if (!empty($this->payment_params['payment_external_currency'])) {
       $this->payment_external_currency = sys_get_param_str($this->payment_params['payment_external_currency']);
-      if(empty($this->payment_external_currency)) {
+      if (empty($this->payment_external_currency)) {
         // TODO - поменять сообщение
         throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid'] . " {$this->payment_external_currency}", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
       }
     }
-    if(empty($this->payment_external_currency)) {
+    if (empty($this->payment_external_currency)) {
       $this->payment_external_currency = $this->config['currency'];
     }
 
     // Заполнение внутренней суммы и валюты из внешних данных
-    if(empty($this->payment_currency)) {
+    if (empty($this->payment_currency)) {
       $this->payment_currency = $config->payment_currency_default;
     }
-    if(empty($this->payment_amount) && !empty($this->payment_external_currency)) {
+    if (empty($this->payment_amount) && !empty($this->payment_external_currency)) {
       $this->payment_amount = self::currency_convert($this->payment_external_amount, $this->payment_external_currency, $this->payment_currency);
     }
 
     // TODO - Тестовый режим
-    if(!empty($this->payment_params['test'])) {
+    if (!empty($this->payment_params['test'])) {
       $this->payment_test = $this->config['test'] || sys_get_param_int($this->payment_params['test']);
     }
 
@@ -641,12 +641,12 @@ 
     sn_db_transaction_start();
     try {
       $response = $this->payment_request_process();
-    } catch(Exception $e) {
+    } catch (Exception $e) {
       $response['result'] = $e->getCode();
       $response['message'] = $e->getMessage();
     }
 
-    if($response['result'] == SN_PAYMENT_REQUEST_OK) {
+    if ($response['result'] == SN_PAYMENT_REQUEST_OK) {
       sn_db_transaction_commit();
       $debug->warning('Результат операции: код ' . $response['result'] . ' сообщение "' . $response['message'] . '"', 'Успешный платёж', LOG_INFO_PAYMENT);
     } else {
@@ -655,7 +655,7 @@ 
     }
 
     // Переводим код результата из СН в код платежной системы
-    if(is_array($this->result_translations) && !empty($this->result_translations)) {
+    if (is_array($this->result_translations) && !empty($this->result_translations)) {
       $response['result'] = isset($this->result_translations[$response['result']]) ? $this->result_translations[$response['result']] : $this->result_translations[SN_PAYMENT_REQUEST_UNDEFINED_ERROR];
     }
 
@@ -680,7 +680,7 @@ 
     $currency_from = strtolower($currency_from);
     $currency_to = strtolower($currency_to);
 
-    if($currency_from != $currency_to) {
+    if ($currency_from != $currency_to) {
 //      $config_currency_from_name = 'payment_currency_exchange_' . $currency_from;
 //      $config_currency_to_name = 'payment_currency_exchange_' . $currency_to;
 
@@ -710,10 +710,10 @@ 
   public static function bonus_calculate($dark_matter, $direct = true, $return_bonus = false) {
     $bonus = 0;
     $dark_matter_new = $dark_matter;
-    if(!empty(self::$bonus_table) && $dark_matter >= self::$bonus_table[0]) {
-      if($direct) {
-        foreach(self::$bonus_table as $dm_for_bonus => $multiplier) {
-          if($dm_for_bonus <= $dark_matter) {
+    if (!empty(self::$bonus_table) && $dark_matter >= self::$bonus_table[0]) {
+      if ($direct) {
+        foreach (self::$bonus_table as $dm_for_bonus => $multiplier) {
+          if ($dm_for_bonus <= $dark_matter) {
             $dark_matter_new = $dark_matter * (1 + $multiplier);
             $bonus = $multiplier;
           } else {
@@ -721,9 +721,9 @@ 
           }
         }
       } else {
-        foreach(self::$bonus_table as $dm_for_bonus => $multiplier) {
+        foreach (self::$bonus_table as $dm_for_bonus => $multiplier) {
           $temp = $dm_for_bonus * (1 + $multiplier);
-          if($dark_matter >= $temp) {
+          if ($dark_matter >= $temp) {
             $dark_matter_new = round($dark_matter / (1 + $multiplier));
             $bonus = $multiplier;
           } else {
@@ -779,13 +779,13 @@ 
     );
 
     $replace = false;
-    if($this->payment_id) {
+    if ($this->payment_id) {
       $payment['payment_id'] = $this->payment_id;
       $replace = true;
     }
 
     $query = array();
-    foreach($payment as $key => $value) {
+    foreach ($payment as $key => $value) {
       $value = is_string($value) ? '"' . db_escape($value) . '"' : $value;
       $query[] = "`{$key}` = {$value}";
     }
@@ -797,12 +797,12 @@ 
 
 
   function payment_adjust_mm_new() {
-    if(!$this->payment_test) {
+    if (!$this->payment_test) {
       // Not a test payment. Adding DM to account
       $this->account = new Account($this->db);
       $this->account->db_get_by_id($this->payment_account_id);
       $result = $this->account->metamatter_change(RPG_PURCHASE, $this->payment_dark_matter_gained, $this->payment_comment);
-      if(!$result) {
+      if (!$result) {
         throw new Exception('Ошибка начисления ММ', SN_METAMATTER_ERROR_ADJUST);
       }
     }
@@ -812,25 +812,25 @@ 
     die('{НЕ РАБОТАЕТ! СООБЩИТЕ АДМИНИСТРАЦИИ!}');
     global $lang;
 
-    if(!isset($payment['payment_status'])) {
+    if (!isset($payment['payment_status'])) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_not_found'], SN_PAYMENT_REQUEST_ORDER_NOT_FOUND);
     }
 
-    if($payment['payment_status'] == PAYMENT_STATUS_COMPLETE) {
-      $safe_comment = db_escape($payment['payment_comment'] = classLocale::$lang['pay_msg_request_payment_cancelled'] .' ' . $payment['payment_comment']);
+    if ($payment['payment_status'] == PAYMENT_STATUS_COMPLETE) {
+      $safe_comment = db_escape($payment['payment_comment'] = classLocale::$lang['pay_msg_request_payment_cancelled'] . ' ' . $payment['payment_comment']);
 
-      if(!$payment['payment_test']) {
+      if (!$payment['payment_test']) {
         $result = $this->account->metamatter_change(RPG_PURCHASE_CANCEL, -$payment['payment_dark_matter_gained'], $payment['payment_comment']);
-        if(!$result) {
+        if (!$result) {
           throw new exception('Ошибка начисления ММ', SN_METAMATTER_ERROR_ADJUST);
         }
       }
       $payment['payment_status'] = PAYMENT_STATUS_CANCELED;
       db_payment_update($payment, $safe_comment);
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancel_complete'], SN_PAYMENT_REQUEST_OK);
-    } elseif($payment['payment_status'] == PAYMENT_STATUS_CANCELED) {
+    } elseif ($payment['payment_status'] == PAYMENT_STATUS_CANCELED) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancelled_already'], SN_PAYMENT_REQUEST_OK);
-    } elseif($payment['payment_status'] == PAYMENT_STATUS_NONE) {
+    } elseif ($payment['payment_status'] == PAYMENT_STATUS_NONE) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancel_not_complete'], SN_PAYMENT_REQUEST_PAYMENT_NOT_COMPLETE);
     }
   }
@@ -844,8 +844,8 @@ 
 
   protected function db_complete_payment() {
     // TODO - поле payment_processed
-    if($this->payment_status == PAYMENT_STATUS_NONE) {
-      if(!defined('PAYMENT_EXPIRE_TIME') || PAYMENT_EXPIRE_TIME == 0 || empty($this->payment_date) || strtotime($this->payment_date) + PAYMENT_EXPIRE_TIME <= SN_TIME_NOW) {
+    if ($this->payment_status == PAYMENT_STATUS_NONE) {
+      if (!defined('PAYMENT_EXPIRE_TIME') || PAYMENT_EXPIRE_TIME == 0 || empty($this->payment_date) || strtotime($this->payment_date) + PAYMENT_EXPIRE_TIME <= SN_TIME_NOW) {
         $this->payment_adjust_mm_new();
         $this->payment_status = PAYMENT_STATUS_COMPLETE;
       } else {
@@ -892,7 +892,7 @@ 
   protected function db_assign_payment($payment = null) {
     $this->payment_reset();
 
-    if(is_array($payment) && isset($payment['payment_id'])) {
+    if (is_array($payment) && isset($payment['payment_id'])) {
       $this->payment_id = $payment['payment_id'];
       $this->payment_status = $payment['payment_status'];
       $this->payment_date = $payment['payment_date'];

includes/classes/template.php

Doc Comments +1 added lines

@@ -103,6 +103,7 @@
   /**
   * Set custom template location (able to use directory outside of phpBB)
   * @access public
+  * @param string $template_path
   */
   function set_custom_template($template_path, $template_name, $fallback_template_path = false)
   {

Spacing +6 added lines, -6 removed lines

@@ -628,7 +628,7 @@ 
       // Re-position template blocks
       for ($i = sizeof($this->_tpldata[$blockname]); $i > $key; $i--)
       {
-        $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i-1];
+        $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i - 1];
         $this->_tpldata[$blockname][$i]['S_ROW_COUNT'] = $i;
       }
 
@@ -710,13 +710,13 @@ 
   */
   function assign_recursive($values, $name = '')
   {
-    if(isset($values['.']))
+    if (isset($values['.']))
     {
       $values_extra = $values['.'];
       unset($values['.']);
     }
 
-    if(!$name)
+    if (!$name)
     {
       $this->assign_vars($values);
     }
@@ -725,12 +725,12 @@ 
       $this->assign_block_vars($name, $values);
     }
 
-    if(isset($values_extra))
+    if (isset($values_extra))
     {
-      foreach($values_extra as $sub_array_name => $sub_array)
+      foreach ($values_extra as $sub_array_name => $sub_array)
       {
         $new_name = $name . ($name ? '.' : '') . $sub_array_name;
-        foreach($sub_array as $sub_element)
+        foreach ($sub_array as $sub_element)
         {
           $this->assign_recursive($sub_element, $new_name);
         }

includes/classes/user_options.php

Doc Comments +3 added lines

@@ -151,6 +151,9 @@
   }
 
 
+  /**
+   * @param integer $user_id
+   */
   public function __construct($user_id) {
     $this->user_change($user_id);
   }

Spacing +30 added lines, -30 removed lines

@@ -116,8 +116,8 @@ 
 
     $update_cache = false;
 
-    if(!empty($this->to_write)) {
-      foreach($this->to_write as $key => $cork) {
+    if (!empty($this->to_write)) {
+      foreach ($this->to_write as $key => $cork) {
         $value = is_array($this->data[$key]) ? serialize($this->data[$key]) : $this->data[$key]; // Сериализация для массивов при сохранении в БД
         $this->to_write[$key] = "({$this->user_id}, '" . db_escape($key) . "', '" . db_escape($value) . "')";
       }
@@ -128,19 +128,19 @@ 
       $update_cache = true;
     }
 
-    if(!empty($this->to_delete)) {
-      foreach($this->to_delete as $key => &$value) {
-        $value = is_string($key) ? "'". db_escape($key) . "'" : $key;
+    if (!empty($this->to_delete)) {
+      foreach ($this->to_delete as $key => &$value) {
+        $value = is_string($key) ? "'" . db_escape($key) . "'" : $key;
       }
 
-      doquery("DELETE FROM {{player_options}} WHERE `player_id` = {$this->user_id} AND `option_id` IN (". implode(',', $this->to_delete) . ") ");
+      doquery("DELETE FROM {{player_options}} WHERE `player_id` = {$this->user_id} AND `option_id` IN (" . implode(',', $this->to_delete) . ") ");
       // pdump("DELETE FROM {{player_options}} WHERE `player_id` = {$this->user_id} AND `option_id` IN (". implode(',', $this->to_delete) . ") ");
 
       $this->to_delete = array();
       $update_cache = true;
     }
 
-    if($update_cache) {
+    if ($update_cache) {
       global $sn_cache;
 
       $field_name = $this->cached_name();
@@ -167,7 +167,7 @@ 
   protected function load() {
     global $sn_cache;
 
-    if($this->loaded) {
+    if ($this->loaded) {
       return;
     }
 
@@ -175,7 +175,7 @@ 
     $this->to_write = array();
     $this->to_delete = array();
 
-    if(!$this->user_id) {
+    if (!$this->user_id) {
       $this->loaded = true;
       return;
     }
@@ -183,13 +183,13 @@ 
     $field_name = $this->cached_name();
     $a_data = $sn_cache->$field_name;
 
-    if(!empty($a_data)) {
+    if (!empty($a_data)) {
       $this->data = array_replace_recursive($this->data, $a_data);
       return;
     }
 
     $query = doquery("SELECT * FROM `{{player_options}}` WHERE `player_id` = {$this->user_id} FOR UPDATE");
-    while($row = db_fetch($query)) {
+    while ($row = db_fetch($query)) {
       // $this->data[$row['option_id']] = $row['value'];
       $this->data[$row['option_id']] = is_string($row['value']) && ($temp = unserialize($row['value'])) !== false ? $temp : $row['value']; // Десериализация
     }
@@ -269,14 +269,14 @@ 
     // Если в массиве индекса только один элемент - значит это просто индекс
     is_array($option_id) && count($option_id) == 1 ? $option_id = reset($option_id) : false;
 
-    if(!isset($this->data[is_array($option_id) ? reset($option_id) : $option_id])) {
+    if (!isset($this->data[is_array($option_id) ? reset($option_id) : $option_id])) {
       $this->load();
     }
 
-    if(is_array($option_id)) {
+    if (is_array($option_id)) {
       $result = $this->data;
-      foreach($option_id as $sub_key) {
-        if(!isset($result) || !isset($result[$sub_key])) {
+      foreach ($option_id as $sub_key) {
+        if (!isset($result) || !isset($result[$sub_key])) {
           $result = null;
           break;
         }
@@ -296,12 +296,12 @@ 
   public function __set($option, $value = null) {
     global $sn_cache;
 
-    if(empty($option) || !$this->user_id) {
+    if (empty($option) || !$this->user_id) {
       return;
     }
 
     // Если в массиве индекса только один элемент - значит это просто индекс
-    if(is_array($option) && count($option) == 1) {
+    if (is_array($option) && count($option) == 1) {
       // Разворачиваем его в индекс
       $option = array(reset($option) => $value);
       unset($value);
@@ -310,13 +310,13 @@ 
 
     $to_write = array();
     // Адресация многомерного массива через массив индексов в $option
-    if(is_array($option) && isset($value)) {
+    if (is_array($option) && isset($value)) {
       $a_data = &$this->data;
-      foreach($option as $option_id) {
+      foreach ($option as $option_id) {
         !is_array($a_data[$option_id]) ? $a_data[$option_id] = array() : false;
         $a_data = &$a_data[$option_id];
       }
-      if($a_data != $value) {
+      if ($a_data != $value) {
         $a_data = $value;
         $to_write[reset($option)] = null;
       }
@@ -324,10 +324,10 @@ 
       // Пакетная запись из массива ключ -> значение
       !is_array($option) ? $option = array($option => $value) : false;
 
-      foreach($option as $option_id => $option_value) {
-        if($this->data[$option_id] !== $option_value) {
+      foreach ($option as $option_id => $option_value) {
+        if ($this->data[$option_id] !== $option_value) {
           // TODO - вынести отдельно в обработчик
-          if($option_id == PLAYER_OPTION_MENU_HIDE_SHOW_BUTTON &&  $option_value == PLAYER_OPTION_MENU_HIDE_SHOW_BUTTON_HIDDEN) {
+          if ($option_id == PLAYER_OPTION_MENU_HIDE_SHOW_BUTTON && $option_value == PLAYER_OPTION_MENU_HIDE_SHOW_BUTTON_HIDDEN) {
             sn_setcookie(SN_COOKIE . '_menu_hidden', '0', time() - PERIOD_WEEK, SN_ROOT_RELATIVE);
           }
 
@@ -337,11 +337,11 @@ 
       }
     }
 
-    if(!empty($to_write)) {
+    if (!empty($to_write)) {
       $field_name = $this->cached_name();
       $sn_cache->$field_name = $this->data;
 
-      foreach($to_write as $option_id => &$option_value) {
+      foreach ($to_write as $option_id => &$option_value) {
         $option_value = is_array($this->data[$option_id]) ? serialize($this->data[$option_id]) : $this->data[$option_id]; // Сериализация для массивов при сохранении в БД
         $to_write[$option_id] = "({$this->user_id}, '" . db_escape($option_id) . "', '" . db_escape($option_value) . "')";
       }
@@ -353,26 +353,26 @@ 
   protected function load() {
     global $sn_cache;
 
-    if($this->loaded) {
+    if ($this->loaded) {
       return;
     }
 
     $this->data = $this->defaults;
 
-    if(!$this->user_id) {
+    if (!$this->user_id) {
       return;
     }
 
     $field_name = $this->cached_name();
     $a_data = $sn_cache->$field_name;
 
-    if(!empty($a_data)) {
+    if (!empty($a_data)) {
       $this->data = array_replace($this->data, $a_data);
       return;
     }
 
     $query = doquery("SELECT * FROM `{{player_options}}` WHERE `player_id` = {$this->user_id} FOR UPDATE");
-    while($row = db_fetch($query)) {
+    while ($row = db_fetch($query)) {
       // $this->data[$row['option_id']] = $row['value'];
       $this->data[$row['option_id']] = is_string($row['value']) && ($temp = unserialize($row['value'])) !== false ? $temp : $row['value']; // Десериализация
     }
@@ -388,7 +388,7 @@ 
     return $this->__get($offset);
   }
   public function offsetSet($offset, $value) {
-    if(!is_null($offset)) {
+    if (!is_null($offset)) {
       // $this->data[$offset] = $value;
       $this->__set($offset, $value);
     } else {

includes/db.php

Doc Comments +8 added lines, -5 removed lines

@@ -11,6 +11,9 @@ 
 
 require_once('db/db_queries.php');
 
+/**
+ * @param string $tablename
+ */
 function db_change_units_perform($query, $tablename, $object_id) {
   $query = implode(',', $query);
   if($query && $object_id) {
@@ -63,6 +66,9 @@ 
   db_change_units_perform($query[LOC_USER], 'users', $user['id']);
   db_change_units_perform($query[LOC_PLANET], 'planets', $planet['id']);
 }
+/**
+ * @param string $table
+ */
 function sn_db_perform($table, $values, $type = 'insert', $options = false) {
   $mass_perform = false;
 
@@ -171,11 +177,8 @@ 
 /**
  * Функция проверяет статус транзакции
  *
- * @param null|true|false $status Должна ли быть запущена транзакция в момент проверки
- *   <p>null - транзакция НЕ должна быть запущена</p>
- *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
- *   <p>false - всё равно - для совместимости с $for_update</p>
- * @return bool Текущий статус транзакции
+ * @param boolean $transaction_should_be_started
+ * @return null|boolean Текущий статус транзакции
  */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::db_transaction_check($transaction_should_be_started);

Spacing +11 added lines, -11 removed lines

@@ -11,7 +11,7 @@ 
 
 function db_change_units_perform($query, $tablename, $object_id) {
   $query = implode(',', $query);
-  if($query && $object_id) {
+  if ($query && $object_id) {
     return classSupernova::db_upd_record_by_id($tablename == 'users' ? LOC_USER : LOC_PLANET, $object_id, $query);
     // return doquery("UPDATE {{{$tablename}}} SET {$query} WHERE `id` = '{$object_id}' LIMIT 1;");
   }
@@ -28,15 +28,15 @@ 
 
   $group = sn_get_groups('resources_loot');
 
-  foreach($unit_list as $unit_id => $unit_amount) {
-    if(!in_array($unit_id, $group)) {
+  foreach ($unit_list as $unit_id => $unit_amount) {
+    if (!in_array($unit_id, $group)) {
       // TODO - remove later
       print('<h1>СООБЩИТЕ ЭТО АДМИНУ: db_change_units() вызван для не-ресурсов!</h1>');
       pdump(debug_backtrace());
       die('db_change_units() вызван для не-ресурсов!');
     }
 
-    if(!$unit_amount) {
+    if (!$unit_amount) {
       continue;
     }
 
@@ -45,7 +45,7 @@ 
     $unit_location = sys_get_unit_location($user, $planet, $unit_id);
 
     // Changing value in object
-    switch($unit_location) {
+    switch ($unit_location) {
       case LOC_USER:
         $user[$unit_db_name] += $unit_amount;
         break;
@@ -67,23 +67,23 @@ 
   $field_set = '';
   $value_set = '';
 
-  switch($type) {
+  switch ($type) {
     case 'delete':
       $query = 'DELETE FROM';
       break;
 
     case 'insert':
       $query = 'INSERT INTO';
-      if(isset($options['__multi'])) {
+      if (isset($options['__multi'])) {
         // Here we generate mass-insert set
         break;
       }
     case 'update':
-      if(!$query) {
+      if (!$query) {
         $query = 'UPDATE';
       }
 
-      foreach($values as $field => &$value) {
+      foreach ($values as $field => &$value) {
         $value_type = gettype($value);
         if ($value_type == 'string') {
           $value = "'" . db_escape($value) . "'";
@@ -111,12 +111,12 @@ 
   $field_set['__IS_SAFE'] = true;
 }
 function sn_db_field_set_make_safe($field_set, $serialize = false) {
-  if(!is_array($field_set)) {
+  if (!is_array($field_set)) {
     die('$field_set is not an array!');
   }
 
   $result = array();
-  foreach($field_set as $field => $value) {
+  foreach ($field_set as $field => $value) {
     $field = db_escape(trim($field));
     switch (true) {
       case is_int($value):