Validate ProjectBuildRequest

src/Helpers/Projects/ProjectBuildRequest.php

@@ -23,13 +23,21 @@ namespace App\Helpers\Projects;
 use App\Entity\Parts\PartLot;
 use App\Entity\ProjectSystem\Project;
 use App\Entity\ProjectSystem\ProjectBOMEntry;
-use Doctrine\Common\Collections\Collection;
+use App\Validator\Constraints\ProjectSystem\ValidProjectBuildRequest;
 
+/**
+ * @ValidProjectBuildRequest()
+ */
 final class ProjectBuildRequest
 {
     private Project $project;
     private int $number_of_builds;
 
+    /**
+     * @var array<int, float>
+     */
+    private array $withdraw_amounts = [];
+
     /**
      * @param  Project  $project  The project that should be build
      * @param  int  $number_of_builds The number of builds that should be created
@@ -38,6 +46,24 @@ final class ProjectBuildRequest
     {
         $this->project = $project;
         $this->number_of_builds = $number_of_builds;
+
+        $this->initializeArray();
+    }
+
+    private function initializeArray(): void
+    {
+        //Completely reset the array
+        $this->withdraw_amounts = [];
+
+        //Now create an array for each BOM entry
+        foreach ($this->getPartBomEntries() as $bom_entry) {
+            $remaining_amount = $this->getNeededAmountForBOMEntry($bom_entry);
+            foreach($this->getPartLotsForBOMEntry($bom_entry) as $lot) {
+                //If the lot has instock use it for the build
+                $this->withdraw_amounts[$lot->getID()] = min($remaining_amount, $lot->getAmount());
+                $remaining_amount -= max(0, $this->withdraw_amounts[$lot->getID()]);
+            }
+        }
     }
 
     /**
@@ -52,9 +78,73 @@ final class ProjectBuildRequest
         }
     }
 
+    /**
+     * Returns the amount of parts that should be withdrawn from the given lot for the corresponding BOM entry.
+     * @param PartLot|int $lot The part lot (or the ID of the part lot) for which the withdraw amount should be get
+     * @return float
+     */
+    public function getLotWithdrawAmount($lot): float
+    {
+        if ($lot instanceof PartLot) {
+            $lot_id = $lot->getID();
+        } elseif (is_int($lot)) {
+            $lot_id = $lot;
+        } else {
+            throw new \InvalidArgumentException('The given lot must be an instance of PartLot or an ID of a PartLot!');
+        }
+
+        if (! array_key_exists($lot_id, $this->withdraw_amounts)) {
+            throw new \InvalidArgumentException('The given lot is not in the withdraw amounts array!');
+        }
+
+        return $this->withdraw_amounts[$lot_id];
+    }
+
+    /**
+     * Sets the amount of parts that should be withdrawn from the given lot for the corresponding BOM entry.
+     * @param PartLot|int $lot The part lot (or the ID of the part lot) for which the withdraw amount should be get
+     * @param  float  $amount
+     * @return $this
+     */
+    public function setLotWithdrawAmount($lot, float $amount): self
+    {
+        if ($lot instanceof PartLot) {
+            $lot_id = $lot->getID();
+        } elseif (is_int($lot)) {
+            $lot_id = $lot;
+        } else {
+            throw new \InvalidArgumentException('The given lot must be an instance of PartLot or an ID of a PartLot!');
+        }
+
+        $this->withdraw_amounts[$lot_id] = $amount;
+
+        return $this;
+    }
+
+    /**
+     * Returns the sum of all withdraw amounts for the given BOM entry.
+     * @param  ProjectBOMEntry  $entry
+     * @return float
+     */
+    public function getWithdrawAmountSum(ProjectBOMEntry $entry): float
+    {
+        $this->ensureBOMEntryValid($entry);
+
+        $sum = 0;
+        foreach ($this->getPartLotsForBOMEntry($entry) as $lot) {
+            $sum += $this->getLotWithdrawAmount($lot);
+        }
+
+        if ($entry->getPart() && !$entry->getPart()->useFloatAmount()) {
+            $sum = round($sum);
+        }
+
+        return $sum;
+    }
+
     /**
      * Returns the number of available lots to take stock from for the given BOM entry.
-     * @parm ProjectBOMEntry $entry
+     * @param ProjectBOMEntry $entry
      * @return PartLot[]|null Returns null if the entry is a non-part BOM entry
      */
     public function getPartLotsForBOMEntry(ProjectBOMEntry $projectBOMEntry): ?array
@@ -65,7 +155,8 @@ final class ProjectBuildRequest
             return null;
         }
 
-        return $projectBOMEntry->getPart()->getPartLots()->toArray();
+        //Filter out all lots which have unknown instock
+        return $projectBOMEntry->getPart()->getPartLots()->filter(fn (PartLot $lot) => !$lot->isInstockUnknown())->toArray();
     }
 
     /**