AyeCode / invoicing

includes/class-getpaid-subscriptions-query.php

Indentation +505 added lines, -505 removed lines

@@ -16,512 +16,512 @@
  */
 class GetPaid_Subscriptions_Query {
 
-	/**
-	 * Query vars, after parsing
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	public $query_vars = array();
-
-	/**
-	 * List of found subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	private $results;
-
-	/**
-	 * Total number of found subscriptions for the current query
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	private $total_subscriptions = 0;
-
-	/**
-	 * The SQL query used to fetch matching subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $request;
-
-	// SQL clauses
-
-	/**
-	 * Contains the 'FIELDS' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_fields;
-
-	/**
-	 * Contains the 'FROM' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_from;
-
-	/**
-	 * Contains the 'WHERE' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_where;
-
-	/**
-	 * Contains the 'ORDER BY' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_orderby;
-
-	/**
-	 * Contains the 'LIMIT' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_limit;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param null|string|array $query Optional. The query variables.
-	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
-			$this->query();
-		}
-	}
-
-	/**
-	 * Fills in missing query variables with default values.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
-	 * @return array Complete query variables with undefined ones filled in with defaults.
-	 */
-	public static function fill_query_vars( $args ) {
-		$defaults = array(
-			'status'          => 'all',
-			'customer_in'     => array(),
-			'customer_not_in' => array(),
-			'product_in'      => array(),
-			'product_not_in'  => array(),
-			'include'         => array(),
-			'exclude'         => array(),
-			'orderby'         => 'id',
-			'order'           => 'DESC',
-			'offset'          => '',
-			'number'          => 10,
-			'paged'           => 1,
-			'count_total'     => true,
-			'fields'          => 'all',
-		);
-
-		return wp_parse_args( $args, $defaults );
-	}
-
-	/**
-	 * Prepare the query variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 *
-	 * @param string|array $query {
-	 *     Optional. Array or string of Query parameters.
-	 *
-	 *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
-	 *                                             Default is all.
-	 *     @type int[]        $customer_in         An array of customer ids to filter by.
-	 *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
-	 *     @type int[]        $invoice_in          An array of invoice ids to filter by.
-	 *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
-	 *     @type int[]        $product_in          An array of product ids to filter by.
-	 *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
-	 *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
-	 *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
-	 *     @type array        $include             An array of subscription IDs to include. Default empty array.
-	 *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
-	 *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
-	 *                                             an array of values, or a multi-dimensional array with fields as
-	 *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
-	 *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
-	 *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
-	 *                                             passed as part of an `$orderby` array take precedence over this
-	 *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
-	 *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
-	 *                                             conjunction with pagination. Default 0.
-	 *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
-	 *                                             conjunction with pagination. Value -1 (all) is supported, but
-	 *                                             should be used with caution on larger sites.
-	 *                                             Default 10.
-	 *     @type int          $paged               When used with number, defines the page of results to return.
-	 *                                             Default 1.
-	 *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
-	 *                                             is not needed, setting this to false can improve performance.
-	 *                                             Default true.
-	 *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
-	 *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
-	 *                                             Use 'all' for all fields. Default 'all'.
-	 * }
-	 */
-	public function prepare_query( $query = array() ) {
-		global $wpdb;
-
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
-			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
-		}
-
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
-		}
-
-		do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
-
-		// Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
-		$qv                =& $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
-		$table             = $wpdb->prefix . 'wpinv_subscriptions';
-		$this->query_from  = "FROM $table";
-
-		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
-
-		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
-
-		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
-
-		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
-			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
-			}
-		}
-
-		do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
-	}
-
-	/**
-	 * Prepares the query fields.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_fields( &$qv, $table ) {
-
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
-
-			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field          = sanitize_key( $field );
-				$query_fields[] = "$table.`$field`";
-			}
-			$this->query_fields = implode( ',', $query_fields );
-		} else {
-			$this->query_fields = "$table.*";
-		}
-
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
-		}
-
-	}
-
-	/**
-	 * Prepares the query where.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_where( &$qv, $table ) {
-		global $wpdb;
-		$this->query_where = 'WHERE 1=1';
-
-		// Status.
-		if ( 'all' !== $qv['status'] ) {
-			$statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
-			$prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
-			$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
-		}
-
-		if ( ! empty( $qv['customer_in'] ) ) {
-			$customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
-		} elseif ( ! empty( $qv['customer_not_in'] ) ) {
-			$customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
-		}
-
-		if ( ! empty( $qv['product_in'] ) ) {
-			$product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
-			$this->query_where .= " AND $table.`product_id` IN ($product_in)";
-		} elseif ( ! empty( $qv['product_not_in'] ) ) {
-			$product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
-			$this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
-		}
-
-		if ( ! empty( $qv['invoice_in'] ) ) {
-			$invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
-		} elseif ( ! empty( $qv['invoice_not_in'] ) ) {
-			$invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
-		}
-
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
-			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
-			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
-		}
-
-		// Date queries are allowed for the subscription creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
-			$this->query_where .= $date_created_query->get_sql();
-		}
-
-		// Date queries are also allowed for the subscription expiration date.
-		if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
-			$date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
-			$this->query_where .= $date_expires_query->get_sql();
-		}
-
-	}
-
-	/**
-	 * Prepares the query order.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_order( &$qv, $table ) {
-
-		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
-
-		// Default order is by 'id' (latest subscriptions).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
-		}
-
-		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list( $qv['orderby'] ) );
-
-		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
-
-			if ( is_int( $_key ) ) {
-				// Integer key means this is a flat array of 'orderby' fields.
-				$_orderby = $_value;
-				$_order   = $order;
-			} else {
-				// Non-integer key means that the key is the field and the value is ASC/DESC.
-				$_orderby = $_key;
-				$_order   = $_value;
-			}
-
-			$parsed = $this->parse_orderby( $_orderby, $table );
-
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
-			}
+    /**
+     * Query vars, after parsing
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    public $query_vars = array();
+
+    /**
+     * List of found subscriptions.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    private $results;
+
+    /**
+     * Total number of found subscriptions for the current query
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    private $total_subscriptions = 0;
+
+    /**
+     * The SQL query used to fetch matching subscriptions.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $request;
+
+    // SQL clauses
+
+    /**
+     * Contains the 'FIELDS' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_fields;
+
+    /**
+     * Contains the 'FROM' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_from;
+
+    /**
+     * Contains the 'WHERE' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_where;
+
+    /**
+     * Contains the 'ORDER BY' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_orderby;
+
+    /**
+     * Contains the 'LIMIT' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_limit;
+
+    /**
+     * Class constructor.
+     *
+     * @since 1.0.19
+     *
+     * @param null|string|array $query Optional. The query variables.
+     */
+    public function __construct( $query = null ) {
+        if ( ! is_null( $query ) ) {
+            $this->prepare_query( $query );
+            $this->query();
+        }
+    }
+
+    /**
+     * Fills in missing query variables with default values.
+     *
+     * @since 1.0.19
+     *
+     * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
+     * @return array Complete query variables with undefined ones filled in with defaults.
+     */
+    public static function fill_query_vars( $args ) {
+        $defaults = array(
+            'status'          => 'all',
+            'customer_in'     => array(),
+            'customer_not_in' => array(),
+            'product_in'      => array(),
+            'product_not_in'  => array(),
+            'include'         => array(),
+            'exclude'         => array(),
+            'orderby'         => 'id',
+            'order'           => 'DESC',
+            'offset'          => '',
+            'number'          => 10,
+            'paged'           => 1,
+            'count_total'     => true,
+            'fields'          => 'all',
+        );
+
+        return wp_parse_args( $args, $defaults );
+    }
+
+    /**
+     * Prepare the query variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
+     * @param string|array $query {
+     *     Optional. Array or string of Query parameters.
+     *
+     *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
+     *                                             Default is all.
+     *     @type int[]        $customer_in         An array of customer ids to filter by.
+     *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
+     *     @type int[]        $invoice_in          An array of invoice ids to filter by.
+     *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
+     *     @type int[]        $product_in          An array of product ids to filter by.
+     *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
+     *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
+     *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
+     *     @type array        $include             An array of subscription IDs to include. Default empty array.
+     *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
+     *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
+     *                                             an array of values, or a multi-dimensional array with fields as
+     *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
+     *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
+     *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
+     *                                             passed as part of an `$orderby` array take precedence over this
+     *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
+     *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
+     *                                             conjunction with pagination. Default 0.
+     *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
+     *                                             conjunction with pagination. Value -1 (all) is supported, but
+     *                                             should be used with caution on larger sites.
+     *                                             Default 10.
+     *     @type int          $paged               When used with number, defines the page of results to return.
+     *                                             Default 1.
+     *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
+     *                                             is not needed, setting this to false can improve performance.
+     *                                             Default true.
+     *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
+     *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
+     *                                             Use 'all' for all fields. Default 'all'.
+     * }
+     */
+    public function prepare_query( $query = array() ) {
+        global $wpdb;
+
+        if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+            $this->query_limit = null;
+            $this->query_vars  = $this->fill_query_vars( $query );
+        }
+
+        if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
+            $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+        }
+
+        do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
+
+        // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
+        $qv                =& $this->query_vars;
+        $qv                = $this->fill_query_vars( $qv );
+        $table             = $wpdb->prefix . 'wpinv_subscriptions';
+        $this->query_from  = "FROM $table";
+
+        // Prepare query fields.
+        $this->prepare_query_fields( $qv, $table );
+
+        // Prepare query where.
+        $this->prepare_query_where( $qv, $table );
+
+        // Prepare query order.
+        $this->prepare_query_order( $qv, $table );
+
+        // limit
+        if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
+            if ( $qv['offset'] ) {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+            } else {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+            }
+        }
+
+        do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
+    }
+
+    /**
+     * Prepares the query fields.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_fields( &$qv, $table ) {
+
+        if ( is_array( $qv['fields'] ) ) {
+            $qv['fields'] = array_unique( $qv['fields'] );
+
+            $query_fields = array();
+            foreach ( $qv['fields'] as $field ) {
+                $field          = sanitize_key( $field );
+                $query_fields[] = "$table.`$field`";
+            }
+            $this->query_fields = implode( ',', $query_fields );
+        } else {
+            $this->query_fields = "$table.*";
+        }
+
+        if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+            $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+        }
+
+    }
+
+    /**
+     * Prepares the query where.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_where( &$qv, $table ) {
+        global $wpdb;
+        $this->query_where = 'WHERE 1=1';
+
+        // Status.
+        if ( 'all' !== $qv['status'] ) {
+            $statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
+            $prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
+            $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
+        }
+
+        if ( ! empty( $qv['customer_in'] ) ) {
+            $customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
+        } elseif ( ! empty( $qv['customer_not_in'] ) ) {
+            $customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
+        }
+
+        if ( ! empty( $qv['product_in'] ) ) {
+            $product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
+            $this->query_where .= " AND $table.`product_id` IN ($product_in)";
+        } elseif ( ! empty( $qv['product_not_in'] ) ) {
+            $product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
+            $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
+        }
+
+        if ( ! empty( $qv['invoice_in'] ) ) {
+            $invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
+        } elseif ( ! empty( $qv['invoice_not_in'] ) ) {
+            $invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
+        }
+
+        if ( ! empty( $qv['include'] ) ) {
+            $include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+            $this->query_where .= " AND $table.`id` IN ($include)";
+        } elseif ( ! empty( $qv['exclude'] ) ) {
+            $exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+            $this->query_where .= " AND $table.`id` NOT IN ($exclude)";
+        }
+
+        // Date queries are allowed for the subscription creation date.
+        if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
+            $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
+            $this->query_where .= $date_created_query->get_sql();
+        }
+
+        // Date queries are also allowed for the subscription expiration date.
+        if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
+            $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
+            $this->query_where .= $date_expires_query->get_sql();
+        }
+
+    }
+
+    /**
+     * Prepares the query order.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_order( &$qv, $table ) {
+
+        // sorting.
+        $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
+        $order       = $this->parse_order( $qv['order'] );
+
+        // Default order is by 'id' (latest subscriptions).
+        if ( empty( $qv['orderby'] ) ) {
+            $qv['orderby'] = array( 'id' );
+        }
+
+        // 'orderby' values may be an array, comma- or space-separated list.
+        $ordersby      = array_filter( wpinv_parse_list( $qv['orderby'] ) );
+
+        $orderby_array = array();
+        foreach ( $ordersby as $_key => $_value ) {
+
+            if ( is_int( $_key ) ) {
+                // Integer key means this is a flat array of 'orderby' fields.
+                $_orderby = $_value;
+                $_order   = $order;
+            } else {
+                // Non-integer key means that the key is the field and the value is ASC/DESC.
+                $_orderby = $_key;
+                $_order   = $_value;
+            }
+
+            $parsed = $this->parse_orderby( $_orderby, $table );
+
+            if ( $parsed ) {
+                $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            }
 }
 
-		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
-			$orderby_array[] = "id $order";
-		}
-
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
-
-	}
-
-	/**
-	 * Execute the query, with the current variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 */
-	public function query() {
-		global $wpdb;
-
-		$qv =& $this->query_vars;
-
-		// Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
-		// total_subscriptions property.
-		$this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
-
-		if ( null === $this->results ) {
-			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
-
-			if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
-			} else {
-				$this->results = $wpdb->get_col( $this->request );
-			}
-
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
-			}
-		}
-
-		if ( 'all' == $qv['fields'] ) {
-			foreach ( $this->results as $key => $subscription ) {
-				$this->set_cache( $subscription->id, $subscription, 'getpaid_subscriptions' );
-				$this->set_cache( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
-				$this->set_cache( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->set_cache( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->results[ $key ] = new WPInv_Subscription( $subscription );
-			}
-		}
-
-	}
-
-	/**
-	 * Set cache
-	 *
-	 * @param string  $id
-	 * @param mixed   $data
-	 * @param string  $group
-	 * @param integer $expire
-	 * @return boolean
-	 */
-	public function set_cache( $key, $data, $group = '', $expire = 0 ) {
-
-		if ( empty( $key ) ) {
-			return false;
-		}
-
-		wp_cache_set( $key, $data, $group, $expire );
-	}
-
-	/**
-	 * Retrieve query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @return mixed
-	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Set query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @param mixed $value Query variable value.
-	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
-	}
-
-	/**
-	 * Return the list of subscriptions.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return WPInv_Subscription[]|array Found subscriptions.
-	 */
-	public function get_results() {
-		return $this->results;
-	}
-
-	/**
-	 * Return the total number of subscriptions for the current query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return int Number of total subscriptions.
-	 */
-	public function get_total() {
-		return $this->total_subscriptions;
-	}
-
-	/**
-	 * Parse and sanitize 'orderby' keys passed to the subscriptions query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $orderby Alias for the field to order by.
-	 *  @param string $table The current table.
-	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
-	 */
-	protected function parse_orderby( $orderby, $table ) {
-
-		$_orderby = '';
-		if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
-			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
-			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
-			$_orderby    = "FIELD( $table.id, $include_sql )";
-		}
-
-		return $_orderby;
-	}
-
-	/**
-	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $order The 'order' query variable.
-	 * @return string The sanitized 'order' query variable.
-	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
-			return 'DESC';
-		}
-
-		if ( 'ASC' === strtoupper( $order ) ) {
-			return 'ASC';
-		} else {
-			return 'DESC';
-		}
-	}
+        // If no valid clauses were found, order by id.
+        if ( empty( $orderby_array ) ) {
+            $orderby_array[] = "id $order";
+        }
+
+        $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+    }
+
+    /**
+     * Execute the query, with the current variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function query() {
+        global $wpdb;
+
+        $qv =& $this->query_vars;
+
+        // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
+        // total_subscriptions property.
+        $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
+
+        if ( null === $this->results ) {
+            $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+            if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
+                $this->results = $wpdb->get_results( $this->request );
+            } else {
+                $this->results = $wpdb->get_col( $this->request );
+            }
+
+            if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+                $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
+                $this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
+            }
+        }
+
+        if ( 'all' == $qv['fields'] ) {
+            foreach ( $this->results as $key => $subscription ) {
+                $this->set_cache( $subscription->id, $subscription, 'getpaid_subscriptions' );
+                $this->set_cache( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
+                $this->set_cache( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                $this->set_cache( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                $this->results[ $key ] = new WPInv_Subscription( $subscription );
+            }
+        }
+
+    }
+
+    /**
+     * Set cache
+     *
+     * @param string  $id
+     * @param mixed   $data
+     * @param string  $group
+     * @param integer $expire
+     * @return boolean
+     */
+    public function set_cache( $key, $data, $group = '', $expire = 0 ) {
+
+        if ( empty( $key ) ) {
+            return false;
+        }
+
+        wp_cache_set( $key, $data, $group, $expire );
+    }
+
+    /**
+     * Retrieve query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @return mixed
+     */
+    public function get( $query_var ) {
+        if ( isset( $this->query_vars[ $query_var ] ) ) {
+            return $this->query_vars[ $query_var ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Set query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @param mixed $value Query variable value.
+     */
+    public function set( $query_var, $value ) {
+        $this->query_vars[ $query_var ] = $value;
+    }
+
+    /**
+     * Return the list of subscriptions.
+     *
+     * @since 1.0.19
+     *
+     * @return WPInv_Subscription[]|array Found subscriptions.
+     */
+    public function get_results() {
+        return $this->results;
+    }
+
+    /**
+     * Return the total number of subscriptions for the current query.
+     *
+     * @since 1.0.19
+     *
+     * @return int Number of total subscriptions.
+     */
+    public function get_total() {
+        return $this->total_subscriptions;
+    }
+
+    /**
+     * Parse and sanitize 'orderby' keys passed to the subscriptions query.
+     *
+     * @since 1.0.19
+     *
+     * @param string $orderby Alias for the field to order by.
+     *  @param string $table The current table.
+     * @return string Value to use in the ORDER clause, if `$orderby` is valid.
+     */
+    protected function parse_orderby( $orderby, $table ) {
+
+        $_orderby = '';
+        if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
+            $_orderby = "$table.`$orderby`";
+        } elseif ( 'id' === strtolower( $orderby ) ) {
+            $_orderby = "$table.id";
+        } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+            $include     = wp_parse_id_list( $this->query_vars['include'] );
+            $include_sql = implode( ',', $include );
+            $_orderby    = "FIELD( $table.id, $include_sql )";
+        }
+
+        return $_orderby;
+    }
+
+    /**
+     * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+     *
+     * @since 1.0.19
+     *
+     * @param string $order The 'order' query variable.
+     * @return string The sanitized 'order' query variable.
+     */
+    protected function parse_order( $order ) {
+        if ( ! is_string( $order ) || empty( $order ) ) {
+            return 'DESC';
+        }
+
+        if ( 'ASC' === strtoupper( $order ) ) {
+            return 'ASC';
+        } else {
+            return 'DESC';
+        }
+    }
 
 }

includes/gateways/class-getpaid-bank-transfer-gateway.php

Indentation +222 added lines, -222 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Bank_Transfer_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'bank_transfer';
 
-	/**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
-	protected $supports = array( 'subscription', 'addons', 'single_subscription_group', 'multiple_subscription_groups' );
+    /**
+     * 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 = 8;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 8;
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title                = __( 'Direct bank transfer', 'invoicing' );
@@ -44,24 +44,24 @@ 
         $this->checkout_button_text = __( 'Proceed', 'invoicing' );
         $this->instructions         = apply_filters( 'wpinv_bank_instructions', $this->get_option( 'info' ) );
 
-		add_action( 'wpinv_receipt_end', array( $this, 'thankyou_page' ) );
-		add_action( 'getpaid_invoice_line_items', array( $this, 'thankyou_page' ), 40 );
-		add_action( 'wpinv_pdf_content_billing', array( $this, 'thankyou_page' ), 11 );
-		add_action( 'wpinv_email_invoice_details', array( $this, 'email_instructions' ), 10, 3 );
-		add_action( 'getpaid_should_renew_subscription', array( $this, 'maybe_renew_subscription' ) );
-		add_action( 'getpaid_invoice_status_publish', array( $this, 'invoice_paid' ), 20 );
+        add_action( 'wpinv_receipt_end', array( $this, 'thankyou_page' ) );
+        add_action( 'getpaid_invoice_line_items', array( $this, 'thankyou_page' ), 40 );
+        add_action( 'wpinv_pdf_content_billing', array( $this, 'thankyou_page' ), 11 );
+        add_action( 'wpinv_email_invoice_details', array( $this, 'email_instructions' ), 10, 3 );
+        add_action( 'getpaid_should_renew_subscription', array( $this, 'maybe_renew_subscription' ) );
+        add_action( 'getpaid_invoice_status_publish', array( $this, 'invoice_paid' ), 20 );
 
     }
 
     /**
-	 * 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 ) {
 
         // Add a transaction id.
         $invoice->set_transaction_id( $invoice->generate_key( 'bt_' ) );
@@ -82,66 +82,66 @@ 
     }
 
     /**
-	 * Output for the order received page.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function thankyou_page( $invoice ) {
+     * Output for the order received page.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     */
+    public function thankyou_page( $invoice ) {
 
         if ( 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) {
 
-			echo '<div class="mt-4 mb-2 getpaid-bank-transfer-details">' . PHP_EOL;
+            echo '<div class="mt-4 mb-2 getpaid-bank-transfer-details">' . PHP_EOL;
 
             if ( ! empty( $this->instructions ) ) {
                 echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) );
-			}
+            }
 
