Removed redundant giftcard observer on core_block_abstract_to_html_after (#575)

fballiano · web-flow · commit 3d1b3c97f9e3 · 2026-02-21T11:03:24.000Z
diff --git a/.phpstorm.meta.php/models.meta.php b/.phpstorm.meta.php/models.meta.php
@@ -1530,7 +1530,6 @@
         'giftcard/resource_indexer_price' => \Maho_Giftcard_Model_Resource_Indexer_Price::class,
         'giftcard/total_creditmemo' => \Maho_Giftcard_Model_Total_Creditmemo::class,
         'giftcard/total_invoice' => \Maho_Giftcard_Model_Total_Invoice::class,
-        'giftcard/total_order' => \Maho_Giftcard_Model_Total_Order::class,
         'giftcard/total_quote' => \Maho_Giftcard_Model_Total_Quote::class,
         'giftcard_resource/giftcard' => \Maho_Giftcard_Model_Resource_Giftcard::class,
         'giftcard_resource/giftcard_collection' => \Maho_Giftcard_Model_Resource_Giftcard_Collection::class,
@@ -4257,7 +4256,6 @@
         'giftcard/resource_indexer_price' => \Maho_Giftcard_Model_Resource_Indexer_Price::class,
         'giftcard/total_creditmemo' => \Maho_Giftcard_Model_Total_Creditmemo::class,
         'giftcard/total_invoice' => \Maho_Giftcard_Model_Total_Invoice::class,
-        'giftcard/total_order' => \Maho_Giftcard_Model_Total_Order::class,
         'giftcard/total_quote' => \Maho_Giftcard_Model_Total_Quote::class,
         'giftcard_resource/giftcard' => \Maho_Giftcard_Model_Resource_Giftcard::class,
         'giftcard_resource/giftcard_collection' => \Maho_Giftcard_Model_Resource_Giftcard_Collection::class,
diff --git a/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Creditmemo/Totals/Giftcard.php b/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Creditmemo/Totals/Giftcard.php
@@ -68,15 +68,22 @@ public function initTotals()
 
         $baseGiftcardAmount = $source->getBaseGiftcardAmount() ?: ($order ? $order->getBaseGiftcardAmount() : 0);
 
-        // Add total after tax - show as positive since it's money going back to gift card
-        // Use a custom block_html to avoid it being summed into grand_total display
-        $parent->addTotal(new Maho\DataObject([
+        // Show as positive since it's money going back to gift card
+        // Add before grand_total
+        $parent->addTotalBefore(new Maho\DataObject([
             'code'       => 'giftcard',
             'value'      => abs((float) $giftcardAmount),
             'base_value' => abs((float) $baseGiftcardAmount),
             'label'      => $label,
             'is_formated' => false,
-        ]), 'tax');
+        ]), ['grand_total', 'base_grandtotal']);
+
+        // Ensure tax appears before giftcard
+        $taxTotal = $parent->getTotal('tax');
+        if ($taxTotal) {
+            $parent->removeTotal('tax');
+            $parent->addTotalBefore($taxTotal, 'giftcard');
+        }
 
         return $this;
     }
diff --git a/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Invoice/Totals/Giftcard.php b/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Invoice/Totals/Giftcard.php
@@ -71,13 +71,20 @@ public function initTotals()
             $baseGiftcardAmount = $order->getBaseGiftcardAmount();
         }
 
-        // Add total after tax
-        $parent->addTotal(new Maho\DataObject([
+        // Add before grand_total
+        $parent->addTotalBefore(new Maho\DataObject([
             'code'       => 'giftcard',
             'value'      => -abs((float) $giftcardAmount),
             'base_value' => -abs((float) $baseGiftcardAmount),
             'label'      => $label,
-        ]), 'tax');
+        ]), ['grand_total', 'base_grandtotal']);
+
+        // Ensure tax appears before giftcard
+        $taxTotal = $parent->getTotal('tax');
+        if ($taxTotal) {
+            $parent->removeTotal('tax');
+            $parent->addTotalBefore($taxTotal, 'giftcard');
+        }
 
         return $this;
     }
