Order: helper method for nice formatting of Total in GridFields

See silvershop#811 Can be removed if Total() works like other DB Fields
wernerkrauss · Jan 2, 2024 · a828c33 · a828c33
1 parent 6882433
commit a828c33
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 2 deletions.
diff --git a/client/dist/css/shopcms.css b/client/dist/css/shopcms.css
diff --git a/lang/de.yml b/lang/de.yml
@@ -243,6 +243,7 @@ de:
     ShipTo: 'Lieferung an'
     SubTotal: Zwischensumme
     Total: Gesamt
+    TotalNice: Gesamt
     TotalOutstanding: 'Gesamt ausstehend'
     TotalPrice: 'Gesamtpreis'
     TotalPriceWithCurrency: 'Gesamtpreis ({Currency})'

diff --git a/lang/en.yml b/lang/en.yml
@@ -261,6 +261,7 @@ en:
     db_Status: Status
     db_Surname: Surname
     db_Total: Total
+    TotalNice: Total
     has_many_Items: Items
     has_many_Modifiers: Modifiers
     has_many_OrderStatusLogs: 'Order Status Logs'

diff --git a/lang/hr.yml b/lang/hr.yml
@@ -211,6 +211,7 @@ hr:
     ShipTo: 'Pošalji na'
     SubTotal: Međuzbroj
     Total: Ukupno
+    TotalNice: Ukupno
     TotalOutstanding: 'Ukupno nepodmireno'
     TotalPrice: 'Ukupna cijena'
     TotalPriceWithCurrency: 'Ukupna cijena ({Currency})'

diff --git a/lang/nb.yml b/lang/nb.yml
@@ -243,6 +243,7 @@ nb:
     ShipTo: 'Send til'
     SubTotal: Sum total
     Total: Pris
+    TotalNice: Pris
     TotalOutstanding: 'Total utestående'
     TotalPrice: 'Pris'
     TotalPriceWithCurrency: 'Pris  ({Currency})'

diff --git a/lang/nl.yml b/lang/nl.yml
@@ -243,6 +243,7 @@ nl:
     ShipTo: 'Verzend naar'
     SubTotal: Subtotaal
     Total: Totaal
+    TotalNice: Totaal
     TotalOutstanding: 'Totaal openstaand'
     TotalPrice: 'Totaalprijs'
     TotalPriceWithCurrency: 'Totaalprijs ({Currency})'

diff --git a/lang/nn.yml b/lang/nn.yml
@@ -241,6 +241,7 @@ nn:
     ShipTo: 'Send sending til:'
     SubTotal: Sum total
     Total: Total
+    TotalNice: Total
     TotalOutstanding: 'Total uteståande'
     TotalPrice: 'Total pris'
     TotalPriceWithCurrency: 'Total pris ({Currency})'

diff --git a/src/Model/Order.php b/src/Model/Order.php
@@ -142,7 +142,7 @@ class Order extends DataObject
         'Placed',
         'Name',
         'LatestEmail',
-        'Total',
+        'TotalNice',
         'StatusI18N',
     ];
 
@@ -343,6 +343,7 @@ public function fieldLabels($includerelations = true)
         $labels['Name'] = _t('SilverShop\Generic.Customer', 'Customer');
         $labels['LatestEmail'] = _t(__CLASS__ . '.db_Email', 'Email');
         $labels['StatusI18N'] = _t(__CLASS__ . '.db_Status', 'Status');
+        $labels['TotalNice'] = _t(__CLASS__ . '.TotalNice', 'Total');
 
         return $labels;
     }
@@ -482,6 +483,25 @@ public function GrandTotal()
         return $this->Total();
     }
 
+    /**
+     * Helper method for getting nice currency-formatted values.
+     *
+     * This is needed, cause Total() conflicts with casting to Currency.
+     * Related Issue: https://github.com/silvershop/silvershop-core/issues/811
+     *
+     * Can be deprecated and removed once the issue is resolved.
+     *
+     * @return string
+     */
+    public function TotalNice(): string
+    {
+        $total = $this->dbObject('Total');
+        if ($total instanceof DBCurrency) {
+            return $total->Nice();
+        }
+        return '';
+    }
+
     /**
      * Calculate how much is left to be paid on the order.
      * Enforces rounding precision.
@@ -518,7 +538,7 @@ public function getStatusI18N()
     public function Link()
     {
         $link = CheckoutPage::find_link(false, 'order', $this->ID);
-        
+
         if (Security::getCurrentUser()) {
             $link = Controller::join_links(AccountPage::find_link(), 'order', $this->ID);
         }