-			$this->bank_details( $invoice );
+            $this->bank_details( $invoice );
 
-			echo '</div>';
+            echo '</div>';
 
         }
 
-	}
+    }
 
     /**
-	 * Add content to the WPI emails.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param string     $email_type Email format: plain text or HTML.
-	 * @param bool     $sent_to_admin Sent to admin.
-	 */
-	public function email_instructions( $invoice, $email_type, $sent_to_admin ) {
+     * Add content to the WPI emails.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param string     $email_type Email format: plain text or HTML.
+     * @param bool     $sent_to_admin Sent to admin.
+     */
+    public function email_instructions( $invoice, $email_type, $sent_to_admin ) {
 
-		if ( ! $sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) {
+        if ( ! $sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) {
 
-			echo '<div class="wpi-email-row getpaid-bank-transfer-details">';
+            echo '<div class="wpi-email-row getpaid-bank-transfer-details">';
 
-			if ( $this->instructions ) {
-				echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL );
+            if ( $this->instructions ) {
+                echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL );
             }
 
-			$this->bank_details( $invoice );
+            $this->bank_details( $invoice );
 
-			echo '</div>';
+            echo '</div>';
 
-		}
+        }
 
     }
 
     /**
-	 * Get bank details and place into a list format.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 */
-	protected function bank_details( $invoice ) {
+     * Get bank details and place into a list format.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     */
+    protected function bank_details( $invoice ) {
 
-		// Get the invoice country and country $locale.
-		$country = $invoice->get_country();
-		$locale  = $this->get_country_locale();
+        // Get the invoice country and country $locale.
+        $country = $invoice->get_country();
+        $locale  = $this->get_country_locale();
 
-		// Get sortcode label in the $locale array and use appropriate one.
-		$sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
+        // Get sortcode label in the $locale array and use appropriate one.
+        $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
 
         $bank_fields = array(
             'ac_name'   => __( 'Account Name', 'invoicing' ),
@@ -160,11 +160,11 @@ 
 
             if ( ! empty( $value ) ) {
                 $bank_info[ $field ] = array(
-					'label' => $label,
-					'value' => $value,
-				);
+                    'label' => $label,
+                    'value' => $value,
+                );
             }
-		}
+        }
 
         $bank_info = apply_filters( 'wpinv_bank_info', $bank_info, $invoice );
 
@@ -172,139 +172,139 @@ 
             return;
         }
 
-		echo '<h3 class="getpaid-bank-transfer-title"> ' . esc_html( apply_filters( 'wpinv_receipt_bank_details_title', __( 'Bank Details', 'invoicing' ), $invoice ) ) . '</h3>' . PHP_EOL;
+        echo '<h3 class="getpaid-bank-transfer-title"> ' . esc_html( apply_filters( 'wpinv_receipt_bank_details_title', __( 'Bank Details', 'invoicing' ), $invoice ) ) . '</h3>' . PHP_EOL;
+
+        echo '<table class="table table-bordered getpaid-bank-transfer-details">' . PHP_EOL;
+
+        foreach ( $bank_info as $key => $data ) {
+            echo "<tr class='getpaid-bank-transfer-" . esc_attr( $key ) . "'><th class='font-weight-bold'>" . wp_kses_post( $data['label'] ) . "</th><td class='w-75'>" . wp_kses_post( wptexturize( $data['value'] ) ) . '</td></tr>' . PHP_EOL;
+        }
+
+        echo '</table>';
 
-		echo '<table class="table table-bordered getpaid-bank-transfer-details">' . PHP_EOL;
+    }
 
-		foreach ( $bank_info as $key => $data ) {
-			echo "<tr class='getpaid-bank-transfer-" . esc_attr( $key ) . "'><th class='font-weight-bold'>" . wp_kses_post( $data['label'] ) . "</th><td class='w-75'>" . wp_kses_post( wptexturize( $data['value'] ) ) . '</td></tr>' . PHP_EOL;
-		}
+    /**
+     * Get country locale if localized.
+     *
+     * @return array
+     */
+    public function get_country_locale() {
+
+        if ( empty( $this->locale ) ) {
+
+            // Locale information to be used - only those that are not 'Sort Code'.
+            $this->locale = apply_filters(
+                'getpaid_get_bank_transfer_locale',
+                array(
+                    'AU' => array(
+                        'sortcode' => array(
+                            'label' => __( 'BSB', 'invoicing' ),
+                        ),
+                    ),
+                    'CA' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Bank transit number', 'invoicing' ),
+                        ),
+                    ),
+                    'IN' => array(
+                        'sortcode' => array(
+                            'label' => __( 'IFSC', 'invoicing' ),
+                        ),
+                    ),
+                    'IT' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Branch sort', 'invoicing' ),
+                        ),
+                    ),
+                    'NZ' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Bank code', 'invoicing' ),
+                        ),
+                    ),
+                    'SE' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Bank code', 'invoicing' ),
+                        ),
+                    ),
+                    'US' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Routing number', 'invoicing' ),
+                        ),
+                    ),
+                    'ZA' => array(
+                        'sortcode' => array(
+                            'label' => __( 'Branch code', 'invoicing' ),
+                        ),
+                    ),
+                )
+            );
 