diff --git a/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Totals/Giftcard.php b/app/code/core/Maho/Giftcard/Block/Adminhtml/Sales/Order/Totals/Giftcard.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Maho
  *
@@ -33,7 +35,7 @@ public function initTotals()
 
         $giftcardAmount = $order->getGiftcardAmount();
 
-        if ($giftcardAmount != 0) {
+        if ((float) $giftcardAmount !== 0.0) {
             // Get gift card codes for display
             $codes = [];
             $giftcardCodes = $order->getGiftcardCodes();
@@ -49,13 +51,20 @@ public function initTotals()
                 $label .= ' (' . implode(', ', $codes) . ')';
             }
 
-            // Add after tax
-            $parent->addTotal(new Maho\DataObject([
+            // Add before grand_total
+            $parent->addTotalBefore(new Maho\DataObject([
                 'code'       => 'giftcard',
                 'value'      => -abs((float) $giftcardAmount),
                 'base_value' => -abs((float) $order->getBaseGiftcardAmount()),
                 'label'      => $label,
-            ]), 'tax');
+            ]), ['grand_total', 'base_grandtotal']);
+
+            // Ensure tax appears before giftcard
+            $taxTotal = $parent->getTotal('tax');
+            if ($taxTotal) {
+                $parent->removeTotal('tax');
+                $parent->addTotalBefore($taxTotal, 'giftcard');
+            }
         }
 
         return $this;
diff --git a/app/code/core/Maho/Giftcard/Model/Observer.php b/app/code/core/Maho/Giftcard/Model/Observer.php
@@ -98,7 +98,9 @@ protected function _createGiftcard(
 
         // Convert amount to base currency using order's conversion rate
         // Gift card amount is in order currency, need to convert to base currency
-        $baseAmount = $amount * $order->getBaseToOrderRate();
+        // base_to_order_rate converts base→order, so to go order→base we divide
+        $baseToOrderRate = (float) $order->getBaseToOrderRate();
+        $baseAmount = $baseToOrderRate > 0 ? $amount / $baseToOrderRate : $amount;
 
         $giftcard = Mage::getModel('giftcard/giftcard');
         $giftcard->setData([
@@ -304,15 +306,12 @@ public function applyGiftcardToOrder(Maho\Event\Observer $observer)
 
         if ($baseGiftcardAmount > 0) {
             // Set gift card amounts on order
+            // Grand total is already reduced during quote total collection
             $order->setBaseGiftcardAmount($baseGiftcardAmount);
             $order->setGiftcardAmount($giftcardAmount);
             if ($giftcardCodes) {
                 $order->setGiftcardCodes($giftcardCodes);
             }
-
-            // Reduce grand total by gift card amount
-            $order->setGrandTotal(max(0, $order->getGrandTotal() - $giftcardAmount));
-            $order->setBaseGrandTotal(max(0, $order->getBaseGrandTotal() - $baseGiftcardAmount));
         }
     }
 
@@ -375,17 +374,15 @@ public function deductGiftcardBalance(Maho\Event\Observer $observer)
             }
         }
 
-        // Set gift card amounts on order
+        // Set gift card amounts on order (codes/amounts may already be set
+        // by fieldset conversion + applyGiftcardToOrder, but ensure they're present)
         $order->setGiftcardCodes($giftcardCodes);
         $order->setBaseGiftcardAmount($baseGiftcardAmount);
         $order->setGiftcardAmount($giftcardAmount);
 
