AyeCode / invoicing

includes/gateways/class-getpaid-authorize-net-gateway.php

Indentation +232 added lines, -232 removed lines

@@ -13,58 +13,58 @@ 
 class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'authorizenet';
 
     /**
-	 * 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', 'tokens', 'addons', 'single_subscription_group', 'multiple_subscription_groups' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 4;
 
     /**
-	 * Endpoint for requests from Authorize.net.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to Authorize.net.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from Authorize.net.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to Authorize.net.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'Credit Card / Debit Card', 'invoicing' );
         $this->method_title         = __( 'Authorize.Net', 'invoicing' );
@@ -76,11 +76,11 @@ 
     }
 
     /**
-	 * Displays the payment method select field.
-	 *
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
+     * Displays the payment method select field.
+     *
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
     public function payment_fields( $invoice_id, $form ) {
 
         // Let the user select a payment method.
@@ -91,16 +91,16 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
+     * Creates a customer profile.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Payment profile id.
-	 */
-	public function create_customer_profile( $invoice, $submission_data, $save = true ) {
+     * @return string|WP_Error Payment profile id.
+     */
+    public function create_customer_profile( $invoice, $submission_data, $save = true ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace( '/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -182,14 +182,14 @@ 
     }
 
     /**
-	 * Retrieves a customer profile.
-	 *
-	 *
-	 * @param string $profile_id profile id.
-	 * @return string|WP_Error Profile id.
+     * Retrieves a customer profile.
+     *
+     *
+     * @param string $profile_id profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile
-	 */
-	public function get_customer_profile( $profile_id ) {
+     */
+    public function get_customer_profile( $profile_id ) {
 
         // Generate args.
         $args = array(
@@ -204,17 +204,17 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
+     * Creates a customer profile.
+     *
+     *
      * @param string $profile_id profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Profile id.
-	 */
-	public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
+     * @return string|WP_Error Profile id.
+     */
+    public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace( '/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -302,13 +302,13 @@ 
     }
 
     /**
-	 * Retrieves payment details from cache.
-	 *
-	 *
+     * Retrieves payment details from cache.
+     *
+     *
      * @param array $payment_details.
-	 * @return array|false Profile id.
-	 */
-	public function retrieve_payment_profile_from_cache( $payment_details, $customer_profile, $invoice ) {
+     * @return array|false Profile id.
+     */
+    public function retrieve_payment_profile_from_cache( $payment_details, $customer_profile, $invoice ) {
 
         $cached_information = get_option( 'getpaid_authorize_net_cached_profiles', array() );
         $payment_details    = hash_hmac( 'sha256', json_encode( $payment_details ), SECURE_AUTH_KEY );
@@ -333,13 +333,13 @@ 
     }
 
     /**
-	 * Securely adds payment details to cache.
-	 *
-	 *
+     * Securely adds payment details to cache.
+     *
+     *
      * @param array $payment_details.
      * @param string $payment_profile_id.
-	 */
-	public function add_payment_profile_to_cache( $payment_details, $payment_profile_id ) {
+     */
+    public function add_payment_profile_to_cache( $payment_details, $payment_profile_id ) {
 
         $cached_information = get_option( 'getpaid_authorize_net_cached_profiles', array() );
         $cached_information = is_array( $cached_information ) ? $cached_information : array();
@@ -351,15 +351,15 @@ 
     }
 
     /**
-	 * Retrieves a customer payment profile.
-	 *
-	 *
-	 * @param string $customer_profile_id customer profile id.
+     * Retrieves a customer payment profile.
+     *
+     *
+     * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @return string|WP_Error Profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile
-	 */
-	public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
+     */
+    public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
 
         // Generate args.
         $args = array(
@@ -375,15 +375,15 @@ 
     }
 
     /**
-	 * Charges a customer payment profile.
-	 *
+     * Charges a customer payment profile.
+     *
      * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile
-	 * @return WP_Error|object
-	 */
-	public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
+     * @return WP_Error|object
+     */
+    public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
 
         // Generate args.
         $args = array(
@@ -429,41 +429,41 @@ 
     }
 
     /**
-	 * Processes a customer charge.
-	 *
+     * Processes a customer charge.
+     *
      * @param stdClass $result Api response.
-	 * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function process_charge_response( $result, $invoice ) {
+     * @param WPInv_Invoice $invoice Invoice.
+     */
+    public function process_charge_response( $result, $invoice ) {
 
         wpinv_clear_errors();
-		$response_code = (int) $result->transactionResponse->responseCode;
+        $response_code = (int) $result->transactionResponse->responseCode;
 
-		// Succeeded.
-		if ( 1 == $response_code || 4 == $response_code ) {
+        // Succeeded.
+        if ( 1 == $response_code || 4 == $response_code ) {
 
-			// Maybe set a transaction id.
-			if ( ! empty( $result->transactionResponse->transId ) ) {
-				$invoice->set_transaction_id( $result->transactionResponse->transId );
-			}
+            // Maybe set a transaction id.
+            if ( ! empty( $result->transactionResponse->transId ) ) {
+                $invoice->set_transaction_id( $result->transactionResponse->transId );
+            }
 
-			$invoice->add_note( sprintf( __( 'Authentication code: %1$s (%2$s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
+            $invoice->add_note( sprintf( __( 'Authentication code: %1$s (%2$s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
 
-			if ( 1 == $response_code ) {
-				return $invoice->mark_paid();
-			}
+            if ( 1 == $response_code ) {
+                return $invoice->mark_paid();
+            }
 
-			$invoice->set_status( 'wpi-onhold' );
-        	$invoice->add_note(
+            $invoice->set_status( 'wpi-onhold' );
+            $invoice->add_note(
                 sprintf(
                     __( 'Held for review: %s', 'invoicing' ),
                     $result->transactionResponse->messages->message[0]->description
                 )
-			);
+            );
 
-			return $invoice->save();
+            return $invoice->save();
 
-		}
+        }
 
         wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) );
 
@@ -475,13 +475,13 @@ 
     }
 
     /**
-	 * Returns payment information.
-	 *
-	 *
-	 * @param array $card Card details.
-	 * @return array
-	 */
-	public function get_payment_information( $card ) {
+     * Returns payment information.
+     *
+     *
+     * @param array $card Card details.
+     * @return array
+     */
+    public function get_payment_information( $card ) {
         return array(
 
             'creditCard' => array(
@@ -494,25 +494,25 @@ 
     }
 
     /**
-	 * Returns the customer profile meta name.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return string
-	 */
-	public function get_customer_profile_meta_name( $invoice ) {
+     * Returns the customer profile meta name.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return string
+     */
+    public function get_customer_profile_meta_name( $invoice ) {
         return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id';
     }
 
     /**
-	 * Validates the submitted data.
-	 *
-	 *
-	 * @param array $submission_data Posted checkout fields.
+     * Validates the submitted data.
+     *
+     *
+     * @param array $submission_data Posted checkout fields.
      * @param WPInv_Invoice $invoice
-	 * @return WP_Error|string The payment profile id
-	 */
-	public function validate_submission_data( $submission_data, $invoice ) {
+     * @return WP_Error|string The payment profile id
+     */
+    public function validate_submission_data( $submission_data, $invoice ) {
 
         // Validate authentication details.
         $auth = $this->get_auth_params();
@@ -544,13 +544,13 @@ 
     }
 
     /**
-	 * Returns invoice line items.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return array
-	 */
-	public function get_line_items( $invoice ) {
+     * Returns invoice line items.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return array
+     */
+    public function get_line_items( $invoice ) {
         $items = array();
 
         foreach ( $invoice->get_items() as $item ) {
@@ -587,15 +587,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Validate the submitted data.
         $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice );
@@ -628,45 +628,45 @@ 
 
         exit;
 
-	}
+    }
 
-	/**
-	 * Processes the initial payment.
-	 *
+    /**
+     * Processes the initial payment.
+     *
      * @param WPInv_Invoice $invoice Invoice.
-	 */
-	protected function process_initial_payment( $invoice ) {
+     */
+    protected function process_initial_payment( $invoice ) {
 
-		$payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
         $customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
 
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
-			wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
+            wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Process the response.
-		$this->process_charge_response( $result, $invoice );
+        // Process the response.
+        $this->process_charge_response( $result, $invoice );
 
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-	}
+    }
 
     /**
-	 * Processes recurring payments.
-	 *
+     * Processes recurring payments.
+     *
      * @param WPInv_Invoice $invoice Invoice.
      * @param WPInv_Subscription[]|WPInv_Subscription $subscriptions Subscriptions.
-	 */
-	public function process_subscription( $invoice, $subscriptions ) {
+     */
+    public function process_subscription( $invoice, $subscriptions ) {
 
         // Check if there is an initial amount to charge.
         if ( (float) $invoice->get_total() > 0 ) {
-			$this->process_initial_payment( $invoice );
+            $this->process_initial_payment( $invoice );
         }
 
         // Activate the subscriptions.
@@ -684,36 +684,36 @@ 
             }
         }
 
-		// Redirect to the success page.
+        // Redirect to the success page.
         wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
     }
 
-	/**
-	 * (Maybe) renews an authorize.net subscription profile.
-	 *
-	 *
+    /**
+     * (Maybe) renews an authorize.net subscription profile.
+     *
+     *
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $subscription ) {
+     */
+    public function maybe_renew_subscription( $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( $this->id === $subscription->get_gateway() && $subscription->has_status( 'active trialling' ) ) {
             $this->renew_subscription( $subscription );
         }
 
-	}
+    }
 
     /**
-	 * Renews a subscription.
-	 *
+     * Renews a subscription.
+     *
      * @param WPInv_Subscription $subscription
-	 */
-	public function renew_subscription( $subscription ) {
+     */
+    public function renew_subscription( $subscription ) {
 
-		// Generate the renewal invoice.
-		$new_invoice = $subscription->create_payment();
-		$old_invoice = $subscription->get_parent_payment();
+        // Generate the renewal invoice.
+        $new_invoice = $subscription->create_payment();
+        $old_invoice = $subscription->get_parent_payment();
 
         if ( empty( $new_invoice ) ) {
             $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false );
@@ -722,37 +722,37 @@ 
         }
 
         // Charge the payment method.
-		$payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
-		$customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
-
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
-
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
-
-		}
-
-		// Process the response.
-		$this->process_charge_response( $result, $new_invoice );
-
-		if ( wpinv_get_errors() ) {
-
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
+        $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
+
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
+
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
+
+        }
+
+        // Process the response.
+        $this->process_charge_response( $result, $new_invoice );
+
+        if ( wpinv_get_errors() ) {
+
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
 
         }
 
@@ -761,13 +761,13 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
 
         global $getpaid_authorize_addons;
 
@@ -786,7 +786,7 @@ 
         $invoice->recalculate_total();
 
         $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
-		$customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
+        $customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
 
         add_filter( 'getpaid_authorizenet_charge_customer_payment_profile_args', array( $this, 'filter_addons_request' ), 10, 2 );
         $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
@@ -801,11 +801,11 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
+     * Processes invoice addons.
+     *
      * @param array $args
-	 * @return array
-	 */
+     * @return array
+     */
     public function filter_addons_request( $args ) {
 
         global $getpaid_authorize_addons;
@@ -839,11 +839,11 @@ 
     }
 
     /**
-	 * Filters the gateway settings.
-	 *
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
+     * Filters the gateway settings.
+     *
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
 
         $currencies = sprintf(
             __( 'Supported Currencies: %s', 'invoicing' ),
@@ -883,7 +883,7 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
 }

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

Indentation +37 added lines, -37 removed lines

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

includes/wpinv-subscription.php

Indentation +1023 added lines, -1023 removed lines

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

includes/class-getpaid-subscription-notification-emails.php

Indentation +269 added lines, -269 removed lines

@@ -13,311 +13,311 @@
 class GetPaid_Subscription_Notification_Emails {
 
     /**
-	 * The array of subscription email actions.
-	 *
-	 * @param array
-	 */
-	public $subscription_actions;
+     * The array of subscription email actions.
+     *
+     * @param array
+     */
+    public $subscription_actions;
 
     /**
-	 * Class constructor
+     * Class constructor
      *
-	 */
-	public function __construct() {
-
-		$this->subscription_actions = apply_filters(
-			'getpaid_notification_email_subscription_triggers',
-			array(
-				'getpaid_subscription_trialling' => 'subscription_trial',
-				'getpaid_subscription_cancelled' => 'subscription_cancelled',
-				'getpaid_subscription_expired'   => 'subscription_expired',
-				'getpaid_subscription_completed' => 'subscription_complete',
-				'getpaid_daily_maintenance'      => 'renewal_reminder',
-			)
-		);
-
-		$this->init_hooks();
+     */
+    public function __construct() {
+
+        $this->subscription_actions = apply_filters(
+            'getpaid_notification_email_subscription_triggers',
+            array(
+                'getpaid_subscription_trialling' => 'subscription_trial',
+                'getpaid_subscription_cancelled' => 'subscription_cancelled',
+                'getpaid_subscription_expired'   => 'subscription_expired',
+                'getpaid_subscription_completed' => 'subscription_complete',
+                'getpaid_daily_maintenance'      => 'renewal_reminder',
+            )
+        );
+
+        $this->init_hooks();
 
     }
 
     /**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
-		foreach ( $this->subscription_actions as $hook => $email_type ) {
-
-			$email = new GetPaid_Notification_Email( $email_type );
-
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $email_type ) ) {
-				add_action( $hook, array( $this, $email_type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
-
-		}
-
-	}
-
-	/**
-	 * Filters subscription merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function subscription_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			$merge_tags = array_merge(
-				$merge_tags,
-				$this->get_subscription_merge_tags( $object )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates subscription merge tags.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @return array
-	 */
-	public function get_subscription_merge_tags( $subscription ) {
-
-		// Abort if it does not exist.
-		if ( ! $subscription->get_id() ) {
-			return array();
-		}
-
-		$invoice    = $subscription->get_parent_invoice();
-		return array(
-			'{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
-			'{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
-			'{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
-			'{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
-			'{subscription_id}'               => absint( $subscription->get_id() ),
-			'{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
-			'{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
-			'{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
-			'{subscription_bill_times}'       => $subscription->get_bill_times(),
-			'{subscription_url}'              => esc_url( $subscription->get_view_url() ),
-		);
-
-	}
-
-	/**
-	 * Checks if we should send a notification for a subscription.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return bool
-	 */
-	public function should_send_notification( $invoice ) {
-		return 0 != $invoice->get_id();
-	}
-
-	/**
-	 * Returns notification recipients.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_recipients( $invoice ) {
-		$recipients = array( $invoice->get_email() );
-
-		$cc = $invoice->get_email_cc();
-
-		if ( ! empty( $cc ) ) {
-			$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-			$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-		}
-
-		return $recipients;
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $subscription, $email, $type, $extra_args = array() ) {
-
-		if ( empty( $subscription ) ) {
-			return;
-		}
-
-		if ( is_array( $subscription ) ) {
-			$subscription = current( $subscription );
-		}
-
-		if ( ! $subscription instanceof WPInv_Subscription ) {
-			return;
-		}
-
-		// Abort in case the parent invoice does not exist.
-		$invoice = $subscription->get_parent_invoice();
-		if ( ! $this->should_send_notification( $invoice ) ) {
-			return;
-		}
-
-		if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
-			return;
-		}
-
-		do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
-
-		$recipients  = $this->get_recipients( $invoice );
-		$mailer      = new GetPaid_Notification_Email_Sender();
-		$merge_tags  = $email->get_merge_tags();
-		$content     = $email->get_content( $merge_tags, $extra_args );
-		$subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
-		$attachments = $email->get_attachments();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$subject,
-			$content,
-			$attachments
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
-				$content,
-				$attachments
-			);
-		}
-
-		if ( $result ) {
-			$invoice->add_system_note(
-				sprintf(
-					__( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
-				)
-			);
-		} else {
-			$invoice->add_system_note(
-				sprintf(
-					__( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
-				)
-			);
-		}
-
-		do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
-
-	}
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
+        foreach ( $this->subscription_actions as $hook => $email_type ) {
+
+            $email = new GetPaid_Notification_Email( $email_type );
+
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $email_type ) ) {
+                add_action( $hook, array( $this, $email_type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
+
+        }
+
+    }
 
     /**
-	 * Sends a new trial notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_trial( $subscription ) {
+     * Filters subscription merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function subscription_merge_tags( $merge_tags, $object ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            $merge_tags = array_merge(
+                $merge_tags,
+                $this->get_subscription_merge_tags( $object )
+            );
+        }
 
-	}
+        return $merge_tags;
 
-	/**
-	 * Sends a cancelled subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_cancelled( $subscription ) {
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Generates subscription merge tags.
+     *
+     * @param WPInv_Subscription $subscription
+     * @return array
+     */
+    public function get_subscription_merge_tags( $subscription ) {
+
+        // Abort if it does not exist.
+        if ( ! $subscription->get_id() ) {
+            return array();
+        }
+
+        $invoice    = $subscription->get_parent_invoice();
+        return array(
+            '{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
+            '{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
+            '{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
+            '{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
+            '{subscription_id}'               => absint( $subscription->get_id() ),
+            '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
+            '{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
+            '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
+            '{subscription_bill_times}'       => $subscription->get_bill_times(),
+            '{subscription_url}'              => esc_url( $subscription->get_view_url() ),
+        );
 
-	}
+    }
 
-	/**
-	 * Sends a subscription expired notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_expired( $subscription ) {
+    /**
+     * Checks if we should send a notification for a subscription.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return bool
+     */
+    public function should_send_notification( $invoice ) {
+        return 0 != $invoice->get_id();
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Returns notification recipients.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_recipients( $invoice ) {
+        $recipients = array( $invoice->get_email() );
 
-	}
+        $cc = $invoice->get_email_cc();
 
-	/**
-	 * Sends a completed subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_complete( $subscription ) {
+        if ( ! empty( $cc ) ) {
+            $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+            $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        return $recipients;
+    }
 
-	}
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Subscription $subscription
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $subscription, $email, $type, $extra_args = array() ) {
+
+        if ( empty( $subscription ) ) {
+            return;
+        }
+
+        if ( is_array( $subscription ) ) {
+            $subscription = current( $subscription );
+        }
+
+        if ( ! $subscription instanceof WPInv_Subscription ) {
+            return;
+        }
+
+        // Abort in case the parent invoice does not exist.
+        $invoice = $subscription->get_parent_invoice();
+        if ( ! $this->should_send_notification( $invoice ) ) {
+            return;
+        }
+
+        if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
+            return;
+        }
+
+        do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
+
+        $recipients  = $this->get_recipients( $invoice );
+        $mailer      = new GetPaid_Notification_Email_Sender();
+        $merge_tags  = $email->get_merge_tags();
+        $content     = $email->get_content( $merge_tags, $extra_args );
+        $subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
+        $attachments = $email->get_attachments();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $subject,
+            $content,
+            $attachments
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
+                $content,
+                $attachments
+            );
+        }
+
+        if ( $result ) {
+            $invoice->add_system_note(
+                sprintf(
+                    __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+                )
+            );
+        } else {
+            $invoice->add_system_note(
+                sprintf(
+                    __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+                )
+            );
+        }
+
+        do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
 
-	/**
-	 * Sends a subscription renewal reminder notification.
-	 *
-	 */
-	public function renewal_reminder() {
+    }
 
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
+    /**
+     * Sends a new trial notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_trial( $subscription ) {
 
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
 
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
+    }
 
-		// Fetch matching subscriptions.
+    /**
+     * Sends a cancelled subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_cancelled( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription expired notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_expired( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a completed subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_complete( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription renewal reminder notification.
+     *
+     */
+    public function renewal_reminder() {
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Fetch matching subscriptions.
         $args  = array(
             'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active',
+            'count_total'        => false,
+            'status'             => 'trialling active',
             'date_expires_query' => array(
-				'relation' => 'OR',
+                'relation' => 'OR',
             ),
-		);
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
 
-			$args['date_expires_query'][] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $args['date_expires_query'][] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
 
         foreach ( $subscriptions->get_results() as $subscription ) {
 
-			// Skip packages.
-			if ( apply_filters( 'getpaid_send_subscription_renewal_reminder_email', true ) ) {
-				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
-			}
-		}
+            // Skip packages.
+            if ( apply_filters( 'getpaid_send_subscription_renewal_reminder_email', true ) ) {
+                $email->object = $subscription;
+                $this->send_email( $subscription, $email, __FUNCTION__ );
+            }
+        }
 
-	}
+    }
 
 }

templates/invoice/line-totals.php

Indentation +11 added lines, -11 removed lines

@@ -39,40 +39,40 @@
                                 if ( 'tax' === $key ) {
                                     wpinv_the_price( $invoice->get_total_tax(), $invoice->get_currency() );
 
-								if ( wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) {
+                                if ( wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) {
 
-									$taxes = $invoice->get_total_tax();
-									if ( empty( $taxes ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) {
-										echo ' <em class="text-muted small">';
-										_x( '(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing' );
-										echo '</em>';
+                                    $taxes = $invoice->get_total_tax();
+                                    if ( empty( $taxes ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) {
+                                        echo ' <em class="text-muted small">';
+                                        _x( '(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing' );
+                                        echo '</em>';
                                     }
 }
 }
 
                                 // Total Fee.
                                 if ( 'fee' === $key ) {
-								wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() );
                                 }
 
                                 // Total discount.
                                 if ( 'discount' === $key ) {
-								wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() );
                                 }
 
                                 // Shipping.
                                 if ( 'shipping' === $key ) {
-								wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() );
                                 }
 
                                 // Sub total.
                                 if ( 'subtotal' === $key ) {
-								wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() );
                                 }
 
                                 // Total.
                                 if ( 'total' === $key ) {
-								wpinv_the_price( $invoice->get_total(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total(), $invoice->get_currency() );
                                 }
 
                                 // Fires when printing a cart total.

includes/admin/class-wpinv-customers-table.php

Indentation +368 added lines, -368 removed lines

@@ -11,7 +11,7 @@ 
 
 // Load WP_List_Table if not loaded
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 /**
@@ -23,375 +23,375 @@ 
  */
 class WPInv_Customers_Table extends WP_List_Table {
 
-	/**
-	 * @var int Number of items per page
-	 * @since 1.0.19
-	 */
-	public $per_page = 10;
-
-	/**
-	 * @var int Number of items
-	 * @since 1.0.19
-	 */
-	public $total = 0;
-
-	/**
-	 * Get things started
-	 *
-	 * @since 1.0.19
-	 * @see WP_List_Table::__construct()
-	 */
-	public function __construct() {
-
-		// Set parent defaults
-		parent::__construct(
+    /**
+     * @var int Number of items per page
+     * @since 1.0.19
+     */
+    public $per_page = 10;
+
+    /**
+     * @var int Number of items
+     * @since 1.0.19
+     */
+    public $total = 0;
+
+    /**
+     * Get things started
+     *
+     * @since 1.0.19
+     * @see WP_List_Table::__construct()
+     */
+    public function __construct() {
+
+        // Set parent defaults
+        parent::__construct(
             array(
-				'singular' => 'id',
-				'plural'   => 'ids',
-				'ajax'     => false,
+                'singular' => 'id',
+                'plural'   => 'ids',
+                'ajax'     => false,
             )
         );
 
-	}
-
-	/**
-	 * Gets the name of the primary column.
-	 *
-	 * @since 1.0.19
-	 * @access protected
-	 *
-	 * @return string Name of the primary column.
-	 */
-	protected function get_primary_column_name() {
-		return 'name';
-	}
-
-	/**
-	 * This function renders most of the columns in the list table.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $item
-	 * @param string $column_name The name of the column
-	 *
-	 * @return string Column Name
-	 */
-	public function column_default( $item, $column_name ) {
-		$value = esc_html( get_user_meta( $item->ID, '_wpinv_' . $column_name, true ) );
-		return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $item );
-	}
-
-	/**
-	 * Displays the country column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_country( $user ) {
-		$country = wpinv_sanitize_country( $user->_wpinv_country );
-		if ( $country ) {
-			$country = wpinv_country_name( $country );
-		}
-		return esc_html( $country );
-	}
-
-	/**
-	 * Displays the state column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_state( $user ) {
-		$country = wpinv_sanitize_country( $user->_wpinv_country );
-		$state   = $user->_wpinv_state;
-		if ( $state ) {
-			$state = wpinv_state_name( $state, $country );
-		}
-
-		return esc_html( $state );
-	}
-
-	/**
-	 * Displays the signup column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_signup( $user ) {
-		return getpaid_format_date_value( $user->user_registered );
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_total( $user ) {
-		return wpinv_price( $this->column_total_raw( $user ) );
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return float
-	 */
-	public function column_total_raw( $user ) {
-
-		$args = array(
-			'data'           => array(
-
-				'total' => array(
-					'type'     => 'invoice_data',
-					'function' => 'SUM',
-					'name'     => 'total_sales',
-				),
-
-			),
-			'where'          => array(
-
-				'author' => array(
-					'type'     => 'post_data',
-					'value'    => absint( $user->ID ),
-					'key'      => 'posts.post_author',
-					'operator' => '=',
-				),
-
-			),
-			'query_type'     => 'get_var',
-			'invoice_status' => array( 'wpi-renewal', 'wpi-processing', 'publish' ),
-		);
-
-		return wpinv_round_amount( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
-
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_invoices( $user ) {
-
-		$args = array(
-			'data'           => array(
-
-				'ID' => array(
-					'type'     => 'post_data',
-					'function' => 'COUNT',
-					'name'     => 'count',
-					'distinct' => true,
-				),
-
-			),
-			'where'          => array(
-
-				'author' => array(
-					'type'     => 'post_data',
-					'value'    => absint( $user->ID ),
-					'key'      => 'posts.post_author',
-					'operator' => '=',
-				),
-
-			),
-			'query_type'     => 'get_var',
-			'invoice_status' => array_keys( wpinv_get_invoice_statuses() ),
-		);
-
-		$value = absint( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
-		$url   = add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $user->ID ), admin_url( 'edit.php' ) );
-		return empty( $value ) ? '0' : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>';
-
-	}
-
-	/**
-	 * Generates content for a single row of the table
-	 * @since 1.0.19
-	 *
-	 * @param int $item The user id.
-	 */
-	public function single_row( $item ) {
-		$item = get_user_by( 'id', $item );
-
-		if ( empty( $item ) ) {
-			return;
-		}
-
-		echo '<tr>';
-		$this->single_row_columns( $item );
-		echo '</tr>';
-	}
-
-	/**
-	 * Displays the customers name
-	 *
-	 * @param  WP_User $customer customer.
-	 * @return string
-	 */
-	public function column_name( $customer ) {
-
-		// Customer view URL.
-		$view_url    = esc_url( add_query_arg( 'user_id', $customer->ID, admin_url( 'user-edit.php' ) ) );
-		$row_actions = $this->row_actions(
-			array(
-				'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
-			)
-		);
-
-		// Get user's address.
-		$address = wpinv_get_user_address( $customer->ID );
-
-		// Customer email address.
-		$email       = sanitize_email( $customer->user_email );
-
-		// Customer's avatar.
-		$avatar = esc_url( get_avatar_url( $email ) );
-		$avatar = "<img src='$avatar' height='32' width='32'/>";
-
-		// Customer's name.
-		$name   = esc_html( "{$address['first_name']} {$address['last_name']}" );
-
-		if ( empty( trim( $name ) ) ) {
-			$name = esc_html( $address['display_name'] );
-		}
-
-		if ( ! empty( $name ) ) {
-			$name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
-		}
-
-		$email = "<div class='row-title'><a href='$view_url'>$email</a></div>";
-
-		return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
-
-	}
-
-	/**
-	 * Retrieve the table columns
-	 *
-	 * @since 1.0.19
-	 * @return array $columns Array of all the list table columns
-	 */
-	public function get_columns() {
-
-		$columns = array(
-			'name'     => __( 'Name', 'invoicing' ),
-			'country'  => __( 'Country', 'invoicing' ),
-			'state'    => __( 'State', 'invoicing' ),
-			'city'     => __( 'City', 'invoicing' ),
-			'zip'      => __( 'ZIP', 'invoicing' ),
-			'address'  => __( 'Address', 'invoicing' ),
-			'phone'    => __( 'Phone', 'invoicing' ),
-			'company'  => __( 'Company', 'invoicing' ),
-			'invoices' => __( 'Invoices', 'invoicing' ),
-			'total'    => __( 'Total Spend', 'invoicing' ),
-			'signup'   => __( 'Date created', 'invoicing' ),
-		);
-		return apply_filters( 'wpinv_customers_table_columns', $columns );
-
-	}
-
-	/**
-	 * Retrieve the current page number
-	 *
-	 * @since 1.0.19
-	 * @return int Current page number
-	 */
-	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
-	}
-
-	/**
-	 * Returns bulk actions.
-	 *
-	 * @since 1.0.19
-	 * @return void
-	 */
-	public function bulk_actions( $which = '' ) {
-		return array();
-	}
-
-	/**
-	 *  Prepares the display query
-	 */
-	public function prepare_query() {
-		global $wpdb;
-
-		$post_types = '';
-
-		foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
-			$post_types .= $wpdb->prepare( 'post_type=%s OR ', $post_type );
-		}
-
-		$post_types = rtrim( $post_types, ' OR' );
-
-		// Maybe search.
-		if ( ! empty( $_POST['s'] ) ) {
-			$users = get_users(
-				array(
-					'search'         => '*' . sanitize_text_field( urldecode( $_POST['s'] ) ) . '*',
-					'search_columns' => array( 'user_login', 'user_email', 'display_name' ),
-					'fields'         => 'ID',
-				)
-			);
-
-			$users      = implode( ', ', $users );
-			$post_types = "($post_types) AND ( post_author IN ( $users ) )";
-		}
-
-		// Users with invoices.
-    	$customers = $wpdb->get_col(
-			$wpdb->prepare(
-				"SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types LIMIT %d,%d",
-				$this->get_paged() * 10 - 10,
-				$this->per_page
-			)
-		);
-
-		$this->items = $customers;
-		$this->total = (int) $wpdb->get_var( "SELECT COUNT( DISTINCT( post_author ) ) FROM $wpdb->posts WHERE $post_types" );
-
-	}
-
-	/**
-	 * Setup the final data for the table
-	 *
-	 * @since 1.0.19
-	 * @return void
-	 */
-	public function prepare_items() {
-		$columns               = $this->get_columns();
-		$hidden                = array(); // No hidden columns
-		$sortable              = $this->get_sortable_columns();
-		$this->_column_headers = array( $columns, $hidden, $sortable );
-		$this->prepare_query();
-
-		$this->set_pagination_args(
-			array(
-				'total_items' => $this->total,
-				'per_page'    => $this->per_page,
-				'total_pages' => ceil( $this->total / $this->per_page ),
-			)
-		);
-
-	}
+    }
+
+    /**
+     * Gets the name of the primary column.
+     *
+     * @since 1.0.19
+     * @access protected
+     *
+     * @return string Name of the primary column.
+     */
+    protected function get_primary_column_name() {
+        return 'name';
+    }
+
+    /**
+     * This function renders most of the columns in the list table.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $item
+     * @param string $column_name The name of the column
+     *
+     * @return string Column Name
+     */
+    public function column_default( $item, $column_name ) {
+        $value = esc_html( get_user_meta( $item->ID, '_wpinv_' . $column_name, true ) );
+        return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $item );
+    }
+
+    /**
+     * Displays the country column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_country( $user ) {
+        $country = wpinv_sanitize_country( $user->_wpinv_country );
+        if ( $country ) {
+            $country = wpinv_country_name( $country );
+        }
+        return esc_html( $country );
+    }
+
+    /**
+     * Displays the state column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_state( $user ) {
+        $country = wpinv_sanitize_country( $user->_wpinv_country );
+        $state   = $user->_wpinv_state;
+        if ( $state ) {
+            $state = wpinv_state_name( $state, $country );
+        }
+
+        return esc_html( $state );
+    }
+
+    /**
+     * Displays the signup column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_signup( $user ) {
+        return getpaid_format_date_value( $user->user_registered );
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_total( $user ) {
+        return wpinv_price( $this->column_total_raw( $user ) );
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return float
+     */
+    public function column_total_raw( $user ) {
+
+        $args = array(
+            'data'           => array(
+
+                'total' => array(
+                    'type'     => 'invoice_data',
+                    'function' => 'SUM',
+                    'name'     => 'total_sales',
+                ),
+
+            ),
+            'where'          => array(
+
+                'author' => array(
+                    'type'     => 'post_data',
+                    'value'    => absint( $user->ID ),
+                    'key'      => 'posts.post_author',
+                    'operator' => '=',
+                ),
+
+            ),
+            'query_type'     => 'get_var',
+            'invoice_status' => array( 'wpi-renewal', 'wpi-processing', 'publish' ),
+        );
+
+        return wpinv_round_amount( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
+
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_invoices( $user ) {
+
+        $args = array(
+            'data'           => array(
+
+                'ID' => array(
+                    'type'     => 'post_data',
+                    'function' => 'COUNT',
+                    'name'     => 'count',
+                    'distinct' => true,
+                ),
+
+            ),
+            'where'          => array(
+
+                'author' => array(
+                    'type'     => 'post_data',
+                    'value'    => absint( $user->ID ),
+                    'key'      => 'posts.post_author',
+                    'operator' => '=',
+                ),
+
+            ),
+            'query_type'     => 'get_var',
+            'invoice_status' => array_keys( wpinv_get_invoice_statuses() ),
+        );
+
+        $value = absint( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
+        $url   = add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $user->ID ), admin_url( 'edit.php' ) );
+        return empty( $value ) ? '0' : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>';
+
+    }
+
+    /**
+     * Generates content for a single row of the table
+     * @since 1.0.19
+     *
+     * @param int $item The user id.
+     */
+    public function single_row( $item ) {
+        $item = get_user_by( 'id', $item );
+
+        if ( empty( $item ) ) {
+            return;
+        }
+
+        echo '<tr>';
+        $this->single_row_columns( $item );
+        echo '</tr>';
+    }
+
+    /**
+     * Displays the customers name
+     *
+     * @param  WP_User $customer customer.
+     * @return string
+     */
+    public function column_name( $customer ) {
+
+        // Customer view URL.
+        $view_url    = esc_url( add_query_arg( 'user_id', $customer->ID, admin_url( 'user-edit.php' ) ) );
+        $row_actions = $this->row_actions(
+            array(
+                'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
+            )
+        );
+
+        // Get user's address.
+        $address = wpinv_get_user_address( $customer->ID );
+
+        // Customer email address.
+        $email       = sanitize_email( $customer->user_email );
+
+        // Customer's avatar.
+        $avatar = esc_url( get_avatar_url( $email ) );
+        $avatar = "<img src='$avatar' height='32' width='32'/>";
+
+        // Customer's name.
+        $name   = esc_html( "{$address['first_name']} {$address['last_name']}" );
+
+        if ( empty( trim( $name ) ) ) {
+            $name = esc_html( $address['display_name'] );
+        }
+
+        if ( ! empty( $name ) ) {
+            $name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
+        }
+
+        $email = "<div class='row-title'><a href='$view_url'>$email</a></div>";
+
+        return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
+
+    }
+
+    /**
+     * Retrieve the table columns
+     *
+     * @since 1.0.19
+     * @return array $columns Array of all the list table columns
+     */
+    public function get_columns() {
+
+        $columns = array(
+            'name'     => __( 'Name', 'invoicing' ),
+            'country'  => __( 'Country', 'invoicing' ),
+            'state'    => __( 'State', 'invoicing' ),
+            'city'     => __( 'City', 'invoicing' ),
+            'zip'      => __( 'ZIP', 'invoicing' ),
+            'address'  => __( 'Address', 'invoicing' ),
+            'phone'    => __( 'Phone', 'invoicing' ),
+            'company'  => __( 'Company', 'invoicing' ),
+            'invoices' => __( 'Invoices', 'invoicing' ),
+            'total'    => __( 'Total Spend', 'invoicing' ),
+            'signup'   => __( 'Date created', 'invoicing' ),
+        );
+        return apply_filters( 'wpinv_customers_table_columns', $columns );
+
+    }
+
+    /**
+     * Retrieve the current page number
+     *
+     * @since 1.0.19
+     * @return int Current page number
+     */
+    public function get_paged() {
+        return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+    }
+
+    /**
+     * Returns bulk actions.
+     *
+     * @since 1.0.19
+     * @return void
+     */
+    public function bulk_actions( $which = '' ) {
+        return array();
+    }
+
+    /**
+     *  Prepares the display query
+     */
+    public function prepare_query() {
+        global $wpdb;
+
+        $post_types = '';
+
+        foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
+            $post_types .= $wpdb->prepare( 'post_type=%s OR ', $post_type );
+        }
+
+        $post_types = rtrim( $post_types, ' OR' );
+
+        // Maybe search.
+        if ( ! empty( $_POST['s'] ) ) {
+            $users = get_users(
+                array(
+                    'search'         => '*' . sanitize_text_field( urldecode( $_POST['s'] ) ) . '*',
+                    'search_columns' => array( 'user_login', 'user_email', 'display_name' ),
+                    'fields'         => 'ID',
+                )
+            );
+
+            $users      = implode( ', ', $users );
+            $post_types = "($post_types) AND ( post_author IN ( $users ) )";
+        }
+
+        // Users with invoices.
+        $customers = $wpdb->get_col(
+            $wpdb->prepare(
+                "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types LIMIT %d,%d",
+                $this->get_paged() * 10 - 10,
+                $this->per_page
+            )
+        );
+
+        $this->items = $customers;
+        $this->total = (int) $wpdb->get_var( "SELECT COUNT( DISTINCT( post_author ) ) FROM $wpdb->posts WHERE $post_types" );
+
+    }
+
+    /**
+     * Setup the final data for the table
+     *
+     * @since 1.0.19
+     * @return void
+     */
+    public function prepare_items() {
+        $columns               = $this->get_columns();
+        $hidden                = array(); // No hidden columns
+        $sortable              = $this->get_sortable_columns();
+        $this->_column_headers = array( $columns, $hidden, $sortable );
+        $this->prepare_query();
+
+        $this->set_pagination_args(
+            array(
+                'total_items' => $this->total,
+                'per_page'    => $this->per_page,
+                'total_pages' => ceil( $this->total / $this->per_page ),
+            )
+        );
+
+    }
 }

templates/payment-forms/form.php

Indentation +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
 
         // And the optional invoice id.
         if ( ! empty( $form->invoice ) ) {
-		    getpaid_hidden_field( 'invoice_id', $form->invoice->get_id() );
+            getpaid_hidden_field( 'invoice_id', $form->invoice->get_id() );
         }
 
         // We also want to include the form id.
@@ -77,7 +77,7 @@ 
 
                     foreach ( $form->get_elements() as $element ) {
 
-					    if ( isset( $element['type'] ) ) {
+                        if ( isset( $element['type'] ) ) {
                             $grid_class = getpaid_get_form_element_grid_class( $element );
                             echo "<div class='" . esc_attr( $grid_class ) . "'>";
                             do_action( 'getpaid_payment_form_element', $element, $form );

includes/admin/meta-boxes/class-getpaid-meta-box-description.php

Indentation +19 added lines, -19 removed lines

@@ -13,25 +13,25 @@
  */
 class GetPaid_Meta_Box_Description {
 
-	/**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post Post object.
-	 */
-	public static function output( $post ) {
+    /**
+     * Output the metabox.
+     *
+     * @param WP_Post $post Post object.
+     */
+    public static function output( $post ) {
 
-		$settings = array(
-			'textarea_name' => 'excerpt',
-			'quicktags'     => array( 'buttons' => 'em,strong,link' ),
-			'teeny'         => true,
-			'media_buttons' => false,
-			'tinymce'       => array(
-				'theme_advanced_buttons1' => 'bold,italic,strikethrough,separator,justifyleft,justifycenter,justifyright,separator,link,unlink,separator,undo,redo,separator',
-				'theme_advanced_buttons2' => '',
-			),
-			'editor_css'    => '<style>#wp-excerpt-editor-container .wp-editor-area{height:175px; width:100%;}</style>',
-		);
+        $settings = array(
+            'textarea_name' => 'excerpt',
+            'quicktags'     => array( 'buttons' => 'em,strong,link' ),
+            'teeny'         => true,
+            'media_buttons' => false,
+            'tinymce'       => array(
+                'theme_advanced_buttons1' => 'bold,italic,strikethrough,separator,justifyleft,justifycenter,justifyright,separator,link,unlink,separator,undo,redo,separator',
+                'theme_advanced_buttons2' => '',
+            ),
+            'editor_css'    => '<style>#wp-excerpt-editor-container .wp-editor-area{height:175px; width:100%;}</style>',
+        );
 
-		wp_editor( htmlspecialchars_decode( $post->post_excerpt, ENT_QUOTES ), 'excerpt', apply_filters( 'getpaid_description_editor_settings', $settings ) );
-	}
+        wp_editor( htmlspecialchars_decode( $post->post_excerpt, ENT_QUOTES ), 'excerpt', apply_filters( 'getpaid_description_editor_settings', $settings ) );
+    }
 }

includes/admin/class-getpaid-metaboxes.php

Indentation +243 added lines, -243 removed lines

@@ -12,280 +12,280 @@
  */
 class GetPaid_Metaboxes {
 
-	/**
-	 * Only save metaboxes once.
-	 *
-	 * @var boolean
-	 */
-	private static $saved_meta_boxes = false;
+    /**
+     * Only save metaboxes once.
+     *
+     * @var boolean
+     */
+    private static $saved_meta_boxes = false;
 
     /**
-	 * Hook in methods.
-	 */
-	public static function init() {
+     * Hook in methods.
+     */
+    public static function init() {
 
-		// Register metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 50, 2 );
+        // Register metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 50, 2 );
 
-		// Remove metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
+        // Remove metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
 
-		// Rename metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
+        // Rename metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
 
-		// Save metaboxes.
-		add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
-	}
+        // Save metaboxes.
+        add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
+    }
 
-	/**
-	 * Register core metaboxes.
-	 */
-	public static function add_meta_boxes( $post_type, $post ) {
+    /**
+     * Register core metaboxes.
+     */
+    public static function add_meta_boxes( $post_type, $post ) {
 
-		// For invoices.
-		self::add_invoice_meta_boxes( $post_type, $post );
+        // For invoices.
+        self::add_invoice_meta_boxes( $post_type, $post );
 
-		// For payment forms.
-		self::add_payment_form_meta_boxes( $post_type, $post );
+        // For payment forms.
+        self::add_payment_form_meta_boxes( $post_type, $post );
 
-		// For invoice items.
-		self::add_item_meta_boxes( $post_type );
+        // For invoice items.
+        self::add_item_meta_boxes( $post_type );
 
-		// For invoice discounts.
-		if ( 'wpi_discount' === $post_type ) {
-			add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
-		}
+        // For invoice discounts.
+        if ( 'wpi_discount' === $post_type ) {
+            add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
+        }
 
-	}
+    }
 
-	/**
-	 * Register core metaboxes.
-	 */
-	protected static function add_payment_form_meta_boxes( $post_type, $post ) {
+    /**
+     * Register core metaboxes.
+     */
+    protected static function add_payment_form_meta_boxes( $post_type, $post ) {
 
-		// For payment forms.
-		if ( 'wpi_payment_form' === $post_type ) {
+        // For payment forms.
+        if ( 'wpi_payment_form' === $post_type ) {
 
-			// Design payment form.
-			add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
+            // Design payment form.
+            add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
 
-			// Payment form information.
-			if ( wpinv_get_default_payment_form() !== $post->ID ) {
-				add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
-			}
+            // Payment form information.
+            if ( wpinv_get_default_payment_form() !== $post->ID ) {
+                add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
+            }
 }
 
-	}
-
-	/**
-	 * Register core metaboxes.
-	 */
-	protected static function add_item_meta_boxes( $post_type ) {
+    }
 
-		if ( 'wpi_item' === $post_type ) {
-
-			// Item details.
-			add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
-
-			// If taxes are enabled, register the tax metabox.
-			if ( wpinv_use_taxes() ) {
-				add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
-			}
+    /**
+     * Register core metaboxes.
+     */
+    protected static function add_item_meta_boxes( $post_type ) {
 
-			// Item info.
-			add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
+        if ( 'wpi_item' === $post_type ) {
 
-			// Item description.
-			add_meta_box( 'postexcerpt', __( 'Item Description', 'invoicing' ), 'GetPaid_Meta_Box_Description::output', 'wpi_item', 'normal' );
-		}
+            // Item details.
+            add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
 
-	}
+            // If taxes are enabled, register the tax metabox.
+            if ( wpinv_use_taxes() ) {
+                add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
+            }
 
-	/**
-	 * Register invoice metaboxes.
-	 */
-	protected static function add_invoice_meta_boxes( $post_type, $post ) {
+            // Item info.
+            add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
 
-		// For invoices...
-		if ( getpaid_is_invoice_post_type( $post_type ) ) {
-			$invoice = new WPInv_Invoice( $post );
+            // Item description.
+            add_meta_box( 'postexcerpt', __( 'Item Description', 'invoicing' ), 'GetPaid_Meta_Box_Description::output', 'wpi_item', 'normal' );
+        }
 
-			// Resend invoice.
-			if ( ! $invoice->is_draft() ) {
+    }
 
-				add_meta_box(
-					'wpinv-mb-resend-invoice',
-					sprintf(
-						// translators: %s is the invoice type.
-						__( 'Resend %s', 'invoicing' ),
-						ucfirst( $invoice->get_invoice_quote_type() )
-					),
-					'GetPaid_Meta_Box_Resend_Invoice::output',
-					$post_type,
-					'side',
-					'low'
-				);
+    /**
+     * Register invoice metaboxes.
+     */
+    protected static function add_invoice_meta_boxes( $post_type, $post ) {
+
+        // For invoices...
+        if ( getpaid_is_invoice_post_type( $post_type ) ) {
+            $invoice = new WPInv_Invoice( $post );
+
+            // Resend invoice.
+            if ( ! $invoice->is_draft() ) {
+
+                add_meta_box(
+                    'wpinv-mb-resend-invoice',
+                    sprintf(
+                        // translators: %s is the invoice type.
+                        __( 'Resend %s', 'invoicing' ),
+                        ucfirst( $invoice->get_invoice_quote_type() )
+                    ),
+                    'GetPaid_Meta_Box_Resend_Invoice::output',
+                    $post_type,
+                    'side',
+                    'low'
+                );
+
+            }
+
+            // Subscriptions.
+            $subscriptions = getpaid_get_invoice_subscriptions( $invoice );
+            if ( ! empty( $subscriptions ) ) {
+
+                if ( is_array( $subscriptions ) ) {
+                    add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' );
+                } else {
+                    add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' );
+                }
+
+                if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) {
+                    add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' );
+                }
+}
 
-			}
+            // Invoice details.
+            add_meta_box(
+                'wpinv-details',
+                sprintf(
+                    // translators: %s is the invoice type.
+                    __( '%s Details', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'GetPaid_Meta_Box_Invoice_Details::output',
+                $post_type,
+                'side'
+            );
+
+            // Payment details.
+            add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' );
+
+            // Billing details.
+            add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' );
+
+            // Invoice items.
+            add_meta_box(
+                'wpinv-items',
+                sprintf(
+                    // translators: %s is the invoice type.
+                    __( '%s Items', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'GetPaid_Meta_Box_Invoice_Items::output',
+                $post_type,
+                'normal',
+                'high'
+            );
+
+            // Invoice notes.
+            add_meta_box(
+                'wpinv-notes',
+                sprintf(
+                    // translators: %s is the invoice type.
+                    __( '%s Notes', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'WPInv_Meta_Box_Notes::output',
+                $post_type,
+                'side',
+                'low'
+            );
+
+            // Shipping Address.
+            if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) {
+                add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' );
+            }
+
+            // Payment form information.
+            if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) {
+                add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' );
+            }
+}
 
-			// Subscriptions.
-			$subscriptions = getpaid_get_invoice_subscriptions( $invoice );
-			if ( ! empty( $subscriptions ) ) {
+    }
 
-				if ( is_array( $subscriptions ) ) {
-					add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' );
-				} else {
-					add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' );
-				}
+    /**
+     * Remove some metaboxes.
+     */
+    public static function remove_meta_boxes() {
+        remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
+        remove_meta_box( 'postexcerpt', 'wpi_item', 'normal' );
+    }
 
-				if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) {
-					add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' );
-				}
-}
+    /**
+     * Rename other metaboxes.
+     */
+    public static function rename_meta_boxes() {
 
-			// Invoice details.
-			add_meta_box(
-				'wpinv-details',
-				sprintf(
-					// translators: %s is the invoice type.
-					__( '%s Details', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'GetPaid_Meta_Box_Invoice_Details::output',
-				$post_type,
-				'side'
-			);
-
-			// Payment details.
-			add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' );
-
-			// Billing details.
-			add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' );
-
-			// Invoice items.
-			add_meta_box(
-				'wpinv-items',
-				sprintf(
-					// translators: %s is the invoice type.
-					__( '%s Items', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'GetPaid_Meta_Box_Invoice_Items::output',
-				$post_type,
-				'normal',
-				'high'
-			);
-
-			// Invoice notes.
-			add_meta_box(
-				'wpinv-notes',
-				sprintf(
-					// translators: %s is the invoice type.
-					__( '%s Notes', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'WPInv_Meta_Box_Notes::output',
-				$post_type,
-				'side',
-				'low'
-			);
-
-			// Shipping Address.
-			if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) {
-				add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' );
-			}
-
-			// Payment form information.
-			if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) {
-				add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' );
-			}
-}
+    }
 
-	}
-
-	/**
-	 * Remove some metaboxes.
-	 */
-	public static function remove_meta_boxes() {
-		remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
-		remove_meta_box( 'postexcerpt', 'wpi_item', 'normal' );
-	}
-
-	/**
-	 * Rename other metaboxes.
-	 */
-	public static function rename_meta_boxes() {
-
-	}
-
-	/**
-	 * Check if we're saving, then trigger an action based on the post type.
-	 *
-	 * @param  int    $post_id Post ID.
-	 * @param  object $post Post object.
-	 */
-	public static function save_meta_boxes( $post_id, $post ) {
-		$post_id = absint( $post_id );
-		$data    = wp_kses_post_deep( wp_unslash( $_POST ) );
-
-		// Do not save for ajax requests.
-		if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
-			return;
-		}
-
-		// $post_id and $post are required
-		if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
-			return;
-		}
-
-		// Dont' save meta boxes for revisions or autosaves.
-		if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
-			return;
-		}
-
-		// Check the nonce.
-		if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
-			return;
-		}
-
-		// Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
-		if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
-			return;
-		}
-
-		// Check user has permission to edit.
-		if ( ! current_user_can( 'edit_post', $post_id ) ) {
-			return;
-		}
-
-		if ( getpaid_is_invoice_post_type( $post->post_type ) ) {
-
-			// We need this save event to run once to avoid potential endless loops.
-			self::$saved_meta_boxes = true;
-
-			return GetPaid_Meta_Box_Invoice_Address::save( $post_id );
-
-		}
-
-		// Ensure this is our post type.
-		$post_types_map = array(
-			'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
-			'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
-			'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
-		);
-
-		// Is this our post type?
-		if ( ! isset( $post_types_map[ $post->post_type ] ) ) {
-			return;
-		}
-
-		// We need this save event to run once to avoid potential endless loops.
-		self::$saved_meta_boxes = true;
-
-		// Save the post.
-		$class = $post_types_map[ $post->post_type ];
-		$class::save( $post_id, wp_kses_post_deep( $_POST ), $post );
-
-	}
+    /**
+     * Check if we're saving, then trigger an action based on the post type.
+     *
+     * @param  int    $post_id Post ID.
+     * @param  object $post Post object.
+     */
+    public static function save_meta_boxes( $post_id, $post ) {
+        $post_id = absint( $post_id );
+        $data    = wp_kses_post_deep( wp_unslash( $_POST ) );
+
+        // Do not save for ajax requests.
+        if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
+            return;
+        }
+
+        // $post_id and $post are required
+        if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
+            return;
+        }
+
+        // Dont' save meta boxes for revisions or autosaves.
+        if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
+            return;
+        }
+
+        // Check the nonce.
+        if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
+            return;
+        }
+
+        // Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
+        if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
+            return;
+        }
+
+        // Check user has permission to edit.
+        if ( ! current_user_can( 'edit_post', $post_id ) ) {
+            return;
+        }
+
+        if ( getpaid_is_invoice_post_type( $post->post_type ) ) {
+
+            // We need this save event to run once to avoid potential endless loops.
+            self::$saved_meta_boxes = true;
+
+            return GetPaid_Meta_Box_Invoice_Address::save( $post_id );
+
+        }
+
+        // Ensure this is our post type.
+        $post_types_map = array(
+            'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
+            'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
+            'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
+        );
+
+        // Is this our post type?
+        if ( ! isset( $post_types_map[ $post->post_type ] ) ) {
+            return;
+        }
+
+        // We need this save event to run once to avoid potential endless loops.
+        self::$saved_meta_boxes = true;
+
+        // Save the post.
+        $class = $post_types_map[ $post->post_type ];
+        $class::save( $post_id, wp_kses_post_deep( $_POST ), $post );
+
+    }
 
 }