-		echo '</table>';
+        }
+
+        return $this->locale;
 
     }
 
     /**
-	 * Get country locale if localized.
-	 *
-	 * @return array
-	 */
-	public function get_country_locale() {
-
-		if ( empty( $this->locale ) ) {
-
-			// Locale information to be used - only those that are not 'Sort Code'.
-			$this->locale = apply_filters(
-				'getpaid_get_bank_transfer_locale',
-				array(
-					'AU' => array(
-						'sortcode' => array(
-							'label' => __( 'BSB', 'invoicing' ),
-						),
-					),
-					'CA' => array(
-						'sortcode' => array(
-							'label' => __( 'Bank transit number', 'invoicing' ),
-						),
-					),
-					'IN' => array(
-						'sortcode' => array(
-							'label' => __( 'IFSC', 'invoicing' ),
-						),
-					),
-					'IT' => array(
-						'sortcode' => array(
-							'label' => __( 'Branch sort', 'invoicing' ),
-						),
-					),
-					'NZ' => array(
-						'sortcode' => array(
-							'label' => __( 'Bank code', 'invoicing' ),
-						),
-					),
-					'SE' => array(
-						'sortcode' => array(
-							'label' => __( 'Bank code', 'invoicing' ),
-						),
-					),
-					'US' => array(
-						'sortcode' => array(
-							'label' => __( 'Routing number', 'invoicing' ),
-						),
-					),
-					'ZA' => array(
-						'sortcode' => array(
-							'label' => __( 'Branch code', 'invoicing' ),
-						),
-					),
-				)
-			);
-
-		}
-
-		return $this->locale;
-
-	}
-
-	/**
-	 * 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 ) {
 
         $admin_settings['bank_transfer_desc']['std']    = __( "Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing' );
-		$admin_settings['bank_transfer_active']['desc'] = __( 'Enable bank transfer', 'invoicing' );
+        $admin_settings['bank_transfer_active']['desc'] = __( 'Enable bank transfer', 'invoicing' );
 
-		$locale  = $this->get_country_locale();
+        $locale  = $this->get_country_locale();
 
-		// Get sortcode label in the $locale array and use appropriate one.
-		$country  = wpinv_default_billing_country();
-		$sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
+        // Get sortcode label in the $locale array and use appropriate one.
+        $country  = wpinv_default_billing_country();
+        $sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
 
-		$admin_settings['bank_transfer_ac_name'] = array(
+        $admin_settings['bank_transfer_ac_name'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_ac_name',
             'name' => __( 'Account Name', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_ac_no'] = array(
+        $admin_settings['bank_transfer_ac_no'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_ac_no',
             'name' => __( 'Account Number', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_bank_name'] = array(
+        $admin_settings['bank_transfer_bank_name'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_bank_name',
             'name' => __( 'Bank Name', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_ifsc'] = array(
+        $admin_settings['bank_transfer_ifsc'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_ifsc',
             'name' => __( 'IFSC Code', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_iban'] = array(
+        $admin_settings['bank_transfer_iban'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_iban',
             'name' => __( 'IBAN', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_bic'] = array(
+        $admin_settings['bank_transfer_bic'] = array(
             'type' => 'text',
             'id'   => 'bank_transfer_bic',
             'name' => __( 'BIC/Swift Code', 'invoicing' ),
-		);
+        );
 
-		$admin_settings['bank_transfer_sort_code'] = array(
-			'type' => 'text',
-			'id'   => 'bank_transfer_sort_code',
-			'name' => $sortcode,
-		);
+        $admin_settings['bank_transfer_sort_code'] = array(
+            'type' => 'text',
+            'id'   => 'bank_transfer_sort_code',
+            'name' => $sortcode,
+        );
 
-		$admin_settings['bank_transfer_info'] = array(
+        $admin_settings['bank_transfer_info'] = array(
             'id'   => 'bank_transfer_info',
             'name' => __( 'Instructions', 'invoicing' ),
             'desc' => __( 'Instructions that will be added to the thank you page and emails.', 'invoicing' ),
@@ -314,17 +314,17 @@ 
             'rows' => 5,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
-	/**
-	 * 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 );
@@ -332,66 +332,66 @@ 
 
         $invoice->recalculate_total();
         $invoice->save();
-	}
+    }
 
-	/**
-	 * (Maybe) renews a bank transfer subscription profile.
-	 *
-	 *
+    /**
+     * (Maybe) renews a bank transfer 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' ) ) {
-			$subscription->create_payment();
+            $subscription->create_payment();
         }
 
     }
 
-	/**
-	 * Process a bank transfer payment.
-	 *
-	 *
+    /**
+     * Process a bank transfer payment.
+     *
+     *
      * @param WPInv_Invoice $invoice
-	 */
-	public function invoice_paid( $invoice ) {
-
-		// Abort if not paid by bank transfer.
-		if ( $this->id !== $invoice->get_gateway() || ! $invoice->is_recurring() ) {
-			return;
-		}
-
-		// Is it a parent payment?
-		if ( 0 == $invoice->get_parent_id() ) {
-
-			// (Maybe) activate subscriptions.
-			$subscriptions = getpaid_get_invoice_subscriptions( $invoice );
-
-			if ( ! empty( $subscriptions ) ) {
-				$subscriptions = is_array( $subscriptions ) ? $subscriptions : array( $subscriptions );
-
-				foreach ( $subscriptions as $subscription ) {
-					if ( $subscription->exists() ) {
-						$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-						$expiry   = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) );
-
-						$subscription->set_next_renewal_date( $expiry );
-						$subscription->set_date_created( current_time( 'mysql' ) );
-						$subscription->set_profile_id( 'bt_sub_' . $invoice->get_id() . '_' . $subscription->get_id() );
-						$subscription->activate();
-					}
-				}
+     */
+    public function invoice_paid( $invoice ) {
+
+        // Abort if not paid by bank transfer.
+        if ( $this->id !== $invoice->get_gateway() || ! $invoice->is_recurring() ) {
+            return;
+        }
+
+        // Is it a parent payment?
+        if ( 0 == $invoice->get_parent_id() ) {
+
+            // (Maybe) activate subscriptions.
+            $subscriptions = getpaid_get_invoice_subscriptions( $invoice );
+
+            if ( ! empty( $subscriptions ) ) {
+                $subscriptions = is_array( $subscriptions ) ? $subscriptions : array( $subscriptions );
+
+                foreach ( $subscriptions as $subscription ) {
+                    if ( $subscription->exists() ) {
+                        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+                        $expiry   = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) );
+
+                        $subscription->set_next_renewal_date( $expiry );
+                        $subscription->set_date_created( current_time( 'mysql' ) );
+                        $subscription->set_profile_id( 'bt_sub_' . $invoice->get_id() . '_' . $subscription->get_id() );
+                        $subscription->activate();
+                    }
+                }
 }
 } else {
 
-			$subscription = getpaid_get_subscription( $invoice->get_subscription_id() );
+            $subscription = getpaid_get_subscription( $invoice->get_subscription_id() );
 
-			// Renew the subscription.
-			if ( $subscription && $subscription->exists() ) {
-				$subscription->add_payment( array(), $invoice );
-				$subscription->renew( strtotime( $invoice->get_date_created() ) );
-					}
+            // Renew the subscription.
+            if ( $subscription && $subscription->exists() ) {
+                $subscription->add_payment( array(), $invoice );
+                $subscription->renew( strtotime( $invoice->get_date_created() ) );
+                    }
 }
 
     }

templates/payment-forms/cart-item.php

Indentation +126 added lines, -126 removed lines

@@ -26,71 +26,71 @@ 
 
 				<?php
 
-					// Fires before printing a line item column.
-					do_action( "getpaid_form_cart_item_before_$key", $item, $form );
+                    // Fires before printing a line item column.
+                    do_action( "getpaid_form_cart_item_before_$key", $item, $form );
 
-					// Item name.
-					if ( 'name' === $key ) {
+                    // Item name.
+                    if ( 'name' === $key ) {
 
 
-						ob_start();
+                        ob_start();
 
-						// Add an optional description.
-						$description = $item->get_description();
+                        // Add an optional description.
+                        $description = $item->get_description();
 
-						if ( ! empty( $description ) ) {
-							echo "<small class='form-text text-muted pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
-						}
+                        if ( ! empty( $description ) ) {
+                            echo "<small class='form-text text-muted pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
+                        }
 
-						// Price help text.
-						$description = getpaid_item_recurring_price_help_text( $item, $currency );
-						if ( $description ) {
-							echo "<small class='getpaid-form-item-price-desc form-text text-muted font-italic pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
-						}
+                        // Price help text.
+                        $description = getpaid_item_recurring_price_help_text( $item, $currency );
+                        if ( $description ) {
+                            echo "<small class='getpaid-form-item-price-desc form-text text-muted font-italic pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
+                        }
 
-						do_action( 'getpaid_payment_form_cart_item_description', $item, $form );
+                        do_action( 'getpaid_payment_form_cart_item_description', $item, $form );
 
-						if ( wpinv_current_user_can_manage_invoicing() ) {
+                        if ( wpinv_current_user_can_manage_invoicing() ) {
 
-							edit_post_link(
-								__( 'Edit this item.', 'invoicing' ),
-								'<small class="form-text text-muted">',
-								'</small>',
-								$item->get_id(),
-								'text-danger'
-							);
+                            edit_post_link(
+                                __( 'Edit this item.', 'invoicing' ),
+                                '<small class="form-text text-muted">',
+                                '</small>',
+                                $item->get_id(),
+                                'text-danger'
+                            );
 
-						}
+                        }
 
-						$description = ob_get_clean();
+                        $description = ob_get_clean();
 
-						// Display the name.
-						$tootip = empty( $description ) ? '' : '&nbsp;<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>';
+                        // Display the name.
+                        $tootip = empty( $description ) ? '' : '&nbsp;<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>';
 
-						$has_featured_image = has_post_thumbnail( $item->get_id() );
+                        $has_featured_image = has_post_thumbnail( $item->get_id() );
 
-						if ( $has_featured_image ) {
-							echo '<div class="d-flex align-items-center getpaid-form-item-has-featured-image">';
-							echo '<div class="getpaid-form-item-image-container mr-2">';
-							echo get_the_post_thumbnail( $item->get_id(), 'thumbnail', array( 'class' => 'getpaid-form-item-image mb-0' ) );
-							echo '</div>';
-							echo '<div class="getpaid-form-item-name-container">';
-						}
+                        if ( $has_featured_image ) {
+                            echo '<div class="d-flex align-items-center getpaid-form-item-has-featured-image">';
+                            echo '<div class="getpaid-form-item-image-container mr-2">';
+                            echo get_the_post_thumbnail( $item->get_id(), 'thumbnail', array( 'class' => 'getpaid-form-item-image mb-0' ) );
+                            echo '</div>';
+                            echo '<div class="getpaid-form-item-name-container">';
+                        }
 
-						echo '<div class="mb-1 font-weight-bold">' . esc_html( $item->get_name() ) . wp_kses_post( $tootip ) . '</div>';
+                        echo '<div class="mb-1 font-weight-bold">' . esc_html( $item->get_name() ) . wp_kses_post( $tootip ) . '</div>';
 
-						if ( ! empty( $description ) ) {
-							printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', wp_kses_post( $description ) );
-						}
+                        if ( ! empty( $description ) ) {
+                            printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', wp_kses_post( $description ) );
+                        }
 
-						if ( $item->allows_quantities() ) {
-							printf(
-								'<small class="d-sm-none text-muted form-text">%s</small>',
-								sprintf(
-									// translators: %s is the item quantity.
-									esc_html__( 'Qty %s', 'invoicing' ),
-									sprintf(
-										'<input
+                        if ( $item->allows_quantities() ) {
+                            printf(
+                                '<small class="d-sm-none text-muted form-text">%s</small>',
+                                sprintf(
+                                    // translators: %s is the item quantity.
+                                    esc_html__( 'Qty %s', 'invoicing' ),
+                                    sprintf(
+                                        '<input
 												type="number"
 												step="0.01"
 												style="width: 48px;"
@@ -99,62 +99,62 @@ 
 												min="1"
 												max="%s"
 												>',
-										(float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(),
-										floatval( null !== $max_qty ? $max_qty : 1000000000000 )
-									)
-								)
-							);
-						} else {
-							printf(
-								'<small class="d-sm-none text-muted form-text">%s</small>',
-								sprintf(
-									// translators: %s is the item quantity.
-									esc_html__( 'Qty %s', 'invoicing' ),
-									(float) $item->get_quantity()
-								)
-							);
-						}
-
-						if ( $has_featured_image ) {
-							echo '</div>';
-							echo '</div>';
-						}
-					}
-
-					// Item price.
-					if ( 'price' === $key ) {
-
-					// Set the currency position.
-					$position = wpinv_currency_position();
-
-					if ( 'left_space' === $position ) {
-						$position = 'left';
-					}
-
-					if ( 'right_space' === $position ) {
-						$position = 'right';
-					}
-
-					if ( $item->user_can_set_their_price() ) {
-						$price            = max( (float) $item->get_price(), (float) $item->get_minimum_price() );
-						$minimum          = (float) $item->get_minimum_price();
-						$validate_minimum = '';
-						$class            = '';
-						$data_minimum     = '';
-
-						if ( $minimum > 0 ) {
-							$validate_minimum = sprintf(
-								// translators: %s is the minimum price.
-								esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ),
-								wp_strip_all_tags( wpinv_price( $minimum, $currency ) )
-							);
-
-							$class = 'getpaid-validate-minimum-amount';
-
-							$data_minimum     = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'";
-						}
-
-						?>
+                                        (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(),
+                                        floatval( null !== $max_qty ? $max_qty : 1000000000000 )
+                                    )
+                                )
+                            );
+                        } else {
+                            printf(
+                                '<small class="d-sm-none text-muted form-text">%s</small>',
+                                sprintf(
+                                    // translators: %s is the item quantity.
+                                    esc_html__( 'Qty %s', 'invoicing' ),
+                                    (float) $item->get_quantity()
+                                )
+                            );
+                        }
+
+                        if ( $has_featured_image ) {
+                            echo '</div>';
+                            echo '</div>';
+                        }
+                    }
+
+                    // Item price.
+                    if ( 'price' === $key ) {
+
+                    // Set the currency position.
+                    $position = wpinv_currency_position();
+
+                    if ( 'left_space' === $position ) {
+                        $position = 'left';
+                    }
+
+                    if ( 'right_space' === $position ) {
+                        $position = 'right';
+                    }
+
+                    if ( $item->user_can_set_their_price() ) {
+                        $price            = max( (float) $item->get_price(), (float) $item->get_minimum_price() );
+                        $minimum          = (float) $item->get_minimum_price();
+                        $validate_minimum = '';
+                        $class            = '';
+                        $data_minimum     = '';
+
+                        if ( $minimum > 0 ) {
+                            $validate_minimum = sprintf(
+                                // translators: %s is the minimum price.
+                                esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ),
+                                wp_strip_all_tags( wpinv_price( $minimum, $currency ) )
+                            );
+
+                            $class = 'getpaid-validate-minimum-amount';
+
+                            $data_minimum     = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'";
+                        }
+
+                        ?>
 								<div class="input-group input-group-sm">
 									<?php if ( 'left' === $position ) : ?>
 										<?php if ( empty( $GLOBALS['aui_bs5'] ) ) : ?>
@@ -195,44 +195,44 @@ 
 
 							<?php
 
-						} else {
-						echo wp_kses_post( wpinv_price( $item->get_price(), $currency ) );
+                        } else {
+                        echo wp_kses_post( wpinv_price( $item->get_price(), $currency ) );
 
-						?>
+                        ?>
 								<input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][price]' type='hidden' class='getpaid-item-price-input' value='<?php echo esc_attr( $item->get_price() ); ?>'>
 						<?php
-						}
+                        }
 
-					printf(
+                    printf(
                         '<small class="d-sm-none text-muted form-text getpaid-mobile-item-subtotal">%s</small>',
-						// translators: %s is the item subtotal.
+                        // translators: %s is the item subtotal.
                         sprintf( esc_html__( 'Subtotal: %s', 'invoicing' ), wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) ) )
                     );
-					}
+                    }
 
-					// Item quantity.
-					if ( 'quantity' === $key ) {
+                    // Item quantity.
+                    if ( 'quantity' === $key ) {
 
-					if ( $item->allows_quantities() ) {
-						?>
+                    if ( $item->allows_quantities() ) {
+                        ?>
 								<input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' type="number" step="any" style='width: 64px; line-height: 1; min-height: 35px;' class='getpaid-item-quantity-input p-1 align-middle font-weight-normal shadow-none m-0 rounded-0 text-center border' value='<?php echo (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(); ?>' min='1' <?php echo null !== $max_qty ? 'max="' . (float) $max_qty . '"' : ''; ?> required>
 							<?php
-						} else {
-						echo (float) $item->get_quantity();
-						echo '&nbsp;&nbsp;&nbsp;';
-						?>
+                        } else {
+                        echo (float) $item->get_quantity();
+                        echo '&nbsp;&nbsp;&nbsp;';
+                        ?>
 								<input type='hidden' name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' class='getpaid-item-quantity-input' value='<?php echo (float) $item->get_quantity(); ?>'>
 						<?php
-						}
+                        }
 }
 
-					// Item sub total.
-					if ( 'subtotal' === $key ) {
-					echo wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) );
-					}
+                    // Item sub total.
+                    if ( 'subtotal' === $key ) {
+                    echo wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) );
+                    }
 
-					do_action( "getpaid_payment_form_cart_item_$key", $item, $form );
-				?>
+                    do_action( "getpaid_payment_form_cart_item_$key", $item, $form );
+                ?>
 
 			</div>
 

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

Indentation +615 added lines, -615 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() {
-
-		do_action( 'getpaid_before_init_payment_gateway_' . $this->id, $this );
-
-		// 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;
-			}
+    /**
+     * 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() {
+
+        do_action( 'getpaid_before_init_payment_gateway_' . $this->id, $this );
+
+        // 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.
-	 */
+        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 ) );
 
@@ -488,7 +488,7 @@ 
             '11' => __( 'November', 'invoicing' ),
             '12' => __( 'December', 'invoicing' ),
         );
-		$months = apply_filters( 'getpaid_cc_months', $months, $this );
+        $months = apply_filters( 'getpaid_cc_months', $months, $this );
 
         $year  = (int) current_time( 'Y' );
         $years = array();
@@ -497,7 +497,7 @@ 
             $years[ $year + $i ] = $year + $i;
         }
 
-		$years = apply_filters( 'getpaid_cc_years', $years, $this );
+        $years = apply_filters( 'getpaid_cc_years', $years, $this );
 
         ?>
             <div class="<?php echo esc_attr( $this->id ); ?>-cc-form getpaid-cc-form mt-1">
@@ -539,7 +539,7 @@ 
 
                                             <?php
                                                 foreach ( $months as $key => $month ) {
-												echo "<option value='" . esc_attr( $key ) . "'>" . esc_html( $month ) . '</option>';
+                                                echo "<option value='" . esc_attr( $key ) . "'>" . esc_html( $month ) . '</option>';
                                                 }
                                             ?>
 
@@ -552,7 +552,7 @@ 
 
                                             <?php
                                                 foreach ( $years as $key => $year ) {
-												echo "<option value='" . esc_attr( $key ) . "'>" . esc_html( $year ) . '</option>';
+                                                echo "<option value='" . esc_attr( $key ) . "'>" . esc_html( $year ) . '</option>';
                                                 }
                                             ?>
 
@@ -570,13 +570,13 @@ 
                                         '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',
+                                        ),
                                     ),
-									true
+                                    true
                                 );
                             ?>
                         </div>
@@ -585,192 +585,192 @@ 
 
 					<?php
 
-						if ( $save ) {
-							$this->save_payment_method_checkbox();
-						}
+                        if ( $save ) {
+                            $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;'> " . wp_kses( $form, getpaid_allowed_html() ) . '</div>';
+    }
+
+    /**
+     * Grab and display our saved payment methods.
+     *
+     * @since 1.0.19
+     */
+    public function saved_payment_methods() {
+        echo '<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 ) {
+            $this->get_saved_payment_method_option_html( $token );
+        }
+
+        $this->get_new_payment_method_option_html();
+        echo '</ul>';
 
     }
 
-	/**
-	 * 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;'> " . wp_kses( $form, getpaid_allowed_html() ) . '</div>';
-	}
-
-	/**
-	 * Grab and display our saved payment methods.
-	 *
-	 * @since 1.0.19
-	 */
-	public function saved_payment_methods() {
-		echo '<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 ) {
-			$this->get_saved_payment_method_option_html( $token );
-		}
-
-		$this->get_new_payment_method_option_html();
-		echo '</ul>';
-
-	}
-
-	/**
-	 * 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 ) {
-
-		printf(
-			'<li class="getpaid-payment-method form-group mb-3">
+    /**
+     * 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 ) {
+
+        printf(
+            '<li class="getpaid-payment-method form-group mb-3">
 				<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 );
-
-		printf(
-			'<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 );
+
+        printf(
+            '<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() {
-
-		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',
-			),
-			true
-		);
-
-	}
-
-	/**
-	 * 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() {
+
+        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',
+            ),
+            true
+        );
+
+    }
+
+    /**
+     * 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/wpinv-helper-functions.php

Indentation +65 added lines, -65 removed lines

@@ -136,13 +136,13 @@ 
  */
 function wpinv_get_invoice_statuses( $draft = false, $trashed = false, $invoice = false ) {
 
-	$invoice_statuses = array(
-		'wpi-pending'    => _x( 'Pending payment', 'Invoice status', 'invoicing' ),
+    $invoice_statuses = array(
+        'wpi-pending'    => _x( 'Pending payment', 'Invoice status', 'invoicing' ),
         'publish'        => _x( 'Paid', 'Invoice status', 'invoicing' ),
         'wpi-processing' => _x( 'Processing', 'Invoice status', 'invoicing' ),
-		'wpi-onhold'     => _x( 'On hold', 'Invoice status', 'invoicing' ),
-		'wpi-cancelled'  => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
-		'wpi-refunded'   => _x( 'Refunded', 'Invoice status', 'invoicing' ),
+        'wpi-onhold'     => _x( 'On hold', 'Invoice status', 'invoicing' ),
+        'wpi-cancelled'  => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
+        'wpi-refunded'   => _x( 'Refunded', 'Invoice status', 'invoicing' ),
         'wpi-failed'     => _x( 'Failed', 'Invoice status', 'invoicing' ),
         'wpi-renewal'    => _x( 'Renewal Payment', 'Invoice status', 'invoicing' ),
     );
@@ -159,7 +159,7 @@ 
         $invoice = $invoice->get_post_type();
     }
 
-	return apply_filters( 'wpinv_statuses', $invoice_statuses, $invoice );
+    return apply_filters( 'wpinv_statuses', $invoice_statuses, $invoice );
 }
 
 /**
@@ -277,25 +277,25 @@ 
  * @return string
  */
 function getpaid_get_price_format() {
-	$currency_pos = wpinv_currency_position();
-	$format       = '%1$s%2$s';
-
-	switch ( $currency_pos ) {
-		case 'left':
-			$format = '%1$s%2$s';
-			break;
-		case 'right':
-			$format = '%2$s%1$s';
-			break;
-		case 'left_space':
-			$format = '%1$s %2$s';
-			break;
-		case 'right_space':
-			$format = '%2$s %1$s';
-			break;
-	}
-
-	return apply_filters( 'getpaid_price_format', $format, $currency_pos );
+    $currency_pos = wpinv_currency_position();
+    $format       = '%1$s%2$s';
+
+    switch ( $currency_pos ) {
+        case 'left':
+            $format = '%1$s%2$s';
+            break;
+        case 'right':
+            $format = '%2$s%1$s';
+            break;
+        case 'left_space':
+            $format = '%1$s %2$s';
+            break;
+        case 'right_space':
+            $format = '%2$s %1$s';
+            break;
+    }
+
+    return apply_filters( 'getpaid_price_format', $format, $currency_pos );
 }
 
 /**
@@ -401,13 +401,13 @@ 
  * @param mixed  $value Value.
  */
 function getpaid_maybe_define_constant( $name, $value ) {
-	if ( ! defined( $name ) ) {
-		define( $name, $value );
-	}
+    if ( ! defined( $name ) ) {
+        define( $name, $value );
+    }
 }
 
 function wpinv_get_php_arg_separator_output() {
-	return ini_get( 'arg_separator.output' );
+    return ini_get( 'arg_separator.output' );
 }
 
 function wpinv_rgb_from_hex( $color ) {
@@ -718,16 +718,16 @@ 
     return wp_kses(
         html_entity_decode( $var ),
         array(
-			'br'     => array(),
-			'em'     => array(),
-			'strong' => array(),
-			'b'      => array(),
-			'small'  => array(),
-			'span'   => array(),
-			'ul'     => array(),
-			'li'     => array(),
-			'ol'     => array(),
-			'p'      => array(),
+            'br'     => array(),
+            'em'     => array(),
+            'strong' => array(),
+            'b'      => array(),
+            'small'  => array(),
+            'span'   => array(),
+            'ul'     => array(),
+            'li'     => array(),
+            'ol'     => array(),
+            'p'      => array(),
         )
     );
 }
@@ -778,11 +778,11 @@ 
         $list = array();
     }
 
-	if ( ! is_array( $list ) ) {
-		return preg_split( '/[\s,]+/', $list, -1, PREG_SPLIT_NO_EMPTY );
-	}
+    if ( ! is_array( $list ) ) {
+        return preg_split( '/[\s,]+/', $list, -1, PREG_SPLIT_NO_EMPTY );
+    }
 
