supernova-ws / SuperNova

classes/SkinModel.php

Doc Comments +5 added lines

@@ -70,6 +70,11 @@
     return $this->getImageFrom($this->activeSkin->getName(), $image_tag, $template);
   }
 
+  /**
+   * @param string $skinName
+   * @param string $image_tag
+   * @param template|null $template
+   */
   public function getImageFrom($skinName, $image_tag, $template) {
     return $this->getSkin($skinName)->imageFromStringTag($image_tag, $template);
   }

classes/template_compile.php

Doc Comments +6 added lines

@@ -468,6 +468,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)
   {
@@ -625,6 +626,7 @@ 
   /**
   * Compile DEFINE tags
   * @access private
+  * @param boolean $op
   */
   function compile_tag_define($tag_args, $op)
   {
@@ -703,6 +705,7 @@ 
   * parse expression
   * This is from Smarty
   * @access private
+  * @param string $is_arg
   */
   function _parse_is_expr($is_arg, $tokens)
   {
@@ -799,6 +802,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)
   {
@@ -862,6 +867,7 @@ 
   /**
   * Minifies template w/i PHP code by removing extra spaces
   * @access private
+  * @return string
   */
   function minify($html)
   {

classes/TextEntity.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
   }
 
   /**
-   * @return array
+   * @return integer
    */
   public function toArray() {
     $tutorial = array();

includes/db.php

Doc Comments +5 added lines, -5 removed lines

@@ -11,6 +11,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) {
@@ -67,11 +70,8 @@ 
 /**
  * Функция проверяет статус транзакции
  *
- * @param null|true|false $status Должна ли быть запущена транзакция в момент проверки
- *   <p>null - транзакция НЕ должна быть запущена</p>
- *   <p>true - транзакция должна быть запущена - для совместимости с $for_update</p>
- *   <p>false - всё равно - для совместимости с $for_update</p>
- * @return bool Текущий статус транзакции
+ * @param boolean $transaction_should_be_started
+ * @return null|boolean Текущий статус транзакции
  */
 function sn_db_transaction_check($transaction_should_be_started = null) {
   return classSupernova::db_transaction_check($transaction_should_be_started);

includes/general.php

Doc Comments +26 added lines, -1 removed lines

@@ -12,6 +12,9 @@ 
 require_once('general/compatibility.php');
 require_once('general_pname.php');
 
+/**
+ * @param string $func_name
+ */
 function sn_function_call($func_name, $func_arg = array())
 {
   global $functions; // All data in $functions should be normalized to valid 'callable' state: '<function_name>'|array('<object_name>', '<method_name>')
@@ -65,6 +68,9 @@ 
 
 // ----------------------------------------------------------------------------------------------------------------
 // Fonction de lecture / ecriture / exploitation de templates
+/**
+ * @param string $filename
+ */
 function sys_file_read($filename)
 {
   return @file_get_contents($filename);
@@ -111,7 +117,7 @@ 
 /**
  * Получение курса обмены валюты в серверную валюту
  *
- * @param $currency_symbol
+ * @param string $currency_symbol
  *
  * @return float
  */
@@ -148,6 +154,7 @@ 
    null  - standard result
    true  - return only style class for current params
    false - return array('text' => $ret, 'class' => $class), where $ret - unstyled
+ * @param boolean $style
  */
 
 function pretty_number($n, $floor = true, $color = false, $limit = false, $style = null)
@@ -267,6 +274,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));
 }
@@ -303,6 +313,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));
@@ -547,6 +560,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);
 
@@ -672,6 +688,9 @@ 
   return implode(';', $fleet_string);
 }
 
+/**
+ * @param string $body
+ */
 function mymail($email_unsafe, $title, $body, $from = '', $html = false) {
   global $config, $lang;
 
@@ -959,6 +978,9 @@ 
   return serialize($nick_array);
 }
 
+/**
+ * @param string $nick_string
+ */
 function player_nick_uncompact($nick_string) {
   try {
     $result = unserialize($nick_string);
@@ -1262,6 +1284,9 @@ 
   return $ranks;
 }
 
+/**
+ * @param boolean $planet_id
+ */
 function sys_player_new_adjust($user_id, $planet_id){return sn_function_call('sys_player_new_adjust', array($user_id, $planet_id, &$result));}
 function sn_sys_player_new_adjust($user_id, $planet_id, &$result) {
   return $result;

includes/template.php

Doc Comments +8 added lines, -17 removed lines

@@ -54,7 +54,7 @@ 
  * @param string    $title
  * @param string    $dest
  * @param int       $time
- * @param bool|true $show_header
+ * @param boolean $show_header
  */
 function message($mes, $title = 'Error', $dest = '', $time = 5, $show_header = true) {
   $template = gettemplate('message_body', true);
@@ -217,10 +217,6 @@ 
 /**
  * @param template|string $page
  * @param string          $title
- * @param bool|true       $isDisplayTopNav
- * @param string          $metatags
- * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
  *
  * @return mixed
  */
@@ -235,11 +231,6 @@ 
 /**
  * @param template|string $page
  * @param string          $title
- * @param bool|true       $isDisplayTopNav
- * @param string          $metatags
- * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
- * @param bool|int|string $exitStatus - Код или сообщение выхода
  */
 function sn_display($page, $title = '') {
   global $debug, $user, $planetrow, $config, $lang, $template_result, $sn_mvc, $sn_page_name;
@@ -402,7 +393,7 @@ 
 
 /**
  * @param $template_result
- * @param $is_login
+ * @param boolean $is_login
  */
 function tpl_global_header(&$template_result, $is_login) {
   global $sn_mvc, $sn_page_name, $user;
@@ -451,10 +442,10 @@ 
 
 /**
  * @param $time
- * @param $event
+ * @param integer $event
  * @param $msg
- * @param $prefix
- * @param $is_decrease
+ * @param string $prefix
+ * @param boolean $is_decrease
  * @param $fleet_flying_row
  * @param $fleet_flying_sorter
  * @param $fleet_flying_events
@@ -785,7 +776,7 @@ 
  * @param template $template
  * @param array|bool      $array
  *
- * @return mixed
+ * @return template
  */
 function templateObjectParse($template, $array = false) {
   global $user;
@@ -809,7 +800,7 @@ 
 }
 
 /**
- * @param template|string $template
+ * @param template $template
  * @param array|bool      $array
  *
  * @return mixed
@@ -832,7 +823,7 @@ 
 }
 
 /**
- * @param array|string  $files
+ * @param string  $files
  * @param template|null $template
  * @param string|null   $template_path - path to template
  *