2014-06-13 13:35:53 +00:00
< ? php
2016-06-21 19:03:56 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ;
}
include_once ( 'abstract-wc-legacy-order.php' );
2014-06-13 13:35:53 +00:00
/**
2015-11-03 13:53:50 +00:00
* Abstract Order
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* Handles generic order data and database interaction which is extended by both
* WC_Order ( regular orders ) and WC_Order_Refund ( refunds are negative orders ) .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ class WC_Abstract_Order
* @ version 2.7 . 0
2014-08-31 05:49:58 +00:00
* @ package WooCommerce / Classes
* @ category Class
* @ author WooThemes
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order {
2015-01-20 12:07:33 +00:00
2016-06-21 19:03:56 +00:00
/**
2016-08-25 12:31:03 +00:00
* Order Data array . This is the core order data exposed in APIs since 2.7 . 0.
2016-06-21 19:03:56 +00:00
*
2016-08-24 11:34:19 +00:00
* Notes : cart_tax = cart_tax is the new name for the legacy 'order_tax'
* which is the tax for items only , not shipping .
2016-06-21 19:03:56 +00:00
* @ since 2.7 . 0
* @ var array
*/
2016-08-25 12:31:03 +00:00
protected $_data = array (
2016-06-21 19:03:56 +00:00
'id' => 0 ,
'parent_id' => 0 ,
2016-08-08 16:03:43 +00:00
'status' => '' ,
2016-06-21 19:03:56 +00:00
'currency' => '' ,
'version' => '' ,
'prices_include_tax' => false ,
'date_created' => '' ,
'date_modified' => '' ,
'discount_total' => 0 ,
'discount_tax' => 0 ,
'shipping_total' => 0 ,
'shipping_tax' => 0 ,
'cart_tax' => 0 ,
'total' => 0 ,
'total_tax' => 0 ,
);
2014-10-07 10:00:10 +00:00
2016-06-21 19:03:56 +00:00
/**
* Data stored in meta keys , but not considered " meta " for an order .
* @ since 2.7 . 0
* @ var array
*/
protected $_internal_meta_keys = array (
2016-08-27 03:04:10 +00:00
'_order_currency' ,
'_cart_discount' ,
'_cart_discount_tax' ,
'_order_shipping' ,
'_order_shipping_tax' ,
'_order_tax' ,
'_order_total' ,
'_order_version' ,
'_prices_include_tax' ,
2016-06-21 19:03:56 +00:00
'_payment_tokens' ,
);
2015-01-20 12:07:33 +00:00
2016-08-09 13:02:40 +00:00
/**
* Order items will be stored here , sometimes before they persist in the DB .
* @ since 2.7 . 0
* @ var array
*/
protected $_items = array (
'line_items' => null ,
'coupon_lines' => null ,
'shipping_lines' => null ,
'fee_lines' => null ,
'tax_lines' => null ,
);
2016-08-17 15:53:01 +00:00
/**
* Order items that need deleting are stored here .
* @ since 2.7 . 0
* @ var array
*/
protected $_items_to_delete = array ();
2016-06-21 19:03:56 +00:00
/**
* Internal meta type used to store order data .
* @ var string
*/
protected $_meta_type = 'post' ;
2015-01-20 12:07:33 +00:00
2016-06-21 19:03:56 +00:00
/**
* Stores meta in cache for future reads .
* A group must be set to to enable caching .
* @ var string
*/
protected $_cache_group = 'order' ;
2015-01-20 12:07:33 +00:00
2014-06-13 13:35:53 +00:00
/**
* Get the order if ID is passed , otherwise the order is new and empty .
2015-11-03 12:28:01 +00:00
* This class should NOT be instantiated , but the get_order function or new WC_Order_Factory .
* should be used . It is possible , but the aforementioned are preferred and are the only .
2014-06-14 21:36:20 +00:00
* methods that will be maintained going forward .
2015-01-20 13:20:22 +00:00
*
2016-08-25 12:31:03 +00:00
* @ param int | object | WC_Order $read Order to init .
2014-06-13 13:35:53 +00:00
*/
2016-08-25 12:31:03 +00:00
public function __construct ( $read = 0 ) {
parent :: __construct ( $read );
2016-08-24 13:37:19 +00:00
2016-08-25 12:31:03 +00:00
if ( is_numeric ( $read ) && $read > 0 ) {
$this -> read ( $read );
} elseif ( $read instanceof self ) {
$this -> read ( absint ( $read -> get_id () ) );
} elseif ( ! empty ( $read -> ID ) ) {
$this -> read ( absint ( $read -> ID ) );
2016-06-21 19:03:56 +00:00
}
2016-08-08 16:24:39 +00:00
// Set default status if none were read.
if ( ! $this -> get_status () ) {
$this -> set_status ( apply_filters ( 'woocommerce_default_order_status' , 'pending' ) );
}
2016-06-21 19:03:56 +00:00
}
/*
|--------------------------------------------------------------------------
| CRUD methods
|--------------------------------------------------------------------------
|
| Methods which create , read , update and delete orders from the database .
| Written in abstract fashion so that the way orders are stored can be
| changed more easily in the future .
|
| A save method is included for convenience ( chooses update or create based
| on if the order exists yet ) .
|
*/
/**
* Get internal type ( post type . )
* @ return string
*/
public function get_type () {
return 'shop_order' ;
2014-10-14 13:25:48 +00:00
}
2014-08-31 05:49:58 +00:00
2014-10-14 13:25:48 +00:00
/**
2016-06-21 19:03:56 +00:00
* Get a title for the new post type .
2014-10-14 13:25:48 +00:00
*/
2016-06-21 19:03:56 +00:00
protected function get_post_title () {
2016-09-01 20:50:14 +00:00
// @codingStandardsIgnoreStart
2016-06-21 19:03:56 +00:00
return sprintf ( __ ( 'Order – %s' , 'woocommerce' ), strftime ( _x ( '%b %d, %Y @ %I:%M %p' , 'Order date parsed by strftime' , 'woocommerce' ) ) );
2016-09-01 20:50:14 +00:00
// @codingStandardsIgnoreEnd
2014-06-13 13:35:53 +00:00
}
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Insert data into the database .
* @ since 2.7 . 0
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function create () {
$this -> set_date_created ( current_time ( 'timestamp' ) );
2016-08-22 10:00:31 +00:00
$this -> set_currency ( $this -> get_currency () ? $this -> get_currency () : get_woocommerce_currency () );
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
$order_id = wp_insert_post ( apply_filters ( 'woocommerce_new_order_data' , array (
'post_date' => date ( 'Y-m-d H:i:s' , $this -> get_date_created () ),
'post_date_gmt' => get_gmt_from_date ( date ( 'Y-m-d H:i:s' , $this -> get_date_created () ) ),
'post_type' => $this -> get_type (),
'post_status' => 'wc-' . ( $this -> get_status () ? $this -> get_status () : apply_filters ( 'woocommerce_default_order_status' , 'pending' ) ),
'ping_status' => 'closed' ,
'post_author' => 1 ,
'post_title' => $this -> get_post_title (),
'post_password' => uniqid ( 'order_' ),
'post_parent' => $this -> get_parent_id (),
) ), true );
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
if ( $order_id ) {
$this -> set_id ( $order_id );
// Set meta data
$this -> update_post_meta ( '_order_currency' , $this -> get_currency () );
$this -> update_post_meta ( '_cart_discount' , $this -> get_discount_total ( true ) );
$this -> update_post_meta ( '_cart_discount_tax' , $this -> get_discount_tax ( true ) );
$this -> update_post_meta ( '_order_shipping' , $this -> get_shipping_total ( true ) );
$this -> update_post_meta ( '_order_shipping_tax' , $this -> get_shipping_tax ( true ) );
$this -> update_post_meta ( '_order_tax' , $this -> get_cart_tax ( true ) );
$this -> update_post_meta ( '_order_total' , $this -> get_total ( true ) );
$this -> update_post_meta ( '_order_version' , $this -> get_version () );
$this -> update_post_meta ( '_prices_include_tax' , $this -> get_prices_include_tax () );
$this -> save_meta_data ();
}
2016-02-03 14:49:24 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Read from the database .
* @ since 2.7 . 0
* @ param int $id ID of object to read .
2016-02-03 14:49:24 +00:00
*/
2016-06-21 19:03:56 +00:00
public function read ( $id ) {
2016-08-24 11:34:19 +00:00
$this -> set_defaults ();
2016-06-21 19:03:56 +00:00
if ( empty ( $id ) || ! ( $post_object = get_post ( $id ) ) ) {
return ;
2016-02-03 14:49:24 +00:00
}
2016-06-21 19:03:56 +00:00
2016-08-25 12:05:27 +00:00
$this -> set_props ( array (
'id' => $post_object -> ID ,
'parent_id' => $post_object -> post_parent ,
'date_created' => $post_object -> post_date ,
'date_modified' => $post_object -> post_modified ,
'status' => $post_object -> post_status ,
'currency' => get_post_meta ( $this -> get_id (), '_order_currency' , true ),
'discount_total' => get_post_meta ( $this -> get_id (), '_cart_discount' , true ),
'discount_tax' => get_post_meta ( $this -> get_id (), '_cart_discount_tax' , true ),
'shipping_total' => get_post_meta ( $this -> get_id (), '_order_shipping' , true ),
'shipping_tax' => get_post_meta ( $this -> get_id (), '_order_shipping_tax' , true ),
'cart_tax' => get_post_meta ( $this -> get_id (), '_order_tax' , true ),
'total' => get_post_meta ( $this -> get_id (), '_order_total' , true ),
'version' => get_post_meta ( $this -> get_id (), '_order_version' , true ),
'prices_include_tax' => metadata_exists ( 'post' , $this -> get_id (), '_prices_include_tax' ) ? 'yes' === get_post_meta ( $this -> get_id (), '_prices_include_tax' , true ) : 'yes' === get_option ( 'woocommerce_prices_include_tax' ),
) );
2016-06-21 19:03:56 +00:00
$this -> read_meta_data ();
2016-02-03 14:49:24 +00:00
}
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Post meta update wrapper . Sets or deletes based on value .
* @ since 2.7 . 0
* @ return bool Was it changed ?
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
protected function update_post_meta ( $key , $value ) {
if ( '' !== $value ) {
return update_post_meta ( $this -> get_id (), $key , $value );
2016-06-07 13:02:02 +00:00
} else {
2016-06-21 19:03:56 +00:00
return delete_post_meta ( $this -> get_id (), $key );
2014-07-03 11:38:55 +00:00
}
}
/**
2016-06-21 19:03:56 +00:00
* Update data in the database .
* @ since 2.7 . 0
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function update () {
global $wpdb ;
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
$order_id = $this -> get_id ();
$wpdb -> update (
$wpdb -> posts ,
array (
'post_date' => date ( 'Y-m-d H:i:s' , $this -> get_date_created () ),
'post_date_gmt' => get_gmt_from_date ( date ( 'Y-m-d H:i:s' , $this -> get_date_created () ) ),
'post_status' => 'wc-' . ( $this -> get_status () ? $this -> get_status () : apply_filters ( 'woocommerce_default_order_status' , 'pending' ) ),
'post_parent' => $this -> get_parent_id (),
),
array (
2016-08-27 01:46:45 +00:00
'ID' => $order_id ,
2016-06-21 19:03:56 +00:00
)
);
// Update meta data
$this -> update_post_meta ( '_order_currency' , $this -> get_currency () );
$this -> update_post_meta ( '_cart_discount' , $this -> get_discount_total ( true ) );
$this -> update_post_meta ( '_cart_discount_tax' , $this -> get_discount_tax ( true ) );
$this -> update_post_meta ( '_order_shipping' , $this -> get_shipping_total ( true ) );
$this -> update_post_meta ( '_order_shipping_tax' , $this -> get_shipping_tax ( true ) );
$this -> update_post_meta ( '_order_tax' , $this -> get_cart_tax ( true ) );
$this -> update_post_meta ( '_order_total' , $this -> get_total ( true ) );
2016-08-22 12:04:57 +00:00
$this -> update_post_meta ( '_order_version' , $this -> get_version () );
2016-06-21 19:03:56 +00:00
$this -> update_post_meta ( '_prices_include_tax' , $this -> get_prices_include_tax () );
$this -> save_meta_data ();
2014-07-28 03:23:59 +00:00
}
2014-07-03 11:38:55 +00:00
2015-06-19 00:43:31 +00:00
/**
2016-06-21 19:03:56 +00:00
* Delete data from the database .
* @ since 2.7 . 0
2015-06-19 00:43:31 +00:00
*/
2016-06-21 19:03:56 +00:00
public function delete () {
wp_delete_post ( $this -> get_id () );
2015-06-19 00:43:31 +00:00
}
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Save data to the database .
* @ since 2.7 . 0
* @ return int order ID
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function save () {
$this -> set_version ( WC_VERSION );
2014-07-28 03:23:59 +00:00
2016-06-21 19:03:56 +00:00
if ( ! $this -> get_id () ) {
$this -> create ();
2014-07-19 04:08:02 +00:00
} else {
2016-06-21 19:03:56 +00:00
$this -> update ();
2014-07-19 04:08:02 +00:00
}
2016-08-09 13:02:40 +00:00
$this -> save_items ();
2016-06-21 19:03:56 +00:00
clean_post_cache ( $this -> get_id () );
wc_delete_shop_order_transients ( $this -> get_id () );
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
return $this -> get_id ();
}
2016-08-09 13:02:40 +00:00
/**
* Save all order items which are part of this order .
*/
protected function save_items () {
2016-08-17 15:53:01 +00:00
// remove items
foreach ( $this -> _items_to_delete as $item ) {
$item -> delete ();
}
$this -> _items_to_delete = array ();
// Add/save items
2016-08-09 13:02:40 +00:00
foreach ( $this -> _items as $item_group => $items ) {
2016-08-09 13:15:04 +00:00
if ( is_array ( $items ) ) {
foreach ( $items as $item_key => $item ) {
$item -> set_order_id ( $this -> get_id () );
$item_id = $item -> save ();
// If ID changed (new item saved to DB)...
if ( $item_id !== $item_key ) {
$this -> _items [ $item_group ][ $item_id ] = $item ;
unset ( $this -> _items [ $item_group ][ $item_key ] );
// Legacy action handler
switch ( $item_group ) {
case 'fee_lines' :
2016-08-15 10:08:36 +00:00
if ( isset ( $item -> legacy_fee , $item -> legacy_fee_key ) ) {
wc_do_deprecated_action ( 'woocommerce_add_order_fee_meta' , array ( $this -> get_id (), $item_id , $item -> legacy_fee , $item -> legacy_fee_key ), '2.7' , 'Use woocommerce_new_order_item action instead.' );
2016-08-09 13:15:04 +00:00
}
break ;
case 'shipping_lines' :
2016-08-15 10:08:36 +00:00
if ( isset ( $item -> legacy_package_key ) ) {
wc_do_deprecated_action ( 'woocommerce_add_shipping_order_item' , array ( $item_id , $item -> legacy_package_key ), '2.7' , 'Use woocommerce_new_order_item action instead.' );
2016-08-09 13:15:04 +00:00
}
break ;
case 'line_items' :
2016-08-15 10:08:36 +00:00
if ( isset ( $item -> legacy_values , $item -> legacy_cart_item_key ) ) {
wc_do_deprecated_action ( 'woocommerce_add_order_item_meta' , array ( $item_id , $item -> legacy_values , $item -> legacy_cart_item_key ), '2.7' , 'Use woocommerce_new_order_item action instead.' );
2016-08-09 13:15:04 +00:00
}
break ;
}
2016-08-09 13:02:40 +00:00
}
}
}
}
}
2016-06-21 19:03:56 +00:00
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
|
| Methods for getting data from the order object .
|
*/
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get all class data in array format .
* @ since 2.7 . 0
* @ return array
*/
public function get_data () {
return array_merge (
$this -> _data ,
array (
'meta_data' => $this -> get_meta_data (),
'line_items' => $this -> get_items ( 'line_item' ),
'tax_lines' => $this -> get_items ( 'tax' ),
'shipping_lines' => $this -> get_items ( 'shipping' ),
'fee_lines' => $this -> get_items ( 'fee' ),
'coupon_lines' => $this -> get_items ( 'coupon' ),
)
);
}
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get order ID .
* @ since 2.7 . 0
* @ return integer
*/
public function get_id () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'id' ];
2014-07-03 11:38:55 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Get parent order ID .
* @ since 2.7 . 0
* @ return integer
*/
public function get_parent_id () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'parent_id' ];
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets order currency .
* @ return string
*/
public function get_currency () {
2016-08-26 09:48:17 +00:00
return apply_filters ( 'woocommerce_get_currency' , $this -> _data [ 'currency' ], $this );
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get order_version
* @ return string
*/
public function get_version () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'version' ];
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get prices_include_tax
* @ return bool
*/
public function get_prices_include_tax () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'prices_include_tax' ];
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get date_created
* @ return int
*/
public function get_date_created () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'date_created' ];
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get date_modified
* @ return int
*/
public function get_date_modified () {
2016-08-26 09:48:17 +00:00
return $this -> _data [ 'date_modified' ];
2016-06-21 19:03:56 +00:00
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Return the order statuses without wc - internal prefix .
* @ return string
*/
public function get_status () {
2016-08-26 09:48:17 +00:00
$status = $this -> _data [ 'status' ];
2016-08-23 17:48:48 +00:00
return apply_filters ( 'woocommerce_order_get_status' , 'wc-' === substr ( $status , 0 , 3 ) ? substr ( $status , 3 ) : $status , $this );
2014-07-28 03:28:25 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Get discount_total
* @ param bool $raw Gets raw unfiltered value .
* @ return string
*/
public function get_discount_total ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'discount_total' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_discount_total' , $value , $this );
2014-07-03 11:38:55 +00:00
}
2014-07-28 03:28:25 +00:00
/**
2016-06-21 19:03:56 +00:00
* Get discount_tax
* @ param bool $raw Gets raw unfiltered value .
* @ return string
2014-07-28 03:28:25 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_discount_tax ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'discount_tax' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_discount_tax' , $value , $this );
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get shipping_total
* @ param bool $raw Gets raw unfiltered value .
* @ return string
*/
public function get_shipping_total ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'shipping_total' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_shipping_total' , $value , $this );
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get shipping_tax .
* @ param bool $raw Gets raw unfiltered value .
* @ return string
*/
public function get_shipping_tax ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'shipping_tax' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_shipping_tax' , $value , $this );
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets cart tax amount .
* @ param bool $raw Gets raw unfiltered value .
* @ return float
*/
public function get_cart_tax ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'cart_tax' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_cart_tax' , $value , $this );
}
2014-07-28 03:28:25 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets order grand total . incl . taxes . Used in gateways . Filtered .
* @ param bool $raw Gets raw unfiltered value .
* @ return float
*/
public function get_total ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'total' ], wc_get_price_decimals () );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_total' , $value , $this );
2014-07-28 03:28:25 +00:00
}
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Get total tax amount . Alias for get_order_tax () .
2014-07-28 03:23:59 +00:00
*
2016-06-21 19:03:56 +00:00
* @ since 2.7 . 0 woocommerce_order_amount_total_tax filter has been removed to avoid
* these values being modified and then saved back to the DB . There are
* other , later hooks available to change totals on display . e . g .
* woocommerce_get_order_item_totals .
* @ param bool $raw Gets raw unfiltered value .
* @ return float
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_total_tax ( $raw = false ) {
2016-08-26 09:48:17 +00:00
$value = wc_format_decimal ( $this -> _data [ 'total_tax' ] );
2016-06-21 19:03:56 +00:00
return $raw ? $value : apply_filters ( 'woocommerce_order_amount_total_tax' , $value , $this );
}
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets the total discount amount .
* @ param bool $ex_tax Show discount excl any tax .
* @ return float
*/
public function get_total_discount ( $ex_tax = true ) {
if ( $ex_tax ) {
$total_discount = $this -> get_discount_total ();
} else {
$total_discount = $this -> get_discount_total () + $this -> get_discount_tax ();
2014-07-03 11:38:55 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_total_discount' , round ( $total_discount , WC_ROUNDING_PRECISION ), $this );
}
2014-07-28 03:23:59 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets order subtotal .
* @ return float
*/
public function get_subtotal () {
$subtotal = 0 ;
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_items () as $item ) {
$subtotal += $item -> get_subtotal ();
2014-07-19 03:15:41 +00:00
}
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_subtotal' , ( double ) $subtotal , $this );
2014-07-03 11:38:55 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Get taxes , merged by code , formatted ready for output .
2014-08-31 05:49:58 +00:00
*
2016-06-21 19:03:56 +00:00
* @ return array
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_tax_totals () {
$tax_totals = array ();
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_items ( 'tax' ) as $key => $tax ) {
$code = $tax -> get_rate_code ();
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
if ( ! isset ( $tax_totals [ $code ] ) ) {
$tax_totals [ $code ] = new stdClass ();
$tax_totals [ $code ] -> amount = 0 ;
2016-01-08 11:42:32 +00:00
}
2016-06-21 19:03:56 +00:00
$tax_totals [ $code ] -> id = $key ;
$tax_totals [ $code ] -> rate_id = $tax -> get_rate_id ();
$tax_totals [ $code ] -> is_compound = $tax -> is_compound ();
$tax_totals [ $code ] -> label = $tax -> get_label ();
$tax_totals [ $code ] -> amount += $tax -> get_tax_total () + $tax -> get_shipping_tax_total ();
$tax_totals [ $code ] -> formatted_amount = wc_price ( wc_round_tax_total ( $tax_totals [ $code ] -> amount ), array ( 'currency' => $this -> get_currency () ) );
2016-01-08 11:42:32 +00:00
}
2016-06-21 19:03:56 +00:00
if ( apply_filters ( 'woocommerce_order_hide_zero_taxes' , true ) ) {
$amounts = array_filter ( wp_list_pluck ( $tax_totals , 'amount' ) );
$tax_totals = array_intersect_key ( $tax_totals , $amounts );
2014-07-28 03:28:25 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_tax_totals' , $tax_totals , $this );
2014-07-28 03:28:25 +00:00
}
2016-06-21 19:03:56 +00:00
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
|
| Functions for setting order data . These should not update anything in the
| database itself and should only change what is stored in the class
| object . However , for backwards compatibility pre 2.7 . 0 some of these
| setters may handle both .
|
*/
2014-07-03 11:38:55 +00:00
2014-07-28 03:28:25 +00:00
/**
2016-06-21 19:03:56 +00:00
* Set order ID .
* @ since 2.7 . 0
* @ param int $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-07-28 03:28:25 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_id ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'id' ] = absint ( $value );
2014-07-28 03:28:25 +00:00
}
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Set parent order ID .
* @ since 2.7 . 0
* @ param int $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_parent_id ( $value ) {
2016-08-23 14:25:50 +00:00
if ( $value && ! get_post ( $value ) ) {
2016-08-25 12:05:27 +00:00
$this -> error ( 'order_invalid_parent_id' , __ ( 'Invalid parent ID' , 'woocommerce' ) );
2016-08-23 14:25:50 +00:00
}
2016-08-26 09:48:17 +00:00
$this -> _data [ 'parent_id' ] = absint ( $value );
2014-07-03 11:38:55 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set order status .
* @ since 2.7 . 0
* @ param string $new_status Status to change the order to . No internal wc - prefix is required .
2016-08-23 14:25:50 +00:00
* @ return array details of change
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_status ( $new_status ) {
2016-08-08 16:03:43 +00:00
$old_status = $this -> get_status ();
$new_status = 'wc-' === substr ( $new_status , 0 , 3 ) ? substr ( $new_status , 3 ) : $new_status ;
2016-05-11 15:32:51 +00:00
2016-08-08 16:03:43 +00:00
// Only allow valid new status
if ( ! in_array ( 'wc-' . $new_status , array_keys ( wc_get_order_statuses () ) ) ) {
$new_status = 'pending' ;
2015-12-23 12:50:28 +00:00
}
2014-07-03 11:38:55 +00:00
2016-08-26 09:48:17 +00:00
$this -> _data [ 'status' ] = 'wc-' . $new_status ;
2016-08-08 16:03:43 +00:00
// If the old status is set but unknown (e.g. draft) assume its pending for action usage.
if ( $old_status && ! in_array ( 'wc-' . $old_status , array_keys ( wc_get_order_statuses () ) ) ) {
$old_status = 'pending' ;
2014-07-03 11:38:55 +00:00
}
2016-06-21 19:03:56 +00:00
return array (
'from' => $old_status ,
2016-08-27 01:46:45 +00:00
'to' => $new_status ,
2016-06-21 19:03:56 +00:00
);
2016-08-03 11:32:27 +00:00
}
2014-07-28 03:29:40 +00:00
2014-07-03 11:38:55 +00:00
/**
2016-06-21 19:03:56 +00:00
* Set order_version
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-07-03 11:38:55 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_version ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'version' ] = $value ;
2014-07-03 11:38:55 +00:00
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Set order_currency
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_currency ( $value ) {
2016-08-17 10:44:56 +00:00
if ( $value && ! in_array ( $value , array_keys ( get_woocommerce_currencies () ) ) ) {
2016-08-25 12:05:27 +00:00
$this -> error ( 'order_invalid_currency' , __ ( 'Invalid currency code' , 'woocommerce' ) );
2016-08-17 10:44:56 +00:00
}
2016-08-26 09:48:17 +00:00
$this -> _data [ 'currency' ] = $value ;
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set prices_include_tax
* @ param bool $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_prices_include_tax ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'prices_include_tax' ] = ( bool ) $value ;
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set date_created
* @ param string $timestamp Timestamp
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_date_created ( $timestamp ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'date_created' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set date_modified
* @ param string $timestamp
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_date_modified ( $timestamp ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'date_modified' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set discount_total
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_discount_total ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'discount_total' ] = wc_format_decimal ( $value );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Set discount_tax
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_discount_tax ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'discount_tax' ] = wc_format_decimal ( $value );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Set shipping_total
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2016-06-21 19:03:56 +00:00
*/
public function set_shipping_total ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'shipping_total' ] = wc_format_decimal ( $value );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Set shipping_tax
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2016-06-21 19:03:56 +00:00
*/
public function set_shipping_tax ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'shipping_tax' ] = wc_format_decimal ( $value );
2016-06-21 19:03:56 +00:00
$this -> set_total_tax ( $this -> get_cart_tax () + $this -> get_shipping_tax () );
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Set cart tax
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function set_cart_tax ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'cart_tax' ] = wc_format_decimal ( $value );
2016-06-21 19:03:56 +00:00
$this -> set_total_tax ( $this -> get_cart_tax () + $this -> get_shipping_tax () );
}
/**
* Sets order tax ( sum of cart and shipping tax ) . Used internaly only .
* @ param string $value
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2016-06-21 19:03:56 +00:00
*/
protected function set_total_tax ( $value ) {
2016-08-26 09:48:17 +00:00
$this -> _data [ 'total_tax' ] = wc_format_decimal ( $value );
2016-06-21 19:03:56 +00:00
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
* Set total
* @ param string $value
* @ param string $deprecated Function used to set different totals based on this .
2016-08-24 09:46:29 +00:00
* @ throws WC_Data_Exception
2016-06-21 19:03:56 +00:00
*/
public function set_total ( $value , $deprecated = '' ) {
if ( $deprecated ) {
_deprecated_argument ( 'total_type' , '2.7' , 'Use dedicated total setter methods instead.' );
return $this -> legacy_set_total ( $value , $deprecated );
2015-11-30 15:16:23 +00:00
}
2016-08-26 09:48:17 +00:00
$this -> _data [ 'total' ] = wc_format_decimal ( $value , wc_get_price_decimals () );
2016-06-21 19:03:56 +00:00
}
2015-11-30 15:16:23 +00:00
2016-06-21 19:03:56 +00:00
/*
|--------------------------------------------------------------------------
| Order Item Handling
|--------------------------------------------------------------------------
|
| Order items are used for products , taxes , shipping , and fees within
| each order .
|
*/
2015-11-30 15:16:23 +00:00
2016-06-21 19:03:56 +00:00
/**
* Remove all line items ( products , coupons , shipping , taxes ) from the order .
* @ param string $type Order item type . Default null .
*/
public function remove_order_items ( $type = null ) {
global $wpdb ;
if ( ! empty ( $type ) ) {
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM itemmeta USING { $wpdb -> prefix } woocommerce_order_itemmeta itemmeta INNER JOIN { $wpdb -> prefix } woocommerce_order_items items WHERE itemmeta.order_item_id = items.order_item_id AND items.order_id = %d AND items.order_item_type = %s " , $this -> get_id (), $type ) );
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM { $wpdb -> prefix } woocommerce_order_items WHERE order_id = %d AND order_item_type = %s " , $this -> get_id (), $type ) );
2016-08-12 15:48:48 +00:00
if ( $group = $this -> type_to_group ( $type ) ) {
$this -> _items [ $group ] = null ;
}
2016-06-21 19:03:56 +00:00
} else {
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM itemmeta USING { $wpdb -> prefix } woocommerce_order_itemmeta itemmeta INNER JOIN { $wpdb -> prefix } woocommerce_order_items items WHERE itemmeta.order_item_id = items.order_item_id and items.order_id = %d " , $this -> get_id () ) );
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM { $wpdb -> prefix } woocommerce_order_items WHERE order_id = %d " , $this -> get_id () ) );
2016-08-12 15:48:48 +00:00
$this -> _items = array (
'line_items' => null ,
'coupon_lines' => null ,
'shipping_lines' => null ,
'fee_lines' => null ,
'tax_lines' => null ,
);
2016-06-21 19:03:56 +00:00
}
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
2016-08-12 15:48:48 +00:00
* Convert a type to a types group .
* @ param string $type
* @ return string group
2016-06-21 19:03:56 +00:00
*/
2016-08-12 15:48:48 +00:00
protected function type_to_group ( $type ) {
2016-08-09 13:15:04 +00:00
$type_to_group = array (
'line_item' => 'line_items' ,
'tax' => 'tax_lines' ,
'shipping' => 'shipping_lines' ,
'fee' => 'fee_lines' ,
'coupon' => 'coupon_lines' ,
);
2016-08-12 15:48:48 +00:00
return isset ( $type_to_group [ $type ] ) ? $type_to_group [ $type ] : '' ;
}
2016-08-09 13:15:04 +00:00
2016-08-12 15:48:48 +00:00
/**
* Return an array of items / products within this order .
* @ param string | array $types Types of line items to get ( array or string ) .
* @ return Array of WC_Order_item
*/
public function get_items ( $types = 'line_item' ) {
2016-08-09 13:02:40 +00:00
$items = array ();
2016-08-09 13:21:54 +00:00
$types = array_filter ( ( array ) $types );
2016-08-09 13:02:40 +00:00
foreach ( $types as $type ) {
2016-08-12 15:48:48 +00:00
if ( $group = $this -> type_to_group ( $type ) ) {
if ( is_null ( $this -> _items [ $group ] ) ) {
$this -> _items [ $group ] = $this -> get_items_from_db ( $type );
2016-08-09 13:21:54 +00:00
}
2016-08-19 12:43:33 +00:00
// Don't use array_merge here because keys are numeric
$items = $items + $this -> _items [ $group ];
2016-08-09 13:15:04 +00:00
}
2016-08-09 13:02:40 +00:00
}
return apply_filters ( 'woocommerce_order_get_items' , $items , $this );
}
/**
* Gets items from the database by type .
* @ param string $type
* @ return array
*/
protected function get_items_from_db ( $type ) {
2016-06-21 19:03:56 +00:00
global $wpdb ;
2016-08-09 13:02:40 +00:00
$get_items_sql = $wpdb -> prepare ( " SELECT * FROM { $wpdb -> prefix } woocommerce_order_items WHERE order_id = %d AND order_item_type = %s ORDER BY order_item_id; " , $this -> get_id (), $type ) ;
2016-06-21 19:03:56 +00:00
$items = $wpdb -> get_results ( $get_items_sql );
2016-06-23 15:07:35 +00:00
if ( ! empty ( $items ) ) {
2016-08-19 12:43:33 +00:00
$items = array_map ( array ( $this , 'get_item' ), array_combine ( wp_list_pluck ( $items , 'order_item_id' ), $items ) );
2016-06-23 15:07:35 +00:00
} else {
$items = array ();
}
2015-11-30 15:16:23 +00:00
2016-08-09 13:02:40 +00:00
return $items ;
2014-06-13 13:35:53 +00:00
}
2015-11-30 15:16:23 +00:00
/**
2016-06-21 19:03:56 +00:00
* Return an array of fees within this order .
* @ return array
2015-11-30 15:16:23 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_fees () {
return $this -> get_items ( 'fee' );
2015-11-30 15:16:23 +00:00
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Return an array of taxes within this order .
* @ return array
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_taxes () {
return $this -> get_items ( 'tax' );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Return an array of shipping costs within this order .
* @ return array
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_shipping_methods () {
return $this -> get_items ( 'shipping' );
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
* Gets formatted shipping method title .
* @ return string
*/
public function get_shipping_method () {
$names = array ();
foreach ( $this -> get_shipping_methods () as $shipping_method ) {
$names [] = $shipping_method -> get_name ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_shipping_method' , implode ( ', ' , $names ), $this );
2015-10-29 15:34:33 +00:00
}
2014-06-13 13:35:53 +00:00
2015-10-29 15:34:33 +00:00
/**
2016-06-21 19:03:56 +00:00
* Get coupon codes only .
* @ return array
2015-10-29 15:34:33 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_used_coupons () {
2016-06-23 14:52:12 +00:00
$coupon_codes = array ();
if ( $coupons = $this -> get_items ( 'coupon' ) ) {
foreach ( $coupons as $coupon ) {
$coupon_codes [] = $coupon -> get_code ();
}
}
return $coupon_codes ;
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Gets the count of order items of a certain type .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ param string $item_type
2014-06-13 13:35:53 +00:00
* @ return string
*/
2016-06-21 19:03:56 +00:00
public function get_item_count ( $item_type = '' ) {
$items = $this -> get_items ( empty ( $item_type ) ? 'line_item' : $item_type );
$count = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $items as $item ) {
2016-08-16 11:36:38 +00:00
$count += $item -> get_quantity ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_get_item_count' , $count , $item_type , $this );
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get an order item object , based on it ' s type .
* @ since 2.7 . 0
* @ param int $item_id
* @ return WC_Order_Item
*/
public function get_item ( $item_id ) {
return WC_Order_Factory :: get_order_item ( $item_id );
2014-06-13 13:35:53 +00:00
}
2016-08-09 13:02:40 +00:00
/**
2016-08-17 15:53:01 +00:00
* Get key for where a certain item type is stored in _items .
* @ since 2.7 . 0
* @ param $item object Order item ( product , shipping , fee , coupon , tax )
* @ return string
2016-08-09 13:02:40 +00:00
*/
2016-08-17 15:53:01 +00:00
protected function get_items_key ( $item ) {
2016-08-09 13:02:40 +00:00
if ( is_a ( $item , 'WC_Order_Item_Product' ) ) {
2016-08-17 15:53:01 +00:00
return 'line_items' ;
2016-08-09 13:02:40 +00:00
} elseif ( is_a ( $item , 'WC_Order_Item_Fee' ) ) {
2016-08-17 15:53:01 +00:00
return 'fee_lines' ;
2016-08-09 13:02:40 +00:00
} elseif ( is_a ( $item , 'WC_Order_Item_Shipping' ) ) {
2016-08-17 15:53:01 +00:00
return 'shipping_lines' ;
2016-08-09 13:02:40 +00:00
} elseif ( is_a ( $item , 'WC_Order_Item_Tax' ) ) {
2016-08-17 15:53:01 +00:00
return 'tax_lines' ;
2016-08-09 13:02:40 +00:00
} elseif ( is_a ( $item , 'WC_Order_Item_Coupon' ) ) {
2016-08-17 15:53:01 +00:00
return 'coupon_lines' ;
2016-08-09 13:02:40 +00:00
} else {
2016-08-17 15:53:01 +00:00
return '' ;
}
}
/**
* Remove item from the order .
* @ param int $item_id
*/
public function remove_item ( $item_id ) {
$item = $this -> get_item ( $item_id );
if ( ! $item || ! ( $items_key = $this -> get_items_key ( $item ) ) ) {
return false ;
}
// Unset and remove later
$this -> _items_to_delete [] = $item ;
2016-08-19 12:43:33 +00:00
unset ( $this -> _items [ $items_key ][ $item -> get_id () ] );
2016-08-17 15:53:01 +00:00
}
/**
* Adds an order item to this order . The order item will not persist until save .
2016-08-22 13:51:53 +00:00
* @ since 2.7 . 0
* @ param WC_Order_Item Order item object ( product , shipping , fee , coupon , tax )
2016-08-17 15:53:01 +00:00
*/
public function add_item ( $item ) {
if ( ! $items_key = $this -> get_items_key ( $item ) ) {
2016-08-09 13:02:40 +00:00
return false ;
}
// Make sure existing items are loaded so we can append this new one.
if ( is_null ( $this -> _items [ $items_key ] ) ) {
2016-08-17 15:53:01 +00:00
$this -> _items [ $items_key ] = $this -> get_items ( $item -> get_type () );
2016-08-09 13:02:40 +00:00
}
// Append new row with generated temporary ID
2016-08-15 10:02:25 +00:00
if ( $item -> get_id () ) {
2016-08-19 12:43:33 +00:00
$this -> _items [ $items_key ][ $item -> get_id () ] = $item ;
2016-08-15 10:02:25 +00:00
} else {
2016-08-22 17:00:52 +00:00
$this -> _items [ $items_key ][ 'new:' . sizeof ( $this -> _items [ $items_key ] ) ] = $item ;
2016-08-15 10:02:25 +00:00
}
2016-08-09 13:02:40 +00:00
}
2016-08-22 17:00:52 +00:00
/**
* Add a product line item to the order . This is the only line item type with
* it ' s own method because it saves looking up order amounts ( costs are added up for you ) .
* @ param \WC_Product $product
* @ param int $qty
* @ param array $args
* @ return int order item ID
2016-08-24 15:02:19 +00:00
* @ throws WC_Data_Exception
2016-08-22 17:00:52 +00:00
*/
public function add_product ( $product , $qty = 1 , $args = array () ) {
if ( $product ) {
$default_args = array (
'name' => $product -> get_title (),
'tax_class' => $product -> get_tax_class (),
'product_id' => $product -> get_id (),
'variation_id' => isset ( $product -> variation_id ) ? $product -> variation_id : 0 ,
'variation' => isset ( $product -> variation_id ) ? $product -> get_variation_attributes () : array (),
'subtotal' => $product -> get_price_excluding_tax ( $qty ),
'total' => $product -> get_price_excluding_tax ( $qty ),
'quantity' => $qty ,
);
} else {
$default_args = array (
'quantity' => $qty ,
);
}
$args = wp_parse_args ( $args , $default_args );
// BW compatibility with old args
if ( isset ( $args [ 'totals' ] ) ) {
foreach ( $args [ 'totals' ] as $key => $value ) {
if ( 'tax' === $key ) {
$args [ 'total_tax' ] = $value ;
} elseif ( 'tax_data' === $key ) {
$args [ 'taxes' ] = $value ;
} else {
$args [ $key ] = $value ;
}
}
}
$item = new WC_Order_Item_Product ( $args );
$item -> set_backorder_meta ();
$item -> set_order_id ( $this -> get_id () );
$item -> save ();
$this -> add_item ( $item );
wc_do_deprecated_action ( 'woocommerce_order_add_product' , array ( $this -> get_id (), $item -> get_id (), $product , $qty , $args ), '2.7' , 'Use woocommerce_new_order_item action instead.' );
return $item -> get_id ();
}
2016-08-15 10:02:25 +00:00
/*
|--------------------------------------------------------------------------
| Payment Token Handling
|--------------------------------------------------------------------------
|
| Payment tokens are hashes used to take payments by certain gateways .
|
*/
2015-05-01 11:42:29 +00:00
/**
2016-06-21 19:03:56 +00:00
* Add a payment token to an order
*
* @ since 2.6
* @ param WC_Payment_Token $token Payment token object
* @ return boolean | int The new token ID or false if it failed .
2015-05-01 11:42:29 +00:00
*/
2016-06-21 19:03:56 +00:00
public function add_payment_token ( $token ) {
if ( empty ( $token ) || ! ( $token instanceof WC_Payment_Token ) ) {
return false ;
}
2015-05-01 11:42:29 +00:00
2016-06-21 19:03:56 +00:00
$token_ids = get_post_meta ( $this -> get_id (), '_payment_tokens' , true );
2015-05-01 11:42:29 +00:00
2016-09-02 01:12:22 +00:00
if ( empty ( $token_ids ) ) {
2016-06-21 19:03:56 +00:00
$token_ids = array ();
2015-05-01 11:42:29 +00:00
}
2016-06-21 19:03:56 +00:00
$token_ids [] = $token -> get_id ();
update_post_meta ( $this -> get_id (), '_payment_tokens' , $token_ids );
do_action ( 'woocommerce_payment_token_added_to_order' , $this -> get_id (), $token -> get_id (), $token , $token_ids );
return $token -> get_id ();
2015-05-01 11:42:29 +00:00
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Returns a list of all payment tokens associated with the current order
2014-08-31 05:49:58 +00:00
*
2016-06-21 19:03:56 +00:00
* @ since 2.6
* @ return array An array of payment token objects
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_payment_tokens () {
return WC_Payment_Tokens :: get_order_tokens ( $this -> get_id () );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/*
|--------------------------------------------------------------------------
| Calculations .
|--------------------------------------------------------------------------
|
| These methods calculate order totals and taxes based on the current data .
|
*/
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Calculate shipping total .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ since 2.2
* @ return float
*/
public function calculate_shipping () {
$shipping_total = 0 ;
2015-04-23 10:50:09 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_shipping_methods () as $shipping ) {
$shipping_total += $shipping -> get_total ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
$this -> set_shipping_total ( $shipping_total );
$this -> save ();
return $this -> get_shipping_total ();
2014-06-13 13:35:53 +00:00
}
2016-08-03 11:32:27 +00:00
/**
* Get all tax classes for items in the order .
*
* @ since 2.6 . 3
* @ return array
*/
public function get_items_tax_classes () {
$found_tax_classes = array ();
2015-04-23 10:50:09 +00:00
2016-08-03 11:32:27 +00:00
foreach ( $this -> get_items () as $item ) {
2016-08-22 15:51:24 +00:00
if ( $_product = $item -> get_product () ) {
2016-08-03 11:32:27 +00:00
$found_tax_classes [] = $_product -> get_tax_class ();
}
2014-06-13 13:35:53 +00:00
}
2016-08-03 11:32:27 +00:00
return array_unique ( $found_tax_classes );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Calculate taxes for all line items and shipping , and store the totals and tax rows .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* Will use the base country unless customer addresses are set .
* @ param $args array Added in 2.7 . 0 to pass things like location .
*/
public function calculate_taxes ( $args = array () ) {
$tax_based_on = get_option ( 'woocommerce_tax_based_on' );
$args = wp_parse_args ( $args , array (
'country' => 'billing' === $tax_based_on ? $this -> get_billing_country () : $this -> get_shipping_country (),
'state' => 'billing' === $tax_based_on ? $this -> get_billing_state () : $this -> get_shipping_state (),
'postcode' => 'billing' === $tax_based_on ? $this -> get_billing_postcode () : $this -> get_shipping_postcode (),
'city' => 'billing' === $tax_based_on ? $this -> get_billing_city () : $this -> get_shipping_city (),
) );
// Default to base
if ( 'base' === $tax_based_on || empty ( $args [ 'country' ] ) ) {
$default = wc_get_base_location ();
$args [ 'country' ] = $default [ 'country' ];
$args [ 'state' ] = $default [ 'state' ];
$args [ 'postcode' ] = '' ;
$args [ 'city' ] = '' ;
2014-09-17 11:24:05 +00:00
}
2016-06-21 19:03:56 +00:00
// Calc taxes for line items
foreach ( $this -> get_items ( array ( 'line_item' , 'fee' ) ) as $item_id => $item ) {
$tax_class = $item -> get_tax_class ();
$tax_status = $item -> get_tax_status ();
2014-07-28 03:23:59 +00:00
2016-06-21 19:03:56 +00:00
if ( '0' !== $tax_class && 'taxable' === $tax_status ) {
$tax_rates = WC_Tax :: find_rates ( array (
'country' => $args [ 'country' ],
'state' => $args [ 'state' ],
'postcode' => $args [ 'postcode' ],
'city' => $args [ 'city' ],
'tax_class' => $tax_class ,
) );
2016-03-03 17:04:20 +00:00
2016-06-21 19:03:56 +00:00
$total = $item -> get_total ();
$taxes = WC_Tax :: calc_tax ( $total , $tax_rates , false );
if ( $item -> is_type ( 'line_item' ) ) {
$subtotal = $item -> get_subtotal ();
$subtotal_taxes = WC_Tax :: calc_tax ( $subtotal , $tax_rates , false );
$item -> set_taxes ( array ( 'total' => $taxes , 'subtotal' => $subtotal_taxes ) );
} else {
$item -> set_taxes ( array ( 'total' => $taxes ) );
}
$item -> save ();
}
2015-12-07 10:12:17 +00:00
}
2014-07-28 03:23:59 +00:00
2016-06-21 19:03:56 +00:00
// Calc taxes for shipping
foreach ( $this -> get_shipping_methods () as $item_id => $item ) {
$shipping_tax_class = get_option ( 'woocommerce_shipping_tax_class' );
2016-02-29 12:24:00 +00:00
2016-06-21 19:03:56 +00:00
// Inherit tax class from items
if ( '' === $shipping_tax_class ) {
2016-08-08 03:36:04 +00:00
$tax_rates = array ();
2016-08-08 16:47:50 +00:00
$tax_classes = array_merge ( array ( '' ), WC_Tax :: get_tax_classes () );
2016-08-03 11:32:27 +00:00
$found_tax_classes = $this -> get_items_tax_classes ();
2016-02-29 12:24:00 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $tax_classes as $tax_class ) {
$tax_class = sanitize_title ( $tax_class );
if ( in_array ( $tax_class , $found_tax_classes ) ) {
$tax_rates = WC_Tax :: find_shipping_rates ( array (
'country' => $args [ 'country' ],
'state' => $args [ 'state' ],
'postcode' => $args [ 'postcode' ],
'city' => $args [ 'city' ],
'tax_class' => $tax_class ,
) );
break ;
}
}
} else {
$tax_rates = WC_Tax :: find_shipping_rates ( array (
'country' => $args [ 'country' ],
'state' => $args [ 'state' ],
'postcode' => $args [ 'postcode' ],
'city' => $args [ 'city' ],
'tax_class' => 'standard' === $shipping_tax_class ? '' : $shipping_tax_class ,
) );
}
2016-08-22 15:48:19 +00:00
2016-06-21 19:03:56 +00:00
$item -> set_taxes ( array ( 'total' => WC_Tax :: calc_tax ( $item -> get_total (), $tax_rates , false ) ) );
$item -> save ();
2016-02-29 12:33:09 +00:00
}
2016-06-21 19:03:56 +00:00
$this -> update_taxes ();
}
2014-09-09 17:00:37 +00:00
2016-06-21 19:03:56 +00:00
/**
* Update tax lines for the order based on the line item taxes themselves .
*/
public function update_taxes () {
$cart_taxes = array ();
$shipping_taxes = array ();
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_items ( array ( 'line_item' , 'fee' ) ) as $item_id => $item ) {
$taxes = $item -> get_taxes ();
foreach ( $taxes [ 'total' ] as $tax_rate_id => $tax ) {
$cart_taxes [ $tax_rate_id ] = isset ( $cart_taxes [ $tax_rate_id ] ) ? $cart_taxes [ $tax_rate_id ] + $tax : $tax ;
}
2016-03-03 17:04:20 +00:00
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_shipping_methods () as $item_id => $item ) {
$taxes = $item -> get_taxes ();
foreach ( $taxes [ 'total' ] as $tax_rate_id => $tax ) {
$shipping_taxes [ $tax_rate_id ] = isset ( $shipping_taxes [ $tax_rate_id ] ) ? $shipping_taxes [ $tax_rate_id ] + $tax : $tax ;
}
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
// Remove old existing tax rows.
$this -> remove_order_items ( 'tax' );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
// Now merge to keep tax rows.
foreach ( array_keys ( $cart_taxes + $shipping_taxes ) as $tax_rate_id ) {
2016-08-22 15:48:19 +00:00
$item = new WC_Order_Item_Tax ();
$item -> set_rate ( $tax_rate_id );
$item -> set_tax_total ( isset ( $cart_taxes [ $tax_rate_id ] ) ? $cart_taxes [ $tax_rate_id ] : 0 );
$item -> set_shipping_tax_total ( isset ( $shipping_taxes [ $tax_rate_id ] ) ? $shipping_taxes [ $tax_rate_id ] : 0 );
$this -> add_item ( $item );
2016-06-21 19:03:56 +00:00
}
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
// Save tax totals
$this -> set_shipping_tax ( WC_Tax :: round ( array_sum ( $shipping_taxes ) ) );
$this -> set_cart_tax ( WC_Tax :: round ( array_sum ( $cart_taxes ) ) );
$this -> save ();
}
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
/**
* Calculate totals by looking at the contents of the order . Stores the totals and returns the orders final total .
*
* @ since 2.2
* @ param bool $and_taxes Calc taxes if true .
* @ return float calculated grand total .
*/
public function calculate_totals ( $and_taxes = true ) {
$cart_subtotal = 0 ;
$cart_total = 0 ;
$fee_total = 0 ;
$cart_subtotal_tax = 0 ;
$cart_total_tax = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $and_taxes && wc_tax_enabled () ) {
$this -> calculate_taxes ();
}
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
// line items
foreach ( $this -> get_items () as $item ) {
2016-08-19 12:43:33 +00:00
$cart_subtotal += $item -> get_subtotal ();
$cart_total += $item -> get_total ();
$cart_subtotal_tax += $item -> get_subtotal_tax ();
$cart_total_tax += $item -> get_total_tax ();
2016-06-21 19:03:56 +00:00
}
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
$this -> calculate_shipping ();
2014-07-03 11:38:55 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_fees () as $item ) {
$fee_total += $item -> get_total ();
2014-06-13 13:35:53 +00:00
}
2015-12-07 10:12:17 +00:00
2016-06-21 19:03:56 +00:00
$grand_total = round ( $cart_total + $fee_total + $this -> get_shipping_total () + $this -> get_cart_tax () + $this -> get_shipping_tax (), wc_get_price_decimals () );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
$this -> set_discount_total ( $cart_subtotal - $cart_total );
$this -> set_discount_tax ( $cart_subtotal_tax - $cart_total_tax );
$this -> set_total ( $grand_total );
$this -> save ();
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
return $grand_total ;
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Get item subtotal - this is the cost before discount .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ param object $item
* @ param bool $inc_tax ( default : false ) .
* @ param bool $round ( default : true ) .
* @ return float
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_item_subtotal ( $item , $inc_tax = false , $round = true ) {
$subtotal = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( is_callable ( array ( $item , 'get_subtotal' ) ) ) {
if ( $inc_tax ) {
2016-08-16 11:36:38 +00:00
$subtotal = ( $item -> get_subtotal () + $item -> get_subtotal_tax () ) / max ( 1 , $item -> get_quantity () );
2016-06-21 19:03:56 +00:00
} else {
2016-08-16 11:36:38 +00:00
$subtotal = ( $item -> get_subtotal () / max ( 1 , $item -> get_quantity () ) );
2016-06-21 19:03:56 +00:00
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
$subtotal = $round ? number_format ( ( float ) $subtotal , wc_get_price_decimals (), '.' , '' ) : $subtotal ;
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_item_subtotal' , $subtotal , $this , $item , $inc_tax , $round );
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get line subtotal - this is the cost before discount .
*
* @ param object $item
* @ param bool $inc_tax ( default : false ) .
* @ param bool $round ( default : true ) .
* @ return float
*/
public function get_line_subtotal ( $item , $inc_tax = false , $round = true ) {
$subtotal = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( is_callable ( array ( $item , 'get_subtotal' ) ) ) {
if ( $inc_tax ) {
$subtotal = $item -> get_subtotal () + $item -> get_subtotal_tax ();
} else {
$subtotal = $item -> get_subtotal ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
$subtotal = $round ? round ( $subtotal , wc_get_price_decimals () ) : $subtotal ;
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_line_subtotal' , $subtotal , $this , $item , $inc_tax , $round );
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
/**
* Calculate item cost - useful for gateways .
*
* @ param object $item
* @ param bool $inc_tax ( default : false ) .
* @ param bool $round ( default : true ) .
* @ return float
*/
public function get_item_total ( $item , $inc_tax = false , $round = true ) {
$total = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( is_callable ( array ( $item , 'get_total' ) ) ) {
if ( $inc_tax ) {
2016-08-16 11:36:38 +00:00
$total = ( $item -> get_total () + $item -> get_total_tax () ) / max ( 1 , $item -> get_quantity () );
2016-06-21 19:03:56 +00:00
} else {
2016-08-16 11:36:38 +00:00
$total = $item -> get_total () / max ( 1 , $item -> get_quantity () );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
$total = $round ? round ( $total , wc_get_price_decimals () ) : $total ;
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_item_total' , $total , $this , $item , $inc_tax , $round );
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Calculate line total - useful for gateways .
*
* @ param object $item
* @ param bool $inc_tax ( default : false ) .
* @ param bool $round ( default : true ) .
* @ return float
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_line_total ( $item , $inc_tax = false , $round = true ) {
$total = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( is_callable ( array ( $item , 'get_total' ) ) ) {
// Check if we need to add line tax to the line total.
$total = $inc_tax ? $item -> get_total () + $item -> get_total_tax () : $item -> get_total ();
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
// Check if we need to round.
$total = $round ? round ( $total , wc_get_price_decimals () ) : $total ;
}
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_line_total' , $total , $this , $item , $inc_tax , $round );
}
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
/**
* Get item tax - useful for gateways .
*
* @ param mixed $item
* @ param bool $round ( default : true ) .
* @ return float
*/
public function get_item_tax ( $item , $round = true ) {
$tax = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( is_callable ( array ( $item , 'get_total_tax' ) ) ) {
2016-08-16 11:36:38 +00:00
$tax = $item -> get_total_tax () / max ( 1 , $item -> get_quantity () );
2016-06-21 19:03:56 +00:00
$tax = $round ? wc_round_tax_total ( $tax ) : $tax ;
}
2015-11-19 16:07:04 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_amount_item_tax' , $tax , $item , $round , $this );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Get line tax - useful for gateways .
*
* @ param mixed $item
* @ return float
*/
public function get_line_tax ( $item ) {
return apply_filters ( 'woocommerce_order_amount_line_tax' , is_callable ( array ( $item , 'get_total_tax' ) ) ? wc_round_tax_total ( $item -> get_total_tax () ) : 0 , $item , $this );
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Gets line subtotal - formatted for display .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ param array $item
* @ param string $tax_display
* @ return string
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_formatted_line_subtotal ( $item , $tax_display = '' ) {
$tax_display = $tax_display ? $tax_display : get_option ( 'woocommerce_tax_display_cart' );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( 'excl' == $tax_display ) {
$ex_tax_label = $this -> get_prices_include_tax () ? 1 : 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
$subtotal = wc_price ( $this -> get_line_subtotal ( $item ), array ( 'ex_tax_label' => $ex_tax_label , 'currency' => $this -> get_currency () ) );
} else {
2016-08-27 02:23:54 +00:00
$subtotal = wc_price ( $this -> get_line_subtotal ( $item , true ), array ( 'currency' => $this -> get_currency () ) );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_formatted_line_subtotal' , $subtotal , $item , $this );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/**
* Gets order total - formatted for display .
* @ return string
*/
public function get_formatted_order_total () {
$formatted_total = wc_price ( $this -> get_total (), array ( 'currency' => $this -> get_currency () ) );
return apply_filters ( 'woocommerce_get_formatted_order_total' , $formatted_total , $this );
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Gets subtotal - subtotal is shown before discounts , but with localised taxes .
*
* @ param bool $compound ( default : false ) .
* @ param string $tax_display ( default : the tax_display_cart value ) .
* @ return string
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_subtotal_to_display ( $compound = false , $tax_display = '' ) {
$tax_display = $tax_display ? $tax_display : get_option ( 'woocommerce_tax_display_cart' );
$subtotal = 0 ;
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( ! $compound ) {
foreach ( $this -> get_items () as $item ) {
$subtotal += $item -> get_subtotal ();
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
if ( 'incl' === $tax_display ) {
$subtotal += $item -> get_subtotal_tax ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
$subtotal = wc_price ( $subtotal , array ( 'currency' => $this -> get_currency () ) );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( 'excl' === $tax_display && $this -> get_prices_include_tax () ) {
$subtotal .= ' <small class="tax_label">' . WC () -> countries -> ex_tax_or_vat () . '</small>' ;
}
} else {
if ( 'incl' === $tax_display ) {
return '' ;
}
foreach ( $this -> get_items () as $item ) {
$subtotal += $item -> get_subtotal ();
}
// Add Shipping Costs.
$subtotal += $this -> get_shipping_total ();
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
// Remove non-compound taxes.
foreach ( $this -> get_taxes () as $tax ) {
if ( $this -> is_compound () ) {
continue ;
}
$subtotal = $subtotal + $tax -> get_tax_total () + $tax -> get_shipping_tax_total ();
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
// Remove discounts.
$subtotal = $subtotal - $this -> get_total_discount ();
$subtotal = wc_price ( $subtotal , array ( 'currency' => $this -> get_currency () ) );
2015-01-30 14:14:34 +00:00
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_subtotal_to_display' , $subtotal , $compound , $this );
}
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Gets shipping ( formatted ) .
*
* @ return string
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_shipping_to_display ( $tax_display = '' ) {
$tax_display = $tax_display ? $tax_display : get_option ( 'woocommerce_tax_display_cart' );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $this -> get_shipping_total () != 0 ) {
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $tax_display == 'excl' ) {
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
// Show shipping excluding tax.
2016-08-27 02:23:54 +00:00
$shipping = wc_price ( $this -> get_shipping_total (), array ( 'currency' => $this -> get_currency () ) );
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
if ( $this -> get_shipping_tax () != 0 && $this -> get_prices_include_tax () ) {
$shipping .= apply_filters ( 'woocommerce_order_shipping_to_display_tax_label' , ' <small class="tax_label">' . WC () -> countries -> ex_tax_or_vat () . '</small>' , $this , $tax_display );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
} else {
// Show shipping including tax.
2016-08-27 02:23:54 +00:00
$shipping = wc_price ( $this -> get_shipping_total () + $this -> get_shipping_tax (), array ( 'currency' => $this -> get_currency () ) );
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $this -> get_shipping_tax () != 0 && ! $this -> get_prices_include_tax () ) {
$shipping .= apply_filters ( 'woocommerce_order_shipping_to_display_tax_label' , ' <small class="tax_label">' . WC () -> countries -> inc_tax_or_vat () . '</small>' , $this , $tax_display );
2014-06-13 13:35:53 +00:00
}
}
2016-06-21 19:03:56 +00:00
$shipping .= apply_filters ( 'woocommerce_order_shipping_to_display_shipped_via' , ' <small class="shipped_via">' . sprintf ( __ ( 'via %s' , 'woocommerce' ), $this -> get_shipping_method () ) . '</small>' , $this );
} elseif ( $this -> get_shipping_method () ) {
$shipping = $this -> get_shipping_method ();
} else {
$shipping = __ ( 'Free!' , 'woocommerce' );
2015-01-30 14:14:34 +00:00
}
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_order_shipping_to_display' , $shipping , $this );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Get the discount amount ( formatted ) .
* @ since 2.3 . 0
* @ return string
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_discount_to_display ( $tax_display = '' ) {
$tax_display = $tax_display ? $tax_display : get_option ( 'woocommerce_tax_display_cart' );
return apply_filters ( 'woocommerce_order_discount_to_display' , wc_price ( $this -> get_total_discount ( 'excl' === $tax_display && 'excl' === get_option ( 'woocommerce_tax_display_cart' ) ), array ( 'currency' => $this -> get_currency () ) ), $this );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Get totals for display on pages and in emails .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ param mixed $tax_display
* @ return array
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function get_order_item_totals ( $tax_display = '' ) {
$tax_display = $tax_display ? $tax_display : get_option ( 'woocommerce_tax_display_cart' );
$total_rows = array ();
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $subtotal = $this -> get_subtotal_to_display ( false , $tax_display ) ) {
$total_rows [ 'cart_subtotal' ] = array (
'label' => __ ( 'Subtotal:' , 'woocommerce' ),
'value' => $subtotal ,
);
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
if ( $this -> get_total_discount () > 0 ) {
$total_rows [ 'discount' ] = array (
'label' => __ ( 'Discount:' , 'woocommerce' ),
'value' => '-' . $this -> get_discount_to_display ( $tax_display ),
);
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $this -> get_shipping_method () ) {
$total_rows [ 'shipping' ] = array (
'label' => __ ( 'Shipping:' , 'woocommerce' ),
'value' => $this -> get_shipping_to_display ( $tax_display ),
);
2014-06-13 13:35:53 +00:00
}
2014-08-31 05:49:58 +00:00
2016-06-21 19:03:56 +00:00
if ( $fees = $this -> get_fees () ) {
foreach ( $fees as $id => $fee ) {
if ( apply_filters ( 'woocommerce_get_order_item_totals_excl_free_fees' , empty ( $fee [ 'line_total' ] ) && empty ( $fee [ 'line_tax' ] ), $id ) ) {
continue ;
}
2016-08-03 11:57:32 +00:00
$total_rows [ 'fee_' . $fee -> get_id () ] = array (
2016-06-21 19:03:56 +00:00
'label' => $fee -> get_name () . ':' ,
2016-08-27 02:23:54 +00:00
'value' => wc_price ( 'excl' === $tax_display ? $fee -> get_total () : $fee -> get_total () + $fee -> get_total_tax (), array ( 'currency' => $this -> get_currency () ) ),
2016-06-21 19:03:56 +00:00
);
}
2014-06-13 13:35:53 +00:00
}
2015-09-21 21:28:03 +00:00
2016-06-21 19:03:56 +00:00
// Tax for tax exclusive prices.
if ( 'excl' === $tax_display ) {
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( get_option ( 'woocommerce_tax_total_display' ) == 'itemized' ) {
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
foreach ( $this -> get_tax_totals () as $code => $tax ) {
$total_rows [ sanitize_title ( $code ) ] = array (
'label' => $tax -> label . ':' ,
'value' => $tax -> formatted_amount ,
);
}
} else {
$total_rows [ 'tax' ] = array (
'label' => WC () -> countries -> tax_or_vat () . ':' ,
'value' => wc_price ( $this -> get_total_tax (), array ( 'currency' => $this -> get_currency () ) ),
);
}
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $this -> get_total () > 0 && $this -> get_payment_method_title () ) {
$total_rows [ 'payment_method' ] = array (
'label' => __ ( 'Payment Method:' , 'woocommerce' ),
'value' => $this -> get_payment_method_title (),
);
}
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
if ( $refunds = $this -> get_refunds () ) {
foreach ( $refunds as $id => $refund ) {
$total_rows [ 'refund_' . $id ] = array (
2016-08-22 12:04:57 +00:00
'label' => $refund -> get_reason () ? $refund -> get_reason () : __ ( 'Refund' , 'woocommerce' ) . ':' ,
'value' => wc_price ( '-' . $refund -> get_amount (), array ( 'currency' => $this -> get_currency () ) ),
2016-06-21 19:03:56 +00:00
);
2014-06-13 13:35:53 +00:00
}
}
2016-06-21 19:03:56 +00:00
$total_rows [ 'order_total' ] = array (
'label' => __ ( 'Total:' , 'woocommerce' ),
'value' => $this -> get_formatted_order_total ( $tax_display ),
);
2014-06-13 13:35:53 +00:00
2016-06-21 19:03:56 +00:00
return apply_filters ( 'woocommerce_get_order_item_totals' , $total_rows , $this );
2014-06-13 13:35:53 +00:00
}
2016-06-21 19:03:56 +00:00
/*
|--------------------------------------------------------------------------
| Conditionals
|--------------------------------------------------------------------------
|
| Checks if a condition is true or false .
|
*/
2014-06-13 13:35:53 +00:00
/**
2016-06-21 19:03:56 +00:00
* Checks the order status against a passed in status .
2014-06-13 13:35:53 +00:00
*
* @ return bool
*/
2016-06-21 19:03:56 +00:00
public function has_status ( $status ) {
return apply_filters ( 'woocommerce_order_has_status' , ( is_array ( $status ) && in_array ( $this -> get_status (), $status ) ) || $this -> get_status () === $status ? true : false , $this , $status );
2014-06-13 13:35:53 +00:00
}
/**
2016-06-21 19:03:56 +00:00
* Check whether this order has a specific shipping method or not .
2014-06-13 13:35:53 +00:00
*
2016-06-21 19:03:56 +00:00
* @ param string $method_id
* @ return bool
2014-06-13 13:35:53 +00:00
*/
2016-06-21 19:03:56 +00:00
public function has_shipping_method ( $method_id ) {
2014-06-13 13:35:53 +00:00
foreach ( $this -> get_shipping_methods () as $shipping_method ) {
2016-08-25 09:58:04 +00:00
if ( strpos ( $shipping_method -> get_method_id (), $method_id ) === 0 ) {
2016-06-21 19:03:56 +00:00
return true ;
2014-06-13 13:35:53 +00:00
}
}
2016-06-21 19:03:56 +00:00
return false ;
2014-06-13 13:35:53 +00:00
}
2014-09-02 18:47:56 +00:00
2016-06-21 19:03:56 +00:00
/**
* Returns true if the order contains a free product .
* @ since 2.5 . 0
2014-09-02 18:47:56 +00:00
* @ return bool
*/
2016-06-21 19:03:56 +00:00
public function has_free_item () {
foreach ( $this -> get_items () as $item ) {
if ( ! $item -> get_total () ) {
return true ;
}
}
return false ;
2014-09-02 18:47:56 +00:00
}
2014-07-28 03:31:26 +00:00
}