supernova-ws / SuperNova

includes/classes/DBStaticMessages.php

Doc Comments +3 added lines

@@ -477,6 +477,9 @@
   {$StartRec}, 25;");
   }
 
+  /**
+   * @param integer $message_type
+   */
   public static function db_message_insert_all($message_type, $from, $subject, $text) {
     return classSupernova::$db->doInsert('INSERT INTO {{messages}} (`message_owner`, `message_sender`, `message_time`, `message_type`, `message_from`, `message_subject`, `message_text`) ' .
       "SELECT `id`, 0, unix_timestamp(now()), {$message_type}, '{$from}', '{$subject}', '{$text}' FROM {{users}}");

includes/classes/debug.php

Doc Comments +3 added lines

@@ -187,6 +187,9 @@
     return $error_backtrace;
   }
 
+  /**
+   * @param string $die_message
+   */
   public function error_fatal($die_message, $details = 'There is a fatal error on page') {
     // TODO - Записывать детали ошибки в лог-файл
     die($die_message);

includes/db.php

Doc Comments +9 added lines

@@ -9,6 +9,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) {
@@ -60,6 +63,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) {
   $field_set = '';
 
@@ -153,6 +159,9 @@ 
 
 
 
+/**
+ * @param boolean $transaction_should_be_started
+ */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::$gc->db->getTransaction()->check($transaction_should_be_started);
 }

includes/db/db_queries.php

Doc Comments +13 added lines, -8 removed lines

@@ -173,6 +173,11 @@ 
  */
 // OK v4
 // TODO - вынести в отдельный класс
