AyeCode / invoicing

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

Indentation +223 added lines, -223 removed lines

@@ -13,94 +13,94 @@ 
 class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'paypal';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 1;
 
     /**
-	 * Stores line items to send to PayPal.
-	 *
-	 * @var array
-	 */
+     * Stores line items to send to PayPal.
+     *
+     * @var array
+     */
     protected $line_items = array();
 
     /**
-	 * Endpoint for requests from PayPal.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to PayPal.
+     *
+     * @var string
+     */
     protected $endpoint;
     
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s';
 
     /**
-	 * URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
+     * URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'PayPal Standard', 'invoicing' );
         $this->method_title         = __( 'PayPal Standard', 'invoicing' );
         $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' );
         $this->notify_url           = wpinv_get_ipn_url( $this->id );
 
-		add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
+        add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
         add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) );
 
         parent::__construct();
     }
 
     /**
-	 * 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 ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -123,15 +123,15 @@ 
     }
 
     /**
-	 * Get the PayPal request URL for an invoice.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_request_url( $invoice ) {
+     * Get the PayPal request URL for an invoice.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_request_url( $invoice ) {
 
         // Endpoint for this request
-		$this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
+        $this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
 
         // Retrieve paypal args.
         $paypal_args       = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' );
@@ -144,44 +144,44 @@ 
 
         return add_query_arg( $paypal_args, $this->endpoint );
 
-	}
+    }
 
     /**
-	 * Get PayPal Args for passing to PP.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_paypal_args( $invoice ) {
+     * Get PayPal Args for passing to PP.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_paypal_args( $invoice ) {
 
         // Whether or not to send the line items as one item.
-		$force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice );
-
-		if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
-			$force_one_line_item = true;
-		}
-
-		$paypal_args = apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, $force_one_line_item )
-			),
-			$invoice
-		);
-
-		return $this->fix_request_length( $invoice, $paypal_args );
+        $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice );
+
+        if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
+            $force_one_line_item = true;
+        }
+
+        $paypal_args = apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, $force_one_line_item )
+            ),
+            $invoice
+        );
+
+        return $this->fix_request_length( $invoice, $paypal_args );
     }
 
     /**
-	 * Get transaction args for paypal request.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_transaction_args( $invoice ) {
-
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        return array(
             'cmd'           => '_cart',
             'business'      => wpinv_get_option( 'paypal_email', false ),
             'no_shipping'   => '1',
@@ -206,16 +206,16 @@ 
     }
 
     /**
-	 * Get line item args for paypal request.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @param  bool     $force_one_line_item Create only one item for this invoice.
-	 * @return array
-	 */
-	protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
+     * Get line item args for paypal request.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @param  bool     $force_one_line_item Create only one item for this invoice.
+     * @return array
+     */
+    protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
 
         // Maybe send invoice as a single item.
-		if ( $force_one_line_item ) {
+        if ( $force_one_line_item ) {
             return $this->get_line_item_args_single_item( $invoice );
         }
 
@@ -235,129 +235,129 @@ 
             $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 );
         }
 
-		return array_merge( $line_item_args, $this->get_line_items() );
+        return array_merge( $line_item_args, $this->get_line_items() );
 
     }
 
     /**
-	 * Get line item args for paypal request as a single line item.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_line_item_args_single_item( $invoice ) {
-		$this->delete_line_items();
+     * Get line item args for paypal request as a single line item.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_line_item_args_single_item( $invoice ) {
+        $this->delete_line_items();
 
         $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() );
-		$this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() );
+        $this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() );
 
-		return $this->get_line_items();
+        return $this->get_line_items();
     }
 
     /**
-	 * Return all line items.
-	 */
-	protected function get_line_items() {
-		return $this->line_items;
-	}
+     * Return all line items.
+     */
+    protected function get_line_items() {
+        return $this->line_items;
+    }
 
     /**
-	 * Remove all line items.
-	 */
-	protected function delete_line_items() {
-		$this->line_items = array();
+     * Remove all line items.
+     */
+    protected function delete_line_items() {
+        $this->line_items = array();
     }
 
     /**
-	 * Prepare line items to send to paypal.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 */
-	protected function prepare_line_items( $invoice ) {
-		$this->delete_line_items();
-
-		// Items.
-		foreach ( $invoice->get_items() as $item ) {
-			$amount   = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total();
-			$quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
-			$this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
+     * Prepare line items to send to paypal.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     */
+    protected function prepare_line_items( $invoice ) {
+        $this->delete_line_items();
+
+        // Items.
+        foreach ( $invoice->get_items() as $item ) {
+            $amount   = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total();
+            $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
+            $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
         }
 
         // Fees.
-		foreach ( $invoice->get_fees() as $fee => $data ) {
+        foreach ( $invoice->get_fees() as $fee => $data ) {
             $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) );
         }
 
     }
 
     /**
-	 * Add PayPal Line Item.
-	 *
-	 * @param  string $item_name Item name.
-	 * @param  int    $quantity Item quantity.
-	 * @param  float  $amount Amount.
-	 * @param  string $item_number Item number.
-	 */
-	protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
-		$index = ( count( $this->line_items ) / 4 ) + 1;
-
-		$item = apply_filters(
-			'getpaid_paypal_line_item',
-			array(
-				'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
-				'quantity'    => (float) $quantity,
-				'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
-				'item_number' => $item_number,
-			),
-			$item_name,
-			$quantity,
-			$amount,
-			$item_number
-		);
-
-		$this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
+     * Add PayPal Line Item.
+     *
+     * @param  string $item_name Item name.
+     * @param  int    $quantity Item quantity.
+     * @param  float  $amount Amount.
+     * @param  string $item_number Item number.
+     */
+    protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
+        $index = ( count( $this->line_items ) / 4 ) + 1;
+
+        $item = apply_filters(
+            'getpaid_paypal_line_item',
+            array(
+                'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
+                'quantity'    => (float) $quantity,
+                'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
+                'item_number' => $item_number,
+            ),
+            $item_name,
+            $quantity,
+            $amount,
+            $item_number
+        );
+
+        $this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
         $this->line_items[ 'quantity_' . $index ]    = $item['quantity'];
         
         // The price or amount of the product, service, or contribution, not including shipping, handling, or tax.
-		$this->line_items[ 'amount_' . $index ]      = $item['amount'];
-		$this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
+        $this->line_items[ 'amount_' . $index ]      = $item['amount'];
+        $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
     }
 
     /**
-	 * If the default request with line items is too long, generate a new one with only one line item.
-	 *
-	 * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
-	 * @param array    $paypal_args Arguments sent to Paypal in the request.
-	 * @return array
-	 */
-	protected function fix_request_length( $invoice, $paypal_args ) {
-		$max_paypal_length = 2083;
-		$query_candidate   = http_build_query( $paypal_args, '', '&' );
-
-		if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
-			return $paypal_args;
-		}
-
-		return apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, true )
-			),
-			$invoice
-		);
+     * If the default request with line items is too long, generate a new one with only one line item.
+     *
+     * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
+     *
+     * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
+     * @param array    $paypal_args Arguments sent to Paypal in the request.
+     * @return array
+     */
+    protected function fix_request_length( $invoice, $paypal_args ) {
+        $max_paypal_length = 2083;
+        $query_candidate   = http_build_query( $paypal_args, '', '&' );
+
+        if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
+            return $paypal_args;
+        }
+
+        return apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, true )
+            ),
+            $invoice
+        );
 
     }
     
     /**
-	 * Processes recurring invoices.
-	 *
-	 * @param  array $paypal_args PayPal args.
-	 * @param  WPInv_Invoice    $invoice Invoice object.
-	 */
-	public function process_subscription( $paypal_args, $invoice ) {
+     * Processes recurring invoices.
+     *
+     * @param  array $paypal_args PayPal args.
+     * @param  WPInv_Invoice    $invoice Invoice object.
+     */
+    public function process_subscription( $paypal_args, $invoice ) {
 
         // Make sure this is a subscription.
         if ( ! $invoice->is_recurring() || ! $subscription = wpinv_get_subscription( $invoice ) ) {
@@ -382,11 +382,11 @@ 
 
             $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount;
 
-			// Trial period length.
-			$paypal_args['p1'] = $subscription_item->get_trial_interval();
+            // Trial period length.
+            $paypal_args['p1'] = $subscription_item->get_trial_interval();
 
-			// Trial period.
-			$paypal_args['t1'] = $subscription_item->get_trial_period();
+            // Trial period.
+            $paypal_args['t1'] = $subscription_item->get_trial_period();
 
         } else if ( $initial_amount != $recurring_amount ) {
 
@@ -409,40 +409,40 @@ 
         }
 
         // We have a recurring payment
-		if ( ! isset( $param_number ) || 1 == $param_number ) {
+        if ( ! isset( $param_number ) || 1 == $param_number ) {
 
-			// Subscription price
-			$paypal_args['a3'] = $recurring_amount;
+            // Subscription price
+            $paypal_args['a3'] = $recurring_amount;
 
-			// Subscription duration
-			$paypal_args['p3'] = $interval;
+            // Subscription duration
+            $paypal_args['p3'] = $interval;
 
-			// Subscription period
-			$paypal_args['t3'] = $period;
+            // Subscription period
+            $paypal_args['t3'] = $period;
 
         }
         
         // Recurring payments
-		if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
+        if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
 
-			// Non-recurring payments
-			$paypal_args['src'] = 0;
+            // Non-recurring payments
+            $paypal_args['src'] = 0;
 
-		} else {
+        } else {
 
-			$paypal_args['src'] = 1;
+            $paypal_args['src'] = 1;
 
-			if ( $bill_times > 0 ) {
+            if ( $bill_times > 0 ) {
 
-				// An initial period is being used to charge a sign-up fee
-				if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
-					$bill_times--;
-				}
+                // An initial period is being used to charge a sign-up fee
+                if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
+                    $bill_times--;
+                }
 
                 // Make sure it's not over the max of 52
                 $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 );
 
-			}
+            }
         }
         
         // Force return URL so that order description & instructions display