-	return $list;
+    return $list;
 }
 
 /**
@@ -823,17 +823,17 @@ 
  */
 function wpinv_clean( $var ) {
 
-	if ( is_array( $var ) ) {
-		return array_map( 'wpinv_clean', $var );
+    if ( is_array( $var ) ) {
+        return array_map( 'wpinv_clean', $var );
     }
 
     if ( is_object( $var ) ) {
-		$object_vars = get_object_vars( $var );
-		foreach ( $object_vars as $property_name => $property_value ) {
-			$var->$property_name = wpinv_clean( $property_value );
+        $object_vars = get_object_vars( $var );
+        foreach ( $object_vars as $property_name => $property_value ) {
+            $var->$property_name = wpinv_clean( $property_value );
         }
         return $var;
-	}
+    }
 
     return is_string( $var ) ? sanitize_text_field( stripslashes( $var ) ) : $var;
 }
@@ -846,7 +846,7 @@ 
  */
 function getpaid_convert_price_string_to_options( $str ) {
 
-	$raw_options = array_map( 'trim', explode( ',', $str ) );
+    $raw_options = array_map( 'trim', explode( ',', $str ) );
     $options     = array();
 
     foreach ( $raw_options as $option ) {
@@ -935,7 +935,7 @@ 
  * @return string
  */
 function getpaid_date_format() {
-	return apply_filters( 'getpaid_date_format', get_option( 'date_format' ) );
+    return apply_filters( 'getpaid_date_format', get_option( 'date_format' ) );
 }
 
 /**
@@ -944,7 +944,7 @@ 
  * @return string
  */
 function getpaid_time_format() {
-	return apply_filters( 'getpaid_time_format', get_option( 'time_format' ) );
+    return apply_filters( 'getpaid_time_format', get_option( 'time_format' ) );
 }
 
 /**
@@ -957,15 +957,15 @@ 
 function getpaid_limit_length( $string, $limit ) {
     $str_limit = $limit - 3;
 
-	if ( function_exists( 'mb_strimwidth' ) ) {
-		if ( mb_strlen( $string ) > $limit ) {
-			$string = mb_strimwidth( $string, 0, $str_limit ) . '...';
-		}
-	} else {
-		if ( strlen( $string ) > $limit ) {
-			$string = substr( $string, 0, $str_limit ) . '...';
-		}
-	}
+    if ( function_exists( 'mb_strimwidth' ) ) {
+        if ( mb_strlen( $string ) > $limit ) {
+            $string = mb_strimwidth( $string, 0, $str_limit ) . '...';
+        }
+    } else {
+        if ( strlen( $string ) > $limit ) {
+            $string = substr( $string, 0, $str_limit ) . '...';
+        }
+    }
     return $string;
 
 }
@@ -1095,12 +1095,12 @@ 
     $types = get_allowed_mime_types();
 
     if ( isset( $types['htm|html'] ) ) {
-		unset( $types['htm|html'] );
-	}
+        unset( $types['htm|html'] );
+    }
 
     if ( isset( $types['js'] ) ) {
-		unset( $types['js'] );
-	}
+        unset( $types['js'] );
+    }
 
     return $types;
 

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

Indentation +468 added lines, -468 removed lines

@@ -12,491 +12,491 @@
  */
 class GetPaid_Invoice_Notification_Emails {
 
-	/**
-	 * The array of invoice email actions.
-	 *
-	 * @param array
-	 */
-	public $invoice_actions;
-
-	/**
-	 * Class constructor
-	 *
-	 */
-	public function __construct() {
-
-		$this->invoice_actions = apply_filters(
-			'getpaid_notification_email_invoice_triggers',
-			array(
-				'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
-				'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
-				'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
-				'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
-				'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
-				'getpaid_invoice_status_publish'        => 'completed_invoice',
-				'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
-				'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
-				'getpaid_new_customer_note'             => 'user_note',
-				'getpaid_daily_maintenance'             => 'overdue',
-			)
-		);
-
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
-		add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
-
-		foreach ( $this->invoice_actions as $hook => $email_type ) {
-			$this->init_email_type_hook( $hook, $email_type );
-		}
-	}
-
-	/**
-	 * Registers an email hook for an invoice action.
-	 *
-	 * @param string $hook
-	 * @param string|array $email_type
-	 */
-	public function init_email_type_hook( $hook, $email_type ) {
-
-		$email_type = wpinv_parse_list( $email_type );
-
-		foreach ( $email_type as $type ) {
-
-			$email = new GetPaid_Notification_Email( $type );
-
-			// Abort if it is not active.
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $type ) ) {
-				add_action( $hook, array( $this, $type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
-		}
-
-	}
-
-	/**
-	 * Filters invoice merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function invoice_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Invoice' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object )
-			);
-		}
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object->get_parent_payment() )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates invoice merge tags.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_invoice_merge_tags( $invoice ) {
-
-		// Abort if it does not exist.
-		if ( ! $invoice->get_id() ) {
-			return array();
-		}
-
-		$merge_tags = array(
-			'{name}'                 => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{full_name}'            => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{first_name}'           => sanitize_text_field( $invoice->get_first_name() ),
-			'{last_name}'            => sanitize_text_field( $invoice->get_last_name() ),
-			'{email}'                => sanitize_email( $invoice->get_email() ),
-			'{invoice_number}'       => sanitize_text_field( $invoice->get_number() ),
-			'{invoice_currency}'     => sanitize_text_field( $invoice->get_currency() ),
-			'{invoice_total}'        => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ),
-			'{invoice_link}'         => esc_url( $invoice->get_view_url() ),
-			'{invoice_pay_link}'     => esc_url( $invoice->get_checkout_payment_url() ),
-			'{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ),
-			'{invoice_date}'         => getpaid_format_date_value( $invoice->get_date_created() ),
-			'{invoice_due_date}'     => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
-			'{invoice_quote}'        => sanitize_text_field( strtolower( $invoice->get_label() ) ),
-			'{invoice_label}'        => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
-			'{invoice_description}'  => wp_kses_post( $invoice->get_description() ),
-			'{subscription_name}'    => wp_kses_post( $invoice->get_subscription_name() ),
-			'{is_was}'               => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
-		);
-
-		$payment_form_data = $invoice->get_meta( 'payment_form_data', true );
-
-		if ( is_array( $payment_form_data ) ) {
-
-			foreach ( $payment_form_data as $label => $value ) {
-
-				$label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) );
-				$value = is_array( $value ) ? implode( ', ', $value ) : $value;
-
-				if ( is_scalar( $value ) ) {
-					$merge_tags[ "{{$label}}" ] = wp_kses_post( $value );
-				}
-			}
-		}
-
-		return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param string|array $recipients
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
-
-		do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
-
-		$skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' );
-		if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) {
-			return;
-		}
-
-		$mailer     = new GetPaid_Notification_Email_Sender();
-		$merge_tags = $email->get_merge_tags();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$email->add_merge_tags( $email->get_subject(), $merge_tags ),
-			$email->get_content( $merge_tags, $extra_args ),
-			$email->get_attachments()
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
-				$email->get_content( $merge_tags ),
-				$email->get_attachments()
-			);
-		}
-
-		if ( $result ) {
-			$invoice->add_system_note(
-				sprintf(
-					// translators: %1 is the email type, %2 is the invoice recipient.
-					__( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
-				)
-			);
-		} else {
-			$invoice->add_system_note(
-				sprintf(
-					// translators: %1 is the email type, %2 is the invoice recipient.
-					__( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
-				)
-			);
-		}
-
-		do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
-
-		return $result;
-	}
-
-	/**
-	 * Also send emails to any cc users.
-	 *
-	 * @param array $recipients
-	 * @param GetPaid_Notification_Email $email
-	 */
-	public function filter_email_recipients( $recipients, $email ) {
-
-		if ( ! $email->is_admin_email() ) {
-			$cc   = $email->object->get_email_cc();
-			$cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true );
-
-			if ( ! empty( $cc ) ) {
-				$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-			}
-
-			if ( ! empty( $cc_2 ) ) {
-				$cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) );
-			}
-		}
-
-		return $recipients;
-
-	}
-
-	/**
-	 * Sends a new invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function new_invoice( $invoice ) {
-
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
-			return;
-		}
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a cancelled invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function cancelled_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-	}
-
-	/**
-	 * Sends a failed invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function failed_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a notification whenever an invoice is put on hold.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function onhold_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a notification whenever an invoice is marked as processing payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function processing_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a notification whenever an invoice is paid.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function completed_invoice( $invoice ) {
-
-		// (Maybe) abort if it is a renewal invoice.
-		if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
-			return;
-		}
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
+    /**
+     * The array of invoice email actions.
+     *
+     * @param array
+     */
+    public $invoice_actions;
+
+    /**
+     * Class constructor
+     *
+     */
+    public function __construct() {
+
+        $this->invoice_actions = apply_filters(
+            'getpaid_notification_email_invoice_triggers',
+            array(
+                'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
+                'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
+                'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
+                'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
+                'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
+                'getpaid_invoice_status_publish'        => 'completed_invoice',
+                'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
+                'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
+                'getpaid_new_customer_note'             => 'user_note',
+                'getpaid_daily_maintenance'             => 'overdue',
+            )
+        );
+
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
+        add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
+
+        foreach ( $this->invoice_actions as $hook => $email_type ) {
+            $this->init_email_type_hook( $hook, $email_type );
+        }
+    }
+
+    /**
+     * Registers an email hook for an invoice action.
+     *
+     * @param string $hook
+     * @param string|array $email_type
+     */
+    public function init_email_type_hook( $hook, $email_type ) {
+
+        $email_type = wpinv_parse_list( $email_type );
+
+        foreach ( $email_type as $type ) {
+
+            $email = new GetPaid_Notification_Email( $type );
+
+            // Abort if it is not active.
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $type ) ) {
+                add_action( $hook, array( $this, $type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
+        }
+
+    }
+
+    /**
+     * Filters invoice merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function invoice_merge_tags( $merge_tags, $object ) {
+
+        if ( is_a( $object, 'WPInv_Invoice' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object )
+            );
+        }
+
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object->get_parent_payment() )
+            );
+        }
+
+        return $merge_tags;
+
+    }
+
+    /**
+     * Generates invoice merge tags.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_invoice_merge_tags( $invoice ) {
+
+        // Abort if it does not exist.
+        if ( ! $invoice->get_id() ) {
+            return array();
+        }
+
+        $merge_tags = array(
+            '{name}'                 => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{full_name}'            => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{first_name}'           => sanitize_text_field( $invoice->get_first_name() ),
+            '{last_name}'            => sanitize_text_field( $invoice->get_last_name() ),
+            '{email}'                => sanitize_email( $invoice->get_email() ),
+            '{invoice_number}'       => sanitize_text_field( $invoice->get_number() ),
+            '{invoice_currency}'     => sanitize_text_field( $invoice->get_currency() ),
+            '{invoice_total}'        => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ),
+            '{invoice_link}'         => esc_url( $invoice->get_view_url() ),
+            '{invoice_pay_link}'     => esc_url( $invoice->get_checkout_payment_url() ),
+            '{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ),
+            '{invoice_date}'         => getpaid_format_date_value( $invoice->get_date_created() ),
+            '{invoice_due_date}'     => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
+            '{invoice_quote}'        => sanitize_text_field( strtolower( $invoice->get_label() ) ),
+            '{invoice_label}'        => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
+            '{invoice_description}'  => wp_kses_post( $invoice->get_description() ),
+            '{subscription_name}'    => wp_kses_post( $invoice->get_subscription_name() ),
+            '{is_was}'               => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+        );
+
+        $payment_form_data = $invoice->get_meta( 'payment_form_data', true );
+
+        if ( is_array( $payment_form_data ) ) {
+
+            foreach ( $payment_form_data as $label => $value ) {
+
+                $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) );
+                $value = is_array( $value ) ? implode( ', ', $value ) : $value;
+
+                if ( is_scalar( $value ) ) {
+                    $merge_tags[ "{{$label}}" ] = wp_kses_post( $value );
+                }
+            }
+        }
+
+        return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is refunded.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function refunded_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param string|array $recipients
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
 
-	/**
-	 * Notifies a user about new invoices
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param bool $force
-	 */
-	public function user_invoice( $invoice, $force = false ) {
+        do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
 
-		if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) {
-			return;
-		}
-
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) {
-			return;
-		}
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Checks if an invoice is a payment form invoice.
-	 *
-	 * @param int $invoice
-	 * @return bool
-	 */
-	public function is_payment_form_invoice( $invoice ) {
-		$created_via             = get_post_meta( $invoice, 'wpinv_created_via', true );
-		$is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via;
-		$is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice );
-		return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice;
-	}
-
-	/**
-	 * Notifies admin about new invoice notes
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $note
-	 */
-	public function user_note( $invoice, $note ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
-
-	}
-
-	/**
-	 * (Force) Sends overdue notices.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function force_send_overdue_notice( $invoice ) {
-		$email = new GetPaid_Notification_Email( 'overdue', $invoice );
-		return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
-	}
-
-	/**
-	 * Sends overdue notices.
-	 *
-	 * @TODO: Create an invoices query class.
-	 */
-	public function overdue() {
-		global $wpdb;
-
-		$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;
-		}
-
-		// Retrieve date query.
-		$date_query = $this->get_date_query( $reminder_days );
-
-		// Invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-
-		// Fetch invoices.
-		$invoices  = $wpdb->get_col(
-			"SELECT posts.ID FROM $wpdb->posts as posts
+        $skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' );
+        if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) {
+            return;
+        }
+
+        $mailer     = new GetPaid_Notification_Email_Sender();
+        $merge_tags = $email->get_merge_tags();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $email->add_merge_tags( $email->get_subject(), $merge_tags ),
+            $email->get_content( $merge_tags, $extra_args ),
+            $email->get_attachments()
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
+                $email->get_content( $merge_tags ),
+                $email->get_attachments()
+            );
+        }
+
+        if ( $result ) {
+            $invoice->add_system_note(
+                sprintf(
+                    // translators: %1 is the email type, %2 is the invoice recipient.
+                    __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
+                )
+            );
+        } else {
+            $invoice->add_system_note(
+                sprintf(
+                    // translators: %1 is the email type, %2 is the invoice recipient.
+                    __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
+                )
+            );
+        }
+
+        do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
+
+        return $result;
+    }
+
+    /**
+     * Also send emails to any cc users.
+     *
+     * @param array $recipients
+     * @param GetPaid_Notification_Email $email
+     */
+    public function filter_email_recipients( $recipients, $email ) {
+
+        if ( ! $email->is_admin_email() ) {
+            $cc   = $email->object->get_email_cc();
+            $cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true );
+
+            if ( ! empty( $cc ) ) {
+                $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+                $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+            }
+
+            if ( ! empty( $cc_2 ) ) {
+                $cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) );
+                $recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) );
+            }
+        }
+
+        return $recipients;
+
+    }
+
+    /**
+     * Sends a new invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function new_invoice( $invoice ) {
+
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+            return;
+        }
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a cancelled invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function cancelled_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+    }
+
+    /**
+     * Sends a failed invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function failed_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a notification whenever an invoice is put on hold.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function onhold_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a notification whenever an invoice is marked as processing payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function processing_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a notification whenever an invoice is paid.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function completed_invoice( $invoice ) {
+
+        // (Maybe) abort if it is a renewal invoice.
+        if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
+            return;
+        }
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a notification whenever an invoice is refunded.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function refunded_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Notifies a user about new invoices
+     *
+     * @param WPInv_Invoice $invoice
+     * @param bool $force
+     */
+    public function user_invoice( $invoice, $force = false ) {
+
+        if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) {
+            return;
+        }
+
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) {
+            return;
+        }
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Checks if an invoice is a payment form invoice.
+     *
+     * @param int $invoice
+     * @return bool
+     */
+    public function is_payment_form_invoice( $invoice ) {
+        $created_via             = get_post_meta( $invoice, 'wpinv_created_via', true );
+        $is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via;
+        $is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice );
+        return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice;
+    }
+
+    /**
+     * Notifies admin about new invoice notes
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $note
+     */
+    public function user_note( $invoice, $note ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
+
+    }
+
+    /**
+     * (Force) Sends overdue notices.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function force_send_overdue_notice( $invoice ) {
+        $email = new GetPaid_Notification_Email( 'overdue', $invoice );
+        return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
+    }
+
+    /**
+     * Sends overdue notices.
+     *
+     * @TODO: Create an invoices query class.
+     */
+    public function overdue() {
+        global $wpdb;
+
+        $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;
+        }
+
+        // Retrieve date query.
+        $date_query = $this->get_date_query( $reminder_days );
+
+        // Invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+
+        // Fetch invoices.
+        $invoices  = $wpdb->get_col(
+            "SELECT posts.ID FROM $wpdb->posts as posts
 			LEFT JOIN $table as invoices ON invoices.post_id = posts.ID
 			WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query"
         );
 
-		foreach ( $invoices as $invoice ) {
+        foreach ( $invoices as $invoice ) {
 
-			// Only send this email for invoices created via the admin page.
-			if ( ! $this->is_payment_form_invoice( $invoice ) ) {
-				$invoice       = new WPInv_Invoice( $invoice );
-				$email->object = $invoice;
+            // Only send this email for invoices created via the admin page.
+            if ( ! $this->is_payment_form_invoice( $invoice ) ) {
+                $invoice       = new WPInv_Invoice( $invoice );
+                $email->object = $invoice;
 
-				if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) {
-					$this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
-				}
-			}
-		}
+                if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) {
+                    $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
+                }
+            }
+        }
 
-	}
+    }
 
-	/**
-	 * Calculates the date query for an invoices query
-	 *
-	 * @param array $reminder_days
-	 * @return string
-	 */
-	public function get_date_query( $reminder_days ) {
+    /**
+     * Calculates the date query for an invoices query
+     *
+     * @param array $reminder_days
+     * @return string
+     */
+    public function get_date_query( $reminder_days ) {
 
-		$date_query = array(
-			'relation' => 'OR',
-		);
+        $date_query = array(
+            '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' ) ) ) );
 
-			$date_query[] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $date_query[] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
+        $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
 
-		return $date_query->get_sql();
+        return $date_query->get_sql();
 
-	}
+    }
 
 }

includes/class-wpinv-ajax.php

Indentation +64 added lines, -64 removed lines

@@ -14,70 +14,70 @@ 
 class WPInv_Ajax {
 
     /**
-	 * Hook in ajax handlers.
-	 */
-	public static function init() {
-		add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
-		add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
-		self::add_ajax_events();
+     * Hook in ajax handlers.
+     */
+    public static function init() {
+        add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
+        add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
+        self::add_ajax_events();
     }
 
     /**
-	 * Set GetPaid AJAX constant and headers.
-	 */
-	public static function define_ajax() {
-
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			getpaid_maybe_define_constant( 'DOING_AJAX', true );
-			getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
-			if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
-				/** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
-			}
-			$GLOBALS['wpdb']->hide_errors();
-		}
+     * Set GetPaid AJAX constant and headers.
+     */
+    public static function define_ajax() {
+
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            getpaid_maybe_define_constant( 'DOING_AJAX', true );
+            getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
+            if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
+                /** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
+            }
+            $GLOBALS['wpdb']->hide_errors();
+        }
 
     }
 
     /**
-	 * Send headers for GetPaid Ajax Requests.
-	 *
-	 * @since 1.0.18
-	 */
-	private static function wpinv_ajax_headers() {
-		if ( ! headers_sent() ) {
-			send_origin_headers();
-			send_nosniff_header();
-			nocache_headers();
-			header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
-			header( 'X-Robots-Tag: noindex' );
-			status_header( 200 );
-		}
+     * Send headers for GetPaid Ajax Requests.
+     *
+     * @since 1.0.18
+     */
+    private static function wpinv_ajax_headers() {
+        if ( ! headers_sent() ) {
+            send_origin_headers();
+            send_nosniff_header();
+            nocache_headers();
+            header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
+            header( 'X-Robots-Tag: noindex' );
+            status_header( 200 );
+        }
     }
 
     /**
-	 * Check for GetPaid Ajax request and fire action.
-	 */
-	public static function do_wpinv_ajax() {
-		global $wp_query;
+     * Check for GetPaid Ajax request and fire action.
+     */
+    public static function do_wpinv_ajax() {
+        global $wp_query;
 
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			$wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
-		}
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            $wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
+        }
 
-		$action = $wp_query->get( 'wpinv-ajax' );
+        $action = $wp_query->get( 'wpinv-ajax' );
 
-		if ( $action ) {
-			self::wpinv_ajax_headers();
-			$action = sanitize_text_field( $action );
-			do_action( 'wpinv_ajax_' . $action );
-			wp_die();
-		}
+        if ( $action ) {
+            self::wpinv_ajax_headers();
+            $action = sanitize_text_field( $action );
+            do_action( 'wpinv_ajax_' . $action );
+            wp_die();
+        }
 
     }
 
     /**
-	 * Hook in ajax methods.
-	 */
+     * Hook in ajax methods.
+     */
     public static function add_ajax_events() {
 
         // array( 'event' => is_frontend )
@@ -258,11 +258,11 @@ 
         global $getpaid_force_checkbox;
 
         // Is the request set up correctly?
-		if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) && empty( $_GET['invoice'] ) ) {
-			aui()->alert(
-				array(
-					'type'    => 'warning',
-					'content' => __( 'No payment form or item provided', 'invoicing' ),
+        if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) && empty( $_GET['invoice'] ) ) {
+            aui()->alert(
+                array(
+                    'type'    => 'warning',
+                    'content' => __( 'No payment form or item provided', 'invoicing' ),
                 ),
                 true
             );
@@ -270,7 +270,7 @@ 
         }
 
         // Payment form or button?
-		if ( ! empty( $_GET['form'] ) ) {
+        if ( ! empty( $_GET['form'] ) ) {
             $form = sanitize_text_field( urldecode( $_GET['form'] ) );
 
             if ( false !== strpos( $form, '|' ) ) {
@@ -323,10 +323,10 @@ 
                 getpaid_display_payment_form( $form );
             }
 } elseif ( ! empty( $_GET['invoice'] ) ) {
-		    getpaid_display_invoice_payment_form( (int) urldecode( $_GET['invoice'] ) );
+            getpaid_display_invoice_payment_form( (int) urldecode( $_GET['invoice'] ) );
         } else {
-			$items = getpaid_convert_items_to_array( sanitize_text_field( urldecode( $_GET['item'] ) ) );
-		    getpaid_display_item_payment_form( $items );
+            $items = getpaid_convert_items_to_array( sanitize_text_field( urldecode( $_GET['item'] ) ) );
+            getpaid_display_item_payment_form( $items );
         }
 
         exit;
@@ -643,7 +643,7 @@ 
         if ( is_wp_error( $error ) ) {
             $alert = $error->get_error_message();
             wp_send_json_success( compact( 'alert' ) );
-         }
+            }
 
         // Update totals.
         $invoice->recalculate_total();
@@ -1072,12 +1072,12 @@ 
     }
 
     /**
-	 * Handles file uploads.
-	 *
-	 * @since       1.0.0
-	 * @return      void
-	 */
-	public static function file_upload() {
+     * Handles file uploads.
+     *
+     * @since       1.0.0
+     * @return      void
+     */
+    public static function file_upload() {
 
         // Check nonce.
         check_ajax_referer( 'getpaid_form_nonce' );
@@ -1138,7 +1138,7 @@ 
 
         wp_send_json_success( $response );
 
-	}
+    }
 
 }
 

includes/class-wpinv.php

Indentation +590 added lines, -590 removed lines

@@ -14,635 +14,635 @@
  */
 class WPInv_Plugin {
 
-	/**
-	 * GetPaid version.
-	 *
-	 * @var string
-	 */
-	public $version;
-
-	/**
-	 * Data container.
-	 *
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Form elements instance.
-	 *
-	 * @var WPInv_Payment_Form_Elements
-	 */
-	public $form_elements;
-
-	/**
-	 * @var array An array of payment gateways.
-	 */
-	public $gateways;
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-		$this->define_constants();
-		$this->includes();
-		$this->init_hooks();
-		$this->set_properties();
-	}
-
-	/**
-	 * Sets a custom data property.
-	 *
-	 * @param string $prop The prop to set.
-	 * @param mixed $value The value to retrieve.
-	 */
-	public function set( $prop, $value ) {
-		$this->data[ $prop ] = $value;
-	}
-
-	/**
-	 * Gets a custom data property.
-	 *
-	 * @param string $prop The prop to set.
-	 * @return mixed The value.
-	 */
-	public function get( $prop ) {
-
-		if ( isset( $this->data[ $prop ] ) ) {
-			return $this->data[ $prop ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Define class properties.
-	 */
-	public function set_properties() {
-
-		// Sessions.
-		$this->set( 'session', new WPInv_Session_Handler() );
-		$GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility.
-		$GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility.
-
-		// Init other objects.
-		$this->set( 'notes', new WPInv_Notes() );
-		$this->set( 'api', new WPInv_API() );
-		$this->set( 'post_types', new GetPaid_Post_Types() );
-		$this->set( 'template', new GetPaid_Template() );
-		$this->set( 'admin', new GetPaid_Admin() );
-		$this->set( 'subscriptions', new WPInv_Subscriptions() );
-		$this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() );
-		$this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() );
-		$this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() );
-		$this->set( 'payment_forms', new GetPaid_Payment_Forms() );
-		$this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() );
-
-	}
-
-	 /**
-	 * Define plugin constants.
-	 */
-	public function define_constants() {
-		define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) );
-		define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) );
-		$this->version = WPINV_VERSION;
-	}
-
-	/**
-	 * Hook into actions and filters.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function init_hooks() {
-		/* Internationalize the text strings used. */
-		add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) );
-
-		// Init the plugin after WordPress inits.
-		add_action( 'init', array( $this, 'init' ), 1 );
-		add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 );
-		add_action( 'init', array( $this, 'wpinv_actions' ) );
-		add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 );
-		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 );
-		add_action( 'wp_footer', array( $this, 'wp_footer' ) );
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
-		add_action( 'widgets_init', array( $this, 'register_widgets' ) );
-		add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) );
-		add_filter( 'the_seo_framework_sitemap_supported_post_types', array( $this, 'exclude_invoicing_post_types' ) );
-		add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) );
-
-		add_filter( 'query_vars', array( $this, 'custom_query_vars' ) );
+    /**
+     * GetPaid version.
+     *
+     * @var string
+     */
+    public $version;
+
+    /**
+     * Data container.
+     *
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Form elements instance.
+     *
+     * @var WPInv_Payment_Form_Elements
+     */
+    public $form_elements;
+
+    /**
+     * @var array An array of payment gateways.
+     */
+    public $gateways;
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+        $this->define_constants();
+        $this->includes();
+        $this->init_hooks();
+        $this->set_properties();
+    }
+
+    /**
+     * Sets a custom data property.
+     *
+     * @param string $prop The prop to set.
+     * @param mixed $value The value to retrieve.
+     */
+    public function set( $prop, $value ) {
+        $this->data[ $prop ] = $value;
+    }
+
+    /**
+     * Gets a custom data property.
+     *
+     * @param string $prop The prop to set.
+     * @return mixed The value.
+     */
+    public function get( $prop ) {
+
+        if ( isset( $this->data[ $prop ] ) ) {
+            return $this->data[ $prop ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Define class properties.
+     */
+    public function set_properties() {
+
+        // Sessions.
+        $this->set( 'session', new WPInv_Session_Handler() );
+        $GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility.
+        $GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility.
+
+        // Init other objects.
+        $this->set( 'notes', new WPInv_Notes() );
+        $this->set( 'api', new WPInv_API() );
+        $this->set( 'post_types', new GetPaid_Post_Types() );
+        $this->set( 'template', new GetPaid_Template() );
+        $this->set( 'admin', new GetPaid_Admin() );
+        $this->set( 'subscriptions', new WPInv_Subscriptions() );
+        $this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() );
+        $this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() );
+        $this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() );
+        $this->set( 'payment_forms', new GetPaid_Payment_Forms() );
+        $this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() );
+
+    }
+
+        /**
+         * Define plugin constants.
+         */
+    public function define_constants() {
+        define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) );
+        define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) );
+        $this->version = WPINV_VERSION;
+    }
+
+    /**
+     * Hook into actions and filters.
+     *
+     * @since 1.0.19
+     */
+    protected function init_hooks() {
+        /* Internationalize the text strings used. */
+        add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) );
+
+        // Init the plugin after WordPress inits.
+        add_action( 'init', array( $this, 'init' ), 1 );
+        add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 );
+        add_action( 'init', array( $this, 'wpinv_actions' ) );
+        add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 );
+        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 );
+        add_action( 'wp_footer', array( $this, 'wp_footer' ) );
+        add_action( 'wp_head', array( $this, 'wp_head' ) );
+        add_action( 'widgets_init', array( $this, 'register_widgets' ) );
+        add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) );
+        add_filter( 'the_seo_framework_sitemap_supported_post_types', array( $this, 'exclude_invoicing_post_types' ) );
+        add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) );
+
+        add_filter( 'query_vars', array( $this, 'custom_query_vars' ) );
         add_action( 'init', array( $this, 'add_rewrite_rule' ), 10, 0 );
