supernova-ws / SuperNova

includes/classes/auth_local.php

Doc Comments +7 added lines

@@ -209,6 +209,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) {
@@ -218,6 +222,9 @@ 
     return $result;
   }
 
+  /**
+   * @param Account $account_to_impersonate
+   */
   public function impersonate($account_to_impersonate) {
     $this->cookie_set($account_to_impersonate);
   }

includes/classes/Confirmation.php

Doc Comments +19 added lines

@@ -18,6 +18,11 @@ 
 
   // TODO - НЕ ОБЯЗАТЕЛЬНО ОТПРАВЛЯТЬ ЧЕРЕЗ ЕМЕЙЛ! ЕСЛИ ЭТО ФЕЙСБУЧЕК ИЛИ ВКШЕЧКА - МОЖНО ЧЕРЕЗ ЛС ПИСАТЬ!!
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $email_unsafe
+   */
   public function db_confirmation_get_latest_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
@@ -26,12 +31,21 @@ 
           `type` = {$confirmation_type_safe} AND `email` = '{$email_safe}' ORDER BY create_time DESC LIMIT 1;", true);
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   */
   public function db_confirmation_delete_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
     return $this->db->doquery("DELETE FROM {{confirmations}} WHERE `type` = {$confirmation_type_safe} AND `email` = '{$email_safe}'");
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $email_unsafe
+   */
   public function db_confirmation_get_unique_code_by_type_and_email($confirmation_type_safe, $email_unsafe) {
     $email_safe = $this->db->db_escape($email_unsafe);
 
@@ -50,6 +64,11 @@ 
     return $confirm_code_unsafe;
   }
   // TODO - OK 4.6
+
+  /**
+   * @param integer $confirmation_type_safe
+   * @param string $confirmation_code_unsafe
+   */
   public function db_confirmation_get_by_type_and_code($confirmation_type_safe, $confirmation_code_unsafe) {
     $confirmation_code_safe = $this->db->db_escape($confirmation_code_unsafe);
 

includes/classes/db_mysql_v4.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
     return true;
   }
 
+  /**
+   * @param string $query_string
+   */
   function mysql_query($query_string) {
     return mysql_query($query_string, $this->link);
   }

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

Indentation +63 added lines, -63 removed lines

