OrderTraits.php — WooCommerce 10.9.1

woocommerce / src / Admin / Overrides / OrderTraits.php

woocommerce / src / Admin / Overrides Last commit date

Order.php 2 months ago OrderRefund.php 3 years ago OrderTraits.php 2 months ago ThemeUpgrader.php 4 years ago ThemeUpgraderSkin.php 4 years ago

OrderTraits.php

130 lines

1	<?php
2	/**
3	* WC Admin Order Trait
4	*
5	* WC Admin Order Trait class that houses shared functionality across order and refund classes.
6	*/
7
8	namespace Automattic\WooCommerce\Admin\Overrides;
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	use Automattic\WooCommerce\Enums\OrderItemType;
13
14	/**
15	* OrderTraits class.
16	*/
17	trait OrderTraits {
18	/**
19	* Calculate shipping amount for line item/product as a total shipping amount ratio based on quantity.
20	*
21	* @param WC_Order_Item $item Line item from order.
22	* @param int $order_items_count (optional) The number of order items in an order. This could be the remaining items left to refund.
23	* @param float $shipping_amount (optional) The shipping fee amount in an order. This could be the remaining shipping amount left to refund.
24	*
25	* @return float\|int
26	*/
27	public function get_item_shipping_amount( $item, $order_items_count = null, $shipping_amount = null ) {
28	// Shipping amount loosely based on woocommerce code in includes/admin/meta-boxes/views/html-order-item(s).php
29	// distributed simply based on number of line items.
30	$product_qty = $item->get_quantity( 'edit' );
31
32	// Use the passed order_items_count if provided, otherwise get the total number of items in the order.
33	// This is useful when calculating refunds for partial items in an order.
34	// For example, if 2 items are refunded from an order with 4 items. The remaining 2 items should have the shipping fee of the refunded items distributed to them.
35	$order_items = null !== $order_items_count ? $order_items_count : $this->get_item_count();
36
37	if ( 0 === $order_items ) {
38	return 0;
39	}
40
41	// Use the passed shipping_amount if provided, otherwise get the total shipping amount in the order.
42	// This is useful when calculating refunds for partial shipping in an order.
43	// For example, if $10 shipping is refunded from an order with $30 shipping, the remaining $20 should be distributed to the remaining items.
44	$total_shipping_amount = null !== $shipping_amount ? $shipping_amount : (float) $this->get_shipping_total();
45
46	return $total_shipping_amount / $order_items * $product_qty;
47	}
48
49	/**
50	* Calculate shipping tax amount for line item/product as a total shipping tax amount ratio based on quantity.
51	*
52	* Loosely based on code in includes/admin/meta-boxes/views/html-order-item(s).php.
53	*
54	* @todo If WC is currently not tax enabled, but it was before (or vice versa), would this work correctly?
55	*
56	* @param WC_Order_Item $item Line item from order.
57	* @param int $order_items_count (optional) The number of order items in an order. This could be the remaining items left to refund.
58	* @param float $shipping_tax_amount (optional) The shipping tax amount in an order. This could be the remaining shipping tax amount left to refund.
59	*
60	* @return float\|int
61	*/
62	public function get_item_shipping_tax_amount( $item, $order_items_count = null, $shipping_tax_amount = null ) {
63	// Use the passed order_items_count if provided, otherwise get the total number of items in the order.
64	// This is useful when calculating refunds for partial items in an order.
65	// For example, if 2 items are refunded from an order with 4 items. The remaining 2 items should have the shipping tax of the refunded items distributed to them.
66	$order_items = null !== $order_items_count ? $order_items_count : $this->get_item_count();
67
68	if ( 0 === $order_items ) {
69	return 0;
70	}
71
72	// Use the passed shipping_tax_amount if provided, otherwise initialize it to 0 and calculate the total shipping tax amount in the order.
73	// This is useful when calculating refunds for partial shipping tax in an order.
74	// For example, if $1 shipping tax is refunded from an order with $3 shipping tax, the remaining $2 should be distributed to the remaining items.
75	$total_shipping_tax_amount = $shipping_tax_amount ? $shipping_tax_amount : 0;
76
77	if ( null === $shipping_tax_amount ) {
78	$order_taxes = $this->get_taxes();
79	$line_items_shipping = $this->get_items( OrderItemType::SHIPPING );
80	foreach ( $line_items_shipping as $item_id => $shipping_item ) {
81	$tax_data = $shipping_item->get_taxes();
82	if ( $tax_data ) {
83	foreach ( $order_taxes as $tax_item ) {
84	$tax_item_id = $tax_item->get_rate_id();
85	$tax_item_total = isset( $tax_data['total'][ $tax_item_id ] ) ? (float) $tax_data['total'][ $tax_item_id ] : 0;
86	$total_shipping_tax_amount += $tax_item_total;
87	}
88	}
89	}
90	}
91
92	$product_qty = $item->get_quantity( 'edit' );
93
94	return $total_shipping_tax_amount / $order_items * $product_qty;
95	}
96
97	/**
98	* Calculates coupon amount for specified line item/product.
99	*
100	* Coupon calculation based on woocommerce code in includes/admin/meta-boxes/views/html-order-item.php.
101	*
102	* @param WC_Order_Item $item Line item from order.
103	*
104	* @return float
105	*/
106	public function get_item_coupon_amount( $item ) {
107	return floatval( $item->get_subtotal( 'edit' ) - $item->get_total( 'edit' ) );
108	}
109
110	/**
111	* Calculate cart tax amount for line item/product.
112	*
113	* @param WC_Order_Item $item Line item from order.
114	*
115	* @return float
116	*/
117	public function get_item_cart_tax_amount( $item ) {
118	$order_taxes = $this->get_taxes();
119	$tax_data = $item->get_taxes();
120	$cart_tax_amount = 0.0;
121
122	foreach ( $order_taxes as $tax_item ) {
123	$tax_item_id = $tax_item->get_rate_id();
124	$cart_tax_amount += isset( $tax_data['total'][ $tax_item_id ] ) ? (float) $tax_data['total'][ $tax_item_id ] : 0;
125	}
126
127	return $cart_tax_amount;
128	}
129	}
130