AyeCode / invoicing

includes/wpinv-discount-functions.php

Indentation +34 added lines, -34 removed lines

@@ -160,51 +160,51 @@
  */
 function getpaid_calculate_invoice_discount( $invoice, $discount ) {
 
-	$initial_discount   = 0;
-	$recurring_discount = 0;
+    $initial_discount   = 0;
+    $recurring_discount = 0;
 
-	foreach ( $invoice->get_items() as $item ) {
+    foreach ( $invoice->get_items() as $item ) {
 
-		// Abort if it is not valid for this item.
-		if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) {
-			continue;
-		}
+        // Abort if it is not valid for this item.
+        if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) {
+            continue;
+        }
 
-		// Calculate the initial amount...
-		$item_discount           = $discount->get_discounted_amount( $item->get_sub_total() );
-		$recurring_item_discount = 0;
+        // Calculate the initial amount...
+        $item_discount           = $discount->get_discounted_amount( $item->get_sub_total() );
+        $recurring_item_discount = 0;
 
-		// ... and maybe the recurring amount.
-		if ( $item->is_recurring() && $discount->is_recurring() ) {
-			$recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() );
-		}
+        // ... and maybe the recurring amount.
+        if ( $item->is_recurring() && $discount->is_recurring() ) {
+            $recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() );
+        }
 
-		// Discount should not exceed discounted amount.
-		if ( ! $discount->is_type( 'percent' ) ) {
+        // Discount should not exceed discounted amount.
+        if ( ! $discount->is_type( 'percent' ) ) {
 
-			if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) {
-				$item_discount = $discount->get_amount() - $initial_discount;
-			}
+            if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) {
+                $item_discount = $discount->get_amount() - $initial_discount;
+            }
 
-			if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) {
-				$recurring_item_discount = $discount->get_amount() - $recurring_discount;
-			}
+            if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) {
+                $recurring_item_discount = $discount->get_amount() - $recurring_discount;
+            }
 
-		}
+        }
 
-		$initial_discount             += $item_discount;
-		$recurring_discount           += $recurring_item_discount;
-		$item->item_discount           = $item_discount;
-		$item->recurring_item_discount = $recurring_item_discount;
+        $initial_discount             += $item_discount;
+        $recurring_discount           += $recurring_item_discount;
+        $item->item_discount           = $item_discount;
+        $item->recurring_item_discount = $recurring_item_discount;
 
-	}
+    }
 
-	return array(
-		'name'               => 'discount_code',
-		'discount_code'      => $discount->get_code(),
-		'initial_discount'   => $initial_discount,
-		'recurring_discount' => $recurring_discount,
-	);
+    return array(
+        'name'               => 'discount_code',
+        'discount_code'      => $discount->get_code(),
+        'initial_discount'   => $initial_discount,
+        'recurring_discount' => $recurring_discount,
+    );
 
 }
 

includes/subscription-functions.php

Indentation +265 added lines, -265 removed lines

@@ -17,28 +17,28 @@ 
  */
 function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
 
-	// Do not retrieve all fields if we just want the count.
-	if ( 'count' == $return ) {
-		$args['fields'] = 'id';
-		$args['number'] = 1;
-	}
+    // Do not retrieve all fields if we just want the count.
+    if ( 'count' == $return ) {
+        $args['fields'] = 'id';
+        $args['number'] = 1;
+    }
 
-	// Do not count all matches if we just want the results.
-	if ( 'results' == $return ) {
-		$args['count_total'] = false;
-	}
+    // Do not count all matches if we just want the results.
+    if ( 'results' == $return ) {
+        $args['count_total'] = false;
+    }
 
-	$query = new GetPaid_Subscriptions_Query( $args );
+    $query = new GetPaid_Subscriptions_Query( $args );
 
-	if ( 'results' == $return ) {
-		return $query->get_results();
-	}
+    if ( 'results' == $return ) {
+        return $query->get_results();
+    }
 
-	if ( 'count' == $return ) {
-		return $query->get_total();
-	}
+    if ( 'count' == $return ) {
+        return $query->get_total();
+    }
 
-	return $query;
+    return $query;
 }
 
 /**
@@ -48,18 +48,18 @@ 
  */
 function getpaid_get_subscription_statuses() {
 
-	return apply_filters(
-		'getpaid_get_subscription_statuses',
-		array(
-			'pending'    => __( 'Pending', 'invoicing' ),
-			'trialling'  => __( 'Trialing', 'invoicing' ),
-			'active'     => __( 'Active', 'invoicing' ),
-			'failing'    => __( 'Failing', 'invoicing' ),
-			'expired'    => __( 'Expired', 'invoicing' ),
-			'completed'  => __( 'Complete', 'invoicing' ),
-			'cancelled'  => __( 'Cancelled', 'invoicing' ),
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_statuses',
+        array(
+            'pending'    => __( 'Pending', 'invoicing' ),
+            'trialling'  => __( 'Trialing', 'invoicing' ),
+            'active'     => __( 'Active', 'invoicing' ),
+            'failing'    => __( 'Failing', 'invoicing' ),
+            'expired'    => __( 'Expired', 'invoicing' ),
+            'completed'  => __( 'Complete', 'invoicing' ),
+            'cancelled'  => __( 'Cancelled', 'invoicing' ),
+        )
+    );
 
 }
 
@@ -69,8 +69,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_status_label( $status ) {
-	$statuses = getpaid_get_subscription_statuses();
-	return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
+    $statuses = getpaid_get_subscription_statuses();
+    return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
 }
 
 /**
@@ -80,18 +80,18 @@ 
  */
 function getpaid_get_subscription_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_subscription_status_classes',
-		array(
-			'pending'    => 'badge-dark',
-			'trialling'  => 'badge-info',
-			'active'     => 'badge-success',
-			'failing'    => 'badge-warning',
-			'expired'    => 'badge-danger',
-			'completed'  => 'badge-primary',
-			'cancelled'  => 'badge-secondary',
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_status_classes',
+        array(
+            'pending'    => 'badge-dark',
+            'trialling'  => 'badge-info',
+            'active'     => 'badge-success',
+            'failing'    => 'badge-warning',
+            'expired'    => 'badge-danger',
+            'completed'  => 'badge-primary',
+            'cancelled'  => 'badge-secondary',
+        )
+    );
 
 }
 
