Skip to content

Commit 032c2b0

Browse files
wjrosaMayishadaledupreez
authored
Renaming order helper methods to append the ID suffix (#4716)
* Introducing a Stripe order helper class * Order meta keys as constants * Adding deprecation annotation * Additional methods * Replacing occurrences * Unit test class * Including class * Tests update * Tests update * Replace meta key reference * Changelog and readme entries * Fix test class name * Fix test class name * validate_minimum_order_amount * Fix tests * Order lock updates * Order lock updates * Order lock updates * Payment awaiting action methods * Fix tests * Revert unnecessary changes * Revert unnecessary changes * Fix merge * Update deprecated comments * Update includes/abstracts/abstract-wc-stripe-payment-gateway.php Co-authored-by: Mayisha <[email protected]> * Update includes/class-wc-stripe-order-helper.php Co-authored-by: Mayisha <[email protected]> * Update includes/class-wc-stripe-order-helper.php Co-authored-by: Mayisha <[email protected]> * Update includes/class-wc-stripe-order-helper.php Co-authored-by: Mayisha <[email protected]> * Removing invalid tests * Revert invalid method calls * Update @SInCE comment * Update includes/class-wc-stripe-order-helper.php Co-authored-by: Mayisha <[email protected]> * Update includes/class-wc-stripe-order-helper.php Co-authored-by: Mayisha <[email protected]> * Removing unused order lock param * Minor improvements to the refund lock code * Adding typed params and return values + singleton pattern * Implementing the new singleton pattern * Fix tests * Adding missing type declarations to constants * Fix static implementations * Fix wrong lock method call * Fix static implementations * Fix static implementations * Fix tests * Fix remaining static calls * Fix tests * Fix tests * Fix tests * Handling source ID meta in the order helper * Handling payment intent, setup intent and refund * Unit tests * Changelog and readme entries * Changelog and readme entries * Fix tests * Fix changelog and readme entries * Minor test improvement * Handling more Stripe metas with the order helper class * Card ID meta * UPE payment type * UPE waiting for redirect * UPE redirect processed * Fix tests * Fix method implementation + remove unused method * Changelog and readme entries * Update includes/class-wc-stripe-order-helper.php Co-authored-by: daledupreez <[email protected]> * Fix implementation after method renaming + renaming the card_id method and implementations * Update includes/class-wc-stripe-order-helper.php Co-authored-by: daledupreez <[email protected]> * Changing null check * New protected method to handle meta update * Renaming Order Helper methods to append _id * Changelog and readme entries --------- Co-authored-by: Mayisha <[email protected]> Co-authored-by: daledupreez <[email protected]>
1 parent 494341e commit 032c2b0

19 files changed

+79
-77
lines changed

‎changelog.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*** Changelog ***
22

33
= 10.1.0 - xxxx-xx-xx =
4+
* Dev - Renames previous Order Helper class methods to use the `_id` suffix
45
* Dev - Expands the Stripe Order Helper class to handle customer ID, card ID, UPE payment type, and UPE redirect status metas
56

67
= 10.0.0 - 2025-10-14 =

‎includes/abstracts/abstract-wc-stripe-payment-gateway.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,14 +1021,14 @@ public function prepare_order_source( $order = null ) {
10211021
}
10221022

10231023
$order_helper = WC_Stripe_Order_Helper::get_instance();
1024-
$source_id = $order_helper->get_stripe_source( $order );
1024+
$source_id = $order_helper->get_stripe_source_id( $order );
10251025

10261026
// Since 4.0.0, we changed card to source so we need to account for that.
10271027
if ( empty( $source_id ) ) {
10281028
$source_id = $order_helper->get_stripe_card_id( $order );
10291029

10301030
// Take this opportunity to update the key name.
1031-
$order_helper->update_stripe_source( $order, $source_id );
1031+
$order_helper->update_stripe_source_id( $order, $source_id );
10321032

10331033
if ( is_callable( [ $order, 'save' ] ) ) {
10341034
$order->save();
@@ -1087,7 +1087,7 @@ public function save_source_to_order( $order, $source ) {
10871087
}
10881088

10891089
if ( $source->source ) {
1090-
$order_helper->update_stripe_source( $order, $source->source );
1090+
$order_helper->update_stripe_source_id( $order, $source->source );
10911091
}
10921092

10931093
if ( is_callable( [ $order, 'save' ] ) ) {
@@ -1281,7 +1281,7 @@ public function process_refund( $order_id, $amount = null, $reason = '' ) {
12811281
}
12821282
}
12831283

1284-
$order_helper->update_stripe_refund( $order, $response->id );
1284+
$order_helper->update_stripe_refund_id( $order, $response->id );
12851285

12861286
if ( isset( $response->balance_transaction ) ) {
12871287
$this->update_fees( $order, $response->balance_transaction );
@@ -1704,7 +1704,7 @@ public function save_intent_to_order( $order, $intent ) {
17041704
$order->update_meta_data( '_stripe_mandate_id', $charge->payment_method_details->acss_debit->mandate );
17051705
}
17061706
} elseif ( 'setup_intent' === $intent->object ) {
1707-
$order_helper->update_stripe_setup_intent( $order, $intent->id );
1707+
$order_helper->update_stripe_setup_intent_id( $order, $intent->id );
17081708

17091709
// Add mandate for free trial subscriptions.
17101710
if ( isset( $intent->mandate ) ) {
@@ -1726,13 +1726,13 @@ public function save_intent_to_order( $order, $intent ) {
17261726
*/
17271727
public function get_intent_from_order( $order ) {
17281728
$order_helper = WC_Stripe_Order_Helper::get_instance();
1729-
$intent_id = $order_helper->get_stripe_intent( $order );
1729+
$intent_id = $order_helper->get_stripe_intent_id( $order );
17301730
if ( $intent_id ) {
17311731
return $this->get_intent( 'payment_intents', $intent_id );
17321732
}
17331733

17341734
// The order doesn't have a payment intent, but it may have a setup intent.
1735-
$intent_id = $order_helper->get_stripe_setup_intent( $order );
1735+
$intent_id = $order_helper->get_stripe_setup_intent_id( $order );
17361736
if ( $intent_id ) {
17371737
return $this->get_intent( 'setup_intents', $intent_id );
17381738
}
@@ -1921,7 +1921,7 @@ public function setup_intent( $order, $prepared_source ) {
19211921
if ( is_wp_error( $setup_intent ) ) {
19221922
WC_Stripe_Logger::log( "Unable to create SetupIntent for Order #$order_id: " . print_r( $setup_intent, true ) );
19231923
} elseif ( WC_Stripe_Intent_Status::REQUIRES_ACTION === $setup_intent->status ) {
1924-
WC_Stripe_Order_Helper::get_instance()->update_stripe_setup_intent( $order, $setup_intent->id );
1924+
WC_Stripe_Order_Helper::get_instance()->update_stripe_setup_intent_id( $order, $setup_intent->id );
19251925
$order->save();
19261926

19271927
return $setup_intent->client_secret;

‎includes/admin/class-wc-stripe-privacy.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public function order_data_exporter( $email_address, $page = 1 ) {
131131
'data' => [
132132
[
133133
'name' => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
134-
'value' => $order_helper->get_stripe_source( $order ),
134+
'value' => $order_helper->get_stripe_source_id( $order ),
135135
],
136136
[
137137
'name' => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
@@ -367,8 +367,8 @@ protected function maybe_handle_subscription( $order ) {
367367
$renewal_orders = class_exists( 'WC_Subscriptions_Renewal_Order' ) ? WC_Subscriptions_Renewal_Order::get_renewal_orders( $order->get_id(), 'WC_Order' ) : [];
368368
foreach ( $renewal_orders as $renewal_order ) {
369369
$order_helper = WC_Stripe_Order_Helper::get_instance();
370-
$order_helper->delete_stripe_source( $renewal_order );
371-
$order_helper->delete_stripe_refund( $renewal_order );
370+
$order_helper->delete_stripe_source_id( $renewal_order );
371+
$order_helper->delete_stripe_refund_id( $renewal_order );
372372
$order_helper->delete_stripe_customer_id( $renewal_order );
373373
}
374374

@@ -387,8 +387,8 @@ protected function maybe_handle_subscription( $order ) {
387387
*/
388388
protected function maybe_handle_order( $order ) {
389389
$order_helper = WC_Stripe_Order_Helper::get_instance();
390-
$stripe_source_id = $order_helper->get_stripe_source( $order );
391-
$stripe_refund_id = $order_helper->get_stripe_refund( $order );
390+
$stripe_source_id = $order_helper->get_stripe_source_id( $order );
391+
$stripe_refund_id = $order_helper->get_stripe_refund_id( $order );
392392
$stripe_customer_id = $order_helper->get_stripe_customer_id( $order );
393393

394394
if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
@@ -400,8 +400,8 @@ protected function maybe_handle_order( $order ) {
400400
return [ false, false, [] ];
401401
}
402402

403-
$order_helper->delete_stripe_source( $order );
404-
$order_helper->delete_stripe_refund( $order );
403+
$order_helper->delete_stripe_source_id( $order );
404+
$order_helper->delete_stripe_refund_id( $order );
405405
$order_helper->delete_stripe_customer_id( $order );
406406

407407
return [ true, false, [ __( 'Stripe personal data erased.', 'woocommerce-gateway-stripe' ) ] ];

‎includes/class-wc-stripe-helper.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1305,7 +1305,7 @@ private static function should_load_scripts_for_prb_location( $location ) {
13051305
*/
13061306
public static function add_payment_intent_to_order( $payment_intent_id, $order ) {
13071307
$order_helper = WC_Stripe_Order_Helper::get_instance();
1308-
$old_intent_id = $order_helper->get_stripe_intent( $order );
1308+
$old_intent_id = $order_helper->get_stripe_intent_id( $order );
13091309
if ( $old_intent_id === $payment_intent_id ) {
13101310
return;
13111311
}
@@ -1318,7 +1318,7 @@ public static function add_payment_intent_to_order( $payment_intent_id, $order )
13181318
)
13191319
);
13201320

1321-
$order_helper->update_stripe_intent( $order, $payment_intent_id );
1321+
$order_helper->update_stripe_intent_id( $order, $payment_intent_id );
13221322
$order->save();
13231323
}
13241324

@@ -1421,9 +1421,9 @@ public static function get_payment_method_from_intent( $intent ) {
14211421
*/
14221422
public static function get_intent_id_from_order( $order ) {
14231423
$order_helper = WC_Stripe_Order_Helper::get_instance();
1424-
$intent_id = $order_helper->get_stripe_intent( $order );
1424+
$intent_id = $order_helper->get_stripe_intent_id( $order );
14251425
if ( ! $intent_id ) {
1426-
$intent_id = $order_helper->get_stripe_setup_intent( $order );
1426+
$intent_id = $order_helper->get_stripe_setup_intent_id( $order );
14271427
}
14281428

14291429
return $intent_id ?? false;

‎includes/class-wc-stripe-intent-controller.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ public function verify_intent() {
127127
}
128128

129129
// Validate the intent being verified.
130-
$order_intent_id = WC_Stripe_Order_Helper::get_instance()->get_stripe_intent( $order );
130+
$order_intent_id = WC_Stripe_Order_Helper::get_instance()->get_stripe_intent_id( $order );
131131
if ( ! $order_intent_id || ! isset( $_GET['intent_id'] ) || $order_intent_id !== $_GET['intent_id'] ) {
132132
throw new WC_Stripe_Exception( 'invalid_intent', __( "We're not able to process this payment. Please try again later.", 'woocommerce-gateway-stripe' ) );
133133
}

‎includes/class-wc-stripe-order-helper.php‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ public function delete_stripe_net( ?WC_Order $order = null ) {
291291
* @param WC_Order|null $order
292292
* @return false|string|null
293293
*/
294-
public function get_stripe_source( ?WC_Order $order = null ) {
294+
public function get_stripe_source_id( ?WC_Order $order = null ) {
295295
if ( is_null( $order ) ) {
296296
return false;
297297
}
@@ -308,7 +308,7 @@ public function get_stripe_source( ?WC_Order $order = null ) {
308308
* @param string $source_id
309309
* @return false|void
310310
*/
311-
public function update_stripe_source( ?WC_Order $order = null, string $source_id = '' ) {
311+
public function update_stripe_source_id( ?WC_Order $order = null, string $source_id = '' ) {
312312
return $this->update_order_meta( $order, self::META_STRIPE_SOURCE_ID, $source_id );
313313
}
314314

@@ -320,7 +320,7 @@ public function update_stripe_source( ?WC_Order $order = null, string $source_id
320320
* @param WC_Order|null $order
321321
* @return false|void
322322
*/
323-
public function delete_stripe_source( ?WC_Order $order = null ) {
323+
public function delete_stripe_source_id( ?WC_Order $order = null ) {
324324
return $this->delete_order_meta( $order, self::META_STRIPE_SOURCE_ID );
325325
}
326326

@@ -332,7 +332,7 @@ public function delete_stripe_source( ?WC_Order $order = null ) {
332332
* @param WC_Order|null $order
333333
* @return false|string|null
334334
*/
335-
public function get_stripe_refund( ?WC_Order $order = null ) {
335+
public function get_stripe_refund_id( ?WC_Order $order = null ) {
336336
if ( is_null( $order ) ) {
337337
return false;
338338
}
@@ -349,7 +349,7 @@ public function get_stripe_refund( ?WC_Order $order = null ) {
349349
* @param string $refund_id
350350
* @return false|void
351351
*/
352-
public function update_stripe_refund( ?WC_Order $order = null, string $refund_id = '' ) {
352+
public function update_stripe_refund_id( ?WC_Order $order = null, string $refund_id = '' ) {
353353
return $this->update_order_meta( $order, self::META_STRIPE_REFUND_ID, $refund_id );
354354
}
355355

@@ -361,7 +361,7 @@ public function update_stripe_refund( ?WC_Order $order = null, string $refund_id
361361
* @param WC_Order|null $order
362362
* @return false|void
363363
*/
364-
public function delete_stripe_refund( ?WC_Order $order = null ) {
364+
public function delete_stripe_refund_id( ?WC_Order $order = null ) {
365365
return $this->delete_order_meta( $order, self::META_STRIPE_REFUND_ID );
366366
}
367367

@@ -373,7 +373,7 @@ public function delete_stripe_refund( ?WC_Order $order = null ) {
373373
* @param WC_Order|null $order
374374
* @return false|string|null
375375
*/
376-
public function get_stripe_intent( ?WC_Order $order = null ) {
376+
public function get_stripe_intent_id( ?WC_Order $order = null ) {
377377
if ( is_null( $order ) ) {
378378
return false;
379379
}
@@ -390,7 +390,7 @@ public function get_stripe_intent( ?WC_Order $order = null ) {
390390
* @param string $intent_id
391391
* @return false|void
392392
*/
393-
public function update_stripe_intent( ?WC_Order $order = null, string $intent_id = '' ) {
393+
public function update_stripe_intent_id( ?WC_Order $order = null, string $intent_id = '' ) {
394394
return $this->update_order_meta( $order, self::META_STRIPE_INTENT_ID, $intent_id );
395395
}
396396

@@ -402,7 +402,7 @@ public function update_stripe_intent( ?WC_Order $order = null, string $intent_id
402402
* @param WC_Order|null $order
403403
* @return false|void
404404
*/
405-
public function delete_stripe_intent( ?WC_Order $order = null ) {
405+
public function delete_stripe_intent_id( ?WC_Order $order = null ) {
406406
return $this->delete_order_meta( $order, self::META_STRIPE_INTENT_ID );
407407
}
408408

@@ -414,7 +414,7 @@ public function delete_stripe_intent( ?WC_Order $order = null ) {
414414
* @param WC_Order|null $order
415415
* @return false|string|null
416416
*/
417-
public function get_stripe_setup_intent( ?WC_Order $order = null ) {
417+
public function get_stripe_setup_intent_id( ?WC_Order $order = null ) {
418418
if ( is_null( $order ) ) {
419419
return false;
420420
}
@@ -431,7 +431,7 @@ public function get_stripe_setup_intent( ?WC_Order $order = null ) {
431431
* @param string $intent_id
432432
* @return false|void
433433
*/
434-
public function update_stripe_setup_intent( ?WC_Order $order = null, string $intent_id = '' ) {
434+
public function update_stripe_setup_intent_id( ?WC_Order $order = null, string $intent_id = '' ) {
435435
return $this->update_order_meta( $order, self::META_STRIPE_SETUP_INTENT, $intent_id );
436436
}
437437

‎includes/class-wc-stripe-webhook-handler.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -742,7 +742,7 @@ public function process_webhook_refund( $notification ) {
742742
if ( $order_helper->is_stripe_gateway_order( $order ) ) {
743743
$charge = $order->get_transaction_id();
744744
$captured = $order->get_meta( '_stripe_charge_captured' );
745-
$refund_id = $order_helper->get_stripe_refund( $order );
745+
$refund_id = $order_helper->get_stripe_refund_id( $order );
746746
$currency = $order->get_currency();
747747
$raw_amount = $refund_object->amount;
748748

@@ -792,7 +792,7 @@ public function process_webhook_refund( $notification ) {
792792
WC_Stripe_Logger::log( $refund->get_error_message() );
793793
}
794794

795-
$order_helper->update_stripe_refund( $order, $refund_object->id );
795+
$order_helper->update_stripe_refund_id( $order, $refund_object->id );
796796

797797
if ( isset( $refund_object->balance_transaction ) ) {
798798
$this->update_fees( $order, $refund_object->balance_transaction );
@@ -827,7 +827,7 @@ public function process_webhook_refund_updated( $notification ) {
827827
$order_helper = WC_Stripe_Order_Helper::get_instance();
828828
if ( $order_helper->is_stripe_gateway_order( $order ) ) {
829829
$charge = $order->get_transaction_id();
830-
$refund_id = $order_helper->get_stripe_refund( $order );
830+
$refund_id = $order_helper->get_stripe_refund_id( $order );
831831
$currency = $order->get_currency();
832832
$raw_amount = $refund_object->amount;
833833

‎includes/compat/trait-wc-stripe-pre-orders.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ class_exists( 'WC_Pre_Orders_Order' ) &&
174174
*/
175175
public function remove_order_source_before_retry( $order ) {
176176
$order_helper = WC_Stripe_Order_Helper::get_instance();
177-
$order_helper->delete_stripe_source( $order );
177+
$order_helper->delete_stripe_source_id( $order );
178178
$order_helper->delete_stripe_card_id( $order );
179179
$order->save();
180180
}

‎includes/compat/trait-wc-stripe-subscriptions.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -644,13 +644,13 @@ public function maybe_update_source_on_subscription_order( $order, $source, $pay
644644
*/
645645
public function delete_resubscribe_meta( $resubscribe_order ) {
646646
$order_helper = WC_Stripe_Order_Helper::get_instance();
647-
$order_helper->delete_stripe_source( $resubscribe_order );
647+
$order_helper->delete_stripe_source_id( $resubscribe_order );
648648

649649
$order_helper->delete_stripe_customer_id( $resubscribe_order );
650650
// For BW compat will remove in future.
651651
$order_helper->delete_stripe_card_id( $resubscribe_order );
652652
// Delete payment intent ID.
653-
$order_helper->delete_stripe_intent( $resubscribe_order );
653+
$order_helper->delete_stripe_intent_id( $resubscribe_order );
654654
$this->delete_renewal_meta( $resubscribe_order );
655655
$resubscribe_order->save();
656656
}
@@ -666,7 +666,7 @@ public function delete_renewal_meta( $renewal_order ) {
666666
$order_helper->delete_stripe_net( $renewal_order );
667667

668668
// Delete payment intent ID.
669-
$order_helper->delete_stripe_intent( $renewal_order );
669+
$order_helper->delete_stripe_intent_id( $renewal_order );
670670

671671
return $renewal_order;
672672
}
@@ -682,7 +682,7 @@ public function delete_renewal_meta( $renewal_order ) {
682682
public function update_failing_payment_method( $subscription, $renewal_order ) {
683683
$order_helper = WC_Stripe_Order_Helper::get_instance();
684684
$subscription->update_meta_data( '_stripe_customer_id', $order_helper->get_stripe_customer_id( $renewal_order ) );
685-
$subscription->update_meta_data( '_stripe_source_id', $order_helper->get_stripe_source( $renewal_order ) );
685+
$subscription->update_meta_data( '_stripe_source_id', $order_helper->get_stripe_source_id( $renewal_order ) );
686686
$subscription->save();
687687
}
688688

@@ -848,7 +848,7 @@ private function get_mandate_for_subscription( $order, $payment_method ) {
848848
}
849849

850850
$mandate = $renewal_order->get_meta( '_stripe_mandate_id', true );
851-
$renewal_order_payment_method = WC_Stripe_Order_Helper::get_instance()->get_stripe_source( $renewal_order );
851+
$renewal_order_payment_method = WC_Stripe_Order_Helper::get_instance()->get_stripe_source_id( $renewal_order );
852852

853853
// Return from the most recent renewal order with a valid mandate. Mandate is created against a payment method
854854
// in Stripe so the payment method should also match to reuse the mandate.
@@ -1012,14 +1012,14 @@ public function maybe_render_subscription_payment_method( $payment_method_to_dis
10121012
$order_helper = WC_Stripe_Order_Helper::get_instance();
10131013
$parent_order = wc_get_order( $subscription->get_parent_id() );
10141014
$stripe_customer_id = $order_helper->get_stripe_customer_id( $parent_order );
1015-
$stripe_source_id = $order_helper->get_stripe_source( $parent_order );
1015+
$stripe_source_id = $order_helper->get_stripe_source_id( $parent_order );
10161016

10171017
// For BW compat will remove in future.
10181018
if ( empty( $stripe_source_id ) ) {
10191019
$stripe_source_id = $order_helper->get_stripe_card_id( $parent_order );
10201020

10211021
// Take this opportunity to update the key name.
1022-
$order_helper->update_stripe_source( $parent_order, $stripe_source_id );
1022+
$order_helper->update_stripe_source_id( $parent_order, $stripe_source_id );
10231023
$parent_order->save();
10241024
}
10251025
}

‎includes/payment-methods/class-wc-stripe-upe-payment-gateway.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1819,7 +1819,7 @@ public function save_payment_method_to_order( $order, $payment_method ) {
18191819
}
18201820

18211821
// Save the payment method id as `source_id`, because we use both `sources` and `payment_methods` APIs.
1822-
$order_helper->update_stripe_source( $order, $payment_method->payment_method );
1822+
$order_helper->update_stripe_source_id( $order, $payment_method->payment_method );
18231823

18241824
if ( is_callable( [ $order, 'save' ] ) ) {
18251825
$order->save();
@@ -2892,7 +2892,7 @@ protected function handle_saving_payment_method( WC_Order $order, $payment_metho
28922892
*/
28932893
public function set_payment_method_id_for_order( WC_Order $order, string $payment_method_id ) {
28942894
// Save the payment method id as `source_id`, because we use both `sources` and `payment_methods` APIs.
2895-
WC_Stripe_Order_Helper::get_instance()->update_stripe_source( $order, $payment_method_id );
2895+
WC_Stripe_Order_Helper::get_instance()->update_stripe_source_id( $order, $payment_method_id );
28962896
$order->save_meta_data();
28972897
}
28982898

0 commit comments

Comments
 (0)