forked from woocommerce/woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class-wc-shipping.php
450 lines (364 loc) · 12 KB
/
class-wc-shipping.php
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<?php
/**
* WooCommerce Shipping Class
*
* Handles shipping and loads shipping methods via hooks.
*
* @class WC_Shipping
* @version 2.3.0
* @package WooCommerce/Classes/Shipping
* @category Class
* @author WooThemes
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
class WC_Shipping {
/** @var bool True if shipping is enabled. */
public $enabled = false;
/** @var array Stores methods loaded into woocommerce. */
public $shipping_methods = array();
/** @var float Stores the cost of shipping */
public $shipping_total = 0;
/** @var array Stores an array of shipping taxes. */
public $shipping_taxes = array();
/** @var array Stores the shipping classes. */
public $shipping_classes = array();
/** @var array Stores packages to ship and to get quotes for. */
public $packages = array();
/**
* @var WC_Shipping The single instance of the class
* @since 2.1
*/
protected static $_instance = null;
/**
* Main WC_Shipping Instance
*
* Ensures only one instance of WC_Shipping is loaded or can be loaded.
*
* @since 2.1
* @static
* @return WC_Shipping Main instance
*/
public static function instance() {
if ( is_null( self::$_instance ) )
self::$_instance = new self();
return self::$_instance;
}
/**
* Cloning is forbidden.
*
* @since 2.1
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'woocommerce' ), '2.1' );
}
/**
* Unserializing instances of this class is forbidden.
*
* @since 2.1
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'woocommerce' ), '2.1' );
}
/**
* __construct function.
*
* @access public
* @return void
*/
public function __construct() {
$this->init();
}
/**
* init function.
*
* @access public
*/
public function init() {
do_action( 'woocommerce_shipping_init' );
$this->enabled = ( get_option('woocommerce_calc_shipping') == 'no' ) ? false : true;
}
/**
* load_shipping_methods function.
*
* Loads all shipping methods which are hooked in. If a $package is passed some methods may add themselves conditionally.
*
* Methods are sorted into their user-defined order after being loaded.
*
* @access public
* @param array $package
* @return array
*/
public function load_shipping_methods( $package = array() ) {
$this->unregister_shipping_methods();
// Methods can register themselves through this hook
do_action( 'woocommerce_load_shipping_methods', $package );
// Register methods through a filter
$shipping_methods_to_load = apply_filters( 'woocommerce_shipping_methods', array(
'WC_Shipping_Flat_Rate',
'WC_Shipping_Free_Shipping',
'WC_Shipping_International_Delivery',
'WC_Shipping_Local_Delivery',
'WC_Shipping_Local_Pickup'
) );
foreach ( $shipping_methods_to_load as $method )
$this->register_shipping_method( $method );
$this->sort_shipping_methods();
return $this->shipping_methods;
}
/**
* Register a shipping method for use in calculations.
*
* @access public
* @param object|string $method Either the name of the method's class, or an instance of the method's class
* @return void
*/
public function register_shipping_method( $method ) {
if ( ! is_object( $method ) )
$method = new $method();
$id = empty( $method->instance_id ) ? $method->id : $method->instance_id;
$this->shipping_methods[ $id ] = $method;
}
/**
* unregister_shipping_methods function.
*
* @access public
* @return void
*/
public function unregister_shipping_methods() {
unset( $this->shipping_methods );
}
/**
* sort_shipping_methods function.
*
* Sorts shipping methods into the user defined order.
*
* @access public
* @return array
*/
public function sort_shipping_methods() {
$sorted_shipping_methods = array();
// Get order option
$ordering = (array) get_option('woocommerce_shipping_method_order');
$order_end = 999;
// Load shipping methods in order
foreach ( $this->shipping_methods as $method ) {
if ( isset( $ordering[ $method->id ] ) && is_numeric( $ordering[ $method->id ] ) ) {
// Add in position
$sorted_shipping_methods[ $ordering[ $method->id ] ][] = $method;
} else {
// Add to end of the array
$sorted_shipping_methods[ $order_end ][] = $method;
}
}
ksort( $sorted_shipping_methods );
$this->shipping_methods = array();
foreach ( $sorted_shipping_methods as $methods )
foreach ( $methods as $method ) {
$id = empty( $method->instance_id ) ? $method->id : $method->instance_id;
$this->shipping_methods[ $id ] = $method;
}
return $this->shipping_methods;
}
/**
* get_shipping_methods function.
*
* Returns all registered shipping methods for usage.
*
* @access public
* @return array
*/
public function get_shipping_methods() {
return $this->shipping_methods;
}
/**
* get_shipping_classes function.
*
* Load shipping classes taxonomy terms.
*
* @access public
* @return array
*/
public function get_shipping_classes() {
if ( empty( $this->shipping_classes ) )
$this->shipping_classes = ( $classes = get_terms( 'product_shipping_class', array( 'hide_empty' => '0' ) ) ) ? $classes : array();
return $this->shipping_classes;
}
/**
* calculate_shipping function.
*
* Calculate shipping for (multiple) packages of cart items.
*
* @access public
* @param array $packages multi-dimensional array of cart items to calc shipping for
*/
public function calculate_shipping( $packages = array() ) {
if ( ! $this->enabled || empty( $packages ) ) {
return;
}
$this->shipping_total = null;
$this->shipping_taxes = array();
$this->packages = array();
// Calculate costs for passed packages
$package_keys = array_keys( $packages );
$package_keys_size = sizeof( $package_keys );
for ( $i = 0; $i < $package_keys_size; $i ++ ) {
$this->packages[ $package_keys[ $i ] ] = $this->calculate_shipping_for_package( $packages[ $package_keys[ $i ] ] );
}
// Get all chosen methods
$chosen_methods = WC()->session->get( 'chosen_shipping_methods' );
$method_counts = WC()->session->get( 'shipping_method_counts' );
// Get chosen methods for each package
foreach ( $this->packages as $i => $package ) {
$_cheapest_cost = false;
$_cheapest_method = false;
$chosen_method = false;
$method_count = false;
if ( ! empty( $chosen_methods[ $i ] ) ) {
$chosen_method = $chosen_methods[ $i ];
}
if ( ! empty( $method_counts[ $i ] ) ) {
$method_count = $method_counts[ $i ];
}
// Get available methods for package
$_available_methods = $package['rates'];
if ( sizeof( $_available_methods ) > 0 ) {
// If not set, not available, or available methods have changed, set to the default option
if ( empty( $chosen_method ) || ! isset( $_available_methods[ $chosen_method ] ) || $method_count != sizeof( $_available_methods ) ) {
$chosen_method = apply_filters( 'woocommerce_shipping_chosen_method', get_option( 'woocommerce_default_shipping_method' ), $_available_methods );
// Loops methods and find a match
if ( ! empty( $chosen_method ) && ! isset( $_available_methods[ $chosen_method ] ) ) {
foreach ( $_available_methods as $method_id => $method ) {
if ( strpos( $method->id, $chosen_method ) === 0 ) {
$chosen_method = $method->id;
break;
}
}
}
if ( empty( $chosen_method ) || ! isset( $_available_methods[ $chosen_method ] ) ) {
// Default to cheapest
foreach ( $_available_methods as $method_id => $method ) {
if ( $method->cost < $_cheapest_cost || ! is_numeric( $_cheapest_cost ) ) {
$_cheapest_cost = $method->cost;
$_cheapest_method = $method_id;
}
}
$chosen_method = $_cheapest_method;
}
// Store chosen method
$chosen_methods[ $i ] = $chosen_method;
$method_counts[ $i ] = sizeof( $_available_methods );
// Do action for this chosen method
do_action( 'woocommerce_shipping_method_chosen', $chosen_method );
}
// Store total costs
if ( $chosen_method ) {
$rate = $_available_methods[ $chosen_method ];
// Merge cost and taxes - label and ID will be the same
$this->shipping_total += $rate->cost;
foreach ( array_keys( $this->shipping_taxes + $rate->taxes ) as $key ) {
$this->shipping_taxes[ $key ] = ( isset( $rate->taxes[$key] ) ? $rate->taxes[$key] : 0 ) + ( isset( $this->shipping_taxes[$key] ) ? $this->shipping_taxes[$key] : 0 );
}
}
}
}
// Save all chosen methods (array)
WC()->session->set( 'chosen_shipping_methods', $chosen_methods );
WC()->session->set( 'shipping_method_counts', $method_counts );
}
/**
* calculate_shipping_for_package function.
*
* Calculates each shipping methods cost. Rates are cached based on the package to speed up calculations.
*
* @access public
* @param array $package cart items
* @return array
* @todo Return array() instead of false for consistent return type?
*/
public function calculate_shipping_for_package( $package = array() ) {
if ( ! $this->enabled ) return false;
if ( ! $package ) return false;
// Check if we need to recalculate shipping for this package
$package_hash = 'wc_ship_' . md5( json_encode( $package ) . WC_Cache_Helper::get_transient_version( 'shipping' ) );
$status_options = get_option( 'woocommerce_status_options', array() );
if ( false === ( $stored_rates = get_transient( $package_hash ) ) || ( ! empty( $status_options['shipping_debug_mode'] ) && current_user_can( 'manage_options' ) ) ) {
// Calculate shipping method rates
$package['rates'] = array();
foreach ( $this->load_shipping_methods( $package ) as $shipping_method ) {
if ( $shipping_method->is_available( $package ) && ( empty( $package['ship_via'] ) || in_array( $shipping_method->id, $package['ship_via'] ) ) ) {
// Reset Rates
$shipping_method->rates = array();
// Calculate Shipping for package
$shipping_method->calculate_shipping( $package );
// Place rates in package array
if ( ! empty( $shipping_method->rates ) && is_array( $shipping_method->rates ) )
foreach ( $shipping_method->rates as $rate )
$package['rates'][ $rate->id ] = $rate;
}
}
// Filter the calculated rates
$package['rates'] = apply_filters( 'woocommerce_package_rates', $package['rates'], $package );
// Store
set_transient( $package_hash, $package['rates'], 60 * 60 ); // Cached for an hour
} else {
$package['rates'] = $stored_rates;
}
return $package;
}
/**
* Get packages
* @return array
*/
public function get_packages() {
return $this->packages;
}
/**
* reset_shipping function.
*
* Reset the totals for shipping as a whole.
*
* @access public
* @return void
*/
public function reset_shipping() {
unset( WC()->session->chosen_shipping_methods );
$this->shipping_total = null;
$this->shipping_taxes = array();
$this->packages = array();
}
/**
* process_admin_options function.
*
* Saves options on the shipping setting page.
*
* @access public
* @return void
*/
public function process_admin_options() {
$default_shipping_method = ( isset( $_POST['default_shipping_method'] ) ) ? esc_attr( $_POST['default_shipping_method'] ) : '';
$method_order = ( isset( $_POST['method_order'] ) ) ? $_POST['method_order'] : '';
$order = array();
if ( is_array( $method_order ) && sizeof( $method_order ) > 0 ) {
$loop = 0;
foreach ($method_order as $method_id) {
$order[$method_id] = $loop;
$loop++;
}
}
update_option( 'woocommerce_default_shipping_method', $default_shipping_method );
update_option( 'woocommerce_shipping_method_order', $order );
}
}
/**
* Register a shipping method
*
* Registers a shipping method ready to be loaded. Accepts a class name (string) or a class object.
*
* @package WooCommerce/Classes/Shipping
* @since 1.5.7
*/
function woocommerce_register_shipping_method( $shipping_method ) {
$GLOBALS['woocommerce']->shipping->register_shipping_method( $shipping_method );
}