Merge pull request #28799 from Progi1984/issue17903

classes/pdf/HTMLTemplateDeliverySlip.php

@@ -24,6 +24,8 @@
  * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  */
 
+use PrestaShop\PrestaShop\Core\Util\Sorter;
+
 /**
  * @since 1.5
  */
@@ -126,6 +128,10 @@ public function getContent()
             }
         }
 
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $order_details = $sorter->natural($order_details, Sorter::ORDER_DESC, 'product_reference', 'product_supplier_reference');
+
         $this->smarty->assign([
             'order' => $this->order,
             'order_details' => $order_details,

classes/pdf/HTMLTemplateInvoice.php

@@ -24,6 +24,8 @@
  * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  */
 
+use PrestaShop\PrestaShop\Core\Util\Sorter;
+
 /**
  * @since 1.5
  */
@@ -238,6 +240,10 @@ public function getContent()
             unset($order_detail); // don't overwrite the last order_detail later
         }
 
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $order_details = $sorter->natural($order_details, Sorter::ORDER_DESC, 'product_reference', 'product_supplier_reference');
+
         $cart_rules = $this->order->getCartRules();
         $free_shipping = false;
         foreach ($cart_rules as $key => $cart_rule) {
@@ -307,10 +313,9 @@ public function getContent()
             $footer[$key] = Tools::ps_round($value, Context::getContext()->getComputingPrecision(), $this->order->round_mode);
         }
 
-        /**
+        /*
          * Need the $round_mode for the tests.
          */
-        $round_type = null;
         switch ($this->order->round_type) {
             case Order::ROUND_TOTAL:
                 $round_type = 'total';

classes/pdf/HTMLTemplateOrderSlip.php

@@ -24,6 +24,8 @@
  * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  */
 
+use PrestaShop\PrestaShop\Core\Util\Sorter;
+
 /**
  * @since 1.5
  */
@@ -159,10 +161,15 @@ public function getContent()
             }
         }
 
+        $order_details = $this->order->products;
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $order_details = $sorter->natural($order_details, Sorter::ORDER_DESC, 'product_reference', 'product_supplier_reference');
+
         $this->smarty->assign([
             'order' => $this->order,
             'order_slip' => $this->order_slip,
-            'order_details' => $this->order->products,
+            'order_details' => $order_details,
             'cart_rules' => $this->order_slip->order_slip_type == 1 ? $this->order->getCartRules() : false,
             'amount_choosen' => $this->order_slip->order_slip_type == 2 ? true : false,
             'delivery_address' => $formatted_delivery_address,

src/Adapter/Cart/QueryHandler/GetCartForViewingHandler.php

@@ -40,6 +40,7 @@
 use PrestaShop\PrestaShop\Core\Domain\Cart\QueryHandler\GetCartForViewingHandlerInterface;
 use PrestaShop\PrestaShop\Core\Domain\Cart\QueryResult\CartView;
 use PrestaShop\PrestaShop\Core\Localization\Locale;
+use PrestaShop\PrestaShop\Core\Util\Sorter;
 use Product;
 use StockAvailable;
 use Validate;
@@ -117,6 +118,10 @@ public function handle(GetCartForViewing $query)
             $total_shipping = $summary['total_shipping'];
         }
 
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $products = $sorter->natural($products, Sorter::ORDER_DESC, 'reference', 'supplier_reference');
+
         foreach ($products as &$product) {
             if ($tax_calculation_method == PS_TAX_EXC) {
                 $product['product_price'] = $product['price'];

src/Adapter/Order/QueryHandler/GetOrderPreviewHandler.php

@@ -47,6 +47,7 @@
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderPreviewShippingDetails;
 use PrestaShop\PrestaShop\Core\Domain\Order\ValueObject\OrderId;
 use PrestaShop\PrestaShop\Core\Localization\Locale\Repository as LocaleRepository;
+use PrestaShop\PrestaShop\Core\Util\Sorter;
 use State;
 use StockAvailable;
 use Validate;
@@ -208,7 +209,12 @@ private function getProductDetails(Order $order): array
 
         $taxCalculationMethod = $this->getOrderTaxCalculationMethod($order);
 
-        foreach ($order->getProductsDetail() as $detail) {
+        $orderDetails = $order->getProductsDetail();
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $orderDetails = $sorter->natural($orderDetails, Sorter::ORDER_DESC, 'product_reference', 'product_supplier_reference');
+
+        foreach ($orderDetails as $detail) {
             $unitPrice = $detail['unit_price_tax_excl'];
             $totalPrice = $detail['total_price_tax_excl'];
 

src/Adapter/Order/QueryHandler/GetOrderProductsForViewingHandler.php

@@ -43,10 +43,10 @@
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderProductCustomizationsForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderProductForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderProductsForViewing;
-use PrestaShop\PrestaShop\Core\Domain\ValueObject\QuerySorting;
 use PrestaShop\PrestaShop\Core\Image\Parser\ImageTagSourceParserInterface;
 use PrestaShop\PrestaShop\Core\Localization\CLDR\ComputingPrecision;
 use PrestaShop\PrestaShop\Core\Localization\Locale;
+use PrestaShop\PrestaShop\Core\Util\Sorter;
 use Product;
 use Shop;
 use StockAvailable;
@@ -175,13 +175,14 @@ public function handle(GetOrderProductsForViewing $query): OrderProductsForViewi
 
         unset($product);
 
-        if (QuerySorting::DESC === $query->getProductsSorting()->getValue()) {
-            // reorder products by order_detail_id DESC
-            krsort($products);
-        } else {
-            // reorder products by order_detail_id ASC
-            ksort($products);
-        }
+        // Sort products by Reference ID (and if equals (like combination) by Supplier Reference)
+        $sorter = new Sorter();
+        $products = $sorter->natural(
+            $products,
+            $query->getProductsSorting()->getValue(),
+            'product_reference',
+            'product_supplier_reference'
+        );
 
         $productsForViewing = [];
 

src/Core/Util/Sorter.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Util;
+
+class Sorter
+{
+    public const ORDER_ASC = 'ASC';
+    public const ORDER_DESC = 'DESC';
+
+    /**
+     * @param array<array<string, mixed>> $array
+     * @param string $order
+     * @param string ...$criterias
+     *
+     * @return array
+     */
+    public function natural(array $array, string $order, string ...$criterias): array
+    {
+        usort($array, function ($a, $b) use ($order, $criterias) {
+            $cmp = 0;
+            foreach ($criterias as $criteria) {
+                if (!isset($a[$criteria]) || !isset($b[$criteria])) {
+                    return 0;
+                }
+                $cmp = strnatcmp($a[$criteria], $b[$criteria]);
+                if ($cmp !== 0) {
+                    break;
+                }
+            }
+
+            return static::ORDER_DESC === $order ? $cmp : $cmp * -1;
+        });
+
+        return $array;
+    }
+}