AyeCode / invoicing

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

Indentation +610 added lines, -610 removed lines

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

includes/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'] );
@@ -175,14 +175,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(
@@ -197,17 +197,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'] );
@@ -282,13 +282,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 );
@@ -313,13 +313,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();
@@ -331,15 +331,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(
@@ -355,15 +355,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(
@@ -409,41 +409,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: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
+            $invoice->add_note( sprintf( __( 'Authentication code: %s (%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' ) );
 
@@ -455,13 +455,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 (
@@ -474,25 +474,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();
@@ -524,13 +524,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 ) {
@@ -568,15 +568,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 );
@@ -609,45 +609,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.
@@ -665,36 +665,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 );
@@ -703,37 +703,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;
 
         }
 
@@ -742,13 +742,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;
 
@@ -768,7 +768,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 );
@@ -783,11 +783,11 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
+     * Processes invoice addons.
+     *
      * @param array $args
-	 * @return array
-	 */
+     * @return array
+     */
     public function filter_addons_request( $args ) {
 
         global $getpaid_authorize_addons;
@@ -821,11 +821,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' ),
@@ -865,7 +865,7 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
 }

includes/geolocation/class-getpaid-maxmind-geolocation.php

Indentation +160 added lines, -160 removed lines

@@ -16,165 +16,165 @@
  */
 class GetPaid_MaxMind_Geolocation {
 
-	/**
-	 * The service responsible for interacting with the MaxMind database.
-	 *
-	 * @var GetPaid_MaxMind_Database_Service
-	 */
-	private $database_service;
-
-	/**
-	 * Initialize the integration.
-	 */
-	public function __construct() {
-
-		/**
-		 * Supports overriding the database service to be used.
-		 *
-		 * @since 1.0.19
-		 * @return mixed|null The geolocation database service.
-		 */
-		$this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null );
-		if ( null === $this->database_service ) {
-			$this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() );
-		}
-
-		// Bind to the scheduled updater action.
-		add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) );
-
-		// Bind to the geolocation filter for MaxMind database lookups.
-		add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 );
-
-		// Handle maxmind key updates.
-		add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) );
-
-	}
-
-	/**
-	 * Get database service.
-	 *
-	 * @return GetPaid_MaxMind_Database_Service|null
-	 */
-	public function get_database_service() {
-		return $this->database_service;
-	}
-
-	/**
-	 * Checks to make sure that the license key is valid.
-	 *
-	 * @param string $license_key The new license key.
-	 * @return string
-	 */
-	public function handle_key_updates( $license_key ) {
-
-		// Trim whitespaces and strip slashes.
-		$license_key = trim( $license_key );
-
-		// Abort if the license key is empty or unchanged.
-		if ( empty( $license_key ) ) {
-			return $license_key;
-		}
-
-		// Abort if a database exists and the license key is unchaged.
-		if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) {
-			return $license_key;
-		}
-
-		// Check the license key by attempting to download the Geolocation database.
-		$tmp_database_path = $this->database_service->download_database( $license_key );
-		if ( is_wp_error( $tmp_database_path ) ) {
-			getpaid_admin()->show_error( $tmp_database_path->get_error_message() );
-			return $license_key;
-		}
-
-		$this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path );
-
-		return $license_key;
-	}
-
-	/**
-	 * Updates the database used for geolocation queries.
-	 *
-	 * @param string $tmp_database_path Temporary database path.
-	 */
-	public function update_database( $tmp_database_path = null ) {
-
-		// Allow us to easily interact with the filesystem.
-		require_once ABSPATH . 'wp-admin/includes/file.php';
-		WP_Filesystem();
-		global $wp_filesystem;
-
-		// Remove any existing archives to comply with the MaxMind TOS.
-		$target_database_path = $this->database_service->get_database_path();
-
-		// If there's no database path, we can't store the database.
-		if ( empty( $target_database_path ) ) {
-			return;
-		}
-
-		if ( $wp_filesystem->exists( $target_database_path ) ) {
-			$wp_filesystem->delete( $target_database_path );
-		}
-
-		// We can't download a database if there's no license key configured.
-		$license_key = wpinv_get_option( 'maxmind_license_key' );
-		if ( empty( $license_key ) ) {
-			return;
-		}
-
-		if ( empty( $tmp_database_path ) ) {
-			$tmp_database_path = $this->database_service->download_database( $license_key );
-		}
-
-		if ( is_wp_error( $tmp_database_path ) ) {
-			wpinv_error_log( $tmp_database_path->get_error_message() );
-			return;
-		}
-
-		// Move the new database into position.
-		$wp_filesystem->move( $tmp_database_path, $target_database_path, true );
-		$wp_filesystem->delete( dirname( $tmp_database_path ) );
-	}
-
-	/**
-	 * Performs a geolocation lookup against the MaxMind database for the given IP address.
-	 *
-	 * @param array  $data       Geolocation data.
-	 * @param string $ip_address The IP address to geolocate.
-	 * @return array Geolocation including country code, state, city and postcode based on an IP address.
-	 */
-	public function get_geolocation( $data, $ip_address ) {
-
-		if ( ! empty( $data['country'] ) || empty( $ip_address ) ) {
-			return $data;
-		}
-
-		$country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address );
-
-		return array(
-			'country'  => $country_code,
-			'state'    => '',
-			'city'     => '',
-			'postcode' => '',
-		);
-
-	}
-
-	/**
-	 * Fetches the prefix for the MaxMind database file.
-	 *
-	 * @return string
-	 */
-	private function get_database_prefix() {
-
-		$prefix = get_option( 'wpinv_maxmind_database_prefix' );
-
-		if ( empty( $prefix ) ) {
-			$prefix = md5( uniqid( 'wpinv' ) );
-			update_option( 'wpinv_maxmind_database_prefix', $prefix );
-		}
-
-		return $prefix;
-	}
+    /**
+     * The service responsible for interacting with the MaxMind database.
+     *
+     * @var GetPaid_MaxMind_Database_Service
+     */
+    private $database_service;
+
+    /**
+     * Initialize the integration.
+     */
+    public function __construct() {
+
+        /**
+         * Supports overriding the database service to be used.
+         *
+         * @since 1.0.19
+         * @return mixed|null The geolocation database service.
+         */
+        $this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null );
+        if ( null === $this->database_service ) {
+            $this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() );
+        }
+
+        // Bind to the scheduled updater action.
+        add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) );
+
+        // Bind to the geolocation filter for MaxMind database lookups.
+        add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 );
+
+        // Handle maxmind key updates.
+        add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) );
+
+    }
+
+    /**
+     * Get database service.
+     *
+     * @return GetPaid_MaxMind_Database_Service|null
+     */
+    public function get_database_service() {
+        return $this->database_service;
+    }
+
+    /**
+     * Checks to make sure that the license key is valid.
+     *
+     * @param string $license_key The new license key.
+     * @return string
+     */
+    public function handle_key_updates( $license_key ) {
+
+        // Trim whitespaces and strip slashes.
+        $license_key = trim( $license_key );
+
+        // Abort if the license key is empty or unchanged.
+        if ( empty( $license_key ) ) {
+            return $license_key;
+        }
+
+        // Abort if a database exists and the license key is unchaged.
+        if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) {
+            return $license_key;
+        }
+
+        // Check the license key by attempting to download the Geolocation database.
+        $tmp_database_path = $this->database_service->download_database( $license_key );
+        if ( is_wp_error( $tmp_database_path ) ) {
+            getpaid_admin()->show_error( $tmp_database_path->get_error_message() );
+            return $license_key;
+        }
+
+        $this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path );
+
+        return $license_key;
+    }
+
+    /**
+     * Updates the database used for geolocation queries.
+     *
+     * @param string $tmp_database_path Temporary database path.
+     */
+    public function update_database( $tmp_database_path = null ) {
+
+        // Allow us to easily interact with the filesystem.
+        require_once ABSPATH . 'wp-admin/includes/file.php';
+        WP_Filesystem();
+        global $wp_filesystem;
+
+        // Remove any existing archives to comply with the MaxMind TOS.
+        $target_database_path = $this->database_service->get_database_path();
+
+        // If there's no database path, we can't store the database.
+        if ( empty( $target_database_path ) ) {
+            return;
+        }
+
+        if ( $wp_filesystem->exists( $target_database_path ) ) {
+            $wp_filesystem->delete( $target_database_path );
+        }
+
+        // We can't download a database if there's no license key configured.
+        $license_key = wpinv_get_option( 'maxmind_license_key' );
+        if ( empty( $license_key ) ) {
+            return;
+        }
+
+        if ( empty( $tmp_database_path ) ) {
+            $tmp_database_path = $this->database_service->download_database( $license_key );
+        }
+
+        if ( is_wp_error( $tmp_database_path ) ) {
+            wpinv_error_log( $tmp_database_path->get_error_message() );
+            return;
+        }
+
+        // Move the new database into position.
+        $wp_filesystem->move( $tmp_database_path, $target_database_path, true );
+        $wp_filesystem->delete( dirname( $tmp_database_path ) );
+    }
+
+    /**
+     * Performs a geolocation lookup against the MaxMind database for the given IP address.
+     *
+     * @param array  $data       Geolocation data.
+     * @param string $ip_address The IP address to geolocate.
+     * @return array Geolocation including country code, state, city and postcode based on an IP address.
+     */
+    public function get_geolocation( $data, $ip_address ) {
+
+        if ( ! empty( $data['country'] ) || empty( $ip_address ) ) {
+            return $data;
+        }
+
+        $country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address );
+
+        return array(
+            'country'  => $country_code,
+            'state'    => '',
+            'city'     => '',
+            'postcode' => '',
+        );
+
+    }
+
+    /**
+     * Fetches the prefix for the MaxMind database file.
+     *
+     * @return string
+     */
+    private function get_database_prefix() {
+
+        $prefix = get_option( 'wpinv_maxmind_database_prefix' );
+
+        if ( empty( $prefix ) ) {
+            $prefix = md5( uniqid( 'wpinv' ) );
+            update_option( 'wpinv_maxmind_database_prefix', $prefix );
+        }
+
+        return $prefix;
+    }
 
 }

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();
@@ -85,12 +85,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' ) ) {
@@ -110,13 +110,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/data-stores/class-getpaid-data.php

