1. Home
  2. Blogs
  3. Guy Schneerson's blog
  4. Working with Drupal commerce order total

Working with Drupal commerce order total

Thursday, April 24, 2014 - 17:03
Tags: e-commerceDrupal

The following gists shows a few approaches for working with Drupal commerce order totals.
All three examples retrieve the order total as two components Ex Vat and VAT:

The first example shows how to get nicely formatted amounts. This is easily done using two functions:
commerce_price_component_total() - Returns the total value and currency for the specified price component in a price array.
commerce_currency_format() - formats the amount with the correct localization and currency symbol

<?php
        // Get a nicely formatted amount for Ex VAT & Vat order totals.
        
        // Get the order wrapper
        $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
        
        // Order total.
        $order_total = $order_wrapper->commerce_order_total->value();
        
        // Get ex vat amount.
        $total_ex_vat = commerce_price_component_total($order_total , 'base_price');
        $total_ex_vat = commerce_currency_format($total_ex_vat['amount'], $total_ex_vat['currency_code']);
        
        // Get vat amount.
        $total_vat = commerce_price_component_total($order_total , 'tax|vat');
        $total_vat = commerce_currency_format($total_vat['amount'], $total_vat['currency_code']);
?>

However if you don't need the currency symbol things get a bit harder.
The following gist takes a simplistic approach and replaces commerce_currency_format() with commerce_currency_amount_to_decimal()
This works however it has two potential issues
1) The formatted amount does not include localized number formatting (decimal & thousands separators)
2) The number will not have any localized rounding (many countries round to the nearest 5c or 10 cent as those are the smallest coins they support)

<?php
        // Get unformatted amount for Ex VAT & Vat order totals.
        // This is not ideal as country specific rounding issues may result in inaccurate amounts (see next file for best appproach)

        // Get the order wrapper
        $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
        
        // Order total.
        $order_total = $order_wrapper->commerce_order_total->value();
        
        // Get ex vat amount.
        $total_ex_vat = commerce_price_component_total($order_total , 'base_price');
        $amount = commerce_currency_amount_to_decimal($total_ex_vat['amount'], $total_ex_vat['currency_code']);
        $total_ex_vat = $amount;


        // Get vat amount.
        $total_vat = commerce_price_component_total($order_total , 'tax|vat');
        $amount = commerce_currency_amount_to_decimal($total_vat['amount'], $total_vat['currency_code']);
        $total_vat = $amount;
?>

The third version solves this using the following functions:
commerce_currency_load() - Returns a currency array holding data about the currency format
commerce_currency_round() - this solves the rounding issue
number_format() - The PHP number formatting function that uses the currency array to get the number of decimal places and the decimal & thousands separator we retrieved using commerce_currency_load()

<?php
        // Get  unformatted amount for Ex VAT & Vat order totals with correct country specific rounding and formatting.

        // Get the order wrapper
        $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
        
        // Order total.
        $order_total = $order_wrapper->commerce_order_total->value();
        
        // Get ex vat amount.
        $total_ex_vat = commerce_price_component_total($order_total , 'base_price');
        // Get the decimal amount.
        $amount = commerce_currency_amount_to_decimal($total_ex_vat['amount'], $total_ex_vat['currency_code']);
        // Load the currency object.
        $currency = commerce_currency_load($total_ex_vat['currency_code']);
        // Round and format.
        $total_ex_vat = number_format(commerce_currency_round($amount, $currency), $currency['decimals'], $currency['decimal_separator'], $currency['thousands_separator']);

        // Get vat amount.
        $total_vat = commerce_price_component_total($order_total , 'tax|vat');
        // Get the decimal amount.
        $amount = commerce_currency_amount_to_decimal($total_vat['amount'], $total_vat['currency_code']);
        // Load the currency object.
        $currency = commerce_currency_load($total_vat['currency_code']);
        // Round and format.
        $total_vat = number_format(commerce_currency_round($amount, $currency), $currency['decimals'], $currency['decimal_separator'], $currency['thousands_separator']);

?>

Finally be aware that you have other low level functions that can be used to look at the total in other ways.
for example if you wanted to get the total of an order excluding delivery you can use the commerce_line_items_total() function that takes a line item type and can be used in the following way

<?php
commerce_line_items_total($order_wrapper->commerce_line_items, commerce_product_line_item_types()); 
?>

If you can think of other useful low level functions or higher level ones that can simplify the code above I would love your comments

Contact Details

Blue-Bag Ltd

  •  info [at] blue-bag.com
  •  Telephone: 0843 2894522
  •  Blue-Bag HQ:
          The Garage, Manor Farm
          Chilcompton, Radstock
          Somerset, BA3 4HP, United Kingdom
  •  Telephone: (+44) 01761 411542
  •  Blue-Bag Brighton:
          Unit 35 Level 6 North, New England House
          New England Street, Brighton
          BN1 4GH United Kingdom
  •  Telephone: (+44) 07944 938204
  • VAT GB 748125034
  • UK Company Reg: 3932829

Contact