AyeCode / invoicing

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +390 added lines, -390 removed lines

@@ -12,472 +12,472 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		if ( is_wp_error( $response ) ) {
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        if ( is_wp_error( $response ) ) {
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
 
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
 
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
 
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
 
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = wpinv_get_option( 'paypal_email' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = wpinv_get_option( 'paypal_email' );
 
-		if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
+        if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
 
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
-
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		// Process a refund.
-		if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
+        // Process a refund.
+        if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( $payment_status == 'completed' ) {
+        // Process payments.
+        if ( $payment_status == 'completed' ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( $payment_status == 'pending' ) {
+        // Pending payments.
+        if ( $payment_status == 'pending' ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach( $dates as $date ) {
+        foreach( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );	
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );	
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false);
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false);
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }

includes/wpinv-subscription.php

Indentation +1035 added lines, -1035 removed lines

@@ -15,125 +15,125 @@ 
  */
 class WPInv_Subscription extends GetPaid_Data {
 
-	/**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
-	protected $data_store_name = 'subscription';
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'subscription';
-
-	/**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'customer_id'       => 0,
-		'frequency'         => 1,
-		'period'            => 'D',
-		'initial_amount'    => null,
-		'recurring_amount'  => null,
-		'bill_times'        => 0,
-		'transaction_id'    => '',
-		'parent_payment_id' => null,
-		'product_id'        => 0,
-		'created'           => '0000-00-00 00:00:00',
-		'expiration'        => '0000-00-00 00:00:00',
-		'trial_period'      => '',
-		'status'            => 'pending',
-		'profile_id'        => '',
-		'gateway'           => '',
-		'customer'          => '',
-	);
-
-	/**
-	 * Stores the status transition information.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $status_transition = false;
-
-	/**
-	 * Get the subscription if ID is passed, otherwise the subscription is new and empty.
-	 *
-	 * @param  int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read.
-	 * @param  bool $deprecated
-	 */
-	function __construct( $subscription = 0, $deprecated = false ) {
-
-		parent::__construct( $subscription );
-
-		if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) {
-			$this->set_id( $subscription );
-		} elseif ( $subscription instanceof self ) {
-			$this->set_id( $subscription->get_id() );
-		} elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
-			$this->set_id( $subscription_id );
-		} elseif ( ! empty( $subscription->id ) ) {
-			$this->set_id( $subscription->id );
-		} else {
-			$this->set_object_read( true );
-		}
-
-		// Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
-
-		if ( $this->get_id() > 0 ) {
-			$this->data_store->read( $this );
-		}
-
-	}
-
-	/**
-	 * Given an invoice id, profile id, transaction id, it returns the subscription's id.
-	 *
-	 *
-	 * @static
-	 * @param string $value
-	 * @param string $field Either invoice_id, transaction_id or profile_id.
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) {
+    /**
+     * Which data store to load.
+     *
+     * @var string
+     */
+    protected $data_store_name = 'subscription';
+
+    /**
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'subscription';
+
+    /**
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'customer_id'       => 0,
+        'frequency'         => 1,
+        'period'            => 'D',
+        'initial_amount'    => null,
+        'recurring_amount'  => null,
+        'bill_times'        => 0,
+        'transaction_id'    => '',
+        'parent_payment_id' => null,
+        'product_id'        => 0,
+        'created'           => '0000-00-00 00:00:00',
+        'expiration'        => '0000-00-00 00:00:00',
+        'trial_period'      => '',
+        'status'            => 'pending',
+        'profile_id'        => '',
+        'gateway'           => '',
+        'customer'          => '',
+    );
+
+    /**
+     * Stores the status transition information.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $status_transition = false;
+
+    /**
+     * Get the subscription if ID is passed, otherwise the subscription is new and empty.
+     *
+     * @param  int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read.
+     * @param  bool $deprecated
+     */
+    function __construct( $subscription = 0, $deprecated = false ) {
+
+        parent::__construct( $subscription );
+
+        if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) {
+            $this->set_id( $subscription );
+        } elseif ( $subscription instanceof self ) {
+            $this->set_id( $subscription->get_id() );
+        } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
+            $this->set_id( $subscription_id );
+        } elseif ( ! empty( $subscription->id ) ) {
+            $this->set_id( $subscription->id );
+        } else {
+            $this->set_object_read( true );
+        }
+
+        // Load the datastore.
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+
+        if ( $this->get_id() > 0 ) {
+            $this->data_store->read( $this );
+        }
+
+    }
+
+    /**
+     * Given an invoice id, profile id, transaction id, it returns the subscription's id.
+     *
+     *
+     * @static
+     * @param string $value
+     * @param string $field Either invoice_id, transaction_id or profile_id.
+     * @since 1.0.19
+     * @return int
+     */
+    public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) {
         global $wpdb;
 
-		// Trim the value.
-		$value = trim( $value );
+        // Trim the value.
+        $value = trim( $value );
 
-		if ( empty( $value ) ) {
-			return 0;
-		}
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
-		if ( 'invoice_id' == $field ) {
-			$field = 'parent_payment_id';
-		}
+        if ( 'invoice_id' == $field ) {
+            $field = 'parent_payment_id';
+        }
 
         // Valid fields.
         $fields = array(
-			'parent_payment_id',
-			'transaction_id',
-			'profile_id'
-		);
-
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		// Maybe retrieve from the cache.
-		$subscription_id   = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" );
-		if ( ! empty( $subscription_id ) ) {
-			return $subscription_id;
-		}
+            'parent_payment_id',
+            'transaction_id',
+            'profile_id'
+        );
+
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        // Maybe retrieve from the cache.
+        $subscription_id   = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" );
+        if ( ! empty( $subscription_id ) ) {
+            return $subscription_id;
+        }
 
         // Fetch from the db.
         $table            = $wpdb->prefix . 'wpinv_subscriptions';
@@ -141,34 +141,34 @@ 
             $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value )
         );
 
-		if ( empty( $subscription_id ) ) {
-			return 0;
-		}
+        if ( empty( $subscription_id ) ) {
+            return 0;
+        }
 
-		// Update the cache with our data.
-		wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" );
+        // Update the cache with our data.
+        wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" );
 
-		return $subscription_id;
-	}
+        return $subscription_id;
+    }
 
-	/**
+    /**
      * Clears the subscription's cache.
      */
     public function clear_cache() {
-		wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' );
-	}
+        wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' );
+    }
 
-	/**
+    /**
      * Checks if a subscription key is set.
      */
     public function _isset( $key ) {
         return isset( $this->data[$key] ) || method_exists( $this, "get_$key" );
-	}
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD methods
 	|--------------------------------------------------------------------------
@@ -177,545 +177,545 @@ 
 	|
     */
 
-	/*
-	|--------------------------------------------------------------------------
-	| Getters
-	|--------------------------------------------------------------------------
-	*/
+    /*
+	|--------------------------------------------------------------------------
+	| Getters
+	|--------------------------------------------------------------------------
+	*/
+
+    /**
+     * Get customer id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'customer_id', $context );
+    }
+
+    /**
+     * Get customer information.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WP_User|false WP_User object on success, false on failure.
+     */
+    public function get_customer( $context = 'view' ) {
+        return get_userdata( $this->get_customer_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_invoice_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_payment_id', $context );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_original_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Get parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_invoice( $context = 'view' ) {
+        return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_payment( $context = 'view' ) {
+        return $this->get_parent_invoice( $context );
+    }
+
+    /**
+     * Get subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_product_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'product_id', $context );
+    }
+
+    /**
+     * Get the subscription product.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Item
+     */
+    public function get_product( $context = 'view' ) {
+        return new WPInv_Item( $this->get_product_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice's gateway.
+     *
+     * Here for backwards compatibility.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gateway( $context = 'view' ) {
+        return $this->get_parent_invoice( $context )->get_gateway();
+    }
+
+    /**
+     * Get the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_period( $context = 'view' ) {
+        return $this->get_prop( 'period', $context );
+    }
+
+    /**
+     * Get number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_frequency( $context = 'view' ) {
+        return (int) $this->get_prop( 'frequency', $context );
+    }
+
+    /**
+     * Get the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
+    }
+
+    /**
+     * Get the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
+    }
+
+    /**
+     * Get number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_bill_times( $context = 'view' ) {
+        return (int) $this->get_prop( 'bill_times', $context );
+    }
+
+    /**
+     * Get transaction id of this subscription's parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_transaction_id( $context = 'view' ) {
+        return $this->get_prop( 'transaction_id', $context );
+    }
+
+    /**
+     * Get the date that the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_created( $context = 'view' ) {
+        return $this->get_prop( 'created', $context );
+    }
+
+    /**
+     * Alias for self::get_created().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_created( $context );
+    }
+
+    /**
+     * Retrieves the creation date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_time_created() {
+        $created = $this->get_date_created();
+        return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get GMT date when the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
+        $date = $this->get_date_created( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date( $context = 'view' ) {
+        return $this->get_prop( 'expiration', $context );
+    }
+
+    /**
+     * Alias for self::get_next_renewal_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration( $context = 'view' ) {
+        return $this->get_next_renewal_date( $context );
+    }
+
+    /**
+     * Retrieves the expiration date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_expiration_time() {
+        $expiration = $this->get_expiration();
+
+        if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
+            return current_time( 'timestamp' );
+        }
+
+        $expiration = strtotime( $expiration, current_time( 'timestamp' ) );
+        return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
+    }
+
+    /**
+     * Get GMT date when the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date_gmt( $context = 'view' ) {
+        $date = $this->get_next_renewal_date( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_trial_period( $context = 'view' ) {
+        return $this->get_prop( 'trial_period', $context );
+    }
+
+    /**
+     * Get the subscription's status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
+    }
+
+    /**
+     * Get the subscription's profile id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_profile_id( $context = 'view' ) {
+        return $this->get_prop( 'profile_id', $context );
+    }
+
+    /*
+	|--------------------------------------------------------------------------
+	| Setters
+	|--------------------------------------------------------------------------
+	*/
+
+    /**
+     * Set customer id.
+     *
+     * @since 1.0.19
+     * @param  int $value The customer's id.
+     */
+    public function set_customer_id( $value ) {
+        $this->set_prop( 'customer_id', (int) $value );
+    }
+
+    /**
+     * Set parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_invoice_id( $value ) {
+        $this->set_prop( 'parent_payment_id', (int) $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_original_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Set subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription product id.
+     */
+    public function set_product_id( $value ) {
+        $this->set_prop( 'product_id', (int) $value );
+    }
+
+    /**
+     * Set the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $value The renewal period.
+     */
+    public function set_period( $value ) {
+        $this->set_prop( 'period', $value );
+    }
+
+    /**
+     * Set number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription frequency.
+     */
+    public function set_frequency( $value ) {
+        $value = empty( $value ) ? 1 : (int) $value;
+        $this->set_prop( 'frequency', absint( $value ) );
+    }
+
+    /**
+     * Set the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The initial subcription amount.
+     */
+    public function set_initial_amount( $value ) {
+        $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The recurring subcription amount.
+     */
+    public function set_recurring_amount( $value ) {
+        $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  int $value Bill times.
+     */
+    public function set_bill_times( $value ) {
+        $this->set_prop( 'bill_times', (int) $value );
+    }
+
+    /**
+     * Get transaction id of this subscription's parent invoice.
+     *
+     * @since 1.0.19
+     * @param string $value Bill times.
+     */
+    public function set_transaction_id( $value ) {
+        $this->set_prop( 'transaction_id', sanitize_text_field( $value ) );
+    }
+
+    /**
+     * Set date when this subscription started.
+     *
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
+     */
+    public function set_created( $value ) {
+        $date = strtotime( $value );
+
+        if ( $date && $value !== '0000-00-00 00:00:00' ) {
+            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+            return;
+        }
+
+        $this->set_prop( 'created', '' );
 
-	/**
-	 * Get customer id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'customer_id', $context );
-	}
-
-	/**
-	 * Get customer information.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WP_User|false WP_User object on success, false on failure.
-	 */
-	public function get_customer( $context = 'view' ) {
-		return get_userdata( $this->get_customer_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_invoice_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_payment_id', $context );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice_id().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-    public function get_parent_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
-	}
+    }
 
-	/**
-     * Alias for self::get_parent_invoice_id().
+    /**
+     * Alias for self::set_created().
      *
-     * @since  1.0.0
-     * @return int
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
      */
-    public function get_original_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
+    public function set_date_created( $value ) {
+        $this->set_created( $value );
     }
 
-	/**
-	 * Get parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-	public function get_parent_invoice( $context = 'view' ) {
-		return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-    public function get_parent_payment( $context = 'view' ) {
-        return $this->get_parent_invoice( $context );
-	}
-
-	/**
-	 * Get subscription's product id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_product_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'product_id', $context );
-	}
-
-	/**
-	 * Get the subscription product.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Item
-	 */
-	public function get_product( $context = 'view' ) {
-		return new WPInv_Item( $this->get_product_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice's gateway.
-	 *
-	 * Here for backwards compatibility.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gateway( $context = 'view' ) {
-		return $this->get_parent_invoice( $context )->get_gateway();
-	}
-
-	/**
-	 * Get the period of a renewal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_period( $context = 'view' ) {
-		return $this->get_prop( 'period', $context );
-	}
-
-	/**
-	 * Get number of periods each renewal is valid for.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_frequency( $context = 'view' ) {
-		return (int) $this->get_prop( 'frequency', $context );
-	}
-
-	/**
-	 * Get the initial amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
-	}
-
-	/**
-	 * Get the recurring amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
-	}
-
-	/**
-	 * Get number of times that this subscription can be renewed.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_bill_times( $context = 'view' ) {
-		return (int) $this->get_prop( 'bill_times', $context );
-	}
-
-	/**
-	 * Get transaction id of this subscription's parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_transaction_id( $context = 'view' ) {
-		return $this->get_prop( 'transaction_id', $context );
-	}
-
-	/**
-	 * Get the date that the subscription was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_created( $context = 'view' ) {
-		return $this->get_prop( 'created', $context );
-	}
-
-	/**
-	 * Alias for self::get_created().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_created( $context );
-	}
-
-	/**
-	 * Retrieves the creation date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_time_created() {
-		$created = $this->get_date_created();
-		return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
-	}
-
-	/**
-	 * Get GMT date when the subscription was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
-        $date = $this->get_date_created( $context );
+    /**
+     * Set the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
+     */
+    public function set_next_renewal_date( $value ) {
+        $date = strtotime( $value );
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
+        if ( $date && $value !== '0000-00-00 00:00:00' ) {
+            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
+            return;
         }
-		return $date;
-	}
-
-	/**
-	 * Get the date that the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_next_renewal_date( $context = 'view' ) {
-		return $this->get_prop( 'expiration', $context );
-	}
-
-	/**
-	 * Alias for self::get_next_renewal_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_expiration( $context = 'view' ) {
-		return $this->get_next_renewal_date( $context );
-	}
-
-	/**
-	 * Retrieves the expiration date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_expiration_time() {
-		$expiration = $this->get_expiration();
-
-		if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
-			return current_time( 'timestamp' );
-		}
-
-		$expiration = strtotime( $expiration, current_time( 'timestamp' ) );
-		return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
-	}
-
-	/**
-	 * Get GMT date when the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_next_renewal_date_gmt( $context = 'view' ) {
-        $date = $this->get_next_renewal_date( $context );
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
-        }
-		return $date;
-	}
-
-	/**
-	 * Get the subscription's trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_trial_period( $context = 'view' ) {
-		return $this->get_prop( 'trial_period', $context );
-	}
-
-	/**
-	 * Get the subscription's status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
-	}
-
-	/**
-	 * Get the subscription's profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_profile_id( $context = 'view' ) {
-		return $this->get_prop( 'profile_id', $context );
-	}
-
-	/*
-	|--------------------------------------------------------------------------
-	| Setters
-	|--------------------------------------------------------------------------
-	*/
+        $this->set_prop( 'expiration', '' );
 
-	/**
-	 * Set customer id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The customer's id.
-	 */
-	public function set_customer_id( $value ) {
-		$this->set_prop( 'customer_id', (int) $value );
-	}
-
-	/**
-	 * Set parent invoice id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The parent invoice id.
-	 */
-	public function set_parent_invoice_id( $value ) {
-		$this->set_prop( 'parent_payment_id', (int) $value );
-	}
-
-	/**
-	 * Alias for self::set_parent_invoice_id().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The parent invoice id.
-	 */
-    public function set_parent_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
-	}
+    }
 
-	/**
-     * Alias for self::set_parent_invoice_id().
+    /**
+     * Alias for self::set_next_renewal_date().
      *
      * @since 1.0.19
-	 * @param  int $value The parent invoice id.
+     * @param string $value strtotime compliant date.
      */
-    public function set_original_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
-	}
-
-	/**
-	 * Set subscription's product id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The subscription product id.
-	 */
-	public function set_product_id( $value ) {
-		$this->set_prop( 'product_id', (int) $value );
-	}
-
-	/**
-	 * Set the period of a renewal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value The renewal period.
-	 */
-	public function set_period( $value ) {
-		$this->set_prop( 'period', $value );
-	}
-
-	/**
-	 * Set number of periods each renewal is valid for.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The subscription frequency.
-	 */
-	public function set_frequency( $value ) {
-		$value = empty( $value ) ? 1 : (int) $value;
-		$this->set_prop( 'frequency', absint( $value ) );
-	}
-
-	/**
-	 * Set the initial amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value The initial subcription amount.
-	 */
-	public function set_initial_amount( $value ) {
-		$this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Set the recurring amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value The recurring subcription amount.
-	 */
-	public function set_recurring_amount( $value ) {
-		$this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Set number of times that this subscription can be renewed.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value Bill times.
-	 */
-	public function set_bill_times( $value ) {
-		$this->set_prop( 'bill_times', (int) $value );
-	}
-
-	/**
-	 * Get transaction id of this subscription's parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Bill times.
-	 */
-	public function set_transaction_id( $value ) {
-		$this->set_prop( 'transaction_id', sanitize_text_field( $value ) );
-	}
-
-	/**
-	 * Set date when this subscription started.
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_created( $value ) {
-        $date = strtotime( $value );
+    public function set_expiration( $value ) {
+        $this->set_next_renewal_date( $value );
+    }
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+    /**
+     * Set the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param string $value trial period e.g 1 year.
+     */
+    public function set_trial_period( $value ) {
+        $this->set_prop( 'trial_period', $value );
+    }
+
+    /**
+     * Set the subscription's status.
+     *
+     * @since 1.0.19
+     * @param string $new_status    New subscription status.
+     */
+    public function set_status( $new_status ) {
+
+        // Abort if this is not a valid status;
+        if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) {
             return;
         }
 
-		$this->set_prop( 'created', '' );
+        $old_status = $this->get_status();
+        $this->set_prop( 'status', $new_status );
 
-	}
+        if ( true === $this->object_read && $old_status !== $new_status ) {
+            $this->status_transition = array(
+                'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
+                'to'     => $new_status,
+            );
+        }
 
-	/**
-	 * Alias for self::set_created().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_date_created( $value ) {
-		$this->set_created( $value );
     }
 
-	/**
-	 * Set the date that the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_next_renewal_date( $value ) {
-		$date = strtotime( $value );
+    /**
+     * Set the subscription's (remote) profile id.
+     *
+     * @since 1.0.19
+     * @param  string $value the remote profile id.
+     */
+    public function set_profile_id( $value ) {
+        $this->set_prop( 'profile_id', sanitize_text_field( $value ) );
+    }
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
-            return;
-		}
-
-		$this->set_prop( 'expiration', '' );
-
-	}
-
-	/**
-	 * Alias for self::set_next_renewal_date().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_expiration( $value ) {
-		$this->set_next_renewal_date( $value );
-    }
-
-	/**
-	 * Set the subscription's trial period.
-	 *
-	 * @since 1.0.19
-	 * @param string $value trial period e.g 1 year.
-	 */
-	public function set_trial_period( $value ) {
-		$this->set_prop( 'trial_period', $value );
-	}
-
-	/**
-	 * Set the subscription's status.
-	 *
-	 * @since 1.0.19
-	 * @param string $new_status    New subscription status.
-	 */
-	public function set_status( $new_status ) {
-
-		// Abort if this is not a valid status;
-		if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) {
-			return;
-		}
-
-		$old_status = $this->get_status();
-		$this->set_prop( 'status', $new_status );
-
-		if ( true === $this->object_read && $old_status !== $new_status ) {
-			$this->status_transition = array(
-				'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
-				'to'     => $new_status,
-			);
-		}
-
-	}
-
-	/**
-	 * Set the subscription's (remote) profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value the remote profile id.
-	 */
-	public function set_profile_id( $value ) {
-		$this->set_prop( 'profile_id', sanitize_text_field( $value ) );
-	}
-
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Boolean methods
 	|--------------------------------------------------------------------------
@@ -724,55 +724,55 @@ 
 	|
 	*/
 
-	/**
+    /**
      * Checks if the subscription has a given status.
-	 *
-	 * @param string|array String or array of strings to check for.
-	 * @return bool
+     *
+     * @param string|array String or array of strings to check for.
+     * @return bool
      */
     public function has_status( $status ) {
         return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) );
-	}
+    }
 
-	/**
+    /**
      * Checks if the subscription has a trial period.
-	 *
-	 * @return bool
+     *
+     * @return bool
      */
     public function has_trial_period() {
-		$period = $this->get_trial_period();
+        $period = $this->get_trial_period();
         return ! empty( $period );
-	}
-
-	/**
-	 * Is the subscription active?
-	 *
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->has_status( 'active trialling' ) && ! $this->is_expired();
-	}
-
-	/**
-	 * Is the subscription expired?
-	 *
-	 * @return bool
-	 */
-	public function is_expired() {
-		return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
-	}
-
-	/**
-	 * Is this the last renewals?
-	 *
-	 * @return bool
-	 */
-	public function is_last_renewal() {
-		$max_bills = $this->get_bill_times();
-		return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
-	}
-
-	/*
+    }
+
+    /**
+     * Is the subscription active?
+     *
+     * @return bool
+     */
+    public function is_active() {
+        return $this->has_status( 'active trialling' ) && ! $this->is_expired();
+    }
+
+    /**
+     * Is the subscription expired?
+     *
+     * @return bool
+     */
+    public function is_expired() {
+        return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
+    }
+
+    /**
+     * Is this the last renewals?
+     *
+     * @return bool
+     */
+    public function is_last_renewal() {
+        $max_bills = $this->get_bill_times();
+        return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional methods
 	|--------------------------------------------------------------------------
@@ -781,27 +781,27 @@ 
 	|
 	*/
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function create( $data = array() ) {
+    /**
+     * Backwards compatibilty.
+     */
+    public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
-	}
+    }
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function update( $args = array() ) {
-		return $this->create( $args );
-	}
+    /**
+     * Backwards compatibilty.
+     */
+    public function update( $args = array() ) {
+        return $this->create( $args );
+    }
 
     /**
      * Retrieve renewal payments for a subscription
@@ -811,22 +811,22 @@ 
      */
     public function get_child_payments( $hide_pending = true ) {
 
-		$statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
+        $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
 
-		if ( ! $hide_pending ) {
-			$statuses = array_keys( wpinv_get_invoice_statuses() );
-		}
+        if ( ! $hide_pending ) {
+            $statuses = array_keys( wpinv_get_invoice_statuses() );
+        }
 
         return get_posts(
-			array(
-            	'post_parent'    => $this->get_parent_payment_id(),
-            	'numberposts'    => -1,
-            	'post_status'    => $statuses,
-            	'orderby'        => 'ID',
-            	'order'          => 'ASC',
-            	'post_type'      => 'wpi_invoice'
-			)
-		);
+            array(
+                'post_parent'    => $this->get_parent_payment_id(),
+                'numberposts'    => -1,
+                'post_status'    => $statuses,
+                'orderby'        => 'ID',
+                'order'          => 'ASC',
+                'post_type'      => 'wpi_invoice'
+            )
+        );
     }
 
     /**
@@ -836,7 +836,7 @@ 
      * @return int
      */
     public function get_total_payments() {
-		return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
+        return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
     }
 
     /**
@@ -860,57 +860,57 @@ 
      *
      * @since  2.4
      * @param  array $args Array of values for the payment, including amount and transaction ID
-	 * @param  WPInv_Invoice $invoice If adding an existing invoice.
+     * @param  WPInv_Invoice $invoice If adding an existing invoice.
      * @return bool
      */
     public function add_payment( $args = array(), $invoice = false ) {
 
-		// Process each payment once.
+        // Process each payment once.
         if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
             return false;
         }
 
-		// Are we creating a new invoice?
-		if ( empty( $invoice ) ) {
-			$invoice = $this->create_payment();
+        // Are we creating a new invoice?
+        if ( empty( $invoice ) ) {
+            $invoice = $this->create_payment();
 
-			if ( empty( $invoice ) ) {
-				return false;
-			}
+            if ( empty( $invoice ) ) {
+                return false;
+            }
 
-		}
+        }
 
-		$invoice->set_status( 'wpi-renewal' );
+        $invoice->set_status( 'wpi-renewal' );
 
-		// Maybe set a transaction id.
-		if ( ! empty( $args['transaction_id'] ) ) {
-			$invoice->set_transaction_id( $args['transaction_id'] );
-		}
+        // Maybe set a transaction id.
+        if ( ! empty( $args['transaction_id'] ) ) {
+            $invoice->set_transaction_id( $args['transaction_id'] );
+        }
 
-		// Set the completed date.
-		$invoice->set_completed_date( current_time( 'mysql' ) );
+        // Set the completed date.
+        $invoice->set_completed_date( current_time( 'mysql' ) );
 
-		// And the gateway.
-		if ( ! empty( $args['gateway'] ) ) {
-			$invoice->set_gateway( $args['gateway'] );
-		}
+        // And the gateway.
+        if ( ! empty( $args['gateway'] ) ) {
+            $invoice->set_gateway( $args['gateway'] );
+        }
 
-		$invoice->save();
+        $invoice->save();
 
-		if ( ! $invoice->exists() ) {
-			return false;
-		}
+        if ( ! $invoice->exists() ) {
+            return false;
+        }
 
-		do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
-		do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
+        do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
+        do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
         do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() );
 
         update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id );
 
         return $invoice->get_id();
-	}
+    }
 
-	/**
+    /**
      * Creates a new invoice and returns it.
      *
      * @since  1.0.19
@@ -918,124 +918,124 @@ 
      */
     public function create_payment() {
 
-		$parent_invoice = $this->get_parent_payment();
-
-		if ( ! $parent_invoice->exists() ) {
-			return false;
-		}
-
-		// Duplicate the parent invoice.
-		$invoice = getpaid_duplicate_invoice( $parent_invoice );
-		$invoice->set_parent_id( $parent_invoice->get_id() );
-		$invoice->set_subscription_id( $this->get_id() );
-		$invoice->set_remote_subscription_id( $this->get_profile_id() );
-
-		// Set invoice items.
-		$subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() );
-		$allowed_items      = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] );
-		$invoice_items      = array();
-
-		foreach ( $invoice->get_items() as $item ) {
-			if ( in_array( $item->get_id(), $allowed_items ) ) {
-				$invoice_items[] = $item;
-			}
-		}
-
-		$invoice->set_items( $invoice_items );
-
-		if ( ! empty( $subscription_group['fees'] ) ) {
-			$invoice->set_fees( $subscription_group['fees'] );
-		}
-
-		// Maybe recalculate discount (Pre-GetPaid Fix).
-		$discount = new WPInv_Discount( $invoice->get_discount_code() );
-		if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) {
-			$invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
-		}
-
-		$invoice->recalculate_total();
-		$invoice->set_status( 'wpi-pending' );
-		$invoice->save();
-
-		return $invoice->exists() ? $invoice : false;
-    }
-
-	/**
-	 * Renews or completes a subscription
-	 *
-	 * @since  1.0.0
-	 * @return int The subscription's id
-	 */
-	public function renew() {
-
-		// Complete subscription if applicable
-		if ( $this->is_last_renewal() ) {
-			return $this->complete();
-		}
-
-		// Calculate new expiration
-		$frequency      = $this->get_frequency();
-		$period         = $this->get_period();
-		$new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() );
-
-		$this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) );
-		$this->set_status( 'active' );
-		$this->save();
-
-		do_action( 'getpaid_subscription_renewed', $this );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Marks a subscription as completed
-	 *
-	 * Subscription is completed when the number of payments matches the billing_times field
-	 *
-	 * @since  1.0.0
-	 * @return int|bool Subscription id or false if the subscription is cancelled.
-	 */
-	public function complete() {
-
-		// Only mark a subscription as complete if it's not already cancelled.
-		if ( $this->has_status( 'cancelled' ) ) {
-			return false;
-		}
-
-		$this->set_status( 'completed' );
-		return $this->save();
-
-	}
-
-	/**
-	 * Marks a subscription as expired
-	 *
-	 * @since  1.0.0
-	 * @param  bool $check_expiration
-	 * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future.
-	 */
-	public function expire( $check_expiration = false ) {
-
-		if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) {
-			// Do not mark as expired since real expiration date is in the future
-			return false;
-		}
-
-		$this->set_status( 'expired' );
-		return $this->save();
-
-	}
-
-	/**
-	 * Marks a subscription as failing
-	 *
-	 * @since  2.4.2
-	 * @return int Subscription id.
-	 */
-	public function failing() {
-		$this->set_status( 'failing' );
-		return $this->save();
-	}
+        $parent_invoice = $this->get_parent_payment();
+
+        if ( ! $parent_invoice->exists() ) {
+            return false;
+        }
+
+        // Duplicate the parent invoice.
+        $invoice = getpaid_duplicate_invoice( $parent_invoice );
+        $invoice->set_parent_id( $parent_invoice->get_id() );
+        $invoice->set_subscription_id( $this->get_id() );
+        $invoice->set_remote_subscription_id( $this->get_profile_id() );
+
+        // Set invoice items.
+        $subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() );
+        $allowed_items      = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] );
+        $invoice_items      = array();
+
+        foreach ( $invoice->get_items() as $item ) {
+            if ( in_array( $item->get_id(), $allowed_items ) ) {
+                $invoice_items[] = $item;
+            }
+        }
+
+        $invoice->set_items( $invoice_items );
+
+        if ( ! empty( $subscription_group['fees'] ) ) {
+            $invoice->set_fees( $subscription_group['fees'] );
+        }
+
+        // Maybe recalculate discount (Pre-GetPaid Fix).
+        $discount = new WPInv_Discount( $invoice->get_discount_code() );
+        if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) {
+            $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
+        }
+
+        $invoice->recalculate_total();
+        $invoice->set_status( 'wpi-pending' );
+        $invoice->save();
+
+        return $invoice->exists() ? $invoice : false;
+    }
+
+    /**
+     * Renews or completes a subscription
+     *
+     * @since  1.0.0
+     * @return int The subscription's id
+     */
+    public function renew() {
+
+        // Complete subscription if applicable
+        if ( $this->is_last_renewal() ) {
+            return $this->complete();
+        }
+
+        // Calculate new expiration
+        $frequency      = $this->get_frequency();
+        $period         = $this->get_period();
+        $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() );
+
+        $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) );
+        $this->set_status( 'active' );
+        $this->save();
+
+        do_action( 'getpaid_subscription_renewed', $this );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Marks a subscription as completed
+     *
+     * Subscription is completed when the number of payments matches the billing_times field
+     *
+     * @since  1.0.0
+     * @return int|bool Subscription id or false if the subscription is cancelled.
+     */
+    public function complete() {
+
+        // Only mark a subscription as complete if it's not already cancelled.
+        if ( $this->has_status( 'cancelled' ) ) {
+            return false;
+        }
+
+        $this->set_status( 'completed' );
+        return $this->save();
+
+    }
+
+    /**
+     * Marks a subscription as expired
+     *
+     * @since  1.0.0
+     * @param  bool $check_expiration
+     * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future.
+     */
+    public function expire( $check_expiration = false ) {
+
+        if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) {
+            // Do not mark as expired since real expiration date is in the future
+            return false;
+        }
+
+        $this->set_status( 'expired' );
+        return $this->save();
+
+    }
+
+    /**
+     * Marks a subscription as failing
+     *
+     * @since  2.4.2
+     * @return int Subscription id.
+     */
+    public function failing() {
+        $this->set_status( 'failing' );
+        return $this->save();
+    }
 
     /**
      * Marks a subscription as cancelled
@@ -1044,19 +1044,19 @@ 
      * @return int Subscription id.
      */
     public function cancel() {
-		$this->set_status( 'cancelled' );
-		return $this->save();
+        $this->set_status( 'cancelled' );
+        return $this->save();
     }
 
-	/**
-	 * Determines if a subscription can be cancelled both locally and with a payment processor.
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_cancel() {
-		return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this );
-	}
+    /**
+     * Determines if a subscription can be cancelled both locally and with a payment processor.
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_cancel() {
+        return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this );
+    }
 
     /**
      * Returns an array of subscription statuses that can be cancelled
@@ -1069,96 +1069,96 @@ 
         return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
     }
 
-	/**
-	 * Retrieves the URL to cancel subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_cancel_url() {
-		$url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
-		return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the URL to view a subscription
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_view_url() {
-
-		$url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
-		$url = add_query_arg( 'subscription', $this->get_id(), $url );
-
-		return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can be manually renewed
-	 *
-	 * This method is filtered by payment gateways in order to return true on subscriptions
-	 * that can be renewed manually
-	 *
-	 * @since  2.5
-	 * @return bool
-	 */
-	public function can_renew() {
-		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
-	}
-
-	/**
-	 * Retrieves the URL to renew a subscription
-	 *
-	 * @since  2.5
-	 * @return string
-	 */
-	public function get_renew_url() {
-		$url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' );
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can have their payment method updated
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
-	}
-
-	/**
-	 * Retrieves the URL to update subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_update_url() {
-		$url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the subscription status label
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_status_label() {
-		return getpaid_get_subscription_status_label( $this->get_status() );
-	}
-
-	/**
-	 * Retrieves the subscription status class
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_status_class() {
-		$statuses = getpaid_get_subscription_status_classes();
-		return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
-	}
+    /**
+     * Retrieves the URL to cancel subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_cancel_url() {
+        $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
+        return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the URL to view a subscription
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_view_url() {
+
+        $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
+        $url = add_query_arg( 'subscription', $this->get_id(), $url );
+
+        return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can be manually renewed
+     *
+     * This method is filtered by payment gateways in order to return true on subscriptions
+     * that can be renewed manually
+     *
+     * @since  2.5
+     * @return bool
+     */
+    public function can_renew() {
+        return apply_filters( 'wpinv_subscription_can_renew', true, $this );
+    }
+
+    /**
+     * Retrieves the URL to renew a subscription
+     *
+     * @since  2.5
+     * @return string
+     */
+    public function get_renew_url() {
+        $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' );
+        return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can have their payment method updated
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_update() {
+        return apply_filters( 'wpinv_subscription_can_update', false, $this );
+    }
+
+    /**
+     * Retrieves the URL to update subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_update_url() {
+        $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
+        return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the subscription status label
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_status_label() {
+        return getpaid_get_subscription_status_label( $this->get_status() );
+    }
+
+    /**
+     * Retrieves the subscription status class
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_status_class() {
+        $statuses = getpaid_get_subscription_status_classes();
+        return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
+    }
 
     /**
      * Retrieves the subscription status label
@@ -1168,11 +1168,11 @@ 
      */
     public function get_status_label_html() {
 
-		$status_label = sanitize_text_field( $this->get_status_label() );
-		$class        = esc_attr( $this->get_status_class() );
-		$status       = sanitize_html_class( $this->get_status() );
+        $status_label = sanitize_text_field( $this->get_status_label() );
+        $class        = esc_attr( $this->get_status_class() );
+        $status       = sanitize_html_class( $this->get_status() );
 
-		return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>";
+        return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>";
     }
 
     /**
@@ -1183,75 +1183,75 @@ 
      * @return bool
      */
     public function payment_exists( $txn_id = '' ) {
-		$invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
+        $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
         return ! empty( $invoice_id );
-	}
-
-	/**
-	 * Handle the status transition.
-	 */
-	protected function status_transition() {
-		$status_transition = $this->status_transition;
-
-		// Reset status transition variable.
-		$this->status_transition = false;
-
-		if ( $status_transition ) {
-			try {
-
-				// Fire a hook for the status change.
-				do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
-				do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition );
-
-				if ( ! empty( $status_transition['from'] ) ) {
-
-					/* translators: 1: old subscription status 2: new subscription status */
-					$transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
-
-					// Note the transition occurred.
-					$this->get_parent_payment()->add_note( $transition_note, false, false, true );
-
-					// Fire another hook.
-					do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
-					do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] );
-
-				} else {
-					/* translators: %s: new invoice status */
-					$transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
-
-					// Note the transition occurred.
-					$this->get_parent_payment()->add_note( $transition_note, false, false, true );
-
-				}
-			} catch ( Exception $e ) {
-				$this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
-			}
-		}
-
-	}
-
-	/**
-	 * Save data to the database.
-	 *
-	 * @since 1.0.19
-	 * @return int subscription ID
-	 */
-	public function save() {
-		parent::save();
-		$this->status_transition();
-		return $this->get_id();
-	}
-
-	/**
-	 * Activates a subscription.
-	 *
-	 * @since 1.0.19
-	 * @return int subscription ID
-	 */
-	public function activate() {
-		$status = 'trialling' == $this->get_status() ? 'trialling' : 'active';
-		$this->set_status( $status );
-		return $this->save();
-	}
+    }
+
+    /**
+     * Handle the status transition.
+     */
+    protected function status_transition() {
+        $status_transition = $this->status_transition;
+
+        // Reset status transition variable.
+        $this->status_transition = false;
+
+        if ( $status_transition ) {
+            try {
+
+                // Fire a hook for the status change.
+                do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
+                do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition );
+
+                if ( ! empty( $status_transition['from'] ) ) {
+
+                    /* translators: 1: old subscription status 2: new subscription status */
+                    $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
+
+                    // Note the transition occurred.
+                    $this->get_parent_payment()->add_note( $transition_note, false, false, true );
+
+                    // Fire another hook.
+                    do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
+                    do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] );
+
+                } else {
+                    /* translators: %s: new invoice status */
+                    $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
+
+                    // Note the transition occurred.
+                    $this->get_parent_payment()->add_note( $transition_note, false, false, true );
+
+                }
+            } catch ( Exception $e ) {
+                $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
+            }
+        }
+
+    }
+
+    /**
+     * Save data to the database.
+     *
+     * @since 1.0.19
+     * @return int subscription ID
+     */
+    public function save() {
+        parent::save();
+        $this->status_transition();
+        return $this->get_id();
+    }
+
+    /**
+     * Activates a subscription.
+     *
+     * @since 1.0.19
+     * @return int subscription ID
+     */
+    public function activate() {
+        $status = 'trialling' == $this->get_status() ? 'trialling' : 'active';
+        $this->set_status( $status );
+        return $this->save();
+    }
 
 }

includes/class-getpaid-notification-email-sender.php

Indentation +134 added lines, -134 removed lines

@@ -13,17 +13,17 @@ 
 class GetPaid_Notification_Email_Sender {
 
     /**
-	 * Whether or not we should inline CSS into the email.
-	 */
-	public $inline_css = true;
+     * Whether or not we should inline CSS into the email.
+     */
+    public $inline_css = true;
 
     /**
-	 * The wp_mail() data.
-	 */
+     * The wp_mail() data.
+     */
     public $wp_mail_data = null;
 
     /**
-	 * Sends a new email.
+     * Sends a new email.
      * 
      * @param string|array $to The recipients email or an array of recipient emails.
      * @param string $subject The email's subject.
@@ -31,49 +31,49 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	public function send( $to, $subject, $email, $attachments = array() ) {
+     */
+    public function send( $to, $subject, $email, $attachments = array() ) {
 
-		/*
+        /*
 		 * Allow to filter data on per-email basis.
 		 */
-		$data = apply_filters(
-			'getpaid_email_data',
-			array(
-				'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
-				'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
-				'email'       => apply_filters( 'wpinv_mail_content', $email ),
-				'headers'     => $this->get_headers(),
-				'attachments' => $attachments,
-			),
-			$this
-		);
+        $data = apply_filters(
+            'getpaid_email_data',
+            array(
+                'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
+                'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
+                'email'       => apply_filters( 'wpinv_mail_content', $email ),
+                'headers'     => $this->get_headers(),
+                'attachments' => $attachments,
+            ),
+            $this
+        );
 
         // Remove slashes.
         $data               = (array) wp_unslash( $data );
 
         // Cache it.
-		$this->wp_mail_data = $data;
+        $this->wp_mail_data = $data;
 
-		// Attach our own hooks.
-		$this->before_sending();
+        // Attach our own hooks.
+        $this->before_sending();
 
         $result = false;
 
         foreach ( $this->wp_mail_data['to'] as $to ) {
-			$result = $this->_send( $to, $data );
+            $result = $this->_send( $to, $data );
         }
 
-		// Remove our hooks.
-		$this->after_sending();		
+        // Remove our hooks.
+        $this->after_sending();		
 
-		$this->wp_mail_data = null;
+        $this->wp_mail_data = null;
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * Does the actual sending.
+    /**
+     * Does the actual sending.
      * 
      * @param string $to The recipient's email.
      * @param array $data The email's data.
@@ -81,81 +81,81 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	protected function _send( $to, $data ) {
-
-		// Prepare the sending function.
-		$sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
-
-		// Send the actual email.
-		$result = call_user_func(
-			$sending_function,
-			$to,
-			html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
-			$data['email'],
-			$data['headers'],
-			$data['attachments']
-		);
-
-		if ( ! $result ) {
-			$log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
-			wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
-		}
-
-		return $result;
-	}
+     */
+    protected function _send( $to, $data ) {
+
+        // Prepare the sending function.
+        $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
+
+        // Send the actual email.
+        $result = call_user_func(
+            $sending_function,
+            $to,
+            html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
+            $data['email'],
+            $data['headers'],
+            $data['attachments']
+        );
+
+        if ( ! $result ) {
+            $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
+            wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
+        }
+
+        return $result;
+    }
     
     /**
-	 * Retrieves email headers.
-	 */
-	public function get_headers() {
+     * Retrieves email headers.
+     */
+    public function get_headers() {
 
-		$name       = $this->get_from_name();
-		$reply_to   = $this->get_reply_to();
-		$headers    = array( "Reply-To:$name <$reply_to>" );
+        $name       = $this->get_from_name();
+        $reply_to   = $this->get_reply_to();
+        $headers    = array( "Reply-To:$name <$reply_to>" );
 
-		return apply_filters( 'getpaid_email_headers',  $headers, $this );
+        return apply_filters( 'getpaid_email_headers',  $headers, $this );
 
-	}
+    }
 
     /**
-	 * Fires before an email is sent
-	 *
-	 * @since 1.0.0
-	 */
-	public function before_sending() {
+     * Fires before an email is sent
+     *
+     * @since 1.0.0
+     */
+    public function before_sending() {
 
         do_action( 'getpaid_before_send_email', $this );
-		add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
+        add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
 
-	}
+    }
 
     /**
-	 * Returns the from name.
-	 */
-	public function get_from_name() {
+     * Returns the from name.
+     */
+    public function get_from_name() {
 
         $from_name = wpinv_get_option( 'email_from_name', get_bloginfo( 'name' ) );
 
-		if ( empty( $from_name ) ) {
-			$from_name =  get_bloginfo( 'name' );
+        if ( empty( $from_name ) ) {
+            $from_name =  get_bloginfo( 'name' );
         }
 
-		return wp_specialchars_decode( $from_name, ENT_QUOTES );
+        return wp_specialchars_decode( $from_name, ENT_QUOTES );
     }
 
     /**
-	 * Returns the from email.
-	 */
-	public function get_from_address() {
+     * Returns the from email.
+     */
+    public function get_from_address() {
 
         $from_address = wpinv_get_option( 'email_from', $this->default_from_address() );
 
-		if ( ! is_email( $from_address ) ) {
-			$from_address =  $this->default_from_address();
+        if ( ! is_email( $from_address ) ) {
+            $from_address =  $this->default_from_address();
         }
         
         return $from_address;
@@ -163,75 +163,75 @@ 
     }
 
     /**
-	 * The default emails from address.
-	 * 
-	 * Defaults to wordpress@$sitename
-	 * Some hosts will block outgoing mail from this address if it doesn't exist,
-	 * but there's no easy alternative. Defaulting to admin_email might appear to be
-	 * another option, but some hosts may refuse to relay mail from an unknown domain.
-	 *
-	 */
-	public function default_from_address() {
-
-		// Get the site domain and get rid of www.
-		$sitename = strtolower( $_SERVER['SERVER_NAME'] );
-		if ( substr( $sitename, 0, 4 ) == 'www.' ) {
-			$sitename = substr( $sitename, 4 );
-		}
-
-		$from_email = 'wordpress@' . $sitename;
-
-		return apply_filters( 'getpaid_default_from_address', $from_email );
+     * The default emails from address.
+     * 
+     * Defaults to wordpress@$sitename
+     * Some hosts will block outgoing mail from this address if it doesn't exist,
+     * but there's no easy alternative. Defaulting to admin_email might appear to be
+     * another option, but some hosts may refuse to relay mail from an unknown domain.
+     *
+     */
+    public function default_from_address() {
+
+        // Get the site domain and get rid of www.
+        $sitename = strtolower( $_SERVER['SERVER_NAME'] );
+        if ( substr( $sitename, 0, 4 ) == 'www.' ) {
+            $sitename = substr( $sitename, 4 );
+        }
+
+        $from_email = 'wordpress@' . $sitename;
+
+        return apply_filters( 'getpaid_default_from_address', $from_email );
 
     }
     
     /**
-	 * Get the email reply-to.
-	 *
-	 *
-	 * @return string The email reply-to address.
-	 */
-	public function get_reply_to() {
+     * Get the email reply-to.
+     *
+     *
+     * @return string The email reply-to address.
+     */
+    public function get_reply_to() {
 
-		$reply_to = wpinv_get_admin_email();
+        $reply_to = wpinv_get_admin_email();
 
-		if ( ! is_email( $reply_to ) ) {
-			$reply_to =  get_option( 'admin_email' );
-		}
+        if ( ! is_email( $reply_to ) ) {
+            $reply_to =  get_option( 'admin_email' );
+        }
 
-		return $reply_to;
+        return $reply_to;
     }
     
     /**
-	 * Get the email content type.
-	 *
-	 */
-	public function get_content_type() {
-		return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
+     * Get the email content type.
+     *
+     */
+    public function get_content_type() {
+        return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
     }
     
     /**
-	 * Ensures that our email messages are not messed up by template plugins.
-	 *
-	 * @return array wp_mail_data.
-	 */
-	public function ensure_email_content( $args ) {
-		$args['message'] = $this->wp_mail_data['email'];
-		return $args;
+     * Ensures that our email messages are not messed up by template plugins.
+     *
+     * @return array wp_mail_data.
+     */
+    public function ensure_email_content( $args ) {
+        $args['message'] = $this->wp_mail_data['email'];
+        return $args;
     }
     
     /**
-	 * A little house keeping after an email is sent.
-	 *
- 	 */
-	public function after_sending() {
+     * A little house keeping after an email is sent.
+     *
+     */
+    public function after_sending() {
 
         do_action( 'getpaid_after_send_email', $this->wp_mail_data );
-		remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
+        remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
 
-	}
+    }
 
 }

includes/admin/subscriptions.php

Indentation +429 added lines, -429 removed lines

@@ -14,7 +14,7 @@ 
  */
 function wpinv_subscriptions_page() {
 
-	?>
+    ?>
 
 	<div class="wrap">
 		<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
@@ -22,27 +22,27 @@ 
 
 			<?php
 
-				// Verify user permissions.
-				if ( ! wpinv_current_user_can_manage_invoicing() ) {
+                // Verify user permissions.
+                if ( ! wpinv_current_user_can_manage_invoicing() ) {
 
-					echo aui()->alert(
-						array(
-							'type'    => 'danger',
-							'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
-						)
-					);
+                    echo aui()->alert(
+                        array(
+                            'type'    => 'danger',
+                            'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
+                        )
+                    );
 
-				} else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
+                } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
 
-					// Display a single subscription.
-					wpinv_recurring_subscription_details();
-				} else {
+                    // Display a single subscription.
+                    wpinv_recurring_subscription_details();
+                } else {
 
-					// Display a list of available subscriptions.
-					getpaid_print_subscriptions_list();
-				}
+                    // Display a list of available subscriptions.
+                    getpaid_print_subscriptions_list();
+                }
 
-			?>
+            ?>
 
 		</div>
 	</div>
@@ -59,10 +59,10 @@ 
  */
 function getpaid_print_subscriptions_list() {
 
-	$subscribers_table = new WPInv_Subscriptions_List_Table();
-	$subscribers_table->prepare_items();
+    $subscribers_table = new WPInv_Subscriptions_List_Table();
+    $subscribers_table->prepare_items();
 
-	?>
+    ?>
 	<form id="subscribers-filter" class="bsui" method="get">
 		<input type="hidden" name="page" value="wpinv-subscriptions" />
 		<?php $subscribers_table->views(); ?>
@@ -80,41 +80,41 @@ 
  */
 function wpinv_recurring_subscription_details() {
 
-	// Fetch the subscription.
-	$sub = new WPInv_Subscription( (int) $_GET['id'] );
-	if ( ! $sub->exists() ) {
+    // Fetch the subscription.
+    $sub = new WPInv_Subscription( (int) $_GET['id'] );
+    if ( ! $sub->exists() ) {
 
-		echo aui()->alert(
-			array(
-				'type'    => 'danger',
-				'content' => __( 'Subscription not found.', 'invoicing' ),
-			)
-		);
+        echo aui()->alert(
+            array(
+                'type'    => 'danger',
+                'content' => __( 'Subscription not found.', 'invoicing' ),
+            )
+        );
 
-		return;
-	}
+        return;
+    }
 
-	// Use metaboxes to display the subscription details.
-	add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal', 'high' );
-	add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
+    // Use metaboxes to display the subscription details.
+    add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal', 'high' );
+    add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
 
-	$subscription_id     = $sub->get_id();
-	$subscription_groups = getpaid_get_invoice_subscription_groups( $sub->get_parent_invoice_id() );
-	$subscription_group  = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
+    $subscription_id     = $sub->get_id();
+    $subscription_groups = getpaid_get_invoice_subscription_groups( $sub->get_parent_invoice_id() );
+    $subscription_group  = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
 
-	if ( 1 < count( $subscription_groups ) ) {
-		add_meta_box( 'getpaid_admin_subscription_related_subscriptions_metabox', __( 'Related Subscriptions', 'invoicing' ), 'getpaid_admin_subscription_related_subscriptions_metabox', get_current_screen(), 'advanced' );
-	}
+    if ( 1 < count( $subscription_groups ) ) {
+        add_meta_box( 'getpaid_admin_subscription_related_subscriptions_metabox', __( 'Related Subscriptions', 'invoicing' ), 'getpaid_admin_subscription_related_subscriptions_metabox', get_current_screen(), 'advanced' );
+    }
 
-	if ( ! empty( $subscription_group ) ) {
-		add_meta_box( 'getpaid_admin_subscription_item_details_metabox', __( 'Subscription Items', 'invoicing' ), 'getpaid_admin_subscription_item_details_metabox', get_current_screen(), 'normal', 'low' );
-	}
+    if ( ! empty( $subscription_group ) ) {
+        add_meta_box( 'getpaid_admin_subscription_item_details_metabox', __( 'Subscription Items', 'invoicing' ), 'getpaid_admin_subscription_item_details_metabox', get_current_screen(), 'normal', 'low' );
+    }
 
-	add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Related Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
+    add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Related Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
 
-	do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
+    do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
 
-	?>
+    ?>
 
 		<form method="post" action="<?php echo admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $sub->get_id() ) ); ?>">
 
@@ -154,45 +154,45 @@ 
  */
 function getpaid_admin_subscription_details_metabox( $sub ) {
 
-	// Subscription items.
-	$subscription_group = getpaid_get_invoice_subscription_group( $sub->get_parent_invoice_id(), $sub->get_id() );
-	$items_count        = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] );
-
-	// Prepare subscription detail columns.
-	$fields = apply_filters(
-		'getpaid_subscription_admin_page_fields',
-		array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'customer'       => __( 'Customer', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'start_date'     => __( 'Start Date', 'invoicing' ),
-			'renews_on'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'       => __( 'Payments', 'invoicing' ),
-			'item'           => _n( 'Item', 'Items', $items_count,  'invoicing' ),
-			'gateway'        => __( 'Payment Method', 'invoicing' ),
-			'profile_id'     => __( 'Profile ID', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		)
-	);
-
-	if ( ! $sub->is_active() ) {
-
-		if ( isset( $fields['renews_on'] ) ) {
-			unset( $fields['renews_on'] );
-		}
-
-		if ( isset( $fields['gateway'] ) ) {
-			unset( $fields['gateway'] );
-		}
-
-	}
-
-	$profile_id = $sub->get_profile_id();
-	if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
-		unset( $fields['profile_id'] );
-	}
-
-	?>
+    // Subscription items.
+    $subscription_group = getpaid_get_invoice_subscription_group( $sub->get_parent_invoice_id(), $sub->get_id() );
+    $items_count        = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] );
+
+    // Prepare subscription detail columns.
+    $fields = apply_filters(
+        'getpaid_subscription_admin_page_fields',
+        array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'customer'       => __( 'Customer', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'start_date'     => __( 'Start Date', 'invoicing' ),
+            'renews_on'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'       => __( 'Payments', 'invoicing' ),
+            'item'           => _n( 'Item', 'Items', $items_count,  'invoicing' ),
+            'gateway'        => __( 'Payment Method', 'invoicing' ),
+            'profile_id'     => __( 'Profile ID', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        )
+    );
+
+    if ( ! $sub->is_active() ) {
+
+        if ( isset( $fields['renews_on'] ) ) {
+            unset( $fields['renews_on'] );
+        }
+
+        if ( isset( $fields['gateway'] ) ) {
+            unset( $fields['gateway'] );
+        }
+
+    }
+
+    $profile_id = $sub->get_profile_id();
+    if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
+        unset( $fields['profile_id'] );
+    }
+
+    ?>
 
 		<table class="table table-borderless" style="font-size: 14px;">
 			<tbody>
@@ -226,20 +226,20 @@ 
  */
 function getpaid_admin_subscription_metabox_display_customer( $subscription ) {
 
-	$username = __( '(Missing User)', 'invoicing' );
+    $username = __( '(Missing User)', 'invoicing' );
 
-	$user = get_userdata( $subscription->get_customer_id() );
-	if ( $user ) {
+    $user = get_userdata( $subscription->get_customer_id() );
+    if ( $user ) {
 
-		$username = sprintf(
-			'<a href="user-edit.php?user_id=%s">%s</a>',
-			absint( $user->ID ),
-			! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
-		);
+        $username = sprintf(
+            '<a href="user-edit.php?user_id=%s">%s</a>',
+            absint( $user->ID ),
+            ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
+        );
 
-	}
+    }
 
-	echo  $username;
+    echo  $username;
 }
 add_action( 'getpaid_subscription_admin_display_customer', 'getpaid_admin_subscription_metabox_display_customer' );
 
@@ -249,8 +249,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_amount( $subscription ) {
-	$amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
-	echo "<span>$amount</span>";
+    $amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
+    echo "<span>$amount</span>";
 }
 add_action( 'getpaid_subscription_admin_display_amount', 'getpaid_admin_subscription_metabox_display_amount' );
 
@@ -260,7 +260,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_id( $subscription ) {
-	echo  '#' . absint( $subscription->get_id() );
+    echo  '#' . absint( $subscription->get_id() );
 }
 add_action( 'getpaid_subscription_admin_display_subscription', 'getpaid_admin_subscription_metabox_display_id' );
 
@@ -270,7 +270,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_start_date( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_date_created() );
+    echo getpaid_format_date_value( $subscription->get_date_created() );
 }
 add_action( 'getpaid_subscription_admin_display_start_date', 'getpaid_admin_subscription_metabox_display_start_date' );
 
@@ -280,7 +280,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renews_on( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_expiration() );
+    echo getpaid_format_date_value( $subscription->get_expiration() );
 }
 add_action( 'getpaid_subscription_admin_display_renews_on', 'getpaid_admin_subscription_metabox_display_renews_on' );
 
@@ -290,8 +290,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renewals( $subscription ) {
-	$max_bills = $subscription->get_bill_times();
-	echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+    $max_bills = $subscription->get_bill_times();
+    echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
 }
 add_action( 'getpaid_subscription_admin_display_renewals', 'getpaid_admin_subscription_metabox_display_renewals' );
 /**
@@ -302,13 +302,13 @@ 
  */
 function getpaid_admin_subscription_metabox_display_item( $subscription, $subscription_group = false ) {
 
-	if ( empty( $subscription_group ) ) {
-		echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() );
-		return;
-	}
+    if ( empty( $subscription_group ) ) {
+        echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() );
+        return;
+    }
 
-	$markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-	echo implode( ' | ', $markup );
+    $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+    echo implode( ' | ', $markup );
 
 }
 add_action( 'getpaid_subscription_admin_display_item', 'getpaid_admin_subscription_metabox_display_item', 10, 2 );
@@ -320,13 +320,13 @@ 
  */
 function getpaid_admin_subscription_metabox_display_gateway( $subscription ) {
 
-	$gateway = $subscription->get_gateway();
+    $gateway = $subscription->get_gateway();
 
-	if ( ! empty( $gateway ) ) {
-		echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
-	} else {
-		echo "&mdash;";
-	}
+    if ( ! empty( $gateway ) ) {
+        echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
+    } else {
+        echo "&mdash;";
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_gateway', 'getpaid_admin_subscription_metabox_display_gateway' );
@@ -337,7 +337,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_status( $subscription ) {
-	echo $subscription->get_status_label_html();
+    echo $subscription->get_status_label_html();
 }
 add_action( 'getpaid_subscription_admin_display_status', 'getpaid_admin_subscription_metabox_display_status' );
 
@@ -348,29 +348,29 @@ 
  */
 function getpaid_admin_subscription_metabox_display_profile_id( $subscription ) {
 
-	$profile_id = $subscription->get_profile_id();
-
-	$input = aui()->input(
-		array(
-			'type'        => 'text',
-			'id'          => 'wpinv_subscription_profile_id',
-			'name'        => 'wpinv_subscription_profile_id',
-			'label'       => __( 'Profile Id', 'invoicing' ),
-			'label_type'  => 'hidden',
-			'placeholder' => __( 'Profile Id', 'invoicing' ),
-			'value'       => sanitize_text_field( $profile_id ),
-			'input_group_right' => '',
-			'no_wrap'     => true,
-		)
-	);
-
-	echo str_ireplace( 'form-control', 'regular-text', $input );
-
-	$url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $subscription );
-	if ( ! empty( $url ) ) {
-		$url = esc_url_raw( $url );
-		echo '&nbsp;<a href="' . $url . '" title="' . __( 'View in Gateway', 'invoicing' ) . '" target="_blank"><i class="fas fa-external-link-alt fa-xs fa-fw align-top"></i></a>';
-	}
+    $profile_id = $subscription->get_profile_id();
+
+    $input = aui()->input(
+        array(
+            'type'        => 'text',
+            'id'          => 'wpinv_subscription_profile_id',
+            'name'        => 'wpinv_subscription_profile_id',
+            'label'       => __( 'Profile Id', 'invoicing' ),
+            'label_type'  => 'hidden',
+            'placeholder' => __( 'Profile Id', 'invoicing' ),
+            'value'       => sanitize_text_field( $profile_id ),
+            'input_group_right' => '',
+            'no_wrap'     => true,
+        )
+    );
+
+    echo str_ireplace( 'form-control', 'regular-text', $input );
+
+    $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $subscription );
+    if ( ! empty( $url ) ) {
+        $url = esc_url_raw( $url );
+        echo '&nbsp;<a href="' . $url . '" title="' . __( 'View in Gateway', 'invoicing' ) . '" target="_blank"><i class="fas fa-external-link-alt fa-xs fa-fw align-top"></i></a>';
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_profile_id', 'getpaid_admin_subscription_metabox_display_profile_id' );
@@ -382,39 +382,39 @@ 
  */
 function getpaid_admin_subscription_update_metabox( $subscription ) {
 
-	?>
+    ?>
 	<div class="mt-3">
 
 		<?php
-			echo aui()->select(
-				array(
-					'options'          => getpaid_get_subscription_statuses(),
-					'name'             => 'subscription_status',
-					'id'               => 'subscription_status_update_select',
-					'required'         => true,
-					'no_wrap'          => false,
-					'label'            => __( 'Subscription Status', 'invoicing' ),
-					'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
-					'select2'          => true,
-					'value'            => $subscription->get_status( 'edit' ),
-				)
-			);
-		?>
+            echo aui()->select(
+                array(
+                    'options'          => getpaid_get_subscription_statuses(),
+                    'name'             => 'subscription_status',
+                    'id'               => 'subscription_status_update_select',
+                    'required'         => true,
+                    'no_wrap'          => false,
+                    'label'            => __( 'Subscription Status', 'invoicing' ),
+                    'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
+                    'select2'          => true,
+                    'value'            => $subscription->get_status( 'edit' ),
+                )
+            );
+        ?>
 
 		<div class="mt-2 px-3 py-2 bg-light border-top" style="margin: -12px;">
 
 		<?php
-			submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
+            submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
 
-			$url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
-			$anchor = __( 'Renew Subscription', 'invoicing' );
-			$title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
+            $url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
+            $anchor = __( 'Renew Subscription', 'invoicing' );
+            $title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
 
-			if ( $subscription->is_active() ) {
-				echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
-			}
+            if ( $subscription->is_active() ) {
+                echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
+            }
 
-	echo '</div></div>';
+    echo '</div></div>';
 }
 
 /**
@@ -425,33 +425,33 @@ 
  */
 function getpaid_admin_subscription_invoice_details_metabox( $subscription, $strict = true ) {
 
-	$columns = apply_filters(
-		'getpaid_subscription_related_invoices_columns',
-		array(
-			'invoice'      => __( 'Invoice', 'invoicing' ),
-			'relationship' => __( 'Relationship', 'invoicing' ),
-			'date'         => __( 'Date', 'invoicing' ),
-			'status'       => __( 'Status', 'invoicing' ),
-			'total'        => __( 'Total', 'invoicing' ),
-		),
-		$subscription
-	);
-
-	// Prepare the invoices.
-	$payments = $subscription->get_child_payments( ! is_admin() );
-	$parent   = $subscription->get_parent_invoice();
-
-	if ( $parent->exists() ) {
-		$payments = array_merge( array( $parent ), $payments );
-	}
-
-	$table_class = 'w-100 bg-white';
-
-	if ( ! is_admin() ) {
-		$table_class = 'table table-bordered';
-	}
-
-	?>
+    $columns = apply_filters(
+        'getpaid_subscription_related_invoices_columns',
+        array(
+            'invoice'      => __( 'Invoice', 'invoicing' ),
+            'relationship' => __( 'Relationship', 'invoicing' ),
+            'date'         => __( 'Date', 'invoicing' ),
+            'status'       => __( 'Status', 'invoicing' ),
+            'total'        => __( 'Total', 'invoicing' ),
+        ),
+        $subscription
+    );
+
+    // Prepare the invoices.
+    $payments = $subscription->get_child_payments( ! is_admin() );
+    $parent   = $subscription->get_parent_invoice();
+
+    if ( $parent->exists() ) {
+        $payments = array_merge( array( $parent ), $payments );
+    }
+
+    $table_class = 'w-100 bg-white';
+
+    if ( ! is_admin() ) {
+        $table_class = 'table table-bordered';
+    }
+
+    ?>
 		<div class="m-0" style="overflow: auto;">
 
 			<table class="<?php echo $table_class; ?>">
@@ -459,14 +459,14 @@ 
 				<thead>
 					<tr>
 						<?php
-							foreach ( $columns as $key => $label ) {
-								$key   = esc_attr( $key );
-								$label = sanitize_text_field( $label );
-								$class = 'text-left';
-
-								echo "<th class='subscription-invoice-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
-							}
-						?>
+                            foreach ( $columns as $key => $label ) {
+                                $key   = esc_attr( $key );
+                                $label = sanitize_text_field( $label );
+                                $class = 'text-left';
+
+                                echo "<th class='subscription-invoice-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
+                            }
+                        ?>
 					</tr>
 				</thead>
 
@@ -482,73 +482,73 @@ 
 
 					<?php
 
-						foreach( $payments as $payment ) :
+                        foreach( $payments as $payment ) :
 
-							// Ensure that we have an invoice.
-							$payment = new WPInv_Invoice( $payment );
+                            // Ensure that we have an invoice.
+                            $payment = new WPInv_Invoice( $payment );
 
-							// Abort if the invoice is invalid...
-							if ( ! $payment->exists() ) {
-								continue;
-							}
+                            // Abort if the invoice is invalid...
+                            if ( ! $payment->exists() ) {
+                                continue;
+                            }
 
-							// ... or belongs to a different subscription.
-							if ( $strict && $payment->is_renewal() && $payment->get_subscription_id() && $payment->get_subscription_id() != $subscription->get_id() ) {
-								continue;
-							}
+                            // ... or belongs to a different subscription.
+                            if ( $strict && $payment->is_renewal() && $payment->get_subscription_id() && $payment->get_subscription_id() != $subscription->get_id() ) {
+                                continue;
+                            }
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									$class = 'text-left';
+                                    $class = 'text-left';
 
-									echo "<td class='p-2 $class'>";
+                                    echo "<td class='p-2 $class'>";
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'total':
-												echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>';
-												break;
+                                            case 'total':
+                                                echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>';
+                                                break;
 
-											case 'relationship':
-												echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
-												break;
+                                            case 'relationship':
+                                                echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
+                                                break;
 
-											case 'date':
-												echo getpaid_format_date_value( $payment->get_date_created() );
-												break;
+                                            case 'date':
+                                                echo getpaid_format_date_value( $payment->get_date_created() );
+                                                break;
 
-											case 'status':
+                                            case 'status':
 
-												$status = $payment->get_status_nicename();
-												if ( is_admin() ) {
-													$status = $payment->get_status_label_html();
-												}
+                                                $status = $payment->get_status_nicename();
+                                                if ( is_admin() ) {
+                                                    $status = $payment->get_status_label_html();
+                                                }
 
-												echo $status;
-												break;
+                                                echo $status;
+                                                break;
 
-											case 'invoice':
-												$link    = esc_url( get_edit_post_link( $payment->get_id() ) );
+                                            case 'invoice':
+                                                $link    = esc_url( get_edit_post_link( $payment->get_id() ) );
 
-												if ( ! is_admin() ) {
-													$link = esc_url( $payment->get_view_url() );
-												}
+                                                if ( ! is_admin() ) {
+                                                    $link = esc_url( $payment->get_view_url() );
+                                                }
 
-												$invoice = sanitize_text_field( $payment->get_number() );
-												echo "<a href='$link'>$invoice</a>";
-												break;
-										}
+                                                $invoice = sanitize_text_field( $payment->get_number() );
+                                                echo "<a href='$link'>$invoice</a>";
+                                                break;
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 
 				</tbody>
 
@@ -566,42 +566,42 @@ 
  */
 function getpaid_admin_subscription_item_details_metabox( $subscription ) {
 
-	// Fetch the subscription group.
-	$subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_payment_id(), $subscription->get_id() );
+    // Fetch the subscription group.
+    $subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_payment_id(), $subscription->get_id() );
 
-	if ( empty( $subscription_group ) || empty( $subscription_group['items'] ) ) {
-		return;
-	}
+    if ( empty( $subscription_group ) || empty( $subscription_group['items'] ) ) {
+        return;
+    }
 
-	// Prepare table columns.
-	$columns = apply_filters(
-		'getpaid_subscription_item_details_columns',
-		array(
-			'item_name'    => __( 'Item', 'invoicing' ),
-			'price'        => __( 'Price', 'invoicing' ),
-			'tax'          => __( 'Tax', 'invoicing' ),
-			'discount'     => __( 'Discount', 'invoicing' ),
-			//'initial'      => __( 'Initial Amount', 'invoicing' ),
-			'recurring'    => __( 'Subtotal', 'invoicing' ),
-		),
-		$subscription
-	);
+    // Prepare table columns.
+    $columns = apply_filters(
+        'getpaid_subscription_item_details_columns',
+        array(
+            'item_name'    => __( 'Item', 'invoicing' ),
+            'price'        => __( 'Price', 'invoicing' ),
+            'tax'          => __( 'Tax', 'invoicing' ),
+            'discount'     => __( 'Discount', 'invoicing' ),
+            //'initial'      => __( 'Initial Amount', 'invoicing' ),
+            'recurring'    => __( 'Subtotal', 'invoicing' ),
+        ),
+        $subscription
+    );
 
-	// Prepare the invoices.
+    // Prepare the invoices.
 
-	$invoice = $subscription->get_parent_invoice();
+    $invoice = $subscription->get_parent_invoice();
 
-	if ( ( ! wpinv_use_taxes() || ! $invoice->is_taxable() ) && isset( $columns['tax'] ) ) {
-		unset( $columns['tax'] );
-	}
+    if ( ( ! wpinv_use_taxes() || ! $invoice->is_taxable() ) && isset( $columns['tax'] ) ) {
+        unset( $columns['tax'] );
+    }
 
-	$table_class = 'w-100 bg-white';
+    $table_class = 'w-100 bg-white';
 
-	if ( ! is_admin() ) {
-		$table_class = 'table table-bordered';
-	}
+    if ( ! is_admin() ) {
+        $table_class = 'table table-bordered';
+    }
 
-	?>
+    ?>
 		<div class="m-0" style="overflow: auto;">
 
 			<table class="<?php echo $table_class; ?>">
@@ -610,14 +610,14 @@ 
 					<tr>
 						<?php
 
-							foreach ( $columns as $key => $label ) {
-								$key   = esc_attr( $key );
-								$label = sanitize_text_field( $label );
-								$class = 'text-left';
+                            foreach ( $columns as $key => $label ) {
+                                $key   = esc_attr( $key );
+                                $label = sanitize_text_field( $label );
+                                $class = 'text-left';
 
-								echo "<th class='subscription-item-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
-							}
-						?>
+                                echo "<th class='subscription-item-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
+                            }
+                        ?>
 					</tr>
 				</thead>
 
@@ -625,106 +625,106 @@ 
 
 					<?php
 
-						foreach( $subscription_group['items'] as $subscription_group_item ) :
+                        foreach( $subscription_group['items'] as $subscription_group_item ) :
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									$class = 'text-left';
+                                    $class = 'text-left';
 
-									echo "<td class='p-2 $class'>";
+                                    echo "<td class='p-2 $class'>";
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'item_name':
-												$item_name = get_the_title( $subscription_group_item['item_id'] );
-												$item_name = empty( $item_name ) ? $subscription_group_item['item_name'] : $item_name;
+                                            case 'item_name':
+                                                $item_name = get_the_title( $subscription_group_item['item_id'] );
+                                                $item_name = empty( $item_name ) ? $subscription_group_item['item_name'] : $item_name;
 
-												if ( $invoice->get_template() == 'amount' || 1 == (float) $subscription_group_item['quantity'] ) {
-													echo sanitize_text_field( $item_name );
-												} else {
-													printf( '%1$s x %2$d', sanitize_text_field( $item_name ), (float) $subscription_group_item['quantity'] );
-												}
+                                                if ( $invoice->get_template() == 'amount' || 1 == (float) $subscription_group_item['quantity'] ) {
+                                                    echo sanitize_text_field( $item_name );
+                                                } else {
+                                                    printf( '%1$s x %2$d', sanitize_text_field( $item_name ), (float) $subscription_group_item['quantity'] );
+                                                }
 
-												break;
+                                                break;
 
-											case 'price':
-												echo wpinv_price( $subscription_group_item['item_price'], $invoice->get_currency() );
-												break;
+                                            case 'price':
+                                                echo wpinv_price( $subscription_group_item['item_price'], $invoice->get_currency() );
+                                                break;
 
-											case 'tax':
-												echo wpinv_price( $subscription_group_item['tax'], $invoice->get_currency() );
-												break;
+                                            case 'tax':
+                                                echo wpinv_price( $subscription_group_item['tax'], $invoice->get_currency() );
+                                                break;
 
-											case 'discount':
-												echo wpinv_price( $subscription_group_item['discount'], $invoice->get_currency() );
-												break;
+                                            case 'discount':
+                                                echo wpinv_price( $subscription_group_item['discount'], $invoice->get_currency() );
+                                                break;
 
-											case 'initial':
-												echo wpinv_price( $subscription_group_item['price'] * $subscription_group_item['quantity'], $invoice->get_currency() );
-												break;
+                                            case 'initial':
+                                                echo wpinv_price( $subscription_group_item['price'] * $subscription_group_item['quantity'], $invoice->get_currency() );
+                                                break;
 
-											case 'recurring':
-												echo '<strong>' . wpinv_price( $subscription_group_item['price'] * $subscription_group_item['quantity'], $invoice->get_currency() ) . '</strong>';
-												break;
+                                            case 'recurring':
+                                                echo '<strong>' . wpinv_price( $subscription_group_item['price'] * $subscription_group_item['quantity'], $invoice->get_currency() ) . '</strong>';
+                                                break;
 
-										}
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
+                        endforeach;
 
-						foreach( $subscription_group['fees'] as $subscription_group_fee ) :
+                        foreach( $subscription_group['fees'] as $subscription_group_fee ) :
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									$class = 'text-left';
+                                    $class = 'text-left';
 
-									echo "<td class='p-2 $class'>";
+                                    echo "<td class='p-2 $class'>";
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'item_name':
-												echo sanitize_text_field( $subscription_group_fee['name'] );
-												break;
+                                            case 'item_name':
+                                                echo sanitize_text_field( $subscription_group_fee['name'] );
+                                                break;
 
-											case 'price':
-												echo wpinv_price( $subscription_group_fee['initial_fee'], $invoice->get_currency() );
-												break;
+                                            case 'price':
+                                                echo wpinv_price( $subscription_group_fee['initial_fee'], $invoice->get_currency() );
+                                                break;
 
-											case 'tax':
-												echo "&mdash;";
-												break;
+                                            case 'tax':
+                                                echo "&mdash;";
+                                                break;
 
-											case 'discount':
-												echo "&mdash;";
-												break;
+                                            case 'discount':
+                                                echo "&mdash;";
+                                                break;
 
-											case 'initial':
-												echo wpinv_price( $subscription_group_fee['initial_fee'], $invoice->get_currency() );
-												break;
+                                            case 'initial':
+                                                echo wpinv_price( $subscription_group_fee['initial_fee'], $invoice->get_currency() );
+                                                break;
 
-											case 'recurring':
-												echo '<strong>' . wpinv_price( $subscription_group_fee['recurring_fee'], $invoice->get_currency() ) . '</strong>';
-												break;
+                                            case 'recurring':
+                                                echo '<strong>' . wpinv_price( $subscription_group_fee['recurring_fee'], $invoice->get_currency() ) . '</strong>';
+                                                break;
 
-										}
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 
 				</tbody>
 
@@ -743,38 +743,38 @@ 
  */
 function getpaid_admin_subscription_related_subscriptions_metabox( $subscription, $skip_current = true ) {
 
-	// Fetch the subscription groups.
-	$subscription_groups = getpaid_get_invoice_subscription_groups( $subscription->get_parent_payment_id() );
-
-	if ( empty( $subscription_groups ) ) {
-		return;
-	}
-
-	// Prepare table columns.
-	$columns = apply_filters(
-		'getpaid_subscription_related_subscriptions_columns',
-		array(
-			'subscription'      => __( 'Subscription', 'invoicing' ),
-			'start_date'        => __( 'Start Date', 'invoicing' ),
-			'renewal_date'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'          => __( 'Payments', 'invoicing' ),
-			'item'              => __( 'Items', 'invoicing' ),
-			'status'            => __( 'Status', 'invoicing' ),
-		),
-		$subscription
-	);
-
-	if ( $subscription->get_status() == 'pending' ) {
-		unset( $columns['start_date'], $columns['renewal_date'] );
-	}
-
-	$table_class = 'w-100 bg-white';
-
-	if ( ! is_admin() ) {
-		$table_class = 'table table-bordered';
-	}
-
-	?>
+    // Fetch the subscription groups.
+    $subscription_groups = getpaid_get_invoice_subscription_groups( $subscription->get_parent_payment_id() );
+
+    if ( empty( $subscription_groups ) ) {
+        return;
+    }
+
+    // Prepare table columns.
+    $columns = apply_filters(
+        'getpaid_subscription_related_subscriptions_columns',
+        array(
+            'subscription'      => __( 'Subscription', 'invoicing' ),
+            'start_date'        => __( 'Start Date', 'invoicing' ),
+            'renewal_date'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'          => __( 'Payments', 'invoicing' ),
+            'item'              => __( 'Items', 'invoicing' ),
+            'status'            => __( 'Status', 'invoicing' ),
+        ),
+        $subscription
+    );
+
+    if ( $subscription->get_status() == 'pending' ) {
+        unset( $columns['start_date'], $columns['renewal_date'] );
+    }
+
+    $table_class = 'w-100 bg-white';
+
+    if ( ! is_admin() ) {
+        $table_class = 'table table-bordered';
+    }
+
+    ?>
 		<div class="m-0" style="overflow: auto;">
 
 			<table class="<?php echo $table_class; ?>">
@@ -783,14 +783,14 @@ 
 					<tr>
 						<?php
 
-							foreach ( $columns as $key => $label ) {
-								$key   = esc_attr( $key );
-								$label = sanitize_text_field( $label );
-								$class = 'text-left';
+                            foreach ( $columns as $key => $label ) {
+                                $key   = esc_attr( $key );
+                                $label = sanitize_text_field( $label );
+                                $class = 'text-left';
 
-								echo "<th class='related-subscription-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
-							}
-						?>
+                                echo "<th class='related-subscription-field-$key bg-light p-2 $class color-dark font-weight-bold'>$label</th>";
+                            }
+                        ?>
 					</tr>
 				</thead>
 
@@ -798,74 +798,74 @@ 
 
 					<?php
 
-						foreach( $subscription_groups as $subscription_group ) :
+                        foreach( $subscription_groups as $subscription_group ) :
 
-							// Do not list current subscription.
-							if ( $skip_current && (int) $subscription_group['subscription_id'] === $subscription->get_id() ) {
-								continue;
-							}
+                            // Do not list current subscription.
+                            if ( $skip_current && (int) $subscription_group['subscription_id'] === $subscription->get_id() ) {
+                                continue;
+                            }
 
-							// Ensure the subscription exists.
-							$_suscription = new WPInv_Subscription( $subscription_group['subscription_id'] );
+                            // Ensure the subscription exists.
+                            $_suscription = new WPInv_Subscription( $subscription_group['subscription_id'] );
 
-							if ( ! $_suscription->exists() ) {
-								continue;
-							}
+                            if ( ! $_suscription->exists() ) {
+                                continue;
+                            }
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									$class = 'text-left';
+                                    $class = 'text-left';
 
-									echo "<td class='p-2 $class'>";
+                                    echo "<td class='p-2 $class'>";
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'status':
-												echo $_suscription->get_status_label_html();
-												break;
+                                            case 'status':
+                                                echo $_suscription->get_status_label_html();
+                                                break;
 
-											case 'item':
-												$markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-												echo implode( ' | ', $markup );
-												break;
+                                            case 'item':
+                                                $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+                                                echo implode( ' | ', $markup );
+                                                break;
 
-											case 'renewals':
-												$max_bills = $_suscription->get_bill_times();
-												echo $_suscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
-												break;
+                                            case 'renewals':
+                                                $max_bills = $_suscription->get_bill_times();
+                                                echo $_suscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+                                                break;
 
-											case 'renewal_date':
-												echo $_suscription->is_active() ? getpaid_format_date_value( $_suscription->get_expiration() ) : "&mdash;";
-												break;
+                                            case 'renewal_date':
+                                                echo $_suscription->is_active() ? getpaid_format_date_value( $_suscription->get_expiration() ) : "&mdash;";
+                                                break;
 
-											case 'start_date':
-												echo 'pending' == $_suscription->get_status() ? "&mdash;" : getpaid_format_date_value( $_suscription->get_date_created() );
-												break;
+                                            case 'start_date':
+                                                echo 'pending' == $_suscription->get_status() ? "&mdash;" : getpaid_format_date_value( $_suscription->get_date_created() );
+                                                break;
 
-											case 'subscription':
-												$url = is_admin() ? admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $_suscription->get_id() ) ) : $_suscription->get_view_url();
-												printf(
-													'%1$s#%2$s%3$s',
-													'<a href="' . esc_url( $url ) . '">',
-													'<strong>' . intval( $_suscription->get_id() ) . '</strong>',
-													'</a>'
-												);
+                                            case 'subscription':
+                                                $url = is_admin() ? admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $_suscription->get_id() ) ) : $_suscription->get_view_url();
+                                                printf(
+                                                    '%1$s#%2$s%3$s',
+                                                    '<a href="' . esc_url( $url ) . '">',
+                                                    '<strong>' . intval( $_suscription->get_id() ) . '</strong>',
+                                                    '</a>'
+                                                );
 
-												echo WPInv_Subscriptions_List_Table::column_amount( $_suscription );
-												break;
+                                                echo WPInv_Subscriptions_List_Table::column_amount( $_suscription );
+                                                break;
 
-										}
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 
 				</tbody>
 

includes/subscription-functions.php

Indentation +307 added lines, -307 removed lines

@@ -50,7 +50,7 @@ 
  */
 function getpaid_get_invoice_subscription_group( $invoice_id, $subscription_id ) {
     $subscription_groups = getpaid_get_invoice_subscription_groups( $invoice_id );
-	$matching_group      = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
+    $matching_group      = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
     return reset( $matching_group );
 }
 
@@ -63,11 +63,11 @@ 
  */
 function getpaid_get_subscription( $subscription ) {
 
-	if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription = new WPInv_Subscription( $subscription );
-	}
+    if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription = new WPInv_Subscription( $subscription );
+    }
 
-	return $subscription->exists() ? $subscription : false;
+    return $subscription->exists() ? $subscription : false;
 }
 
 /**
@@ -81,28 +81,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;
 }
 
 /**
@@ -112,18 +112,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' ),
+        )
+    );
 
 }
 
@@ -133,8 +133,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 ) );
 }
 
 /**
@@ -144,18 +144,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',
+        )
+    );
 
 }
 
@@ -166,15 +166,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;
 
 }
 
@@ -185,32 +185,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' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -221,7 +221,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 );
 }
 
 /**
@@ -231,7 +231,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 ) );
 }
 
 /**
@@ -242,8 +242,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 ) );
 }
 
 /**
@@ -254,22 +254,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 '';
 }
 
 /**
@@ -281,22 +281,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 '';
 }
 
 /**
@@ -307,101 +307,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
 
-	);
+    );
 
 }
 
@@ -412,7 +412,7 @@ 
  * @return WPInv_Subscription|false
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -421,10 +421,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();
+    }
 }
 
 /**
@@ -433,7 +433,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -452,15 +452,15 @@ 
         return false;
     }
 
-	// Fetch the invoice subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoice 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];
 
 }
 
@@ -477,48 +477,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 );
 }
 
 /**
@@ -529,17 +529,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;
 }
 
 /**
@@ -553,57 +553,57 @@ 
  */
 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.
-		 * @var GetPaid_Form_Item $item
-		 */
-		foreach ( $items as $item ) {
+        /**
+         * Get the totals of the group.
+         * @var GetPaid_Form_Item $item
+         */
+        foreach ( $items as $item ) {
 
-			$subscription_totals[ $subscription_key ]['items'][$item->get_id()]  = $item->prepare_data_for_saving();
-			$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() + $item->item_tax - $item->item_discount;
-			$subscription_totals[ $subscription_key ]['recurring_total']        += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount;
-			$subscription_totals[ $subscription_key ]['recurring_limit']         = $item->get_recurring_limit();
+            $subscription_totals[ $subscription_key ]['items'][$item->get_id()]  = $item->prepare_data_for_saving();
+            $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() + $item->item_tax - $item->item_discount;
+            $subscription_totals[ $subscription_key ]['recurring_total']        += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount;
+            $subscription_totals[ $subscription_key ]['recurring_limit']         = $item->get_recurring_limit();
 
-			// 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 );
 }
 
 /**
@@ -614,17 +614,17 @@ 
  */
 function getpaid_should_group_subscriptions( $invoice ) {
 
-	$recurring_items = 0;
+    $recurring_items = 0;
 
-	foreach ( $invoice->get_items() as $item ) {
+    foreach ( $invoice->get_items() as $item ) {
 
-		if ( $item->is_recurring() ) {
-			$recurring_items ++;
-		}
+        if ( $item->is_recurring() ) {
+            $recurring_items ++;
+        }
 
-	}
+    }
 
-	return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice );
+    return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice );
 }
 
 /**
@@ -635,40 +635,40 @@ 
  * @return int
  */
 function getpaid_count_subscription_invoices( $parent_invoice_id, $subscription_id = false ) {
-	global $wpdb;
+    global $wpdb;
 
-	$parent_invoice_id = (int) $parent_invoice_id;
+    $parent_invoice_id = (int) $parent_invoice_id;
 
-	if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) {
+    if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) {
 
-		return (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-				$parent_invoice_id,
-				$parent_invoice_id
-			)
-		);
+        return (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+                $parent_invoice_id,
+                $parent_invoice_id
+            )
+        );
 
-	}
+    }
 	
-	$invoice_ids = $wpdb->get_col(
-		$wpdb->prepare(
-			"SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-			$parent_invoice_id,
-			$parent_invoice_id
-		)
-	);
+    $invoice_ids = $wpdb->get_col(
+        $wpdb->prepare(
+            "SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+            $parent_invoice_id,
+            $parent_invoice_id
+        )
+    );
 
-	$count = 0;
+    $count = 0;
 
-	foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) {
+    foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) {
 
-		if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) {
-			$count ++;
-			continue;
-		}
+        if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) {
+            $count ++;
+            continue;
+        }
 
-	}
+    }
 
-	return $count;
+    return $count;
 }

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

Indentation +211 added lines, -211 removed lines

@@ -12,230 +12,230 @@
  */
 class GetPaid_Payment_Form_Submission_Taxes {
 
-	/**
-	 * Submission taxes.
-	 * @var array
-	 */
-	public $taxes = array();
-
-	/**
-	 * Whether or not we should skip the taxes.
-	 * @var bool
-	 */
-	protected $skip_taxes = false;
+    /**
+     * Submission taxes.
+     * @var array
+     */
+    public $taxes = array();
+
+    /**
+     * Whether or not we should skip the taxes.
+     * @var bool
+     */
+    protected $skip_taxes = false;
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		// Validate VAT number.
-		$this->validate_vat( $submission );
-
-		if ( $this->skip_taxes ) {
-			return;
-		}
-
-		foreach ( $submission->get_items() as $item ) {
-			$this->process_item_tax( $item, $submission );
-		}
-
-		// Process any existing invoice taxes.
-		if ( $submission->has_invoice() ) {
-			$this->taxes = array_replace( $submission->get_invoice()->get_taxes(), $this->taxes );
-		}
-
-	}
-
-	/**
-	 * Maybe process tax.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function process_item_tax( $item, $submission ) {
-
-		$rates    = getpaid_get_item_tax_rates( $item, $submission->country, $submission->state );
-		$rates    = getpaid_filter_item_tax_rates( $item, $rates );
-		$taxes    = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates );
-		$r_taxes  = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates );
-
-		foreach ( $taxes as $name => $amount ) {
-			$recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0;
-			$tax       = getpaid_prepare_item_tax( $item, $name, $amount, $recurring );
-
-			$item->item_tax += wpinv_sanitize_amount( $tax['initial_tax'] );
-
-			if ( ! isset( $this->taxes[ $name ] ) ) {
-				$this->taxes[ $name ] = $tax;
-				continue;
-			}
-
-			$this->taxes[ $name ]['initial_tax']   += $tax['initial_tax'];
-			$this->taxes[ $name ]['recurring_tax'] += $tax['recurring_tax'];
-
-		}
-
-	}
-
-	/**
-	 * Checks if the submission has a digital item.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_digital_item( $submission ) {
-
-		foreach ( $submission->get_items() as $item ) {
-
-			if ( 'digital' == $item->get_vat_rule() ) {
-				return true;
-			}
-
-		}
-
-		return false;
-	}
-
-	/**
-	 * Checks if this is an eu store.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public static function is_eu_store() {
-		return self::is_eu_country( wpinv_get_default_country() );
-	}
-
-	/**
-	 * Checks if this is an eu country.
-	 *
-	 * @param string $country
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public static function is_eu_country( $country ) {
-		return getpaid_is_eu_state( $country );
-	}
-
-	/**
-	 * Checks if this is an eu purchase.
-	 *
-	 * @param string $customer_country
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public static function is_eu_transaction( $customer_country ) {
-		return self::is_eu_country( $customer_country ) && self::is_eu_store();
-	}
-
-	/**
-	 * Retrieves the vat number.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_vat_number( $submission ) {
-
-		// Retrieve from the posted number.
-		$vat_number = $submission->get_field( 'wpinv_vat_number', 'billing' );
-		if ( ! is_null( $vat_number ) ) {
-			return wpinv_clean( $vat_number );
-		}
-
-		return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : '';
-	}
-
-	/**
-	 * Retrieves the company.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_company( $submission ) {
-
-		// Retrieve from the posted data.
-		$company = $submission->get_field( 'wpinv_company', 'billing' );
-		if ( ! empty( $company ) ) {
-			return wpinv_clean( $company );
-		}
-
-		// Retrieve from the invoice.
-		return $submission->has_invoice() ? $submission->get_invoice()->get_company() : '';
-	}
-
-	/**
-	 * Checks if we require a VAT number.
-	 *
-	 * @param bool $ip_in_eu Whether the customer IP is from the EU
-	 * @param bool $country_in_eu Whether the customer country is from the EU
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function requires_vat( $ip_in_eu, $country_in_eu ) {
-
-		$prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' );
-		$prevent_b2c = ! empty( $prevent_b2c );
-		$is_eu       = $ip_in_eu || $country_in_eu;
-
-		return $prevent_b2c && $is_eu;
-	}
-
-	/**
-	 * Validate VAT data.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @since 1.0.19
-	 */
-	public function validate_vat( $submission ) {
-
-		$in_eu = $this->is_eu_transaction( $submission->country );
-
-		// Abort if we are not validating vat numbers.
-		if ( ! $in_eu ) {
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        // Validate VAT number.
+        $this->validate_vat( $submission );
+
+        if ( $this->skip_taxes ) {
             return;
-		}
+        }
+
+        foreach ( $submission->get_items() as $item ) {
+            $this->process_item_tax( $item, $submission );
+        }
+
+        // Process any existing invoice taxes.
+        if ( $submission->has_invoice() ) {
+            $this->taxes = array_replace( $submission->get_invoice()->get_taxes(), $this->taxes );
+        }
+
+    }
+
+    /**
+     * Maybe process tax.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function process_item_tax( $item, $submission ) {
+
+        $rates    = getpaid_get_item_tax_rates( $item, $submission->country, $submission->state );
+        $rates    = getpaid_filter_item_tax_rates( $item, $rates );
+        $taxes    = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates );
+        $r_taxes  = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates );
+
+        foreach ( $taxes as $name => $amount ) {
+            $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0;
+            $tax       = getpaid_prepare_item_tax( $item, $name, $amount, $recurring );
+
+            $item->item_tax += wpinv_sanitize_amount( $tax['initial_tax'] );
+
+            if ( ! isset( $this->taxes[ $name ] ) ) {
+                $this->taxes[ $name ] = $tax;
+                continue;
+            }
+
+            $this->taxes[ $name ]['initial_tax']   += $tax['initial_tax'];
+            $this->taxes[ $name ]['recurring_tax'] += $tax['recurring_tax'];
+
+        }
+
+    }
+
+    /**
+     * Checks if the submission has a digital item.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_digital_item( $submission ) {
+
+        foreach ( $submission->get_items() as $item ) {
+
+            if ( 'digital' == $item->get_vat_rule() ) {
+                return true;
+            }
+
+        }
 
-		// Prepare variables.
-		$vat_number  = $this->get_vat_number( $submission );
-		$ip_country  = getpaid_get_ip_country();
+        return false;
+    }
+
+    /**
+     * Checks if this is an eu store.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public static function is_eu_store() {
+        return self::is_eu_country( wpinv_get_default_country() );
+    }
+
+    /**
+     * Checks if this is an eu country.
+     *
+     * @param string $country
+     * @since 1.0.19
+     * @return bool
+     */
+    public static function is_eu_country( $country ) {
+        return getpaid_is_eu_state( $country );
+    }
+
+    /**
+     * Checks if this is an eu purchase.
+     *
+     * @param string $customer_country
+     * @since 1.0.19
+     * @return bool
+     */
+    public static function is_eu_transaction( $customer_country ) {
+        return self::is_eu_country( $customer_country ) && self::is_eu_store();
+    }
+
+    /**
+     * Retrieves the vat number.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_vat_number( $submission ) {
+
+        // Retrieve from the posted number.
+        $vat_number = $submission->get_field( 'wpinv_vat_number', 'billing' );
+        if ( ! is_null( $vat_number ) ) {
+            return wpinv_clean( $vat_number );
+        }
+
+        return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : '';
+    }
+
+    /**
+     * Retrieves the company.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_company( $submission ) {
+
+        // Retrieve from the posted data.
+        $company = $submission->get_field( 'wpinv_company', 'billing' );
+        if ( ! empty( $company ) ) {
+            return wpinv_clean( $company );
+        }
+
+        // Retrieve from the invoice.
+        return $submission->has_invoice() ? $submission->get_invoice()->get_company() : '';
+    }
+
+    /**
+     * Checks if we require a VAT number.
+     *
+     * @param bool $ip_in_eu Whether the customer IP is from the EU
+     * @param bool $country_in_eu Whether the customer country is from the EU
+     * @since 1.0.19
+     * @return string
+     */
+    public function requires_vat( $ip_in_eu, $country_in_eu ) {
+
+        $prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' );
+        $prevent_b2c = ! empty( $prevent_b2c );
+        $is_eu       = $ip_in_eu || $country_in_eu;
+
+        return $prevent_b2c && $is_eu;
+    }
+
+    /**
+     * Validate VAT data.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @since 1.0.19
+     */
+    public function validate_vat( $submission ) {
+
+        $in_eu = $this->is_eu_transaction( $submission->country );
+
+        // Abort if we are not validating vat numbers.
+        if ( ! $in_eu ) {
+            return;
+        }
+
+        // Prepare variables.
+        $vat_number  = $this->get_vat_number( $submission );
+        $ip_country  = getpaid_get_ip_country();
         $is_eu       = $this->is_eu_country( $submission->country );
         $is_ip_eu    = $this->is_eu_country( $ip_country );
 
-		// Maybe abort early for initial fetches.
-		if ( $submission->is_initial_fetch() && empty( $vat_number ) ) {
-			return;
-		}
+        // Maybe abort early for initial fetches.
+        if ( $submission->is_initial_fetch() && empty( $vat_number ) ) {
+            return;
+        }
 
-		// If we're preventing business to consumer purchases,
-		if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) {
+        // If we're preventing business to consumer purchases,
+        if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) {
 
-			// Ensure that a vat number has been specified.
-			throw new Exception(
-				__( 'Please enter your VAT number to verify your purchase is by an EU business.', 'invoicing' )
-			);
+            // Ensure that a vat number has been specified.
+            throw new Exception(
+                __( 'Please enter your VAT number to verify your purchase is by an EU business.', 'invoicing' )
+            );
 
-		}
+        }
 
-		if ( empty( $vat_number ) ) {
-			return;
-		}
+        if ( empty( $vat_number ) ) {
+            return;
+        }
 
-		if ( wpinv_should_validate_vat_number() && ! wpinv_validate_vat_number( $vat_number, $submission->country ) ) {
-			throw new Exception( __( 'Your VAT number is invalid', 'invoicing' ) );
-		}
+        if ( wpinv_should_validate_vat_number() && ! wpinv_validate_vat_number( $vat_number, $submission->country ) ) {
+            throw new Exception( __( 'Your VAT number is invalid', 'invoicing' ) );
+        }
 
-		if (  wpinv_default_billing_country() == $submission->country && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) {
-			return;
-		}
+        if (  wpinv_default_billing_country() == $submission->country && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) {
+            return;
+        }
 
-		$this->skip_taxes = true;
-	}
+        $this->skip_taxes = true;
+    }
 
 }

includes/wpinv-payment-functions.php

Indentation +1 added lines, -1 removed lines

@@ -239,7 +239,7 @@
         do_action( 'getpaid_checkout_invoice_exception', $invoice );
     }
 
-	// Do we have any errors?
+    // Do we have any errors?
     if ( wpinv_get_errors() ) {
         $response['data'] = getpaid_get_errors_html( true, false );
     } else {

includes/payments/class-getpaid-checkout.php

Indentation +256 added lines, -256 removed lines

@@ -12,180 +12,180 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 * 
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items      = $this->get_submission_items();
-		$invoice    = $this->get_submission_invoice();
-		$invoice    = $this->process_submission_invoice( $invoice, $items );
-		$prepared   = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->set_is_viewed( true );
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     * 
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items      = $this->get_submission_items();
+        $invoice    = $this->get_submission_invoice();
+        $invoice    = $this->process_submission_invoice( $invoice, $items );
+        $prepared   = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->set_is_viewed( true );
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->set_created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
 
-		return $invoice;
-	}
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->set_created_via( 'payment_form' );
+            return $invoice;
+        }
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+        $invoice = $submission->get_invoice();
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+        return $invoice;
+    }
+
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
+
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
+
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $data['wpi-gateway'] );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $data['wpi-gateway'] );
 
-		$address_confirmed = $submission->get_field( 'confirm-address' );
-		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
+        $address_confirmed = $submission->get_field( 'confirm-address' );
+        $invoice->set_address_confirmed( ! empty( $address_confirmed ) );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -195,11 +195,11 @@ 
         if ( empty( $user ) ) {
             $user = wpinv_create_user( $submission->get_billing_email() );
 
-			// (Maybe) send new user notification.
-			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
-				wp_send_new_user_notifications( $user, 'user' );
-			}
+            // (Maybe) send new user notification.
+            $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+            if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
+                wp_send_new_user_notifications( $user, 'user' );
+            }
 
         }
 
@@ -209,31 +209,31 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array();
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) || $field['type'] == 'address' ) {
                 continue;
             }
@@ -251,176 +251,176 @@ 
                     $label = $field['label'];
                 }
 
-				$prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] );
+                $prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] );
 
             }
 
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
 
-		// Save payment form data.
-		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
+        // Save payment form data.
+        $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
         if ( ! empty( $prepared_payment_form_data ) ) {
             update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data );
-		}
+        }
 
-		// Save payment form data.
+        // Save payment form data.
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		$this->process_payment( $invoice );
+        $this->process_payment( $invoice );
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */

includes/class-wpinv-discount.php

Indentation +1300 added lines, -1300 removed lines

@@ -15,30 +15,30 @@ 
  */
 class WPInv_Discount extends GetPaid_Data  {
 
-	/**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+    /**
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'discount';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'discount';
-
-	/**
-	 * Discount Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'discount';
+
+    /**
+     * Discount Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => 'no-name',
         'description'          => '',
@@ -58,144 +58,144 @@ 
         'amount'               => null,
     );
 
-	/**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_discounts';
+    /**
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_discounts';
 
     /**
      * Stores a reference to the original WP_Post object
      *
      * @var WP_Post
      */
-	protected $post = null;
-
-	/**
-	 * Get the discount if ID is passed, otherwise the discount is new and empty.
-	 *
-	 * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code.
-	 */
-	public function __construct( $discount = 0 ) {
-		parent::__construct( $discount );
-
-		if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) {
-			$this->set_id( $discount );
-		} elseif ( $discount instanceof self ) {
-			$this->set_id( $discount->get_id() );
-		} elseif ( ! empty( $discount->ID ) ) {
-			$this->set_id( $discount->ID );
-		} elseif ( is_array( $discount ) ) {
-			$this->set_props( $discount );
-
-			if ( isset( $discount['ID'] ) ) {
-				$this->set_id( $discount['ID'] );
-			}
-
-		} elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) {
-			$this->set_id( $discount );
-		} else {
-			$this->set_object_read( true );
-		}
+    protected $post = null;
+
+    /**
+     * Get the discount if ID is passed, otherwise the discount is new and empty.
+     *
+     * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code.
+     */
+    public function __construct( $discount = 0 ) {
+        parent::__construct( $discount );
+
+        if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) {
+            $this->set_id( $discount );
+        } elseif ( $discount instanceof self ) {
+            $this->set_id( $discount->get_id() );
+        } elseif ( ! empty( $discount->ID ) ) {
+            $this->set_id( $discount->ID );
+        } elseif ( is_array( $discount ) ) {
+            $this->set_props( $discount );
+
+            if ( isset( $discount['ID'] ) ) {
+                $this->set_id( $discount['ID'] );
+            }
+
+        } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) {
+            $this->set_id( $discount );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
             $this->ID   = $this->get_id();
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
+        }
+
+    }
+
+    /**
+     * Fetch a discount from the db/cache
+     *
+     *
+     * @static
+     * @param string $field The field to query against: 'ID', 'discount_code'
+     * @param string|int $value The field value
+     * @deprecated
+     * @since 1.0.15
+     * @return array|bool array of discount details on success. False otherwise.
+     */
+    public static function get_data_by( $field, $value ) {
+
+        if ( 'id' == strtolower( $field ) ) {
+            // Make sure the value is numeric to avoid casting objects, for example,
+            // to int 1.
+            if ( ! is_numeric( $value ) )
+                return false;
+            $value = intval( $value );
+            if ( $value < 1 )
+                return false;
+        }
+
+        if ( ! $value || ! is_string( $field ) ) {
+            return false;
+        }
+
+        $field = trim( $field );
+
+        // prepare query args
+        switch ( strtolower( $field ) ) {
+            case 'id':
+                $discount_id = $value;
+                $args		 = array( 'include' => array( $value ) );
+                break;
+            case 'discount_code':
+            case 'code':
+                $value       = trim( $value );
+                $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' );
+                $args		 = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value );
+                break;
+            case 'name':
+                $discount_id = 0;
+                $args		 = array( 'name' => trim( $value ) );
+                break;
+            default:
+                $args		 = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value );
+                if ( ! is_array( $args ) ) {
+                    return apply_filters( "wpinv_discount_get_data_by_$field", false, $value );
+                }
+
+        }
+
+        // Check if there is a cached value.
+        if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) {
+            return $discount;
+        }
+
+        $args = array_merge(
+            $args,
+            array(
+                'post_type'      => 'wpi_discount',
+                'posts_per_page' => 1,
+                'post_status'    => array( 'publish', 'pending', 'draft', 'expired' )
+            )
+        );
+
+        $discount = get_posts( $args );
+
+        if( empty( $discount ) ) {
+            return false;
         }
 
-	}
-
-	/**
-	 * Fetch a discount from the db/cache
-	 *
-	 *
-	 * @static
-	 * @param string $field The field to query against: 'ID', 'discount_code'
-	 * @param string|int $value The field value
-	 * @deprecated
-	 * @since 1.0.15
-	 * @return array|bool array of discount details on success. False otherwise.
-	 */
-	public static function get_data_by( $field, $value ) {
-
-		if ( 'id' == strtolower( $field ) ) {
-			// Make sure the value is numeric to avoid casting objects, for example,
-			// to int 1.
-			if ( ! is_numeric( $value ) )
-				return false;
-			$value = intval( $value );
-			if ( $value < 1 )
-				return false;
-		}
-
-		if ( ! $value || ! is_string( $field ) ) {
-			return false;
-		}
-
-		$field = trim( $field );
-
-		// prepare query args
-		switch ( strtolower( $field ) ) {
-			case 'id':
-				$discount_id = $value;
-				$args		 = array( 'include' => array( $value ) );
-				break;
-			case 'discount_code':
-			case 'code':
-				$value       = trim( $value );
-				$discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' );
-				$args		 = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value );
-				break;
-			case 'name':
-				$discount_id = 0;
-				$args		 = array( 'name' => trim( $value ) );
-				break;
-			default:
-				$args		 = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value );
-				if ( ! is_array( $args ) ) {
-					return apply_filters( "wpinv_discount_get_data_by_$field", false, $value );
-				}
-
-		}
-
-		// Check if there is a cached value.
-		if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) {
-			return $discount;
-		}
-
-		$args = array_merge(
-			$args,
-			array(
-				'post_type'      => 'wpi_discount',
-				'posts_per_page' => 1,
-				'post_status'    => array( 'publish', 'pending', 'draft', 'expired' )
-			)
-		);
-
-		$discount = get_posts( $args );
-
-		if( empty( $discount ) ) {
-			return false;
-		}
-
-		$discount = $discount[0];
-
-		// Prepare the return data.
-		$return = array(
+        $discount = $discount[0];
+
+        // Prepare the return data.
+        $return = array(
             'ID'                          => $discount->ID,
             'code'                        => get_post_meta( $discount->ID, '_wpi_discount_code', true ),
             'amount'                      => get_post_meta( $discount->ID, '_wpi_discount_amount', true ),
             'date_created'                => $discount->post_date,
-			'date_modified'               => $discount->post_modified,
-			'status'               		  => $discount->post_status,
-			'start'                  	  => get_post_meta( $discount->ID, '_wpi_discount_start', true ),
+            'date_modified'               => $discount->post_modified,
+            'status'               		  => $discount->post_status,
+            'start'                  	  => get_post_meta( $discount->ID, '_wpi_discount_start', true ),
             'expiration'                  => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ),
             'type'               		  => get_post_meta( $discount->ID, '_wpi_discount_type', true ),
             'description'                 => $discount->post_excerpt,
@@ -209,77 +209,77 @@ 
             'max_total'                   => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ),
         );
 
-		$return = apply_filters( 'wpinv_discount_properties', $return );
-
-		// Update the cache with our data
-		wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' );
-		wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' );
-
-		return $return;
-	}
-
-	/**
-	 * Given a discount code, it returns a discount id.
-	 *
-	 *
-	 * @static
-	 * @param string $discount_code
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_discount_id_by_code( $discount_code ) {
-
-		// Trim the code.
-		$discount_code = trim( $discount_code );
-
-		// Ensure a value has been passed.
-		if ( empty( $discount_code ) ) {
-			return 0;
-		}
-
-		// Maybe retrieve from the cache.
-		$discount_id   = wp_cache_get( $discount_code, 'getpaid_discount_codes' );
-		if ( ! empty( $discount_id ) ) {
-			return $discount_id;
-		}
-
-		// Fetch the first discount codes.
-		$discounts = get_posts(
-			array(
-				'meta_key'       => '_wpi_discount_code',
-				'meta_value'     => $discount_code,
-				'post_type'      => 'wpi_discount',
-				'posts_per_page' => 1,
-				'post_status'    => array( 'publish', 'pending', 'draft', 'expired' ),
-				'fields'         => 'ids',
-			)
-		);
-
-		if ( empty( $discounts ) ) {
-			return 0;
-		}
-
-		$discount_id = $discounts[0];
-
-		// Update the cache with our data
-		wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' );
-
-		return $discount_id;
-	}
-
-	/**
-	 * Magic method for checking the existence of a certain custom field.
-	 *
-	 * @since 1.0.15
-	 * @access public
-	 *
-	 * @return bool Whether the given discount field is set.
-	 */
-	public function __isset( $key ){
-		return isset( $this->data[$key] ) || method_exists( $this, "get_$key");
-	}
-
-	/*
+        $return = apply_filters( 'wpinv_discount_properties', $return );
+
+        // Update the cache with our data
+        wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' );
+        wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' );
+
+        return $return;
+    }
+
+    /**
+     * Given a discount code, it returns a discount id.
+     *
+     *
+     * @static
+     * @param string $discount_code
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_discount_id_by_code( $discount_code ) {
+
+        // Trim the code.
+        $discount_code = trim( $discount_code );
+
+        // Ensure a value has been passed.
+        if ( empty( $discount_code ) ) {
+            return 0;
+        }
+
+        // Maybe retrieve from the cache.
+        $discount_id   = wp_cache_get( $discount_code, 'getpaid_discount_codes' );
+        if ( ! empty( $discount_id ) ) {
+            return $discount_id;
+        }
+
+        // Fetch the first discount codes.
+        $discounts = get_posts(
+            array(
+                'meta_key'       => '_wpi_discount_code',
+                'meta_value'     => $discount_code,
+                'post_type'      => 'wpi_discount',
+                'posts_per_page' => 1,
+                'post_status'    => array( 'publish', 'pending', 'draft', 'expired' ),
+                'fields'         => 'ids',
+            )
+        );
+
+        if ( empty( $discounts ) ) {
+            return 0;
+        }
+
+        $discount_id = $discounts[0];
+
+        // Update the cache with our data
+        wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' );
+
+        return $discount_id;
+    }
+
+    /**
+     * Magic method for checking the existence of a certain custom field.
+     *
+     * @since 1.0.15
+     * @access public
+     *
+     * @return bool Whether the given discount field is set.
+     */
+    public function __isset( $key ){
+        return isset( $this->data[$key] ) || method_exists( $this, "get_$key");
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD methods
 	|--------------------------------------------------------------------------
@@ -294,430 +294,430 @@ 
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Get discount status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
+    /**
+     * Get discount status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
     }
 
     /**
-	 * Get plugin version when the discount was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the discount was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the discount was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the discount was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the discount was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the discount was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the discount was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the discount was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the discount was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the discount was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
-    }
-
-    /**
-	 * Get the discount name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
-    }
-
-    /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
-    }
-
-    /**
-	 * Get the discount description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-		return $this->get_prop( 'description', $context );
-    }
-
-    /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_excerpt( $context = 'view' ) {
-		return $this->get_description( $context );
-    }
-
-    /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_summary( $context = 'view' ) {
-		return $this->get_description( $context );
-    }
-
-    /**
-	 * Get the owner of the discount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
-	}
-
-	/**
-	 * Get the discount code.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_code( $context = 'view' ) {
-		return $this->get_prop( 'code', $context );
-	}
-
-	/**
-	 * Alias for self::get_code().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_coupon_code( $context = 'view' ) {
-		return $this->get_code( $context );
-	}
-
-	/**
-	 * Alias for self::get_code().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_discount_code( $context = 'view' ) {
-		return $this->get_code( $context );
-	}
-
-	/**
-	 * Get the discount's amount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_amount( $context = 'view' ) {
-		return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context );
-	}
-
-	/**
-	 * Get the discount's formated amount/rate.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_formatted_amount() {
-
-		if ( $this->is_type( 'flat' ) ) {
-			$rate = wpinv_price( $this->get_amount() );
-		} else {
-			$rate = $this->get_amount() . '%';
-		}
-
-		return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() );
-	}
-
-	/**
-	 * Get the discount's start date.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_start( $context = 'view' ) {
-		return $this->get_prop( 'start', $context );
-	}
-
-	/**
-	 * Alias for self::get_start().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_start_date( $context = 'view' ) {
-		return $this->get_start( $context );
-	}
-
-	/**
-	 * Get the discount's expiration date.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_expiration( $context = 'view' ) {
-		return $this->get_prop( 'expiration', $context );
-	}
-
-	/**
-	 * Alias for self::get_expiration().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_expiration_date( $context = 'view' ) {
-		return $this->get_expiration( $context );
-	}
-
-	/**
-	 * Alias for self::get_expiration().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_end_date( $context = 'view' ) {
-		return $this->get_expiration( $context );
-	}
-
-	/**
-	 * Get the discount's type.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
-		return $this->get_prop( 'type', $context );
-	}
-
-	/**
-	 * Get the number of times a discount has been used.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_uses( $context = 'view' ) {
-		return (int) $this->get_prop( 'uses', $context );
-	}
-
-	/**
-	 * Get the discount's usage, i.e uses / max uses.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_usage() {
-
-		if ( ! $this->has_limit() ) {
-			return $this->get_uses() . ' / ' . ' &infin;';
-		}
-
-		return $this->get_uses() . ' / ' . (int) $this->get_max_uses();
-
-	}
-
-	/**
-	 * Get the maximum number of time a discount can be used.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_max_uses( $context = 'view' ) {
-		$max_uses = $this->get_prop( 'max_uses', $context );
-		return empty( $max_uses ) ? null : $max_uses;
-	}
-
-	/**
-	 * Checks if this is a single use discount or not.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_is_single_use( $context = 'view' ) {
-		return $this->get_prop( 'is_single_use', $context );
-	}
-
-	/**
-	 * Get the items that can be used with this discount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_items( $context = 'view' ) {
-		return wpinv_parse_list( $this->get_prop( 'items', $context ) );
-	}
-
-	/**
-	 * Alias for self::get_items().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_allowed_items( $context = 'view' ) {
-		return $this->get_items( $context );
-	}
-
-	/**
-	 * Get the items that are not allowed to use this discount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_excluded_items( $context = 'view' ) {
-		return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) );
-	}
-
-	/**
-	 * Checks if this is a recurring discount or not.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int|string|bool
-	 */
-	public function get_is_recurring( $context = 'view' ) {
-		return $this->get_prop( 'is_recurring', $context );
-	}
-
-	/**
-	 * Get's the minimum total amount allowed for this discount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_min_total( $context = 'view' ) {
-		$minimum = $this->get_prop( 'min_total', $context );
-		return empty( $minimum ) ? null : $minimum;
-	}
-
-	/**
-	 * Alias for self::get_min_total().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_minimum_total( $context = 'view' ) {
-		return $this->get_min_total( $context );
-	}
-
-	/**
-	 * Get's the maximum total amount allowed for this discount.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_max_total( $context = 'view' ) {
-		$maximum = $this->get_prop( 'max_total', $context );
-		return empty( $maximum ) ? null : $maximum;
-	}
-
-	/**
-	 * Alias for self::get_max_total().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_maximum_total( $context = 'view' ) {
-		return $this->get_max_total( $context );
-	}
-
-	/**
-	 * Magic method for accessing discount properties.
-	 *
-	 * @since 1.0.15
-	 * @access public
-	 *
-	 * @param string $key Discount data to retrieve
-	 * @param  string $context View or edit context.
-	 * @return mixed Value of the given discount property (if set).
-	 */
-	public function get( $key, $context = 'view' ) {
+        return $date;
+    }
+
+    /**
+     * Get the discount name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
+    }
+
+    /**
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
+    }
+
+    /**
+     * Get the discount description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+        return $this->get_prop( 'description', $context );
+    }
+
+    /**
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_excerpt( $context = 'view' ) {
+        return $this->get_description( $context );
+    }
+
+    /**
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_summary( $context = 'view' ) {
+        return $this->get_description( $context );
+    }
+
+    /**
+     * Get the owner of the discount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
+    }
+
+    /**
+     * Get the discount code.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_code( $context = 'view' ) {
+        return $this->get_prop( 'code', $context );
+    }
+
+    /**
+     * Alias for self::get_code().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_coupon_code( $context = 'view' ) {
+        return $this->get_code( $context );
+    }
+
+    /**
+     * Alias for self::get_code().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_discount_code( $context = 'view' ) {
+        return $this->get_code( $context );
+    }
+
+    /**
+     * Get the discount's amount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_amount( $context = 'view' ) {
+        return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context );
+    }
+
+    /**
+     * Get the discount's formated amount/rate.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_formatted_amount() {
+
+        if ( $this->is_type( 'flat' ) ) {
+            $rate = wpinv_price( $this->get_amount() );
+        } else {
+            $rate = $this->get_amount() . '%';
+        }
+
+        return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() );
+    }
+
+    /**
+     * Get the discount's start date.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_start( $context = 'view' ) {
+        return $this->get_prop( 'start', $context );
+    }
+
+    /**
+     * Alias for self::get_start().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_start_date( $context = 'view' ) {
+        return $this->get_start( $context );
+    }
+
+    /**
+     * Get the discount's expiration date.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration( $context = 'view' ) {
+        return $this->get_prop( 'expiration', $context );
+    }
+
+    /**
+     * Alias for self::get_expiration().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration_date( $context = 'view' ) {
+        return $this->get_expiration( $context );
+    }
+
+    /**
+     * Alias for self::get_expiration().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_end_date( $context = 'view' ) {
+        return $this->get_expiration( $context );
+    }
+
+    /**
+     * Get the discount's type.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_type( $context = 'view' ) {
+        return $this->get_prop( 'type', $context );
+    }
+
+    /**
+     * Get the number of times a discount has been used.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_uses( $context = 'view' ) {
+        return (int) $this->get_prop( 'uses', $context );
+    }
+
+    /**
+     * Get the discount's usage, i.e uses / max uses.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_usage() {
+
+        if ( ! $this->has_limit() ) {
+            return $this->get_uses() . ' / ' . ' &infin;';
+        }
+
+        return $this->get_uses() . ' / ' . (int) $this->get_max_uses();
+
+    }
+
+    /**
+     * Get the maximum number of time a discount can be used.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_max_uses( $context = 'view' ) {
+        $max_uses = $this->get_prop( 'max_uses', $context );
+        return empty( $max_uses ) ? null : $max_uses;
+    }
+
+    /**
+     * Checks if this is a single use discount or not.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_is_single_use( $context = 'view' ) {
+        return $this->get_prop( 'is_single_use', $context );
+    }
+
+    /**
+     * Get the items that can be used with this discount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_items( $context = 'view' ) {
+        return wpinv_parse_list( $this->get_prop( 'items', $context ) );
+    }
+
+    /**
+     * Alias for self::get_items().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_allowed_items( $context = 'view' ) {
+        return $this->get_items( $context );
+    }
+
+    /**
+     * Get the items that are not allowed to use this discount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_excluded_items( $context = 'view' ) {
+        return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) );
+    }
+
+    /**
+     * Checks if this is a recurring discount or not.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int|string|bool
+     */
+    public function get_is_recurring( $context = 'view' ) {
+        return $this->get_prop( 'is_recurring', $context );
+    }
+
+    /**
+     * Get's the minimum total amount allowed for this discount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_min_total( $context = 'view' ) {
+        $minimum = $this->get_prop( 'min_total', $context );
+        return empty( $minimum ) ? null : $minimum;
+    }
+
+    /**
+     * Alias for self::get_min_total().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_minimum_total( $context = 'view' ) {
+        return $this->get_min_total( $context );
+    }
+
+    /**
+     * Get's the maximum total amount allowed for this discount.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_max_total( $context = 'view' ) {
+        $maximum = $this->get_prop( 'max_total', $context );
+        return empty( $maximum ) ? null : $maximum;
+    }
+
+    /**
+     * Alias for self::get_max_total().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_maximum_total( $context = 'view' ) {
+        return $this->get_max_total( $context );
+    }
+
+    /**
+     * Magic method for accessing discount properties.
+     *
+     * @since 1.0.15
+     * @access public
+     *
+     * @param string $key Discount data to retrieve
+     * @param  string $context View or edit context.
+     * @return mixed Value of the given discount property (if set).
+     */
+    public function get( $key, $context = 'view' ) {
         return $this->get_prop( $key, $context );
-	}
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Setters
 	|--------------------------------------------------------------------------
@@ -727,41 +727,41 @@ 
 	| object.
 	*/
 
-	/**
-	 * Sets discount status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+    /**
+     * Sets discount status.
+     *
+     * @since 1.0.19
+     * @param  string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
         $this->set_prop( 'status', $status );
 
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
     }
 
     /**
-	 * Set plugin version when the discount was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the discount was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the discount was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the discount was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -774,13 +774,13 @@ 
     }
 
     /**
-	 * Set date when the discount was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the discount was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -793,324 +793,324 @@ 
     }
 
     /**
-	 * Set the discount name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the discount name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
         $name = sanitize_text_field( $value );
-		$this->set_prop( 'name', $name );
+        $this->set_prop( 'name', $name );
     }
 
     /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
     }
 
     /**
-	 * Set the discount description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
-        $description = wp_kses_post( $value );
-		return $this->set_prop( 'description', $description );
-    }
-
-    /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_excerpt( $value ) {
-		$this->set_description( $value );
-    }
-
-    /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_summary( $value ) {
-		$this->set_description( $value );
-    }
-
-    /**
-	 * Set the owner of the discount.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
-
-	/**
-	 * Sets the discount code.
-	 *
-	 * @since 1.0.19
-	 * @param string $value New discount code.
-	 */
-	public function set_code( $value ) {
-		$code = sanitize_text_field( $value );
-		$this->set_prop( 'code', $code );
-	}
-
-	/**
-	 * Alias of self::set_code().
-	 *
-	 * @since 1.0.19
-	 * @param string $value New discount code.
-	 */
-	public function set_coupon_code( $value ) {
-		$this->set_code( $value );
-	}
-
-	/**
-	 * Alias of self::set_code().
-	 *
-	 * @since 1.0.19
-	 * @param string $value New discount code.
-	 */
-	public function set_discount_code( $value ) {
-		$this->set_code( $value );
-	}
-
-	/**
-	 * Sets the discount amount.
-	 *
-	 * @since 1.0.19
-	 * @param float $value New discount code.
-	 */
-	public function set_amount( $value ) {
-		$amount = floatval( wpinv_sanitize_amount( $value ) );
-		$this->set_prop( 'amount', $amount );
-	}
-
-	/**
-	 * Sets the discount's start date.
-	 *
-	 * @since 1.0.19
-	 * @param float $value New start date.
-	 */
-	public function set_start( $value ) {
-		$date = strtotime( $value );
+     * Set the discount description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
+        $description = wp_kses_post( $value );
+        return $this->set_prop( 'description', $description );
+    }
+
+    /**
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_excerpt( $value ) {
+        $this->set_description( $value );
+    }
+
+    /**
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_summary( $value ) {
+        $this->set_description( $value );
+    }
+
+    /**
+     * Set the owner of the discount.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
+
+    /**
+     * Sets the discount code.
+     *
+     * @since 1.0.19
+     * @param string $value New discount code.
+     */
+    public function set_code( $value ) {
+        $code = sanitize_text_field( $value );
+        $this->set_prop( 'code', $code );
+    }
+
+    /**
+     * Alias of self::set_code().
+     *
+     * @since 1.0.19
+     * @param string $value New discount code.
+     */
+    public function set_coupon_code( $value ) {
+        $this->set_code( $value );
+    }
+
+    /**
+     * Alias of self::set_code().
+     *
+     * @since 1.0.19
+     * @param string $value New discount code.
+     */
+    public function set_discount_code( $value ) {
+        $this->set_code( $value );
+    }
+
+    /**
+     * Sets the discount amount.
+     *
+     * @since 1.0.19
+     * @param float $value New discount code.
+     */
+    public function set_amount( $value ) {
+        $amount = floatval( wpinv_sanitize_amount( $value ) );
+        $this->set_prop( 'amount', $amount );
+    }
+
+    /**
+     * Sets the discount's start date.
+     *
+     * @since 1.0.19
+     * @param float $value New start date.
+     */
+    public function set_start( $value ) {
+        $date = strtotime( $value );
 
         if ( $date ) {
             $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) );
             return true;
-		}
+        }
 
-		$this->set_prop( 'start', '' );
+        $this->set_prop( 'start', '' );
 
         return false;
-	}
-
-	/**
-	 * Alias of self::set_start().
-	 *
-	 * @since 1.0.19
-	 * @param string $value New start date.
-	 */
-	public function set_start_date( $value ) {
-		$this->set_start( $value );
-	}
-
-	/**
-	 * Sets the discount's expiration date.
-	 *
-	 * @since 1.0.19
-	 * @param float $value New expiration date.
-	 */
-	public function set_expiration( $value ) {
-		$date = strtotime( $value );
+    }
+
+    /**
+     * Alias of self::set_start().
+     *
+     * @since 1.0.19
+     * @param string $value New start date.
+     */
+    public function set_start_date( $value ) {
+        $this->set_start( $value );
+    }
+
+    /**
+     * Sets the discount's expiration date.
+     *
+     * @since 1.0.19
+     * @param float $value New expiration date.
+     */
+    public function set_expiration( $value ) {
+        $date = strtotime( $value );
 
         if ( $date ) {
             $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) );
             return true;
         }
 
-		$this->set_prop( 'expiration', '' );
+        $this->set_prop( 'expiration', '' );
         return false;
-	}
-
-	/**
-	 * Alias of self::set_expiration().
-	 *
-	 * @since 1.0.19
-	 * @param string $value New expiration date.
-	 */
-	public function set_expiration_date( $value ) {
-		$this->set_expiration( $value );
-	}
-
-	/**
-	 * Alias of self::set_expiration().
-	 *
-	 * @since 1.0.19
-	 * @param string $value New expiration date.
-	 */
-	public function set_end_date( $value ) {
-		$this->set_expiration( $value );
-	}
-
-	/**
-	 * Sets the discount type.
-	 *
-	 * @since 1.0.19
-	 * @param string $value New discount type.
-	 */
-	public function set_type( $value ) {
-		if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) {
-			$this->set_prop( 'type', sanitize_text_field( $value ) );
-		}
-	}
-
-	/**
-	 * Sets the number of times a discount has been used.
-	 *
-	 * @since 1.0.19
-	 * @param int $value usage count.
-	 */
-	public function set_uses( $value ) {
-
-		$value = (int) $value;
-
-		if ( $value < 0 ) {
-			$value = 0;
-		}
-
-		$this->set_prop( 'uses', (int) $value );
-	}
-
-	/**
-	 * Sets the maximum number of times a discount can be used.
-	 *
-	 * @since 1.0.19
-	 * @param int $value maximum usage count.
-	 */
-	public function set_max_uses( $value ) {
-		$this->set_prop( 'max_uses', absint( $value ) );
-	}
-
-	/**
-	 * Sets if this is a single use discount or not.
-	 *
-	 * @since 1.0.19
-	 * @param int|bool $value is single use.
-	 */
-	public function set_is_single_use( $value ) {
-		$this->set_prop( 'is_single_use', (bool) $value );
-	}
-
-	/**
-	 * Sets the items that can be used with this discount.
-	 *
-	 * @since 1.0.19
-	 * @param array $value items.
-	 */
-	public function set_items( $value ) {
-		$this->set_prop( 'items', wpinv_parse_list( $value ) );
-	}
-
-	/**
-	 * Alias for self::set_items().
-	 *
-	 * @since 1.0.19
-	 * @param array $value items.
-	 */
-	public function set_allowed_items( $value ) {
-		$this->set_items( $value );
-	}
-
-	/**
-	 * Sets the items that can not be used with this discount.
-	 *
-	 * @since 1.0.19
-	 * @param array $value items.
-	 */
-	public function set_excluded_items( $value ) {
-		$this->set_prop( 'excluded_items', wpinv_parse_list( $value ) );
-	}
-
-	/**
-	 * Sets if this is a recurring discounts or not.
-	 *
-	 * @since 1.0.19
-	 * @param int|bool $value is recurring.
-	 */
-	public function set_is_recurring( $value ) {
-		$this->set_prop( 'is_recurring', (bool) $value );
-	}
-
-	/**
-	 * Sets the minimum total that can not be used with this discount.
-	 *
-	 * @since 1.0.19
-	 * @param float $value minimum total.
-	 */
-	public function set_min_total( $value ) {
-		$this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Alias for self::set_min_total().
-	 *
-	 * @since 1.0.19
-	 * @param float $value minimum total.
-	 */
-	public function set_minimum_total( $value ) {
-		$this->set_min_total( $value );
-	}
-
-	/**
-	 * Sets the maximum total that can not be used with this discount.
-	 *
-	 * @since 1.0.19
-	 * @param float $value maximum total.
-	 */
-	public function set_max_total( $value ) {
-		$this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Alias for self::set_max_total().
-	 *
-	 * @since 1.0.19
-	 * @param float $value maximum total.
-	 */
-	public function set_maximum_total( $value ) {
-		$this->set_max_total( $value );
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function refresh(){}
-
-	/**
-	 * @deprecated
-	 *
-	 */
-	public function update_status( $status = 'publish' ){
-
-		if ( $this->exists() && $this->get_status() != $status ) {
-			$this->set_status( $status );
-			$this->save();
-		}
-
-	}
-
-	/*
+    }
+
+    /**
+     * Alias of self::set_expiration().
+     *
+     * @since 1.0.19
+     * @param string $value New expiration date.
+     */
+    public function set_expiration_date( $value ) {
+        $this->set_expiration( $value );
+    }
+
+    /**
+     * Alias of self::set_expiration().
+     *
+     * @since 1.0.19
+     * @param string $value New expiration date.
+     */
+    public function set_end_date( $value ) {
+        $this->set_expiration( $value );
+    }
+
+    /**
+     * Sets the discount type.
+     *
+     * @since 1.0.19
+     * @param string $value New discount type.
+     */
+    public function set_type( $value ) {
+        if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) {
+            $this->set_prop( 'type', sanitize_text_field( $value ) );
+        }
+    }
+
+    /**
+     * Sets the number of times a discount has been used.
+     *
+     * @since 1.0.19
+     * @param int $value usage count.
+     */
+    public function set_uses( $value ) {
+
+        $value = (int) $value;
+
+        if ( $value < 0 ) {
+            $value = 0;
+        }
+
+        $this->set_prop( 'uses', (int) $value );
+    }
+
+    /**
+     * Sets the maximum number of times a discount can be used.
+     *
+     * @since 1.0.19
+     * @param int $value maximum usage count.
+     */
+    public function set_max_uses( $value ) {
+        $this->set_prop( 'max_uses', absint( $value ) );
+    }
+
+    /**
+     * Sets if this is a single use discount or not.
+     *
+     * @since 1.0.19
+     * @param int|bool $value is single use.
+     */
+    public function set_is_single_use( $value ) {
+        $this->set_prop( 'is_single_use', (bool) $value );
+    }
+
+    /**
+     * Sets the items that can be used with this discount.
+     *
+     * @since 1.0.19
+     * @param array $value items.
+     */
+    public function set_items( $value ) {
+        $this->set_prop( 'items', wpinv_parse_list( $value ) );
+    }
+
+    /**
+     * Alias for self::set_items().
+     *
+     * @since 1.0.19
+     * @param array $value items.
+     */
+    public function set_allowed_items( $value ) {
+        $this->set_items( $value );
+    }
+
+    /**
+     * Sets the items that can not be used with this discount.
+     *
+     * @since 1.0.19
+     * @param array $value items.
+     */
+    public function set_excluded_items( $value ) {
+        $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) );
+    }
+
+    /**
+     * Sets if this is a recurring discounts or not.
+     *
+     * @since 1.0.19
+     * @param int|bool $value is recurring.
+     */
+    public function set_is_recurring( $value ) {
+        $this->set_prop( 'is_recurring', (bool) $value );
+    }
+
+    /**
+     * Sets the minimum total that can not be used with this discount.
+     *
+     * @since 1.0.19
+     * @param float $value minimum total.
+     */
+    public function set_min_total( $value ) {
+        $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Alias for self::set_min_total().
+     *
+     * @since 1.0.19
+     * @param float $value minimum total.
+     */
+    public function set_minimum_total( $value ) {
+        $this->set_min_total( $value );
+    }
+
+    /**
+     * Sets the maximum total that can not be used with this discount.
+     *
+     * @since 1.0.19
+     * @param float $value maximum total.
+     */
+    public function set_max_total( $value ) {
+        $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Alias for self::set_max_total().
+     *
+     * @since 1.0.19
+     * @param float $value maximum total.
+     */
+    public function set_maximum_total( $value ) {
+        $this->set_max_total( $value );
+    }
+
+    /**
+     * @deprecated
+     */
+    public function refresh(){}
+
+    /**
+     * @deprecated
+     *
+     */
+    public function update_status( $status = 'publish' ){
+
+        if ( $this->exists() && $this->get_status() != $status ) {
+            $this->set_status( $status );
+            $this->save();
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Conditionals
 	|--------------------------------------------------------------------------
@@ -1119,263 +1119,263 @@ 
 	|
 	*/
 
-	/**
-	 * Checks whether a discount exists in the database or not
-	 *
-	 * @since 1.0.15
-	 */
-	public function exists(){
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
-
-	/**
-	 * Checks the discount type.
-	 *
-	 *
-	 * @param  string $type the discount type to check against
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function is_type( $type ) {
-		return $this->get_type() == $type;
-	}
-
-	/**
-	 * Checks whether the discount is published or not
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->get_status() == 'publish';
-	}
-
-	/**
-	 * Checks whether the discount has max uses
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_limit() {
-		$limit = $this->get_max_uses();
-		return ! empty( $limit );
-	}
-
-	/**
-	 * Checks whether the discount has ever been used.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_uses() {
-		return $this->get_uses() > 0;
-	}
-
-	/**
-	 * Checks whether the discount is has exided the usage limit or not
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_exceeded_limit() {
-
-		if ( ! $this->has_limit() || ! $this->has_uses() ) {
-			$exceeded = false ;
-		} else {
-			$exceeded = (int) $this->get_max_uses() <= $this->get_uses();
-		}
-
-		return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() );
-	}
-
-	/**
-	 * Checks whether the discount has an expiration date.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_expiration_date() {
-		$date = $this->get_expiration_date();
-		return ! empty( $date );
-	}
-
-	/**
-	 * Checks if the discount is expired
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function is_expired() {
-		$expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false;
-		return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() );
-	}
-
-	/**
-	 * Checks whether the discount has a start date.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_start_date() {
-		$date = $this->get_start_date();
-		return ! empty( $date );
-	}
-
-	/**
-	 * Checks the discount start date.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_started() {
-		$started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() );
-		return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() );
-	}
-
-	/**
-	 * Checks the discount has allowed items or not.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_allowed_items() {
-		$allowed_items = $this->get_allowed_items();
-		return ! empty( $allowed_items );
-	}
-
-	/**
-	 * Checks the discount has excluded items or not.
-	 *
-	 * @since 1.0.15
-	 * @return bool
-	 */
-	public function has_excluded_items() {
-		$excluded_items = $this->get_excluded_items();
-		return ! empty( $excluded_items );
-	}
-
-	/**
-	 * Check if a discount is valid for a given item id.
-	 *
-	 * @param  int|int[]  $item_ids
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_valid_for_items( $item_ids ) {
-
-		$item_ids = wp_parse_id_list( $item_ids );
-		$included = array_intersect( $item_ids, $this->get_allowed_items() );
-		$excluded = array_intersect( $item_ids, $this->get_excluded_items() );
-
-		if ( $this->has_excluded_items() && ! empty( $excluded ) ) {
-			return false;
-		}
-
-		if ( $this->has_allowed_items() && empty( $included ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a discount is valid for the given amount
-	 *
-	 * @param  float  $amount The amount to check against
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_valid_for_amount( $amount ) {
-		return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount );
-	}
-
-	/**
-	 * Checks if the minimum amount is set
-	 *
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function has_minimum_amount() {
-		$minimum = $this->get_minimum_total();
-		return ! empty( $minimum );
-	}
-
-	/**
-	 * Checks if the minimum amount is met
-	 *
-	 * @param  float  $amount The amount to check against
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_minimum_amount_met( $amount ) {
-		$amount = floatval( wpinv_sanitize_amount( $amount ) );
-		$min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) );
-		return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount );
-	}
-
-	/**
-	 * Checks if the maximum amount is set
-	 *
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function has_maximum_amount() {
-		$maximum = $this->get_maximum_total();
-		return ! empty( $maximum );
-	}
-
-	/**
-	 * Checks if the maximum amount is met
-	 *
-	 * @param  float  $amount The amount to check against
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_maximum_amount_met( $amount ) {
-		$amount = floatval( wpinv_sanitize_amount( $amount ) );
-		$max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) );
-		return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount );
-	}
-
-	/**
-	 * Checks if the discount is recurring.
-	 *
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_recurring() {
-		$recurring = $this->get_is_recurring();
-		return ! empty( $recurring );
-	}
-
-	/**
-	 * Checks if the discount is single use.
-	 *
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_single_use() {
-		$usage = $this->get_is_single_use();
-		return ! empty( $usage );
-	}
-
-	/**
-	 * Check if a discount is valid for the given user
-	 *
-	 * @param  int|string  $user
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function is_valid_for_user( $user ) {
-
-		// Ensure that the discount is single use.
-		if ( empty( $user ) || ! $this->is_single_use() ) {
-			return true;
-		}
-
-		// Prepare the user id.
-		$user_id = 0;
+    /**
+     * Checks whether a discount exists in the database or not
+     *
+     * @since 1.0.15
+     */
+    public function exists(){
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
+
+    /**
+     * Checks the discount type.
+     *
+     *
+     * @param  string $type the discount type to check against
+     * @since 1.0.15
+     * @return bool
+     */
+    public function is_type( $type ) {
+        return $this->get_type() == $type;
+    }
+
+    /**
+     * Checks whether the discount is published or not
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function is_active() {
+        return $this->get_status() == 'publish';
+    }
+
+    /**
+     * Checks whether the discount has max uses
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_limit() {
+        $limit = $this->get_max_uses();
+        return ! empty( $limit );
+    }
+
+    /**
+     * Checks whether the discount has ever been used.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_uses() {
+        return $this->get_uses() > 0;
+    }
+
+    /**
+     * Checks whether the discount is has exided the usage limit or not
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_exceeded_limit() {
+
+        if ( ! $this->has_limit() || ! $this->has_uses() ) {
+            $exceeded = false ;
+        } else {
+            $exceeded = (int) $this->get_max_uses() <= $this->get_uses();
+        }
+
+        return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() );
+    }
+
+    /**
+     * Checks whether the discount has an expiration date.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_expiration_date() {
+        $date = $this->get_expiration_date();
+        return ! empty( $date );
+    }
+
+    /**
+     * Checks if the discount is expired
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function is_expired() {
+        $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false;
+        return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() );
+    }
+
+    /**
+     * Checks whether the discount has a start date.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_start_date() {
+        $date = $this->get_start_date();
+        return ! empty( $date );
+    }
+
+    /**
+     * Checks the discount start date.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_started() {
+        $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() );
+        return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() );
+    }
+
+    /**
+     * Checks the discount has allowed items or not.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_allowed_items() {
+        $allowed_items = $this->get_allowed_items();
+        return ! empty( $allowed_items );
+    }
+
+    /**
+     * Checks the discount has excluded items or not.
+     *
+     * @since 1.0.15
+     * @return bool
+     */
+    public function has_excluded_items() {
+        $excluded_items = $this->get_excluded_items();
+        return ! empty( $excluded_items );
+    }
+
+    /**
+     * Check if a discount is valid for a given item id.
+     *
+     * @param  int|int[]  $item_ids
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_valid_for_items( $item_ids ) {
+
+        $item_ids = wp_parse_id_list( $item_ids );
+        $included = array_intersect( $item_ids, $this->get_allowed_items() );
+        $excluded = array_intersect( $item_ids, $this->get_excluded_items() );
+
+        if ( $this->has_excluded_items() && ! empty( $excluded ) ) {
+            return false;
+        }
+
+        if ( $this->has_allowed_items() && empty( $included ) ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a discount is valid for the given amount
+     *
+     * @param  float  $amount The amount to check against
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_valid_for_amount( $amount ) {
+        return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount );
+    }
+
+    /**
+     * Checks if the minimum amount is set
+     *
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function has_minimum_amount() {
+        $minimum = $this->get_minimum_total();
+        return ! empty( $minimum );
+    }
+
+    /**
+     * Checks if the minimum amount is met
+     *
+     * @param  float  $amount The amount to check against
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_minimum_amount_met( $amount ) {
+        $amount = floatval( wpinv_sanitize_amount( $amount ) );
+        $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) );
+        return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount );
+    }
+
+    /**
+     * Checks if the maximum amount is set
+     *
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function has_maximum_amount() {
+        $maximum = $this->get_maximum_total();
+        return ! empty( $maximum );
+    }
+
+    /**
+     * Checks if the maximum amount is met
+     *
+     * @param  float  $amount The amount to check against
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_maximum_amount_met( $amount ) {
+        $amount = floatval( wpinv_sanitize_amount( $amount ) );
+        $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) );
+        return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount );
+    }
+
+    /**
+     * Checks if the discount is recurring.
+     *
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_recurring() {
+        $recurring = $this->get_is_recurring();
+        return ! empty( $recurring );
+    }
+
+    /**
+     * Checks if the discount is single use.
+     *
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_single_use() {
+        $usage = $this->get_is_single_use();
+        return ! empty( $usage );
+    }
+
+    /**
+     * Check if a discount is valid for the given user
+     *
+     * @param  int|string  $user
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function is_valid_for_user( $user ) {
+
+        // Ensure that the discount is single use.
+        if ( empty( $user ) || ! $this->is_single_use() ) {
+            return true;
+        }
+
+        // Prepare the user id.
+        $user_id = 0;
         if ( is_numeric( $user ) ) {
             $user_id = absint( $user );
         } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) {
@@ -1384,117 +1384,117 @@ 
             $user_id = $user_data->ID;
         }
 
-		// Ensure that we have a user.
-		if ( empty( $user_id ) ) {
-			return true;
-		}
+        // Ensure that we have a user.
+        if ( empty( $user_id ) ) {
+            return true;
+        }
 
-		// Get all payments with matching user id.
+        // Get all payments with matching user id.
         $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) );
-		$code     = strtolower( $this->get_code() );
-
-		// For each payment...
-		foreach ( $payments as $payment ) {
-
-			// Only check for paid invoices.
-			if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) {
-				return false;
-			}
-
-		}
-
-		return true;
-	}
-
-	/**
-	 * Deletes the discount from the database
-	 *
-	 * @since 1.0.15
-	 * @return boolean
-	 */
-	public function remove() {
-		return $this->delete();
-	}
-
-	/**
-	 * Increases a discount's usage.
-	 *
-	 * @since 1.0.15
-	 * @param int $by The number of usages to increas by.
-	 * @return int
-	 */
-	public function increase_usage( $by = 1 ) {
-
-		// Abort if zero.
-		if ( empty( $by ) ) {
-			return;
-		}
-
-		// Increase the usage.
-		$this->set_uses( $this->get_uses() + (int) $by );
-
-		// Save the discount.
-		$this->save();
-
-		// Fire relevant hooks.
-		if( (int) $by > 0 ) {
-			do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(),  absint( $by ) );
-		} else {
-			do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) );
-		}
-
-		// Return the number of times the discount has been used.
-		return $this->get_uses();
-	}
-
-	/**
-	 * Alias of self::__toString()
-	 *
-	 * @since 1.0.15
-	 * @return string|false
-	 */
-	public function get_data_as_json() {
-		return $this->__toString();
-	}
-
-	/**
-	 * Returns a discount's discounted amount.
-	 *
-	 * @since 1.0.15
-	 * @param float $amount
-	 * @return float
-	 */
-	public function get_discounted_amount( $amount ) {
-
-		// Convert amount to float.
-		$amount = (float) $amount;
-
-		// Get discount amount.
-		$discount_amount = $this->get_amount();
-
-		if ( empty( $discount_amount ) ) {
-			return 0;
-		}
-
-		// Format the amount.
-		$discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) );
-
-		// If this is a percentage discount.
-		if ( $this->is_type( 'percent' ) ) {
+        $code     = strtolower( $this->get_code() );
+
+        // For each payment...
+        foreach ( $payments as $payment ) {
+
+            // Only check for paid invoices.
+            if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) {
+                return false;
+            }
+
+        }
+
+        return true;
+    }
+
+    /**
+     * Deletes the discount from the database
+     *
+     * @since 1.0.15
+     * @return boolean
+     */
+    public function remove() {
+        return $this->delete();
+    }
+
+    /**
+     * Increases a discount's usage.
+     *
+     * @since 1.0.15
+     * @param int $by The number of usages to increas by.
+     * @return int
+     */
+    public function increase_usage( $by = 1 ) {
+
+        // Abort if zero.
+        if ( empty( $by ) ) {
+            return;
+        }
+
+        // Increase the usage.
+        $this->set_uses( $this->get_uses() + (int) $by );
+
+        // Save the discount.
+        $this->save();
+
+        // Fire relevant hooks.
+        if( (int) $by > 0 ) {
+            do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(),  absint( $by ) );
+        } else {
+            do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) );
+        }
+
+        // Return the number of times the discount has been used.
+        return $this->get_uses();
+    }
+
+    /**
+     * Alias of self::__toString()
+     *
+     * @since 1.0.15
+     * @return string|false
+     */
+    public function get_data_as_json() {
+        return $this->__toString();
+    }
+
+    /**
+     * Returns a discount's discounted amount.
+     *
+     * @since 1.0.15
+     * @param float $amount
+     * @return float
+     */
+    public function get_discounted_amount( $amount ) {
+
+        // Convert amount to float.
+        $amount = (float) $amount;
+
+        // Get discount amount.
+        $discount_amount = $this->get_amount();
+
+        if ( empty( $discount_amount ) ) {
+            return 0;
+        }
+
+        // Format the amount.
+        $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) );
+
+        // If this is a percentage discount.
+        if ( $this->is_type( 'percent' ) ) {
             $discount_amount = $amount * ( $discount_amount / 100 );
-		}
+        }
 
-		// Discount can not be less than zero...
-		if ( $discount_amount < 0 ) {
-			$discount_amount = 0;
-		}
+        // Discount can not be less than zero...
+        if ( $discount_amount < 0 ) {
+            $discount_amount = 0;
+        }
 
-		// ... or more than the amount.
-		if ( $discount_amount > $amount ) {
-			$discount_amount = $amount;
-		}
+        // ... or more than the amount.
+        if ( $discount_amount > $amount ) {
+            $discount_amount = $amount;
+        }
 
-		return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this );
-	}
+        return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this );
+    }
 
 }