1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
<?php
/**
* Order Factory
*
* The WooCommerce order factory creating the right order objects.
*
* @version 3.0.0
* @package WooCommerce\Classes
*/
use Automattic\WooCommerce\Caches\OrderCache;
use Automattic\WooCommerce\Utilities\OrderUtil;
defined( 'ABSPATH' ) || exit;
/**
* Order factory class
*/
class WC_Order_Factory {
/**
* Get order.
*
* @param mixed $order_id (default: false) Order ID to get.
* @return \WC_Order|bool
*/
public static function get_order( $order_id = false ) {
$order_id = self::get_order_id( $order_id );
if ( ! $order_id ) {
return false;
}
$use_orders_cache = OrderUtil::orders_cache_usage_is_enabled();
if ( $use_orders_cache ) {
$order_cache = wc_get_container()->get( OrderCache::class );
$order = $order_cache->get( $order_id );
if ( ! is_null( $order ) ) {
return 0 === $order->get_id() ? false : $order;
}
}
$classname = self::get_class_name_for_order_id( $order_id );
if ( ! $classname ) {
return false;
}
try {
$order = new $classname( $order_id );
if ( $use_orders_cache && $order instanceof \WC_Abstract_Legacy_Order ) {
$order_cache->set( $order, $order_id );
}
return $order;
} catch ( Exception $e ) {
wc_caught_exception( $e, __FUNCTION__, array( $order_id ) );
return false;
}
}
/**
* Get multiple orders (by ID).
*
* @param array[mixed] $order_ids Array of order IDs to get.
* @param boolean $skip_invalid (default: false) TRUE if invalid IDs or orders should be ignored.
* @return array[\WC_Order]
*
* @throws \Exception When an invalid order is found.
*/
public static function get_orders( $order_ids = array(), $skip_invalid = false ) {
if ( empty( $order_ids ) ) {
return array();
}
$result = array();
$order_ids = array_filter( array_map( array( __CLASS__, 'get_order_id' ), $order_ids ) );
$original_order_sort = $order_ids;
$order_cache = wc_get_container()->get( OrderCache::class );
$already_cached_orders = array();
$use_orders_cache = OrderUtil::orders_cache_usage_is_enabled();
if ( $use_orders_cache ) {
$uncached_order_ids = array();
foreach ( $order_ids as $order_id ) {
$cached_order = $order_cache->get( absint( $order_id ) );
if ( $cached_order instanceof \WC_Abstract_Legacy_Order ) {
$already_cached_orders[ $order_id ] = $cached_order;
} else {
$uncached_order_ids[] = $order_id;
}
}
$order_ids = $uncached_order_ids;
}
// We separate order list by class, since their datastore might be different.
$order_list_by_class = array();
$order_id_classnames = self::get_class_names_for_order_ids( $order_ids );
foreach ( $order_id_classnames as $order_id => $classname ) {
if ( ! $classname && ! $skip_invalid ) {
// translators: %d is an order ID.
throw new \Exception( sprintf( __( 'Could not find classname for order ID %d', 'woocommerce' ), $order_id ) );
}
if ( ! isset( $order_list_by_class[ $classname ] ) ) {
$order_list_by_class[ $classname ] = array();
}
try {
$obj = new $classname();
$obj->set_defaults();
$obj->set_id( $order_id );
$order_list_by_class[ $classname ][ $order_id ] = $obj;
} catch ( \Exception $e ) {
wc_caught_exception( $e, __FUNCTION__, array( $order_id ) );
if ( ! $skip_invalid ) {
throw $e;
}
}
}
foreach ( $order_list_by_class as $classname => $order_list ) {
$data_store = ( new $classname() )->get_data_store();
try {
$data_store->read_multiple( $order_list );
} catch ( \Exception $e ) {
wc_caught_exception( $e, __FUNCTION__, $order_ids );
if ( ! $skip_invalid ) {
throw $e;
}
}
foreach ( $order_list as $order ) {
$result[ $order->get_id() ] = $order;
}
}
if ( $use_orders_cache ) {
foreach ( $result as $order_id => $order ) {
$order_cache->set( $order, $order->get_id() );
}
$result = array_replace( $result, $already_cached_orders );
}
// restore the sort order.
$result = array_values( array_replace( array_flip( $original_order_sort ), $result ) );
return $result;
}
/**
* Get order item.
*
* @param int $item_id Order item ID to get.
* @return WC_Order_Item|false if not found
*/
public static function get_order_item( $item_id = 0 ) {
if ( is_numeric( $item_id ) ) {
$item_type = WC_Data_Store::load( 'order-item' )->get_order_item_type( $item_id );
$id = $item_id;
} elseif ( $item_id instanceof WC_Order_Item ) {
$item_type = $item_id->get_type();
$id = $item_id->get_id();
} elseif ( is_object( $item_id ) && ! empty( $item_id->order_item_type ) ) {
$id = $item_id->order_item_id;
$item_type = $item_id->order_item_type;
} else {
$item_type = false;
$id = false;
}
if ( $id && $item_type ) {
$classname = false;
switch ( $item_type ) {
case 'line_item':
case 'product':
$classname = 'WC_Order_Item_Product';
break;
case 'coupon':
$classname = 'WC_Order_Item_Coupon';
break;
case 'fee':
$classname = 'WC_Order_Item_Fee';
break;
case 'shipping':
$classname = 'WC_Order_Item_Shipping';
break;
case 'tax':
$classname = 'WC_Order_Item_Tax';
break;
}
$classname = apply_filters( 'woocommerce_get_order_item_classname', $classname, $item_type, $id );
if ( $classname && class_exists( $classname ) ) {
try {
return new $classname( $id );
} catch ( Exception $e ) {
return false;
}
}
}
return false;
}
/**
* Get the order ID depending on what was passed.
*
* @since 3.0.0
* @param mixed $order Order data to convert to an ID.
* @return int|bool false on failure
*/
public static function get_order_id( $order ) {
if ( false === $order ) {
return self::get_global_order_id();
} elseif ( is_numeric( $order ) ) {
return $order;
} elseif ( $order instanceof WC_Abstract_Order ) {
return $order->get_id();
} elseif ( ! empty( $order->ID ) ) {
return $order->ID;
} else {
return false;
}
}
/**
* Try to determine the current order ID based on available global state.
*
* @return false|int
*/
private static function get_global_order_id() {
global $post;
global $theorder;
// Initialize the global $theorder object if necessary.
if ( ! isset( $theorder ) || ! $theorder instanceof WC_Abstract_Order ) {
if ( ! isset( $post ) || 'shop_order' !== $post->post_type ) {
return false;
} else {
OrderUtil::init_theorder_object( $post );
}
}
if ( $theorder instanceof WC_Order ) {
return $theorder->get_id();
} elseif ( is_a( $post, 'WP_Post' ) && 'shop_order' === get_post_type( $post ) ) {
return absint( $post->ID );
} else {
return false;
}
}
/**
* Gets the class name bunch of order instances should have based on their IDs.
*
* @param array $order_ids Order IDs to get the class name for.
*
* @return array Array of order_id => class_name.
*/
public static function get_class_names_for_order_ids( $order_ids ) {
$order_data_store = WC_Data_Store::load( 'order' );
if ( $order_data_store->has_callable( 'get_orders_type' ) ) {
$order_types = $order_data_store->get_orders_type( $order_ids );
} else {
$order_types = array();
foreach ( $order_ids as $order_id ) {
$order_types[ $order_id ] = $order_data_store->get_order_type( $order_id );
}
}
$order_class_names = array();
foreach ( $order_types as $order_id => $order_type ) {
$order_type_data = wc_get_order_type( $order_type );
if ( $order_type_data ) {
$order_class_names[ $order_id ] = $order_type_data['class_name'];
} else {
$order_class_names[ $order_id ] = false;
}
/**
* Filter classname so that the class can be overridden if extended.
*
* @param string $classname Order classname.
* @param string $order_type Order type.
* @param int $order_id Order ID.
*
* @since 3.0.0
*/
$order_class_names[ $order_id ] = apply_filters( 'woocommerce_order_class', $order_class_names[ $order_id ], $order_type, $order_id );
if ( ! class_exists( $order_class_names[ $order_id ] ) ) {
$order_class_names[ $order_id ] = false;
}
}
return $order_class_names;
}
/**
* Gets the class name an order instance should have based on its ID.
*
* @since 6.9.0
* @param int $order_id The order ID.
* @return string The class name or FALSE if the class does not exist.
*/
private static function get_class_name_for_order_id( $order_id ) {
$classname = self::get_class_names_for_order_ids( array( $order_id ) );
return $classname[ $order_id ] ?? false;
}
}
|