@@ -44,17 +44,17 @@ 
   var $block_else_level = array();
 
   /**
-  * constuctor
-  */
+   * constuctor
+   */
   function template_compile(&$template)
   {
     $this->template = &$template;
   }
 
   /**
-  * Load template source from file
-  * @access private
-  */
+   * Load template source from file
+   * @access private
+   */
   function _tpl_load_file($handle, $store_in_db = false)
   {
     // Try and open template for read
@@ -97,10 +97,10 @@ 
   }
 
   /**
-  * Remove any PHP tags that do not belong, these regular expressions are derived from
-  * the ones that exist in zend_language_scanner.l
-  * @access private
-  */
+   * Remove any PHP tags that do not belong, these regular expressions are derived from
+   * the ones that exist in zend_language_scanner.l
+   * @access private
+   */
   function remove_php_tags(&$code)
   {
     // This matches the information gathered from the internal PHP lexer
@@ -114,9 +114,9 @@ 
   }
 
   /**
-  * The all seeing all doing compile method. Parts are inspired by or directly from Smarty
-  * @access private
-  */
+   * The all seeing all doing compile method. Parts are inspired by or directly from Smarty
+   * @access private
+   */
   function compile($code, $no_echo = false, $echo_var = '')
   {
     if ($echo_var)
@@ -285,9 +285,9 @@ 
   }
 
   /**
-  * Compile variables
-  * @access private
-  */
+   * Compile variables
+   * @access private
+   */
   function compile_var_tags(&$text_blocks)
   {
     // change template varrefs into PHP varrefs
@@ -347,9 +347,9 @@ 
   }
 
   /**
-  * Compile blocks
-  * @access private
-  */
+   * Compile blocks
+   * @access private
+   */
   function compile_tag_block($tag_args)
   {
     $no_nesting = false;
@@ -435,14 +435,14 @@ 
     $tag_template_php .= 'if ($_' . $tag_args . '_count) {';
 
     /**
-    * The following uses foreach for iteration instead of a for loop, foreach is faster but requires PHP to make a copy of the contents of the array which uses more memory
-    * <code>
-    * if (!$offset)
-    * {
-    *   $tag_template_php .= 'foreach (' . $varref . ' as $_' . $tag_args . '_i => $_' . $tag_args . '_val){';
-    * }
-    * </code>
-    */
+     * The following uses foreach for iteration instead of a for loop, foreach is faster but requires PHP to make a copy of the contents of the array which uses more memory
+     * <code>
+     * if (!$offset)
+     * {
+     *   $tag_template_php .= 'foreach (' . $varref . ' as $_' . $tag_args . '_i => $_' . $tag_args . '_val){';
+     * }
+     * </code>
+     */
 
     $tag_template_php .= 'for ($_' . $tag_args . '_i = ' . $loop_start . '; $_' . $tag_args . '_i < ' . $loop_end . '; ++$_' . $tag_args . '_i){';
 //    $tag_template_php .= '$this->_block_counter["'. $tag_args . '"] = $_' . $tag_args . '_i;';
@@ -453,10 +453,10 @@ 
   }
 
   /**
-  * Compile IF tags - much of this is from Smarty with
-  * some adaptions for our block level methods
-  * @access private
-  */
+   * Compile IF tags - much of this is from Smarty with
+   * some adaptions for our block level methods
+   * @access private
+   */
   function compile_tag_if($tag_args, $elseif)
   {
     // Tokenize args for 'if' tag.
@@ -611,9 +611,9 @@ 
   }
 
   /**
-  * Compile DEFINE tags
-  * @access private
-  */
+   * Compile DEFINE tags
+   * @access private
+   */
   function compile_tag_define($tag_args, $op)
   {
     preg_match('#^((?:[a-z0-9\-_]+\.)+)?\$(?=[A-Z])([A-Z0-9_\-]*)(?: = (\'?)([^\']*)(\'?))?$#', $tag_args, $match);
@@ -664,9 +664,9 @@ 
   }
 
   /**
-  * Compile INCLUDE tag
-  * @access private
-  */
+   * Compile INCLUDE tag
+   * @access private
+   */
   function compile_tag_include($tag_args)
   {
     // Process dynamic includes
@@ -679,19 +679,19 @@ 
   }
 
   /**
-  * Compile INCLUDE_PHP tag
-  * @access private
-  */
+   * Compile INCLUDE_PHP tag
+   * @access private
+   */
   function compile_tag_include_php($tag_args)
   {
     return "\$this->_php_include('$tag_args');";
   }
 
   /**
-  * parse expression
-  * This is from Smarty
-  * @access private
-  */
+   * parse expression
+   * This is from Smarty
+   * @access private
+   */
   function _parse_is_expr($is_arg, $tokens)
   {
     $expr_end = 0;
@@ -756,13 +756,13 @@ 
   }
 
   /**
-  * Generates a reference to the given variable inside the given (possibly nested)
-  * block namespace. This is a string of the form:
-  * ' . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname'] . '
-  * It's ready to be inserted into an "echo" line in one of the templates.
-  * NOTE: expects a trailing "." on the namespace.
-  * @access private
-  */
+   * Generates a reference to the given variable inside the given (possibly nested)
+   * block namespace. This is a string of the form:
+   * ' . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname'] . '
+   * It's ready to be inserted into an "echo" line in one of the templates.
+   * NOTE: expects a trailing "." on the namespace.
+   * @access private
+   */
   function generate_block_varref($namespace, $varname, $echo = true, $defop = false)
   {
     // Strip the trailing period.
@@ -780,14 +780,14 @@ 
   }
 
   /**
-  * Generates a reference to the array of data values for the given
-  * (possibly nested) block namespace. This is a string of the form:
-  * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
-  *
-  * 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
-  */
+   * Generates a reference to the array of data values for the given
+   * (possibly nested) block namespace. This is a string of the form:
+   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
+   *
+   * 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
+   */
   function generate_block_data_ref($blockname, $include_last_iterator, $defop = false)
   {
     // Get an array of the blocks involved.
@@ -823,9 +823,9 @@ 
   }
 
   /**
-  * Write compiled file to cache directory
-  * @access private
-  */
+   * Write compiled file to cache directory
+   * @access private
+   */
   function compile_write($handle, $data)
   {
     $filename = $this->template->cachepath . str_replace('/', '.', $this->template->filename[$handle]) . DOT_PHP_EX;
@@ -848,8 +848,8 @@ 
 
   // Gorlum's minifier BOF
   /**
-  * Minifies template w/i PHP code by removing extra spaces
-  */
+   * Minifies template w/i PHP code by removing extra spaces
+   */
   private function minify($html)
   {
     if(!classSupernova::$config->tpl_minifier)

includes/classes/locale.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/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;
   }

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

Indentation +75 added lines, -75 removed lines

@@ -25,11 +25,11 @@ 
 class template
 {
   /** variable that holds all the data we'll be substituting into
-  * the compiled templates. Takes form:
-  * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
-  * if it's a root-level variable, it'll be like this:
-  * --> $this->_tpldata[.][0][varname] == value
-  */
+   * the compiled templates. Takes form:
+   * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
+   * if it's a root-level variable, it'll be like this:
+   * --> $this->_tpldata[.][0][varname] == value
+   */
   var $_tpldata = array('.' => array(0 => array()));
   var $_rootref;
 //  var $_block_counter = array();
@@ -60,9 +60,9 @@ 
   var $parsed = false;
 
   /**
-  * Set template location
-  * @access public
-  */
+   * Set template location
+   * @access public
+   */
   function set_template()
   {
     global $phpbb_root_path, $user;
@@ -101,9 +101,9 @@ 
   }
 
   /**
-  * Set custom template location (able to use directory outside of phpBB)
-  * @access public
-  */
+   * Set custom template location (able to use directory outside of phpBB)
+   * @access public
+   */
   function set_custom_template($template_path, $template_name, $fallback_template_path = false)
   {
     global $phpbb_root_path, $user;
@@ -142,10 +142,10 @@ 
   }
 
   /**
-  * Sets the template filenames for handles. $filename_array
-  * should be a hash of handle => filename pairs.
-  * @access public
-  */
+   * Sets the template filenames for handles. $filename_array
+   * should be a hash of handle => filename pairs.
+   * @access public
+   */
   function set_filenames($filename_array)
   {
     if (!is_array($filename_array))
@@ -172,9 +172,9 @@ 
   }
 
   /**
-  * Destroy template data set
-  * @access public
-  */
+   * Destroy template data set
+   * @access public
+   */
   function destroy()
   {
     $this->_tpldata = array('.' => array(0 => array()));
@@ -182,9 +182,9 @@ 
   }
 
   /**
-  * Reset/empty complete block
-  * @access public
-  */
+   * Reset/empty complete block
+   * @access public
+   */
   function destroy_block_vars($blockname)
   {
     if (strpos($blockname, '.') !== false)
@@ -212,9 +212,9 @@ 
   }
 
   /**
-  * Display handle
-  * @access public
-  */
+   * Display handle
+   * @access public
+   */
   function display($handle, $include_once = true)
   {
     global $user, $phpbb_hook, $lang, $config;
@@ -248,9 +248,9 @@ 
   }
 
   /**
-  * Display the handle and assign the output to a template variable or return the compiled result.
-  * @access public
-  */
+   * Display the handle and assign the output to a template variable or return the compiled result.
+   * @access public
+   */
   function assign_display($handle, $template_var = '', $return_content = true, $include_once = false)
   {
     ob_start();
@@ -268,9 +268,9 @@ 
   }
 
   /**
-  * Load a compiled template if possible, if not, recompile it
-  * @access private
-  */
+   * Load a compiled template if possible, if not, recompile it
+   * @access private
+   */
   function _tpl_load(&$handle)
   {
     global $user, $config;
@@ -453,9 +453,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array
-  * @access public
-  */
+   * Assign key variable pairs from an array
+   * @access public
+   */
   function assign_vars($vararray)
   {
     foreach ($vararray as $key => $val)
@@ -467,9 +467,9 @@ 
   }
 
   /**
-  * Assign a single variable to a single key
-  * @access public
-  */
+   * Assign a single variable to a single key
+   * @access public
+   */
   function assign_var($varname, $varval)
   {
     $this->_rootref[$varname] = $varval;
@@ -478,9 +478,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array to a specified block
-  * @access public
-  */
+   * Assign key variable pairs from an array to a specified block
+   * @access public
+   */
   function assign_block_vars($blockname, $vararray)
   {
     if (strpos($blockname, '.') !== false)
@@ -545,33 +545,33 @@ 
   }
 
   /**
-  * Change already assigned key variable pair (one-dimensional - single loop entry)
-  *
-  * An example of how to use this function:
-  * {@example alter_block_array.php}
-  *
-  * @param  string  $blockname  the blockname, for example 'loop'
-  * @param  array $vararray the var array to insert/add or merge
-  * @param  mixed $key    Key to search for
-  *
-  * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
-  *
-  * int: Position [the position to change or insert at directly given]
-  *
-  * If key is false the position is set to 0
-  * If key is true the position is set to the last entry
-  *
-  * @param  string  $mode   Mode to execute (valid modes are 'insert' and 'change')
-  *
-  * If insert, the vararray is inserted at the given position (position counting from zero).
-  * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
-  *
-  * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
-  * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
-  *
-  * @return bool false on error, true on success
-  * @access public
-  */
+   * Change already assigned key variable pair (one-dimensional - single loop entry)
+   *
+   * An example of how to use this function:
+   * {@example alter_block_array.php}
+   *
+   * @param  string  $blockname  the blockname, for example 'loop'
+   * @param  array $vararray the var array to insert/add or merge
+   * @param  mixed $key    Key to search for
+   *
+   * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
+   *
+   * int: Position [the position to change or insert at directly given]
+   *
+   * If key is false the position is set to 0
+   * If key is true the position is set to the last entry
+   *
+   * @param  string  $mode   Mode to execute (valid modes are 'insert' and 'change')
+   *
+   * If insert, the vararray is inserted at the given position (position counting from zero).
+   * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
+   *
+   * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
+   * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
+   *
+   * @return bool false on error, true on success
+   * @access public
+   */
   function alter_block_array($blockname, $vararray, $key = false, $mode = 'insert')
   {
     if (strpos($blockname, '.') !== false)
@@ -655,9 +655,9 @@ 
   }
 
   /**
-  * Include a separate template
-  * @access private
-  */
+   * Include a separate template
+   * @access private
+   */
   function _tpl_include($filename, $include = true)
   {
     global $lang, $config;
@@ -686,9 +686,9 @@ 
   }
 
   /**
-  * Include a php-file
-  * @access private
-  */
+   * Include a php-file
+   * @access private
+   */
   function _php_include($filename)
   {
     global $phpbb_root_path;
@@ -705,9 +705,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array with block support
-  * @access public
-  */
+   * Assign key variable pairs from an array with block support
+   * @access public
+   */
   function assign_recursive($values, $name = '')
   {
     if(isset($values['.']))

includes/classes/user_options.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/db.php

Doc Comments +8 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) {
@@ -63,6 +66,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) {
   $mass_perform = false;
 
@@ -171,11 +177,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);