Merge pull request #343 from skyverge/ch7127-add-standard-subscription-data-to-orders

[ch7127] Add standard subscription data to orders

Author: ChaseWiseman

woocommerce/changelog.txt

@@ -1,6 +1,7 @@
 *** SkyVerge WooCommerce Plugin Framework Changelog ***
 
 2019.nn.nn - version 5.4.2-dev.1
+ * Tweak - Add a standard set of subscription details to orders payment data set by a gateway
  * Tweak - Add replacement helper methods to get the current screen in WordPress and check the screen ID
  * Misc - Change SV_WC_Payment_Gateway::is_configured() from protected to public
  * Misc - Add admin notice when a gateway is enabled but is not configured and is unable to take payments

woocommerce/payment-gateway/integrations/class-sv-wc-payment-gateway-integration-subscriptions.php

@@ -81,6 +81,9 @@ public function add_support() {
 		// save token/customer ID to subscription objects
 		add_action( 'wc_payment_gateway_' . $this->get_gateway()->get_id() . '_add_transaction_data', array( $this, 'save_payment_meta' ), 10, 2 );
 
+		// add additional subscription details to orders along with payment data
+		add_action( 'wc_payment_gateway_' . $this->get_gateway()->get_id() . '_get_order_base', [ $this, 'add_subscriptions_details_to_order' ], 10, 2 );
+
 		// process renewal payments
 		add_action( 'woocommerce_scheduled_subscription_payment_' . $this->get_gateway()->get_id(), array( $this, 'process_renewal_payment' ), 10, 2 );
 
@@ -193,6 +196,115 @@ public function save_payment_meta( $order ) {
 	}
 
 
+	/**
+	 * Adds subscription details to order base data.
+	 *
+	 * Details are added to a \WC_Order::$payment->subscriptions[] property.
+	 * @see SV_WC_Payment_Gateway_Integration_Subscriptions::add_subscription_details_to_order()
+	 * @internal
+	 *
+	 * @since 5.4.2-dev.1
+	 *
+	 * @param \WC_Order $order order object
+	 * @param SV_WC_Payment_Gateway $gateway payment gateway
+	 * @return \WC_Order
+	 */
+	public function add_subscriptions_details_to_order( $order, $gateway ) {
+
+		if ( isset( $order->payment ) ) {
+
+			// defaults
+			$order->payment->subscriptions = [];
+			$order->payment->recurring     = ! empty( $order->payment->recurring ) ?: false;
+
+			// if the order contains a subscription (but is not a renewal)
+			if ( wcs_order_contains_subscription( $order ) ) {
+
+				$order->payment->recurring = true;
+
+				$subscriptions = wcs_get_subscriptions_for_order( $order );
+
+				if ( ! empty( $subscriptions ) ) {
+
+					foreach ( $subscriptions as $subscription ) {
+
+						if ( $subscription instanceof \WC_Subscription ) {
+
+							$order->payment->subscriptions[] = $this->add_subscription_details_to_order( $subscription, false );
+						}
+					}
+				}
+
+			// order is for a subscription renewal
+			} elseif ( wcs_order_contains_renewal( $order ) ) {
+
+				$order->payment->recurring = true;
+
+				$subscriptions = wcs_get_subscriptions_for_renewal_order( $order );
+
+				if ( ! empty( $subscriptions ) ) {
+
+					foreach ( $subscriptions as $subscription ) {
+
+						if ( $subscription instanceof \WC_Subscription ) {
+
+							$order->payment->subscriptions[] = $this->add_subscription_details_to_order( $subscription, true );
+						}
+					}
+				}
+			}
+		}
+
+		return $order;
+	}
+
+
+	/**
+	 * Builds and returns a subscription's details data.
+	 *
+	 * @see SV_WC_Payment_Gateway_Integration_Subscriptions::add_subscriptions_details_to_order()
+	 *
+	 * \stdClass {
+	 *  int $id the subscription's ID
+	 *  bool $is_renewal whether the order is for a subscription renewal
+	 *  bool $is_installment whether the subscription is for an installment
+	 *  bool $is_first whether it is the first payment for an installment series
+	 *  bool $is_last whether it is the last payment for an installment series
+	 *}
+	 *
+	 * @since 5.4.2-dev.1
+	 *
+	 * @param \WC_Subscription $subscription subscription object
+	 * @param bool $renewal whether the subscription is a renewal
+	 * @return \stdClass subscription details data
+	 */
+	protected function add_subscription_details_to_order( $subscription, $renewal ) {
+
+		$details = new \stdClass;
+
+		$details->id             = max( 0, (int) SV_WC_Order_Compatibility::get_prop( $subscription, 'id' ) );
+		$details->is_renewal     = (bool) $renewal;
+		$details->is_installment = (bool) $subscription->get_date( 'end' );
+
+		$details->is_first = $details->is_last = false;
+
+		if ( $details->is_installment ) {
+
+			// if this is not a renewal, but the subscription has an end date, then this must be the first installment
+			if ( ! $details->is_renewal ) {
+				$details->is_first = true;
+			}
+
+			// if the subscription has an end date, but there is no next payment date set, this must be the last installment
+			if ( ! (bool) $subscription->get_date( 'next_payment' ) ) {
+				$details->is_last = true;
+			}
+		}
+
+		return $details;
+	}
+
+
 	/**
 	 * Process a subscription renewal payment
 	 *