supernova-ws / SuperNova

includes/classes/Fleet.php

Doc Comments +4 added lines, -2 removed lines

@@ -591,6 +591,9 @@ 
     return max(0, $this->shipsGetCapacity() - $this->resourcesGetTotal());
   }
 
+  /**
+   * @param integer $ship_id
+   */
   public function shipsGetTotalById($ship_id) {
     return $this->unitList->unitsCountById($ship_id);
   }
@@ -705,7 +708,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'])) {
@@ -781,7 +784,6 @@ 
    * Restores fleet or resources to planet
    *
    * @param bool $start
-   * @param bool $only_resources
    * @param int  $result
    *
    * @return int

Spacing +20 added lines, -20 removed lines

@@ -283,7 +283,7 @@ 
   public function dbInsert() {
     // WARNING! MISSION TIMES MUST BE SET WITH set_times() method!
     // TODO - more checks!
-    if(empty($this->_time_launch)) {
+    if (empty($this->_time_launch)) {
       die('Fleet time not set!');
     }
 
@@ -363,7 +363,7 @@ 
     // Записываем изменения в БД
     $this->dbSave();
 
-    if($this->_group_id) {
+    if ($this->_group_id) {
       // TODO: Make here to delete only one AKS - by adding aks_fleet_count to AKS table
       db_fleet_aks_purge();
     }
@@ -434,15 +434,15 @@ 
    */
   // TODO - separate shipList and unitList
   public function unitsSetFromArray($unit_array) {
-    foreach($unit_array as $unit_id => $unit_count) {
+    foreach ($unit_array as $unit_id => $unit_count) {
       $unit_count = floatval($unit_count);
-      if(!$unit_count) {
+      if (!$unit_count) {
         continue;
       }
 
-      if($this->isShip($unit_id)) {
+      if ($this->isShip($unit_id)) {
         $this->unitList->unitSetCount($unit_id, $unit_count);
-      } elseif($this->isResource($unit_id)) {
+      } elseif ($this->isResource($unit_id)) {
         $this->resource_list[$unit_id] = $unit_count;
       } else {
         throw new Exception('Trying to pass to fleet non-resource and non-ship ' . var_export($unit_array, true), ERR_ERROR);
@@ -471,7 +471,7 @@ 
   public function parse_missile_db_row($missile_db_row) {
 //    $this->_reset();
 
-    if(empty($missile_db_row) || !is_array($missile_db_row)) {
+    if (empty($missile_db_row) || !is_array($missile_db_row)) {
       return;
     }
 
@@ -607,7 +607,7 @@ 
   public function shipsGetCapacityRecyclers(array $recycler_info) {
     $recyclers_incoming_capacity = 0;
     $fleet_data = $this->shipsGetArray();
-    foreach($recycler_info as $recycler_id => $recycler_data) {
+    foreach ($recycler_info as $recycler_id => $recycler_data) {
       $recyclers_incoming_capacity += $fleet_data[$recycler_id] * $recycler_data['capacity'];
     }
 
@@ -627,7 +627,7 @@ 
     sn_db_transaction_check(true);
 
     // Если флот уже обработан - не существует или возращается - тогда ничего не делаем
-    if($this->isEmpty()) {
+    if ($this->isEmpty()) {
       return $result;
     }
 
@@ -649,18 +649,18 @@ 
     // TODO - Проверка, что планета всё еще существует на указанных координатах, а не телепортировалась, не удалена хозяином, не уничтожена врагом
     // Флот, который возвращается на захваченную планету, пропадает
     // Ship landing is possible only to fleet owner's planet
-    if($this->getPlayerOwnerId() == $planet_arrival['id_owner']) {
+    if ($this->getPlayerOwnerId() == $planet_arrival['id_owner']) {
       $db_changeset = array();
 
       $fleet_array = $this->shipsGetArray();
-      foreach($fleet_array as $ship_id => $ship_count) {
-        if($ship_count) {
+      foreach ($fleet_array as $ship_id => $ship_count) {
+        if ($ship_count) {
           $db_changeset['unit'][] = sn_db_unit_changeset_prepare($ship_id, $ship_count, $user, $planet_arrival['id']);
         }
       }
 
       // Adjusting ship amount on planet
-      if(!empty($db_changeset)) {
+      if (!empty($db_changeset)) {
         db_changeset_apply($db_changeset);
       }
 
@@ -708,7 +708,7 @@ 
    * @param array $resource_list
    */
   public function resourcesSet($resource_list) {
-    if(!empty($this->propertiesAdjusted['resource_list'])) {
+    if (!empty($this->propertiesAdjusted['resource_list'])) {
       throw new PropertyAccessException('Property "resource_list" already was adjusted so no SET is possible until dbSave in ' . get_called_class() . '::unitSetResourceList', ERR_ERROR);
     }
     $this->resourcesAdjust($resource_list, true);
@@ -722,13 +722,13 @@ 
   public function resourcesAdjust($resource_delta_list, $replace_value = false) {
     !is_array($resource_delta_list) ? $resource_delta_list = array() : false;
 
-    foreach($resource_delta_list as $resource_id => $unit_delta) {
-      if(!UnitResourceLoot::is_in_group($resource_id) || !($unit_delta = floor($unit_delta))) {
+    foreach ($resource_delta_list as $resource_id => $unit_delta) {
+      if (!UnitResourceLoot::is_in_group($resource_id) || !($unit_delta = floor($unit_delta))) {
         // Not a resource or no resources - continuing
         continue;
       }
 
-      if($replace_value) {
+      if ($replace_value) {
         $this->resource_list[$resource_id] = $unit_delta;
       } else {
         $this->resource_list[$resource_id] += $unit_delta;
@@ -738,7 +738,7 @@ 
       }
 
       // Check for negative unit value
-      if($this->resource_list[$resource_id] < 0) {
+      if ($this->resource_list[$resource_id] < 0) {
         // TODO
         throw new Exception('Resource ' . $resource_id . ' will become negative in ' . get_called_class() . '::unitAdjustResourceList', ERR_ERROR);
       }
@@ -790,7 +790,7 @@ 
     sn_db_transaction_check(true);
 
     // Если флот уже обработан - не существует или возращается - тогда ничего не делаем
-    if(!$this->resourcesGetTotal()) {
+    if (!$this->resourcesGetTotal()) {
       return $result;
     }
 
@@ -810,7 +810,7 @@ 
     // TODO - Проверка, что планета всё еще существует на указанных координатах, а не телепортировалась, не удалена хозяином, не уничтожена врагом
 
     // Restoring resources to planet
-    if($this->resourcesGetTotal()) {
+    if ($this->resourcesGetTotal()) {
       $fleet_resources = $this->resourcesGetList();
       db_planet_set_by_id($planet_arrival['id'],
         "`metal` = `metal` + '{$fleet_resources[RES_METAL]}', `crystal` = `crystal` + '{$fleet_resources[RES_CRYSTAL]}', `deuterium` = `deuterium` + '{$fleet_resources[RES_DEUTERIUM]}'");

includes/includes/flt_flying_fleet_handler2.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
  *
  * @param Fleet $objFleet
  * @param bool  $start
- * @param null  $result
+ * @param integer  $result
  *
  * @return mixed
  */

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/UnitList.php

Spacing +21 added lines, -21 removed lines

@@ -88,7 +88,7 @@ 
    * @param Unit  $value
    */
   public function offsetSet($offset, $value) {
-    if(isset($this->mapUnitIdToDb[$value->unitId])) {
+    if (isset($this->mapUnitIdToDb[$value->unitId])) {
       classSupernova::$debug->error('UnitList::offsetSet: Unit with UnitId ' . $value->unitId . ' already exists');
     }
     $this->mapUnitIdToDb[$value->unitId] = $value;
@@ -96,7 +96,7 @@ 
   }
 
   public function offsetUnset($offset) {
-    if(!empty($this[$offset]->unitId)) {
+    if (!empty($this[$offset]->unitId)) {
 //      $unit_id = $this[$offset]->unitId;
 //      $this->mapUnitIdToDb[$unit_id] = null;
 //      unset($this->mapUnitIdToDb[$unit_id]);
@@ -118,20 +118,20 @@ 
   public function dbLoad($dbId) {
 //    $this->_reset();
 
-    if($dbId <= 0) {
+    if ($dbId <= 0) {
       return;
     }
 
-    if(!is_object($this->locatedAt)) {
+    if (!is_object($this->locatedAt)) {
       classSupernova::$debug->error('UnitList::dbLoad have no locatedAt field set');
     }
 
     $unit_array = classSupernova::db_get_unit_list_by_location(0, $this->getLocationType(), $this->getLocationDbId());
-    if(!is_array($unit_array)) {
+    if (!is_array($unit_array)) {
       return;
     }
 
-    foreach($unit_array as $unit_db_row) {
+    foreach ($unit_array as $unit_db_row) {
       $unit = $this->_createElement();
       $unit->setLocatedAt($this);
       $unit->dbRowParse($unit_db_row);
@@ -147,25 +147,25 @@ 
   }
 
   public function dbSave() {
-    if(!is_object($this->locatedAt)) {
+    if (!is_object($this->locatedAt)) {
       classSupernova::$debug->error('UnitList::dbSave have no locatedAt field set');
     }
 
-    foreach($this->mapUnitIdToDb as $unit) {
+    foreach ($this->mapUnitIdToDb as $unit) {
       $unit_db_id = $unit->dbId;
       $unit->dbSave();
 
-      if($unit->isEmpty()) {
+      if ($unit->isEmpty()) {
         // Removing unit object
         // TODO - change when there will be common bus for all objects
         // ...or should I? If COUNT is empty - it means that object does not exists in DB. So it should be deleted from PHP memory and cache too
         unset($this[$unit_db_id]);
       } else {
-        if($unit->dbId <= 0) {
+        if ($unit->dbId <= 0) {
           classSupernova::$debug->error('Error writing unit to DB');
         }
         // If unit is new then putting unit object to container
-        if(empty($this->_container[$unit->dbId])) {
+        if (empty($this->_container[$unit->dbId])) {
           $this->_container[$unit->dbId] = $unit;
         }
       }
@@ -200,7 +200,7 @@ 
   }
 
   public function unitGetCount($unit_id) {
-    if(empty($this->mapUnitIdToDb[$unit_id])) {
+    if (empty($this->mapUnitIdToDb[$unit_id])) {
       throw new Exception('Unit [' . $unit_id . '] is not exists in UnitList');
     }
     return $this->mapUnitIdToDb[$unit_id]->count;
@@ -215,14 +215,14 @@ 
    * @param bool $replace_value
    */
   public function unitAdjustCount($unit_id, $unit_count = 0, $replace_value = false) {
-    if(empty($this->mapUnitIdToDb[$unit_id])) {
+    if (empty($this->mapUnitIdToDb[$unit_id])) {
       // If unit not exists - creating one and setting all attributes
       $this->mapUnitIdToDb[$unit_id] = $this->_createElement();
       $this->mapUnitIdToDb[$unit_id]->setUnitId($unit_id);
       $this->mapUnitIdToDb[$unit_id]->setLocatedAt($this);
     }
 
-    if($replace_value) {
+    if ($replace_value) {
       $this->mapUnitIdToDb[$unit_id]->count = $unit_count;
     } else {
       $this->mapUnitIdToDb[$unit_id]->adjustCount($unit_count);
@@ -236,7 +236,7 @@ 
    */
   public function unitsGetArray() {
     $result = array();
-    foreach($this->mapUnitIdToDb as $unit) {
+    foreach ($this->mapUnitIdToDb as $unit) {
       $result[$unit->unitId] = $unit->count;
     }
 
@@ -244,7 +244,7 @@ 
   }
 
   public function unitsCountApplyLossMultiplier($ships_lost_multiplier) {
-    foreach($this->mapUnitIdToDb as $unit_id => $unit) {
+    foreach ($this->mapUnitIdToDb as $unit_id => $unit) {
       $unit->count = floor($unit->count * $ships_lost_multiplier);
     }
   }
@@ -270,8 +270,8 @@ 
 
   public function unitsPropertySumById($unit_id = 0, $propertyName = 'count') {
     $result = 0;
-    foreach($this->mapUnitIdToDb as $unit) {
-      if(!$unit_id || $unit->unitId == $unit_id) {
+    foreach ($this->mapUnitIdToDb as $unit) {
+      if (!$unit_id || $unit->unitId == $unit_id) {
         $result += $unit->$propertyName;
       }
     }
@@ -352,7 +352,7 @@ 
 
     print('</tr>');
 
-    foreach($this->mapUnitIdToDb as $unit) {
+    foreach ($this->mapUnitIdToDb as $unit) {
       print('<tr>');
 
       print('<td>');
@@ -403,14 +403,14 @@ 
 
 
   public function unitZeroDbId() {
-    foreach($this->mapUnitIdToDb as $unit) {
+    foreach ($this->mapUnitIdToDb as $unit) {
       $unit->zeroDbId();
     }
   }
 
 
   public function unitZeroCount() {
-    foreach($this->mapUnitIdToDb as $unit) {
+    foreach ($this->mapUnitIdToDb as $unit) {
       $unit->count = 0;
     }
   }