supernova-ws / SuperNova

includes/classes/auth_local.php

Doc Comments +7 added lines, -1 removed lines

@@ -134,7 +134,6 @@ 
   /**
    * Попытка залогиниться с использованием метода $method
    *
-   * @param string $method_name
    */
   public function login() {
     // TODO Проверяем поддерживаемость метода
@@ -162,6 +161,10 @@ 
    * @return array|bool|resource
    */
   // OK v4.5
+
+  /**
+   * @param string $salt_unsafe
+   */
   public function password_change($old_password_unsafe, $new_password_unsafe, $salt_unsafe = null) {
     $result = parent::password_change($old_password_unsafe, $new_password_unsafe, $salt_unsafe);
     if($result) {
@@ -171,6 +174,9 @@ 
     return $result;
   }
 
+  /**
+   * @param Account $account_to_impersonate
+   */
   public function impersonate($account_to_impersonate) {
     $this->cookie_set($account_to_impersonate);
   }

includes/classes/classSupernova.php

Doc Comments +4 added lines, -1 removed lines

@@ -200,7 +200,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */
@@ -377,6 +377,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;

Unused Use Statements -1 removed lines

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

includes/classes/db_mysql.php

Doc Comments +9 added lines, -2 removed lines

@@ -149,7 +149,7 @@ 
   /**
    * @param string $query
    *
-   * @return mixed|string
+   * @return string
    */
   public function replaceTablePlaceholders($query) {
     $sql = $query;
@@ -163,7 +163,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    */
   protected function logQuery($query) {
     if (!classSupernova::$config->debug) {
@@ -352,6 +352,10 @@ 
   }
 
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   protected function security_watch_user_queries($query) {
     global $user;
 
@@ -375,6 +379,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function security_query_check_bad_words($query) {
     if ($this->skipQueryCheck) {
       return;

includes/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;

includes/classes/DbQueryConstructor.php

Doc Comments +8 added lines, -4 removed lines

@@ -155,10 +155,17 @@ 
     return $this->field(DbSqlLiteral::build($this->db)->literal($field));
   }
 
+  /**
+   * @param string $functionName
+   * @param string $alias
+   */
   public function fieldSingleFunction($functionName, $field = '*', $alias = DbSqlLiteral::SQL_LITERAL_ALIAS_NONE) {
     return $this->field(DbSqlLiteral::build($this->db)->buildSingleArgument($functionName, $field, $alias));
   }
 
+  /**
+   * @param string $alias
+   */
   public function fieldCount($field = '*', $alias = DbSqlLiteral::SQL_LITERAL_ALIAS_NONE) {
     return $this->field(DbSqlLiteral::build($this->db)->count($field, $alias));
   }
@@ -240,7 +247,7 @@ 
 
   /**
    * @param db_mysql|null $db
-   * @param string|object|DBStaticRecord|DbSqlAware $className
+   * @param string $className
    *
    * @return static
    */
@@ -435,7 +442,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return DbEmptyIterator|DbMysqliResultIterator
    */
@@ -444,7 +450,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return array
    */
@@ -455,7 +460,6 @@ 
   }
 
   /**
-   * @param bool $skip_query_check
    *
    * @return mixed|null
    */

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) {