+/**
+ * @param string $db_id_field_name
+ * @param string $db_table_name
+ * @param string $db_value_field_name
+ */
 function db_get_set_unique_id_value($current_value_unsafe, $db_id_field_name, $db_table_name, $db_value_field_name) {
   $current_value_safe = db_escape($current_value_unsafe);
   $value_id = classSupernova::$db->doSelectFetch("SELECT `{$db_id_field_name}` AS id_field FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE");
@@ -474,8 +479,8 @@ 
 
 
 /**
- * @param $user_id
- * @param $change_type
+ * @param integer $user_id
+ * @param integer $change_type
  * @param $dark_matter
  * @param $comment
  * @param $row
@@ -495,7 +500,7 @@ 
 /**
  * @param $user_id_safe
  *
- * @return array|bool|mysqli_result|null
+ * @return integer
  */
 function db_referral_get_by_id($user_id_safe) {
   $old_referral = classSupernova::$db->doSelectFetch("SELECT * FROM {{referrals}} WHERE `id` = {$user_id_safe} LIMIT 1 FOR UPDATE;");
@@ -523,9 +528,9 @@ 
 
 // Quests ***********************************************************************************************************
 /**
- * @param $query_add_select
+ * @param string $query_add_select
  * @param $query_add_from
- * @param $query_add_where
+ * @param string $query_add_where
  *
  * @return array|bool|mysqli_result|null
  */
@@ -570,10 +575,10 @@ 
 
 /**
  * @param $quest_name
- * @param $quest_type
+ * @param integer $quest_type
  * @param $quest_description
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name, $quest_type, $quest_description, $quest_conditions, $quest_rewards, $quest_id) {
@@ -592,7 +597,7 @@ 
 /**
  * @param $banner
  * @param $banned
- * @param $reason
+ * @param string $reason
  * @param $ban_until
  */
 function db_ban_insert($banner, $banned, $reason, $ban_until) {

includes/general.php

Doc Comments +33 added lines, -3 removed lines

@@ -12,7 +12,7 @@ 
 require_once('general_pname.php');
 
 /**
- * @param       $func_name
+ * @param       string $func_name
  * @param array $func_arg
  *
  * @return mixed
@@ -63,6 +63,9 @@ 
 }
 
 // ----------------------------------------------------------------------------------------------------------------
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename) {
   return @file_get_contents($filename);
 }
@@ -105,7 +108,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -146,7 +149,7 @@ 
  * @param float     $n
  * @param int|bool  $floor
  * @param int|bool  $color
- * @param int|bool  $limit
+ * @param boolean  $limit
  * @param bool|null $style
  *
  * @return array|float|string
@@ -239,6 +242,9 @@ 
   return preg_replace($ListCensure, '*', $String);
 }
 
+/**
+ * @param string $email
+ */
 function is_email($email) {
   return (preg_match("/^[-_.[:alnum:]]+@((([[:alnum:]]|[[:alnum:]][[:alnum:]-]*[[:alnum:]])\.)+(ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|at|au|aw|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|com|coop|cr|cs|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gh|gi|gl|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|in|info|int|io|iq|ir|is|it|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mil|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no|np|nr|nt|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)$|(([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5])\.){3}([0-9][0-9]?|[0-1][0-9][0-9]|[2][0-4][0-9]|[2][5][0-5]))$/i", $email));
 }
@@ -276,6 +282,9 @@ 
   return floatval(sys_get_param($param_name, $default));
 }
 
+/**
+ * @param string $param_name
+ */
 function sys_get_param_escaped($param_name, $default = '') {
   return db_escape(sys_get_param($param_name, $default));
 }
@@ -444,6 +453,9 @@ 
 }
 
 // Generates random string of $length symbols from $allowed_chars charset
+/**
+ * @param string $allowed_chars
+ */
 function sys_random_string($length = 16, $allowed_chars = SN_SYS_SEC_CHARS_ALLOWED) {
   $allowed_length = strlen($allowed_chars);
 
@@ -548,6 +560,9 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   $from = trim($from ? $from : classSupernova::$config->game_adminEmail);
 
@@ -808,6 +823,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -995,6 +1013,9 @@ 
   return $result;
 }
 
+/**
+ * @param string $groups
+ */
 function isInGroup($groups, $unitId) {
   $group = sn_get_groups($groups);
 
@@ -1063,6 +1084,9 @@ 
   return $ranks;
 }
 
+/**
+ * @param boolean $planet_id
+ */
 function sys_player_new_adjust($user_id, $planet_id) { return sn_function_call(__FUNCTION__, array($user_id, $planet_id, &$result)); }
 
 function sn_sys_player_new_adjust($user_id, $planet_id, &$result) {
@@ -1213,6 +1237,9 @@ 
   return $rates;
 }
 
+/**
+ * @param integer $in_resource
+ */
 function get_unit_cost_in(&$cost, $in_resource = RES_METAL) {
   static $rates;
 
@@ -1379,6 +1406,9 @@ 
   return version_compare(sn_version_compare_extra($ver1), sn_version_compare_extra($ver2));
 }
 
+/**
+ * @param string $name
+ */
 function sn_setcookie($name, $value = null, $expire = null, $path = SN_ROOT_RELATIVE, $domain = null, $secure = null, $httponly = null) {
   $_COOKIE[$name] = $value;
 

includes/classes/DBStaticUser.php

Doc Comments +8 added lines, -2 removed lines

@@ -104,6 +104,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $config_user_birthday_range
+   */
   public static function db_user_list_to_celebrate($config_user_birthday_range) {
     $query = static::buildDBQ()
       ->field('id', 'username', 'user_birthday', 'user_birthday_celebrated')
@@ -178,6 +181,9 @@ 
   }
 
 
+  /**
+   * @param string $username_unsafe
+   */
   public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {
     // TODO Проверить, кстати - а везде ли нужно выбирать юзеров или где-то все-таки ищутся Альянсы ?
     if (!($username_unsafe = trim($username_unsafe))) {
@@ -232,8 +238,8 @@ 
    *    <p>array - запись пользователя с установленным полем ['id']</p>
    * @param bool      $for_update @deprecated
    * @param string    $fields @deprecated список полей или '*'/'' для всех полей
-   * @param null      $player
-   * @param bool|null $player Признак выбора записи пользователь типа "игрок"
+   * @param boolean      $player
+   * @param boolean $player Признак выбора записи пользователь типа "игрок"
    *    <p>null - Можно выбрать запись любого типа</p>
    *    <p>true - Выбирается только запись типа "игрок"</p>
    *    <p>false - Выбирается только запись типа "альянс"</p>

includes/functions/eco_planet_update.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
  *     [+] Full rewrote and optimization
  *
  */
+/**
+ * @param integer $UpdateTime
+ */
 function sys_o_get_updated($user, $planet, $UpdateTime, $simulation = false, $no_user_update = false) {
   sn_db_transaction_check(true);
 

includes/classes/SnDbCachedOperator.php

Doc Comments +4 added lines, -1 removed lines

@@ -314,6 +314,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $location_type
+   */
   public static function db_ins_field_set($location_type, $field_set, $serialize = false) {
     // TODO multiinsert
     !sn_db_field_set_is_safe($field_set) ? $field_set = sn_db_field_set_make_safe($field_set, $serialize) : false;
@@ -350,7 +353,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */

includes/classes/db_mysql.php

Doc Comments +16 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
   /**
    * @param string $query
    *
-   * @return mixed|string
+   * @return string
    */
   public function replaceTablePlaceholders($query) {
     $sql = $query;
@@ -169,7 +169,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    */
   protected function logQuery($query) {
     if (!classSupernova::$config->debug) {
@@ -311,10 +311,16 @@ 
     return $this->doExecute($query);
   }
 
+  /**
+   * @param string $table
+   */
   public function doInsertSet($table, $fieldsAndValues) {
     return $this->doSet($table, $fieldsAndValues, false);
   }
 
+  /**
+   * @param string $table
+   */
   public function doReplaceSet($table, $fieldsAndValues) {
     return $this->doSet($table, $fieldsAndValues, true);
   }
@@ -427,7 +433,7 @@ 
    *
    * Usually used for mallformed $where conditions
    *
-   * @param $table
+   * @param string $table
    * @param $where
    *
    * @return array|bool|mysqli_result|null
@@ -565,6 +571,10 @@ 
   }
 
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   protected function security_watch_user_queries($query) {
     global $user;
 
@@ -588,6 +598,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function security_query_check_bad_words($query) {
     if ($this->skipQueryCheck) {
       return;