Implement discounts management in Order View page

admin-dev/themes/new-theme/js/pages/order/OrderViewPageMap.js

@@ -29,4 +29,14 @@ export default {
   privateNoteBlock: '.js-private-note-block',
   privateNoteInput: '#private_note_note',
   privateNoteSubmitBtn: '.js-private-note-btn',
+  updateOrderProductModal: '#updateOrderProductModal',
+  updateOrderProductPriceTaxExclInput: '#update_order_product_price_tax_excl',
+  updateOrderProductPriceTaxInclInput: '#update_order_product_price_tax_incl',
+  updateOrderProductQuantityInput: '#update_order_product_quantity',
+  addCartRuleModal: '#addOrderDiscountModal',
+  addCartRuleApplyOnAllInvoicesCheckbox: '#add_order_cart_rule_apply_on_all_invoices',
+  addCartRuleInvoiceIdSelect: '#add_order_cart_rule_invoice_id',
+  addCartRuleTypeSelect: '#add_order_cart_rule_type',
+  addCartRuleValueInput: '#add_order_cart_rule_value',
+  cartRuleHelpText: '.js-cart-rule-value-help',
 };

admin-dev/themes/new-theme/js/pages/order/view.js

@@ -28,6 +28,10 @@ import OrderViewPageMap from './OrderViewPageMap';
 const $ = window.$;
 
 $(() => {
+  const DISCOUNT_TYPE_AMOUNT = 'amount';
+  const DISCOUNT_TYPE_PERCENT = 'percent';
+  const DISCOUNT_TYPE_FREE_SHIPPING = 'free_shipping';
+
   handlePaymentDetailsToggle();
   handlePrivateNoteChange();
 
@@ -36,6 +40,9 @@ $(() => {
     togglePrivateNoteBlock();
   });
 
+  initAddCartRuleFormHandler();
+  initAddProductFormHandler();
+
   function handlePaymentDetailsToggle() {
     $(OrderViewPageMap.orderPaymentDetailsBtn).on('click', (event) => {
       const $paymentDetailRow = $(event.currentTarget).closest('tr').next(':first');
@@ -69,4 +76,51 @@ $(() => {
       $submitBtn.prop('disabled', !note);
     });
   }
+
+  function initAddProductFormHandler() {
+    const $modal = $(OrderViewPageMap.updateOrderProductModal);
+
+    $modal.on('click', '.js-order-product-update-btn', (event) => {
+      const $btn = $(event.currentTarget);
+
+      $modal.find('.js-update-product-name').text($btn.data('product-name'));
+      $modal.find(OrderViewPageMap.updateOrderProductPriceTaxExclInput).val($btn.data('product-price-tax-excl'));
+      $modal.find(OrderViewPageMap.updateOrderProductPriceTaxInclInput).val($btn.data('product-price-tax-incl'));
+      $modal.find(OrderViewPageMap.updateOrderProductQuantityInput).val($btn.data('product-quantity'));
+      $modal.find('form').attr('action', $btn.data('update-url'));
+    });
+  }
+
+  function initAddCartRuleFormHandler() {
+    const $modal = $(OrderViewPageMap.addCartRuleModal);
+    const $form = $modal.find('form');
+    const $valueHelp = $modal.find(OrderViewPageMap.cartRuleHelpText);
+    const $invoiceSelect = $modal.find(OrderViewPageMap.addCartRuleInvoiceIdSelect);
+    const $valueInput = $form.find(OrderViewPageMap.addCartRuleValueInput);
+    const $valueFormGroup = $valueInput.closest('.form-group');
+
+    $form.find(OrderViewPageMap.addCartRuleApplyOnAllInvoicesCheckbox).on('change', (event) => {
+      const isChecked = $(event.currentTarget).is(':checked');
+
+      $invoiceSelect.attr('disabled', isChecked);
+    });
+
+    $form.find(OrderViewPageMap.addCartRuleTypeSelect).on('change', (event) => {
+      const selectedCartRuleType = $(event.currentTarget).val();
+
+      if (selectedCartRuleType === DISCOUNT_TYPE_AMOUNT) {
+        $valueHelp.removeClass('d-none');
+      } else {
+        $valueHelp.addClass('d-none');
+      }
+
+      if (selectedCartRuleType === DISCOUNT_TYPE_FREE_SHIPPING) {
+        $valueFormGroup.addClass('d-none');
+        $valueInput.attr('disabled', true);
+      } else {
+        $valueFormGroup.removeClass('d-none');
+        $valueInput.attr('disabled', false);
+      }
+    });
+  }
 });

src/Adapter/Order/CommandHandler/AddCartRuleToOrderHandler.php

@@ -46,13 +46,13 @@ final class AddCartRuleToOrderHandler extends AbstractOrderHandler implements Ad
     /**
      * {@inheritdoc}
      */
-    public function handle(AddCartRuleToOrderCommand $command)
+    public function handle(AddCartRuleToOrderCommand $command): void
     {
         $order = $this->getOrderObject($command->getOrderId());
 
         // If the discount is for only one invoice
-        if ($order->hasInvoice() && null === $command->getOrderInvoiceId()) {
-            $orderInvoice = new OrderInvoice($command->getOrderInvoiceId());
+        if ($order->hasInvoice() && null !== $command->getOrderInvoiceId()) {
+            $orderInvoice = new OrderInvoice($command->getOrderInvoiceId()->getValue());
             if (!Validate::isLoadedObject($orderInvoice)) {
                 throw new OrderException('Can\'t load Order Invoice object');
             }
@@ -111,7 +111,7 @@ public function handle(AddCartRuleToOrderCommand $command)
                         );
                     }
                 } else {
-                    throw new OrderException('The discount value is invalid.');
+                    throw new OrderException('Percentage discount value cannot be higher than 100%.');
                 }
 
                 break;
@@ -215,7 +215,7 @@ public function handle(AddCartRuleToOrderCommand $command)
             $cartRuleObj = new CartRule();
             $cartRuleObj->date_from = date('Y-m-d H:i:s', strtotime('-1 hour', strtotime($order->date_add)));
             $cartRuleObj->date_to = date('Y-m-d H:i:s', strtotime('+1 hour'));
-            $cartRuleObj->name[Configuration::get('PS_LANG_DEFAULT')] = Tools::getValue('discount_name');
+            $cartRuleObj->name[Configuration::get('PS_LANG_DEFAULT')] = $command->getCartRuleName();
             $cartRuleObj->quantity = 0;
             $cartRuleObj->quantity_per_user = 1;
 

src/Adapter/Order/CommandHandler/UpdateProductInOrderHandler.php

@@ -33,6 +33,7 @@
 use OrderDetail;
 use OrderInvoice;
 use PrestaShop\PrestaShop\Adapter\Order\AbstractOrderHandler;
+use PrestaShop\PrestaShop\Core\Domain\Order\Exception\CannotEditDeliveredOrderProductException;
 use PrestaShop\PrestaShop\Core\Domain\Order\Product\Command\UpdateProductInOrderCommand;
 use PrestaShop\PrestaShop\Core\Domain\Order\Product\CommandHandler\UpdateProductInOrderHandlerInterface;
 use PrestaShop\PrestaShop\Core\Domain\Order\Exception\OrderException;
@@ -79,8 +80,8 @@ public function handle(UpdateProductInOrderCommand $command)
         $product_quantity = $command->getQuantity();
 
         // @todo: use https://github.com/PrestaShop/decimal for price computations
-        $product_price_tax_incl = Tools::ps_round(Tools::getValue('product_price_tax_incl'), 2);
-        $product_price_tax_excl = Tools::ps_round(Tools::getValue('product_price_tax_excl'), 2);
+        $product_price_tax_incl = Tools::ps_round($command->getPriceTaxIncluded(), 2);
+        $product_price_tax_excl = Tools::ps_round($command->getPriceTaxExcluded(), 2);
         $total_products_tax_incl = $product_price_tax_incl * $product_quantity;
         $total_products_tax_excl = $product_price_tax_excl * $product_quantity;
 
@@ -215,7 +216,7 @@ private function assertProductCanBeUpdated(
 
         // We can't edit a delivered order
         if ($order->hasBeenDelivered()) {
-            throw new OrderException('You cannot edit a delivered order.');
+            throw new CannotEditDeliveredOrderProductException('You cannot edit a delivered order.');
         }
 
         if (null !== $orderInvoice && $orderInvoice->id_order != $order->id) {
@@ -233,7 +234,7 @@ private function assertProductCanBeUpdated(
         }
 
         if (!is_array($command->getQuantity())
-            && !Validate::isUnsignedInt(Tools::getValue('product_quantity'))
+            && !Validate::isUnsignedInt($command->getQuantity())
         ) {
             throw new OrderException('Invalid quantity');
         }

src/Adapter/Order/QueryHandler/GetOrderForViewingHandler.php

@@ -51,6 +51,8 @@
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryHandler\GetOrderForViewingHandlerInterface;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderCarrierForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderCustomerForViewing;
+use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderDiscountForViewing;
+use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderDiscountsForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderDocumentForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderDocumentsForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderForViewing;
@@ -60,6 +62,7 @@
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderMessagesForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderPaymentForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderPaymentsForViewing;
+use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderPricesForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderProductForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderProductsForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderReturnForViewing;
@@ -122,16 +125,21 @@ public function handle(GetOrderForViewing $query): OrderForViewing
     {
         $order = $this->getOrder($query->getOrderId());
 
-        $taxMethod = $order->getTaxCalculationMethod() == PS_TAX_EXC ?
-            $this->translator->trans('Tax excluded', [], 'Admin.Global') :
-            $this->translator->trans('Tax included', [], 'Admin.Global');
+        $isTaxIncluded = $order->getTaxCalculationMethod() == PS_TAX_INC;
+
+        $taxMethod = $isTaxIncluded ?
+            $this->translator->trans('Tax included', [], 'Admin.Global') :
+            $this->translator->trans('Tax excluded', [], 'Admin.Global');
 
         return new OrderForViewing(
             (int) $order->id,
             (int) $order->id_currency,
             $order->reference,
             $taxMethod,
+            $isTaxIncluded,
             (bool) $order->valid,
+            $order->hasInvoice(),
+            $order->hasBeenDelivered(),
             $this->getOrderCustomer($order),
             $this->getOrderShippingAddress($order),
             $this->getOrderInvoiceAddress($order),
@@ -141,7 +149,9 @@ public function handle(GetOrderForViewing $query): OrderForViewing
             $this->getOrderShipping($order),
             $this->getOrderReturns($order),
             $this->getOrderPayments($order),
-            $this->getOrderMessages($order)
+            $this->getOrderMessages($order),
+            $this->getOrderPrices($order),
+            $this->getOrderDiscounts($order)
         );
     }
 
@@ -379,6 +389,7 @@ private function getOrderProducts(Order $order): OrderProductsForViewing
             $totalPriceFormatted = Tools::displayPrice($totalPrice, $currency);
 
             $productsForViewing[] = new OrderProductForViewing(
+                $product['id_order_detail'],
                 $product['product_id'],
                 $product['product_name'],
                 $product['reference'],
@@ -387,7 +398,9 @@ private function getOrderProducts(Order $order): OrderProductsForViewing
                 $unitPriceFormatted,
                 $totalPriceFormatted,
                 $product['current_stock'],
-                $this->imageTagSourceParser->parse($product['image_tag'])
+                $this->imageTagSourceParser->parse($product['image_tag']),
+                Tools::ps_round($product['unit_price_tax_excl'], 2),
+                Tools::ps_round($product['unit_price_tax_incl'], 2)
             );
         }
 
@@ -707,4 +720,72 @@ private function getOrderMessages(Order $order): OrderMessagesForViewing
 
         return new OrderMessagesForViewing($messages);
     }
+
+    private function getOrderPrices(Order $order): OrderPricesForViewing
+    {
+        $currency = new Currency($order->id_currency);
+        $customer = $order->getCustomer();
+
+        $isTaxExcluded = $order->getTaxCalculationMethod() == PS_TAX_EXC;
+
+        $shipping_refundable_tax_excl = $order->total_shipping_tax_excl;
+        $shipping_refundable_tax_incl = $order->total_shipping_tax_incl;
+        $slips = OrderSlip::getOrdersSlip($customer->id, $order->id);
+        foreach ($slips as $slip) {
+            $shipping_refundable_tax_excl -= $slip['total_shipping_tax_excl'];
+            $shipping_refundable_tax_incl -= $slip['total_shipping_tax_incl'];
+        }
+
+        if ($isTaxExcluded) {
+            $productsPrice = (float) $order->total_products;
+            $discountsAmount = (float) $order->total_discounts_tax_excl;
+            $wrappingPrice = (float) $order->total_wrapping_tax_excl;
+            $shippingPrice = (float) $order->total_shipping_tax_excl;
+            $shippingRefundable = max(0, $shipping_refundable_tax_excl);
+        } else {
+            $productsPrice = (float) $order->total_products_wt;
+            $discountsAmount = (float) $order->total_discounts_tax_incl;
+            $wrappingPrice = (float) $order->total_wrapping_tax_incl;
+            $shippingPrice = (float) $order->total_shipping_tax_incl;
+            $shippingRefundable = max(0, $shipping_refundable_tax_incl);
+        }
+
+        $taxesAmount = $order->total_paid_tax_incl - $order->total_paid_tax_excl;
+        $totalAmount = (float) $order->total_paid_tax_incl;
+
+        return new OrderPricesForViewing(
+            $productsPrice,
+            $discountsAmount,
+            $wrappingPrice,
+            $shippingPrice,
+            $shippingRefundable,
+            $taxesAmount,
+            $totalAmount,
+            Tools::displayPrice($productsPrice, $currency),
+            Tools::displayPrice($discountsAmount, $currency),
+            Tools::displayPrice($wrappingPrice, $currency),
+            Tools::displayPrice($shippingPrice, $currency),
+            Tools::displayPrice($shippingRefundable, $currency),
+            Tools::displayPrice($taxesAmount, $currency),
+            Tools::displayPrice($totalAmount, $currency)
+        );
+    }
+
+    private function getOrderDiscounts(Order $order): OrderDiscountsForViewing
+    {
+        $currency = new Currency($order->id_currency);
+        $discounts = $order->getCartRules();
+        $discountsForViewing = [];
+
+        foreach ($discounts as $discount) {
+            $discountsForViewing[] = new OrderDiscountForViewing(
+                (int) $discount['id_cart_rule'],
+                $discount['name'],
+                (float) $discount['value'],
+                Tools::displayPrice($discount['value'], $currency)
+            );
+        }
+
+        return new OrderDiscountsForViewing($discountsForViewing);
+    }
 }