supernova-ws / SuperNova

classes/DBStatic/DBStaticPlanet.php

Doc Comments +14 added lines

@@ -21,11 +21,19 @@ 
     return empty($result) ? null : $result;
   }
 
+  /**
+   * @param integer $galaxy
+   * @param integer $system
+   * @param integer $planet
+   */
   public static function db_planet_by_gspt_safe($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     return classSupernova::db_get_record_list(LOC_PLANET,
       "{{planets}}.`galaxy` = {$galaxy} AND {{planets}}.`system` = {$system} AND {{planets}}.`planet` = {$planet} AND {{planets}}.`planet_type` = {$planet_type}", true);
   }
 
+  /**
+   * @param integer $planet_type
+   */
   public static function db_planet_by_gspt($galaxy, $system, $planet, $planet_type, $for_update = false, $fields = '*') {
     $galaxy = intval($galaxy);
     $system = intval($system);
@@ -120,6 +128,9 @@ 
       "`id_owner` = '{$user_row['id']}' {$conditions} ORDER BY {$order_by}");
   }
 
+  /**
+   * @param integer $planet_id
+   */
   public static function db_planet_list_by_user_or_planet($user_id, $planet_id) {
     if(!($user_id = idval($user_id)) && !($planet_id = idval($planet_id))) {
       return false;
@@ -138,6 +149,9 @@ 
     return classSupernova::db_upd_record_by_id(LOC_PLANET, $planet_id, $set);
   }
 
+  /**
+   * @param integer $ui_planet_type
+   */
   public static function db_planet_set_by_gspt($ui_galaxy, $ui_system, $ui_planet, $ui_planet_type = PT_ALL, $set) {
     if(!($set = trim($set))) {
       return false;

classes/DBStatic/DBStaticUnit.php

Doc Comments +3 added lines

@@ -118,6 +118,9 @@
     return classSupernova::$gc->cacheOperator->db_ins_record(LOC_UNIT, $set);
   }
 
+  /**
+   * @param integer $unit_location_type
+   */
   public static function db_unit_list_delete($user_id = 0, $unit_location_type, $unit_location_id = 0, $unit_snid = 0) {
     $where = array('unit_location_type' => $unit_location_type);
     ($unit_location_id = idval($unit_location_id)) ? $where['unit_location_id'] = $unit_location_id : false;

classes/DBStatic/DBStaticUser.php

Doc Comments +9 added lines, -3 removed lines

@@ -40,6 +40,7 @@ 
   }
 
   /**
+   * @param string $fields
    * @return DbResultIterator
    */
   protected static function playerSelectIterator($fields, $orderBy = '', $forUpdate = false, $groupHaving = '', $where = '', $limit = '') {
@@ -134,6 +135,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $config_user_birthday_range
+   */
   public static function db_user_list_to_celebrate($config_user_birthday_range) {
     $query = "SELECT
         `id`, `username`, `user_birthday`, `user_birthday_celebrated`,
@@ -213,6 +217,9 @@ 
     return $user_list;
   }
 
+  /**
+   * @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))) {
@@ -266,7 +273,6 @@ 
 
   /**
    * @param       $user_id
-   * @param array $set
    * @param array $adjust
    *
    * @return array|bool|mysqli_result|null
@@ -283,8 +289,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>

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

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

classes/SnCache.php

Doc Comments +24 added lines

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

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

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

classes/template_compile.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)
   {