@@ -458,19 +458,19 @@ 
         }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -480,10 +480,10 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 

includes/api/class-getpaid-rest-report-top-sellers-controller.php

Indentation +175 added lines, -175 removed lines

@@ -18,179 +18,179 @@
  */
 class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/top_sellers';
-
-	/**
-	 * Get top sellers report.
-	 *
-	 * @param WP_REST_Request $request
-	 * @return array|WP_Error
-	 */
-	public function get_items( $request ) {
-
-		// Prepare items.
-		$this->report_range = $this->get_date_range( $request );
-		$report_data        = $this->get_report_data();
-
-		$top_sellers = array();
-
-		foreach ( $report_data as $item ) {
-
-			$item_obj  = new WPInv_Item( $item );
-			$item_name = $item->invoice_item_name;
-			$item_qty  = floatval( $item->invoice_item_qty );
-			$item_id   = absint( $item->invoice_item_id );
-			$price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
-
-			$item_obj  = new WPInv_Item( $item_id );
-
-			if ( $item_obj->exists() ) {
-				$item_name = $item_obj->get_name();
-			} else {
-				$item_id   = 0; 
-			}
-
-			$top_sellers[] = array(
-				'name'               =>sanitize_text_field( $item_name ),
-				'item_id'            => $item_id,
-				'quantity'           => $item_qty,
-				'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
-				'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
-			);
-
-		}
-
-		$data = array();
-		foreach ( $top_sellers as $top_seller ) {
-			$item   = $this->prepare_item_for_response( (object) $top_seller, $request );
-			$data[] = $this->prepare_response_for_collection( $item );
-		}
-
-		return rest_ensure_response( $data );
-
-	}
-
-	/**
-	 * Prepare a report sales object for serialization.
-	 *
-	 * @param stdClass $top_seller
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $top_seller, $request ) {
-		$data    = (array) $top_seller;
-
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Wrap the data in a response object.
-		$response = rest_ensure_response( $data );
-		$links = array(
-			'about' => array(
-				'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-			),
-		);
-
-		if ( ! empty( $top_seller->item_id ) ) {
-			$links['item']   = array(
-				'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
-				'embeddable' => true,
-			);
-		}
-
-		$response->add_links( $links );
-		return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
-	}
-
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
-
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'              => array(
-					'quantity'      => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_qty',
-					),
-					'item_id'             => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_id',
-					),
-					'item_name'           => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_name',
-					),
-					'price'               => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_price',
-					),
-				),
-				'group_by'       => 'invoice_item_id',
-				'order_by'       => 'invoice_item_qty DESC',
-				'query_type'     => 'get_results',
-				'limit'          => 10,
-				'filter_range'   => $this->report_range,
-			)
-		);
-
-	}
-
-	/**
-	 * Get the Report's schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => $this->rest_base,
-			'type'       => 'object',
-			'properties' => array(
-				'name' => array(
-					'description' => __( 'Item name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'item_id'         => array(
-					'description' => __( 'Item ID.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'quantity' => array(
-					'description' => __( 'Total number of purchases.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings' => array(
-					'description' => __( 'Total earnings for the item.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings_formatted"' => array(
-					'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/top_sellers';
+
+    /**
+     * Get top sellers report.
+     *
+     * @param WP_REST_Request $request
+     * @return array|WP_Error
+     */
+    public function get_items( $request ) {
+
+        // Prepare items.
+        $this->report_range = $this->get_date_range( $request );
+        $report_data        = $this->get_report_data();
+
+        $top_sellers = array();
+
+        foreach ( $report_data as $item ) {
+
+            $item_obj  = new WPInv_Item( $item );
+            $item_name = $item->invoice_item_name;
+            $item_qty  = floatval( $item->invoice_item_qty );
+            $item_id   = absint( $item->invoice_item_id );
+            $price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
+
+            $item_obj  = new WPInv_Item( $item_id );
+
+            if ( $item_obj->exists() ) {
+                $item_name = $item_obj->get_name();
+            } else {
+                $item_id   = 0; 
+            }
+
+            $top_sellers[] = array(
+                'name'               =>sanitize_text_field( $item_name ),
+                'item_id'            => $item_id,
+                'quantity'           => $item_qty,
+                'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
+                'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
+            );
+
+        }
+
+        $data = array();
+        foreach ( $top_sellers as $top_seller ) {
+            $item   = $this->prepare_item_for_response( (object) $top_seller, $request );
+            $data[] = $this->prepare_response_for_collection( $item );
+        }
+
+        return rest_ensure_response( $data );
+
+    }
+
+    /**
+     * Prepare a report sales object for serialization.
+     *
+     * @param stdClass $top_seller
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $top_seller, $request ) {
+        $data    = (array) $top_seller;
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Wrap the data in a response object.
+        $response = rest_ensure_response( $data );
+        $links = array(
+            'about' => array(
+                'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
+            ),
+        );
+
+        if ( ! empty( $top_seller->item_id ) ) {
+            $links['item']   = array(
+                'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
+                'embeddable' => true,
+            );
+        }
+
+        $response->add_links( $links );
+        return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
+    }
+
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
+
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'              => array(
+                    'quantity'      => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_qty',
+                    ),
+                    'item_id'             => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_id',
+                    ),
+                    'item_name'           => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_name',
+                    ),
+                    'price'               => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_price',
+                    ),
+                ),
+                'group_by'       => 'invoice_item_id',
+                'order_by'       => 'invoice_item_qty DESC',
+                'query_type'     => 'get_results',
+                'limit'          => 10,
+                'filter_range'   => $this->report_range,
+            )
+        );
+
+    }
+
+    /**
+     * Get the Report's schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => $this->rest_base,
+            'type'       => 'object',
+            'properties' => array(
+                'name' => array(
+                    'description' => __( 'Item name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'item_id'         => array(
+                    'description' => __( 'Item ID.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'quantity' => array(
+                    'description' => __( 'Total number of purchases.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings' => array(
+                    'description' => __( 'Total earnings for the item.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings_formatted"' => array(
+                    'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
 }

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

Indentation +61 added lines, -61 removed lines

@@ -12,79 +12,79 @@
  */
 class GetPaid_Payment_Form_Submission_Items {
 
-	/**
-	 * Submission items.
-	 * @var GetPaid_Form_Item[]
-	 */
-	public $items = array();
-
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$data         = $submission->get_data();
-		$payment_form = $submission->get_payment_form();
-
-		// Prepare the selected items.
-		$selected_items = array();
-		if ( ! empty( $data['getpaid-items'] ) ) {
-			$selected_items = wpinv_clean( $data['getpaid-items'] );
-		}
-
-		// For default forms, ensure that an item has been set.
-		if ( $payment_form->is_default() && ! $submission->has_invoice() && isset( $data['getpaid-form-items'] ) ) {
-			$form_items = wpinv_clean( $data['getpaid-form-items'] );
-			$payment_form->set_items( getpaid_convert_items_to_array( $form_items ) );
-		}
+     * Submission items.
+     * @var GetPaid_Form_Item[]
+     */
+    public $items = array();
 
-		// Process each individual item.
-		foreach ( $payment_form->get_items() as $item ) {
-			$this->process_item( $item, $selected_items );
-		}
-
-	}
+    /**
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $data         = $submission->get_data();
+        $payment_form = $submission->get_payment_form();
+
+        // Prepare the selected items.
+        $selected_items = array();
+        if ( ! empty( $data['getpaid-items'] ) ) {
+            $selected_items = wpinv_clean( $data['getpaid-items'] );
+        }
+
+        // For default forms, ensure that an item has been set.
+        if ( $payment_form->is_default() && ! $submission->has_invoice() && isset( $data['getpaid-form-items'] ) ) {
+            $form_items = wpinv_clean( $data['getpaid-form-items'] );
+            $payment_form->set_items( getpaid_convert_items_to_array( $form_items ) );
+        }
+
+        // Process each individual item.
+        foreach ( $payment_form->get_items() as $item ) {
+            $this->process_item( $item, $selected_items );
+        }
+
+    }
 
-	/**
-	 * Process a single item.
-	 *
-	 * @param GetPaid_Form_Item $item
-	 * @param array $selected_items
-	 */
-	public function process_item( $item, $selected_items ) {
+    /**
+     * Process a single item.
+     *
+     * @param GetPaid_Form_Item $item
+     * @param array $selected_items
+     */
+    public function process_item( $item, $selected_items ) {
 
-		// Abort if this is an optional item and it has not been selected.
-		if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) {
-			return;
-		}
+        // Abort if this is an optional item and it has not been selected.
+        if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) {
+            return;
+        }
 
-		// (maybe) let customers change the quantities and prices.
-		if ( isset( $selected_items[ $item->get_id() ] ) ) {
+        // (maybe) let customers change the quantities and prices.
+        if ( isset( $selected_items[ $item->get_id() ] ) ) {
 
-			// Maybe change the quantities.
-			if ( $item->allows_quantities() ) {
-				$item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] );
-			}
+            // Maybe change the quantities.
+            if ( $item->allows_quantities() ) {
+                $item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] );
+            }
 
-			// Maybe change the price.
-			if ( $item->user_can_set_their_price() ) {
-				$price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] );
+            // Maybe change the price.
+            if ( $item->user_can_set_their_price() ) {
+                $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] );
 
