forked from woocommerce/woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass-wc-order.php
1960 lines (1736 loc) · 57.7 KB
/
class-wc-order.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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Regular order
*
* @author Automattic
* @package WooCommerce\Classes
* @version 2.2.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Order Class.
*
* These are regular WooCommerce orders, which extend the abstract order class.
*/
class WC_Order extends WC_Abstract_Order {
/**
* Stores data about status changes so relevant hooks can be fired.
*
* @var bool|array
*/
protected $status_transition = false;
/**
* Order Data array. This is the core order data exposed in APIs since 3.0.0.
*
* @since 3.0.0
* @var array
*/
protected $data = array(
// Abstract order props.
'parent_id' => 0,
'status' => '',
'currency' => '',
'version' => '',
'prices_include_tax' => false,
'date_created' => null,
'date_modified' => null,
'discount_total' => 0,
'discount_tax' => 0,
'shipping_total' => 0,
'shipping_tax' => 0,
'cart_tax' => 0,
'total' => 0,
'total_tax' => 0,
// Order props.
'customer_id' => 0,
'order_key' => '',
'billing' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
'email' => '',
'phone' => '',
),
'shipping' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
),
'payment_method' => '',
'payment_method_title' => '',
'transaction_id' => '',
'customer_ip_address' => '',
'customer_user_agent' => '',
'created_via' => '',
'customer_note' => '',
'date_completed' => null,
'date_paid' => null,
'cart_hash' => '',
);
/**
* When a payment is complete this function is called.
*
* Most of the time this should mark an order as 'processing' so that admin can process/post the items.
* If the cart contains only downloadable items then the order is 'completed' since the admin needs to take no action.
* Stock levels are reduced at this point.
* Sales are also recorded for products.
* Finally, record the date of payment.
*
* @param string $transaction_id Optional transaction id to store in post meta.
* @return bool success
*/
public function payment_complete( $transaction_id = '' ) {
if ( ! $this->get_id() ) { // Order must exist.
return false;
}
if ( $this->get_changes() ) { // Before updating the order status, let's ensure other changes are already persisted to the DB.
$this->save();
}
try {
wc_transaction_query( 'start' );
do_action( 'woocommerce_pre_payment_complete', $this->get_id() );
if ( WC()->session ) {
WC()->session->set( 'order_awaiting_payment', false );
}
if ( $this->has_status( apply_filters( 'woocommerce_valid_order_statuses_for_payment_complete', array( 'on-hold', 'pending', 'failed', 'cancelled' ), $this ) ) ) {
if ( ! empty( $transaction_id ) ) {
$this->set_transaction_id( $transaction_id );
}
if ( ! $this->get_date_paid( 'edit' ) ) {
$this->set_date_paid( current_time( 'timestamp', true ) );
}
$this->set_status( apply_filters( 'woocommerce_payment_complete_order_status', $this->needs_processing() ? 'processing' : 'completed', $this->get_id(), $this ) );
$this->save();
do_action( 'woocommerce_payment_complete', $this->get_id() );
} else {
do_action( 'woocommerce_payment_complete_order_status_' . $this->get_status(), $this->get_id() );
}
wc_transaction_query( 'commit' );
} catch ( Exception $e ) {
wc_transaction_query( 'rollback' );
$logger = wc_get_logger();
$logger->error( sprintf( 'Payment complete of order #%d failed!', $this->get_id() ), array(
'order' => $this,
'error' => $e,
) );
$this->add_order_note( __( 'Payment complete event failed.', 'woocommerce' ) . ' ' . $e->getMessage() );
return false;
}
return true;
}
/**
* Gets order total - formatted for display.
*
* @param string $tax_display Type of tax display.
* @param bool $display_refunded If should include refunded value.
*
* @return string
*/
public function get_formatted_order_total( $tax_display = '', $display_refunded = true ) {
$formatted_total = wc_price( $this->get_total(), array( 'currency' => $this->get_currency() ) );
$order_total = $this->get_total();
$total_refunded = $this->get_total_refunded();
$tax_string = '';
// Tax for inclusive prices.
if ( wc_tax_enabled() && 'incl' === $tax_display ) {
$tax_string_array = array();
$tax_totals = $this->get_tax_totals();
if ( 'itemized' === get_option( 'woocommerce_tax_total_display' ) ) {
foreach ( $tax_totals as $code => $tax ) {
$tax_amount = ( $total_refunded && $display_refunded ) ? wc_price( WC_Tax::round( $tax->amount - $this->get_total_tax_refunded_by_rate_id( $tax->rate_id ) ), array( 'currency' => $this->get_currency() ) ) : $tax->formatted_amount;
$tax_string_array[] = sprintf( '%s %s', $tax_amount, $tax->label );
}
} elseif ( ! empty( $tax_totals ) ) {
$tax_amount = ( $total_refunded && $display_refunded ) ? $this->get_total_tax() - $this->get_total_tax_refunded() : $this->get_total_tax();
$tax_string_array[] = sprintf( '%s %s', wc_price( $tax_amount, array( 'currency' => $this->get_currency() ) ), WC()->countries->tax_or_vat() );
}
if ( ! empty( $tax_string_array ) ) {
/* translators: %s: taxes */
$tax_string = ' <small class="includes_tax">' . sprintf( __( '(includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) ) . '</small>';
}
}
if ( $total_refunded && $display_refunded ) {
$formatted_total = '<del>' . strip_tags( $formatted_total ) . '</del> <ins>' . wc_price( $order_total - $total_refunded, array( 'currency' => $this->get_currency() ) ) . $tax_string . '</ins>';
} else {
$formatted_total .= $tax_string;
}
/**
* Filter WooCommerce formatted order total.
*
* @param string $formatted_total Total to display.
* @param WC_Order $order Order data.
* @param string $tax_display Type of tax display.
* @param bool $display_refunded If should include refunded value.
*/
return apply_filters( 'woocommerce_get_formatted_order_total', $formatted_total, $this, $tax_display, $display_refunded );
}
/*
|--------------------------------------------------------------------------
| 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).
|
*/
/**
* Save data to the database.
*
* @since 3.0.0
* @return int order ID
*/
public function save() {
try {
$this->maybe_set_user_billing_email();
if ( $this->data_store ) {
// Trigger action before saving to the DB. Allows you to adjust object props before save.
do_action( 'woocommerce_before_' . $this->object_type . '_object_save', $this, $this->data_store );
if ( $this->get_id() ) {
$this->data_store->update( $this );
} else {
$this->data_store->create( $this );
}
}
$this->save_items();
$this->status_transition();
} catch ( Exception $e ) {
$logger = wc_get_logger();
$logger->error( sprintf( 'Error saving order #%d', $this->get_id() ), array(
'order' => $this,
'error' => $e,
) );
$this->add_order_note( __( 'Error saving order.', 'woocommerce' ) . ' ' . $e->getMessage() );
}
return $this->get_id();
}
/**
* Set order status.
*
* @since 3.0.0
* @param string $new_status Status to change the order to. No internal wc- prefix is required.
* @param string $note Optional note to add.
* @param bool $manual_update Is this a manual order status change?.
* @return array
*/
public function set_status( $new_status, $note = '', $manual_update = false ) {
$result = parent::set_status( $new_status );
if ( true === $this->object_read && ! empty( $result['from'] ) && $result['from'] !== $result['to'] ) {
$this->status_transition = array(
'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $result['from'],
'to' => $result['to'],
'note' => $note,
'manual' => (bool) $manual_update,
);
$this->maybe_set_date_paid();
$this->maybe_set_date_completed();
}
return $result;
}
/**
* Maybe set date paid.
*
* Sets the date paid variable when transitioning to the payment complete
* order status. This is either processing or completed. This is not filtered
* to avoid infinite loops e.g. if loading an order via the filter.
*
* Date paid is set once in this manner - only when it is not already set.
* This ensures the data exists even if a gateway does not use the
* `payment_complete` method.
*
* @since 3.0.0
*/
public function maybe_set_date_paid() {
if ( ! $this->get_date_paid( 'edit' ) && $this->has_status( apply_filters( 'woocommerce_payment_complete_order_status', $this->needs_processing() ? 'processing' : 'completed', $this->get_id(), $this ) ) ) {
$this->set_date_paid( current_time( 'timestamp', true ) );
}
}
/**
* Maybe set date completed.
*
* Sets the date completed variable when transitioning to completed status.
*
* @since 3.0.0
*/
protected function maybe_set_date_completed() {
if ( $this->has_status( 'completed' ) ) {
$this->set_date_completed( current_time( 'timestamp', true ) );
}
}
/**
* Updates status of order immediately.
*
* @uses WC_Order::set_status()
* @param string $new_status Status to change the order to. No internal wc- prefix is required.
* @param string $note Optional note to add.
* @param bool $manual Is this a manual order status change?.
* @return bool
*/
public function update_status( $new_status, $note = '', $manual = false ) {
if ( ! $this->get_id() ) { // Order must exist.
return false;
}
if ( $this->get_changes() ) { // Before updating the order status, let's ensure other changes are already persisted to the DB.
$this->save();
}
try {
wc_transaction_query( 'start' );
$this->set_status( $new_status, $note, $manual );
$this->save();
wc_transaction_query( 'commit' );
} catch ( Exception $e ) {
wc_transaction_query( 'rollback' );
$logger = wc_get_logger();
$logger->error( sprintf( 'Update status of order #%d failed!', $this->get_id() ), array(
'order' => $this,
'error' => $e,
) );
$this->add_order_note( __( 'Update status event failed.', 'woocommerce' ) . ' ' . $e->getMessage() );
return false;
}
return true;
}
/**
* Handle the status transition.
*/
protected function status_transition() {
$status_transition = $this->status_transition;
// Reset status transition variable.
$this->status_transition = false;
if ( $status_transition ) {
try {
do_action( 'woocommerce_order_status_' . $status_transition['to'], $this->get_id(), $this );
if ( ! empty( $status_transition['from'] ) ) {
/* translators: 1: old order status 2: new order status */
$transition_note = sprintf( __( 'Order status changed from %1$s to %2$s.', 'woocommerce' ), wc_get_order_status_name( $status_transition['from'] ), wc_get_order_status_name( $status_transition['to'] ) );
do_action( 'woocommerce_order_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
do_action( 'woocommerce_order_status_changed', $this->get_id(), $status_transition['from'], $status_transition['to'], $this );
} else {
/* translators: %s: new order status */
$transition_note = sprintf( __( 'Order status set to %s.', 'woocommerce' ), wc_get_order_status_name( $status_transition['to'] ) );
}
// Note the transition occurred.
$this->add_order_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] );
} catch ( Exception $e ) {
$logger = wc_get_logger();
$logger->error( sprintf( 'Status transition of order #%d errored!', $this->get_id() ), array(
'order' => $this,
'error' => $e,
) );
$this->add_order_note( __( 'Error during status transition.', 'woocommerce' ) . ' ' . $e->getMessage() );
}
}
}
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
|
| Methods for getting data from the order object.
|
*/
/**
* Get all class data in array format.
*
* @since 3.0.0
* @return array
*/
public function get_data() {
return array_merge(
array(
'id' => $this->get_id(),
),
$this->data,
array(
'number' => $this->get_order_number(),
'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' ),
)
);
}
/**
* Expands the shipping and billing information in the changes array.
*/
public function get_changes() {
$changed_props = parent::get_changes();
$subs = array( 'shipping', 'billing' );
foreach ( $subs as $sub ) {
if ( ! empty( $changed_props[ $sub ] ) ) {
foreach ( $changed_props[ $sub ] as $sub_prop => $value ) {
$changed_props[ $sub . '_' . $sub_prop ] = $value;
}
}
}
if ( isset( $changed_props['customer_note'] ) ) {
$changed_props['post_excerpt'] = $changed_props['customer_note'];
}
return $changed_props;
}
/**
* Gets the order number for display (by default, order ID).
*
* @return string
*/
public function get_order_number() {
return (string) apply_filters( 'woocommerce_order_number', $this->get_id(), $this );
}
/**
* Get order key.
*
* @since 3.0.0
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_order_key( $context = 'view' ) {
return $this->get_prop( 'order_key', $context );
}
/**
* Get customer_id.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return int
*/
public function get_customer_id( $context = 'view' ) {
return $this->get_prop( 'customer_id', $context );
}
/**
* Alias for get_customer_id().
*
* @param string $context What the value is for. Valid values are view and edit.
* @return int
*/
public function get_user_id( $context = 'view' ) {
return $this->get_customer_id( $context );
}
/**
* Get the user associated with the order. False for guests.
*
* @return WP_User|false
*/
public function get_user() {
return $this->get_user_id() ? get_user_by( 'id', $this->get_user_id() ) : false;
}
/**
* Gets a prop for a getter method.
*
* @since 3.0.0
* @param string $prop Name of prop to get.
* @param string $address billing or shipping.
* @param string $context What the value is for. Valid values are view and edit.
* @return mixed
*/
protected function get_address_prop( $prop, $address = 'billing', $context = 'view' ) {
$value = null;
if ( array_key_exists( $prop, $this->data[ $address ] ) ) {
$value = isset( $this->changes[ $address ][ $prop ] ) ? $this->changes[ $address ][ $prop ] : $this->data[ $address ][ $prop ];
if ( 'view' === $context ) {
$value = apply_filters( $this->get_hook_prefix() . $address . '_' . $prop, $value, $this );
}
}
return $value;
}
/**
* Get billing first name.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_first_name( $context = 'view' ) {
return $this->get_address_prop( 'first_name', 'billing', $context );
}
/**
* Get billing last name.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_last_name( $context = 'view' ) {
return $this->get_address_prop( 'last_name', 'billing', $context );
}
/**
* Get billing company.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_company( $context = 'view' ) {
return $this->get_address_prop( 'company', 'billing', $context );
}
/**
* Get billing address line 1.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_address_1( $context = 'view' ) {
return $this->get_address_prop( 'address_1', 'billing', $context );
}
/**
* Get billing address line 2.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_address_2( $context = 'view' ) {
return $this->get_address_prop( 'address_2', 'billing', $context );
}
/**
* Get billing city.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_city( $context = 'view' ) {
return $this->get_address_prop( 'city', 'billing', $context );
}
/**
* Get billing state.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_state( $context = 'view' ) {
return $this->get_address_prop( 'state', 'billing', $context );
}
/**
* Get billing postcode.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_postcode( $context = 'view' ) {
return $this->get_address_prop( 'postcode', 'billing', $context );
}
/**
* Get billing country.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_country( $context = 'view' ) {
return $this->get_address_prop( 'country', 'billing', $context );
}
/**
* Get billing email.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_email( $context = 'view' ) {
return $this->get_address_prop( 'email', 'billing', $context );
}
/**
* Get billing phone.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_billing_phone( $context = 'view' ) {
return $this->get_address_prop( 'phone', 'billing', $context );
}
/**
* Get shipping first name.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_first_name( $context = 'view' ) {
return $this->get_address_prop( 'first_name', 'shipping', $context );
}
/**
* Get shipping_last_name.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_last_name( $context = 'view' ) {
return $this->get_address_prop( 'last_name', 'shipping', $context );
}
/**
* Get shipping company.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_company( $context = 'view' ) {
return $this->get_address_prop( 'company', 'shipping', $context );
}
/**
* Get shipping address line 1.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_address_1( $context = 'view' ) {
return $this->get_address_prop( 'address_1', 'shipping', $context );
}
/**
* Get shipping address line 2.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_address_2( $context = 'view' ) {
return $this->get_address_prop( 'address_2', 'shipping', $context );
}
/**
* Get shipping city.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_city( $context = 'view' ) {
return $this->get_address_prop( 'city', 'shipping', $context );
}
/**
* Get shipping state.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_state( $context = 'view' ) {
return $this->get_address_prop( 'state', 'shipping', $context );
}
/**
* Get shipping postcode.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_postcode( $context = 'view' ) {
return $this->get_address_prop( 'postcode', 'shipping', $context );
}
/**
* Get shipping country.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_shipping_country( $context = 'view' ) {
return $this->get_address_prop( 'country', 'shipping', $context );
}
/**
* Get the payment method.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_payment_method( $context = 'view' ) {
return $this->get_prop( 'payment_method', $context );
}
/**
* Get payment method title.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_payment_method_title( $context = 'view' ) {
return $this->get_prop( 'payment_method_title', $context );
}
/**
* Get transaction d.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_transaction_id( $context = 'view' ) {
return $this->get_prop( 'transaction_id', $context );
}
/**
* Get customer ip address.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_customer_ip_address( $context = 'view' ) {
return $this->get_prop( 'customer_ip_address', $context );
}
/**
* Get customer user agent.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_customer_user_agent( $context = 'view' ) {
return $this->get_prop( 'customer_user_agent', $context );
}
/**
* Get created via.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_created_via( $context = 'view' ) {
return $this->get_prop( 'created_via', $context );
}
/**
* Get customer note.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_customer_note( $context = 'view' ) {
return $this->get_prop( 'customer_note', $context );
}
/**
* Get date completed.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return WC_DateTime|NULL object if the date is set or null if there is no date.
*/
public function get_date_completed( $context = 'view' ) {
return $this->get_prop( 'date_completed', $context );
}
/**
* Get date paid.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return WC_DateTime|NULL object if the date is set or null if there is no date.
*/
public function get_date_paid( $context = 'view' ) {
$date_paid = $this->get_prop( 'date_paid', $context );
if ( 'view' === $context && ! $date_paid && version_compare( $this->get_version( 'edit' ), '3.0', '<' ) && $this->has_status( apply_filters( 'woocommerce_payment_complete_order_status', $this->needs_processing() ? 'processing' : 'completed', $this->get_id(), $this ) ) ) {
// In view context, return a date if missing.
$date_paid = $this->get_date_created( 'edit' );
}
return $date_paid;
}
/**
* Get cart hash.
*
* @param string $context What the value is for. Valid values are view and edit.
* @return string
*/
public function get_cart_hash( $context = 'view' ) {
return $this->get_prop( 'cart_hash', $context );
}
/**
* Returns the requested address in raw, non-formatted way.
* Note: Merges raw data with get_prop data so changes are returned too.
*
* @since 2.4.0
* @param string $type Billing or shipping. Anything else besides 'billing' will return shipping address.
* @return array The stored address after filter.
*/
public function get_address( $type = 'billing' ) {
return apply_filters( 'woocommerce_get_order_address', array_merge( $this->data[ $type ], $this->get_prop( $type, 'view' ) ), $type, $this );
}
/**
* Get a formatted shipping address for the order.
*
* @return string
*/
public function get_shipping_address_map_url() {
$address = $this->get_address( 'shipping' );
// Remove name and company before generate the Google Maps URL.
unset( $address['first_name'], $address['last_name'], $address['company'] );
$address = apply_filters( 'woocommerce_shipping_address_map_url_parts', $address, $this );
return apply_filters( 'woocommerce_shipping_address_map_url', 'https://maps.google.com/maps?&q=' . rawurlencode( implode( ', ', $address ) ) . '&z=16', $this );
}
/**
* Get a formatted billing full name.
*
* @return string
*/
public function get_formatted_billing_full_name() {
/* translators: 1: first name 2: last name */
return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $this->get_billing_first_name(), $this->get_billing_last_name() );
}
/**
* Get a formatted shipping full name.
*
* @return string
*/
public function get_formatted_shipping_full_name() {
/* translators: 1: first name 2: last name */
return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $this->get_shipping_first_name(), $this->get_shipping_last_name() );
}
/**
* Get a formatted billing address for the order.
*
* @param string $empty_content Content to show if no address is present. @since 3.3.0.
* @return string
*/
public function get_formatted_billing_address( $empty_content = '' ) {
$address = apply_filters( 'woocommerce_order_formatted_billing_address', $this->get_address( 'billing' ), $this );
$address = WC()->countries->get_formatted_address( $address );
return $address ? $address : $empty_content;
}
/**
* Get a formatted shipping address for the order.
*
* @param string $empty_content Content to show if no address is present. @since 3.3.0.
* @return string
*/
public function get_formatted_shipping_address( $empty_content = '' ) {
$address = '';
if ( $this->has_shipping_address() ) {
$address = apply_filters( 'woocommerce_order_formatted_shipping_address', $this->get_address( 'shipping' ), $this );
$address = WC()->countries->get_formatted_address( $address );
}
return $address ? $address : $empty_content;
}
/**
* Returns true if the order has a billing address.
*
* @since 3.0.4
* @return boolean
*/
public function has_billing_address() {
return $this->get_billing_address_1() || $this->get_billing_address_2();
}
/**
* Returns true if the order has a shipping address.
*
* @since 3.0.4
* @return boolean
*/
public function has_shipping_address() {
return $this->get_shipping_address_1() || $this->get_shipping_address_2();
}
/*
|--------------------------------------------------------------------------
| 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 3.0.0 some of these
| setters may handle both.
|
*/
/**
* Sets a prop for a setter method.
*
* @since 3.0.0
* @param string $prop Name of prop to set.
* @param string $address Name of address to set. billing or shipping.
* @param mixed $value Value of the prop.
*/
protected function set_address_prop( $prop, $address = 'billing', $value ) {
if ( array_key_exists( $prop, $this->data[ $address ] ) ) {
if ( true === $this->object_read ) {
if ( $value !== $this->data[ $address ][ $prop ] || ( isset( $this->changes[ $address ] ) && array_key_exists( $prop, $this->changes[ $address ] ) ) ) {
$this->changes[ $address ][ $prop ] = $value;
}
} else {
$this->data[ $address ][ $prop ] = $value;
}
}
}
/**
* Set order key.
*
* @param string $value Max length 22 chars.
* @throws WC_Data_Exception Throws exception when invalid data is found.
*/
public function set_order_key( $value ) {
$this->set_prop( 'order_key', substr( $value, 0, 22 ) );
}
/**
* Set customer id.
*
* @param int $value Customer ID.
* @throws WC_Data_Exception Throws exception when invalid data is found.
*/
public function set_customer_id( $value ) {
$this->set_prop( 'customer_id', absint( $value ) );
}
/**
* Set billing first name.
*
* @param string $value Billing first name.
* @throws WC_Data_Exception Throws exception when invalid data is found.
*/
public function set_billing_first_name( $value ) {
$this->set_address_prop( 'first_name', 'billing', $value );
}
/**
* Set billing last name.
*
* @param string $value Billing last name.
* @throws WC_Data_Exception Throws exception when invalid data is found.
*/
public function set_billing_last_name( $value ) {
$this->set_address_prop( 'last_name', 'billing', $value );
}
/**
* Set billing company.
*
* @param string $value Billing company.
* @throws WC_Data_Exception Throws exception when invalid data is found.
*/
public function set_billing_company( $value ) {
$this->set_address_prop( 'company', 'billing', $value );
}
/**
* Set billing address line 1.
*
* @param string $value Billing address line 1.
* @throws WC_Data_Exception Throws exception when invalid data is found.