Indentation +863 added lines, -863 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,356 +21,356 @@ 
  */
 abstract class GetPaid_Data {
 
-	/**
-	 * ID for this object.
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	protected $id = 0;
-
-	/**
-	 * Core data for this object. Name value pairs (name + default value).
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Core data changes for this object.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $changes = array();
-
-	/**
-	 * This is false until the object is read from the DB.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $object_read = false;
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $object_type = 'data';
-
-	/**
-	 * Extra data for this object. Name value pairs (name + default value).
-	 * Used as a standard way for sub classes (like item types) to add
-	 * additional information to an inherited class.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $extra_data = array();
-
-	/**
-	 * Set to _data on construct so we can track and reset data if needed.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $default_data = array();
-
-	/**
-	 * Contains a reference to the data store for this class.
-	 *
-	 * @since 1.0.19
-	 * @var GetPaid_Data_Store
-	 */
-	protected $data_store;
-
-	/**
-	 * Stores meta in cache for future reads.
-	 * A group must be set to to enable caching.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $cache_group = '';
-
-	/**
-	 * Stores the last error.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $last_error = '';
-
-	/**
-	 * Stores additional meta data.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $meta_data = null;
-
-	/**
-	 * Default constructor.
-	 *
-	 * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
-	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
-		$this->default_data = $this->data;
-	}
-
-	/**
-	 * Only store the object ID to avoid serializing the data object instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'id' );
-	}
-
-	/**
-	 * Re-run the constructor with the object ID.
-	 *
-	 * If the object no longer exists, remove the ID.
-	 */
-	public function __wakeup() {
-		$this->__construct( absint( $this->id ) );
-
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
-		}
-
-	}
-
-	/**
-	 * When the object is cloned, make sure meta is duplicated correctly.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __clone() {
-		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get the data store.
-	 *
-	 * @since  1.0.19
-	 * @return object
-	 */
-	public function get_data_store() {
-		return $this->data_store;
-	}
-
-	/**
-	 * Get the object type.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Returns the unique ID for this object.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function get_id() {
-		return $this->id;
-	}
-
-	/**
-	 * Get form 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 );
-    }
-
-	/**
-	 * Delete an object, set the ID to 0, and return result.
-	 *
-	 * @since  1.0.19
-	 * @param  bool $force_delete Should the data be deleted permanently.
-	 * @return bool result
-	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store && $this->exists() ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Save should create or update based on object existence.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function save() {
-		if ( ! $this->data_store ) {
-			return $this->get_id();
-		}
-
-		/**
-		 * Trigger action before saving to the DB. Allows you to adjust object props before save.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
-		} else {
-			$this->data_store->create( $this );
-		}
-
-		/**
-		 * Trigger action after saving to the DB.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Change data to JSON format.
-	 *
-	 * @since  1.0.19
-	 * @return string Data in JSON format.
-	 */
-	public function __toString() {
-		return wp_json_encode( $this->get_data() );
-	}
-
-	/**
-	 * Returns all data for this object.
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
-	}
-
-	/**
-	 * Returns array of expected data keys for this object.
-	 *
-	 * @since   1.0.19
-	 * @return array
-	 */
-	public function get_data_keys() {
-		return array_keys( $this->data );
-	}
-
-	/**
-	 * Returns all "extra" data keys for an object (for sub objects like item types).
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
-	}
-
-	/**
-	 * Filter null meta values from array.
-	 *
-	 * @since  1.0.19
-	 * @param mixed $meta Meta value to check.
-	 * @return bool
-	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
-	}
-
-	/**
-	 * Get All Meta Data.
-	 *
-	 * @since 1.0.19
-	 * @return array of objects.
-	 */
-	public function get_meta_data() {
-		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
-	}
-
-	/**
-	 * Check if the key is an internal one.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Key to check.
-	 * @return bool   true if it's an internal key, false otherwise
-	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
-
-		if ( ! $internal_meta_key ) {
-			return false;
-		}
-
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
-
-		if ( ! $has_setter_or_getter ) {
-			return false;
-		}
-
-		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Magic method for setting data fields.
-	 *
-	 * This method does not update custom fields in the database.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 */
-	public function __set( $key, $value ) {
-
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
-		}
-
-		if ( method_exists( $this, "set_$key") ) {
-
-			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-			call_user_func( array( $this, "set_$key" ), $value );
-		} else {
-			$this->set_prop( $key, $value );
-		}
-
-	}
-
-	/**
+    /**
+     * ID for this object.
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    protected $id = 0;
+
+    /**
+     * Core data for this object. Name value pairs (name + default value).
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Core data changes for this object.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $changes = array();
+
+    /**
+     * This is false until the object is read from the DB.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $object_read = false;
+
+    /**
+     * This is the name of this object type.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $object_type = 'data';
+
+    /**
+     * Extra data for this object. Name value pairs (name + default value).
+     * Used as a standard way for sub classes (like item types) to add
+     * additional information to an inherited class.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $extra_data = array();
+
+    /**
+     * Set to _data on construct so we can track and reset data if needed.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $default_data = array();
+
+    /**
+     * Contains a reference to the data store for this class.
+     *
+     * @since 1.0.19
+     * @var GetPaid_Data_Store
+     */
+    protected $data_store;
+
+    /**
+     * Stores meta in cache for future reads.
+     * A group must be set to to enable caching.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $cache_group = '';
+
+    /**
+     * Stores the last error.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $last_error = '';
+
+    /**
+     * Stores additional meta data.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $meta_data = null;
+
+    /**
+     * Default constructor.
+     *
+     * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
+     */
+    public function __construct( $read = 0 ) {
+        $this->data         = array_merge( $this->data, $this->extra_data );
+        $this->default_data = $this->data;
+    }
+
+    /**
+     * Only store the object ID to avoid serializing the data object instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'id' );
+    }
+
+    /**
+     * Re-run the constructor with the object ID.
+     *
+     * If the object no longer exists, remove the ID.
+     */
+    public function __wakeup() {
+        $this->__construct( absint( $this->id ) );
+
+        if ( ! empty( $this->last_error ) ) {
+            $this->set_id( 0 );
+        }
+
+    }
+
+    /**
+     * When the object is cloned, make sure meta is duplicated correctly.
+     *
+     * @since 1.0.19
+     */
+    public function __clone() {
+        $this->maybe_read_meta_data();
+        if ( ! empty( $this->meta_data ) ) {
+            foreach ( $this->meta_data as $array_key => $meta ) {
+                $this->meta_data[ $array_key ] = clone $meta;
+                if ( ! empty( $meta->id ) ) {
+                    $this->meta_data[ $array_key ]->id = null;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the data store.
+     *
+     * @since  1.0.19
+     * @return object
+     */
+    public function get_data_store() {
+        return $this->data_store;
+    }
+
+    /**
+     * Get the object type.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Returns the unique ID for this object.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function get_id() {
+        return $this->id;
+    }
+
+    /**
+     * Get form 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 );
+    }
+
+    /**
+     * Delete an object, set the ID to 0, and return result.
+     *
+     * @since  1.0.19
+     * @param  bool $force_delete Should the data be deleted permanently.
+     * @return bool result
+     */
+    public function delete( $force_delete = false ) {
+        if ( $this->data_store && $this->exists() ) {
+            $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
+            $this->set_id( 0 );
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Save should create or update based on object existence.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function save() {
+        if ( ! $this->data_store ) {
+            return $this->get_id();
+        }
+
+        /**
+         * Trigger action before saving to the DB. Allows you to adjust object props before save.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        if ( $this->get_id() ) {
+            $this->data_store->update( $this );
+        } else {
+            $this->data_store->create( $this );
+        }
+
+        /**
+         * Trigger action after saving to the DB.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Change data to JSON format.
+     *
+     * @since  1.0.19
+     * @return string Data in JSON format.
+     */
+    public function __toString() {
+        return wp_json_encode( $this->get_data() );
+    }
+
+    /**
+     * Returns all data for this object.
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+    }
+
+    /**
+     * Returns array of expected data keys for this object.
+     *
+     * @since   1.0.19
+     * @return array
+     */
+    public function get_data_keys() {
+        return array_keys( $this->data );
+    }
+
+    /**
+     * Returns all "extra" data keys for an object (for sub objects like item types).
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_extra_data_keys() {
+        return array_keys( $this->extra_data );
+    }
+
+    /**
+     * Filter null meta values from array.
+     *
+     * @since  1.0.19
+     * @param mixed $meta Meta value to check.
+     * @return bool
+     */
+    protected function filter_null_meta( $meta ) {
+        return ! is_null( $meta->value );
+    }
+
+    /**
+     * Get All Meta Data.
+     *
+     * @since 1.0.19
+     * @return array of objects.
+     */
+    public function get_meta_data() {
+        $this->maybe_read_meta_data();
+        return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+    }
+
+    /**
+     * Check if the key is an internal one.
+     *
+     * @since  1.0.19
+     * @param  string $key Key to check.
+     * @return bool   true if it's an internal key, false otherwise
+     */
+    protected function is_internal_meta_key( $key ) {
+        $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+
+        if ( ! $internal_meta_key ) {
+            return false;
+        }
+
+        $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+
+        if ( ! $has_setter_or_getter ) {
+            return false;
+        }
+
+        /* translators: %s: $key Key to check */
+        getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Magic method for setting data fields.
+     *
+     * This method does not update custom fields in the database.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     */
+    public function __set( $key, $value ) {
+
+        if ( 'id' == strtolower( $key ) ) {
+            return $this->set_id( $value );
+        }
+
+        if ( method_exists( $this, "set_$key") ) {
+
+            /* translators: %s: $key Key to set */
+            getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+            call_user_func( array( $this, "set_$key" ), $value );
+        } else {
+            $this->set_prop( $key, $value );
+        }
+
+    }
+
+    /**
      * Margic method for retrieving a property.
      */
     public function __get( $key ) {
@@ -378,10 +378,10 @@ 
         // Check if we have a helper method for that.
         if ( method_exists( $this, 'get_' . $key ) ) {
 
-			if ( 'post_type' != $key ) {
-				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-			}
+            if ( 'post_type' != $key ) {
+                /* translators: %s: $key Key to set */
+                getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,515 +391,515 @@ 
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
-
-    }
-
-	/**
-	 * Get Meta Data by Key.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @param  bool   $single return first found meta with key, or all with $key.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
-
-		// Check if this is an internal meta key.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_key );
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'get_' . $_key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}();
-			}
-		}
-
-		// Read the meta data if not yet read.
-		$this->maybe_read_meta_data();
-		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
-		$value      = $single ? '' : array();
-
-		if ( ! empty( $array_keys ) ) {
-			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
-			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
-			}
-		}
-
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * See if meta data exists, since get_meta always returns a '' or array().
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @return boolean
-	 */
-	public function meta_exists( $key = '' ) {
-		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
-	}
-
-	/**
-	 * Set all meta data from array.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Key/Value pairs.
-	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
-			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
-				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
-					$this->meta_data[] = new GetPaid_Meta_Data(
-						array(
-							'id'    => $meta['id'],
-							'key'   => $meta['key'],
-							'value' => $meta['value'],
-						)
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Add meta data.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string       $key Meta key.
-	 * @param string|array $value Meta value.
-	 * @param bool         $unique Should this be a unique key?.
-	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
-		}
-		$this->meta_data[] = new GetPaid_Meta_Data(
-			array(
-				'key'   => $key,
-				'value' => $value,
-			)
-		);
-
-		$this->save();
-	}
-
-	/**
-	 * Update meta data by key or ID, if provided.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param  string       $key Meta key.
-	 * @param  string|array $value Meta value.
-	 * @param  int          $meta_id Meta ID.
-	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-
-		$array_key = false;
-
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
-		} else {
-			// Find matches by key.
-			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
-					$matches[] = $meta_data_array_key;
-				}
-			}
-
-			if ( ! empty( $matches ) ) {
-				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
-				}
-				$array_key = current( $matches );
-			}
-		}
-
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
-			$meta->key   = $key;
-			$meta->value = $value;
-		} else {
-			$this->add_meta_data( $key, $value, true );
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param string $key Meta key.
-	 */
-	public function delete_meta_data( $key ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param int $mid Meta ID.
-	 */
-	public function delete_meta_data_by_mid( $mid ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Read meta data if null.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
-			$this->read_meta_data();
-		}
-	}
-
-	/**
-	 * Read Meta Data from the database. Ignore any internal properties.
-	 * Uses it's own caches because get_metadata does not provide meta_ids.
-	 *
-	 * @since 1.0.19
-	 * @param bool $force_read True to force a new DB read (and update cache).
-	 */
-	public function read_meta_data( $force_read = false ) {
-
-		// Reset meta data.
-		$this->meta_data = array();
-
-		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
-			return;
-		}
-
-		// Only read from cache if the cache key is set.
-		$cache_key = null;
-		if ( ! $force_read && ! empty( $this->cache_group ) ) {
-			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
-		}
-
-		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
-
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-
-		}
-
-		// Set meta data.
-		if ( is_array( $raw_meta_data ) ) {
-
-			foreach ( $raw_meta_data as $meta ) {
-				$this->meta_data[] = new GetPaid_Meta_Data(
-					array(
-						'id'    => (int) $meta->meta_id,
-						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
-					)
-				);
-			}
-
-		}
-
-	}
-
-	/**
-	 * Update Meta Data in the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
-			return;
-		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
-				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
-				$meta->apply_changes();
-			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
-					$meta->apply_changes();
-				}
-			}
-		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
-		}
-	}
-
-	/**
-	 * Set ID.
-	 *
-	 * @since 1.0.19
-	 * @param int $id ID.
-	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+        return $this->get_prop( $key );
+
+    }
+
+    /**
+     * Get Meta Data by Key.
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @param  bool   $single return first found meta with key, or all with $key.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    public function get_meta( $key = '', $single = true, $context = 'view' ) {
+
+        // Check if this is an internal meta key.
+        $_key = str_replace( '_wpinv', '', $key );
+        $_key = str_replace( 'wpinv', '', $_key );
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'get_' . $_key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}();
+            }
+        }
+
+        // Read the meta data if not yet read.
+        $this->maybe_read_meta_data();
+        $meta_data  = $this->get_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+        $value      = $single ? '' : array();
+
+        if ( ! empty( $array_keys ) ) {
+            // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
+            if ( $single ) {
+                $value = $meta_data[ current( $array_keys ) ]->value;
+            } else {
+                $value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+            }
+        }
+
+        if ( 'view' === $context ) {
+            $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+        }
+
+        return $value;
+    }
+
+    /**
+     * See if meta data exists, since get_meta always returns a '' or array().
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @return boolean
+     */
+    public function meta_exists( $key = '' ) {
+        $this->maybe_read_meta_data();
+        $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
+        return in_array( $key, $array_keys, true );
+    }
+
+    /**
+     * Set all meta data from array.
+     *
+     * @since 1.0.19
+     * @param array $data Key/Value pairs.
+     */
+    public function set_meta_data( $data ) {
+        if ( ! empty( $data ) && is_array( $data ) ) {
+            $this->maybe_read_meta_data();
+            foreach ( $data as $meta ) {
+                $meta = (array) $meta;
+                if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+                    $this->meta_data[] = new GetPaid_Meta_Data(
+                        array(
+                            'id'    => $meta['id'],
+                            'key'   => $meta['key'],
+                            'value' => $meta['value'],
+                        )
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * Add meta data.
+     *
+     * @since 1.0.19
+     *
+     * @param string       $key Meta key.
+     * @param string|array $value Meta value.
+     * @param bool         $unique Should this be a unique key?.
+     */
+    public function add_meta_data( $key, $value, $unique = false ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+        if ( $unique ) {
+            $this->delete_meta_data( $key );
+        }
+        $this->meta_data[] = new GetPaid_Meta_Data(
+            array(
+                'key'   => $key,
+                'value' => $value,
+            )
+        );
+
+        $this->save();
+    }
+
+    /**
+     * Update meta data by key or ID, if provided.
+     *
+     * @since  1.0.19
+     *
+     * @param  string       $key Meta key.
+     * @param  string|array $value Meta value.
+     * @param  int          $meta_id Meta ID.
+     */
+    public function update_meta_data( $key, $value, $meta_id = 0 ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+
+        $array_key = false;
+
+        if ( $meta_id ) {
+            $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
+            $array_key  = $array_keys ? current( $array_keys ) : false;
+        } else {
+            // Find matches by key.
+            $matches = array();
+            foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
+                if ( $meta->key === $key ) {
+                    $matches[] = $meta_data_array_key;
+                }
+            }
+
+            if ( ! empty( $matches ) ) {
+                // Set matches to null so only one key gets the new value.
+                foreach ( $matches as $meta_data_array_key ) {
+                    $this->meta_data[ $meta_data_array_key ]->value = null;
+                }
+                $array_key = current( $matches );
+            }
+        }
+
+        if ( false !== $array_key ) {
+            $meta        = $this->meta_data[ $array_key ];
+            $meta->key   = $key;
+            $meta->value = $value;
+        } else {
+            $this->add_meta_data( $key, $value, true );
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param string $key Meta key.
+     */
+    public function delete_meta_data( $key ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param int $mid Meta ID.
+     */
+    public function delete_meta_data_by_mid( $mid ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Read meta data if null.
+     *
+     * @since 1.0.19
+     */
+    protected function maybe_read_meta_data() {
+        if ( is_null( $this->meta_data ) ) {
+            $this->read_meta_data();
+        }
+    }
+
+    /**
+     * Read Meta Data from the database. Ignore any internal properties.
+     * Uses it's own caches because get_metadata does not provide meta_ids.
+     *
+     * @since 1.0.19
+     * @param bool $force_read True to force a new DB read (and update cache).
+     */
+    public function read_meta_data( $force_read = false ) {
+
+        // Reset meta data.
+        $this->meta_data = array();
+
+        // Maybe abort early.
+        if ( ! $this->get_id() || ! $this->data_store ) {
+            return;
+        }
+
+        // Only read from cache if the cache key is set.
+        $cache_key = null;
+        if ( ! $force_read && ! empty( $this->cache_group ) ) {
+            $cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+        }
+
+        // Should we force read?
+        if ( empty( $raw_meta_data ) ) {
+            $raw_meta_data = $this->data_store->read_meta( $this );
+
+            if ( ! empty( $cache_key ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+
+        }
+
+        // Set meta data.
+        if ( is_array( $raw_meta_data ) ) {
+
+            foreach ( $raw_meta_data as $meta ) {
+                $this->meta_data[] = new GetPaid_Meta_Data(
+                    array(
+                        'id'    => (int) $meta->meta_id,
+                        'key'   => $meta->meta_key,
+                        'value' => maybe_unserialize( $meta->meta_value ),
+                    )
+                );
+            }
+
+        }
+
+    }
+
+    /**
+     * Update Meta Data in the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_meta_data() {
+        if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+            return;
+        }
+        foreach ( $this->meta_data as $array_key => $meta ) {
+            if ( is_null( $meta->value ) ) {
+                if ( ! empty( $meta->id ) ) {
+                    $this->data_store->delete_meta( $this, $meta );
+                    unset( $this->meta_data[ $array_key ] );
+                }
+            } elseif ( empty( $meta->id ) ) {
+                $meta->id = $this->data_store->add_meta( $this, $meta );
+                $meta->apply_changes();
+            } else {
+                if ( $meta->get_changes() ) {
+                    $this->data_store->update_meta( $this, $meta );
+                    $meta->apply_changes();
+                }
+            }
+        }
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            wp_cache_delete( $cache_key, $this->cache_group );
+        }
+    }
+
+    /**
+     * Set ID.
+     *
+     * @since 1.0.19
+     * @param int $id ID.
+     */
+    public function set_id( $id ) {
+        $this->id = absint( $id );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
-		$this->set_prop( 'status', $status );
-
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
-    }
-
-	/**
-	 * Set all props to default values.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_defaults() {
-		$this->data    = $this->default_data;
-		$this->changes = array();
-		$this->set_object_read( false );
-	}
-
-	/**
-	 * Set object read property.
-	 *
-	 * @since 1.0.19
-	 * @param boolean $read Should read?.
-	 */
-	public function set_object_read( $read = true ) {
-		$this->object_read = (bool) $read;
-	}
-
-	/**
-	 * Get object read property.
-	 *
-	 * @since  1.0.19
-	 * @return boolean
-	 */
-	public function get_object_read() {
-		return (bool) $this->object_read;
-	}
-
-	/**
-	 * Set a collection of props in one go, collect any errors, and return the result.
-	 * Only sets using public methods.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @param string $context In what context to run this.
-	 *
-	 * @return bool|WP_Error
-	 */
-	public function set_props( $props, $context = 'set' ) {
-		$errors = false;
-
-		$props = wp_unslash( $props );
-		foreach ( $props as $prop => $value ) {
-			try {
-				/**
-				 * Checks if the prop being set is allowed, and the value is not null.
-				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
-					continue;
-				}
-				$setter = "set_$prop";
-
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
-				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
-					$errors = new WP_Error();
-				}
-				$errors->add( $e->getCode(), $e->getMessage() );
-				$this->last_error = $e->getMessage();
-			}
-		}
-
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
-	}
-
-	/**
-	 * Sets a prop for a setter method.
-	 *
-	 * This stores changes in a special array so we can track what needs saving
-	 * the the DB later.
-	 *
-	 * @since 1.0.19
-	 * @param string $prop Name of prop to set.
-	 * @param mixed  $value Value of the prop.
-	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
-				}
-			} else {
-				$this->data[ $prop ] = $value;
-			}
-		}
-	}
-
-	/**
-	 * Return data changes only.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_changes() {
-		return $this->changes;
-	}
-
-	/**
-	 * Merge changes with data and clear.
-	 *
-	 * @since 1.0.19
-	 */
-	public function apply_changes() {
-		$this->data    = array_replace( $this->data, $this->changes );
-		$this->changes = array();
-	}
-
-	/**
-	 * Prefix for action and filter hooks on data.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	protected function get_hook_prefix() {
-		return 'wpinv_get_' . $this->object_type . '_';
-	}
-
-	/**
-	 * Gets a prop for a getter method.
-	 *
-	 * Gets the value from either current pending changes, or the data itself.
-	 * Context controls what happens to the value before it's returned.
-	 *
-	 * @since  1.0.19
-	 * @param  string $prop Name of prop to get.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	protected function get_prop( $prop, $context = 'view' ) {
-		$value = null;
-
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
-
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
-			}
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Sets a date prop whilst handling formatting and datetime objects.
-	 *
-	 * @since 1.0.19
-	 * @param string         $prop Name of prop to set.
-	 * @param string|integer $value Value of the prop.
-	 */
-	protected function set_date_prop( $prop, $value ) {
-
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
-			return;
-		}
-		$this->set_prop( $prop, $value );
-
-	}
-
-	/**
-	 * When invalid data is found, throw an exception unless reading from the DB.
-	 *
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		$this->last_error = $message;
-	}
-
-	/**
-	 * Checks if the object is saved in the database
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function exists() {
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
+        $this->set_prop( 'status', $status );
+
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
+    }
+
+    /**
+     * Set all props to default values.
+     *
+     * @since 1.0.19
+     */
+    public function set_defaults() {
+        $this->data    = $this->default_data;
+        $this->changes = array();
+        $this->set_object_read( false );
+    }
+
+    /**
+     * Set object read property.
+     *
+     * @since 1.0.19
+     * @param boolean $read Should read?.
+     */
+    public function set_object_read( $read = true ) {
+        $this->object_read = (bool) $read;
+    }
+
+    /**
+     * Get object read property.
+     *
+     * @since  1.0.19
+     * @return boolean
+     */
+    public function get_object_read() {
+        return (bool) $this->object_read;
+    }
+
+    /**
+     * Set a collection of props in one go, collect any errors, and return the result.
+     * Only sets using public methods.
+     *
+     * @since  1.0.19
+     *
+     * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
+     * @param string $context In what context to run this.
+     *
+     * @return bool|WP_Error
+     */
+    public function set_props( $props, $context = 'set' ) {
+        $errors = false;
+
+        $props = wp_unslash( $props );
+        foreach ( $props as $prop => $value ) {
+            try {
+                /**
+                 * Checks if the prop being set is allowed, and the value is not null.
+                 */
+                if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+                    continue;
+                }
+                $setter = "set_$prop";
+
+                if ( is_callable( array( $this, $setter ) ) ) {
+                    $this->{$setter}( $value );
+                }
+            } catch ( Exception $e ) {
+                if ( ! $errors ) {
+                    $errors = new WP_Error();
+                }
+                $errors->add( $e->getCode(), $e->getMessage() );
+                $this->last_error = $e->getMessage();
+            }
+        }
+
+        return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+    }
+
+    /**
+     * Sets a prop for a setter method.
+     *
+     * This stores changes in a special array so we can track what needs saving
+     * the the DB later.
+     *
+     * @since 1.0.19
+     * @param string $prop Name of prop to set.
+     * @param mixed  $value Value of the prop.
+     */
+    protected function set_prop( $prop, $value ) {
+        if ( array_key_exists( $prop, $this->data ) ) {
+            if ( true === $this->object_read ) {
+                if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
+                    $this->changes[ $prop ] = $value;
+                }
+            } else {
+                $this->data[ $prop ] = $value;
+            }
+        }
+    }
+
+    /**
+     * Return data changes only.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_changes() {
+        return $this->changes;
+    }
+
+    /**
+     * Merge changes with data and clear.
+     *
+     * @since 1.0.19
+     */
+    public function apply_changes() {
+        $this->data    = array_replace( $this->data, $this->changes );
+        $this->changes = array();
+    }
+
+    /**
+     * Prefix for action and filter hooks on data.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    protected function get_hook_prefix() {
+        return 'wpinv_get_' . $this->object_type . '_';
+    }
+
+    /**
+     * Gets a prop for a getter method.
+     *
+     * Gets the value from either current pending changes, or the data itself.
+     * Context controls what happens to the value before it's returned.
+     *
+     * @since  1.0.19
+     * @param  string $prop Name of prop to get.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    protected function get_prop( $prop, $context = 'view' ) {
+        $value = null;
+
+        if ( array_key_exists( $prop, $this->data ) ) {
+            $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+
+            if ( 'view' === $context ) {
+                $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Sets a date prop whilst handling formatting and datetime objects.
+     *
+     * @since 1.0.19
+     * @param string         $prop Name of prop to set.
+     * @param string|integer $value Value of the prop.
+     */
+    protected function set_date_prop( $prop, $value ) {
+
+        if ( empty( $value ) ) {
+            $this->set_prop( $prop, null );
+            return;
+        }
+        $this->set_prop( $prop, $value );
+
+    }
+
+    /**
+     * When invalid data is found, throw an exception unless reading from the DB.
+     *
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        $this->last_error = $message;
+    }
+
+    /**
+     * Checks if the object is saved in the database
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function exists() {
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
 
 }

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

Indentation +257 added lines, -257 removed lines

@@ -13,300 +13,300 @@
 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() ) {
-
-		// 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 %s notification email to %s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
-				)
-			);
-		} else {
-			$invoice->add_system_note(
-				sprintf(
-					__( 'Failed sending %s notification email to %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() ) {
+
+        // 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 %s notification email to %s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+                )
+            );
+        } else {
+            $invoice->add_system_note(
+                sprintf(
+                    __( 'Failed sending %s notification email to %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 as $subscription ) {
 
-			// Skip packages.
-			if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
-				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
-			}
+            // Skip packages.
+            if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
+                $email->object = $subscription;
+                $this->send_email( $subscription, $email, __FUNCTION__ );
+            }
 
-		}
+        }
 
-	}
+    }
 
 }

includes/admin/html-admin-page-addons.php

Indentation +70 added lines, -70 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 add_ThickBox();
 ?>
@@ -14,18 +14,18 @@ 
 	<?php if ( $tabs ){ ?>
 		<nav class="nav-tab-wrapper wpi-nav-tab-wrapper">
 			<?php
-			foreach ( $tabs as $name => $label ) {
-				echo '<a href="' . admin_url( 'admin.php?page=wpi-addons&tab=' . $name ) . '" class="nav-tab ' . ( $current_tab == $name ? 'nav-tab-active' : '' ) . '">' . $label . '</a>';
-			}
-			do_action( 'wpi_addons_tabs' );
-			?>
+            foreach ( $tabs as $name => $label ) {
+                echo '<a href="' . admin_url( 'admin.php?page=wpi-addons&tab=' . $name ) . '" class="nav-tab ' . ( $current_tab == $name ? 'nav-tab-active' : '' ) . '">' . $label . '</a>';
+            }
+            do_action( 'wpi_addons_tabs' );
+            ?>
 		</nav>
 
 		<?php
 
-		if($current_tab == 'membership'){
+        if($current_tab == 'membership'){
 
-			?>
+            ?>
 
 			<div class="wpi-membership-tab-conatiner">
 				<div class="membership-content">
@@ -36,9 +36,9 @@ 
 					<h2><?php _e("Have a membership key?","invoicing");?></h2>
 					<p>
 						<?php
-						$wpeu_admin = new External_Updates_Admin('wpinvoicing.com','1');
-						echo $wpeu_admin->render_licence_actions('wpinvoicing.com', 'membership',array(95, 106, 108,12351));
-						?>
+                        $wpeu_admin = new External_Updates_Admin('wpinvoicing.com','1');
+                        echo $wpeu_admin->render_licence_actions('wpinvoicing.com', 'membership',array(95, 106, 108,12351));
+                        ?>
 					</p>
 				<?php }?>
 
@@ -48,13 +48,13 @@ 
 							<div class="feature-list">
 								<ul>
 									<?php
-									$addon_obj = new WPInv_Admin_Addons();
-									if ($addons = $addon_obj->get_section_data( 'addons' ) ) {
-										foreach ( $addons as $addon ) {
-											echo '<li><i class="far fa-check-circle fa-sm"></i> '.esc_html( $addon->info->title ).'</li>';
-										}
-									}
-									?>
+                                    $addon_obj = new WPInv_Admin_Addons();
+                                    if ($addons = $addon_obj->get_section_data( 'addons' ) ) {
+                                        foreach ( $addons as $addon ) {
+                                            echo '<li><i class="far fa-check-circle fa-sm"></i> '.esc_html( $addon->info->title ).'</li>';
+                                        }
+                                    }
+                                    ?>
 									</ul>
 
 									<div class="feature-cta">
@@ -65,12 +65,12 @@ 
 									<h3><?php _e("Included Gateways:","invoicing");?></h3>
 									<ul>
 										<?php
-										if ($addons = $addon_obj->get_section_data( 'gateways' ) ) {
-											foreach ( $addons as $addon ) {
-												echo '<li><i class="far fa-check-circle fa-sm"></i> '.esc_html( $addon->info->title ).'</li>';
-											}
-										}
-										?>
+                                        if ($addons = $addon_obj->get_section_data( 'gateways' ) ) {
+                                            foreach ( $addons as $addon ) {
+                                                echo '<li><i class="far fa-check-circle fa-sm"></i> '.esc_html( $addon->info->title ).'</li>';
+                                            }
+                                        }
+                                        ?>
 								</ul>
 							</div>
 
@@ -81,8 +81,8 @@ 
 						<div class="testimonial-content">
 							<div class="t-image">
 								<?php
-									echo '<img src="' . plugins_url( 'images/t-image2.png', dirname(__FILE__) ) . '" > ';
-								?>
+                                    echo '<img src="' . plugins_url( 'images/t-image2.png', dirname(__FILE__) ) . '" > ';
+                                ?>
 							</div>
 							<div class="t-content">
 								<p>
@@ -101,8 +101,8 @@ 
 						<div class="testimonial-content">
 							<div class="t-image">
 								<?php
-									echo '<img src="' . plugins_url( 'images/t-image1.png', dirname(__FILE__) ) . '" > ';
-								?>
+                                    echo '<img src="' . plugins_url( 'images/t-image1.png', dirname(__FILE__) ) . '" > ';
+                                ?>
 							</div>
 							<div class="t-content">
 								<p>
@@ -126,21 +126,21 @@ 
 			</div>
 		</div>
 			<?php
-		}else{
-			$installed_plugins = get_plugins();
+        }else{
+            $installed_plugins = get_plugins();
             $addon_obj = new WPInv_Admin_Addons();
-			if ($addons = $addon_obj->get_section_data( $current_tab ) ) :
-				//print_r($addons);
-				?>
+            if ($addons = $addon_obj->get_section_data( $current_tab ) ) :
+                //print_r($addons);
+                ?>
 				<ul class="wpi-products"><?php foreach ( $addons as $addon ) :
                         if(965==$addon->info->id){continue;}// don't show quote add on
-						?><li class="wpi-product">
+                        ?><li class="wpi-product">
 								<div class="wpi-product-title">
 									<h3><?php
-										if ( ! empty( $addon->info->excerpt) ){
-											echo wpi_help_tip( $addon->info->excerpt );
-										}
-										echo esc_html( $addon->info->title ); ?></h3>
+                                        if ( ! empty( $addon->info->excerpt) ){
+                                            echo wpi_help_tip( $addon->info->excerpt );
+                                        }
+                                        echo esc_html( $addon->info->title ); ?></h3>
 								</div>
 
 								<span class="wpi-product-image">
@@ -148,32 +148,32 @@ 
 										<img src="<?php echo esc_attr( $addon->info->thumbnail ); ?>"/>
 									<?php endif;
 
-									if ( 'stripe-payment-gateway' == $addon->info->slug ) {
-										$addon->info->slug = 'getpaid-stripe-payments';
-										$addon->info->link = 'https://wordpress.org/plugins/getpaid-stripe-payments/';
-									}
-
-									if(isset($addon->info->link) && substr( $addon->info->link, 0, 21 ) === "https://wordpress.org"){
-										echo '<a href="'.admin_url('/plugin-install.php?tab=plugin-information&plugin='.$addon->info->slug).'&width=770&height=660&TB_iframe=true" class="thickbox" >';
-										echo '<span class="wpi-product-info">'.__('More info','invoicing').'</span>';
-										echo '</a>';
-									}elseif(isset($addon->info->link) && ( substr( $addon->info->link, 0, 23 ) === "https://wpinvoicing.com" || substr( $addon->info->link, 0, 21 ) === "https://wpgetpaid.com" ) ){
-										if(defined('WP_EASY_UPDATES_ACTIVE')){
-											$url = admin_url('/plugin-install.php?tab=plugin-information&plugin='.$addon->info->slug.'&width=770&height=660&item_id='.$addon->info->id.'&update_url=https://wpgetpaid.com&TB_iframe=true');
-										}else{
-											// if installed show activation link
-											if(isset($installed_plugins['wp-easy-updates/external-updates.php'])){
-												$url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-activation';
-											}else{
-												$url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-for-external';
-											}
-										}
-										echo '<a href="'.$url.'" class="thickbox">';
-										echo '<span class="wpi-product-info">'.__('More info','invoicing').'</span>';
-										echo '</a>';
-									}
-
-									?>
+                                    if ( 'stripe-payment-gateway' == $addon->info->slug ) {
+                                        $addon->info->slug = 'getpaid-stripe-payments';
+                                        $addon->info->link = 'https://wordpress.org/plugins/getpaid-stripe-payments/';
+                                    }
+
+                                    if(isset($addon->info->link) && substr( $addon->info->link, 0, 21 ) === "https://wordpress.org"){
+                                        echo '<a href="'.admin_url('/plugin-install.php?tab=plugin-information&plugin='.$addon->info->slug).'&width=770&height=660&TB_iframe=true" class="thickbox" >';
+                                        echo '<span class="wpi-product-info">'.__('More info','invoicing').'</span>';
+                                        echo '</a>';
+                                    }elseif(isset($addon->info->link) && ( substr( $addon->info->link, 0, 23 ) === "https://wpinvoicing.com" || substr( $addon->info->link, 0, 21 ) === "https://wpgetpaid.com" ) ){
+                                        if(defined('WP_EASY_UPDATES_ACTIVE')){
+                                            $url = admin_url('/plugin-install.php?tab=plugin-information&plugin='.$addon->info->slug.'&width=770&height=660&item_id='.$addon->info->id.'&update_url=https://wpgetpaid.com&TB_iframe=true');
+                                        }else{
+                                            // if installed show activation link
+                                            if(isset($installed_plugins['wp-easy-updates/external-updates.php'])){
+                                                $url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-activation';
+                                            }else{
+                                                $url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-for-external';
+                                            }
+                                        }
+                                        echo '<a href="'.$url.'" class="thickbox">';
+                                        echo '<span class="wpi-product-info">'.__('More info','invoicing').'</span>';
+                                        echo '</a>';
+                                    }
+
+                                    ?>
 
 								</span>
 
@@ -181,15 +181,15 @@ 
 								<span class="wpi-product-button">
 									<?php
                                     $addon_obj->output_button( $addon );
-									?>
+                                    ?>
 								</span>
 
 								<span class="wpi-price"><?php //print_r($addon); //echo wp_kses_post( $addon->price ); ?></span></li><?php endforeach; ?></ul>
 			<?php endif;
-		}
+        }
 
-	}
-	?>
+    }
+    ?>
 
 
 	<div class="clearfix" ></div>
@@ -208,8 +208,8 @@ 
 			<input class="wpeu-licence-key" type="text" placeholder="<?php _e("Enter your licence key",'invoicing');?>"> <button class="button-primary wpeu-licence-popup-button" ><?php _e("Install",'invoicing');?></button>
 			<br>
 			<?php
-			echo sprintf( __('%sFind your licence key here%s OR %sBuy one here%s', 'invoicing'), '<a href="https://wpinvoicing.com/your-account/" target="_blank">','</a>','<a class="wpeu-licence-link" href="https://wpinvoicing.com/downloads/category/addons/" target="_blank">','</a>' );
-			?>
+            echo sprintf( __('%sFind your licence key here%s OR %sBuy one here%s', 'invoicing'), '<a href="https://wpinvoicing.com/your-account/" target="_blank">','</a>','<a class="wpeu-licence-link" href="https://wpinvoicing.com/downloads/category/addons/" target="_blank">','</a>' );
+            ?>
 		</span>
 	</div>
 

includes/wpinv-address-functions.php

Indentation +88 added lines, -88 removed lines

@@ -13,9 +13,9 @@ 
 
 
 function wpinv_get_default_country() {
-	$country = wpinv_get_option( 'default_country', 'UK' );
+    $country = wpinv_get_option( 'default_country', 'UK' );
 
-	return apply_filters( 'wpinv_default_country', $country );
+    return apply_filters( 'wpinv_default_country', $country );
 }
 
 /**
@@ -36,7 +36,7 @@ 
  */
 function wpinv_sanitize_country( $country ) {
 
-	// Enure the country is specified
+    // Enure the country is specified
     if ( empty( $country ) ) {
         $country = wpinv_get_default_country();
     }
@@ -66,9 +66,9 @@ 
 }
 
 function wpinv_get_default_state() {
-	$state = wpinv_get_option( 'default_state', '' );
+    $state = wpinv_get_option( 'default_state', '' );
 
-	return apply_filters( 'wpinv_default_state', $state );
+    return apply_filters( 'wpinv_default_state', $state );
 }
 
 function wpinv_state_name( $state_code = '', $country_code = '' ) {
@@ -305,11 +305,11 @@ 
 
     $country = wpinv_sanitize_country( $country );
     
-	foreach ( wpinv_get_continents( 'countries' ) as $continent_code => $countries ) {
-		if ( false !== array_search( $country, $countries, true ) ) {
-			return $continent_code;
-		}
-	}
+    foreach ( wpinv_get_continents( 'countries' ) as $continent_code => $countries ) {
+        if ( false !== array_search( $country, $countries, true ) ) {
+            return $continent_code;
+        }
+    }
 
     return '';
     
@@ -601,33 +601,33 @@ 
 }
 
 function wpinv_get_states_field() {
-	if( empty( $_POST['country'] ) ) {
-		$_POST['country'] = wpinv_get_default_country();
-	}
-	$states = wpinv_get_country_states( sanitize_text_field( $_POST['country'] ) );
+    if( empty( $_POST['country'] ) ) {
+        $_POST['country'] = wpinv_get_default_country();
+    }
+    $states = wpinv_get_country_states( sanitize_text_field( $_POST['country'] ) );
 
-	if( !empty( $states ) ) {
-		$sanitized_field_name = sanitize_text_field( $_POST['field_name'] );
+    if( !empty( $states ) ) {
+        $sanitized_field_name = sanitize_text_field( $_POST['field_name'] );
 
         $class  = isset( $_POST['class'] ) ? esc_attr( $_POST['class'] ) : '';
         $class .= " $sanitized_field_name getpaid_js_field-state custom-select wpinv-select wpi_select2";
 
         $args  = array(
-			'name'    => $sanitized_field_name,
-			'id'      => $sanitized_field_name,
-			'class'   => implode( ' ', array_unique( explode( ' ', $class ) ) ),
-			'options' => array_merge( array( '' => '' ), $states ),
-			'show_option_all'  => false,
-			'show_option_none' => false
-		);
-
-		$response = wpinv_html_select( $args );
-
-	} else {
-		$response = 'nostates';
-	}
+            'name'    => $sanitized_field_name,
+            'id'      => $sanitized_field_name,
+            'class'   => implode( ' ', array_unique( explode( ' ', $class ) ) ),
+            'options' => array_merge( array( '' => '' ), $states ),
+            'show_option_all'  => false,
+            'show_option_none' => false
+        );
+
+        $response = wpinv_html_select( $args );
+
+    } else {
+        $response = 'nostates';
+    }
 
-	return $response;
+    return $response;
 }
 
 function wpinv_default_billing_country( $country = '', $user_id = 0 ) {
@@ -645,46 +645,46 @@ 
  */
 function wpinv_get_address_formats() {
 
-		return apply_filters( 'wpinv_localisation_address_formats',
-			array(
-				'default' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}\n{{zip}}\n{{country}}",
-				'AU'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}} {{zip}}\n{{country}}",
-				'AT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'BE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'CA'      => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{state_code}}  {{zip}}\n{{country}}",
-				'CH'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'CL'      => "{{company}}\n{{name}}\n{{address}}\n{{state}}\n{{zip}} {{city}}\n{{country}}",
-				'CN'      => "{{country}} {{zip}}\n{{state}}, {{city}}, {{address}}\n{{company}}\n{{name}}",
-				'CZ'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'DE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'EE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'FI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'DK'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'FR'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city_upper}}\n{{country}}",
-				'HK'      => "{{company}}\n{{first_name}} {{last_name_upper}}\n{{address}}\n{{city_upper}}\n{{state_upper}}\n{{country}}",
-				'HU'      => "{{name}}\n{{company}}\n{{city}}\n{{address}}\n{{zip}}\n{{country}}",
-				'IN'      => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{zip}}\n{{state}}, {{country}}",
-				'IS'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'IT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}}\n{{city}}\n{{state_upper}}\n{{country}}",
-				'JP'      => "{{zip}}\n{{state}} {{city}} {{address}}\n{{company}}\n{{last_name}} {{first_name}}\n{{country}}",
-				'TW'      => "{{company}}\n{{last_name}} {{first_name}}\n{{address}}\n{{state}}, {{city}} {{zip}}\n{{country}}",
-				'LI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'NL'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'NZ'      => "{{name}}\n{{company}}\n{{address}}\n{{city}} {{zip}}\n{{country}}",
-				'NO'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'PL'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'PT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'SK'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'RS'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'SI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'ES'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{state}}\n{{country}}",
-				'SE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
-				'TR'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}} {{state}}\n{{country}}",
-				'UG'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}, {{country}}",
-				'US'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}, {{state_code}} {{zip}}\n{{country}}",
-				'VN'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{country}}",
-			)
-		);
+        return apply_filters( 'wpinv_localisation_address_formats',
+            array(
+                'default' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}\n{{zip}}\n{{country}}",
+                'AU'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}} {{zip}}\n{{country}}",
+                'AT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'BE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'CA'      => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{state_code}}  {{zip}}\n{{country}}",
+                'CH'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'CL'      => "{{company}}\n{{name}}\n{{address}}\n{{state}}\n{{zip}} {{city}}\n{{country}}",
+                'CN'      => "{{country}} {{zip}}\n{{state}}, {{city}}, {{address}}\n{{company}}\n{{name}}",
+                'CZ'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'DE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'EE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'FI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'DK'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'FR'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city_upper}}\n{{country}}",
+                'HK'      => "{{company}}\n{{first_name}} {{last_name_upper}}\n{{address}}\n{{city_upper}}\n{{state_upper}}\n{{country}}",
+                'HU'      => "{{name}}\n{{company}}\n{{city}}\n{{address}}\n{{zip}}\n{{country}}",
+                'IN'      => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{zip}}\n{{state}}, {{country}}",
+                'IS'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'IT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}}\n{{city}}\n{{state_upper}}\n{{country}}",
+                'JP'      => "{{zip}}\n{{state}} {{city}} {{address}}\n{{company}}\n{{last_name}} {{first_name}}\n{{country}}",
+                'TW'      => "{{company}}\n{{last_name}} {{first_name}}\n{{address}}\n{{state}}, {{city}} {{zip}}\n{{country}}",
+                'LI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'NL'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'NZ'      => "{{name}}\n{{company}}\n{{address}}\n{{city}} {{zip}}\n{{country}}",
+                'NO'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'PL'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'PT'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'SK'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'RS'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'SI'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'ES'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{state}}\n{{country}}",
+                'SE'      => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}",
+                'TR'      => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}} {{state}}\n{{country}}",
+                'UG'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}, {{country}}",
+                'US'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}, {{state_code}} {{zip}}\n{{country}}",
+                'VN'      => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{country}}",
+            )
+        );
 }
 
 /**
@@ -701,21 +701,21 @@ 
     }
 
     // Get all formats.
-	$formats = wpinv_get_address_formats();
+    $formats = wpinv_get_address_formats();
 
-	// Get format for the specified country.
-	$format = ( $country && isset( $formats[ $country ] ) ) ? $formats[ $country ] : $formats['default'];
+    // Get format for the specified country.
+    $format = ( $country && isset( $formats[ $country ] ) ) ? $formats[ $country ] : $formats['default'];
     
     /**
-	 * Filters the address format to use on Invoices.
+     * Filters the address format to use on Invoices.
      * 
      * New lines will be replaced by a `br` element. Double new lines will be replaced by a paragraph. HTML tags are allowed.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param string $format  The address format to use.
+     *
+     * @since 1.0.13
+     *
+     * @param string $format  The address format to use.
      * @param string $country The country who's address format is being retrieved.
-	 */
+     */
     return apply_filters( 'wpinv_get_full_address_format', $format, $country );
 }
 