@@ -102,15 +102,15 @@ 
  */
 function getpaid_get_subscription_status_counts( $args = array() ) {
 
-	$statuses = array_keys( getpaid_get_subscription_statuses() );
-	$counts   = array();
+    $statuses = array_keys( getpaid_get_subscription_statuses() );
+    $counts   = array();
 
-	foreach ( $statuses as $status ) {
-		$_args             = wp_parse_args( "status=$status", $args );
-		$counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
-	}
+    foreach ( $statuses as $status ) {
+        $_args             = wp_parse_args( "status=$status", $args );
+        $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
+    }
 
-	return $counts;
+    return $counts;
 
 }
 
@@ -121,32 +121,32 @@ 
  */
 function getpaid_get_subscription_periods() {
 
-	return apply_filters(
-		'getpaid_get_subscription_periods',
-		array(
+    return apply_filters(
+        'getpaid_get_subscription_periods',
+        array(
 
-			'day'   => array(
-				'singular' => __( '%s day', 'invoicing' ),
-				'plural'   => __( '%d days', 'invoicing' ),
-			),
+            'day'   => array(
+                'singular' => __( '%s day', 'invoicing' ),
+                'plural'   => __( '%d days', 'invoicing' ),
+            ),
 
-			'week'   => array(
-				'singular' => __( '%s week', 'invoicing' ),
-				'plural'   => __( '%d weeks', 'invoicing' ),
-			),
+            'week'   => array(
+                'singular' => __( '%s week', 'invoicing' ),
+                'plural'   => __( '%d weeks', 'invoicing' ),
+            ),
 
-			'month'   => array(
-				'singular' => __( '%s month', 'invoicing' ),
-				'plural'   => __( '%d months', 'invoicing' ),
-			),
+            'month'   => array(
+                'singular' => __( '%s month', 'invoicing' ),
+                'plural'   => __( '%d months', 'invoicing' ),
+            ),
 
-			'year'   => array(
-				'singular' => __( '%s year', 'invoicing' ),
-				'plural'   => __( '%d years', 'invoicing' ),
-			),
+            'year'   => array(
+                'singular' => __( '%s year', 'invoicing' ),
+                'plural'   => __( '%d years', 'invoicing' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -157,7 +157,7 @@ 
  * @return int
  */
 function getpaid_get_subscription_trial_period_interval( $trial_period ) {
-	return (int) preg_replace( '/[^0-9]/', '', $trial_period );
+    return (int) preg_replace( '/[^0-9]/', '', $trial_period );
 }
 
 /**
@@ -167,7 +167,7 @@ 
  * @return string
  */
 function getpaid_get_subscription_trial_period_period( $trial_period ) {
-	return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
+    return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
 }
 
 /**
@@ -178,8 +178,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) {
-	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
-	return strtolower( sanitize_text_field( $label ) );
+    $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
+    return strtolower( sanitize_text_field( $label ) );
 }
 
 /**
@@ -190,22 +190,22 @@ 
  */
 function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['singular'], $singular_prefix );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['singular'], $singular_prefix );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['singular'], $singular_prefix );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['singular'], $singular_prefix );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -217,22 +217,22 @@ 
  */
 function getpaid_get_plural_subscription_period_label( $period, $interval ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['plural'], $interval );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['plural'], $interval );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['plural'], $interval );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['plural'], $interval );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -243,101 +243,101 @@ 
  */
 function getpaid_get_formatted_subscription_amount( $subscription ) {
 
-	$initial    = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
-	$recurring  = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-	$period     = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-	$bill_times = $subscription->get_bill_times();
+    $initial    = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
+    $recurring  = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+    $period     = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+    $bill_times = $subscription->get_bill_times();
 
-	if ( ! empty( $bill_times ) ) {
-		$bill_times = $subscription->get_frequency() * $bill_times;
-		$bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times );
-	}
+    if ( ! empty( $bill_times ) ) {
+        $bill_times = $subscription->get_frequency() * $bill_times;
+        $bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times );
+    }
 
-	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
+    // Trial periods.
+    if ( $subscription->has_trial_period() ) {
 
-		$trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
-		$trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+        $trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
+        $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
 
-		if ( empty( $bill_times ) ) {
+        if ( empty( $bill_times ) ) {
 
-			return sprintf(
+            return sprintf(
 
-				// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
-				_x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
-				$initial,
-				getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-				$recurring,
-				$period
+                // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
+                _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
+                $initial,
+                getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+                $recurring,
+                $period
 	
-			);
+            );
 
-		}
+        }
 
-		return sprintf(
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times
-			_x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ),
-			$initial,
-			getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-			$recurring,
-			$period,
-			$bill_times
-		);
+            // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times
+            _x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ),
+            $initial,
+            getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+            $recurring,
+            $period,
+            $bill_times
+        );
 
-	}
+    }
 