-		add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 );
-
-		// Fires after registering actions.
-		do_action( 'wpinv_actions', $this );
-		do_action( 'getpaid_actions', $this );
-
-	}
-
-	public function plugins_loaded() {
-		/* Internationalize the text strings used. */
-		$this->load_textdomain();
-
-		do_action( 'wpinv_loaded' );
-
-		// Fix oxygen page builder conflict
-		if ( function_exists( 'ct_css_output' ) ) {
-			wpinv_oxygen_fix_conflict();
-		}
-	}
-
-	/**
-	 * Load Localisation files.
-	 *
-	 * Note: the first-loaded translation file overrides any following ones if the same translation is present.
-	 *
-	 * Locales found in:
-	 *      - WP_LANG_DIR/plugins/invoicing-LOCALE.mo
-	 *      - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo
-	 *
-	 * @since 1.0.0
-	 */
-	public function load_textdomain() {
-
-		load_plugin_textdomain(
-			'invoicing',
-			false,
-			plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/'
-		);
-
-	}
-
-	/**
-	 * Include required core files used in admin and on the frontend.
-	 */
-	public function includes() {
-
-		// Start with the settings.
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php';
-
-		// Packages/libraries.
-		require_once WPINV_PLUGIN_DIR . 'vendor/autoload.php';
-		require_once WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php';
-
-		// Load functions.
-		require_once WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/invoice-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/subscription-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/user-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/error-functions.php';
-
-		// Register autoloader.
-		try {
-			spl_autoload_register( array( $this, 'autoload' ), true );
-		} catch ( Exception $e ) {
-			wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
-		}
-
-		require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/checkout.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-history.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/subscriptions.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/buy-item.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/getpaid.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php';
-
-		if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) {
-			GetPaid_Post_Types_Admin::init();
-
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php';
-			// load the user class only on the users.php page
-			global $pagenow;
-			if ( $pagenow == 'users.php' ) {
-				new WPInv_Admin_Users();
-			}
-		}
-
-		// Register cli commands
-		if ( defined( 'WP_CLI' ) && WP_CLI ) {
-			require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php';
-			WP_CLI::add_command( 'invoicing', 'WPInv_CLI' );
-		}
-
-	}
-
-	/**
-	 * Class autoloader
-	 *
-	 * @param       string $class_name The name of the class to load.
-	 * @access      public
-	 * @since       1.0.19
-	 * @return      void
-	 */
-	public function autoload( $class_name ) {
-
-		// Normalize the class name...
-		$class_name  = strtolower( $class_name );
-
-		// ... and make sure it is our class.
-		if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
-			return;
-		}
-
-		// Next, prepare the file name from the class.
-		$file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
-
-		// Base path of the classes.
-		$plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
-
-		// And an array of possible locations in order of importance.
-		$locations = array(
-			"$plugin_path/includes",
-			"$plugin_path/includes/data-stores",
-			"$plugin_path/includes/gateways",
-			"$plugin_path/includes/payments",
-			"$plugin_path/includes/geolocation",
-			"$plugin_path/includes/reports",
-			"$plugin_path/includes/api",
-			"$plugin_path/includes/admin",
-			"$plugin_path/includes/admin/meta-boxes",
-		);
-
-		foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) {
-
-			if ( file_exists( trailingslashit( $location ) . $file_name ) ) {
-				include trailingslashit( $location ) . $file_name;
-				break;
-			}
+        add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 );
+
+        // Fires after registering actions.
+        do_action( 'wpinv_actions', $this );
+        do_action( 'getpaid_actions', $this );
+
+    }
+
+    public function plugins_loaded() {
+        /* Internationalize the text strings used. */
+        $this->load_textdomain();
+
+        do_action( 'wpinv_loaded' );
+
+        // Fix oxygen page builder conflict
+        if ( function_exists( 'ct_css_output' ) ) {
+            wpinv_oxygen_fix_conflict();
+        }
+    }
+
+    /**
+     * Load Localisation files.
+     *
+     * Note: the first-loaded translation file overrides any following ones if the same translation is present.
+     *
+     * Locales found in:
+     *      - WP_LANG_DIR/plugins/invoicing-LOCALE.mo
+     *      - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo
+     *
+     * @since 1.0.0
+     */
+    public function load_textdomain() {
+
+        load_plugin_textdomain(
+            'invoicing',
+            false,
+            plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/'
+        );
+
+    }
+
+    /**
+     * Include required core files used in admin and on the frontend.
+     */
+    public function includes() {
+
+        // Start with the settings.
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php';
+
+        // Packages/libraries.
+        require_once WPINV_PLUGIN_DIR . 'vendor/autoload.php';
+        require_once WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php';
+
+        // Load functions.
+        require_once WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/invoice-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/subscription-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/user-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/error-functions.php';
+
+        // Register autoloader.
+        try {
+            spl_autoload_register( array( $this, 'autoload' ), true );
+        } catch ( Exception $e ) {
+            wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
+        }
+
+        require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/checkout.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-history.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/subscriptions.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/buy-item.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/getpaid.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php';
+
+        if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) {
+            GetPaid_Post_Types_Admin::init();
+
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php';
+            // load the user class only on the users.php page
+            global $pagenow;
+            if ( $pagenow == 'users.php' ) {
+                new WPInv_Admin_Users();
+            }
+        }
+
+        // Register cli commands
+        if ( defined( 'WP_CLI' ) && WP_CLI ) {
+            require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php';
+            WP_CLI::add_command( 'invoicing', 'WPInv_CLI' );
+        }
+
+    }
+
+    /**
+     * Class autoloader
+     *
+     * @param       string $class_name The name of the class to load.
+     * @access      public
+     * @since       1.0.19
+     * @return      void
+     */
+    public function autoload( $class_name ) {
+
+        // Normalize the class name...
+        $class_name  = strtolower( $class_name );
+
+        // ... and make sure it is our class.
+        if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
+            return;
+        }
+
+        // Next, prepare the file name from the class.
+        $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
+
+        // Base path of the classes.
+        $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
+
+        // And an array of possible locations in order of importance.
+        $locations = array(
+            "$plugin_path/includes",
+            "$plugin_path/includes/data-stores",
+            "$plugin_path/includes/gateways",
+            "$plugin_path/includes/payments",
+            "$plugin_path/includes/geolocation",
+            "$plugin_path/includes/reports",
+            "$plugin_path/includes/api",
+            "$plugin_path/includes/admin",
+            "$plugin_path/includes/admin/meta-boxes",
+        );
+
+        foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) {
+
+            if ( file_exists( trailingslashit( $location ) . $file_name ) ) {
+                include trailingslashit( $location ) . $file_name;
+                break;
+            }
 }
 
-	}
-
-	/**
-	 * Inits hooks etc.
-	 */
-	public function init() {
-
-		// Fires before getpaid inits.
-		do_action( 'before_getpaid_init', $this );
-
-		// Maybe upgrade.
-		$this->maybe_upgrade_database();
-
-		// Load default gateways.
-		$gateways = apply_filters(
-			'getpaid_default_gateways',
-			array(
-				'manual'        => 'GetPaid_Manual_Gateway',
-				'paypal'        => 'GetPaid_Paypal_Gateway',
-				'worldpay'      => 'GetPaid_Worldpay_Gateway',
-				'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway',
-				'authorizenet'  => 'GetPaid_Authorize_Net_Gateway',
-			)
-		);
-
-		foreach ( $gateways as $id => $class ) {
-			$this->gateways[ $id ] = new $class();
-		}
-
-		if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) {
-			GetPaid_Installer::rename_gateways_label();
-			update_option( 'wpinv_renamed_gateways', 'yes' );
-		}
-
-		// Fires after getpaid inits.
-		do_action( 'getpaid_init', $this );
-
-	}
-
-	/**
-	 * Checks if this is an IPN request and processes it.
-	 */
-	public function maybe_process_ipn() {
-
-		// Ensure that this is an IPN request.
-		if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) {
-			return;
-		}
-
-		$gateway = sanitize_text_field( $_GET['wpi-gateway'] );
-
-		do_action( 'wpinv_verify_payment_ipn', $gateway );
-		do_action( "wpinv_verify_{$gateway}_ipn" );
-		exit;
-
-	}
-
-	public function enqueue_scripts() {
-
-		// Fires before adding scripts.
-		do_action( 'getpaid_enqueue_scripts' );
-
-		$localize                         = array();
-		$localize['ajax_url']             = admin_url( 'admin-ajax.php' );
-		$localize['thousands']            = wpinv_thousands_separator();
-		$localize['decimals']             = wpinv_decimal_separator();
-		$localize['nonce']                = wp_create_nonce( 'wpinv-nonce' );
-		$localize['txtComplete']          = __( 'Continue', 'invoicing' );
-		$localize['UseTaxes']             = wpinv_use_taxes();
-		$localize['formNonce']            = wp_create_nonce( 'getpaid_form_nonce' );
-		$localize['loading']              = __( 'Loading...', 'invoicing' );
-		$localize['connectionError']      = __( 'Could not establish a connection to the server.', 'invoicing' );
-
-		$localize = apply_filters( 'wpinv_front_js_localize', $localize );
-
-		$version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' );
-		wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true );
-		wp_localize_script( 'wpinv-front-script', 'WPInv', $localize );
-	}
-
-	public function wpinv_actions() {
-		if ( isset( $_REQUEST['wpi_action'] ) ) {
-			do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST );
-		}
-
-		if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) {
-			include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php';
-		}
-	}
-
-	/**
+    }
+
+    /**
+     * Inits hooks etc.
+     */
+    public function init() {
+
+        // Fires before getpaid inits.
+        do_action( 'before_getpaid_init', $this );
+
+        // Maybe upgrade.
+        $this->maybe_upgrade_database();
+
+        // Load default gateways.
+        $gateways = apply_filters(
+            'getpaid_default_gateways',
+            array(
+                'manual'        => 'GetPaid_Manual_Gateway',
+                'paypal'        => 'GetPaid_Paypal_Gateway',
+                'worldpay'      => 'GetPaid_Worldpay_Gateway',
+                'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway',
+                'authorizenet'  => 'GetPaid_Authorize_Net_Gateway',
+            )
+        );
+
+        foreach ( $gateways as $id => $class ) {
+            $this->gateways[ $id ] = new $class();
+        }
+
+        if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) {
+            GetPaid_Installer::rename_gateways_label();
+            update_option( 'wpinv_renamed_gateways', 'yes' );
+        }
+
+        // Fires after getpaid inits.
+        do_action( 'getpaid_init', $this );
+
+    }
+
+    /**
+     * Checks if this is an IPN request and processes it.
+     */
+    public function maybe_process_ipn() {
+
+        // Ensure that this is an IPN request.
+        if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) {
+            return;
+        }
+
+        $gateway = sanitize_text_field( $_GET['wpi-gateway'] );
+
+        do_action( 'wpinv_verify_payment_ipn', $gateway );
+        do_action( "wpinv_verify_{$gateway}_ipn" );
+        exit;
+
+    }
+
+    public function enqueue_scripts() {
+
+        // Fires before adding scripts.
+        do_action( 'getpaid_enqueue_scripts' );
+
+        $localize                         = array();
+        $localize['ajax_url']             = admin_url( 'admin-ajax.php' );
+        $localize['thousands']            = wpinv_thousands_separator();
+        $localize['decimals']             = wpinv_decimal_separator();
+        $localize['nonce']                = wp_create_nonce( 'wpinv-nonce' );
+        $localize['txtComplete']          = __( 'Continue', 'invoicing' );
+        $localize['UseTaxes']             = wpinv_use_taxes();
+        $localize['formNonce']            = wp_create_nonce( 'getpaid_form_nonce' );
+        $localize['loading']              = __( 'Loading...', 'invoicing' );
+        $localize['connectionError']      = __( 'Could not establish a connection to the server.', 'invoicing' );
+
+        $localize = apply_filters( 'wpinv_front_js_localize', $localize );
+
+        $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' );
+        wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true );
+        wp_localize_script( 'wpinv-front-script', 'WPInv', $localize );
+    }
+
+    public function wpinv_actions() {
+        if ( isset( $_REQUEST['wpi_action'] ) ) {
+            do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST );
+        }
+
+        if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) {
+            include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php';
+        }
+    }
+
+    /**
      * Fires an action after verifying that a user can fire them.
-	 *
-	 * Note: If the action is on an invoice, subscription etc, esure that the
-	 * current user owns the invoice/subscription.
+     *
+     * Note: If the action is on an invoice, subscription etc, esure that the
+     * current user owns the invoice/subscription.
      */
     public function maybe_do_authenticated_action() {
 
-		if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) {
+        if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) {
 
-			$key  = sanitize_key( $_REQUEST['getpaid-action'] );
-			$data = wp_unslash( $_REQUEST );
-			if ( is_user_logged_in() ) {
-				do_action( "getpaid_authenticated_action_$key", $data );
-			}
+            $key  = sanitize_key( $_REQUEST['getpaid-action'] );
+            $data = wp_unslash( $_REQUEST );
+            if ( is_user_logged_in() ) {
+                do_action( "getpaid_authenticated_action_$key", $data );
+            }
 
-			do_action( "getpaid_unauthenticated_action_$key", $data );
+            do_action( "getpaid_unauthenticated_action_$key", $data );
 
-		}
+        }
 
     }
 
