supernova-ws / SuperNova

includes/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();
   }

includes/classes/classCache.php

Doc Comments +7 added lines

@@ -81,6 +81,10 @@ 
   // -------------------------------------------------------------------------
   // Here comes low-level functions - those that directly works with cacher engines
   // -------------------------------------------------------------------------
+
+  /**
+   * @param string $name
+   */
   public function __set($name, $value) {
     switch ($name) {
       case '_MODE':
@@ -132,6 +136,9 @@ 
     return null;
   }
 
+  /**
+   * @param string $name
+   */
   public function __isset($name) {
     switch (self::$mode) {
       case CACHER_NO_CACHE:

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

includes/classes/classSupernova.php

Doc Comments +5 added lines, -2 removed lines

@@ -323,7 +323,7 @@ 
    *   <p>null - транзакция НЕ должна быть запущена</p>
    *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
    *   <p>false - всё равно - для совместимости с $for_update</p>
-   * @return bool Текущий статус транзакции
+   * @return null|boolean Текущий статус транзакции
    */
   public static function db_transaction_check($status = null) {
     $error_msg = false;
@@ -399,7 +399,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */
@@ -574,6 +574,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;

includes/classes/debug.php

Doc Comments +6 added lines

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

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

includes/classes/userOptions.php

Doc Comments +3 added lines

@@ -151,6 +151,9 @@
   }
 
 
+  /**
+   * @param integer $user_id
+   */
   public function __construct($user_id) {
     $this->user_change($user_id);
   }

includes/general/math.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,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 их слишком много
  *

includes/general.php

Doc Comments +34 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,10 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $title
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   $from = trim($from ? $from : classSupernova::$config->game_adminEmail);
 
@@ -808,6 +824,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -987,6 +1006,9 @@ 
   return $result;
 }
 
+/**
+ * @param string $groups
+ */
 function isInGroup($groups, $unitId) {
   $group = sn_get_groups($groups);
   return !empty($group[$unitId]);
@@ -1054,6 +1076,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) {
@@ -1204,6 +1229,9 @@ 
   return $rates;
 }
 
+/**
+ * @param integer $in_resource
+ */
 function get_unit_cost_in(&$cost, $in_resource = RES_METAL) {
   static $rates;
 
@@ -1370,6 +1398,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;