-	if ( $initial != $recurring ) {
+    if ( $initial != $recurring ) {
 
-		if ( empty( $bill_times ) ) {
+        if ( empty( $bill_times ) ) {
 
-			return sprintf(
+            return sprintf(
 
-				// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
-				_x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
-				$initial,
-				$recurring,
-				$period
+                // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
+                _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
+                $initial,
+                $recurring,
+                $period
 	
-			);
+            );
 
-		}
+        }
 
-		return sprintf(
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times
-			_x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ),
-			$initial,
-			$recurring,
-			$period,
-			$bill_times
+            // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times
+            _x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ),
+            $initial,
+            $recurring,
+            $period,
+            $bill_times
 
-		);
+        );
 
-	}
+    }
 
-	if ( empty( $bill_times ) ) {
+    if ( empty( $bill_times ) ) {
 
-		return sprintf(
+        return sprintf(
 
-			// translators: $1: is the recurring amount, $2: is the recurring period
-			_x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
-			$initial,
-			$period
+            // translators: $1: is the recurring amount, $2: is the recurring period
+            _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
+            $initial,
+            $period
 	
-		);
+        );
 
-	}
+    }
 
-	return sprintf(
+    return sprintf(
 
-		// translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period
-		_x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ),
-		$bill_times,
-		$initial,
-		$period
+        // translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period
+        _x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ),
+        $bill_times,
+        $initial,
+        $period
 
-	);
+    );
 
 }
 
@@ -348,7 +348,7 @@ 
  * @return WPInv_Subscription|bool
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -357,10 +357,10 @@ 
  * @param WPInv_Invoice $invoice
  */
 function getpaid_activate_invoice_subscription( $invoice ) {
-	$subscription = getpaid_get_invoice_subscription( $invoice );
-	if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription->activate();
-	}
+    $subscription = getpaid_get_invoice_subscription( $invoice );
+    if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription->activate();
+    }
 }
 
 /**
@@ -369,7 +369,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -387,15 +387,15 @@ 
         return false;
     }
 
-	// Fetch the invoiec subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoiec subscription.
+    $subscription = getpaid_get_subscriptions(
+        array(
+            'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
+            'number'     => 1,
+        )
+    );
 
-	return empty( $subscription ) ? false : $subscription[0];
+    return empty( $subscription ) ? false : $subscription[0];
 
 }
 
@@ -412,48 +412,48 @@ 
  */
 function getpaid_get_recurring_item_key( $cart_item ) {
 
-	$cart_key     = 'renews_';
-	$interval     = $cart_item->get_recurring_interval();
-	$period       = $cart_item->get_recurring_period( true );
-	$length       = $cart_item->get_recurring_limit() * $interval;
-	$trial_period = $cart_item->get_trial_period( true );
-	$trial_length = $cart_item->get_trial_interval();
-
-	// First start with the billing interval and period
-	switch ( $interval ) {
-		case 1 :
-			if ( 'day' == $period ) {
-				$cart_key .= 'daily';
-			} else {
-				$cart_key .= sprintf( '%sly', $period );
-			}
-			break;
-		case 2 :
-			$cart_key .= sprintf( 'every_2nd_%s', $period );
-			break;
-		case 3 :
-			$cart_key .= sprintf( 'every_3rd_%s', $period );
-		break;
-		default:
-			$cart_key .= sprintf( 'every_%dth_%s', $interval, $period );
-			break;
-	}
-
-	// Maybe add the optional maximum billing periods...
-	if ( $length > 0 ) {
-		$cart_key .= '_for_';
-		$cart_key .= sprintf( '%d_%s', $length, $period );
-		if ( $length > 1 ) {
-			$cart_key .= 's';
-		}
-	}
-
-	// And an optional free trial.
-	if ( $cart_item->has_free_trial() ) {
-		$cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period );
-	}
-
-	return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item );
+    $cart_key     = 'renews_';
+    $interval     = $cart_item->get_recurring_interval();
+    $period       = $cart_item->get_recurring_period( true );
+    $length       = $cart_item->get_recurring_limit() * $interval;
+    $trial_period = $cart_item->get_trial_period( true );
+    $trial_length = $cart_item->get_trial_interval();
+
+    // First start with the billing interval and period
+    switch ( $interval ) {
+        case 1 :
+            if ( 'day' == $period ) {
+                $cart_key .= 'daily';
+            } else {
+                $cart_key .= sprintf( '%sly', $period );
+            }
+            break;
+        case 2 :
+            $cart_key .= sprintf( 'every_2nd_%s', $period );
+            break;
+        case 3 :
+            $cart_key .= sprintf( 'every_3rd_%s', $period );
+        break;
+        default:
+            $cart_key .= sprintf( 'every_%dth_%s', $interval, $period );
+            break;
+    }
+
+    // Maybe add the optional maximum billing periods...
+    if ( $length > 0 ) {
+        $cart_key .= '_for_';
+        $cart_key .= sprintf( '%d_%s', $length, $period );
+        if ( $length > 1 ) {
+            $cart_key .= 's';
+        }
+    }
+
+    // And an optional free trial.
+    if ( $cart_item->has_free_trial() ) {
+        $cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period );
+    }
+
+    return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item );
 }
 
 /**
@@ -464,17 +464,17 @@ 
  */
 function getpaid_get_subscription_groups( $invoice ) {
 
-	// Generate subscription groups.
-	$subscription_groups = array();
-	foreach ( $invoice->get_items() as $item ) {
+    // Generate subscription groups.
+    $subscription_groups = array();
+    foreach ( $invoice->get_items() as $item ) {
 
-		if ( $item->is_recurring() ) {
-			$subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item;
-		}
+        if ( $item->is_recurring() ) {
+            $subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item;
+        }
 
-	}
+    }
 
-	return $subscription_groups;
+    return $subscription_groups;
 }
 
 /**
@@ -488,51 +488,51 @@ 
  */
 function getpaid_calculate_subscription_totals( $invoice ) {
 
-	// Generate subscription groups.
-	$subscription_groups = getpaid_get_subscription_groups( $invoice );
+    // Generate subscription groups.
+    $subscription_groups = getpaid_get_subscription_groups( $invoice );
 
-	// Now let's calculate the totals for each group of subscriptions
-	$subscription_totals = array();
+    // Now let's calculate the totals for each group of subscriptions
+    $subscription_totals = array();
 
-	foreach ( $subscription_groups as $subscription_key => $items ) {
+    foreach ( $subscription_groups as $subscription_key => $items ) {
 
-		if ( empty( $subscription_totals[ $subscription_key ] ) ) {
+        if ( empty( $subscription_totals[ $subscription_key ] ) ) {
 
-			$subscription_totals[ $subscription_key ] = array(
-				'initial_total'   => 0,
-				'recurring_total' => 0,
-				'items'           => array(),
-				'trialling'       => false,
-			);
+            $subscription_totals[ $subscription_key ] = array(
+                'initial_total'   => 0,
+                'recurring_total' => 0,
+                'items'           => array(),
+                'trialling'       => false,
+            );
 
-		}
+        }
 
-		// Get the totals of the group.
-		foreach ( $items as $item ) {
+        // Get the totals of the group.
+        foreach ( $items as $item ) {
 
-			$subscription_totals[ $subscription_key ]['items'][]          = $item->get_id();
-			$subscription_totals[ $subscription_key ]['item_id']          = $item->get_id();
-			$subscription_totals[ $subscription_key ]['period']           = $item->get_recurring_period( true );
-			$subscription_totals[ $subscription_key ]['interval']         = $item->get_recurring_interval();
-			$subscription_totals[ $subscription_key ]['initial_total']   += $item->get_sub_total();
-			$subscription_totals[ $subscription_key ]['recurring_total'] += $item->get_recurring_sub_total();
+            $subscription_totals[ $subscription_key ]['items'][]          = $item->get_id();
+            $subscription_totals[ $subscription_key ]['item_id']          = $item->get_id();
+            $subscription_totals[ $subscription_key ]['period']           = $item->get_recurring_period( true );
+            $subscription_totals[ $subscription_key ]['interval']         = $item->get_recurring_interval();
+            $subscription_totals[ $subscription_key ]['initial_total']   += $item->get_sub_total();
+            $subscription_totals[ $subscription_key ]['recurring_total'] += $item->get_recurring_sub_total();
 
-			// Calculate the next renewal date.
-			$period       = $item->get_recurring_period( true );
-			$interval     = $item->get_recurring_interval();
+            // Calculate the next renewal date.
+            $period       = $item->get_recurring_period( true );
+            $interval     = $item->get_recurring_interval();
 
-			// If the subscription item has a trial period...
-			if ( $item->has_free_trial() ) {
-				$period   = $item->get_trial_period( true );
-				$interval = $item->get_trial_interval();
-				$subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period;
-			}
+            // If the subscription item has a trial period...
+            if ( $item->has_free_trial() ) {
+                $period   = $item->get_trial_period( true );
+                $interval = $item->get_trial_interval();
+                $subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period;
+            }
 
-			$subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) );
+            $subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) );
 
-		}
+        }
 
