supernova-ws / SuperNova

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/classSupernova.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 
 use Vector\Vector;
-
 use Common\GlobalContainer;
 
 class classSupernova {

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

classes/core_auth.php

Doc Comments +7 added lines, -1 removed lines

@@ -286,7 +286,6 @@ 
   /**
    * Функция пытается залогиниться по всем известным провайдерам
    *
-   * @param null $result
    */
   public function login() {
     if(empty(sn_module::$sn_module_list['auth'])) {
@@ -823,10 +822,17 @@ 
 
   // OK v4.5
   // TODO - REMEMBER_ME
+
+  /**
+   * @param integer $period
+   */
   protected static function cookie_set($value, $impersonate = false, $period = null) {
     sn_setcookie($impersonate ? SN_COOKIE_U_I : SN_COOKIE_U, $value, $period === null ? SN_TIME_NOW + PERIOD_YEAR : $period, SN_ROOT_RELATIVE);
   }
 
+  /**
+   * @param string $message
+   */
   protected static function flog($message, $die = false) {
     if(!defined('DEBUG_AUTH') || !DEBUG_AUTH) {
       return;

Spacing +1 added lines, -1 removed lines

@@ -259,7 +259,7 @@
       );
 
     if ($this->register_status == LOGIN_ERROR_USERNAME_RESTRICTED_CHARACTERS) {
-      $prohibited_characters = array_map(function ($value) {
+      $prohibited_characters = array_map(function($value) {
         return "'" . htmlentities($value, ENT_QUOTES, 'UTF-8') . "'";
       }, str_split(LOGIN_REGISTER_CHARACTERS_PROHIBITED));
       $template_result[F_PLAYER_REGISTER_MESSAGE] .= implode(', ', $prohibited_characters);

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/DbRowDirectOperator.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
     return $this->db->doSelectIterator($query);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateRowSetAffected($table, $fieldsAndValues, $where) {
     $this->db->doUpdateRowSet($table, $fieldsAndValues, $where);
     return $this->db->db_affected_rows();

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/DBStaticAlly.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
   }
 
   /**
-   * @param $ranklist
+   * @param string $ranklist
    * @param $user
    */
   public static function db_ally_update_ranklist($ranklist, $user) {

Spacing +5 added lines, -5 removed lines

@@ -77,12 +77,12 @@
    */
   public static function db_ally_insert($ally_name_unsafe, $ally_tag_unsafe, $userId) {
     $ally = classSupernova::$db->doInsertSet(TABLE_ALLIANCE, array(
-      'ally_name'          => (string)$ally_name_unsafe,
-      'ally_tag'           => (string)$ally_tag_unsafe,
+      'ally_name'          => (string) $ally_name_unsafe,
+      'ally_tag'           => (string) $ally_tag_unsafe,
       'ally_owner'         => $userId,
-      'ally_owner_range'   => (string)classLocale::$lang['ali_leaderRank'],
-      'ally_members'       => (int)1,
-      'ranklist'           => (string)(classLocale::$lang['ali_defaultRankName'] . ",0,0,0,0,0"),
+      'ally_owner_range'   => (string) classLocale::$lang['ali_leaderRank'],
+      'ally_members'       => (int) 1,
+      'ranklist'           => (string) (classLocale::$lang['ali_defaultRankName'] . ",0,0,0,0,0"),
       'ally_register_time' => SN_TIME_NOW,
     ));