supernova-ws / SuperNova

includes/includes/flt_mission_transport.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
 /**
  * Fleet mission "Relocate"
  *
- * @param $mission_data Mission
+ * @param Mission $mission_data Mission
  *
  * @return int
  *

includes/classes/core_auth.php

Doc Comments +7 added lines, -1 removed lines

@@ -286,7 +286,6 @@ 
   /**
    * Функция пытается залогиниться по всем известным провайдерам
    *
-   * @param null $result
    */
   public function login() {
     if(empty(sn_module::$sn_module_list['auth'])) {
@@ -823,10 +822,17 @@ 
 
   // OK v4.5
   // TODO - REMEMBER_ME
+
+  /**
+   * @param integer $period
+   */
   protected static function cookie_set($value, $impersonate = false, $period = null) {
     sn_setcookie($impersonate ? SN_COOKIE_U_I : SN_COOKIE_U, $value, $period === null ? SN_TIME_NOW + PERIOD_YEAR : $period, SN_ROOT_RELATIVE);
   }
 
+  /**
+   * @param string $message
+   */
   protected static function flog($message, $die = false) {
     if(!defined('DEBUG_AUTH') || !DEBUG_AUTH) {
       return;

includes/classes/Fleet.php

Doc Comments +5 added lines, -3 removed lines

@@ -972,7 +972,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'])) {
@@ -1020,7 +1020,7 @@ 
   }
 
   /**
-   * @param array $rate
+   * @param integer[] $rate
    *
    * @return float
    */
@@ -1051,7 +1051,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int
@@ -1205,6 +1204,9 @@ 
   }
 
 
+  /**
+   * @param integer $missionStartTimeStamp
+   */
   protected function renderFleetCoordinates($missionStartTimeStamp = SN_TIME_NOW, $timeMissionJob = 0) {
     $timeToReturn = $this->travelData['duration'] * 2 + $timeMissionJob;
 

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

includes/classes/DbSqlLiteral.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
   }
 
   /**
-   * @param mixed $value
+   * @param string $value
    *
    * @return $this
    */

includes/classes/DBStaticUser.php

Doc Comments +9 added lines

@@ -131,6 +131,9 @@ 
     );
   }
 
+  /**
+   * @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`,
@@ -208,6 +211,9 @@ 
   }
 
 
+  /**
+   * @param string $username_unsafe
+   */
   public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {
     return classSupernova::db_get_user_by_username($username_unsafe, $for_update, $fields, $player, $like);
   }
@@ -220,6 +226,9 @@ 
     return classSupernova::db_upd_record_by_id(LOC_USER, $user_id, $set);
   }
 
+  /**
+   * @param boolean $player
+   */
   public static function db_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) {
     return classSupernova::db_get_user_by_id($user_id_unsafe, $for_update, $fields, $player);
   }

includes/classes/UBE/ArrayAccessV2.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
    * @param mixed $offset <p>
    * The offset to assign the value to.
    * </p>
-   * @param mixed $value <p>
+   * @param Unit $value <p>
    * The value to set.
    * </p>
    *

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: