AyeCode / invoicing

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

Indentation +807 added lines, -807 removed lines

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

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

Indentation +233 added lines, -233 removed lines

@@ -12,281 +12,281 @@
  */
 class GetPaid_Payment_Form_Submission_Refresh_Prices {
 
-	/**
-	 * Contains the response for refreshing prices.
-	 * @var array
-	 */
-	public $response = array();
+    /**
+     * Contains the response for refreshing prices.
+     * @var array
+     */
+    public $response = array();
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$this->response = array(
-			'submission_id'              => $submission->id,
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $this->response = array(
+            'submission_id'              => $submission->id,
             'has_recurring'              => $submission->has_recurring,
-			'has_multiple_subscriptions' => $submission->has_recurring && 1 < count( getpaid_get_subscription_groups( $submission ) ),
+            'has_multiple_subscriptions' => $submission->has_recurring && 1 < count( getpaid_get_subscription_groups( $submission ) ),
             'is_free'                    => ! $submission->should_collect_payment_details(),
-		);
-
-		$this->add_totals( $submission );
-		$this->add_texts( $submission );
-		$this->add_items( $submission );
-		$this->add_fees( $submission );
-		$this->add_discounts( $submission );
-		$this->add_taxes( $submission );
-		$this->add_gateways( $submission );
-		$this->add_data( $submission );
-
-	}
-
-	/**
-	 * Adds totals to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_totals( $submission ) {
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-
-				'totals'        => array(
-					'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
-					'discount'  => $submission->format_amount( $submission->get_discount() ),
-					'fees'      => $submission->format_amount( $submission->get_fee() ),
-					'tax'       => $submission->format_amount( $submission->get_tax() ),
-					'total'     => $submission->format_amount( $submission->get_total() ),
-					'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
-				),
-
-				'recurring'     => array(
-					'subtotal'  => $submission->format_amount( $submission->get_recurring_subtotal() ),
-					'discount'  => $submission->format_amount( $submission->get_recurring_discount() ),
-					'fees'      => $submission->format_amount( $submission->get_recurring_fee() ),
-					'tax'       => $submission->format_amount( $submission->get_recurring_tax() ),
-					'total'     => $submission->format_amount( $submission->get_recurring_total() ),
-				),
-
-				'initial_amt'   => wpinv_round_amount( $submission->get_total(), null, true ),
-				'currency'      => $submission->get_currency(),
-
-			)
-		);
-
-	}
-
-	/**
-	 * Adds texts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_texts( $submission ) {
-
-		$payable = $submission->format_amount( $submission->get_total() );
-		$groups  = getpaid_get_subscription_groups( $submission );
-
-		if ( $submission->has_recurring != 0 && 2 > $groups ) {
-
-			$recurring = new WPInv_Item( $submission->has_recurring );
-			$period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
-
-			if ( $submission->get_total() == $submission->get_recurring_total() ) {
-				$payable = "$payable / $period";
-			} else {
-				$payable = sprintf(
-					__( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
-					$submission->format_amount( $submission->get_total() ),
-					$submission->format_amount( $submission->get_recurring_total() ),
-					$period
-				);
-			}
-
-		}
-
-		$texts = array(
-			'.getpaid-checkout-total-payable' => $payable,
-		);
-
-		foreach ( $submission->get_items() as $item ) {
-			$item_id                                               = $item->get_id();
-			$initial_price                                         = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_sub_total(), $submission->get_discount_code(), false ) );
-			$recurring_price                                       = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_recurring_sub_total(), $submission->get_discount_code(), true ) );
-			$texts[".item-$item_id .getpaid-form-item-price-desc"] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
-		}
-
-		$this->response = array_merge( $this->response, array( 'texts' => $texts ) );
-
-	}
-
-	/**
-	 * Adds items to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_items( $submission ) {
-
-		// Add items.
-		$items = array();
+        );
+
+        $this->add_totals( $submission );
+        $this->add_texts( $submission );
+        $this->add_items( $submission );
+        $this->add_fees( $submission );
+        $this->add_discounts( $submission );
+        $this->add_taxes( $submission );
+        $this->add_gateways( $submission );
+        $this->add_data( $submission );
+
+    }
+
+    /**
+     * Adds totals to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_totals( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+
+                'totals'        => array(
+                    'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
+                    'discount'  => $submission->format_amount( $submission->get_discount() ),
+                    'fees'      => $submission->format_amount( $submission->get_fee() ),
+                    'tax'       => $submission->format_amount( $submission->get_tax() ),
+                    'total'     => $submission->format_amount( $submission->get_total() ),
+                    'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
+                ),
+
+                'recurring'     => array(
+                    'subtotal'  => $submission->format_amount( $submission->get_recurring_subtotal() ),
+                    'discount'  => $submission->format_amount( $submission->get_recurring_discount() ),
+                    'fees'      => $submission->format_amount( $submission->get_recurring_fee() ),
+                    'tax'       => $submission->format_amount( $submission->get_recurring_tax() ),
+                    'total'     => $submission->format_amount( $submission->get_recurring_total() ),
+                ),
+
+                'initial_amt'   => wpinv_round_amount( $submission->get_total(), null, true ),
+                'currency'      => $submission->get_currency(),
+
+            )
+        );
+
+    }
+
+    /**
+     * Adds texts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_texts( $submission ) {
+
+        $payable = $submission->format_amount( $submission->get_total() );
+        $groups  = getpaid_get_subscription_groups( $submission );
+
+        if ( $submission->has_recurring != 0 && 2 > $groups ) {
+
+            $recurring = new WPInv_Item( $submission->has_recurring );
+            $period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
+
+            if ( $submission->get_total() == $submission->get_recurring_total() ) {
+                $payable = "$payable / $period";
+            } else {
+                $payable = sprintf(
+                    __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
+                    $submission->format_amount( $submission->get_total() ),
+                    $submission->format_amount( $submission->get_recurring_total() ),
+                    $period
+                );
+            }
+
+        }
+
+        $texts = array(
+            '.getpaid-checkout-total-payable' => $payable,
+        );
 
         foreach ( $submission->get_items() as $item ) {
-			$item_id           = $item->get_id();
-			$items["$item_id"] = $submission->format_amount( $item->get_sub_total() );
-		}
+            $item_id                                               = $item->get_id();
+            $initial_price                                         = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_sub_total(), $submission->get_discount_code(), false ) );
+            $recurring_price                                       = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_recurring_sub_total(), $submission->get_discount_code(), true ) );
+            $texts[".item-$item_id .getpaid-form-item-price-desc"] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'items' => $items )
-		);
+        $this->response = array_merge( $this->response, array( 'texts' => $texts ) );
 
-	}
+    }
 
-	/**
-	 * Adds fees to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_fees( $submission ) {
+    /**
+     * Adds items to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_items( $submission ) {
 
-		$fees = array();
+        // Add items.
+        $items = array();
 
-        foreach ( $submission->get_fees() as $name => $data ) {
-			$fees[$name] = $submission->format_amount( $data['initial_fee'] );
-		}
+        foreach ( $submission->get_items() as $item ) {
+            $item_id           = $item->get_id();
+            $items["$item_id"] = $submission->format_amount( $item->get_sub_total() );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'fees' => $fees )
-		);
+        $this->response = array_merge(
+            $this->response,
+            array( 'items' => $items )
+        );
 
-	}
+    }
 
-	/**
-	 * Adds discounts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_discounts( $submission ) {
+    /**
+     * Adds fees to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_fees( $submission ) {
 
-		$discounts = array();
+        $fees = array();
 
-        foreach ( $submission->get_discounts() as $name => $data ) {
-			$discounts[$name] = $submission->format_amount( $data['initial_discount'] );
-		}
+        foreach ( $submission->get_fees() as $name => $data ) {
+            $fees[$name] = $submission->format_amount( $data['initial_fee'] );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'discounts' => $discounts )
-		);
+        $this->response = array_merge(
+            $this->response,
+            array( 'fees' => $fees )
+        );
 
-	}
+    }
 
-	/**
-	 * Adds taxes to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_taxes( $submission ) {
+    /**
+     * Adds discounts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_discounts( $submission ) {
 
-		$taxes  = array();
-		$markup = '';
-        foreach ( $submission->get_taxes() as $name => $data ) {
-			$name          = sanitize_text_field( $name );
-			$amount        = $submission->format_amount( $data['initial_tax'] );
-			$taxes[$name]  = $amount;
-			$markup       .= "<small class='form-text'>$name : $amount</small>";
-		}
+        $discounts = array();
+
+        foreach ( $submission->get_discounts() as $name => $data ) {
+            $discounts[$name] = $submission->format_amount( $data['initial_discount'] );
+        }
 
-		if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) {
-			$this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup;
-		}
+        $this->response = array_merge(
+            $this->response,
+            array( 'discounts' => $discounts )
+        );
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'taxes' => $taxes )
-		);
+    }
 
-	}
+    /**
+     * Adds taxes to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_taxes( $submission ) {
+
+        $taxes  = array();
+        $markup = '';
+        foreach ( $submission->get_taxes() as $name => $data ) {
+            $name          = sanitize_text_field( $name );
+            $amount        = $submission->format_amount( $data['initial_tax'] );
+            $taxes[$name]  = $amount;
+            $markup       .= "<small class='form-text'>$name : $amount</small>";
+        }
 
-	/**
-	 * Adds gateways to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_gateways( $submission ) {
+        if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) {
+            $this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup;
+        }
 
-		$gateways = array_keys( wpinv_get_enabled_payment_gateways() );
+        $this->response = array_merge(
+            $this->response,
+            array( 'taxes' => $taxes )
+        );
 
-		if ( $this->response['has_recurring'] ) {
+    }
 
-			foreach ( $gateways as $i => $gateway ) {
+    /**
+     * Adds gateways to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_gateways( $submission ) {
 
-				if ( ! getpaid_payment_gateway_supports( $gateway, 'subscription' ) || ( $this->response['has_multiple_subscriptions'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscriptions' ) ) ) {
-					unset( $gateways[ $i ] );
-				}
+        $gateways = array_keys( wpinv_get_enabled_payment_gateways() );
 
-			}
+        if ( $this->response['has_recurring'] ) {
 
-		}
+            foreach ( $gateways as $i => $gateway ) {
 
-		$gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
-		$this->response = array_merge(
-			$this->response,
-			array( 'gateways' => $gateways )
-		);
+                if ( ! getpaid_payment_gateway_supports( $gateway, 'subscription' ) || ( $this->response['has_multiple_subscriptions'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscriptions' ) ) ) {
+                    unset( $gateways[ $i ] );
+                }
 
-	}
+            }
 
-	/**
-	 * Standardizes prices.
-	 *
-	 * @param int $item_id
-	 * @param float $item_total
-	 * @param string $discount_code
-	 * @param bool $recurring
-	 */
-	public function standardize_price( $item_id, $item_total, $discount_code, $recurring = false ) {
+        }
 
-		$standardadized_price = $item_total;
+        $gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
+        $this->response = array_merge(
+            $this->response,
+            array( 'gateways' => $gateways )
+        );
 
-		// Do we have a $discount_code?
-		if ( ! empty( $discount_code ) ) {
+    }
 
-			$discount = new WPInv_Discount( $discount_code );
+    /**
+     * Standardizes prices.
+     *
+     * @param int $item_id
+     * @param float $item_total
+     * @param string $discount_code
+     * @param bool $recurring
+     */
+    public function standardize_price( $item_id, $item_total, $discount_code, $recurring = false ) {
+
+        $standardadized_price = $item_total;
 
-			if ( $discount->exists() && $discount->is_valid_for_items( $item_id ) && ( ! $recurring || $discount->is_recurring() ) ) {
-				$standardadized_price = $item_total - $discount->get_discounted_amount( $item_total );
-			}
+        // Do we have a $discount_code?
+        if ( ! empty( $discount_code ) ) {
 
-		}
+            $discount = new WPInv_Discount( $discount_code );
 
-    	return max( 0, $standardadized_price );
+            if ( $discount->exists() && $discount->is_valid_for_items( $item_id ) && ( ! $recurring || $discount->is_recurring() ) ) {
+                $standardadized_price = $item_total - $discount->get_discounted_amount( $item_total );
+            }
 
-	}
+        }
 
-	/**
-	 * Adds data to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_data( $submission ) {
+        return max( 0, $standardadized_price );
 
-		$this->response = array_merge(
-			$this->response,
-			array(
-				'js_data' => apply_filters(
-					'getpaid_submission_js_data',
-					array(
-						'is_recurring' => $this->response['has_recurring'],
-					),
-					$submission
-				)
-			)
-		);
+    }
 
-	}
+    /**
+     * Adds data to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_data( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+                'js_data' => apply_filters(
+                    'getpaid_submission_js_data',
+                    array(
+                        'is_recurring' => $this->response['has_recurring'],
+                    ),
+                    $submission
+                )
+            )
+        );
+
+    }
 
 }

includes/gateways/class-getpaid-manual-gateway.php

Indentation +38 added lines, -38 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'manual';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'addons', 'multiple_subscriptions' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 11;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 11;
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title        = __( 'Test Gateway', 'invoicing' );
@@ -46,15 +46,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Mark it as paid.
         $invoice->mark_paid();
@@ -68,13 +68,13 @@ 
     }
 
     /**
-	 * (Maybe) renews a manual subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+     * (Maybe) renews a manual subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {
@@ -102,13 +102,13 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
 
         foreach ( $items as $item ) {
             $invoice->add_item( $item );

includes/gateways/class-getpaid-payment-gateway.php

Indentation +601 added lines, -601 removed lines

@@ -13,461 +13,461 @@ 
  */
 abstract class GetPaid_Payment_Gateway {
 
-	/**
-	 * Set if the place checkout button should be renamed on selection.
-	 *
-	 * @var string
-	 */
-	public $checkout_button_text;
-
-	/**
-	 * Boolean whether the method is enabled.
-	 *
-	 * @var bool
-	 */
-	public $enabled = true;
-
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	public $id;
-
-	/**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 10;
-
-	/**
-	 * Payment method title for the frontend.
-	 *
-	 * @var string
-	 */
-	public $title;
-
-	/**
-	 * Payment method description for the frontend.
-	 *
-	 * @var string
-	 */
-	public $description;
-
-	/**
-	 * Gateway title.
-	 *
-	 * @var string
-	 */
-	public $method_title = '';
-
-	/**
-	 * Gateway description.
-	 *
-	 * @var string
-	 */
-	public $method_description = '';
-
-	/**
-	 * Countries this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $countries;
-
-	/**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies;
-
-	/**
-	 * Currencies this gateway is not allowed for.
-	 *
-	 * @var array
-	 */
-	public $exclude_currencies;
-
-	/**
-	 * Maximum transaction amount, zero does not define a maximum.
-	 *
-	 * @var int
-	 */
-	public $max_amount = 0;
-
-	/**
-	 * Optional URL to view a transaction.
-	 *
-	 * @var string
-	 */
-	public $view_transaction_url = '';
-
-	/**
-	 * Optional URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = '';
-
-	/**
-	 * Optional label to show for "new payment method" in the payment
-	 * method/token selection radio selection.
-	 *
-	 * @var string
-	 */
-	public $new_method_label = '';
-
-	/**
-	 * Contains a user's saved tokens for this gateway.
-	 *
-	 * @var array
-	 */
-	protected $tokens = array();
-
-	/**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
-	protected $supports = array();
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Register gateway.
-		add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
-
-		$this->enabled = wpinv_is_gateway_active( $this->id );
-
-		// Add support for various features.
-		foreach ( $this->supports as $feature ) {
-			add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' );
-		}
-
-		// Invoice addons.
-		if ( $this->supports( 'addons' ) ) {
-			add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 );
-		}
-
-		// Gateway settings.
-		add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
+    /**
+     * Set if the place checkout button should be renamed on selection.
+     *
+     * @var string
+     */
+    public $checkout_button_text;
+
+    /**
+     * Boolean whether the method is enabled.
+     *
+     * @var bool
+     */
+    public $enabled = true;
+
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 10;
+
+    /**
+     * Payment method title for the frontend.
+     *
+     * @var string
+     */
+    public $title;
+
+    /**
+     * Payment method description for the frontend.
+     *
+     * @var string
+     */
+    public $description;
+
+    /**
+     * Gateway title.
+     *
+     * @var string
+     */
+    public $method_title = '';
+
+    /**
+     * Gateway description.
+     *
+     * @var string
+     */
+    public $method_description = '';
+
+    /**
+     * Countries this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $countries;
+
+    /**
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies;
+
+    /**
+     * Currencies this gateway is not allowed for.
+     *
+     * @var array
+     */
+    public $exclude_currencies;
+
+    /**
+     * Maximum transaction amount, zero does not define a maximum.
+     *
+     * @var int
+     */
+    public $max_amount = 0;
+
+    /**
+     * Optional URL to view a transaction.
+     *
+     * @var string
+     */
+    public $view_transaction_url = '';
+
+    /**
+     * Optional URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = '';
+
+    /**
+     * Optional label to show for "new payment method" in the payment
+     * method/token selection radio selection.
+     *
+     * @var string
+     */
+    public $new_method_label = '';
+
+    /**
+     * Contains a user's saved tokens for this gateway.
+     *
+     * @var array
+     */
+    protected $tokens = array();
+
+    /**
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
+    protected $supports = array();
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Register gateway.
+        add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
+
+        $this->enabled = wpinv_is_gateway_active( $this->id );
+
+        // Add support for various features.
+        foreach ( $this->supports as $feature ) {
+            add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' );
+        }
+
+        // Invoice addons.
+        if ( $this->supports( 'addons' ) ) {
+            add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 );
+        }
+
+        // Gateway settings.
+        add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
 		
 
-		// Gateway checkout fiellds.
-		add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
-
-		// Process payment.
-		add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+        // Gateway checkout fiellds.
+        add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
+
+        // Process payment.
+        add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+
+        // Change the checkout button text.
+        if ( ! empty( $this->checkout_button_text ) ) {
+            add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
+        }
+
+        // Check if a gateway is valid for a given currency.
+        add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
+
+        // Generate the transaction url.
+        add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
+
+        // Generate the subscription url.
+        add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 );
+
+        // Confirm payments.
+        add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
+
+        // Verify IPNs.
+        add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
+
+    }
+
+    /**
+     * Checks if this gateway is a given gateway.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is( $gateway ) {
+        return $gateway == $this->id;
+    }
+
+    /**
+     * Returns a users saved tokens for this gateway.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_tokens( $sandbox = null ) {
+
+        if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
+            $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
+
+            if ( is_array( $tokens ) ) {
+                $this->tokens = $tokens;
+            }
+
+        }
+
+        if ( ! is_bool( $sandbox ) ) {
+            return $this->tokens;
+        }
+
+        $args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
+        return wp_list_filter( $this->tokens, $args );
+
+    }
+
+    /**
+     * Saves a token for this gateway.
+     *
+     * @since 1.0.19
+     */
+    public function save_token( $token ) {
+
+        $tokens   = $this->get_tokens();
+        $tokens[] = $token;
+
+        update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
+
+        $this->tokens = $tokens;
+
+    }
+
+    /**
+     * Return the title for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_title() {
+        return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
+    }
+
+    /**
+     * Return the description for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_description() {
+        return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
+    }
+
+    /**
+     * Get the success url.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_return_url( $invoice ) {
+
+        // Payment success url
+        $return_url = add_query_arg(
+            array(
+                'payment-confirm' => $this->id,
+                'invoice_key'     => $invoice->get_key(),
+                'utm_nooverride'  => 1
+            ),
+            wpinv_get_success_page_uri()
+        );
+
+        return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
+    }
+
+    /**
+     * Confirms payments when rendering the success page.
+     *
+     * @param string $content Success page content.
+     * @return string
+     */
+    public function confirm_payment( $content ) {
+
+        // Retrieve the invoice.
+        $invoice_id = getpaid_get_current_invoice_id();
+        $invoice    = wpinv_get_invoice( $invoice_id );
+
+        // Ensure that it exists and that it is pending payment.
+        if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
+            return $content;
+        }
+
+        // Can the user view this invoice??
+        if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
+            return $content;
+        }
+
+        // Show payment processing indicator.
+        return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {}
+
+    /**
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
+
+    }
+
+    /**
+     * Get a link to the transaction on the 3rd party gateway site (if applicable).
+     *
+     * @param string $transaction_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string transaction URL, or empty string.
+     */
+    public function filter_transaction_url( $transaction_url, $invoice ) {
+
+        $transaction_id  = $invoice->get_transaction_id();
+
+        if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
+            $transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
+            $replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
+        }
+
+        return $transaction_url;
+    }
+
+    /**
+     * Get a link to the subscription on the 3rd party gateway site (if applicable).
+     *
+     * @param string $subscription_url transaction url.
+     * @param WPInv_Subscription $subscription Subscription objectt.
+     * @return string subscription URL, or empty string.
+     */
+    public function generate_subscription_url( $subscription_url, $subscription ) {
+
+        $profile_id      = $subscription->get_profile_id();
 
-		// Change the checkout button text.
-		if ( ! empty( $this->checkout_button_text ) ) {
-			add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
-		}
-
-		// Check if a gateway is valid for a given currency.
-		add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
-
-		// Generate the transaction url.
-		add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
-
-		// Generate the subscription url.
-		add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 );
-
-		// Confirm payments.
-		add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
-
-		// Verify IPNs.
-		add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
-
-	}
-
-	/**
-	 * Checks if this gateway is a given gateway.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is( $gateway ) {
-		return $gateway == $this->id;
-	}
-
-	/**
-	 * Returns a users saved tokens for this gateway.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_tokens( $sandbox = null ) {
-
-		if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
-			$tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
-
-			if ( is_array( $tokens ) ) {
-				$this->tokens = $tokens;
-			}
-
-		}
-
-		if ( ! is_bool( $sandbox ) ) {
-			return $this->tokens;
-		}
-
-		$args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
-		return wp_list_filter( $this->tokens, $args );
-
-	}
-
-	/**
-	 * Saves a token for this gateway.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_token( $token ) {
-
-		$tokens   = $this->get_tokens();
-		$tokens[] = $token;
-
-		update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
-
-		$this->tokens = $tokens;
-
-	}
-
-	/**
-	 * Return the title for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_title() {
-		return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
-	}
-
-	/**
-	 * Return the description for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_description() {
-		return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
-	}
-
-	/**
-	 * Get the success url.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_return_url( $invoice ) {
-
-		// Payment success url
-		$return_url = add_query_arg(
-			array(
-				'payment-confirm' => $this->id,
-				'invoice_key'     => $invoice->get_key(),
-				'utm_nooverride'  => 1
-			),
-			wpinv_get_success_page_uri()
-		);
-
-		return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
-	}
-
-	/**
-	 * Confirms payments when rendering the success page.
-	 *
-	 * @param string $content Success page content.
-	 * @return string
-	 */
-	public function confirm_payment( $content ) {
-
-		// Retrieve the invoice.
-		$invoice_id = getpaid_get_current_invoice_id();
-		$invoice    = wpinv_get_invoice( $invoice_id );
-
-		// Ensure that it exists and that it is pending payment.
-		if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
-			return $content;
-		}
-
-		// Can the user view this invoice??
-		if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
-			return $content;
-		}
-
-		// Show payment processing indicator.
-		return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {}
-
-	/**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
-
-	}
-
-	/**
-	 * Get a link to the transaction on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $transaction_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string transaction URL, or empty string.
-	 */
-	public function filter_transaction_url( $transaction_url, $invoice ) {
-
-		$transaction_id  = $invoice->get_transaction_id();
-
-		if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
-			$transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
-			$replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
-		}
-
-		return $transaction_url;
-	}
-
-	/**
-	 * Get a link to the subscription on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $subscription_url transaction url.
-	 * @param WPInv_Subscription $subscription Subscription objectt.
-	 * @return string subscription URL, or empty string.
-	 */
-	public function generate_subscription_url( $subscription_url, $subscription ) {
-
-		$profile_id      = $subscription->get_profile_id();
-
-		if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
-
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : '';
-			$subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
-
-		}
-
-		return $subscription_url;
-	}
-
-	/**
-	 * Check if the gateway is available for use.
-	 *
-	 * @return bool
-	 */
-	public function is_available() {
-		return ! empty( $this->enabled );
-	}
-
-	/**
-	 * Return the gateway's title.
-	 *
-	 * @return string
-	 */
-	public function get_title() {
-		return apply_filters( 'getpaid_gateway_title', $this->title, $this );
-	}
-
-	/**
-	 * Return the gateway's description.
-	 *
-	 * @return string
-	 */
-	public function get_description() {
-		return apply_filters( 'getpaid_gateway_description', $this->description, $this );
-	}
-
-	/**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return void
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
-		// Process the payment then either redirect to the success page or the gateway.
-		do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
-	}
-
-	/**
-	 * Process refund.
-	 *
-	 * If the gateway declares 'refunds' support, this will allow it to refund.
-	 * a passed in amount.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param  float  $amount Refund amount.
-	 * @param  string $reason Refund reason.
-	 * @return WP_Error|bool True or false based on success, or a WP_Error object.
-	 */
-	public function process_refund( $invoice, $amount = null, $reason = '' ) {
-		return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
-	}
-
-	/**
-	 * Displays the payment fields, credit cards etc.
-	 * 
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
-	public function payment_fields( $invoice_id, $form ) {
-		do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
-	}
-
-	/**
-	 * Filters the gateway settings.
-	 * 
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the value of a gateway setting.
-	 * 
-	 * @param string $option
-	 */
-	public function get_option( $option, $default = false ) {
-		return wpinv_get_option( $this->id . '_' . $option, $default );
-	}
-
-	/**
-	 * Check if a gateway supports a given feature.
-	 *
-	 * Gateways should override this to declare support (or lack of support) for a feature.
-	 * For backward compatibility, gateways support 'products' by default, but nothing else.
-	 *
-	 * @param string $feature string The name of a feature to test support for.
-	 * @return bool True if the gateway supports the feature, false otherwise.
-	 * @since 1.0.19
-	 */
-	public function supports( $feature ) {
-		return getpaid_payment_gateway_supports( $this->id, $feature );
-	}
-
-	/**
-	 * Returns the credit card form html.
-	 * 
-	 * @param bool $save whether or not to display the save button.
-	 */
+        if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+
+            $subscription_url = sprintf( $this->view_subscription_url, $profile_id );
+            $replace          = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : '';
+            $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
+
+        }
+
+        return $subscription_url;
+    }
+
+    /**
+     * Check if the gateway is available for use.
+     *
+     * @return bool
+     */
+    public function is_available() {
+        return ! empty( $this->enabled );
+    }
+
+    /**
+     * Return the gateway's title.
+     *
+     * @return string
+     */
+    public function get_title() {
+        return apply_filters( 'getpaid_gateway_title', $this->title, $this );
+    }
+
+    /**
+     * Return the gateway's description.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return apply_filters( 'getpaid_gateway_description', $this->description, $this );
+    }
+
+    /**
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return void
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
+        // Process the payment then either redirect to the success page or the gateway.
+        do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
+    }
+
+    /**
+     * Process refund.
+     *
+     * If the gateway declares 'refunds' support, this will allow it to refund.
+     * a passed in amount.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param  float  $amount Refund amount.
+     * @param  string $reason Refund reason.
+     * @return WP_Error|bool True or false based on success, or a WP_Error object.
+     */
+    public function process_refund( $invoice, $amount = null, $reason = '' ) {
+        return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
+    }
+
+    /**
+     * Displays the payment fields, credit cards etc.
+     * 
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
+    public function payment_fields( $invoice_id, $form ) {
+        do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
+    }
+
+    /**
+     * Filters the gateway settings.
+     * 
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the value of a gateway setting.
+     * 
+     * @param string $option
+     */
+    public function get_option( $option, $default = false ) {
+        return wpinv_get_option( $this->id . '_' . $option, $default );
+    }
+
+    /**
+     * Check if a gateway supports a given feature.
+     *
+     * Gateways should override this to declare support (or lack of support) for a feature.
+     * For backward compatibility, gateways support 'products' by default, but nothing else.
+     *
+     * @param string $feature string The name of a feature to test support for.
+     * @return bool True if the gateway supports the feature, false otherwise.
+     * @since 1.0.19
+     */
+    public function supports( $feature ) {
+        return getpaid_payment_gateway_supports( $this->id, $feature );
+    }
+
+    /**
+     * Returns the credit card form html.
+     * 
+     * @param bool $save whether or not to display the save button.
+     */
     public function get_cc_form( $save = false ) {
 
-		ob_start();
+        ob_start();
 
         $id_prefix = esc_attr( uniqid( $this->id ) );
 
@@ -562,11 +562,11 @@ 
                                         'name'              => $this->id . '[cc_cvv2]',
                                         'id'                => "$id_prefix-cc-cvv2",
                                         'label'             => __( 'CCV', 'invoicing' ),
-										'label_type'        => 'vertical',
-										'class'             => 'form-control-sm',
-										'extra_attributes'  => array(
-											'autocomplete'  => "cc-csc",
-										),
+                                        'label_type'        => 'vertical',
+                                        'class'             => 'form-control-sm',
+                                        'extra_attributes'  => array(
+                                            'autocomplete'  => "cc-csc",
+                                        ),
                                     )
                                 );
                             ?>
@@ -576,191 +576,191 @@ 
 					
 					<?php
 
-						if ( $save ) {
-							echo $this->save_payment_method_checkbox();
-						}
+                        if ( $save ) {
+                            echo $this->save_payment_method_checkbox();
+                        }
 
-					?>
+                    ?>
                 </div>
 
             </div>
 		<?php
 		
-		return ob_get_clean();
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Displays a new payment method entry form.
+     *
+     * @since 1.0.19
+     */
+    public function new_payment_method_entry( $form ) {
+        echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
+    }
+
+    /**
+     * Grab and display our saved payment methods.
+     *
+     * @since 1.0.19
+     */
+    public function saved_payment_methods() {
+        $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
+
+        foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
+            $html .= $this->get_saved_payment_method_option_html( $token );
+        }
 
+        $html .= $this->get_new_payment_method_option_html();
+        $html .= '</ul>';
+
+        echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
     }
 
-	/**
-	 * Displays a new payment method entry form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function new_payment_method_entry( $form ) {
-		echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
-	}
-
-	/**
-	 * Grab and display our saved payment methods.
-	 *
-	 * @since 1.0.19
-	 */
-	public function saved_payment_methods() {
-		$html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
-
-		foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
-			$html .= $this->get_saved_payment_method_option_html( $token );
-		}
-
-		$html .= $this->get_new_payment_method_option_html();
-		$html .= '</ul>';
-
-		echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
-	}
-
-	/**
-	 * Gets saved payment method HTML from a token.
-	 *
-	 * @since 1.0.19
-	 * @param  array $token Payment Token.
-	 * @return string Generated payment method HTML
-	 */
-	public function get_saved_payment_method_option_html( $token ) {
-
-		return sprintf(
-			'<li class="getpaid-payment-method form-group">
+    /**
+     * Gets saved payment method HTML from a token.
+     *
+     * @since 1.0.19
+     * @param  array $token Payment Token.
+     * @return string Generated payment method HTML
+     */
+    public function get_saved_payment_method_option_html( $token ) {
+
+        return sprintf(
+            '<li class="getpaid-payment-method form-group">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s />
 					<span>%3$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_attr( $token['id'] ),
-			esc_html( $token['name'] ),
-			checked( empty( $token['default'] ), false, false )
-		);
+            esc_attr( $this->id ),
+            esc_attr( $token['id'] ),
+            esc_html( $token['name'] ),
+            checked( empty( $token['default'] ), false, false )
+        );
 
-	}
+    }
 
-	/**
-	 * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_new_payment_method_option_html() {
+    /**
+     * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
+     *
+     * @since 1.0.19
+     */
+    public function get_new_payment_method_option_html() {
 
-		$label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
+        $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
 
-		return sprintf(
-			'<li class="getpaid-new-payment-method">
+        return sprintf(
+            '<li class="getpaid-new-payment-method">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="new" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_html( $label )
-		);
-
-	}
-
-	/**
-	 * Outputs a checkbox for saving a new payment method to the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_payment_method_checkbox() {
-
-		return aui()->input(
-			array(
-				'type'       => 'checkbox',
-				'name'       => esc_attr( "getpaid-$this->id-new-payment-method" ),
-				'id'         => esc_attr( uniqid( $this->id ) ),
-				'required'   => false,
-				'label'      => esc_html__( 'Save payment method', 'invoicing' ),
-				'value'      => 'true',
-				'checked'    => true,
-				'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1',
-			)
-		);
-
-	}
-
-	/**
-	 * Registers the gateway.
-	 *
-	 * @return array
-	 */
-	public function register_gateway( $gateways ) {
-
-		$gateways[ $this->id ] = array(
-
-			'admin_label'    => $this->method_title,
+            esc_attr( $this->id ),
+            esc_html( $label )
+        );
+
+    }
+
+    /**
+     * Outputs a checkbox for saving a new payment method to the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_payment_method_checkbox() {
+
+        return aui()->input(
+            array(
+                'type'       => 'checkbox',
+                'name'       => esc_attr( "getpaid-$this->id-new-payment-method" ),
+                'id'         => esc_attr( uniqid( $this->id ) ),
+                'required'   => false,
+                'label'      => esc_html__( 'Save payment method', 'invoicing' ),
+                'value'      => 'true',
+                'checked'    => true,
+                'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1',
+            )
+        );
+
+    }
+
+    /**
+     * Registers the gateway.
+     *
+     * @return array
+     */
+    public function register_gateway( $gateways ) {
+
+        $gateways[ $this->id ] = array(
+
+            'admin_label'    => $this->method_title,
             'checkout_label' => $this->title,
-			'ordering'       => $this->order,
+            'ordering'       => $this->order,
 
-		);
+        );
 
-		return $gateways;
+        return $gateways;
 
-	}
+    }
 
