supernova-ws / SuperNova

classes/sn_module_payment.php

Doc Comments +7 added lines, -1 removed lines

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

classes/SnCache.php

Doc Comments +24 added lines

@@ -134,6 +134,9 @@ 
     }
   }
 
+  /**
+   * @param string $filter
+   */
   public function queryCacheSetByFilter($location_type, $filter, $record_id) {
     $this->queries[$location_type][$filter][$record_id] = &$this->getDataRefByLocationAndId($location_type, $record_id);
   }
@@ -173,14 +176,23 @@ 
     return true; // Не всегда - от результата
   }
 
+  /**
+   * @param integer $locationType
+   */
   public function getData($locationType = LOC_NONE) {
     return $locationType == LOC_NONE ? $this->data : $this->data[$locationType];
   }
 
+  /**
+   * @param integer $locationType
+   */
   public function cacheUnsetElement($locationType, $recordId) {
     $this->data[$locationType][$recordId] = null;
   }
 
+  /**
+   * @param integer $locationType
+   */
   public function isArrayLocation($locationType) {
     return is_array($this->data[$locationType]);
   }
@@ -204,6 +216,9 @@ 
     }
   }
 
+  /**
+   * @param integer $unit_snid
+   */
   public function getUnitLocator($location_type, $location_id, $unit_snid) {
     return $unit_snid ? $this->locator[LOC_UNIT][$location_type][$location_id][$unit_snid] : $this->locator[LOC_UNIT][$location_type][$location_id];
   }
@@ -236,14 +251,23 @@ 
     return $this->locks;
   }
 
+  /**
+   * @param string $filter
+   */
   public function getQueriesByLocationAndFilter($locationType, $filter) {
     return !empty($this->queries[$locationType][$filter]) && is_array($this->queries[$locationType][$filter]) ? $this->queries[$locationType][$filter] : array();
   }
 
+  /**
+   * @param string $filter
+   */
   public function isQueryCacheByLocationAndFilterEmpty($locationType, $filter) {
     return !isset($this->queries[$locationType][$filter]) || $this->queries[$locationType][$filter] === null;
   }
 
+  /**
+   * @param string $filter
+   */
   public function queryCacheResetByLocationAndFilter($locationType, $filter) {
     $this->queries[$locationType][$filter] = array();
   }

classes/SnDbCachedOperator.php

Doc Comments +4 added lines, -1 removed lines

@@ -426,6 +426,9 @@ 
   }
 
 
+  /**
+   * @param integer $location_type
+   */
   public function db_ins_field_set($location_type, $field_set) {
     $table_name = static::$location_info[$location_type][P_TABLE_NAME];
     $result = $this->db->doInsertSet($table_name, $field_set);
@@ -450,7 +453,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */

classes/template.php

Doc Comments +1 added lines

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

classes/template_compile.php

Doc Comments +8 added lines

@@ -45,6 +45,7 @@ 
 
   /**
   * constuctor
+  * @param template $template
   */
   public function template_compile(&$template)
   {
@@ -456,6 +457,7 @@ 
   * Compile IF tags - much of this is from Smarty with
   * some adaptions for our block level methods
   * @access private
+  * @param boolean $elseif
   */
   public function compile_tag_if($tag_args, $elseif)
   {
@@ -613,6 +615,7 @@ 
   /**
   * Compile DEFINE tags
   * @access private
+  * @param boolean $op
   */
   public function compile_tag_define($tag_args, $op)
   {
@@ -691,6 +694,7 @@ 
   * parse expression
   * This is from Smarty
   * @access private
+  * @param string $is_arg
   */
   public function _parse_is_expr($is_arg, $tokens)
   {
@@ -788,6 +792,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
   */
   public function generate_block_data_ref($blockname, $include_last_iterator, $defop = false)
   {
@@ -826,6 +832,7 @@ 
   /**
   * Write compiled file to cache directory
   * @access private
+  * @param string $data
   */
   public function compile_write($handle, $data)
   {
@@ -850,6 +857,7 @@ 
   // Gorlum's minifier BOF
   /**
   * Minifies template w/i PHP code by removing extra spaces
+  * @return string
   */
   private function minify($html)
   {

classes/V2Unit/V2UnitList.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
     }
   }
 
+  /**
+   * @param integer $snId
+   */
   public function unitAdd($snId, $level) {
     $unit = $this->unitModel->buildContainer();
     $unit->snId = $snId;

includes/db/db_queries.php

Doc Comments +15 added lines, -10 removed lines

@@ -176,6 +176,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->doSelectFetchArray("SELECT `{$db_id_field_name}` FROM {{{$db_table_name}}} WHERE `{$db_value_field_name}` = '{$current_value_safe}' LIMIT 1 FOR UPDATE");
@@ -509,8 +514,8 @@ 
 
 
 /**
- * @param $user_id
- * @param $change_type
+ * @param integer $user_id
+ * @param integer $change_type
  * @param $dark_matter
  * @param $comment_unsafe
  * @param $rowUserNameUnsafe
@@ -531,7 +536,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->doSelectFetchArray("SELECT * FROM {{referrals}} WHERE `id` = {$user_id_safe} LIMIT 1 FOR UPDATE;");
@@ -571,9 +576,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
  */
@@ -617,11 +622,11 @@ 
 }
 
 /**
- * @param $quest_name_unsafe
- * @param $quest_type
- * @param $quest_description_unsafe
+ * @param string $quest_name_unsafe
+ * @param integer $quest_type
+ * @param string $quest_description_unsafe
  * @param $quest_conditions
- * @param $quest_rewards
+ * @param string $quest_rewards
  * @param $quest_id
  */
 function db_quest_update($quest_name_unsafe, $quest_type, $quest_description_unsafe, $quest_conditions, $quest_rewards, $quest_id) {
@@ -705,7 +710,7 @@ 
 
 /**
  * @param $payment_id
- * @param $payment_status
+ * @param integer $payment_status
  * @param $comment_unsafe
  */
 function db_payment_update($payment_id, $payment_status, $comment_unsafe) {

includes/functions/eco_get_build_data.php

Doc Comments +4 added lines

@@ -12,6 +12,7 @@ 
  *
  * 1.0 - copyright (c) 2010 by Gorlum for http://supernova.ws
  * @version 1.0
+ * @param integer $lab_require
  */
 function eco_get_lab_max_effective_level(&$user, $lab_require) {
   if (!$user['user_as_ally'] && !isset($user['laboratories_active'])) {
@@ -182,6 +183,9 @@ 
   return $result;
 }
 
+/**
+ * @param integer[] $unit_list
+ */
 function eco_is_builds_in_que($planet_que, $unit_list) {
   $eco_is_builds_in_que = false;
 

includes/functions/eco_planet_update.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 use DBStatic\DBStaticPlanet;
 use DBStatic\DBStaticUser;
 
+/**
+ * @param integer $UpdateTime
+ */
 function sys_o_get_updated($user, $planet, $UpdateTime, $simulation = false, $no_user_update = false) {
   sn_db_transaction_check(true);