Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Totals progress

This commit is contained in:
Mike Jolley 2017-07-24 17:21:08 +01:00
parent 45a9826a80
commit ee545e7793
3 changed files with 256 additions and 519 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
includes/class-wc-discounts.php
View File

@ -46,8 +46,9 @@ class WC_Discounts {
/** /**
* Constructor. * Constructor.
*/ */
public function __construct() { public function __construct( $items ) {
$this->precision = pow( 10, wc_get_price_decimals() ); $this->precision = pow( 10, wc_get_price_decimals() );
$this->set_items( $items );
} }
/** /**
@ -71,13 +72,13 @@ class WC_Discounts {
} }
/** /**
* Get all discount totals without precision. * Get all discount totals with precision.
* *
* @since 3.2.0 * @since 3.2.0
* @return array * @return array
*/ */
public function get_discounts() { public function get_discounts() {
return array_map( array( $this, 'remove_precision' ), $this->discounts ); return $this->discounts;
} }
/** /**
@ -117,43 +118,20 @@ class WC_Discounts {
* Set cart/order items which will be discounted. * Set cart/order items which will be discounted.
* *
* @since 3.2.0 * @since 3.2.0
* @param array $raw_items List of raw cart or order items. * @param array $items List items, normailised, by WC_Totals.
*/ */
public function set_items( $raw_items ) { public function set_items( $items ) {
$this->items = array(); $this->items = array();
$this->discounts = array(); $this->discounts = array();
$this->applied_coupons = array(); $this->applied_coupons = array();
if ( ! empty( $raw_items ) && is_array( $raw_items ) ) { if ( ! empty( $items ) && is_array( $items ) ) {
foreach ( $raw_items as $raw_item ) { $this->items = $items;
$item = (object) array( $this->discounts = array_fill_keys( array_keys( $items ), 0 );
'price' => 0, // Line price without discounts, in cents.
'quantity' => 0, // Line qty.
'product' => false,
);
if ( is_a( $raw_item, 'WC_Cart_Item' ) ) {
//$item->quantity = $raw_item->get_quantity();
//$item->price = $raw_item->get_price() * $raw_item->get_quantity();
//$item->is_taxable = $raw_item->is_taxable();
//$item->tax_class = $raw_item->get_tax_class();
// @todo
} elseif ( is_a( $raw_item, 'WC_Order_Item_Product' ) ) {
$item->key = $raw_item->get_id();
$item->quantity = $raw_item->get_quantity();
$item->price = $raw_item->get_subtotal() * $this->precision;
$item->product = $raw_item->get_product();
} else {
$item->key = $raw_item['key'];
$item->quantity = $raw_item['quantity'];
$item->price = $raw_item['data']->get_price() * $this->precision * $raw_item['quantity'];
$item->product = $raw_item['data'];
}
$this->items[ $item->key ] = $item;
$this->discounts[ $item->key ] = 0;
} }
uasort( $this->items, array( $this, 'sort_by_price' ) ); uasort( $this->items, array( $this, 'sort_by_price' ) );
} }
}
/** /**
* Apply a discount to all items using a coupon. * Apply a discount to all items using a coupon.

691
includes/class-wc-totals.php
View File

@ -13,44 +13,34 @@ if ( ! defined( 'ABSPATH' ) ) {
*/ */
class WC_Totals { class WC_Totals {
/**
* Reference to cart or order object.
*
* @since 3.2.0
* @var array
*/
protected $object;
/** /**
* Line items to calculate. * Line items to calculate.
* *
* @since 3.2.0
* @var array * @var array
*/ */
protected $items = array(); protected $items = array(); // @todo ?
/** /**
* Coupons to calculate. * Discount amounts in cents after calculation.
*
* @var array
*/
protected $coupons = array();
/**
* Discounts to calculate.
* *
* @since 3.2.0
* @var array * @var array
*/ */
protected $discounts = array(); protected $discounts = array();
/**
* Fees to calculate.
*
* @var array
*/
protected $fees = array();
/**
* Shipping to calculate.
*
* @var array
*/
protected $shipping = array();
/** /**
* Stores totals. * Stores totals.
* *
* @since 3.2.0
* @var array * @var array
*/ */
protected $totals = array( protected $totals = array(
@ -60,51 +50,75 @@ class WC_Totals {
'items_subtotal_tax' => 0, 'items_subtotal_tax' => 0,
'items_total' => 0, 'items_total' => 0,
'items_total_tax' => 0, 'items_total_tax' => 0,
'item_totals' => array(),
'total' => 0, 'total' => 0,
'taxes' => array(), 'taxes' => array(),
'tax_total' => 0, 'tax_total' => 0,
'shipping_total' => 0, 'shipping_total' => 0,
'shipping_tax_total' => 0, 'shipping_tax_total' => 0,
'discounts_total' => 0,
'discounts_tax_total' => 0,
); );
/** /**
* Precision so we can work in cents. * Precision so we can work in cents.
* *
* @since 3.2.0
* @var int * @var int
*/ */
protected $precision = 1; protected $precision = 1;
/** /**
* Sets up the items provided, and calculate totals. * Sets up the items provided, and calculate totals.
*
* @since 3.2.0
*/ */
public function __construct( $cart = null ) { public function __construct( &$cart = null ) {
$this->precision = pow( 10, wc_get_price_decimals() ); $this->precision = pow( 10, wc_get_price_decimals() );
$this->set_cart( $cart ); $this->object = $cart;
$this->set_items();
$this->calculate(); $this->calculate();
} }
/** /**
* Hadnles a cart or order object passed in for calculation. Normalises data. * Handles a cart or order object passed in for calculation. Normalises data.
*
* @since 3.2.0
*/ */
protected function set_cart( $cart ) { protected function set_items() {
if ( is_a( $cart, 'WC_Cart' ) ) { if ( is_a( $this->object, 'WC_Cart' ) ) {
foreach ( $this->object->get_cart() as $cart_item_key => $cart_item ) {
$item = $this->get_default_item_props();
$item->key = $cart_item_key;
$item->quantity = $cart_item['quantity'];
$item->price = $cart_item['data']->get_price() * $this->precision * $cart_item['quantity'];
$item->product = $cart_item['data'];
$this->items[ $cart_item_key ] = $item;
}
} }
} }
/** /**
* Remove precision from a price. * Remove precision from a price.
* *
* @since 3.2.0
* @param int $value * @param int $value
* @return float * @return float
*/ */
protected function remove_precision( $value ) { protected function remove_precision( $value ) {
return wc_format_decimal( $value / $this->precision, wc_get_price_decimals() ); if ( is_array( $value ) ) {
foreach ( $value as $key => $subvalue ) {
$value[ $key ] = $this->remove_precision( $subvalue );
}
} else {
$value = wc_format_decimal( $value / $this->precision, wc_get_price_decimals() );
}
return $value;
} }
/** /**
* Get default blank set of props used per item. * Get default blank set of props used per item.
*
* @since 3.2.0
* @return array * @return array
*/ */
protected function get_default_item_props() { protected function get_default_item_props() {
@ -120,60 +134,13 @@ class WC_Totals {
); );
} }
/**
* Get default blank set of props used per coupon.
* @return array
*/
protected function get_default_coupon_props() {
return (object) array(
'count' => 0,
'total' => 0,
'total_tax' => 0,
'object' => false,
);
}
/**
* Get default blank set of props used per fee.
* @return array
*/
protected function get_default_fee_props() {
return (object) array(
'total_tax' => 0,
'taxes' => array(),
);
}
/**
* Get default blank set of props used per shipping row.
* @return array
*/
protected function get_default_shipping_props() {
return (object) array(
'total' => 0,
'total_tax' => 0,
'taxes' => array(),
);
}
/**
* Sort items by the subtotal.
*
* @param object $a
* @param object $b
* @return int
*/
protected function sort_items_callback( $a, $b ) {
$b->subtotal = isset( $a->subtotal ) ? $a->subtotal : 0;
$b->subtotal = isset( $b->subtotal ) ? $b->subtotal : 0;
return $b->subtotal === $b->subtotal ? 0 : ( $b->subtotal < $b->subtotal ? 1 : -1 );
}
/** /**
* Only ran if woocommerce_adjust_non_base_location_prices is true. * Only ran if woocommerce_adjust_non_base_location_prices is true.
* *
* If the customer is outside of the base location, this removes the base * If the customer is outside of the base location, this removes the base
* taxes. This is off by default unless the filter is used. * taxes. This is off by default unless the filter is used.
*
* @since 3.2.0
*/ */
protected function adjust_non_base_location_price( $item ) { protected function adjust_non_base_location_price( $item ) {
$base_tax_rates = WC_Tax::get_base_tax_rates( $item->product->tax_class ); $base_tax_rates = WC_Tax::get_base_tax_rates( $item->product->tax_class );
@ -190,6 +157,126 @@ class WC_Totals {
return $item; return $item;
} }
/**
* Get discounted price of an item with precision (in cents).
*
* @since 3.2.0
* @param object $item
* @return int
*/
protected function get_discounted_price_in_cents( $item ) {
return $item->price - $this->totals['discounts'][ $item->key ];
}
/**
* Get tax rates for an item. Caches rates in class to avoid multiple look ups.
*
* @param object $item
* @return array of taxes
*/
protected function get_item_tax_rates( $item ) {
$tax_class = $item->product->get_tax_class();
return isset( $this->item_tax_rates[ $tax_class ] ) ? $this->item_tax_rates[ $tax_class ] : $this->item_tax_rates[ $tax_class ] = WC_Tax::get_rates( $item->product->get_tax_class() );
}
/**
* Return array of coupon objects from the cart or an order.
*
* @since 3.2.0
* @return array
*/
protected function get_coupons() {
if ( is_a( $this->object, 'WC_Cart' ) ) {
return $this->object->get_coupons();
}
}
/**
* Return array of shipping costs.
*
* @since 3.2.0
* @return array
*/
protected function get_shipping() {
// @todo get this somehow. Where does calc occur?
return array();
}
protected function get_discounts() {
// @todo fee style API for discounts in cart/checkout.
return array();
}
protected function get_fees() {
// @todo where should fee api be located? New class?
return array();
}
/**
* Get a single total with or without precision (in cents).
*
* @since 3.2.0
* @param string $key Total to get.
* @param bool $in_cents
* @return int|float
*/
public function get_total( $key = 'total', $in_cents = false ) {
$totals = $this->get_totals( $in_cents );
return isset( $totals[ $key ] ) ? $totals[ $key ] : 0;
}
/**
* Set a single total.
*
* @since 3.2.0
* @param string $key
* @param int $total
*/
protected function set_total( $key = 'total', $total ) {
$this->totals[ $key ] = $total;
}
/**
* Get all totals with or without precision (in cents).
*
* @since 3.2.0
* @param $in_cents bool
* @return array.
*/
public function get_totals( $in_cents = false ) {
return $in_cents ? $this->totals : array_map( array( $this, 'remove_precision' ), $this->totals );
}
/**
* Get all tax rows from items (including shipping and product line items).
*
* @todo consider an item object instead of array here
*
* @since 3.2.0
* @return array
*/
protected function get_merged_taxes() {
$taxes = array();
foreach ( $this->items as $item ) {
foreach ( $item->taxes as $rate_id => $rate ) {
if ( ! isset( $taxes[ $rate_id ] ) ) {
$taxes[ $rate_id ] = array( 'tax_total' => 0, 'shipping_tax_total' => 0 );
}
$taxes[ $rate_id ]['tax_total'] = $taxes[ $rate_id ]['tax_total'] + $rate;
}
}
foreach ( $this->get_shipping() as $item ) {
foreach ( $item->taxes as $rate_id => $rate ) {
if ( ! isset( $taxes[ $rate_id ] ) ) {
$taxes[ $rate_id ] = array( 'tax_total' => 0, 'shipping_tax_total' => 0 );
}
$taxes[ $rate_id ]['shipping_tax_total'] = $taxes[ $rate_id ]['shipping_tax_total'] + $rate;
}
}
return $taxes;
}
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Calculation methods. | Calculation methods.
@ -199,14 +286,11 @@ class WC_Totals {
/** /**
* Run all calculations methods on the given items. * Run all calculations methods on the given items.
* *
* @uses WC_Totals::calculate_item_subtotals * @since 3.2.0
* @uses WC_Totals::calculate_item_totals
* @uses WC_Totals::calculate_fee_totals
* @uses WC_Totals::calculate_shipping_totals
* @uses WC_Totals::calculate_totals
*/ */
protected function calculate() { protected function calculate() {
$this->calculate_item_subtotals(); $this->calculate_item_subtotals();
$this->calculate_discounts();
$this->calculate_item_totals(); $this->calculate_item_totals();
$this->calculate_fee_totals(); $this->calculate_fee_totals();
$this->calculate_shipping_totals(); $this->calculate_shipping_totals();
@ -224,18 +308,19 @@ class WC_Totals {
* afterwards. * afterwards.
* *
* e.g. $100 bike with $10 coupon = customer pays $90 and tax worked backwards from that. * e.g. $100 bike with $10 coupon = customer pays $90 and tax worked backwards from that.
*
* @since 3.2.0
*/ */
protected function calculate_item_subtotals() { protected function calculate_item_subtotals() {
foreach ( $this->items as $item ) { foreach ( $this->items as $item ) {
$item->subtotal = $item->price * $item->quantity;
$item->subtotal_tax = 0;
if ( $item->price_includes_tax && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) { if ( $item->price_includes_tax && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
$item = $this->adjust_non_base_location_price( $item ); $item = $this->adjust_non_base_location_price( $item );
$item->subtotal = $item->price * $item->quantity;
} }
if ( $this->wc_tax_enabled() && $item->product->is_taxable() ) { $item->subtotal = $item->price;
$item->subtotal_tax = 0;
if ( wc_tax_enabled() && $item->product->is_taxable() ) {
$item->subtotal_taxes = WC_Tax::calc_tax( $item->subtotal, $this->get_item_tax_rates( $item ), $item->price_includes_tax ); $item->subtotal_taxes = WC_Tax::calc_tax( $item->subtotal, $this->get_item_tax_rates( $item ), $item->price_includes_tax );
$item->subtotal_tax = array_sum( $item->subtotal_taxes ); $item->subtotal_tax = array_sum( $item->subtotal_taxes );
@ -244,31 +329,47 @@ class WC_Totals {
} }
} }
} }
uasort( $this->items, array( $this, 'sort_items_callback' ) ); $this->set_total( 'items_subtotal', array_sum( array_values( wp_list_pluck( $this->items, 'subtotal' ) ) ) );
$this->set_items_subtotal( array_sum( array_values( wp_list_pluck( $this->items, 'subtotal' ) ) ) ); $this->set_total( 'items_subtotal_tax', array_sum( array_values( wp_list_pluck( $this->items, 'subtotal_tax' ) ) ) );
$this->set_items_subtotal_tax( array_sum( array_values( wp_list_pluck( $this->items, 'subtotal_tax' ) ) ) ); }
/**
* Calculate all discount and coupon amounts.
*
* @since 3.2.0
* @uses WC_Discounts class.
*/
protected function calculate_discounts() {
$discounts = new WC_Discounts( $this->items );
foreach ( $this->get_coupons() as $coupon ) {
$discounts->apply_coupon( $coupon );
}
foreach ( $this->get_discounts() as $discount ) {
//$discounts->apply_discount( $coupon ); @todo
}
$this->totals['discounts'] = $discounts->get_discounts();
$this->totals['discounts_total'] = array_sum( $this->totals['discounts'] );
// $this->totals['discounts_tax_total'] = $value;
/*$this->set_coupon_totals( wp_list_pluck( $this->coupons, 'total' ) );
//$this->set_coupon_tax_totals( wp_list_pluck( $this->coupons, 'total_tax' ) );
//$this->set_coupon_counts( wp_list_pluck( $this->coupons, 'count' ) );*/
} }
/** /**
* Totals are costs after discounts. * Totals are costs after discounts.
*
* @since 3.2.0
*/ */
protected function calculate_item_totals() { protected function calculate_item_totals() {
foreach ( $this->items as $item ) { foreach ( $this->items as $item ) {
$item->total = $this->get_discounted_price_in_cents( $item );
// ! @todo
//$item->discounted_price = $this->get_discounted_price( $item );
$item->total = $item->discounted_price * $item->quantity;
$item->total_tax = 0; $item->total_tax = 0;
if ( $this->wc_tax_enabled() && $item->product->is_taxable() ) { if ( wc_tax_enabled() && $item->product->is_taxable() ) {
$item->taxes = WC_Tax::calc_tax( $item->total, $this->get_item_tax_rates( $item ), $item->price_includes_tax ); $item->taxes = WC_Tax::calc_tax( $item->total, $this->get_item_tax_rates( $item ), $item->price_includes_tax );
$item->total_tax = array_sum( $item->taxes ); $item->total_tax = array_sum( $item->taxes );
@ -279,392 +380,52 @@ class WC_Totals {
} }
} }
} }
$this->set_items_total( array_sum( array_values( wp_list_pluck( $this->items, 'total' ) ) ) ); $this->set_total( 'items_total', array_sum( array_values( wp_list_pluck( $this->items, 'total' ) ) ) );
$this->set_items_total_tax( array_sum( array_values( wp_list_pluck( $this->items, 'total_tax' ) ) ) ); $this->set_total( 'items_total_tax', array_sum( array_values( wp_list_pluck( $this->items, 'total_tax' ) ) ) );
//$this->set_coupon_totals( wp_list_pluck( $this->coupons, 'total' ) );
//$this->set_coupon_tax_totals( wp_list_pluck( $this->coupons, 'total_tax' ) );
//$this->set_coupon_counts( wp_list_pluck( $this->coupons, 'count' ) );
//$this->set_item_totals( $this->items );
} }
/** /**
* Calculate any fees taxes. * Calculate any fees taxes.
*
* @since 3.2.0
*/ */
protected function calculate_fee_totals() { protected function calculate_fee_totals() {
if ( ! empty( $this->fees ) ) { foreach ( $this->get_fees() as $fee_key => $fee ) {
foreach ( $this->fees as $fee_key => $fee ) { if ( wc_tax_enabled() && $fee->taxable ) {
if ( $this->wc_tax_enabled() && $fee->taxable ) {
$fee->taxes = WC_Tax::calc_tax( $fee->total, $tax_rates, false ); $fee->taxes = WC_Tax::calc_tax( $fee->total, $tax_rates, false );
$fee->total_tax = array_sum( $fee->taxes ); $fee->total_tax = array_sum( $fee->taxes );
} }
} }
} }
$this->set_fees_total( array_sum( array_values( wp_list_pluck( $this->fees, 'total' ) ) ) );
$this->set_fees_total_tax( array_sum( array_values( wp_list_pluck( $this->fees, 'total_tax' ) ) ) );
}
/** /**
* Calculate any shipping taxes. * Calculate any shipping taxes.
*
* @since 3.2.0
*/ */
protected function calculate_shipping_totals() { protected function calculate_shipping_totals() {
//$this->set_shipping_total( array_sum( array_values( wp_list_pluck( $this->shipping, 'total' ) ) ) );
} }
/** /**
* Main cart totals. * Main cart totals.
*/
protected function calculate_totals() {
$this->set_shipping_total( array_sum( array_values( wp_list_pluck( $this->shipping, 'total' ) ) ) );
$this->set_taxes( $this->get_merged_taxes() );
// Total up/round taxes and shipping taxes
if ( 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' ) ) {
$this->set_tax_total( WC_Tax::get_tax_total( wc_list_pluck( $this->get_taxes(), 'get_tax_total' ) ) );
$this->set_shipping_tax_total( WC_Tax::get_tax_total( wc_list_pluck( $this->get_taxes(), 'get_shipping_tax_total' ) ) );
} else {
$this->set_tax_total( array_sum( wc_list_pluck( $this->get_taxes(), 'get_tax_total' ) ) );
$this->set_shipping_tax_total( array_sum( wc_list_pluck( $this->get_taxes(), 'get_shipping_tax_total' ) ) );
}
// Allow plugins to hook and alter totals before final total is calculated
do_action( 'woocommerce_calculate_totals', WC()->cart );
// Grand Total - Discounted product prices, discounted tax, shipping cost + tax
$this->set_total( apply_filters( 'woocommerce_calculated_total', round( $this->get_items_total() + $this->get_fees_total() + $this->get_shipping_total() + $this->get_tax_total() + $this->get_shipping_tax_total(), wc_get_price_decimals() ), WC()->cart ) );
}
/*
|--------------------------------------------------------------------------
| Setters.
|--------------------------------------------------------------------------
*/
/**
* Set cart/order items which will be discounted.
* *
* @since 3.2.0 * @since 3.2.0
* @param array $raw_items List of raw cart or order items.
*/ */
protected function set_items( $raw_items ) { protected function calculate_totals() {
$this->items = array(); $this->set_total( 'taxes', $this->get_merged_taxes() );
$this->set_total( 'tax_total', array_sum( wp_list_pluck( $this->get_total( 'taxes', true ), 'tax_total' ) ) );
$this->set_total( 'shipping_tax_total', array_sum( wp_list_pluck( $this->get_total( 'taxes', true ), 'shipping_tax_total' ) ) );
if ( ! empty( $raw_items ) && is_array( $raw_items ) ) { //$this->set_fees_total( array_sum( array_values( wp_list_pluck( $this->fees, 'total' ) ) ) );
foreach ( $raw_items as $raw_item ) { //$this->set_fees_total_tax( array_sum( array_values( wp_list_pluck( $this->fees, 'total_tax' ) ) ) );
$item = (object) array(
'price' => 0, // Line price without discounts, in cents.
'quantity' => 0, // Line qty.
'product' => false,
);
if ( is_a( $raw_item, 'WC_Cart_Item' ) ) {
//$item->quantity = $raw_item->get_quantity();
//$item->price = $raw_item->get_price() * $raw_item->get_quantity();
//$item->is_taxable = $raw_item->is_taxable();
//$item->tax_class = $raw_item->get_tax_class();
// @todo
} elseif ( is_a( $raw_item, 'WC_Order_Item_Product' ) ) {
$item->key = $raw_item->get_id();
$item->quantity = $raw_item->get_quantity();
$item->price = $raw_item->get_subtotal() * $this->precision;
$item->product = $raw_item->get_product();
} else {
$item->key = $raw_item['key'];
$item->quantity = $raw_item['quantity'];
$item->price = $raw_item['data']->get_price() * $this->precision * $raw_item['quantity'];
$item->product = $raw_item['data'];
}
$this->items[ $item->key ] = $item;
}
}
}
/**
* Set coupons.
* @param array $coupons
*/
protected function set_coupons( $coupons ) {
foreach ( $coupons as $code => $coupon_object ) {
$coupon = $this->get_default_coupon_props();
$coupon->coupon = $coupon_object;
$this->coupons[ $code ] = $coupon;
}
}
/** $this->set_total( 'total', round( $this->get_total( 'items_total', true ) + $this->get_total( 'fees_total', true ) + $this->get_total( 'shipping_total', true ) + $this->get_total( 'tax_total', true ) + $this->get_total( 'shipping_tax_total', true ) ) );
* Set fees.
* @param array $fees
*/
protected function set_fees( $fees ) {
foreach ( $fees as $fee_key => $fee_object ) {
$fee = $this->get_default_fee_props();
$fee->total = $fee_object->amount;
$fee->taxable = $fee_object->taxable;
$fee->tax_class = $fee_object->tax_class;
$this->fees[ $fee_key ] = $fee;
}
}
/**
* Set shipping lines.
* @param array
*/
protected function set_shipping( $shipping_objects ) {
$this->shipping = array();
if ( is_array( $shipping_objects ) ) { // @todo woocommerce_tax_round_at_subtotal option - how should we handle this with precision?
foreach ( $shipping_objects as $key => $shipping_object ) { // @todo woocommerce_calculate_totals action for carts.
$shipping = $this->get_default_shipping_props(); // @todo woocommerce_calculated_total filter for carts.
$shipping->total = $shipping_object->cost;
$shipping->taxes = $shipping_object->taxes;
$shipping->total_tax = array_sum( $shipping_object->taxes );
$this->shipping[ $key ] = $shipping;
}
}
}
/**
* Set taxes.
* @param array $value
*/
protected function set_taxes( $value ) {
$this->totals['taxes'] = $value;
}
/**
* Set tax total.
* @param float $value
*/
protected function set_tax_total( $value ) {
$this->totals['tax_total'] = $value;
}
/**
* Set shipping total.
* @param float $value
*/
protected function set_shipping_total( $value ) {
$this->totals['shipping_total'] = $value;
}
/**
* Set shipping tax total.
* @param float $value
*/
protected function set_shipping_tax_total( $value ) {
$this->totals['shipping_tax_total'] = $value;
}
/**
* Set item totals.
* @param array $value
*/
protected function set_item_totals( $value ) {
$this->totals['item_totals'] = $value;
}
/**
* Set items subtotal.
* @param float $value
*/
protected function set_items_subtotal( $value ) {
$this->totals['items_subtotal'] = $value;
}
/**
* Set items subtotal tax.
* @param float $value
*/
protected function set_items_subtotal_tax( $value ) {
$this->totals['items_subtotal_tax'] = $value;
}
/**
* Set items total.
* @param float $value
*/
protected function set_items_total( $value ) {
$this->totals['items_total'] = $value;
}
/**
* Set items total tax.
* @param float $value
*/
protected function set_items_total_tax( $value ) {
$this->totals['items_total_tax'] = $value;
}
/**
* Set fees total.
* @param float $value
*/
protected function set_fees_total( $value ) {
$this->totals['fees_total'] = $value;
}
/**
* Set fees total tax.
* @param float $value
*/
protected function set_fees_total_tax( $value ) {
$this->totals['fees_total_tax'] = $value;
}
/**
* Set total.
* @param float $value
*/
protected function set_total( $value ) {
$this->totals['total'] = max( 0, $value );
}
/*
|--------------------------------------------------------------------------
| Getters.
|--------------------------------------------------------------------------
*/
/**
* Get all totals.
* @return array.
*/
public function get_totals() {
return $this->totals;
}
/**
* Get shipping and item taxes.
* @return array
*/
public function get_taxes() {
return $this->totals['taxes'];
}
/**
* Get tax total.
* @return float
*/
public function get_tax_total() {
return $this->totals['tax_total'];
}
/**
* Get shipping total.
* @return float
*/
public function get_shipping_total() {
return $this->totals['shipping_total'];
}
/**
* Get shipping tax total.
* @return float
*/
public function get_shipping_tax_total() {
return $this->totals['shipping_tax_total'];
}
/**
* Get the items subtotal.
* @return float
*/
public function get_items_subtotal() {
return $this->totals['items_subtotal'];
}
/**
* Get the items subtotal tax.
* @return float
*/
public function get_items_subtotal_tax() {
return $this->totals['items_subtotal_tax'];
}
/**
* Get the items total.
* @return float
*/
public function get_items_total() {
return $this->totals['items_total'];
}
/**
* Get the items total tax.
* @return float
*/
public function get_items_total_tax() {
return $this->totals['items_total_tax'];
}
/**
* Get the total fees amount.
* @return float
*/
public function get_fees_total() {
return $this->totals['fees_total'];
}
/**
* Get the total fee tax amount.
* @return float
*/
public function get_fees_total_tax() {
return $this->totals['fees_total_tax'];
}
/**
* Get the total.
* @return float
*/
public function get_total() {
return $this->totals['total'];
}
/**
* Returns an array of item totals.
* @return array
*/
public function get_item_totals() {
return $this->totals['item_totals'];
}
/**
* Get tax rates for an item. Caches rates in class to avoid multiple look ups.
* @param object $item
* @return array of taxes
*/
protected function get_item_tax_rates( $item ) {
$tax_class = $item->product->get_tax_class();
return isset( $this->item_tax_rates[ $tax_class ] ) ? $this->item_tax_rates[ $tax_class ] : $this->item_tax_rates[ $tax_class ] = WC_Tax::get_rates( $item->product->get_tax_class() );
}
/**
* Get all tax rows for a set of items and shipping methods.
* @return array
*/
protected function get_merged_taxes() {
$taxes = array();
foreach ( $this->items as $item ) {
foreach ( $item->taxes as $rate_id => $rate ) {
if ( ! isset( $taxes[ $rate_id ] ) ) {
$taxes[ $rate_id ] = new WC_Item_Tax();
}
$taxes[ $rate_id ]->set_rate( $rate_id );
$taxes[ $rate_id ]->set_tax_total( $taxes[ $rate_id ]->get_tax_total() + $rate );
}
}
foreach ( $this->shipping as $item ) {
foreach ( $item->taxes as $rate_id => $rate ) {
if ( ! isset( $taxes[ $rate_id ] ) ) {
$taxes[ $rate_id ] = new WC_Item_Tax();
}
$taxes[ $rate_id ]->set_rate( $rate_id );
$taxes[ $rate_id ]->set_shipping_tax_total( $taxes[ $rate_id ]->get_shipping_tax_total() + $rate );
}
}
return $taxes;
} }
} }

34
tests/unit-tests/totals/totals.php
View File

@ -51,7 +51,7 @@ class WC_Tests_Totals extends WC_Unit_Test_Case {
WC()->cart->add_fee( "test fee", 10, true ); WC()->cart->add_fee( "test fee", 10, true );
WC()->cart->add_fee( "test fee 2", 20, true ); WC()->cart->add_fee( "test fee 2", 20, true );
WC()->cart->add_fee( "test fee non-taxable", 10, false ); WC()->cart->add_fee( "test fee non-taxable", 10, false );
WC()->cart->add_discount( 'test-coupon-10' ); WC()->cart->add_discount( $coupon->get_code() );
// @todo manual discounts // @todo manual discounts
$this->totals = new WC_Totals( WC()->cart ); $this->totals = new WC_Totals( WC()->cart );
@ -81,22 +81,20 @@ class WC_Tests_Totals extends WC_Unit_Test_Case {
* Test get and set items. * Test get and set items.
*/ */
public function test_get_totals() { public function test_get_totals() {
$this->assertEquals( array(), $this->totals->get_totals() ); $this->assertEquals( array(
'fees_total' => 40.00,
'fees_total_tax' => 6.00,
'items_subtotal' => 30.00,
'items_subtotal_tax' => 6.00,
'items_total' => 27.00,
'items_total_tax' => 5.40,
'total' => 72.40,
'taxes' => array(), // @todo ?
'tax_total' => 11.40,
'shipping_total' => 0, // @todo ?
'shipping_tax_total' => 0, // @todo ?
'discounts_total' => 3.00,
'discounts_tax_total' => 0, // @todo ?
), $this->totals->get_totals() );
} }
/**
* Test get and set items.
*/
public function test_get_taxes() {
}
/**
* Test get and set items.
*/
public function test_get_tax_total() {
}
//... @todo test all public methods
} }