-	/**
-	 * Checks whether or not this is a sandbox request.
-	 *
-	 * @param  WPInv_Invoice|null $invoice Invoice object or null.
-	 * @return bool
-	 */
-	public function is_sandbox( $invoice = null ) {
+    /**
+     * Checks whether or not this is a sandbox request.
+     *
+     * @param  WPInv_Invoice|null $invoice Invoice object or null.
+     * @return bool
+     */
+    public function is_sandbox( $invoice = null ) {
 
-		if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
-			return $invoice->get_mode() == 'test';
-		}
+        if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
+            return $invoice->get_mode() == 'test';
+        }
 
-		return wpinv_is_test_mode( $this->id );
+        return wpinv_is_test_mode( $this->id );
 
-	}
+    }
 
-	/**
-	 * Renames the checkout button
-	 *
-	 * @return string
-	 */
-	public function rename_checkout_button() {
-		return $this->checkout_button_text;
-	}
+    /**
+     * Renames the checkout button
+     *
+     * @return string
+     */
+    public function rename_checkout_button() {
+        return $this->checkout_button_text;
+    }
 
-	/**
-	 * Validate gateway currency
-	 *
-	 * @return bool
-	 */
-	public function validate_currency( $validation, $currency ) {
+    /**
+     * Validate gateway currency
+     *
+     * @return bool
+     */
+    public function validate_currency( $validation, $currency ) {
 
-		// Required currencies.
-		if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
-			return false;
-		}
+        // Required currencies.
+        if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
+            return false;
+        }
 