-	}
+    }
 
-	return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice );
+    return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice );
 }

includes/payments/class-getpaid-payment-form-submission.php

Indentation +813 added lines, -813 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,206 +10,206 @@ 
 class GetPaid_Payment_Form_Submission {
 
     /**
-	 * Submission ID
-	 *
-	 * @var string
-	 */
-	public $id = null;
-
-	/**
-	 * The raw submission data.
-	 *
-	 * @var array
-	 */
-	protected $data = null;
-
-	/**
-	 * Submission totals
-	 *
-	 * @var array
-	 */
-	protected $totals = array(
-
-		'subtotal'      => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'discount'      => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'fees'          => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'taxes'         => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-	);
-
-	/**
-	 * Sets the associated payment form.
-	 *
-	 * @var GetPaid_Payment_Form
-	 */
+     * Submission ID
+     *
+     * @var string
+     */
+    public $id = null;
+
+    /**
+     * The raw submission data.
+     *
+     * @var array
+     */
+    protected $data = null;
+
+    /**
+     * Submission totals
+     *
+     * @var array
+     */
+    protected $totals = array(
+
+        'subtotal'      => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'discount'      => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'fees'          => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'taxes'         => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+    );
+
+    /**
+     * Sets the associated payment form.
+     *
+     * @var GetPaid_Payment_Form
+     */
     protected $payment_form = null;
 
     /**
-	 * The country for the submission.
-	 *
-	 * @var string
-	 */
-	public $country = null;
-
-    /**
-	 * The state for the submission.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $state = null;
-
-	/**
-	 * The invoice associated with the submission.
-	 *
-	 * @var WPInv_Invoice
-	 */
-	protected $invoice = null;
-
-	/**
-	 * The recurring item for the submission.
-	 *
-	 * @var int
-	 */
-	public $has_recurring = 0;
-
-	/**
-	 * The subscription groups. If more than 2, ensure the gateway
-	 * supports multiple subscriptions.
-	 *
-	 * @var array
-	 */
-	public $subscription_groups = array();
-
-	/**
-	 * An array of fees for the submission.
-	 *
-	 * @var array
-	 */
-	protected $fees = array();
-
-	/**
-	 * An array of discounts for the submission.
-	 *
-	 * @var array
-	 */
-	protected $discounts = array();
-
-	/**
-	 * An array of taxes for the submission.
-	 *
-	 * @var array
-	 */
-	protected $taxes = array();
-
-	/**
-	 * An array of items for the submission.
-	 *
-	 * @var GetPaid_Form_Item[]
-	 */
-	protected $items = array();
-
-	/**
-	 * The last error.
-	 *
-	 * @var string
-	 */
-	public $last_error = null;
-
-	/**
-	 * The last error code.
-	 *
-	 * @var string
-	 */
-	public $last_error_code = null;
-
-    /**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-
-		// Set the state and country to the default state and country.
-		$this->country = wpinv_default_billing_country();
-		$this->state   = wpinv_get_default_state();
-
-		// Do we have an actual submission?
-		if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
-			$this->load_data( $_POST );
-		}
-
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Remove slashes from the submitted data...
-		$data       = wp_unslash( $data );
-
-		// Allow plugins to filter the data.
-		$data       = apply_filters( 'getpaid_submission_data', $data, $this );
-
-		// Cache it...
-		$this->data = $data;
-
-		// Then generate a unique id from the data.
-		$this->id   = md5( wp_json_encode( $data ) );
-
-		// Finally, process the submission.
-		try {
-
-			// Each process is passed an instance of the class (with reference)
-			// and should throw an Exception whenever it encounters one.
-			$processors = apply_filters(
-				'getpaid_payment_form_submission_processors',
-				array(
-					array( $this, 'process_payment_form' ),
-					array( $this, 'process_invoice' ),
-					array( $this, 'process_fees' ),
-					array( $this, 'process_items' ),
-					array( $this, 'process_discount' ),
-					array( $this, 'process_taxes' ),
-				),
-				$this		
-			);
-
-			foreach ( $processors as $processor ) {
-				call_user_func_array( $processor, array( &$this ) );
-			}
-
-		} catch( GetPaid_Payment_Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getErrorCode();
-		} catch ( Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getCode();
-		}
-
-		// Fired when we are done processing a submission.
-		do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
-
-	}
-
-	/*
+     * The country for the submission.
+     *
+     * @var string
+     */
+    public $country = null;
+
+    /**
+     * The state for the submission.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $state = null;
+
+    /**
+     * The invoice associated with the submission.
+     *
+     * @var WPInv_Invoice
+     */
+    protected $invoice = null;
+
+    /**
+     * The recurring item for the submission.
+     *
+     * @var int
+     */
+    public $has_recurring = 0;
+
+    /**
+     * The subscription groups. If more than 2, ensure the gateway
+     * supports multiple subscriptions.
+     *
+     * @var array
+     */
+    public $subscription_groups = array();
+
+    /**
+     * An array of fees for the submission.
+     *
+     * @var array
+     */
+    protected $fees = array();
+
+    /**
+     * An array of discounts for the submission.
+     *
+     * @var array
+     */
+    protected $discounts = array();
+
+    /**
+     * An array of taxes for the submission.
+     *
+     * @var array
+     */
+    protected $taxes = array();
+
+    /**
+     * An array of items for the submission.
+     *
+     * @var GetPaid_Form_Item[]
+     */
+    protected $items = array();
+
+    /**
+     * The last error.
+     *
+     * @var string
+     */
+    public $last_error = null;
+
+    /**
+     * The last error code.
+     *
+     * @var string
+     */
+    public $last_error_code = null;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+
+        // Set the state and country to the default state and country.
+        $this->country = wpinv_default_billing_country();
+        $this->state   = wpinv_get_default_state();
+
+        // Do we have an actual submission?
+        if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
+            $this->load_data( $_POST );
+        }
+
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Remove slashes from the submitted data...
+        $data       = wp_unslash( $data );
+
+        // Allow plugins to filter the data.
+        $data       = apply_filters( 'getpaid_submission_data', $data, $this );
+
+        // Cache it...
+        $this->data = $data;
+
+        // Then generate a unique id from the data.
+        $this->id   = md5( wp_json_encode( $data ) );
+
+        // Finally, process the submission.
+        try {
+
+            // Each process is passed an instance of the class (with reference)
+            // and should throw an Exception whenever it encounters one.
+            $processors = apply_filters(
+                'getpaid_payment_form_submission_processors',
+                array(
+                    array( $this, 'process_payment_form' ),
+                    array( $this, 'process_invoice' ),
+                    array( $this, 'process_fees' ),
+                    array( $this, 'process_items' ),
+                    array( $this, 'process_discount' ),
+                    array( $this, 'process_taxes' ),
+                ),
+                $this		
+            );
+
+            foreach ( $processors as $processor ) {
+                call_user_func_array( $processor, array( &$this ) );
+            }
+
+        } catch( GetPaid_Payment_Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getErrorCode();
+        } catch ( Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getCode();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -218,39 +218,39 @@ 
 	| submission has an active payment form etc.
     */
 
-	/**
-	 * Prepares the submission's payment form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_payment_form() {
+    /**
+     * Prepares the submission's payment form.
+     *
+     * @since 1.0.19
+     */
+    public function process_payment_form() {
 
-		// Every submission needs an active payment form.
-		if ( empty( $this->data['form_id'] ) ) {
-			throw new Exception( __( 'Missing payment form', 'invoicing' ) );
-		}
+        // Every submission needs an active payment form.
+        if ( empty( $this->data['form_id'] ) ) {
+            throw new Exception( __( 'Missing payment form', 'invoicing' ) );
+        }
 
-		// Fetch the payment form.
-		$this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
+        // Fetch the payment form.
+        $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
 
-		if ( ! $this->payment_form->is_active() ) {
-			throw new Exception( __( 'Payment form not active', 'invoicing' ) );
-		}
+        if ( ! $this->payment_form->is_active() ) {
+            throw new Exception( __( 'Payment form not active', 'invoicing' ) );
+        }
 
-		do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
-	}
+        do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
+    }
 
     /**
-	 * Returns the payment form.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Payment_Form
-	 */
-	public function get_payment_form() {
-		return $this->payment_form;
-	}
+     * Returns the payment form.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Payment_Form
+     */
+    public function get_payment_form() {
+        return $this->payment_form;
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Invoices.
 	|--------------------------------------------------------------------------
@@ -259,84 +259,84 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_invoice() {
+    /**
+     * Prepares the submission's invoice.
+     *
+     * @since 1.0.19
+     */
+    public function process_invoice() {
 
-		// Abort if there is no invoice.
-		if ( empty( $this->data['invoice_id'] ) ) {
-			return;
-		}
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+            return;
+        }
 
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
 
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
 
-		$this->payment_form->invoice = $invoice;
-		if ( ! $this->payment_form->is_default() ) {
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
 
-			$items    = array();
-			$item_ids = array();
+            $items    = array();
+            $item_ids = array();
 	
-			foreach ( $invoice->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
+            foreach ( $invoice->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
 	
-			foreach ( $this->payment_form->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
+            foreach ( $this->payment_form->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
 	
-			$this->payment_form->set_items( $items );
+            $this->payment_form->set_items( $items );
 	
-		} else {
-			$this->payment_form->set_items( $invoice->get_items() );
-		}
-
-		$this->country = $invoice->get_country();
-		$this->state   = $invoice->get_state();
-		$this->invoice = $invoice;
-
-		do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
-	}
-
-	/**
-	 * Returns the associated invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
-	public function get_invoice() {
-		return $this->invoice;
-	}
-
-	/**
-	 * Checks whether there is an invoice associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_invoice() {
-		return ! empty( $this->invoice );
-	}
-
-	/*
+        } else {
+            $this->payment_form->set_items( $invoice->get_items() );
+        }
+
+        $this->country = $invoice->get_country();
+        $this->state   = $invoice->get_state();
+        $this->invoice = $invoice;
+
+        do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
+    }
+
+    /**
+     * Returns the associated invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
+    public function get_invoice() {
+        return $this->invoice;
+    }
+
+    /**
+     * Checks whether there is an invoice associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_invoice() {
+        return ! empty( $this->invoice );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Items.
 	|--------------------------------------------------------------------------
@@ -345,116 +345,116 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-
-			if ( $this->has_recurring != 0 ) {
-				throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
-			}
-
-			$this->has_recurring = $item->get_id();
-
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-
-		$this->subscription_groups = getpaid_calculate_subscription_totals( $this );
-	}
-
-	/**
-	 * Removes a specific item.
-	 * 
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+
+            if ( $this->has_recurring != 0 ) {
+                throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
+            }
+
+            $this->has_recurring = $item->get_id();
+
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+
+        $this->subscription_groups = getpaid_calculate_subscription_totals( $this );
+    }
+
+    /**
+     * Removes a specific item.
+     * 
+     * You should not call this method after the discounts and taxes
+     * have been calculated.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
+
+        if ( isset( $this->items[ $item_id ] ) ) {
+            $this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
+            $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
+
+            if ( $this->items[ $item_id ]->is_recurring() ) {
+                $this->has_recurring = 0;
+            }
+
+            unset( $this->items[ $item_id ] );
+        }
+
+    }
+
+    /**
+     * Returns the subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
+        }
+
+        return $this->totals['subtotal']['initial'];
+    }
+
+    /**
+     * Returns the recurring subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
+        }
+
+        return $this->totals['subtotal']['recurring'];
+    }
+
+    /**
+     * Returns all items.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items() {
+        return $this->items;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -463,128 +463,128 @@ 
 	| or only one-time.
     */
 
-	/**
-	 * Prepares the submission's taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_taxes() {
-
-		// Abort if we're not using taxes.
-		if ( ! $this->use_taxes() ) {
-			return;
-		}
-
-		// If a custom country && state has been passed in, use it to calculate taxes.
-		$country = $this->get_field( 'wpinv_country', 'billing' );
-		if ( ! empty( $country ) ) {
-			$this->country = $country;
-		}
-
-		$state = $this->get_field( 'wpinv_state', 'billing' );
-		if ( ! empty( $state ) ) {
-			$this->state = $state;
-		}
-
-		// Confirm if the provided country and the ip country are similar.
-		$address_confirmed = $this->get_field( 'confirm-address' );
-		if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
-			throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
-		}
-
-		// Abort if the country is not taxable.
-		if ( ! wpinv_is_country_taxable( $this->country ) ) {
-			return;
-		}
-
-		$processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
-
-		foreach ( $processor->taxes as $tax ) {
-			$this->add_tax( $tax );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
-	}
-
-	/**
-	 * Adds a tax to the submission.
-	 *
-	 * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
-	 * @since 1.0.19
-	 */
-	public function add_tax( $tax ) {
-
-		if ( wpinv_round_tax_per_tax_rate() ) {
-			$tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
-			$tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
-		}
-
-		$this->taxes[ $tax['name'] ]         = $tax;
-		$this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
-		$this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
-
-	}
-
-	/**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax_name ) {
-
-		if ( isset( $this->taxes[ $tax_name ] ) ) {
-			$this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
-			$this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
-			unset( $this->taxes[ $tax_name ] );
-		}
-
-	}
-
-	/**
-	 * Whether or not we'll use taxes for the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function use_taxes() {
-
-		$use_taxes = wpinv_use_taxes();
-
-		if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
-			$use_taxes = false;
-		}
-
-		return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
-
-	}
-
-	/**
-	 * Returns the tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax() {
-		return $this->totals['taxes']['initial'];
-	}
-
-	/**
-	 * Returns the recurring tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_tax() {
-		return $this->totals['taxes']['recurring'];
-	}
-
-	/**
-	 * Returns all taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_taxes() {
-		return $this->taxes;
-	}
-
-	/*
+    /**
+     * Prepares the submission's taxes.
+     *
+     * @since 1.0.19
+     */
+    public function process_taxes() {
+
+        // Abort if we're not using taxes.
+        if ( ! $this->use_taxes() ) {
+            return;
+        }
+
+        // If a custom country && state has been passed in, use it to calculate taxes.
+        $country = $this->get_field( 'wpinv_country', 'billing' );
+        if ( ! empty( $country ) ) {
+            $this->country = $country;
+        }
+
+        $state = $this->get_field( 'wpinv_state', 'billing' );
+        if ( ! empty( $state ) ) {
+            $this->state = $state;
+        }
+
+        // Confirm if the provided country and the ip country are similar.
+        $address_confirmed = $this->get_field( 'confirm-address' );
+        if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
+            throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
+        }
+
+        // Abort if the country is not taxable.
+        if ( ! wpinv_is_country_taxable( $this->country ) ) {
+            return;
+        }
+
+        $processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
+
+        foreach ( $processor->taxes as $tax ) {
+            $this->add_tax( $tax );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
+    }
+
+    /**
+     * Adds a tax to the submission.
+     *
+     * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
+     * @since 1.0.19
+     */
+    public function add_tax( $tax ) {
+
+        if ( wpinv_round_tax_per_tax_rate() ) {
+            $tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
+            $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
+        }
+
+        $this->taxes[ $tax['name'] ]         = $tax;
+        $this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
+        $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
+
+    }
+
+    /**
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax_name ) {
+
+        if ( isset( $this->taxes[ $tax_name ] ) ) {
+            $this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
+            $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
+            unset( $this->taxes[ $tax_name ] );
+        }
+
+    }
+
+    /**
+     * Whether or not we'll use taxes for the submission.
+     *
+     * @since 1.0.19
+     */
+    public function use_taxes() {
+
+        $use_taxes = wpinv_use_taxes();
+
+        if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
+            $use_taxes = false;
+        }
+
+        return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
+
+    }
+
+    /**
+     * Returns the tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax() {
+        return $this->totals['taxes']['initial'];
+    }
+
+    /**
+     * Returns the recurring tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_tax() {
+        return $this->totals['taxes']['recurring'];
+    }
+
+    /**
+     * Returns all taxes.
+     *
+     * @since 1.0.19
+     */
+    public function get_taxes() {
+        return $this->taxes;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Discounts
 	|--------------------------------------------------------------------------
@@ -593,99 +593,99 @@ 
 	| or only one-time. They also do not have to come from a discount code.
     */
 
-	/**
-	 * Prepares the submission's discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_discount() {
-
-		$initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
-		$recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
-		$processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
-
-		foreach ( $processor->discounts as $discount ) {
-			$this->add_discount( $discount );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
-	}
-
-	/**
-	 * Adds a discount to the submission.
-	 *
-	 * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
-	 * @since 1.0.19
-	 */
-	public function add_discount( $discount ) {
-		$this->discounts[ $discount['name'] ]   = $discount;
-		$this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
-		$this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
-	}
-
-	/**
-	 * Removes a discount from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $name ) {
-
-		if ( isset( $this->discounts[ $name ] ) ) {
-			$this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
-			$this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
-			unset( $this->discounts[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Checks whether there is a discount code associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_discount_code() {
-		return ! empty( $this->discounts['discount_code'] );
-	}
-
-	/**
-	 * Returns the discount code.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_discount_code() {
-		return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
-	}
-
-	/**
-	 * Returns the discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount() {
-		return $this->totals['discount']['initial'];
-	}
-
-	/**
-	 * Returns the recurring discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_discount() {
-		return $this->totals['discount']['recurring'];
-	}
-
-	/**
-	 * Returns all discounts.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discounts() {
-		return $this->discounts;
-	}
-
-	/*
+    /**
+     * Prepares the submission's discount.
+     *
+     * @since 1.0.19
+     */
+    public function process_discount() {
+
+        $initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
+        $recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
+        $processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
+
+        foreach ( $processor->discounts as $discount ) {
+            $this->add_discount( $discount );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
+    }
+
+    /**
+     * Adds a discount to the submission.
+     *
+     * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
+     * @since 1.0.19
+     */
+    public function add_discount( $discount ) {
+        $this->discounts[ $discount['name'] ]   = $discount;
+        $this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
+        $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
+    }
+
+    /**
+     * Removes a discount from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $name ) {
+
+        if ( isset( $this->discounts[ $name ] ) ) {
+            $this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
+            $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
+            unset( $this->discounts[ $name ] );
+        }
+
+    }
+
+    /**
+     * Checks whether there is a discount code associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_discount_code() {
+        return ! empty( $this->discounts['discount_code'] );
+    }
+
+    /**
+     * Returns the discount code.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_discount_code() {
+        return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
+    }
+
+    /**
+     * Returns the discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount() {
+        return $this->totals['discount']['initial'];
+    }
+
+    /**
+     * Returns the recurring discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_discount() {
+        return $this->totals['discount']['recurring'];
+    }
+
+    /**
+     * Returns all discounts.
+     *
+     * @since 1.0.19
+     */
+    public function get_discounts() {
+        return $this->discounts;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Fees
 	|--------------------------------------------------------------------------
@@ -695,89 +695,89 @@ 
 	| fees.
     */
 
-	/**
-	 * Prepares the submission's fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_fees() {
-
-		$fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
-
-		foreach ( $fees_processor->fees as $fee ) {
-			$this->add_fee( $fee );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
-	}
-
-	/**
-	 * Adds a fee to the submission.
-	 *
-	 * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
-	 * @since 1.0.19
-	 */
-	public function add_fee( $fee ) {
-
-		$this->fees[ $fee['name'] ]         = $fee;
-		$this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-		$this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-
-	}
-
-	/**
-	 * Removes a fee from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $name ) {
-
-		if ( isset( $this->fees[ $name ] ) ) {
-			$this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
-			$this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
-			unset( $this->fees[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Returns the fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee() {
-		return $this->totals['fees']['initial'];
-	}
-
-	/**
-	 * Returns the recurring fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_fee() {
-		return $this->totals['fees']['recurring'];
-	}
-
-	/**
-	 * Returns all fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fees() {
-		return $this->fees;
-	}
-
-	/**
-	 * Checks if there are any fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_fees() {
-		return count( $this->fees ) !== 0;
-	}
-
-	/*
+    /**
+     * Prepares the submission's fees.
+     *
+     * @since 1.0.19
+     */
+    public function process_fees() {
+
+        $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
+
+        foreach ( $fees_processor->fees as $fee ) {
+            $this->add_fee( $fee );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
+    }
+
+    /**
+     * Adds a fee to the submission.
+     *
+     * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
+     * @since 1.0.19
+     */
+    public function add_fee( $fee ) {
+
+        $this->fees[ $fee['name'] ]         = $fee;
+        $this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+        $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+
+    }
+
+    /**
+     * Removes a fee from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $name ) {
+
+        if ( isset( $this->fees[ $name ] ) ) {
+            $this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
+            $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
+            unset( $this->fees[ $name ] );
+        }
+
+    }
+
+    /**
+     * Returns the fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee() {
+        return $this->totals['fees']['initial'];
+    }
+
+    /**
+     * Returns the recurring fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_fee() {
+        return $this->totals['fees']['recurring'];
+    }
+
+    /**
+     * Returns all fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fees() {
+        return $this->fees;
+    }
+
+    /**
+     * Checks if there are any fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_fees() {
+        return count( $this->fees ) !== 0;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| MISC
 	|--------------------------------------------------------------------------
@@ -785,119 +785,119 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return empty( $this->data['initial_state'] );
-	}
-
-	/**
-	 * Returns the total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_total() {
-		$total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Returns the recurring total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_total() {
-		$total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Whether payment details should be collected for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function should_collect_payment_details() {
-		$initial   = $this->get_total();
-		$recurring = $this->get_recurring_total();
-
-		if ( $this->has_recurring == 0 ) {
-			$recurring = 0;
-		}
-
-		$collect = $initial > 0 || $recurring > 0;
-		return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this  );
-	}
-
-	/**
-	 * Returns the billing email of the user.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_billing_email() {
-		return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this  );
-	}
-
-	/**
-	 * Checks if the submitter has a billing email.
-	 *
-	 * @since 1.0.19
-	 */
-	public function has_billing_email() {
-		$billing_email = $this->get_billing_email();
-		return ! empty( $billing_email ) && is_email( $billing_email );
-	}
-
-	/**
-	 * Returns the appropriate currency for the submission.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_currency() {
-		return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
-    }
-
-    /**
-	 * Returns the raw submission data.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return $this->data;
-	}
-
-	/**
-	 * Returns a field from the submission data
-	 *
-	 * @param string $field
-	 * @since 1.0.19
-	 * @return mixed|null
-	 */
-	public function get_field( $field, $sub_array_key = null ) {
-		return getpaid_get_array_field( $this->data, $field, $sub_array_key );
-	}
-
-	/**
-	 * Checks if a required field is set.
-	 *
-	 * @since 1.0.19
-	 */
-	public function is_required_field_set( $field ) {
-		return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
-	}
-
-	/**
-	 * Formats an amount
-	 *
-	 * @since 1.0.19
-	 */
-	public function format_amount( $amount ) {
-		return wpinv_price( $amount, $this->get_currency() );
-	}
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return empty( $this->data['initial_state'] );
+    }
+
+    /**
+     * Returns the total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_total() {
+        $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Returns the recurring total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_total() {
+        $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Whether payment details should be collected for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function should_collect_payment_details() {
+        $initial   = $this->get_total();
+        $recurring = $this->get_recurring_total();
+
+        if ( $this->has_recurring == 0 ) {
+            $recurring = 0;
+        }
+
+        $collect = $initial > 0 || $recurring > 0;
+        return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this  );
+    }
+
+    /**
+     * Returns the billing email of the user.
+     *
+     * @since 1.0.19
+     */
+    public function get_billing_email() {
+        return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this  );
+    }
+
+    /**
+     * Checks if the submitter has a billing email.
+     *
+     * @since 1.0.19
+     */
+    public function has_billing_email() {
+        $billing_email = $this->get_billing_email();
+        return ! empty( $billing_email ) && is_email( $billing_email );
+    }
+
+    /**
+     * Returns the appropriate currency for the submission.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_currency() {
+        return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
+    }
+
+    /**
+     * Returns the raw submission data.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return $this->data;
+    }
+
+    /**
+     * Returns a field from the submission data
+     *
+     * @param string $field
+     * @since 1.0.19
+     * @return mixed|null
+     */
+    public function get_field( $field, $sub_array_key = null ) {
+        return getpaid_get_array_field( $this->data, $field, $sub_array_key );
+    }
+
+    /**
+     * Checks if a required field is set.
+     *
+     * @since 1.0.19
+     */
+    public function is_required_field_set( $field ) {
+        return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
+    }
+
+    /**
+     * Formats an amount
+     *
+     * @since 1.0.19
+     */
+    public function format_amount( $amount ) {
+        return wpinv_price( $amount, $this->get_currency() );
+    }
 
 }