-				if ( $item->get_minimum_price() > $price ) {
-					throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_sanitize_amount( $item->get_minimum_price() ) ) );
-				}
+                if ( $item->get_minimum_price() > $price ) {
+                    throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_sanitize_amount( $item->get_minimum_price() ) ) );
+                }
 
-				$item->set_price( $price );
+                $item->set_price( $price );
 
-			}
+            }
 
-		}
+        }
 
-		// Save the item.
-		$this->items[] = $item;
+        // Save the item.
+        $this->items[] = $item;
 
-	}
+    }
 
 }

includes/data/invoice-schema.php

Indentation +621 added lines, -621 removed lines

@@ -13,629 +13,629 @@
 
 return array(
 
-	'id'              => array(
-		'description' => __( 'Unique identifier for the invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'parent_id'       => array(
-		'description' => __( 'Parent invoice ID.', 'invoicing' ),
-		'type'        => 'integer',
-		'minimum'     => 0,
-		'default'     => 0,
-		'context'     => array( 'view', 'edit' ),
-	),
-
-	'key'			  => array(
-		'description' => __( 'A unique key for the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'number'		  => array(
-		'description' => __( 'A unique number for the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'type'			  => array(
-		'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'post_type'		  => array(
-		'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'version'         => array(
-		'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'template'        => array(
-		'description' => __( 'The invoice template.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => 'quantity',
-		'enum'        => array( 'quantity', 'hours', 'amount' ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'status'          => array(
-		'description' => __( 'Invoice status.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => 'wpi-pending',
-		'enum'        => array_keys( wpinv_get_invoice_statuses( true ) ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'status_nicename' => array(
-		'description' => __( 'A human readable name for the invoice status.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'currency'        => array(
-		'description' => __( 'The invoice currency in ISO format.', 'invoicing' ),
-		'type'        => 'string',
-		'default'     => wpinv_get_currency(),
-		'enum'        => array_keys( wpinv_get_currencies() ),
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'date_created'    => array(
-		'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'date_created_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was created.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'date_modified'   => array(
-		'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'date_modified_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'due_date'        => array(
-		'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'due_date_gmt'    => array(
-		'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'completed_date'  => array(
-		'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'completed_date_gmt'    => array(
-		'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_discount'   => array(
-		'description' => __( 'Total discount amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_tax'       => array(
-		'description' => __( 'Total tax amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total_fees'      => array(
-		'description' => __( 'Total fees amount for the invoice.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subtotal'        => array(
-		'description' => __( 'Invoice subtotal.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'total'           => array(
-		'description' => __( 'Grand total.', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'initial_total'   => array(
-		'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'recurring_total'  => array(
-		'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ),
-		'type'        => 'number',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'totals'          => array(
-		'description' => __( 'Invoice totals.', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'fees'            => array(
-		'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'discounts'       => array(
-		'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'taxes'           => array(
-		'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ),
-		'type'        => 'object',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'amount' ),
-			'properties'          => array(
-				'amount'          => array(
-					'description' => __( 'Fee amount.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'recurring'       => array(
-					'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ),
-					'type'        => array( 'boolean', 'integer' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'items'           => array(
-		'description' => __( 'Invoice items.', 'invoicing' ),
-		'type'        => 'array',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'required'            => array( 'item_id' ),
-			'properties'          => array(
-				'item_id'         => array(
-					'description' => __( 'Item ID.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'item_name'       => array(
-					'description' => __( 'Item Name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'item_description' => array(
-					'description'  => __( 'Item Description.', 'invoicing' ),
-					'type'         => 'string',
-					'context'      => array( 'view', 'edit', 'embed' ),
-				),
-				'item_price'      => array(
-					'description' => __( 'Item Price.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'quantity'        => array(
-					'description' => __( 'Item Quantity.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'subtotal'        => array(
-					'description' => __( 'Item Subtotal.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view', 'edit', 'embed' ),
-					'readonly'    => true,
-				),
-				'meta'            => array(
-					'description' => __( 'Item Meta.', 'invoicing' ),
-					'type'        => 'object',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'mode'			  => array(
-		'description' => __( 'The invoice transaction mode.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'enum'        => array( 'live', 'test' ),
-		'readonly'    => true,
-	),
+    'id'              => array(
+        'description' => __( 'Unique identifier for the invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'parent_id'       => array(
+        'description' => __( 'Parent invoice ID.', 'invoicing' ),
+        'type'        => 'integer',
+        'minimum'     => 0,
+        'default'     => 0,
+        'context'     => array( 'view', 'edit' ),
+    ),
+
+    'key'			  => array(
+        'description' => __( 'A unique key for the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'number'		  => array(
+        'description' => __( 'A unique number for the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'type'			  => array(
+        'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'post_type'		  => array(
+        'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'version'         => array(
+        'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'template'        => array(
+        'description' => __( 'The invoice template.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => 'quantity',
+        'enum'        => array( 'quantity', 'hours', 'amount' ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'status'          => array(
+        'description' => __( 'Invoice status.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => 'wpi-pending',
+        'enum'        => array_keys( wpinv_get_invoice_statuses( true ) ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'status_nicename' => array(
+        'description' => __( 'A human readable name for the invoice status.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'currency'        => array(
+        'description' => __( 'The invoice currency in ISO format.', 'invoicing' ),
+        'type'        => 'string',
+        'default'     => wpinv_get_currency(),
+        'enum'        => array_keys( wpinv_get_currencies() ),
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'date_created'    => array(
+        'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'date_created_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was created.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'date_modified'   => array(
+        'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'date_modified_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'due_date'        => array(
+        'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'due_date_gmt'    => array(
+        'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'completed_date'  => array(
+        'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'completed_date_gmt'    => array(
+        'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_discount'   => array(
+        'description' => __( 'Total discount amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_tax'       => array(
+        'description' => __( 'Total tax amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total_fees'      => array(
+        'description' => __( 'Total fees amount for the invoice.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subtotal'        => array(
+        'description' => __( 'Invoice subtotal.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'total'           => array(
+        'description' => __( 'Grand total.', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'initial_total'   => array(
+        'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'recurring_total'  => array(
+        'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ),
+        'type'        => 'number',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'totals'          => array(
+        'description' => __( 'Invoice totals.', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'fees'            => array(
+        'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'discounts'       => array(
+        'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'taxes'           => array(
+        'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ),
+        'type'        => 'object',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'amount' ),
+            'properties'          => array(
+                'amount'          => array(
+                    'description' => __( 'Fee amount.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'recurring'       => array(
+                    'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ),
+                    'type'        => array( 'boolean', 'integer' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'items'           => array(
+        'description' => __( 'Invoice items.', 'invoicing' ),
+        'type'        => 'array',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'required'            => array( 'item_id' ),
+            'properties'          => array(
+                'item_id'         => array(
+                    'description' => __( 'Item ID.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_name'       => array(
+                    'description' => __( 'Item Name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_description' => array(
+                    'description'  => __( 'Item Description.', 'invoicing' ),
+                    'type'         => 'string',
+                    'context'      => array( 'view', 'edit', 'embed' ),
+                ),
+                'item_price'      => array(
+                    'description' => __( 'Item Price.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'quantity'        => array(
+                    'description' => __( 'Item Quantity.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'subtotal'        => array(
+                    'description' => __( 'Item Subtotal.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                    'readonly'    => true,
+                ),
+                'meta'            => array(
+                    'description' => __( 'Item Meta.', 'invoicing' ),
+                    'type'        => 'object',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'mode'			  => array(
+        'description' => __( 'The invoice transaction mode.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'enum'        => array( 'live', 'test' ),
+        'readonly'    => true,
+    ),
 	
-	'discount_code'   => array(
-		'description' => __( 'The discount code used on this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'gateway'         => array(
-		'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'gateway_title'   => array(
-		'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'transaction_id'  => array(
-		'description' => __( 'The transaction id for this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
+    'discount_code'   => array(
+        'description' => __( 'The discount code used on this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'gateway'         => array(
+        'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'gateway_title'   => array(
+        'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'transaction_id'  => array(
+        'description' => __( 'The transaction id for this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
 	
-	'disable_taxes'   => array(
-		'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ),
-		'type'        => 'boolean ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'is_viewed'       => array(
-		'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ),
-		'type'        => 'boolean ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'email_cc'        => array(
-		'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit' ),
-	),
-
-	'subscription_id' => array(
-		'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subscription_name' => array(
-		'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'subscription_name' => array(
-		'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
-		'type'        => 'string ',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_parent'		  => array(
-		'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_renewal'      => array(
-		'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_recurring'    => array(
-		'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_free'         => array(
-		'description' => __( 'Whether or not this invoice is free.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_paid'         => array(
-		'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'needs_payment'   => array(
-		'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_refunded'     => array(
-		'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_due'          => array(
-		'description' => __( 'Whether or not this invoice is due.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_held'         => array(
-		'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'is_draft'        => array(
-		'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ),
-		'type'        => 'boolean',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'path'			  => array(
-		'description' => __( 'The invoice path/slug/name.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'description'     => array(
-		'description' => __( 'The invoice description.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'payment_form'    => array(
-		'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'submission_id'   => array(
-		'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit' ),
-		'readonly'    => true,
-	),
-
-	'customer_id'     => array(
-		'description' => __( 'The customer id.', 'invoicing' ),
-		'type'        => 'integer',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_ip'     => array(
-		'description' => __( "The customer's ip address.", 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'ip',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'first_name'     => array(
-		'description' => __( "The customer's first name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'last_name'       => array(
-		'description' => __( "The customer's last name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
+    'disable_taxes'   => array(
+        'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ),
+        'type'        => 'boolean ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'is_viewed'       => array(
+        'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ),
+        'type'        => 'boolean ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'email_cc'        => array(
+        'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit' ),
+    ),
+
+    'subscription_id' => array(
+        'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subscription_name' => array(
+        'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'subscription_name' => array(
+        'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ),
+        'type'        => 'string ',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_parent'		  => array(
+        'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_renewal'      => array(
+        'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_recurring'    => array(
+        'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_free'         => array(
+        'description' => __( 'Whether or not this invoice is free.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_paid'         => array(
+        'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'needs_payment'   => array(
+        'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_refunded'     => array(
+        'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_due'          => array(
+        'description' => __( 'Whether or not this invoice is due.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_held'         => array(
+        'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'is_draft'        => array(
+        'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ),
+        'type'        => 'boolean',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'path'			  => array(
+        'description' => __( 'The invoice path/slug/name.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'description'     => array(
+        'description' => __( 'The invoice description.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'payment_form'    => array(
+        'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'submission_id'   => array(
+        'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit' ),
+        'readonly'    => true,
+    ),
+
+    'customer_id'     => array(
+        'description' => __( 'The customer id.', 'invoicing' ),
+        'type'        => 'integer',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_ip'     => array(
+        'description' => __( "The customer's ip address.", 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'ip',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'first_name'     => array(
+        'description' => __( "The customer's first name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'last_name'       => array(
+        'description' => __( "The customer's last name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
 	
-	'full_name'       => array(
-		'description' => __( "The customer's full name.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'phone_number'    => array(
-		'description' => __( "The customer's phone number.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-	),
-
-	'email_address'   => array(
-		'description' => __( "The customer's email address.", 'invoicing' ),
-		'type'        => 'string',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'customer_country'   => array(
-		'description'    => __( "The customer's country.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-		'default'        => wpinv_get_default_country(),
-	),
-
-	'customer_state'     => array(
-		'description'    => __( "The customer's state.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_city'      => array(
-		'description'    => __( "The customer's city.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_zip'       => array(
-		'description'    => __( "The customer's zip/postal code.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'customer_company'   => array(
-		'description'    => __( "The customer's company name.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'vat_number'         => array(
-		'description'    => __( "The customer's VAT number.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'vat_rate'           => array(
-		'description'    => __( "The customer's VAT rate.", 'invoicing' ),
-		'type'           => 'number',
-		'context'        => array( 'view', 'edit', 'embed' ),
-		'readonly'       => true,
-	),
-
-	'customer_address'   => array(
-		'description'    => __( "The customer's address.", 'invoicing' ),
-		'type'           => 'string',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'address_confirmed'  => array(
-		'description'    => __( "Whether or not the customer's address is confirmed.", 'invoicing' ),
-		'type'           => 'boolean',
-		'context'        => array( 'view', 'edit', 'embed' ),
-	),
-
-	'meta_data'       => array(
-		'description' => __( 'Invoice meta data.', 'invoicing' ),
-		'type'        => 'array',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'items'       => array(
-			'type'                => 'object',
-			'properties'          => array(
-				'id'              => array(
-					'description' => __( 'Meta ID.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'key'             => array(
-					'description' => __( 'Meta key.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-				'value'           => array(
-					'description' => __( 'Meta Value.', 'invoicing' ),
-					'type'        => array( 'string', 'array', 'object', 'integer', 'null' ),
-					'context'     => array( 'view', 'edit', 'embed' ),
-				),
-			),
-		),
-	),
-
-	'view_url'        => array(
-		'description' => __( 'URL to the invoice.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'checkout_payment_url'         => array(
-		'description' => __( 'URL to the invoice checkout page.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
-
-	'receipt_url'     => array(
-		'description' => __( 'URL to the invoice receipt page.', 'invoicing' ),
-		'type'        => 'string',
-		'format'      => 'uri',
-		'context'     => array( 'view', 'edit', 'embed' ),
-		'readonly'    => true,
-	),
+    'full_name'       => array(
+        'description' => __( "The customer's full name.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'phone_number'    => array(
+        'description' => __( "The customer's phone number.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'email_address'   => array(
+        'description' => __( "The customer's email address.", 'invoicing' ),
+        'type'        => 'string',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'customer_country'   => array(
+        'description'    => __( "The customer's country.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+        'default'        => wpinv_get_default_country(),
+    ),
+
+    'customer_state'     => array(
+        'description'    => __( "The customer's state.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_city'      => array(
+        'description'    => __( "The customer's city.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_zip'       => array(
+        'description'    => __( "The customer's zip/postal code.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'customer_company'   => array(
+        'description'    => __( "The customer's company name.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'vat_number'         => array(
+        'description'    => __( "The customer's VAT number.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'vat_rate'           => array(
+        'description'    => __( "The customer's VAT rate.", 'invoicing' ),
+        'type'           => 'number',
+        'context'        => array( 'view', 'edit', 'embed' ),
+        'readonly'       => true,
+    ),
+
+    'customer_address'   => array(
+        'description'    => __( "The customer's address.", 'invoicing' ),
+        'type'           => 'string',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'address_confirmed'  => array(
+        'description'    => __( "Whether or not the customer's address is confirmed.", 'invoicing' ),
+        'type'           => 'boolean',
+        'context'        => array( 'view', 'edit', 'embed' ),
+    ),
+
+    'meta_data'       => array(
+        'description' => __( 'Invoice meta data.', 'invoicing' ),
+        'type'        => 'array',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'items'       => array(
+            'type'                => 'object',
+            'properties'          => array(
+                'id'              => array(
+                    'description' => __( 'Meta ID.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'key'             => array(
+                    'description' => __( 'Meta key.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'value'           => array(
+                    'description' => __( 'Meta Value.', 'invoicing' ),
+                    'type'        => array( 'string', 'array', 'object', 'integer', 'null' ),
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+            ),
+        ),
+    ),
+
+    'view_url'        => array(
+        'description' => __( 'URL to the invoice.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'checkout_payment_url'         => array(
+        'description' => __( 'URL to the invoice checkout page.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
+
+    'receipt_url'     => array(
+        'description' => __( 'URL to the invoice receipt page.', 'invoicing' ),
+        'type'        => 'string',
+        'format'      => 'uri',
+        'context'     => array( 'view', 'edit', 'embed' ),
+        'readonly'    => true,
+    ),
 
 );

includes/class-wpinv-item.php

Indentation +734 added lines, -734 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,30 +10,30 @@ 
 class WPInv_Item  extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'item';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'item';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'item';
 
     /**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'parent_id'            => 0,
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'parent_id'            => 0,
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'description'          => '',
@@ -58,13 +58,13 @@ 
     );
 
     /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_items';
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_items';
 
     /**
      * Stores a reference to the original WP_Post object
@@ -74,37 +74,37 @@ 
     protected $post = null;
 
     /**
-	 * Get the item if ID is passed, otherwise the item is new and empty.
-	 *
-	 * @param  int|object|WPInv_Item|WP_Post $item Item to read.
-	 */
-	public function __construct( $item = 0 ) {
-		parent::__construct( $item );
-
-		if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
-			$this->set_id( $item );
-		} elseif ( $item instanceof self ) {
-			$this->set_id( $item->get_id() );
-		} elseif ( ! empty( $item->ID ) ) {
-			$this->set_id( $item->ID );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
-			$this->set_id( $item_id );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
-			$this->set_id( $item_id );
-		} else {
-			$this->set_object_read( true );
-		}
+     * Get the item if ID is passed, otherwise the item is new and empty.
+     *
+     * @param  int|object|WPInv_Item|WP_Post $item Item to read.
+     */
+    public function __construct( $item = 0 ) {
+        parent::__construct( $item );
+
+        if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
+            $this->set_id( $item );
+        } elseif ( $item instanceof self ) {
+            $this->set_id( $item->get_id() );
+        } elseif ( ! empty( $item->ID ) ) {
+            $this->set_id( $item->ID );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
+            $this->set_id( $item_id );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
+            $this->set_id( $item_id );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
             $this->ID   = $this->get_id();
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -122,401 +122,401 @@ 
     */
 
     /**
-	 * Get parent item ID.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_id', $context );
+     * Get parent item ID.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_id', $context );
     }
 
     /**
-	 * Get item 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 item status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
     }
 
     /**
-	 * Get plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the item name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
     }
 
     /**
-	 * Get the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-		return $this->get_prop( 'description', $context );
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+        return $this->get_prop( 'description', $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_excerpt( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_excerpt( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_summary( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_summary( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Get the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
-	}
+     * Get the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
+    }
 	
-	/**
-	 * Alias of self::get_author().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_owner( $context = 'view' ) {
-		return $this->get_author( $context );
-    }
-
-    /**
-	 * Get the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_price( $context = 'view' ) {
+    /**
+     * Alias of self::get_author().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_owner( $context = 'view' ) {
+        return $this->get_author( $context );
+    }
+
+    /**
+     * Get the price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) );
-	}
+    }
 	
-	/**
-	 * Get the inital price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_price( $context = 'view' ) {
+    /**
+     * Get the inital price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_price( $context = 'view' ) {
 
-		$price = (float) $this->get_price( $context );
+        $price = (float) $this->get_price( $context );
 
-		if ( $this->has_free_trial() ) {
-			$price = 0;
-		}
+        if ( $this->has_free_trial() ) {
+            $price = 0;
+        }
 
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) );
     }
 
     /**
-	 * Returns a formated price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+     * Returns a formated price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_price() {
         return wpinv_price( $this->get_price() );
-	}
-
-	/**
-	 * Returns the formated initial price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Returns the formated initial price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_initial_price() {
         return wpinv_price( $this->get_initial_price() );
     }
 
     /**
-	 * Get the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_rule( $context = 'view' ) {
+     * Get the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_rule( $context = 'view' ) {
         return $this->get_prop( 'vat_rule', $context );
     }
 
     /**
-	 * Get the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_class( $context = 'view' ) {
+     * Get the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_class( $context = 'view' ) {
         return $this->get_prop( 'vat_class', $context );
     }
 
     /**
-	 * Get the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
+     * Get the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_type( $context = 'view' ) {
         return $this->get_prop( 'type', $context );
     }
 
     /**
-	 * Get the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_id( $context = 'view' ) {
+     * Get the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_id( $context = 'view' ) {
         return $this->get_prop( 'custom_id', $context );
     }
 
     /**
-	 * Get the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_name( $context = 'view' ) {
+     * Get the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_name( $context = 'view' ) {
         return $this->get_prop( 'custom_name', $context );
     }
 
     /**
-	 * Get the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_singular_name( $context = 'view' ) {
+     * Get the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_singular_name( $context = 'view' ) {
         return $this->get_prop( 'custom_singular_name', $context );
     }
 
     /**
-	 * Checks if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_editable( $context = 'view' ) {
+     * Checks if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_editable( $context = 'view' ) {
         return (int) $this->get_prop( 'is_editable', $context );
     }
 
     /**
-	 * Alias of self::get_is_editable().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_editable( $context = 'view' ) {
-		return $this->get_is_editable( $context );
+     * Alias of self::get_is_editable().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_editable( $context = 'view' ) {
+        return $this->get_is_editable( $context );
     }
 
     /**
-	 * Checks if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_dynamic_pricing( $context = 'view' ) {
+     * Checks if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_dynamic_pricing( $context = 'view' ) {
         return (int) $this->get_prop( 'is_dynamic_pricing', $context );
     }
 
     /**
-	 * Returns the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_minimum_price( $context = 'view' ) {
+     * Returns the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_minimum_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) );
     }
 
     /**
-	 * Checks if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_recurring( $context = 'view' ) {
+     * Checks if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_recurring( $context = 'view' ) {
         return (int) $this->get_prop( 'is_recurring', $context );
-	}
+    }
 	
-	/**
-	 * Get the recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_price( $context = 'view' ) {
-		$price = $this->get_price( $context );
+    /**
+     * Get the recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_price( $context = 'view' ) {
+        $price = $this->get_price( $context );
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) );
-	}
-
-	/**
-	 * Get the formatted recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Get the formatted recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_recurring_price() {
         return wpinv_price( $this->get_recurring_price() );
-	}
-
-	/**
-	 * Get the first renewal date (in timestamps) of the item.
-	 *
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public function get_first_renewal_date() {
-
-		$periods = array(
-			'D' => 'days',
-			'W' => 'weeks',
-			'M' => 'months',
-			'Y' => 'years',
-		);
-
-		$period   = $this->get_recurring_period();
-		$interval = $this->get_recurring_interval();
-
-		if ( $this->has_free_trial() ) {
-			$period   = $this->get_trial_period();
-			$interval = $this->get_trial_interval();
-		}
-
-		$period       = $periods[ $period ];
-		$interval     = empty( $interval ) ? 1 : $interval;
-		$next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get the first renewal date (in timestamps) of the item.
+     *
+     * @since 1.0.19
+     * @return int
+     */
+    public function get_first_renewal_date() {
+
+        $periods = array(
+            'D' => 'days',
+            'W' => 'weeks',
+            'M' => 'months',
+            'Y' => 'years',
+        );
+
+        $period   = $this->get_recurring_period();
+        $interval = $this->get_recurring_interval();
+
+        if ( $this->has_free_trial() ) {
+            $period   = $this->get_trial_period();
+            $interval = $this->get_trial_interval();
+        }
+
+        $period       = $periods[ $period ];
+        $interval     = empty( $interval ) ? 1 : $interval;
+        $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
         return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this );
     }
 
     /**
-	 * Get the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_recurring_period( $full = false ) {
+     * Get the recurring period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_recurring_period( $full = false ) {
         $period = $this->get_prop( 'recurring_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -527,63 +527,63 @@ 
     }
 
     /**
-	 * Get the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_interval( $context = 'view' ) {
-		$interval = absint( $this->get_prop( 'recurring_interval', $context ) );
+     * Get the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_interval( $context = 'view' ) {
+        $interval = absint( $this->get_prop( 'recurring_interval', $context ) );
 
-		if ( $interval < 1 ) {
-			$interval = 1;
-		}
+        if ( $interval < 1 ) {
+            $interval = 1;
+        }
 
         return $interval;
     }
 
     /**
-	 * Get the recurring limit.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_limit( $context = 'view' ) {
+     * Get the recurring limit.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_limit( $context = 'view' ) {
         return (int) $this->get_prop( 'recurring_limit', $context );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_free_trial( $context = 'view' ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_free_trial( $context = 'view' ) {
         return (int) $this->get_prop( 'is_free_trial', $context );
     }
 
     /**
-	 * Alias for self::get_is_free_trial().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_free_trial( $context = 'view' ) {
+     * Alias for self::get_is_free_trial().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_free_trial( $context = 'view' ) {
         return $this->get_is_free_trial( $context );
     }
 
     /**
-	 * Get the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_trial_period( $full = false ) {
+     * Get the trial period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_trial_period( $full = false ) {
         $period = $this->get_prop( 'trial_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -594,104 +594,104 @@ 
     }
 
     /**
-	 * Get the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_trial_interval( $context = 'view' ) {
+     * Get the trial interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_trial_interval( $context = 'view' ) {
         return (int) $this->get_prop( 'trial_interval', $context );
-	}
+    }
 	
-	/**
-	 * Get the item's edit url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_edit_url() {
+    /**
+     * Get the item's edit url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_edit_url() {
         return get_edit_post_link( $this->get_id() );
-	}
-
-	/**
-	 * Given an item's name/custom id, it returns its id.
-	 *
-	 *
-	 * @static
-	 * @param string $value The item name or custom id.
-	 * @param string $field Either name or custom_id.
-	 * @param string $type in case you need to search for a given type.
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
-
-		// Trim the value.
-		$value = sanitize_text_field( $value );
-		if ( empty( $value ) ) {
-			return 0;
-		}
+    }
+
+    /**
+     * Given an item's name/custom id, it returns its id.
+     *
+     *
+     * @static
+     * @param string $value The item name or custom id.
+     * @param string $field Either name or custom_id.
+     * @param string $type in case you need to search for a given type.
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
+
+        // Trim the value.
+        $value = sanitize_text_field( $value );
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
         // Valid fields.
         $fields = array( 'custom_id', 'name', 'slug' );
 
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		if ( $field == 'name' ) {
-			$field = 'slug';
-		}
-
-		// Maybe retrieve from the cache.
-		$item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-		if ( ! empty( $item_id ) ) {
-			return $item_id;
-		}
-
-		// Fetch from the db.
-		$items = array();
-		if ( $field == 'slug' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'name'           => $value,
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-				)
-			);
-		}
-
-		if ( $field =='custom_id' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-					'meta_query'     => array(
-						array(
-							'key'   => '_wpinv_type',
-                			'value' => $type,
-						),
-						array(
-							'key'   => '_wpinv_custom_id',
-                			'value' => $value,
-						)
-					)
-				)
-			);
-		}
-
-		if ( empty( $items ) ) {
-			return 0;
-		}
-
-		// Update the cache with our data
-		wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-
-		return $items[0]->ID;
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        if ( $field == 'name' ) {
+            $field = 'slug';
+        }
+
+        // Maybe retrieve from the cache.
+        $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+        if ( ! empty( $item_id ) ) {
+            return $item_id;
+        }
+
+        // Fetch from the db.
+        $items = array();
+        if ( $field == 'slug' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'name'           => $value,
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                )
+            );
+        }
+
+        if ( $field =='custom_id' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                    'meta_query'     => array(
+                        array(
+                            'key'   => '_wpinv_type',
+                            'value' => $type,
+                        ),
+                        array(
+                            'key'   => '_wpinv_custom_id',
+                            'value' => $value,
+                        )
+                    )
+                )
+            );
+        }
+
+        if ( empty( $items ) ) {
+            return 0;
+        }
+
+        // Update the cache with our data
+        wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+
+        return $items[0]->ID;
     }
 
     /**
@@ -724,52 +724,52 @@ 
     */
 
     /**
-	 * Set parent order ID.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_parent_id( $value ) {
-		if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
-			return;
-		}
-		$this->set_prop( 'parent_id', absint( $value ) );
-	}
-
-    /**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+     * Set parent order ID.
+     *
+     * @since 1.0.19
+     */
+    public function set_parent_id( $value ) {
+        if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
+            return;
+        }
+        $this->set_prop( 'parent_id', absint( $value ) );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param  string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
         $this->set_prop( 'status', $status );
 
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
     }
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -782,13 +782,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -801,115 +801,115 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
         $name = sanitize_text_field( $value );
-		$this->set_prop( 'name', $name );
+        $this->set_prop( 'name', $name );
     }
 
     /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
     }
 
     /**
-	 * Set the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
-		$description = wp_kses_post( $value );
-		return $this->set_prop( 'description', $description );
+     * Set the item description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
+        $description = wp_kses_post( $value );
+        return $this->set_prop( 'description', $description );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_excerpt( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_excerpt( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_summary( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_summary( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
 	
-	/**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_owner( $value ) {
-		$this->set_author( $value );
-    }
-
-    /**
-	 * Set the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value New price.
-	 */
-	public function set_price( $value ) {
+    /**
+     * Alias of self::set_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_owner( $value ) {
+        $this->set_author( $value );
+    }
+
+    /**
+     * Set the price of the item.
+     *
+     * @since 1.0.19
+     * @param  float $value New price.
+     */
+    public function set_price( $value ) {
         $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Set the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new rule.
-	 */
-	public function set_vat_rule( $value ) {
+     * Set the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new rule.
+     */
+    public function set_vat_rule( $value ) {
         $this->set_prop( 'vat_rule', $value );
     }
 
     /**
-	 * Set the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new class.
-	 */
-	public function set_vat_class( $value ) {
+     * Set the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new class.
+     */
+    public function set_vat_class( $value ) {
         $this->set_prop( 'vat_class', $value );
     }
 
     /**
-	 * Set the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new item type.
-	 * @return string
-	 */
-	public function set_type( $value ) {
+     * Set the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new item type.
+     * @return string
+     */
+    public function set_type( $value ) {
 
         if ( empty( $value ) ) {
             $value = 'custom';
@@ -919,132 +919,132 @@ 
     }
 
     /**
-	 * Set the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom id.
-	 */
-	public function set_custom_id( $value ) {
+     * Set the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom id.
+     */
+    public function set_custom_id( $value ) {
         $this->set_prop( 'custom_id', $value );
     }
 
     /**
-	 * Set the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom name.
-	 */
-	public function set_custom_name( $value ) {
+     * Set the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom name.
+     */
+    public function set_custom_name( $value ) {
         $this->set_prop( 'custom_name', $value );
     }
 
     /**
-	 * Set the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom singular name.
-	 */
-	public function set_custom_singular_name( $value ) {
+     * Set the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom singular name.
+     */
+    public function set_custom_singular_name( $value ) {
         $this->set_prop( 'custom_singular_name', $value );
     }
 
     /**
-	 * Sets if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not the item is editable.
-	 */
-	public function set_is_editable( $value ) {
-		$this->set_prop( 'is_editable', (int) $value );
+     * Sets if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not the item is editable.
+     */
+    public function set_is_editable( $value ) {
+        $this->set_prop( 'is_editable', (int) $value );
     }
 
     /**
-	 * Sets if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_dynamic_pricing( $value ) {
+     * Sets if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_dynamic_pricing( $value ) {
         $this->set_prop( 'is_dynamic_pricing', (int) $value );
     }
 
     /**
-	 * Sets the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value minimum price.
-	 */
-	public function set_minimum_price( $value ) {
+     * Sets the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  float $value minimum price.
+     */
+    public function set_minimum_price( $value ) {
         $this->set_prop( 'minimum_price',  (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Sets if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_recurring( $value ) {
+     * Sets if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_recurring( $value ) {
         $this->set_prop( 'is_recurring', (int) $value );
     }
 
     /**
-	 * Set the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new period.
-	 */
-	public function set_recurring_period( $value ) {
+     * Set the recurring period.
+     *
+     * @since 1.0.19
+     * @param  string $value new period.
+     */
+    public function set_recurring_period( $value ) {
         $this->set_prop( 'recurring_period', $value );
     }
 
     /**
-	 * Set the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value recurring interval.
-	 */
-	public function set_recurring_interval( $value ) {
+     * Set the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  int $value recurring interval.
+     */
+    public function set_recurring_interval( $value ) {
         return $this->set_prop( 'recurring_interval', (int) $value );
     }
 
     /**
-	 * Get the recurring limit.
-	 * @since 1.0.19
-	 * @param  int $value The recurring limit.
-	 * @return int
-	 */
-	public function set_recurring_limit( $value ) {
+     * Get the recurring limit.
+     * @since 1.0.19
+     * @param  int $value The recurring limit.
+     * @return int
+     */
+    public function set_recurring_limit( $value ) {
         $this->set_prop( 'recurring_limit', (int) $value );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not it has a free trial.
-	 */
-	public function set_is_free_trial( $value ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not it has a free trial.
+     */
+    public function set_is_free_trial( $value ) {
         $this->set_prop( 'is_free_trial', (int) $value );
     }
 
     /**
-	 * Set the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value trial period.
-	 */
-	public function set_trial_period( $value ) {
+     * Set the trial period.
+     *
+     * @since 1.0.19
+     * @param  string $value trial period.
+     */
+    public function set_trial_period( $value ) {
         $this->set_prop( 'trial_period', $value );
     }
 
     /**
-	 * Set the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value trial interval.
-	 */
-	public function set_trial_interval( $value ) {
+     * Set the trial interval.
+     *
+     * @since 1.0.19
+     * @param  int $value trial interval.
+     */
+    public function set_trial_interval( $value ) {
         $this->set_prop( 'trial_interval', $value );
     }
 
@@ -1052,17 +1052,17 @@ 
      * Create an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     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();
 
     }
 
@@ -1070,7 +1070,7 @@ 
      * Updates an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -1086,93 +1086,93 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function user_can_set_their_price() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function user_can_set_their_price() {
         return (bool) $this->get_is_dynamic_pricing();
-	}
+    }
 	
-	/**
-	 * Checks whether the item is recurring.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_recurring() {
+    /**
+     * Checks whether the item is recurring.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_recurring() {
         return (bool) $this->get_is_recurring();
     }
 
     /**
-	 * Checks whether the item has a free trial.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item has a free trial.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_free_trial() {
         $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false;
         return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this );
     }
 
     /**
-	 * Checks whether the item is free.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is free.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_free() {
         $is_free   = $this->get_price() == 0;
         return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this );
     }
 
     /**
-	 * Checks the item status against a passed in status.
-	 *
-	 * @param array|string $status Status to check.
-	 * @return bool
-	 */
-	public function has_status( $status ) {
-		$has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
-		return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
+     * Checks the item status against a passed in status.
+     *
+     * @param array|string $status Status to check.
+     * @return bool
+     */
+    public function has_status( $status ) {
+        $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
+        return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
     }
 
     /**
-	 * Checks the item type against a passed in types.
-	 *
-	 * @param array|string $type Type to check.
-	 * @return bool
-	 */
-	public function is_type( $type ) {
-		$is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
-		return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
-	}
+     * Checks the item type against a passed in types.
+     *
+     * @param array|string $type Type to check.
+     * @return bool
+     */
+    public function is_type( $type ) {
+        $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
+        return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
+    }
 
     /**
-	 * Checks whether the item is editable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is editable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_editable() {
         $is_editable = $this->get_is_editable();
         return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this );
-	}
+    }
 
-	/**
-	 * Returns an array of cart fees.
-	 */
-	public function get_fees() {
+    /**
+     * Returns an array of cart fees.
+     */
+    public function get_fees() {
         return array();
     }
 
     /**
-	 * Checks whether the item is purchasable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is purchasable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function can_purchase() {
         $can_purchase = $this->exists();
 
@@ -1184,11 +1184,11 @@ 
     }
 
     /**
-	 * Checks whether the item supports dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item supports dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function supports_dynamic_pricing() {
         return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this );
     }

includes/data-stores/class-getpaid-item-data-store.php

Indentation +209 added lines, -209 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,228 +14,228 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
-					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
-					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'     => $item->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_item',
+                    'post_status'   => $this->get_post_status( $item ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $item->get_author( 'edit' ),
+                    'post_title'    => $item->get_name( 'edit' ),
+                    'post_parent'   => 0,
+                    'post_excerpt'  => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            do_action( 'getpaid_new_item', $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
 		
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
-				'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item );
-		} else {
-			do_action( 'getpaid_update_item', $item );
-		}
-
-	}
-
-	/*
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            $item->set_id( 0 );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
+                'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+        do_action( 'getpaid_read_item', $item );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $item->get_id() );
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $item->get_date_created( 'edit' ),
+                'post_status'       => $item->get_status( 'edit' ),
+                'post_parent'       => $item->get_parent_id( 'edit' ),
+                'post_excerpt'      => $item->get_description( 'edit' ),
+                'post_modified'     => $item->get_date_modified( 'edit' ),
+                'post_title'        => $item->get_name( 'edit' ),
+                'post_author'       => $item->get_author( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $item->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_item', $item );
+        } else {
+            do_action( 'getpaid_update_item', $item );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

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

Indentation +533 added lines, -533 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,55 +10,55 @@ 
 class GetPaid_Payment_Form extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'payment_form';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'payment_form';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'payment_form';
 
     /**
-	 * Form Data array. This is the core form data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Form Data array. This is the core form data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'author'               => 1,
         'elements'             => null,
-		'items'                => null,
-		'earned'               => 0,
-		'refunded'             => 0,
-		'cancelled'            => 0,
-		'failed'               => 0,
-	);
-
-    /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_forms';
-
-	/**
-	 * Stores a reference to the invoice if the form is for an invoice..
-	 *
-	 * @var WPInv_Invoice
-	 */
-	public $invoice = 0;
+        'items'                => null,
+        'earned'               => 0,
+        'refunded'             => 0,
+        'cancelled'            => 0,
+        'failed'               => 0,
+    );
+
+    /**
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_forms';
+
+    /**
+     * Stores a reference to the invoice if the form is for an invoice..
+     *
+     * @var WPInv_Invoice
+     */
+    public $invoice = 0;
 
     /**
      * Stores a reference to the original WP_Post object
@@ -68,35 +68,35 @@ 
     protected $post = null;
 
     /**
-	 * Get the form if ID is passed, otherwise the form is new and empty.
-	 *
-	 * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
-	 */
-	public function __construct( $form = 0 ) {
-		parent::__construct( $form );
+     * Get the form if ID is passed, otherwise the form is new and empty.
+     *
+     * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
+     */
+    public function __construct( $form = 0 ) {
+        parent::__construct( $form );
 
-		if ( is_numeric( $form ) && $form > 0 ) {
-			$this->set_id( $form );
-		} elseif ( $form instanceof self ) {
+        if ( is_numeric( $form ) && $form > 0 ) {
+            $this->set_id( $form );
+        } elseif ( $form instanceof self ) {
 
-			$this->set_id( $form->get_id() );
-			$this->invoice = $form->invoice;
+            $this->set_id( $form->get_id() );
+            $this->invoice = $form->invoice;
 
-		} elseif ( ! empty( $form->ID ) ) {
-			$this->set_id( $form->ID );
-		} else {
-			$this->set_object_read( true );
-		}
+        } elseif ( ! empty( $form->ID ) ) {
+            $this->set_id( $form->ID );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -114,358 +114,358 @@ 
     */
 
     /**
-	 * Get plugin version when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the form name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the form name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
-	}
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
+    }
 
     /**
-	 * Get the owner of the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
+     * Get the owner of the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
     }
 
     /**
-	 * Get the elements that make up the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_elements( $context = 'view' ) {
-		$elements = $this->get_prop( 'elements', $context );
+     * Get the elements that make up the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_elements( $context = 'view' ) {
+        $elements = $this->get_prop( 'elements', $context );
 
-		if ( empty( $elements ) || ! is_array( $elements ) ) {
+        if ( empty( $elements ) || ! is_array( $elements ) ) {
             return wpinv_get_data( 'sample-payment-form' );
-		}
+        }
 
-		// Ensure that all required elements exist.
-		$_elements = array();
-		foreach ( $elements as $element ) {
+        // Ensure that all required elements exist.
+        $_elements = array();
+        foreach ( $elements as $element ) {
 
-			if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
+            if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
 
-				$_elements[] = array(
-					'text'        => __( 'Select Payment Method', 'invoicing' ),
-					'id'          => 'gtscicd',
-					'name'        => 'gtscicd',
-					'type'        => 'gateway_select',
-					'premade'     => true
+                $_elements[] = array(
+                    'text'        => __( 'Select Payment Method', 'invoicing' ),
+                    'id'          => 'gtscicd',
+                    'name'        => 'gtscicd',
+                    'type'        => 'gateway_select',
+                    'premade'     => true
 			
-				);
+                );
 
-			}
+            }
 
-			$_elements[] = $element;
+            $_elements[] = $element;
 
-		}
+        }
 
         return $_elements;
-	}
-
-	/**
-	 * Get the items sold via the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @param  string $return objects or arrays.
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items( $context = 'view', $return = 'objects' ) {
-		$items = $this->get_prop( 'items', $context );
-
-		if ( empty( $items ) || ! is_array( $items ) ) {
+    }
+
+    /**
+     * Get the items sold via the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @param  string $return objects or arrays.
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items( $context = 'view', $return = 'objects' ) {
+        $items = $this->get_prop( 'items', $context );
+
+        if ( empty( $items ) || ! is_array( $items ) ) {
             $items = wpinv_get_data( 'sample-payment-form-items' );
-		}
+        }
+
+        // Convert the items.
+        $prepared = array();
 
-		// Convert the items.
-		$prepared = array();
+        foreach ( $items as $key => $value ) {
 
-		foreach ( $items as $key => $value ) {
+            // Form items.
+            if ( $value instanceof GetPaid_Form_Item ) {
 
-			// Form items.
-			if ( $value instanceof GetPaid_Form_Item ) {
+                if ( $value->can_purchase() ) {
+                    $prepared[] = $value;
+                }
 
-				if ( $value->can_purchase() ) {
-					$prepared[] = $value;
-				}
+                continue;
 
-				continue;
+            }
 
-			}
+            // $item_id => $quantity (buy buttons)
+            if ( is_numeric( $key ) && is_numeric( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
 
-			// $item_id => $quantity (buy buttons)
-			if ( is_numeric( $key ) && is_numeric( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+                if ( $item->can_purchase() ) {
 
-				if ( $item->can_purchase() ) {
+                    $value = (float) $value;
+                    $item->set_quantity( $value );
+                    if ( 0 == $value ) {
+                        $item->set_quantity( 1 );
+                        $item->set_allow_quantities( true );
+                    }
 
-					$value = (float) $value;
-					$item->set_quantity( $value );
-					if ( 0 == $value ) {
-						$item->set_quantity( 1 );
-						$item->set_allow_quantities( true );
-					}
+                    $prepared[] = $item;
+                }
 
-					$prepared[] = $item;
-				}
+                continue;
+            }
 
-				continue;
-			}
+            // Items saved via payment forms editor.
+            if ( is_array( $value ) && isset( $value['id'] ) ) {
 
-			// Items saved via payment forms editor.
-			if ( is_array( $value ) && isset( $value['id'] ) ) {
+                $item = new GetPaid_Form_Item( $value['id'] );
 
-				$item = new GetPaid_Form_Item( $value['id'] );
+                if ( ! $item->can_purchase() ) {
+                    continue;
+                }
 
-				if ( ! $item->can_purchase() ) {
-					continue;
-				}
+                // Sub-total (Cart items).
+                if ( isset( $value['subtotal'] ) ) {
+                    $item->set_price( $value['subtotal'] );
+                }
 
-				// Sub-total (Cart items).
-				if ( isset( $value['subtotal'] ) ) {
-					$item->set_price( $value['subtotal'] );
-				}
+                if ( isset( $value['quantity'] ) ) {
+                    $item->set_quantity( $value['quantity'] );
+                }
 
-				if ( isset( $value['quantity'] ) ) {
-					$item->set_quantity( $value['quantity'] );
-				}
+                if ( isset( $value['allow_quantities'] ) ) {
+                    $item->set_allow_quantities( $value['allow_quantities'] );
+                }
 
-				if ( isset( $value['allow_quantities'] ) ) {
-					$item->set_allow_quantities( $value['allow_quantities'] );
-				}
+                if ( isset( $value['required'] ) ) {
+                    $item->set_is_required( $value['required'] );
+                }
 
-				if ( isset( $value['required'] ) ) {
-					$item->set_is_required( $value['required'] );
-				}
+                if ( isset( $value['description'] ) ) {
+                    $item->set_custom_description( $value['description'] );
+                }
 
-				if ( isset( $value['description'] ) ) {
-					$item->set_custom_description( $value['description'] );
-				}
+                $prepared[] = $item;
+                continue;
 
-				$prepared[] = $item;
-				continue;
+            }
+
+            // $item_id => array( 'price' => 10 ) (item variations)
+            if ( is_numeric( $key ) && is_array( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
+
+                if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
+                    $item->set_price( $value['price'] );
+                }
+
+                if ( $item->can_purchase() ) {
+                    $prepared[] = $item;
+                }
+
+                continue;
+            }
+
+        }
+
+        if ( 'objects' == $return && 'view' == $context ) {
+            return $prepared;
+        }
+
+        $items = array();
+        foreach ( $prepared as $item ) {
+            $items[] = $item->prepare_data_for_use();
+        }
+
+        return $items;
+    }
+
+    /**
+     * Get a single item belonging to the form.
+     *
+     * @since 1.0.19
+     * @param  int $item_id The item id to return.
+     * @return GetPaid_Form_Item|bool
+     */
+    public function get_item( $item_id ) {
+
+        if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
+            return false;
+        }
+
+        foreach( $this->get_items() as $item ) {
+            if ( $item->get_id() == (int) $item_id ) {
+                return $item;
+            }
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Gets a single element.
+     *
+     * @since 1.0.19
+     * @param  string $element_type The element type to return.
+     * @return array|bool
+     */
+    public function get_element_type( $element_type ) {
+
+        if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
+            return false;
+        }
+
+        foreach ( $this->get_prop( 'elements' ) as $element ) {
+
+            if ( $element['type'] == $element_type ) {
+                return $element;
+            }
+
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Get the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_earned( $context = 'view' ) {
+        return $this->get_prop( 'earned', $context );
+    }
+
+    /**
+     * Get the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_refunded( $context = 'view' ) {
+        return $this->get_prop( 'refunded', $context );
+    }
 
-			}
+    /**
+     * Get the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_cancelled( $context = 'view' ) {
+        return $this->get_prop( 'cancelled', $context );
+    }
 
-			// $item_id => array( 'price' => 10 ) (item variations)
-			if ( is_numeric( $key ) && is_array( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+    /**
+     * Get the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_failed( $context = 'view' ) {
+        return $this->get_prop( 'failed', $context );
+    }
 
-				if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
-					$item->set_price( $value['price'] );
-				}
-
-				if ( $item->can_purchase() ) {
-					$prepared[] = $item;
-				}
-
-				continue;
-			}
-
-		}
-
-		if ( 'objects' == $return && 'view' == $context ) {
-			return $prepared;
-		}
-
-		$items = array();
-		foreach ( $prepared as $item ) {
-			$items[] = $item->prepare_data_for_use();
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Get a single item belonging to the form.
-	 *
-	 * @since 1.0.19
-	 * @param  int $item_id The item id to return.
-	 * @return GetPaid_Form_Item|bool
-	 */
-	public function get_item( $item_id ) {
-
-		if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
-			return false;
-		}
-
-		foreach( $this->get_items() as $item ) {
-			if ( $item->get_id() == (int) $item_id ) {
-				return $item;
-			}
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Gets a single element.
-	 *
-	 * @since 1.0.19
-	 * @param  string $element_type The element type to return.
-	 * @return array|bool
-	 */
-	public function get_element_type( $element_type ) {
-
-		if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
-			return false;
-		}
-
-		foreach ( $this->get_prop( 'elements' ) as $element ) {
-
-			if ( $element['type'] == $element_type ) {
-				return $element;
-			}
-
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Get the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_earned( $context = 'view' ) {
-		return $this->get_prop( 'earned', $context );
-	}
-
-	/**
-	 * Get the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_refunded( $context = 'view' ) {
-		return $this->get_prop( 'refunded', $context );
-	}
-
-	/**
-	 * Get the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_cancelled( $context = 'view' ) {
-		return $this->get_prop( 'cancelled', $context );
-	}
-
-	/**
-	 * Get the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_failed( $context = 'view' ) {
-		return $this->get_prop( 'failed', $context );
-	}
-
-	/**
-	 * Get the currency.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_currency() {
-		$currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
-		return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
-	}
+    /**
+     * Get the currency.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_currency() {
+        $currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
+        return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -478,22 +478,22 @@ 
     */
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -506,13 +506,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -525,118 +525,118 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
-		$this->set_prop( 'name', sanitize_text_field( $value ) );
-    }
-
-    /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
-    }
-
-    /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
-
-	/**
-	 * Set the form elements.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value Form elements.
-	 */
-	public function set_elements( $value ) {
-		if ( is_array( $value ) ) {
-			$this->set_prop( 'elements', $value );
-		}
-	}
-
-	/**
-	 * Set the form items.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value Form elements.
-	 */
-	public function set_items( $value ) {
-		if ( is_array( $value ) ) {
-			$this->set_prop( 'items', $value );
-		}
-	}
-
-	/**
-	 * Set the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount earned.
-	 */
-	public function set_earned( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'earned', $value );
-	}
-
-	/**
-	 * Set the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount refunded.
-	 */
-	public function set_refunded( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'refunded', $value );
-	}
-
-	/**
-	 * Set the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_cancelled( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'cancelled', $value );
-	}
-
-	/**
-	 * Set the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_failed( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'failed', $value );
-	}
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
+        $this->set_prop( 'name', sanitize_text_field( $value ) );
+    }
+
+    /**
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
+    }
+
+    /**
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
+
+    /**
+     * Set the form elements.
+     *
+     * @since 1.0.19
+     * @param  array $value Form elements.
+     */
+    public function set_elements( $value ) {
+        if ( is_array( $value ) ) {
+            $this->set_prop( 'elements', $value );
+        }
+    }
+
+    /**
+     * Set the form items.
+     *
+     * @since 1.0.19
+     * @param  array $value Form elements.
+     */
+    public function set_items( $value ) {
+        if ( is_array( $value ) ) {
+            $this->set_prop( 'items', $value );
+        }
+    }
+
+    /**
+     * Set the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount earned.
+     */
+    public function set_earned( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'earned', $value );
+    }
+
+    /**
+     * Set the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount refunded.
+     */
+    public function set_refunded( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'refunded', $value );
+    }
+
+    /**
+     * Set the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_cancelled( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'cancelled', $value );
+    }
+
+    /**
+     * Set the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_failed( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'failed', $value );
+    }
 
     /**
      * Create an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     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();
 
     }
 
@@ -644,7 +644,7 @@ 
      * Updates an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -660,22 +660,22 @@ 
 	*/
 
     /**
-	 * Checks whether this is the default payment form.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether this is the default payment form.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_default() {
         $is_default = $this->get_id() == wpinv_get_default_payment_form();
         return (bool) apply_filters( 'wpinv_is_default_payment_form', $is_default, $this->get_id(), $this );
-	}
+    }
 
     /**
-	 * Checks whether the form is active.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the form is active.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_active() {
         $is_active = 0 !== (int) $this->get_id();
 
@@ -684,76 +684,76 @@ 
         }
 
         return (bool) apply_filters( 'wpinv_is_payment_form_active', $is_active, $this );
-	}
-
-	/**
-	 * Checks whether the form has a given item.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given item.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_item( $item_id ) {
         return false !== $this->get_item( $item_id );
-	}
-
-	/**
-	 * Checks whether the form has a given element.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given element.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_element_type( $element_type ) {
         return false !== $this->get_element_type( $element_type );
-	}
-
-	/**
-	 * Checks whether this form is recurring or not.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether this form is recurring or not.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_recurring() {
 
-		if ( ! empty( $this->invoice ) ) {
-			return $this->invoice->is_recurring();
-		}
+        if ( ! empty( $this->invoice ) ) {
+            return $this->invoice->is_recurring();
+        }
 
-		foreach ( $this->get_items() as $item ) {
+        foreach ( $this->get_items() as $item ) {
 
-			if ( $item->is_recurring() ) {
-				return true;
-			}
+            if ( $item->is_recurring() ) {
+                return true;
+            }
 
-		}
+        }
 
         return false;
-	}
+    }
 
-	/**
-	 * Retrieves the form's html.
-	 *
-	 * @since 1.0.19
-	 */
+    /**
+     * Retrieves the form's html.
+     *
+     * @since 1.0.19
+     */
     public function get_html( $extra_markup = '' ) {
 
-		// Return the HTML.
-		return wpinv_get_template_html(
-			'payment-forms/form.php',
-			array(
-				'form'         => $this,
-				'extra_markup' => $extra_markup,
-			)
-		);
-
-	}
-
-	/**
-	 * Displays the payment form.
-	 *
-	 * @since 1.0.19
-	 */
+        // Return the HTML.
+        return wpinv_get_template_html(
+            'payment-forms/form.php',
+            array(
+                'form'         => $this,
+                'extra_markup' => $extra_markup,
+            )
+        );
+
+    }
+
+    /**
+     * Displays the payment form.
+     *
+     * @since 1.0.19
+     */
     public function display( $extra_markup = '' ) {
-		echo $this->get_html( $extra_markup );
+        echo $this->get_html( $extra_markup );
     }
 
 }

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

Indentation +767 added lines, -767 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,187 +10,187 @@ 
 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;
-
-	/**
-	 * 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;
-
-    /**
-	 * 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 ( Exception $e ) {
-			$this->last_error = $e->getMessage();
-		}
-
-		// 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;
+
+    /**
+     * 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;
+
+    /**
+     * 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 ( Exception $e ) {
+            $this->last_error = $e->getMessage();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -199,39 +199,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.
 	|--------------------------------------------------------------------------
@@ -240,61 +240,61 @@ 
 	| 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' ) );
-		}
-
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
-
-		$this->payment_form->set_items( $invoice->get_items() );
-		$this->payment_form->invoice = $invoice;
-
-		$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 );
-	}
-
-	/*
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
+
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
+
+        $this->payment_form->set_items( $invoice->get_items() );
+        $this->payment_form->invoice = $invoice;
+
+        $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.
 	|--------------------------------------------------------------------------
@@ -303,115 +303,115 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-
-			if ( $this->has_recurring != 0 ) {
-				throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
-			}
-
-			$this->has_recurring = $item->get_id();
-
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-
-	}
-
-	/**
-	 * Removes a specific item.
-	 * 
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+
+            if ( $this->has_recurring != 0 ) {
+                throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
+            }
+
+            $this->has_recurring = $item->get_id();
+
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+
+    }
+
+    /**
+     * 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
 	|--------------------------------------------------------------------------
@@ -420,128 +420,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
 	|--------------------------------------------------------------------------
@@ -550,99 +550,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
 	|--------------------------------------------------------------------------
@@ -652,89 +652,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
 	|--------------------------------------------------------------------------
@@ -742,109 +742,109 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * 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() );
-	}
+    /**
+     * 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/gateways/class-getpaid-payment-gateway.php

Indentation +607 added lines, -607 removed lines

@@ -13,467 +13,467 @@ 
  */
 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 );
-
-		// Enable Subscriptions.
-		if ( $this->supports( 'subscription' ) ) {
-			add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
-		}
-
-		// Enable sandbox.
-		if ( $this->supports( 'sandbox' ) ) {
-			add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
-		}
-
-		// Invoice addons.
-		if ( $this->supports( 'addons' ) ) {
-			add_filter( "getpaid_{$this->id}_supports_addons", '__return_true' );
-			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 );
+
+        // Enable Subscriptions.
+        if ( $this->supports( 'subscription' ) ) {
+            add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
+        }
+
+        // Enable sandbox.
+        if ( $this->supports( 'sandbox' ) ) {
+            add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
+        }
+
+        // Invoice addons.
+        if ( $this->supports( 'addons' ) ) {
+            add_filter( "getpaid_{$this->id}_supports_addons", '__return_true' );
+            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_gateway_{$this->id}_subscription_url", array( $this, 'filter_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_Invoice $invoice Invoice object.
+     * @return string subscription URL, or empty string.
+     */
+    public function filter_subscription_url( $subscription_url, $invoice ) {
 
-		// 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_gateway_{$this->id}_subscription_url", array( $this, 'filter_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_Invoice $invoice Invoice object.
-	 * @return string subscription URL, or empty string.
-	 */
-	public function filter_subscription_url( $subscription_url, $invoice ) {
-
-		$profile_id      = $invoice->get_subscription_id();
-
-		if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
-
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $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 apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
-	}
-
-	/**
-	 * Returns the credit card form html.
-	 * 
-	 * @param bool $save whether or not to display the save button.
-	 */
+        $profile_id      = $invoice->get_subscription_id();
+
+        if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+
+            $subscription_url = sprintf( $this->view_subscription_url, $profile_id );
+            $replace          = $this->is_sandbox( $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 apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
+    }
+
+    /**
+     * 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 ) );
 
@@ -568,11 +568,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",
+                                        ),
                                     )
                                 );
                             ?>
@@ -582,191 +582,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 );
-	}
-
-	/**
-	 * 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">
+    /**
+     * 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">
 				<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 );
 
-	}
+    }
 
 }