-		// Excluded currencies.
-		if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
-			return false;
-		}
+        // Excluded currencies.
+        if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
+            return false;
+        }
 
-		return $validation;
-	}
+        return $validation;
+    }
 
-	/**
-	 * Displays an error
-	 *
-	 */
-	public function show_error( $code, $message, $type ) {
+    /**
+     * Displays an error
+     *
+     */
+    public function show_error( $code, $message, $type ) {
 
-		if ( is_admin() ) {
-			getpaid_admin()->{"show_$type"}( $message );
-		}
+        if ( is_admin() ) {
+            getpaid_admin()->{"show_$type"}( $message );
+        }
 
-		wpinv_set_error( $code, $message, $type );
+        wpinv_set_error( $code, $message, $type );
 
-	}
+    }
 
 }

includes/class-wpinv-subscriptions.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@ 
 class WPInv_Subscriptions {
 
     /**
-	 * Class constructor.
-	 */
+     * Class constructor.
+     */
     public function __construct(){
 
         // Fire gateway specific hooks when a subscription changes.
@@ -89,12 +89,12 @@ 
     }
 
     /**
-	 * Processes subscription status changes.
+     * Processes subscription status changes.
      *
      * @param WPInv_Subscription $subscription
      * @param string $from
      * @param string $to
-	 */
+     */
     public function process_subscription_status_change( $subscription, $from, $to ) {
 
         $gateway = $subscription->get_gateway();

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
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * 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 );
-	}
+    /**
+     * 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', '' );
 
-	/**
-     * 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,16 +836,16 @@ 
      * @return int
      */
     public function get_total_payments() {
-		global $wpdb;
+        global $wpdb;
 
-		$count = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-				$this->get_parent_invoice_id()
-			)
-		);
+        $count = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+                $this->get_parent_invoice_id()
+            )
+        );
 
-		// Maybe include parent invoice.
+        // Maybe include parent invoice.
         if ( $this->get_parent_payment()->is_paid() ) {
             $count++;
         }
@@ -874,57 +874,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
@@ -932,122 +932,122 @@ 
      */
     public function create_payment() {
 
-		$parent_invoice = $this->get_parent_payment();
-
-		if ( ! $parent_invoice->exists() ) {
-			return false;
-		}
+        $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() );
+
+        // 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();
+
+    }
 
-		// Duplicate the parent invoice.
-		$invoice = getpaid_duplicate_invoice( $parent_invoice );
-		$invoice->set_parent_id( $parent_invoice->get_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 failing
+     *
+     * @since  2.4.2
+     * @return int Subscription id.
+     */
+    public function failing() {
+        $this->set_status( 'failing' );
+        return $this->save();
+    }
 
     /**
      * Marks a subscription as cancelled
@@ -1056,19 +1056,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
@@ -1081,96 +1081,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
@@ -1180,11 +1180,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>";
     }
 
     /**
@@ -1195,75 +1195,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();
+    }
 
 }