code fixes

Admin/Routes/Web/Api.php

@@ -57,5 +57,5 @@ return [
                 'state'  => PermissionCategory::ORDER,
             ],
         ],
-    ]
+    ],
 ];

Controller/ApiController.php

@@ -84,6 +84,17 @@ final class ApiController extends Controller
         $this->createStandardBackgroundResponse($request, $response, []);
     }
 
+    /**
+     * Returns data from an order suggestion element.
+     *
+     * This also re-calculates a lot of values because some depend on the current stock amounts, prices etc.
+     *
+     * @param OrderSuggestionElement[] $elements Elements of our order
+     *
+     * @return array<int, array{singlePrice:FloatInt, totalPrice:FloatInt, stock:FloatInt, reserved:FloatInt, ordered:FloatInt, minquantity:FloatInt, minstock:FloatInt, quantitystep:FloatInt, avgsales:FloatInt, range_stock:float, range_reserved:float, range_ordered:float}>
+     *
+     * @since 1.0.0
+     */
     public function getOrderSuggestionElementData(array $elements) : array
     {
         if (empty($elements)) {
@@ -111,7 +122,7 @@ final class ApiController extends Controller
         // @todo A lot of the code below is mirrored in the CliController for ALL items.
         //      Pull out some of the code so we only need to maintain one version
         foreach ($elements as $element) {
-            $maxHistoryDuration = $element->item->getAttribute('order_suggestion_history_duration')->value->getValue() ?? 12;
+            $maxHistoryDuration = $element->item->getAttribute('order_suggestion_history_duration')->value->valueInt ?? 12;
 
             $salesForecast = [];
 
@@ -179,15 +190,15 @@ final class ApiController extends Controller
             //      -> see SD HTS (depending on other shipments -> not delivered even if available)
             //      -> maybe it's possible to consider the expected delivery time?
 
-            $minimumStockQuantity = $element->item->getAttribute('minimum_stock_quantity')->value->getValue() ?? 0;
+            $minimumStockQuantity = $element->item->getAttribute('minimum_stock_quantity')->value->valueInt ?? 0;
-            $minimumStockQuantity = (int) \round($minimumStockQuantity * 1000);
+            $minimumStockQuantity = (int) \round($minimumStockQuantity * FloatInt::DIVISOR); // @bug why? shouldn't the value already be 10,000?
             $minimumStockRange    = $avgMonthlySales === 0 ? 0 : $minimumStockQuantity / $avgMonthlySales;
             $minimumStockQuantity = (int) \round($minimumStockRange * $avgMonthlySales);
 
-            $minimumOrderQuantity = $element->item->getAttribute('minimum_order_quantity')->value->getValue() ?? 0;
+            $minimumOrderQuantity = $element->item->getAttribute('minimum_order_quantity')->value->valueInt ?? 0;
             $minimumOrderQuantity = (int) \round($minimumOrderQuantity * FloatInt::DIVISOR);
 
-            $orderQuantityStep = $element->item->getAttribute('order_quantity_steps')->value->getValue() ?? 1;
+            $orderQuantityStep = $element->item->getAttribute('order_quantity_steps')->value->valueInt ?? 1;
             $orderQuantityStep = (int) \round($orderQuantityStep * FloatInt::DIVISOR);
 
             $orderQuantity = $element->quantity->value;

Controller/CliController.php

@@ -84,6 +84,15 @@ final class CliController extends Controller
         return $view;
     }
 
+    /**
+     * Create a suggestion
+     *
+     * @param RequestAbstract $request Request
+     *
+     * @return OrderSuggestion
+     *
+     * @since 1.0.0
+     */
     public function createSuggestionFromRequest(RequestAbstract $request) : OrderSuggestion
     {
         $showIrrelevant = $request->getDataBool('-irrelevant') ?? false;
@@ -99,6 +108,7 @@ final class CliController extends Controller
         // @question Consider to save suggestion as model in db
         //      This would allow users to work on it for a longer time
         //      It would also allow for an easier approval process
+        /** @var \Modules\ItemManagement\Models\Item[] $items */
         $items = ItemMapper::getAll()
             ->with('container')
             ->with('l11n')
@@ -150,13 +160,13 @@ final class CliController extends Controller
             ->where('type/name', 'business_year_start')
             ->execute();
 
-        $businessStart = $unitAttribute->id === 0 ? 1 : $unitAttribute->value->getValue();
+        $businessStart = $unitAttribute->id === 0 ? 1 : $unitAttribute->value->valueInt;
 
         $historyStart = (int) $start->format('m');
         $historyEnd   = (int) $end->format('m');
 
         foreach ($items as $item) {
-            $maxHistoryDuration = $item->getAttribute('order_suggestion_history_duration')->value->getValue() ?? 12;
+            $maxHistoryDuration = $item->getAttribute('order_suggestion_history_duration')->value->valueInt ?? 12;
 
             $salesForecast = [];
 
@@ -225,24 +235,24 @@ final class CliController extends Controller
             //      -> maybe it's possible to consider the expected delivery time?
 
             // Get minimum range we want
-            $wantedStockRange = $item->getAttribute('minimum_stock_range')->value->getValue() ?? 1;
+            $wantedStockRange = $item->getAttribute('minimum_stock_range')->value->valueInt ?? 1;
 
-            $minimumStockQuantity = $item->getAttribute('minimum_stock_quantity')->value->getValue() ?? 0;
+            $minimumStockQuantity = $item->getAttribute('minimum_stock_quantity')->value->valueInt ?? 0;
             $minimumStockQuantity = (int) \round($minimumStockQuantity * FloatInt::DIVISOR);
             $minimumStockRange    = $avgMonthlySales === 0 ? 0 : $minimumStockQuantity / $avgMonthlySales;
             $minimumStockQuantity = (int) \round($minimumStockRange * $avgMonthlySales);
 
-            $minimumOrderQuantity = $item->getAttribute('minimum_order_quantity')->value->getValue() ?? 0;
+            $minimumOrderQuantity = $item->getAttribute('minimum_order_quantity')->value->valueInt ?? 0;
             $minimumOrderQuantity = (int) \round($minimumOrderQuantity * FloatInt::DIVISOR);
 
-            $orderQuantityStep = $item->getAttribute('order_quantity_steps')->value->getValue() ?? 1;
+            $orderQuantityStep = $item->getAttribute('order_quantity_steps')->value->valueInt ?? 1;
             $orderQuantityStep = (int) \round($orderQuantityStep * FloatInt::DIVISOR);
 
-            $leadTime = $item->getAttribute('lead_time')->value->getValue() ?? 3; // in days
+            $leadTime = $item->getAttribute('lead_time')->value->valueInt ?? 3; // in days
 
             // @todo Business hours don't have to be 8 hours
             // we assume 10 seconds per item if nothing is defined for (invoice handling, stock handling)
-            $adminTime = ($item->getAttribute('admin_time')->value->getValue() ?? 10) / (8 * 60 * 60); // from seconds -> days
+            $adminTime = ($item->getAttribute('admin_time')->value->valueInt ?? 10) / (8 * 60 * 60); // from seconds -> days
 
             // Overhead time in days by estimating at least 1 week worth of order quantity
             $estimatedOverheadTime = $leadTime + $adminTime * \max($minimumOrderQuantity, $avgMonthlySales / 4) / FloatInt::DIVISOR;

Models/OrderSuggestion/OrderSuggestion.php

@@ -36,14 +36,30 @@ class OrderSuggestion
 
     public \DateTimeImmutable $createdAt;
 
+    /**
+     * Order elements
+     *
+     * @var OrderSuggestionElement[]
+     * @since 1.0.0
+     */
     public array $elements = [];
 
+    /**
+     * Constructor.
+     */
     public function __construct()
     {
         $this->createdBy = new NullAccount();
         $this->createdAt = new \DateTimeImmutable('now');
     }
 
+    /**
+     * Calculate total costs of order
+     *
+     * @return FloatInt
+     *
+     * @since 1.0.0
+     */
     public function getTotalCosts() : FloatInt
     {
         $total = new FloatInt();

Models/OrderSuggestion/OrderSuggestionElement.php

@@ -53,6 +53,11 @@ class OrderSuggestionElement
 
     public FloatInt $costs;
 
+    /**
+     * Constructor.
+     *
+     * @since 1.0.0
+     */
     public function __construct()
     {
         $this->modifiedBy = new NullAccount();

Models/OrderSuggestion/OrderSuggestionElementMapper.php

@@ -21,14 +21,14 @@ use Modules\SupplierManagement\Models\SupplierMapper;
 use phpOMS\DataStorage\Database\Mapper\DataMapperFactory;
 
 /**
- * Client mapper class.
+ * OrderSuggestionElement mapper class.
  *
  * @package Modules\Purchase\Models\OrderSuggestion
  * @license OMS License 2.0
  * @link    https://jingga.app
  * @since   1.0.0
  *
- * @template T of Client
+ * @template T of OrderSuggestionElement
  * @extends DataMapperFactory<T>
  */
 final class OrderSuggestionElementMapper extends DataMapperFactory

Models/OrderSuggestion/OrderSuggestionMapper.php

@@ -18,14 +18,14 @@ use Modules\Admin\Models\AccountMapper;
 use phpOMS\DataStorage\Database\Mapper\DataMapperFactory;
 
 /**
- * Client mapper class.
+ * OrderSuggestion mapper class.
  *
  * @package Modules\Purchase\Models\OrderSuggestion
  * @license OMS License 2.0
  * @link    https://jingga.app
  * @since   1.0.0
  *
- * @template T of Client
+ * @template T of OrderSuggestion
  * @extends DataMapperFactory<T>
  */
 final class OrderSuggestionMapper extends DataMapperFactory

Models/OrderSuggestion/OrderSuggestionOptimizationType.php

@@ -33,5 +33,4 @@ abstract class OrderSuggestionOptimizationType extends Enum
     public const COST = 2; // Suggestion focuses on creating better prices if volume discounts exist.
 
     public const JUST_IN_TIME = 3; // Suggestion focuses on calculating minimum stock quantities.
-
 }

Theme/Backend/Lang/Navigation.en.lang.php

@@ -15,10 +15,8 @@ declare(strict_types=1);
 return ['Navigation' => [
     'Analysis'         => 'Analysis',
     'Articles'         => 'Articles',
-    'Create'           => 'Create',
     'Invoice'          => 'Invoice',
     'Invoices'         => 'Invoices',
-    'List'             => 'List',
     'OrderSuggestions' => 'Order Suggestions',
     'PendingOrders'    => 'Pending Orders',
     'Profile'          => 'Profile',

Theme/Backend/Lang/de.lang.php

@@ -16,11 +16,8 @@ return ['Purchase' => [
     'Created'                  => 'Erstellt',
     'Creator'                  => 'Ersteller',
     'Order'                    => 'Befehl',
-    'Ordered'              => 'Bestellt',
     'Price'                    => 'Preis',
     'Status'                   => 'Status',
-    'Stock'                => 'Aktie',
-    'Order'                 => 'Bestellen',
     'Item'                     => 'Artikel',
     'Supplier'                 => 'Lieferant',
     'Stock'                    => 'Lager',
@@ -35,7 +32,6 @@ return ['Purchase' => [
     'Steps'                    => 'Schritte',
     'Ordering'                 => 'Bestellen',
     'NewRange'                 => 'Neue Reichw.',
-    'Price'                 => 'Preis',
     'Total'                    => 'Gesamt',
     'Costs'                    => 'Kosten',
     ':SuggestionStatus-1'      => 'Entwurf',
@@ -53,7 +49,6 @@ return ['Purchase' => [
     'Section'                  => 'Sparte',
     'SalesGroup'               => 'Umsatzgruppe',
     'ProductGroup'             => 'Produktgruppe',
-    'MinRange'              => 'Min.-Reichweite',
     'OrderSuggestions'         => 'Bestellvorschläge',
     'OrderSuggestion'          => 'Bestellvorschlag',
     'Suggestions'              => 'Vorschläge',

Theme/Backend/Lang/en.lang.php

@@ -15,12 +15,7 @@ declare(strict_types=1);
 return ['Purchase' => [
     'Created'                  => 'Created',
     'Creator'                  => 'Creator',
-    'Order'                => 'Order',
-    'Ordered'              => 'Ordered',
-    'Price'                => 'Price',
     'Status'                   => 'Status',
-    'Stock'                => 'Stock',
-    'Supplier'             => 'Supplier',
     'Order'                    => 'Order',
     'Item'                     => 'Item',
     'Supplier'                 => 'Supplier',
@@ -32,7 +27,6 @@ return ['Purchase' => [
     'Range2'                   => 'Range 2',
     'MinStock'                 => 'Min. Stock',
     'MinOrder'                 => 'Min. Order',
-    'MinRange'                 => 'Min. Range',
     'Steps'                    => 'Steps',
     'Ordering'                 => 'Ordering',
     'NewRange'                 => 'New Range',

Theme/Backend/order-suggestion.tpl.php

@@ -125,7 +125,7 @@ echo $this->data['nav']->render();
                             (int) ($months = ($this->data['suggestion_data'][$element->item->id]['range_ordered']
                                 + $this->data['suggestion_data'][$element->item->id]['range_reserved'])),
                             (int) (($months - ((int) $months)) * 30))
-                            ->format('Y-m-d')
+                            ->format('Y-m-d');
                         ?>
                     <td><?= $this->data['suggestion_data'][$element->item->id]['singlePrice']->getAmount(); ?>
                     <td><?= $element->costs->getAmount(); ?>