supernova-ws / SuperNova

classes/Fleet.php

Doc Comments +2 added lines, -4 removed lines

@@ -979,7 +979,7 @@ 
   /**
    * Set current resource list from array of units
    *
-   * @param array $resource_list
+   * @param integer[] $resource_list
    */
   public function resourcesSet($resource_list) {
     if (!empty($this->propertiesAdjusted['resource_list'])) {
@@ -1027,7 +1027,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -1058,8 +1058,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
-   * @param int  $result
    */
   public function resourcesUnload($start = true) {
     sn_db_transaction_check(true);

classes/Account.php

Doc Comments +21 added lines

@@ -171,6 +171,10 @@ 
    * @return bool
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   */
   public function db_get_by_name($account_name_unsafe) {
     $this->reset();
 
@@ -207,6 +211,11 @@ 
    *
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $email_unsafe
+   */
   public function db_get_by_name_or_email($account_name_unsafe, $email_unsafe) {
     $this->reset();
 
@@ -223,6 +232,13 @@ 
    * @throws Exception
    */
   // OK v4.5
+
+  /**
+   * @param string $account_name_unsafe
+   * @param string $password_raw
+   * @param string $email_unsafe
+   * @param string $language_unsafe
+   */
   public function db_create($account_name_unsafe, $password_raw, $email_unsafe, $language_unsafe = null, $salt_unsafe = null) {
     $this->reset();
 
@@ -317,6 +333,11 @@ 
    * @return int|string
    */
   // OK 4.8
+
+  /**
+   * @param integer $change_type
+   * @param double $metamatter
+   */
   protected function db_mm_log_insert($comment, $change_type, $metamatter, $user_id_unsafe) {
     $provider_id_safe = intval(core_auth::$main_provider->provider_id);
     //$account_id_safe = $this->db->db_escape($this->account_id);

classes/V2Fleet/V2FleetModel.php

Doc Comments +1 added lines, -1 removed lines

@@ -213,7 +213,7 @@
   /**
    * @param int|string $dbId
    *
-   * @return V2FleetContainer|false
+   * @return V2FleetContainer
    */
   public function loadById($dbId) {
     /**

classes/db_mysql.php

Doc Comments +22 added lines, -4 removed lines

@@ -164,7 +164,7 @@ 
   /**
    * @param string $query
    *
-   * @return mixed|string
+   * @return string
    */
   public function replaceTablePlaceholders($query) {
     $sql = $query;
@@ -178,7 +178,7 @@ 
   }
 
   /**
-   * @param $query
+   * @param string $query
    */
   protected function logQuery($query) {
     if (!classSupernova::$config->debug) {
@@ -290,6 +290,7 @@ 
    * @param array  $fields
    * @param array  $where
    * @param bool   $isOneRecord
+   * @param boolean $forUpdate
    *
    * @return array|bool|mysqli_result|null
    *
@@ -332,6 +333,10 @@ 
 
   //
   // INSERT/REPLACE ----------------------------------------------------------------------------------------------------
+
+  /**
+   * @param string $query
+   */
   public function doInsertComplex($query) {
     return $this->doSql($query);
   }
@@ -408,7 +413,7 @@ 
    * Self-contained - means no params used
    * Such queries usually used to make large amount of in-base calculations
    *
-   * @param $query
+   * @param string $query
    *
    * @return array|bool|mysqli_result|null
    */
@@ -425,13 +430,16 @@ 
   }
 
   /**
-   * @param $DbQuery DbQuery
+   * @param DbQuery $DbQuery DbQuery
    */
   public function doUpdateDbQueryAdjust($DbQuery) {
     return $this->doUpdateDbQuery($DbQuery);
   }
 
 
+  /**
+   * @param boolean $isOneRecord
+   */
   protected function doUpdateWhere($table, $fieldsSet, $fieldsAdjust = array(), $where = array(), $isOneRecord = DB_RECORDS_ALL, $whereDanger = array()) {
     $query = DbQuery::build($this)
       ->setTable($table)
@@ -450,6 +458,9 @@ 
     return $this->doUpdateWhere($table, $fieldsAndValues, array(), $where, DB_RECORD_ONE);
   }
 
+  /**
+   * @param string $table
+   */
   public function doUpdateTableSet($table, $fieldsAndValues, $where = array()) {
     return $this->doUpdateWhere($table, $fieldsAndValues, array(), $where, DB_RECORDS_ALL);
   }
@@ -559,6 +570,10 @@ 
   //
   // OTHER FUNCTIONS ----------------------------------------------------------------------------------------------------------
   // TODO Заменить это на новый логгер
+
+  /**
+   * @param string $query
+   */
   protected function security_watch_user_queries($query) {
     global $user;
 
@@ -582,6 +597,9 @@ 
   }
 
 
+  /**
+   * @param string $query
+   */
   public function security_query_check_bad_words($query) {
     if ($this->skipQueryCheck) {
       return;

includes/template.php

Doc Comments +7 added lines, -8 removed lines

@@ -36,7 +36,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);
@@ -195,7 +195,7 @@ 
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
  * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
+ * @param boolean       $isDisplayMenu
  *
  * @return mixed
  */
@@ -208,7 +208,6 @@ 
  * @param string          $title
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
- * @param bool|false      $AdminPage
  * @param bool|true       $isDisplayMenu
  * @param bool|int|string $exitStatus - Код или сообщение выхода
  */
@@ -359,7 +358,7 @@ 
 
 /**
  * @param $fileList
- * @param $extension
+ * @param string $extension
  * @param $sn_page_name
  * @param $template_result
  *
@@ -387,7 +386,7 @@ 
 }
 
 /**
- * @return mixed|string
+ * @return string
  */
 function calculateFontSize() {
   $font_size = !empty($_COOKIE[SN_COOKIE_F]) ? $_COOKIE[SN_COOKIE_F] : classSupernova::$user_options[PLAYER_OPTION_BASE_FONT_SIZE];
@@ -406,10 +405,10 @@ 
 
 /**
  * @param       $time
- * @param       $event
+ * @param       integer $event
  * @param       $msg
  * @param       $coordinates
- * @param       $is_decrease
+ * @param       boolean $is_decrease
  * @param Fleet $objFleet
  * @param       $fleet_flying_sorter
  * @param       $fleet_flying_events
@@ -733,7 +732,7 @@ 
 }
 
 /**
- * @param array|string  $files
+ * @param string  $files
  * @param template|bool $template
  * @param string|bool   $template_path
  *