-	public function pre_get_posts( $wp_query ) {
-
-		if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) {
-			$wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) );
-		}
-
-		return $wp_query;
-	}
-
-	/**
-	 * Register widgets
-	 *
-	 */
-	public function register_widgets() {
-		global $pagenow;
-
-		// Currently, UX Builder does not work particulaly well with SuperDuper.
-		// So we disable our widgets when editing a page with UX Builder.
-		if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) {
-			return;
-		}
-
-		$block_widget_init_screens = function_exists( 'sd_pagenow_exclude' ) ? sd_pagenow_exclude() : array();
-
-		if ( is_admin() && $pagenow && in_array( $pagenow, $block_widget_init_screens ) ) {
-			// don't initiate in these conditions.
-		} else {
-
-			// Only load allowed widgets.
-			$exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array();
-			$widgets = apply_filters(
-				'getpaid_widget_classes',
-				array(
-					'WPInv_Checkout_Widget',
-					'WPInv_History_Widget',
-					'WPInv_Receipt_Widget',
-					'WPInv_Subscriptions_Widget',
-					'WPInv_Buy_Item_Widget',
-					'WPInv_Messages_Widget',
-					'WPInv_GetPaid_Widget',
-					'WPInv_Invoice_Widget',
-				)
-			);
-
-			// For each widget...
-			foreach ( $widgets as $widget ) {
-
-				// Abort early if it is excluded for this page.
-				if ( in_array( $widget, $exclude ) ) {
-					continue;
-				}
-
-				// SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it.
-				if ( is_subclass_of( $widget, 'WP_Widget' ) ) {
-					register_widget( $widget );
-				} else {
-					new $widget();
-				}
+    public function pre_get_posts( $wp_query ) {
+
+        if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) {
+            $wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) );
+        }
+
+        return $wp_query;
+    }
+
+    /**
+     * Register widgets
+     *
+     */
+    public function register_widgets() {
+        global $pagenow;
+
+        // Currently, UX Builder does not work particulaly well with SuperDuper.
+        // So we disable our widgets when editing a page with UX Builder.
+        if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) {
+            return;
+        }
+
+        $block_widget_init_screens = function_exists( 'sd_pagenow_exclude' ) ? sd_pagenow_exclude() : array();
+
+        if ( is_admin() && $pagenow && in_array( $pagenow, $block_widget_init_screens ) ) {
+            // don't initiate in these conditions.
+        } else {
+
+            // Only load allowed widgets.
+            $exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array();
+            $widgets = apply_filters(
+                'getpaid_widget_classes',
+                array(
+                    'WPInv_Checkout_Widget',
+                    'WPInv_History_Widget',
+                    'WPInv_Receipt_Widget',
+                    'WPInv_Subscriptions_Widget',
+                    'WPInv_Buy_Item_Widget',
+                    'WPInv_Messages_Widget',
+                    'WPInv_GetPaid_Widget',
+                    'WPInv_Invoice_Widget',
+                )
+            );
+
+            // For each widget...
+            foreach ( $widgets as $widget ) {
+
+                // Abort early if it is excluded for this page.
+                if ( in_array( $widget, $exclude ) ) {
+                    continue;
+                }
+
+                // SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it.
+                if ( is_subclass_of( $widget, 'WP_Widget' ) ) {
+                    register_widget( $widget );
+                } else {
+                    new $widget();
+                }
 }
 }
 
-	}
+    }
+
+    /**
+     * Upgrades the database.
+     *
+     * @since 2.0.2
+     */
+    public function maybe_upgrade_database() {
+
+        $wpi_version = get_option( 'wpinv_version', 0 );
+
+        if ( $wpi_version == WPINV_VERSION ) {
+            return;
+        }
 
-	/**
-	 * Upgrades the database.
-	 *
-	 * @since 2.0.2
-	 */
-	public function maybe_upgrade_database() {
+        $installer = new GetPaid_Installer();
 
-		$wpi_version = get_option( 'wpinv_version', 0 );
+        if ( empty( $wpi_version ) ) {
+            return $installer->upgrade_db( 0 );
+        }
 
-		if ( $wpi_version == WPINV_VERSION ) {
-			return;
-		}
+        $upgrades  = array(
+            '0.0.5'  => '004',
+            '1.0.3'  => '102',
+            '2.0.0'  => '118',
+            '2.0.8'  => '207',
+            '2.6.16' => '2615',
+        );
 
-		$installer = new GetPaid_Installer();
+        foreach ( $upgrades as $key => $method ) {
+
+            if ( version_compare( $wpi_version, $key, '<' ) ) {
+                return $installer->upgrade_db( $method );
+            }
+        }
+
+    }
+
+    /**
+     * Flushes the permalinks if needed.
+     *
+     * @since 2.0.8
+     */
+    public function maybe_flush_permalinks() {
 
-		if ( empty( $wpi_version ) ) {
-			return $installer->upgrade_db( 0 );
-		}
+        $flush = get_option( 'wpinv_flush_permalinks', 0 );
 
-		$upgrades  = array(
-			'0.0.5'  => '004',
-			'1.0.3'  => '102',
-			'2.0.0'  => '118',
-			'2.0.8'  => '207',
-			'2.6.16' => '2615',
-		);
-
-		foreach ( $upgrades as $key => $method ) {
-
-			if ( version_compare( $wpi_version, $key, '<' ) ) {
-				return $installer->upgrade_db( $method );
-			}
-		}
-
-	}
-
-	/**
-	 * Flushes the permalinks if needed.
-	 *
-	 * @since 2.0.8
-	 */
-	public function maybe_flush_permalinks() {
-
-		$flush = get_option( 'wpinv_flush_permalinks', 0 );
-
-		if ( ! empty( $flush ) ) {
-			flush_rewrite_rules();
-			delete_option( 'wpinv_flush_permalinks' );
-		}
-
-	}
-
-	/**
-	 * Remove our pages from yoast sitemaps.
-	 *
-	 * @since 1.0.19
-	 * @param int[] $excluded_posts_ids
-	 */
-	public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ) {
-
-		// Ensure that we have an array.
-		if ( ! is_array( $excluded_posts_ids ) ) {
-			$excluded_posts_ids = array();
-		}
-
-		// Prepare our pages.
-		$our_pages = array();
-
-		// Checkout page.
-		$our_pages[] = wpinv_get_option( 'checkout_page', false );
-
-		// Success page.
-		$our_pages[] = wpinv_get_option( 'success_page', false );
-
-		// Failure page.
-		$our_pages[] = wpinv_get_option( 'failure_page', false );
-
-		// History page.
-		$our_pages[] = wpinv_get_option( 'invoice_history_page', false );
-
-		// Subscriptions page.
-		$our_pages[] = wpinv_get_option( 'invoice_subscription_page', false );
-
-		$our_pages   = array_map( 'intval', array_filter( $our_pages ) );
-
-		$excluded_posts_ids = $excluded_posts_ids + $our_pages;
-		return array_unique( $excluded_posts_ids );
-
-	}
-
-	/**
-	 * Remove our pages from yoast sitemaps.
-	 *
-	 * @since 1.0.19
-	 * @param string[] $post_types
-	 */
-	public function exclude_invoicing_post_types( $post_types ) {
-
-		// Ensure that we have an array.
-		if ( ! is_array( $post_types ) ) {
-			$post_types = array();
-		}
-
-		// Remove our post types.
-		return array_diff( $post_types, array_keys( getpaid_get_invoice_post_types() ) );
-	}
-
-	/**
-	 * Displays additional footer code.
-	 *
-	 * @since 2.0.0
-	 */
-	public function wp_footer() {
-		wpinv_get_template( 'frontend-footer.php' );
-	}
-
-	/**
-	 * Displays additional header code.
-	 *
-	 * @since 2.0.0
-	 */
-	public function wp_head() {
-		wpinv_get_template( 'frontend-head.php' );
-	}
-
-	/**
-	 * Custom query vars.
-	 *
-	 */
-	public function custom_query_vars( $vars ) {
+        if ( ! empty( $flush ) ) {
+            flush_rewrite_rules();
+            delete_option( 'wpinv_flush_permalinks' );
+        }
+
+    }
+
+    /**
+     * Remove our pages from yoast sitemaps.
+     *
+     * @since 1.0.19
+     * @param int[] $excluded_posts_ids
+     */
+    public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ) {
+
+        // Ensure that we have an array.
+        if ( ! is_array( $excluded_posts_ids ) ) {
+            $excluded_posts_ids = array();
+        }
+
+        // Prepare our pages.
+        $our_pages = array();
+
+        // Checkout page.
+        $our_pages[] = wpinv_get_option( 'checkout_page', false );
+
+        // Success page.
+        $our_pages[] = wpinv_get_option( 'success_page', false );
+
+        // Failure page.
+        $our_pages[] = wpinv_get_option( 'failure_page', false );
+
+        // History page.
+        $our_pages[] = wpinv_get_option( 'invoice_history_page', false );
+
+        // Subscriptions page.
+        $our_pages[] = wpinv_get_option( 'invoice_subscription_page', false );
+
+        $our_pages   = array_map( 'intval', array_filter( $our_pages ) );
+
+        $excluded_posts_ids = $excluded_posts_ids + $our_pages;
+        return array_unique( $excluded_posts_ids );
+
+    }
+
+    /**
+     * Remove our pages from yoast sitemaps.
+     *
+     * @since 1.0.19
+     * @param string[] $post_types
+     */
+    public function exclude_invoicing_post_types( $post_types ) {
+
+        // Ensure that we have an array.
+        if ( ! is_array( $post_types ) ) {
+            $post_types = array();
+        }
+
+        // Remove our post types.
+        return array_diff( $post_types, array_keys( getpaid_get_invoice_post_types() ) );
+    }
+
+    /**
+     * Displays additional footer code.
+     *
+     * @since 2.0.0
+     */
+    public function wp_footer() {
+        wpinv_get_template( 'frontend-footer.php' );
+    }
+
+    /**
+     * Displays additional header code.
+     *
+     * @since 2.0.0
+     */
+    public function wp_head() {
+        wpinv_get_template( 'frontend-head.php' );
+    }
+
+    /**
+     * Custom query vars.
+     *
+     */
+    public function custom_query_vars( $vars ) {
         $vars[] = 'getpaid-ipn';
         return $vars;
-	}
+    }
 
-	/**
-	 * Add rewrite tags and rules.
-	 *
-	 */
-	public function add_rewrite_rule() {
+    /**
+     * Add rewrite tags and rules.
+     *
+     */
+    public function add_rewrite_rule() {
         $tag = 'getpaid-ipn';
         add_rewrite_tag( "%$tag%", '([^&]+)' );
         add_rewrite_rule( "^$tag/([^/]*)/?", "index.php?$tag=\$matches[1]", 'top' );
-	}
+    }
 
-	/**
-	 * Processes non-query string ipns.
-	 *
-	 */
-	public function maybe_process_new_ipn( $query ) {
+    /**
+     * Processes non-query string ipns.
+     *
+     */
+    public function maybe_process_new_ipn( $query ) {
 
         if ( is_admin() || ! $query->is_main_query() ) {
             return;
         }
 
-		$gateway = get_query_var( 'getpaid-ipn' );
+        $gateway = get_query_var( 'getpaid-ipn' );
 
         if ( ! empty( $gateway ) ) {
 
-			$gateway = sanitize_text_field( $gateway );
-			nocache_headers();
-			do_action( 'wpinv_verify_payment_ipn', $gateway );
-			do_action( "wpinv_verify_{$gateway}_ipn" );
-			exit;
+            $gateway = sanitize_text_field( $gateway );
+            nocache_headers();
+            do_action( 'wpinv_verify_payment_ipn', $gateway );
+            do_action( "wpinv_verify_{$gateway}_ipn" );
+            exit;
 
         }
 
-	}
+    }
 
 }

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

Indentation +232 added lines, -232 removed lines

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