Merge pull request #5 from pronamic/4-add-support-for-order-id-setting

Add setting for order ID template
pronamic · Sep 8, 2023 · 7222a5c · 7222a5c
2 parents 7d250b9 + 11690f8
commit 7222a5c
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 27 deletions.
diff --git a/src/Extension.php b/src/Extension.php
@@ -371,7 +371,7 @@ public function redirect_for_payment( $entry_id, $form_id ) {
 
 		$payment->source    = 'formidable-forms';
 		$payment->source_id = $entry_id;
-		$payment->order_id  = $entry_id;
+		$payment->order_id  = FormidableFormsHelper::get_order_id( $this->action, $form_id, $entry, $entry_id );
 
 		$description = FormidableFormsHelper::get_description( $this->action, $form_id, $entry, $entry_id );
 

diff --git a/src/FormidableFormsHelper.php b/src/FormidableFormsHelper.php
@@ -48,6 +48,47 @@ public static function get_currency_from_settings() {
 		return $currency;
 	}
 
+	/**
+	 * Get order ID.
+	 *
+	 * @param unknown $action   Action.
+	 * @param int     $form_id  Form ID.
+	 * @param unknown $entry    Entry.
+	 * @param int     $entry_id Entry ID.
+	 * @return string
+	 */
+	public static function get_order_id( $action, $form_id, $entry, $entry_id ) {
+		if ( ! \array_key_exists( 'pronamic_pay_order_id', $action->post_content ) ) {
+			return $entry_id;
+		}
+
+		// Order ID template.
+		$order_id_template = $action->post_content['pronamic_pay_order_id'];
+
+		/**
+		 * Find shortcode.
+		 *
+		 * @link https://github.com/wp-premium/formidable/blob/2.0.22/classes/helpers/FrmFieldsHelper.php#L684-L696
+		 */
+		$shortcodes = FrmFieldsHelper::get_shortcodes( $order_id_template, $form_id );
+
+		/**
+		 * Replace shortcodes.
+		 *
+		 * @link https://github.com/wp-premium/formidable/blob/2.0.22/classes/helpers/FrmFieldsHelper.php#L715-L821
+		 */
+		$order_id = FrmFieldsHelper::replace_content_shortcodes( $order_id_template, $entry, $shortcodes );
+
+		/**
+		 * Fallback to entry ID.
+		 */
+		if ( '' === $order_id ) {
+			$order_id = (string) $entry_id;
+		}
+
+		return $order_id;
+	}
+
 	/**
 	 * Get description.
 	 *

diff --git a/src/PaymentAction.php b/src/PaymentAction.php
@@ -57,6 +57,8 @@ public function __construct() {
 	public function form( $instance, $args = [] ) {
 		$form_fields = $this->get_field_options( $args['form']->id );
 
+		$payment_action = $this;
+
 		include __DIR__ . '/../views/payment-settings.php';
 	}
 

diff --git a/views/payment-settings.php b/views/payment-settings.php
@@ -16,11 +16,28 @@
  * @since 1.0.0
  */
 
+$callback_text_field = function ( $field ) use ( $instance, $payment_action ) {
+	$id = $field['id'];
+
+	$current = '';
+
+	if ( \array_key_exists( $id, $instance->post_content ) ) {
+		$current = $instance->post_content[ $id ];
+	}
+
+	printf(
+		'<input type="text" name="%s" value="%s" class="large-text frm_help" title="" data-original-title="%s" />',
+		esc_attr( $payment_action->get_field_name( $id ) ),
+		esc_attr( $current ),
+		esc_attr( $field['description'] )
+	);
+};
+
 $fields = [
 	[
 		'id'       => 'pronamic_pay_amount_field',
 		'label'    => __( 'Amount', 'pronamic_ideal' ),
-		'callback' => function ( $field ) use ( $form_fields, $instance ) {
+		'callback' => function ( $field ) use ( $form_fields, $instance, $payment_action ) {
 			$id = $field['id'];
 
 			$current = '';
@@ -31,7 +48,7 @@
 
 			printf(
 				'<select name="%s">',
-				esc_attr( $this->get_field_name( $id ) )
+				esc_attr( $payment_action->get_field_name( $id ) )
 			);
 
 			$options = [
@@ -57,7 +74,7 @@
 	[
 		'id'       => 'pronamic_pay_payment_method_field',
 		'label'    => __( 'Payment method', 'pronamic_ideal' ),
-		'callback' => function ( $field ) use ( $form_fields, $instance ) {
+		'callback' => function ( $field ) use ( $form_fields, $instance, $payment_action ) {
 			$id = $field['id'];
 
 			$current = '';
@@ -68,7 +85,7 @@
 
 			printf(
 				'<select name="%s">',
-				esc_attr( $this->get_field_name( $id ) )
+				esc_attr( $payment_action->get_field_name( $id ) )
 			);
 
 			$options = [
@@ -98,7 +115,7 @@
 	[
 		'id'       => 'pronamic_pay_config_id',
 		'label'    => __( 'Payment Gateway Configuration', 'pronamic_ideal' ),
-		'callback' => function ( $field ) use ( $instance ) {
+		'callback' => function ( $field ) use ( $instance, $payment_action ) {
 			$id = $field['id'];
 
 			$current = '';
@@ -109,7 +126,7 @@
 
 			\printf(
 				'<select name="%s">',
-				esc_attr( $this->get_field_name( $id ) )
+				esc_attr( $payment_action->get_field_name( $id ) )
 			);
 
 			$options = Plugin::get_config_select_options();
@@ -129,29 +146,21 @@
 		},
 	],
 	[
-		'id'       => 'pronamic_pay_transaction_description',
-		'label'    => __( 'Transaction Description', 'pronamic_ideal' ),
-		'callback' => function ( $field ) use ( $instance ) {
-			$id = $field['id'];
-
-			$current = '';
-
-			if ( \array_key_exists( $id, $instance->post_content ) ) {
-				$current = $instance->post_content[ $id ];
-			}
-
-			printf(
-				'<input type="text" name="%s" value="%s" class="large-text frm_help" title="" data-original-title="%s" />',
-				esc_attr( $this->get_field_name( $id ) ),
-				esc_attr( $current ),
-				esc_attr__( 'Enter a transaction description, you can use Formidable Forms shortcodes.', 'pronamic_ideal' )
-			);
-		},
+		'id'          => 'pronamic_pay_order_id',
+		'label'       => __( 'Order ID', 'pronamic_ideal' ),
+		'description' => __( 'Enter an order ID, you can use Formidable Forms shortcodes.', 'pronamic_ideal' ),
+		'callback'    => $callback_text_field,
+	],
+	[
+		'id'          => 'pronamic_pay_transaction_description',
+		'label'       => __( 'Transaction Description', 'pronamic_ideal' ),
+		'description' => __( 'Enter a transaction description, you can use Formidable Forms shortcodes.', 'pronamic_ideal' ),
+		'callback'    => $callback_text_field,
 	],
 	[
 		'id'       => 'pronamic_pay_delay_notifications',
 		'label'    => __( 'Notifications', 'pronamic_ideal' ),
-		'callback' => function ( $field ) use ( $instance ) {
+		'callback' => function ( $field ) use ( $instance, $payment_action ) {
 			$id = $field['id'];
 
 			$current = '';
@@ -162,7 +171,7 @@
 
 			printf(
 				'<input type="checkbox" name="%s" title="" %s /> %s',
-				esc_attr( $this->get_field_name( $id ) ),
+				esc_attr( $payment_action->get_field_name( $id ) ),
 				checked( $current, 'on', false ),
 				esc_attr__( 'Delay email notifications until payment has been received.', 'pronamic_ideal' )
 			);