Handling source id / refund id / intent ids metas in the order helper class

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 10.0.0 - xxxx-xx-xx =
+* Dev - Expands the Stripe Order Helper class to handle source ID, refund ID, intent ID, and setup intent ID metas
 * Update - Removing the `wc_stripe_is_upe_checkout_enabled` filter, as Legacy Checkout is no longer supported
 * Dev - Upgrades `jest` to version 29.7.0, `@wordpress/scripts` to 26.19.0, and adds `axios`(version 1.12.2) to the JavaScript development dependencies
 * Update - Shows the Stripe account connection modal in settings when the merchant did not connect via OAuth along with a new notice

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

@@ -1020,14 +1020,15 @@ public function prepare_order_source( $order = null ) {
 				$stripe_customer->set_id( $stripe_customer_id );
 			}
 
-			$source_id = $order->get_meta( '_stripe_source_id', true );
+			$order_helper = WC_Stripe_Order_Helper::get_instance();
+			$source_id    = $order_helper->get_stripe_source( $order );
 
 			// Since 4.0.0, we changed card to source so we need to account for that.
 			if ( empty( $source_id ) ) {
 				$source_id = $order->get_meta( '_stripe_card_id', true );
 
 				// Take this opportunity to update the key name.
-				$order->update_meta_data( '_stripe_source_id', $source_id );
+				$order_helper->update_stripe_source( $order, $source_id );
 
 				if ( is_callable( [ $order, 'save' ] ) ) {
 					$order->save();
@@ -1084,7 +1085,7 @@ public function save_source_to_order( $order, $source ) {
 		}
 
 		if ( $source->source ) {
-			$order->update_meta_data( '_stripe_source_id', $source->source );
+			WC_Stripe_Order_Helper::get_instance()->update_stripe_source( $order, $source->source );
 		}
 
 		if ( is_callable( [ $order, 'save' ] ) ) {
@@ -1278,7 +1279,7 @@ public function process_refund( $order_id, $amount = null, $reason = '' ) {
 				}
 			}
 
-			$order->update_meta_data( '_stripe_refund_id', $response->id );
+			$order_helper->update_stripe_refund( $order, $response->id );
 
 			if ( isset( $response->balance_transaction ) ) {
 				$this->update_fees( $order, $response->balance_transaction );
@@ -1686,8 +1687,9 @@ public function save_intent_to_order( $order, $intent ) {
 			return;
 		}
 
+		$order_helper = WC_Stripe_Order_Helper::get_instance();
 		if ( 'payment_intent' === $intent->object ) {
-			WC_Stripe_Order_Helper::get_instance()->add_payment_intent_to_order( $intent->id, $order );
+			$order_helper->add_payment_intent_to_order( $intent->id, $order );
 
 			// TODO: Refactor and add mandate ID support for other payment methods, if necessary.
 			// The mandate ID is not available for the intent object, so we need to fetch the charge.
@@ -1700,7 +1702,7 @@ public function save_intent_to_order( $order, $intent ) {
 				$order->update_meta_data( '_stripe_mandate_id', $charge->payment_method_details->acss_debit->mandate );
 			}
 		} elseif ( 'setup_intent' === $intent->object ) {
-			$order->update_meta_data( '_stripe_setup_intent', $intent->id );
+			$order_helper->update_stripe_setup_intent( $order );
 
 			// Add mandate for free trial subscriptions.
 			if ( isset( $intent->mandate ) ) {
@@ -1721,15 +1723,14 @@ public function save_intent_to_order( $order, $intent ) {
 	 * @return obect|bool     Either the intent object or `false`.
 	 */
 	public function get_intent_from_order( $order ) {
-		$intent_id = $order->get_meta( '_stripe_intent_id' );
-
+		$order_helper = WC_Stripe_Order_Helper::get_instance();
+		$intent_id    = $order_helper->get_stripe_intent( $order );
 		if ( $intent_id ) {
 			return $this->get_intent( 'payment_intents', $intent_id );
 		}
 
 		// The order doesn't have a payment intent, but it may have a setup intent.
-		$intent_id = $order->get_meta( '_stripe_setup_intent' );
-
+		$intent_id = $order_helper->get_stripe_setup_intent( $order );
 		if ( $intent_id ) {
 			return $this->get_intent( 'setup_intents', $intent_id );
 		}
@@ -1918,7 +1919,7 @@ public function setup_intent( $order, $prepared_source ) {
 		if ( is_wp_error( $setup_intent ) ) {
 			WC_Stripe_Logger::log( "Unable to create SetupIntent for Order #$order_id: " . print_r( $setup_intent, true ) );
 		} elseif ( WC_Stripe_Intent_Status::REQUIRES_ACTION === $setup_intent->status ) {
-			$order->update_meta_data( '_stripe_setup_intent', $setup_intent->id );
+			WC_Stripe_Order_Helper::get_instance()->update_stripe_setup_intent( $setup_intent->id );
 			$order->save();
 
 			return $setup_intent->client_secret;

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

@@ -119,11 +119,8 @@ public function get_privacy_message() {
 	public function order_data_exporter( $email_address, $page = 1 ) {
 		$done           = false;
 		$data_to_export = [];
-
-		$orders = $this->get_stripe_orders( $email_address, (int) $page );
-
-		$done = true;
-
+		$orders         = $this->get_stripe_orders( $email_address, (int) $page );
+		$done           = true;
 		if ( 0 < count( $orders ) ) {
 			foreach ( $orders as $order ) {
 				$data_to_export[] = [
@@ -133,7 +130,7 @@ public function order_data_exporter( $email_address, $page = 1 ) {
 					'data'        => [
 						[
 							'name'  => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
-							'value' => $order->get_meta( '_stripe_source_id', true ),
+							'value' => WC_Stripe_Order_Helper::get_instance()->get_stripe_source( $order ),
 						],
 						[
 							'name'  => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
@@ -367,10 +364,10 @@ protected function maybe_handle_subscription( $order ) {
 		}
 
 		$renewal_orders = class_exists( 'WC_Subscriptions_Renewal_Order' ) ? WC_Subscriptions_Renewal_Order::get_renewal_orders( $order->get_id(), 'WC_Order' ) : [];
-
 		foreach ( $renewal_orders as $renewal_order ) {
-			$renewal_order->delete_meta_data( '_stripe_source_id' );
-			$renewal_order->delete_meta_data( '_stripe_refund_id' );
+			$order_helper = WC_Stripe_Order_Helper::get_instance();
+			$order_helper->delete_stripe_source( $renewal_order );
+			$order_helper->delete_stripe_refund( $renewal_order );
 			$renewal_order->delete_meta_data( '_stripe_customer_id' );
 		}
 
@@ -388,8 +385,9 @@ protected function maybe_handle_subscription( $order ) {
 	 * @return array
 	 */
 	protected function maybe_handle_order( $order ) {
-		$stripe_source_id   = $order->get_meta( '_stripe_source_id', true );
-		$stripe_refund_id   = $order->get_meta( '_stripe_refund_id', true );
+		$order_helper       = WC_Stripe_Order_Helper::get_instance();
+		$stripe_source_id   = $order_helper->get_stripe_source( $order );
+		$stripe_refund_id   = $order_helper->get_stripe_refund( $order );
 		$stripe_customer_id = $order->get_meta( '_stripe_customer_id', true );
 
 		if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
@@ -401,8 +399,8 @@ protected function maybe_handle_order( $order ) {
 			return [ false, false, [] ];
 		}
 
-		$order->delete_meta_data( '_stripe_source_id' );
-		$order->delete_meta_data( '_stripe_refund_id' );
+		$order_helper->delete_stripe_source( $order );
+		$order_helper->delete_stripe_refund( $order );
 		$order->delete_meta_data( '_stripe_customer_id' );
 
 		return [ true, false, [ __( 'Stripe personal data erased.', 'woocommerce-gateway-stripe' ) ] ];

includes/class-wc-stripe-helper.php

@@ -1304,9 +1304,8 @@ private static function should_load_scripts_for_prb_location( $location ) {
 	 * @deprecated 10.0.0 Use WC_Stripe_Order_Helper::add_payment_intent_to_order() instead.
 	 */
 	public static function add_payment_intent_to_order( $payment_intent_id, $order ) {
-
-		$old_intent_id = $order->get_meta( '_stripe_intent_id' );
-
+		$order_helper  = WC_Stripe_Order_Helper::get_instance();
+		$old_intent_id = $order_helper->get_stripe_intent( $order );
 		if ( $old_intent_id === $payment_intent_id ) {
 			return;
 		}
@@ -1319,7 +1318,7 @@ public static function add_payment_intent_to_order( $payment_intent_id, $order )
 			)
 		);
 
-		$order->update_meta_data( '_stripe_intent_id', $payment_intent_id );
+		$order_helper->update_stripe_intent( $order );
 		$order->save();
 	}
 
@@ -1421,10 +1420,10 @@ public static function get_payment_method_from_intent( $intent ) {
 	 * @deprecated 10.0.0 Use WC_Stripe_Order_Helper::get_intent_id_from_order() instead.
 	 */
 	public static function get_intent_id_from_order( $order ) {
-		$intent_id = $order->get_meta( '_stripe_intent_id' );
-
+		$order_helper = WC_Stripe_Order_Helper::get_instance();
+		$intent_id    = $order_helper->get_stripe_intent( $order );
 		if ( ! $intent_id ) {
-			$intent_id = $order->get_meta( '_stripe_setup_intent' );
+			$intent_id = $order_helper->get_stripe_setup_intent( $order );
 		}
 
 		return $intent_id ?? false;

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

@@ -127,7 +127,7 @@ public function verify_intent() {
 			}
 
 			// Validate the intent being verified.
-			$order_intent_id = $order->get_meta( '_stripe_intent_id', true );
+			$order_intent_id = WC_Stripe_Order_Helper::get_instance()->get_stripe_intent( $order );
 			if ( ! $order_intent_id || ! isset( $_GET['intent_id'] ) || $order_intent_id !== $_GET['intent_id'] ) {
 				throw new WC_Stripe_Exception( 'invalid_intent', __( "We're not able to process this payment. Please try again later.", 'woocommerce-gateway-stripe' ) );
 			}

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

@@ -50,13 +50,6 @@ class WC_Stripe_Order_Helper {
 	 */
 	private const META_STRIPE_SOURCE_ID = '_stripe_source_id';
 
-	/**
-	 * Meta key for Stripe charge ID.
-	 *
-	 * @var string
-	 */
-	private const META_STRIPE_CHARGE_ID = '_stripe_charge_id';
-
 	/**
 	 * Meta key for Stripe refund ID.
 	 *
@@ -267,6 +260,186 @@ public function delete_stripe_net( ?WC_Order $order = null ) {
 		$order->delete_meta_data( self::LEGACY_META_STRIPE_NET );
 	}
 
+	/**
+	 * Gets the Stripe source for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|string|null
+	 */
+	public function get_stripe_source( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		return $order->get_meta( self::META_STRIPE_SOURCE_ID, true );
+	}
+
+	/**
+	 * Updates the Stripe source for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @param string $source_id
+	 * @return false|void
+	 */
+	public function update_stripe_source( ?WC_Order $order = null, string $source_id = '' ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->update_meta_data( self::META_STRIPE_SOURCE_ID, $source_id );
+	}
+
+	/**
+	 * Deletes the Stripe source for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|void
+	 */
+	public function delete_stripe_source( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->delete_meta_data( self::META_STRIPE_SOURCE_ID );
+	}
+
+	/**
+	 * Updates the Stripe refund for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|string|null
+	 */
+	public function get_stripe_refund( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		return $order->get_meta( self::META_STRIPE_REFUND_ID, true );
+	}
+
+	/**
+	 * Updates the Stripe refund for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @param string $refund_id
+	 * @return false|void
+	 */
+	public function update_stripe_refund( ?WC_Order $order = null, string $refund_id = '' ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->update_meta_data( self::META_STRIPE_REFUND_ID, $refund_id );
+	}
+
+	/**
+	 * Deletes the Stripe refund for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|void
+	 */
+	public function delete_stripe_refund( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->delete_meta_data( self::META_STRIPE_REFUND_ID );
+	}
+
+	/**
+	 * Gets the Stripe intent for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|string|null
+	 */
+	public function get_stripe_intent( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		return $order->get_meta( self::META_STRIPE_INTENT_ID, true );
+	}
+
+	/**
+	 * Updates the Stripe intent for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @param string $intent_id
+	 * @return false|void
+	 */
+	public function update_stripe_intent( ?WC_Order $order = null, string $intent_id = '' ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->update_meta_data( self::META_STRIPE_INTENT_ID, $intent_id );
+	}
+
+	/**
+	 * Deletes the Stripe intent for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|void
+	 */
+	public function delete_stripe_intent( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->delete_meta_data( self::META_STRIPE_INTENT_ID );
+	}
+
+	/**
+	 * Gets the Stripe setup intent for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @return false|string|null
+	 */
+	public function get_stripe_setup_intent( ?WC_Order $order = null ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		return $order->get_meta( self::META_STRIPE_SETUP_INTENT, true );
+	}
+
+	/**
+	 * Updates the Stripe setup intent for order.
+	 *
+	 * @since 10.0.0
+	 *
+	 * @param WC_Order|null $order
+	 * @param string $intent_id
+	 * @return false|void
+	 */
+	public function update_stripe_setup_intent( ?WC_Order $order = null, string $intent_id = '' ) {
+		if ( is_null( $order ) ) {
+			return false;
+		}
+
+		$order->update_meta_data( self::META_STRIPE_SETUP_INTENT, $intent_id );
+	}
+
 	/**
 	 * Adds payment intent id and order note to order if payment intent is not already saved
 	 *