-        // Reduce grand total by gift card amount (if not already reduced)
-        $currentGrandTotal = (float) $order->getGrandTotal();
-        if ($giftcardAmount > 0 && $currentGrandTotal > 0) {
-            $order->setGrandTotal(max(0, $currentGrandTotal - $giftcardAmount));
-            $order->setBaseGrandTotal(max(0, (float) $order->getBaseGrandTotal() - $baseGiftcardAmount));
-        }
+        // Grand total is NOT modified here — it was already reduced during
+        // quote total collection via Total_Quote::collect() → _addAmount(-$amount)
+        // and carried over to the order during quote-to-order conversion.
 
         // Add gift card info to payment additional information for display in grid
         $payment = $order->getPayment();
@@ -494,63 +491,6 @@ public function deductGiftcardBalance(Maho\Event\Observer $observer)
         }
     }
 
-    /**
-     * Add gift card total to admin order view
-     *
-     * @return void
-     */
-    public function addGiftcardTotalToAdminOrder(Maho\Event\Observer $observer)
-    {
-        $block = $observer->getEvent()->getBlock();
-
-        // Check if this is an order totals block
-        if ($block->getNameInLayout() != 'order_totals') {
-            return;
-        }
-
-        $order = $block->getOrder();
-        if (!$order || !$order->getId()) {
-            return;
-        }
-
-        $giftcardAmount = $order->getGiftcardAmount();
-
-        if ($giftcardAmount != 0) {
-            // Get gift card codes for display
-            $codes = [];
-            $giftcardCodes = $order->getGiftcardCodes();
-            if ($giftcardCodes) {
-                $codesArray = json_decode($giftcardCodes, true);
-                if (is_array($codesArray)) {
-                    // Show partial codes for security
-                    foreach (array_keys($codesArray) as $code) {
-                        if (strlen($code) > 10) {
-                            $codes[] = substr($code, 0, 5) . '...' . substr($code, -4);
-                        } else {
-                            $codes[] = $code;
-                        }
-                    }
-                }
-            }
-
-            $label = Mage::helper('giftcard')->__('Gift Cards');
-            if ($codes !== []) {
-                $label .= ' (' . implode(', ', $codes) . ')';
-            }
-
-            $total = new Maho\DataObject([
-                'code'       => 'giftcard',
-                'value'      => -abs((float) $giftcardAmount),
-                'base_value' => -abs((float) $order->getBaseGiftcardAmount()),
-                'label'      => $label,
-                'strong'     => false,
-            ]);
-
-            // Add after tax, before grand_total
-            $block->addTotal($total, 'tax');
-        }
-    }
-
     /**
      * Refund gift card balance when credit memo is created
      *
diff --git a/app/code/core/Maho/Giftcard/Model/Total/Order.php b/app/code/core/Maho/Giftcard/Model/Total/Order.php
diff --git a/app/code/core/Maho/Giftcard/etc/config.xml b/app/code/core/Maho/Giftcard/etc/config.xml
@@ -15,15 +15,6 @@
                     </giftcard>
                 </totals>
             </quote>
-            <order>
-                <totals>
-                    <giftcard>
-                        <class>giftcard/total_order</class>
-                        <after>subtotal,shipping,discount,tax</after>
-                        <before>grand_total</before>
-                    </giftcard>
-                </totals>
-            </order>
         </sales>
 
         <models>
@@ -160,14 +151,6 @@
                     </giftcard_create_on_payment>
                 </observers>
             </sales_order_invoice_pay>
-            <core_block_abstract_to_html_after>
-                <observers>
-                    <giftcard_add_total_to_admin>
-                        <class>giftcard/observer</class>
-                        <method>addGiftcardTotalToAdminOrder</method>
-                    </giftcard_add_total_to_admin>
-                </observers>
-            </core_block_abstract_to_html_after>
             <sales_convert_quote_address_to_order>
                 <observers>
                     <giftcard_apply_to_order>
diff --git a/tests/Backend/Integration/Giftcard/Observer/OrderFlowTest.php b/tests/Backend/Integration/Giftcard/Observer/OrderFlowTest.php