@@ -736,8 +736,8 @@ 
         'country'           => '',
         'zip'               => '',
         'first_name'        => '',
-		'last_name'         => '',
-		'company'           => '',
+        'last_name'         => '',
+        'company'           => '',
     );
 
     $args    = map_deep( wp_parse_args( $billing_details, $default_args ), 'trim' );
@@ -758,14 +758,14 @@ 
     $args['country_code']= $country;
 
     /**
-	 * Filters the address format replacements to use on Invoices.
+     * Filters the address format replacements to use on Invoices.
      * 
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param array $replacements  The address replacements to use.
+     *
+     * @since 1.0.13
+     *
+     * @param array $replacements  The address replacements to use.
      * @param array $billing_details  The billing details to use.
-	 */
+     */
     $replacements = apply_filters( 'wpinv_get_invoice_address_replacements', $args, $billing_details );
 
     $return = array();
@@ -788,5 +788,5 @@ 
  * @return string
  */
 function wpinv_trim_formatted_address_line( $line ) {
-	return trim( $line, ', ' );
+    return trim( $line, ', ' );
 }
\ No newline at end of file

includes/admin/views/wizard-header.php

Indentation +4 added lines, -4 removed lines

@@ -20,13 +20,13 @@
 			<title><?php esc_html_e( 'GetPaid &rsaquo; Setup Wizard', 'invoicing' ); ?></title>
 			<?php
                 getpaid_admin()->enqeue_scripts();
-				wp_enqueue_style( 'font-awesome', 'https://use.fontawesome.com/releases/v5.13.0/css/all.css', array(), 'v5.13.0' );
-				wp_print_styles( 'select2' );
+                wp_enqueue_style( 'font-awesome', 'https://use.fontawesome.com/releases/v5.13.0/css/all.css', array(), 'v5.13.0' );
+                wp_print_styles( 'select2' );
                 wp_print_scripts( 'select2' );
-				wp_print_scripts( 'wpinv-admin-script' );
+                wp_print_scripts( 'wpinv-admin-script' );
                 do_action( 'admin_print_styles' );
                 do_action( 'admin_head' );
-			?>
+            ?>
 			<style>
 				body, p{
 					font-size: 16px;