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/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-wpinv-session-handler.php

Indentation +274 added lines, -274 removed lines

@@ -14,125 +14,125 @@ 
  */
 class WPInv_Session_Handler extends WPInv_Session {
 
-	/**
-	 * Cookie name used for the session.
-	 *
-	 * @var string cookie name
-	 */
-	protected $_cookie;
-
-	/**
-	 * Stores session expiry.
-	 *
-	 * @var int session due to expire timestamp
-	 */
-	protected $_session_expiring;
-
-	/**
-	 * Stores session due to expire timestamp.
-	 *
-	 * @var string session expiration timestamp
-	 */
-	protected $_session_expiration;
-
-	/**
-	 * True when the cookie exists.
-	 *
-	 * @var bool Based on whether a cookie exists.
-	 */
-	protected $_has_cookie = false;
-
-	/**
-	 * Table name for session data.
-	 *
-	 * @var string Custom session table name
-	 */
-	protected $_table;
-
-	/**
-	 * Constructor for the session class.
-	 */
-	public function old__construct() {
-
-	    $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH );
+    /**
+     * Cookie name used for the session.
+     *
+     * @var string cookie name
+     */
+    protected $_cookie;
+
+    /**
+     * Stores session expiry.
+     *
+     * @var int session due to expire timestamp
+     */
+    protected $_session_expiring;
+
+    /**
+     * Stores session due to expire timestamp.
+     *
+     * @var string session expiration timestamp
+     */
+    protected $_session_expiration;
+
+    /**
+     * True when the cookie exists.
+     *
+     * @var bool Based on whether a cookie exists.
+     */
+    protected $_has_cookie = false;
+
+    /**
+     * Table name for session data.
+     *
+     * @var string Custom session table name
+     */
+    protected $_table;
+
+    /**
+     * Constructor for the session class.
+     */
+    public function old__construct() {
+
+        $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH );
         add_action( 'init', array( $this, 'init' ), -1 );
-		add_action( 'wp_logout', array( $this, 'destroy_session' ) );
-		add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 );
-		add_action( 'shutdown', array( $this, 'save_data' ), 20 );
-
-	}
-
-	/**
-	 * Init hooks and session data.
-	 *
-	 * @since 3.3.0
-	 */
-	public function init() {
-		$this->init_session_cookie();
-
-		if ( ! is_user_logged_in() ) {
-			add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 );
-		}
-	}
-
-	/**
-	 * Setup cookie and customer ID.
-	 *
-	 * @since 3.6.0
-	 */
-	public function init_session_cookie() {
-		$cookie = $this->get_session_cookie();
-
-		if ( $cookie ) {
-			$this->_customer_id        = $cookie[0];
-			$this->_session_expiration = $cookie[1];
-			$this->_session_expiring   = $cookie[2];
-			$this->_has_cookie         = true;
-			$this->_data               = $this->get_session_data();
-
-			// If the user logs in, update session.
-			if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) {
-				$this->_customer_id = get_current_user_id();
-				$this->_dirty       = true;
-				$this->save_data();
-				$this->set_customer_session_cookie( true );
-			}
-
-			// Update session if its close to expiring.
-			if ( time() > $this->_session_expiring ) {
-				$this->set_session_expiration();
-				$this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
-			}
-		} else {
-			$this->set_session_expiration();
-			$this->_customer_id = $this->generate_customer_id();
-			$this->_data        = $this->get_session_data();
-		}
-	}
-
-	/**
-	 * Sets the session cookie on-demand (usually after adding an item to the cart).
-	 *
-	 * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set.
-	 *
-	 * Warning: Cookies will only be set if this is called before the headers are sent.
-	 *
-	 * @param bool $set Should the session cookie be set.
-	 */
-	public function set_customer_session_cookie( $set ) {
-		if ( $set ) {
-			$to_hash           = $this->_customer_id . '|' . $this->_session_expiration;
-			$cookie_hash       = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
-			$cookie_value      = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
-			$this->_has_cookie = true;
-
-			if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) {
-				$this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true );
-			}
-		}
-	}
-
-	public function setcookie( $name, $value, $expire = 0, $secure = false, $httponly = false ) {
+        add_action( 'wp_logout', array( $this, 'destroy_session' ) );
+        add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 );
+        add_action( 'shutdown', array( $this, 'save_data' ), 20 );
+
+    }
+
+    /**
+     * Init hooks and session data.
+     *
+     * @since 3.3.0
+     */
+    public function init() {
+        $this->init_session_cookie();
+
+        if ( ! is_user_logged_in() ) {
+            add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 );
+        }
+    }
+
+    /**
+     * Setup cookie and customer ID.
+     *
+     * @since 3.6.0
+     */
+    public function init_session_cookie() {
+        $cookie = $this->get_session_cookie();
+
+        if ( $cookie ) {
+            $this->_customer_id        = $cookie[0];
+            $this->_session_expiration = $cookie[1];
+            $this->_session_expiring   = $cookie[2];
+            $this->_has_cookie         = true;
+            $this->_data               = $this->get_session_data();
+
+            // If the user logs in, update session.
+            if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) {
+                $this->_customer_id = get_current_user_id();
+                $this->_dirty       = true;
+                $this->save_data();
+                $this->set_customer_session_cookie( true );
+            }
+
+            // Update session if its close to expiring.
+            if ( time() > $this->_session_expiring ) {
+                $this->set_session_expiration();
+                $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
+            }
+        } else {
+            $this->set_session_expiration();
+            $this->_customer_id = $this->generate_customer_id();
+            $this->_data        = $this->get_session_data();
+        }
+    }
+
+    /**
+     * Sets the session cookie on-demand (usually after adding an item to the cart).
+     *
+     * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set.
+     *
+     * Warning: Cookies will only be set if this is called before the headers are sent.
+     *
+     * @param bool $set Should the session cookie be set.
+     */
+    public function set_customer_session_cookie( $set ) {
+        if ( $set ) {
+            $to_hash           = $this->_customer_id . '|' . $this->_session_expiration;
+            $cookie_hash       = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+            $cookie_value      = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
+            $this->_has_cookie = true;
+
+            if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) {
+                $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true );
+            }
+        }
+    }
+
+    public function setcookie( $name, $value, $expire = 0, $secure = false, $httponly = false ) {
         if ( ! headers_sent() ) {
             setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) );
         } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
@@ -141,86 +141,86 @@ 
         }
     }
 
-	/**
-	 * Should the session cookie be secure?
-	 *
-	 * @since 3.6.0
-	 * @return bool
-	 */
-	protected function use_secure_cookie() {
+    /**
+     * Should the session cookie be secure?
+     *
+     * @since 3.6.0
+     * @return bool
+     */
+    protected function use_secure_cookie() {
         $is_https = false !== strstr( get_option( 'home' ), 'https:' );
-		return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() );
-	}
-
-	/**
-	 * Return true if the current user has an active session, i.e. a cookie to retrieve values.
-	 *
-	 * @return bool
-	 */
-	public function has_session() {
-		return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
-	}
-
-	/**
-	 * Set session expiration.
-	 */
-	public function set_session_expiration() {
-		$this->_session_expiring   = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
-		$this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
-	}
-
-	/**
-	 * Generates session ids.
-	 *
-	 * @return string
-	 */
-	public function generate_customer_id() {
-		require_once ABSPATH . 'wp-includes/class-phpass.php';
-		$hasher      = new PasswordHash( 8, false );
-		return md5( $hasher->get_random_bytes( 32 ) );
-	}
-
-	/**
-	 * Get the session cookie, if set. Otherwise return false.
-	 *
-	 * Session cookies without a customer ID are invalid.
-	 *
-	 * @return bool|array
-	 */
-	public function get_session_cookie() {
-		$cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
-
-		if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
-			return false;
-		}
-
-		list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
-
-		if ( empty( $customer_id ) ) {
-			return false;
-		}
-
-		// Validate hash.
-		$to_hash = $customer_id . '|' . $session_expiration;
-		$hash    = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
-
-		if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
-			return false;
-		}
-
-		return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash );
-	}
-
-	/**
-	 * Get session data.
-	 *
-	 * @return array
-	 */
-	public function get_session_data() {
-		return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array();
-	}
-
-	public function generate_key( $customer_id ) {
+        return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() );
+    }
+
+    /**
+     * Return true if the current user has an active session, i.e. a cookie to retrieve values.
+     *
+     * @return bool
+     */
+    public function has_session() {
+        return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
+    }
+
+    /**
+     * Set session expiration.
+     */
+    public function set_session_expiration() {
+        $this->_session_expiring   = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
+        $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
+    }
+
+    /**
+     * Generates session ids.
+     *
+     * @return string
+     */
+    public function generate_customer_id() {
+        require_once ABSPATH . 'wp-includes/class-phpass.php';
+        $hasher      = new PasswordHash( 8, false );
+        return md5( $hasher->get_random_bytes( 32 ) );
+    }
+
+    /**
+     * Get the session cookie, if set. Otherwise return false.
+     *
+     * Session cookies without a customer ID are invalid.
+     *
+     * @return bool|array
+     */
+    public function get_session_cookie() {
+        $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
+
+        if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
+            return false;
+        }
+
+        list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
+
+        if ( empty( $customer_id ) ) {
+            return false;
+        }
+
+        // Validate hash.
+        $to_hash = $customer_id . '|' . $session_expiration;
+        $hash    = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+
+        if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
+            return false;
+        }
+
+        return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash );
+    }
+
+    /**
+     * Get session data.
+     *
+     * @return array
+     */
+    public function get_session_data() {
+        return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array();
+    }
+
+    public function generate_key( $customer_id ) {
         if ( ! $customer_id ) {
             return;
         }
@@ -228,68 +228,68 @@ 
         return 'wpi_trans_' . $customer_id;
     }
 
-	/**
-	 * Save data.
-	 */
-	public function save_data() {
-		// Dirty if something changed - prevents saving nothing new.
-		if ( $this->_dirty && $this->has_session() ) {
+    /**
+     * Save data.
+     */
+    public function save_data() {
+        // Dirty if something changed - prevents saving nothing new.
+        if ( $this->_dirty && $this->has_session() ) {
 
             set_transient( $this->generate_key( $this->_customer_id ), $this->_data, $this->_session_expiration );
 
-			$this->_dirty = false;
-		}
-	}
-
-	/**
-	 * Destroy all session data.
-	 */
-	public function destroy_session() {
-		$this->delete_session( $this->_customer_id );
-		$this->forget_session();
-	}
-
-	/**
-	 * Forget all session data without destroying it.
-	 */
-	public function forget_session() {
-		$this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true );
-
-		wpinv_empty_cart();
-
-		$this->_data        = array();
-		$this->_dirty       = false;
-		$this->_customer_id = $this->generate_customer_id();
-	}
-
-	/**
-	 * When a user is logged out, ensure they have a unique nonce by using the customer/session ID.
-	 *
-	 * @param int $uid User ID.
-	 * @return string
-	 */
-	public function nonce_user_logged_out( $uid ) {
-
-		// Check if one of our nonces.
-		if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) {
-			return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
-		}
-
-		return $uid;
-	}
-
-	/**
-	 * Returns the session.
-	 *
-	 * @param string $customer_id Customer ID.
-	 * @param mixed  $default Default session value.
-	 * @return string|array
-	 */
-	public function get_session( $customer_id, $default = false ) {
-
-		if ( defined( 'WP_SETUP_CONFIG' ) ) {
-			return array();
-		}
+            $this->_dirty = false;
+        }
+    }
+
+    /**
+     * Destroy all session data.
+     */
+    public function destroy_session() {
+        $this->delete_session( $this->_customer_id );
+        $this->forget_session();
+    }
+
+    /**
+     * Forget all session data without destroying it.
+     */
+    public function forget_session() {
+        $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true );
+
+        wpinv_empty_cart();
+
+        $this->_data        = array();
+        $this->_dirty       = false;
+        $this->_customer_id = $this->generate_customer_id();
+    }
+
+    /**
+     * When a user is logged out, ensure they have a unique nonce by using the customer/session ID.
+     *
+     * @param int $uid User ID.
+     * @return string
+     */
+    public function nonce_user_logged_out( $uid ) {
+
+        // Check if one of our nonces.
+        if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) {
+            return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
+        }
+
+        return $uid;
+    }
+
+    /**
+     * Returns the session.
+     *
+     * @param string $customer_id Customer ID.
+     * @param mixed  $default Default session value.
+     * @return string|array
+     */
+    public function get_session( $customer_id, $default = false ) {
+
+        if ( defined( 'WP_SETUP_CONFIG' ) ) {
+            return array();
+        }
 
         $key = $this->generate_key( $customer_id );
         $value = get_transient( $key );
@@ -298,30 +298,30 @@ 
             $value = $default;
         }
 
-		return maybe_unserialize( $value );
-	}
+        return maybe_unserialize( $value );
+    }
 
-	/**
-	 * Delete the session from the cache and database.
-	 *
-	 * @param int $customer_id Customer ID.
-	 */
-	public function delete_session( $customer_id ) {
+    /**
+     * Delete the session from the cache and database.
+     *
+     * @param int $customer_id Customer ID.
+     */
+    public function delete_session( $customer_id ) {
 
         $key = $this->generate_key( $customer_id );
 
-		delete_transient( $key );
-	}
+        delete_transient( $key );
+    }
 
-	/**
-	 * Update the session expiry timestamp.
-	 *
-	 * @param string $customer_id Customer ID.
-	 * @param int    $timestamp Timestamp to expire the cookie.
-	 */
-	public function update_session_timestamp( $customer_id, $timestamp ) {
+    /**
+     * Update the session expiry timestamp.
+     *
+     * @param string $customer_id Customer ID.
+     * @param int    $timestamp Timestamp to expire the cookie.
+     */
+    public function update_session_timestamp( $customer_id, $timestamp ) {
 
         set_transient( $this->generate_key( $customer_id ), maybe_serialize( $this->_data ), $timestamp );
 
-	}
+    }
 }

includes/admin/class-getpaid-metaboxes.php

Indentation +243 added lines, -243 removed lines

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

vendor/ayecode/wp-ayecode-ui/includes/components/class-aui-component-alert.php

Indentation +83 added lines, -83 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,87 +11,87 @@ 
  */
 class AUI_Component_Alert {
 
-	/**
-	 * Build the component.
-	 * 
-	 * @param array $args
-	 *
-	 * @return string The rendered component.
-	 */
-	public static function get($args = array()){
-		global $aui_bs5;
-		$defaults = array(
-			'type'       => 'info',
-			'class'      => '',
-			'icon' => '',
-			'heading'    => '',
-			'content'    => '',
-			'footer'     => '',
-			'dismissible'=> false,
-			'data'       => '',
-		);
-
-		/**
-		 * Parse incoming $args into an array and merge it with $defaults
-		 */
-		$args   = wp_parse_args( $args, $defaults );
-		$output = '';
-		if ( ! empty( $args['content'] ) ) {
-			$type = sanitize_html_class( $args['type'] );
-			if($type=='error'){$type='danger';}
-			$icon = !empty($args['icon']) ? "<i class='".esc_attr($args['icon'])."'></i>" : '';
-
-			// set default icon
-			if(!$icon && $args['icon']!==false && $type){
-				if($type=='danger'){$icon = '<i class="fas fa-exclamation-circle"></i>';}
-				elseif($type=='warning'){$icon = '<i class="fas fa-exclamation-triangle"></i>';}
-				elseif($type=='success'){$icon = '<i class="fas fa-check-circle"></i>';}
-				elseif($type=='info'){$icon = '<i class="fas fa-info-circle"></i>';}
-			}
-
-			$data = '';
-			$class = !empty($args['class']) ? esc_attr($args['class']) : '';
-			if($args['dismissible']){$class .= " alert-dismissible fade show";}
-
-			// open
-			$output .= '<div class="alert alert-' . $type . ' '.$class.'" role="alert" '.$data.'>';
-
-			// heading
-			if ( ! empty( $args['heading'] ) ) {
-				$output .= '<h4 class="alert-heading">' . $args['heading'] . '</h4>';
-			}
-
-			// icon
-			if ( ! empty( $icon) ) {
-				$output .= $icon." ";
-			}
-
-			// content
-			$output .= $args['content'];
-
-			// dismissible
-			if($args['dismissible']){
-
-				if ( $aui_bs5 ) {
-					$output .= '<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>';
-				}else{
-					$output .= '<button type="button" class="close" data-dismiss="alert" aria-label="Close">';
-					$output .= '<span aria-hidden="true">&times;</span>';
-					$output .= '</button>';
-				}
-			}
-
-			// footer
-			if ( ! empty( $args['footer'] ) ) {
-				$output .= '<hr>';
-				$output .= '<p class="mb-0">' . $args['footer'] . '</p>';
-			}
-
-			// close
-			$output .= '</div>';
-		}
-
-		return $output;
-	}
+    /**
+     * Build the component.
+     * 
+     * @param array $args
+     *
+     * @return string The rendered component.
+     */
+    public static function get($args = array()){
+        global $aui_bs5;
+        $defaults = array(
+            'type'       => 'info',
+            'class'      => '',
+            'icon' => '',
+            'heading'    => '',
+            'content'    => '',
+            'footer'     => '',
+            'dismissible'=> false,
+            'data'       => '',
+        );
+
+        /**
+         * Parse incoming $args into an array and merge it with $defaults
+         */
+        $args   = wp_parse_args( $args, $defaults );
+        $output = '';
+        if ( ! empty( $args['content'] ) ) {
+            $type = sanitize_html_class( $args['type'] );
+            if($type=='error'){$type='danger';}
+            $icon = !empty($args['icon']) ? "<i class='".esc_attr($args['icon'])."'></i>" : '';
+
+            // set default icon
+            if(!$icon && $args['icon']!==false && $type){
+                if($type=='danger'){$icon = '<i class="fas fa-exclamation-circle"></i>';}
+                elseif($type=='warning'){$icon = '<i class="fas fa-exclamation-triangle"></i>';}
+                elseif($type=='success'){$icon = '<i class="fas fa-check-circle"></i>';}
+                elseif($type=='info'){$icon = '<i class="fas fa-info-circle"></i>';}
+            }
+
+            $data = '';
+            $class = !empty($args['class']) ? esc_attr($args['class']) : '';
+            if($args['dismissible']){$class .= " alert-dismissible fade show";}
+
+            // open
+            $output .= '<div class="alert alert-' . $type . ' '.$class.'" role="alert" '.$data.'>';
+
+            // heading
+            if ( ! empty( $args['heading'] ) ) {
+                $output .= '<h4 class="alert-heading">' . $args['heading'] . '</h4>';
+            }
+
+            // icon
+            if ( ! empty( $icon) ) {
+                $output .= $icon." ";
+            }
+
+            // content
+            $output .= $args['content'];
+
+            // dismissible
+            if($args['dismissible']){
+
+                if ( $aui_bs5 ) {
+                    $output .= '<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>';
+                }else{
+                    $output .= '<button type="button" class="close" data-dismiss="alert" aria-label="Close">';
+                    $output .= '<span aria-hidden="true">&times;</span>';
+                    $output .= '</button>';
+                }
+            }
+
+            // footer
+            if ( ! empty( $args['footer'] ) ) {
+                $output .= '<hr>';
+                $output .= '<p class="mb-0">' . $args['footer'] . '</p>';
+            }
+
+            // close
+            $output .= '</div>';
+        }
+
+        return $output;
+    }
 
 }
\ No newline at end of file

vendor/ayecode/wp-ayecode-ui/includes/components/class-aui-component-helper.php

Indentation +467 added lines, -467 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,470 +11,470 @@ 
  */
 class AUI_Component_Helper {
 
-	/**
-	 * A component helper for generating a input name.
-	 *
-	 * @param $text
-	 * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
-	 *
-	 * @return string
-	 */
-	public static function name( $text, $multiple = false ) {
-		$output = '';
-
-		if ( $text ) {
-			$is_multiple = strpos( $text, '[' ) === false && $multiple ? '[]' : '';
-			$output      = ' name="' . esc_attr( $text ) . $is_multiple . '" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item id.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function id( $text ) {
-		$output = '';
-
-		if ( $text ) {
-			$output = ' id="' . sanitize_html_class( $text ) . '" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item title.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function title( $text ) {
-		$output = '';
-
-		if ( $text ) {
-			$output = ' title="' . esc_attr( $text ) . '" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item value.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function value( $text ) {
-		$output = '';
-
-		if ( $text !== null && $text !== false ) {
-			$output = ' value="' . esc_attr( wp_unslash( $text ) ) . '" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item class attribute.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function class_attr( $text ) {
-		$output = '';
-
-		if ( $text ) {
-			$classes = self::esc_classes( $text );
-			if ( ! empty( $classes ) ) {
-				$output = ' class="' . $classes . '" ';
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Escape a string of classes.
-	 *
-	 * @param $text
-	 *
-	 * @return string
-	 */
-	public static function esc_classes( $text ) {
-		$output = '';
-
-		if ( $text ) {
-			$classes = explode( " ", $text );
-			$classes = array_map( "trim", $classes );
-			$classes = array_map( "sanitize_html_class", $classes );
-			if ( ! empty( $classes ) ) {
-				$output = implode( " ", $classes );
-			}
-		}
-
-		return $output;
-
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function data_attributes( $args ) {
-		$output = '';
-
-		if ( ! empty( $args ) ) {
-
-			foreach ( $args as $key => $val ) {
-				if ( substr( $key, 0, 5 ) === "data-" ) {
-					$output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function aria_attributes( $args ) {
-		$output = '';
-
-		if ( ! empty( $args ) ) {
-
-			foreach ( $args as $key => $val ) {
-				if ( substr( $key, 0, 5 ) === "aria-" ) {
-					$output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Build a font awesome icon from a class.
-	 *
-	 * @param $class
-	 * @param bool $space_after
-	 * @param array $extra_attributes An array of extra attributes.
-	 *
-	 * @return string
-	 */
-	public static function icon( $class, $space_after = false, $extra_attributes = array() ) {
-		$output = '';
-
-		if ( $class ) {
-			$classes = self::esc_classes( $class );
-			if ( ! empty( $classes ) ) {
-				$output = '<i class="' . $classes . '" ';
-				// extra attributes
-				if ( ! empty( $extra_attributes ) ) {
-					$output .= AUI_Component_Helper::extra_attributes( $extra_attributes );
-				}
-				$output .= '></i>';
-				if ( $space_after ) {
-					$output .= " ";
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function extra_attributes( $args ) {
-		$output = '';
-
-		if ( ! empty( $args ) ) {
-
-			if ( is_array( $args ) ) {
-				foreach ( $args as $key => $val ) {
-					$output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
-				}
-			} else {
-				$output .= ' ' . $args . ' ';
-			}
-
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function help_text( $text ) {
-		$output = '';
-
-		if ( $text ) {
-			$output .= '<small class="form-text text-muted d-block">' . wp_kses_post( $text ) . '</small>';
-		}
-
-
-		return $output;
-	}
-
-	/**
-	 * Replace element require context with JS.
-	 *
-	 * @param $input
-	 *
-	 * @return string|void
-	 */
-	public static function element_require( $input ) {
-
-		$input = str_replace( "'", '"', $input );// we only want double quotes
-
-		$output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
-			"jQuery(form).find('[data-argument=\"",
-			"\"]').find('input,select,textarea').val()",
-			"\"]').find('input:checked').val()",
-		), $input ) );
-
-		if ( $output ) {
-			$output = ' data-element-require="' . $output . '" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Navigates through an array, object, or scalar, and removes slashes from the values.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param mixed $value The value to be stripped.
-	 * @param array $input Input Field.
-	 *
-	 * @return mixed Stripped value.
-	 */
-	public static function sanitize_html_field( $value, $input = array() ) {
-		$original = $value;
-
-		if ( is_array( $value ) ) {
-			foreach ( $value as $index => $item ) {
-				$value[ $index ] = self::_sanitize_html_field( $value, $input );
-			}
-		} elseif ( is_object( $value ) ) {
-			$object_vars = get_object_vars( $value );
-
-			foreach ( $object_vars as $property_name => $property_value ) {
-				$value->$property_name = self::_sanitize_html_field( $property_value, $input );
-			}
-		} else {
-			$value = self::_sanitize_html_field( $value, $input );
-		}
-
-		/**
-		 * Filters content and keeps only allowable HTML elements.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param string|array $value Content to filter through kses.
-		 * @param string|array $value Original content without filter.
-		 * @param array $input Input Field.
-		 */
-		return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
-	}
-
-	/**
-	 * Filters content and keeps only allowable HTML elements.
-	 *
-	 * This function makes sure that only the allowed HTML element names, attribute
-	 * names and attribute values plus only sane HTML entities will occur in
-	 * $string. You have to remove any slashes from PHP's magic quotes before you
-	 * call this function.
-	 *
-	 * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
-	 * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
-	 * covers all common link protocols, except for 'javascript' which should not
-	 * be allowed for untrusted users.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $value Content to filter through kses.
-	 * @param array $input Input Field.
-	 *
-	 * @return string Filtered content with only allowed HTML elements.
-	 */
-	public static function _sanitize_html_field( $value, $input = array() ) {
-		if ( $value === '' ) {
-			return $value;
-		}
-
-		$allowed_html = self::kses_allowed_html( 'post', $input );
-
-		if ( ! is_array( $allowed_html ) ) {
-			$allowed_html = wp_kses_allowed_html( 'post' );
-		}
-
-		$filtered = trim( wp_unslash( $value ) );
-		$filtered = wp_kses( $filtered, $allowed_html );
-		$filtered = balanceTags( $filtered ); // Balances tags
-
-		return $filtered;
-	}
-
-	/**
-	 * Returns an array of allowed HTML tags and attributes for a given context.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
-	 *                              'strip', 'data', 'entities', or the name of a field filter such as
-	 *                              'pre_user_description'.
-	 * @param array $input Input.
-	 *
-	 * @return array Array of allowed HTML tags and their allowed attributes.
-	 */
-	public static function kses_allowed_html( $context = 'post', $input = array() ) {
-		$allowed_html = wp_kses_allowed_html( $context );
-
-		if ( is_array( $allowed_html ) ) {
-			// <iframe>
-			if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
-				$allowed_html['iframe'] = array(
-					'class'           => true,
-					'id'              => true,
-					'src'             => true,
-					'width'           => true,
-					'height'          => true,
-					'frameborder'     => true,
-					'marginwidth'     => true,
-					'marginheight'    => true,
-					'scrolling'       => true,
-					'style'           => true,
-					'title'           => true,
-					'allow'           => true,
-					'allowfullscreen' => true,
-					'data-*'          => true,
-				);
-			}
-		}
-
-		/**
-		 * Filters the allowed html tags.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param array[]|string $allowed_html Allowed html tags.
-		 * @param @param string|array $context The context for which to retrieve tags.
-		 * @param array $input Input field.
-		 */
-		return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
-	}
-
-	public static function get_column_class( $label_number = 2, $type = 'label' ) {
-
-		$class = '';
-
-		// set default if empty
-		if( $label_number === '' ){
-			$label_number = 2;
-		}
-
-		if ( $label_number && $label_number < 12 && $label_number > 0 ) {
-			if ( $type == 'label' ) {
-				$class = 'col-sm-' . absint( $label_number );
-			} elseif ( $type == 'input' ) {
-				$class = 'col-sm-' . ( 12 - absint( $label_number ) );
-			}
-		}
-
-		return $class;
-	}
-
-	/**
-	 * Sanitizes a multiline string from user input or from the database.
-	 *
-	 * Emulate the WP native sanitize_textarea_field function in a %%variable%% safe way.
-	 *
-	 * @see   https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php for the original
-	 *
-	 * @since 0.1.66
-	 *
-	 * @param string $str String to sanitize.
-	 * @return string Sanitized string.
-	 */
-	public static function sanitize_textarea_field( $str ) {
-		$filtered = self::_sanitize_text_fields( $str, true );
-
-		/**
-		 * Filters a sanitized textarea field string.
-		 *
-		 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php
-		 *
-		 * @param string $filtered The sanitized string.
-		 * @param string $str      The string prior to being sanitized.
-		 */
-		return apply_filters( 'sanitize_textarea_field', $filtered, $str );
-	}
-
-	/**
-	 * Internal helper function to sanitize a string from user input or from the db.
-	 *
-	 * @since 0.1.66
-	 * @access private
-	 *
-	 * @param string $str           String to sanitize.
-	 * @param bool   $keep_newlines Optional. Whether to keep newlines. Default: false.
-	 * @return string Sanitized string.
-	 */
-	public static function _sanitize_text_fields( $str, $keep_newlines = false ) {
-		if ( is_object( $str ) || is_array( $str ) ) {
-			return '';
-		}
-
-		$str = (string) $str;
-
-		$filtered = wp_check_invalid_utf8( $str );
-
-		if ( strpos( $filtered, '<' ) !== false ) {
-			$filtered = wp_pre_kses_less_than( $filtered );
-			// This will strip extra whitespace for us.
-			$filtered = wp_strip_all_tags( $filtered, false );
-
-			// Use HTML entities in a special case to make sure no later
-			// newline stripping stage could lead to a functional tag.
-			$filtered = str_replace( "<\n", "&lt;\n", $filtered );
-		}
-
-		if ( ! $keep_newlines ) {
-			$filtered = preg_replace( '/[\r\n\t ]+/', ' ', $filtered );
-		}
-		$filtered = trim( $filtered );
-
-		$found = false;
-		while ( preg_match( '`[^%](%[a-f0-9]{2})`i', $filtered, $match ) ) {
-			$filtered = str_replace( $match[1], '', $filtered );
-			$found = true;
-		}
-		unset( $match );
-
-		if ( $found ) {
-			// Strip out the whitespace that may now exist after removing the octets.
-			$filtered = trim( preg_replace( '` +`', ' ', $filtered ) );
-		}
-
-		return $filtered;
-	}
+    /**
+     * A component helper for generating a input name.
+     *
+     * @param $text
+     * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
+     *
+     * @return string
+     */
+    public static function name( $text, $multiple = false ) {
+        $output = '';
+
+        if ( $text ) {
+            $is_multiple = strpos( $text, '[' ) === false && $multiple ? '[]' : '';
+            $output      = ' name="' . esc_attr( $text ) . $is_multiple . '" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item id.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function id( $text ) {
+        $output = '';
+
+        if ( $text ) {
+            $output = ' id="' . sanitize_html_class( $text ) . '" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item title.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function title( $text ) {
+        $output = '';
+
+        if ( $text ) {
+            $output = ' title="' . esc_attr( $text ) . '" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item value.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function value( $text ) {
+        $output = '';
+
+        if ( $text !== null && $text !== false ) {
+            $output = ' value="' . esc_attr( wp_unslash( $text ) ) . '" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item class attribute.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function class_attr( $text ) {
+        $output = '';
+
+        if ( $text ) {
+            $classes = self::esc_classes( $text );
+            if ( ! empty( $classes ) ) {
+                $output = ' class="' . $classes . '" ';
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Escape a string of classes.
+     *
+     * @param $text
+     *
+     * @return string
+     */
+    public static function esc_classes( $text ) {
+        $output = '';
+
+        if ( $text ) {
+            $classes = explode( " ", $text );
+            $classes = array_map( "trim", $classes );
+            $classes = array_map( "sanitize_html_class", $classes );
+            if ( ! empty( $classes ) ) {
+                $output = implode( " ", $classes );
+            }
+        }
+
+        return $output;
+
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function data_attributes( $args ) {
+        $output = '';
+
+        if ( ! empty( $args ) ) {
+
+            foreach ( $args as $key => $val ) {
+                if ( substr( $key, 0, 5 ) === "data-" ) {
+                    $output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function aria_attributes( $args ) {
+        $output = '';
+
+        if ( ! empty( $args ) ) {
+
+            foreach ( $args as $key => $val ) {
+                if ( substr( $key, 0, 5 ) === "aria-" ) {
+                    $output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Build a font awesome icon from a class.
+     *
+     * @param $class
+     * @param bool $space_after
+     * @param array $extra_attributes An array of extra attributes.
+     *
+     * @return string
+     */
+    public static function icon( $class, $space_after = false, $extra_attributes = array() ) {
+        $output = '';
+
+        if ( $class ) {
+            $classes = self::esc_classes( $class );
+            if ( ! empty( $classes ) ) {
+                $output = '<i class="' . $classes . '" ';
+                // extra attributes
+                if ( ! empty( $extra_attributes ) ) {
+                    $output .= AUI_Component_Helper::extra_attributes( $extra_attributes );
+                }
+                $output .= '></i>';
+                if ( $space_after ) {
+                    $output .= " ";
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function extra_attributes( $args ) {
+        $output = '';
+
+        if ( ! empty( $args ) ) {
+
+            if ( is_array( $args ) ) {
+                foreach ( $args as $key => $val ) {
+                    $output .= ' ' . sanitize_html_class( $key ) . '="' . esc_attr( $val ) . '" ';
+                }
+            } else {
+                $output .= ' ' . $args . ' ';
+            }
+
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function help_text( $text ) {
+        $output = '';
+
+        if ( $text ) {
+            $output .= '<small class="form-text text-muted d-block">' . wp_kses_post( $text ) . '</small>';
+        }
+
+
+        return $output;
+    }
+
+    /**
+     * Replace element require context with JS.
+     *
+     * @param $input
+     *
+     * @return string|void
+     */
+    public static function element_require( $input ) {
+
+        $input = str_replace( "'", '"', $input );// we only want double quotes
+
+        $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
+            "jQuery(form).find('[data-argument=\"",
+            "\"]').find('input,select,textarea').val()",
+            "\"]').find('input:checked').val()",
+        ), $input ) );
+
+        if ( $output ) {
+            $output = ' data-element-require="' . $output . '" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * Navigates through an array, object, or scalar, and removes slashes from the values.
+     *
+     * @since 0.1.41
+     *
+     * @param mixed $value The value to be stripped.
+     * @param array $input Input Field.
+     *
+     * @return mixed Stripped value.
+     */
+    public static function sanitize_html_field( $value, $input = array() ) {
+        $original = $value;
+
+        if ( is_array( $value ) ) {
+            foreach ( $value as $index => $item ) {
+                $value[ $index ] = self::_sanitize_html_field( $value, $input );
+            }
+        } elseif ( is_object( $value ) ) {
+            $object_vars = get_object_vars( $value );
+
+            foreach ( $object_vars as $property_name => $property_value ) {
+                $value->$property_name = self::_sanitize_html_field( $property_value, $input );
+            }
+        } else {
+            $value = self::_sanitize_html_field( $value, $input );
+        }
+
+        /**
+         * Filters content and keeps only allowable HTML elements.
+         *
+         * @since 0.1.41
+         *
+         * @param string|array $value Content to filter through kses.
+         * @param string|array $value Original content without filter.
+         * @param array $input Input Field.
+         */
+        return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
+    }
+
+    /**
+     * Filters content and keeps only allowable HTML elements.
+     *
+     * This function makes sure that only the allowed HTML element names, attribute
+     * names and attribute values plus only sane HTML entities will occur in
+     * $string. You have to remove any slashes from PHP's magic quotes before you
+     * call this function.
+     *
+     * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
+     * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
+     * covers all common link protocols, except for 'javascript' which should not
+     * be allowed for untrusted users.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $value Content to filter through kses.
+     * @param array $input Input Field.
+     *
+     * @return string Filtered content with only allowed HTML elements.
+     */
+    public static function _sanitize_html_field( $value, $input = array() ) {
+        if ( $value === '' ) {
+            return $value;
+        }
+
+        $allowed_html = self::kses_allowed_html( 'post', $input );
+
+        if ( ! is_array( $allowed_html ) ) {
+            $allowed_html = wp_kses_allowed_html( 'post' );
+        }
+
+        $filtered = trim( wp_unslash( $value ) );
+        $filtered = wp_kses( $filtered, $allowed_html );
+        $filtered = balanceTags( $filtered ); // Balances tags
+
+        return $filtered;
+    }
+
+    /**
+     * Returns an array of allowed HTML tags and attributes for a given context.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
+     *                              'strip', 'data', 'entities', or the name of a field filter such as
+     *                              'pre_user_description'.
+     * @param array $input Input.
+     *
+     * @return array Array of allowed HTML tags and their allowed attributes.
+     */
+    public static function kses_allowed_html( $context = 'post', $input = array() ) {
+        $allowed_html = wp_kses_allowed_html( $context );
+
+        if ( is_array( $allowed_html ) ) {
+            // <iframe>
+            if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
+                $allowed_html['iframe'] = array(
+                    'class'           => true,
+                    'id'              => true,
+                    'src'             => true,
+                    'width'           => true,
+                    'height'          => true,
+                    'frameborder'     => true,
+                    'marginwidth'     => true,
+                    'marginheight'    => true,
+                    'scrolling'       => true,
+                    'style'           => true,
+                    'title'           => true,
+                    'allow'           => true,
+                    'allowfullscreen' => true,
+                    'data-*'          => true,
+                );
+            }
+        }
+
+        /**
+         * Filters the allowed html tags.
+         *
+         * @since 0.1.41
+         *
+         * @param array[]|string $allowed_html Allowed html tags.
+         * @param @param string|array $context The context for which to retrieve tags.
+         * @param array $input Input field.
+         */
+        return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
+    }
+
+    public static function get_column_class( $label_number = 2, $type = 'label' ) {
+
+        $class = '';
+
+        // set default if empty
+        if( $label_number === '' ){
+            $label_number = 2;
+        }
+
+        if ( $label_number && $label_number < 12 && $label_number > 0 ) {
+            if ( $type == 'label' ) {
+                $class = 'col-sm-' . absint( $label_number );
+            } elseif ( $type == 'input' ) {
+                $class = 'col-sm-' . ( 12 - absint( $label_number ) );
+            }
+        }
+
+        return $class;
+    }
+
+    /**
+     * Sanitizes a multiline string from user input or from the database.
+     *
+     * Emulate the WP native sanitize_textarea_field function in a %%variable%% safe way.
+     *
+     * @see   https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php for the original
+     *
+     * @since 0.1.66
+     *
+     * @param string $str String to sanitize.
+     * @return string Sanitized string.
+     */
+    public static function sanitize_textarea_field( $str ) {
+        $filtered = self::_sanitize_text_fields( $str, true );
+
+        /**
+         * Filters a sanitized textarea field string.
+         *
+         * @see https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php
+         *
+         * @param string $filtered The sanitized string.
+         * @param string $str      The string prior to being sanitized.
+         */
+        return apply_filters( 'sanitize_textarea_field', $filtered, $str );
+    }
+
+    /**
+     * Internal helper function to sanitize a string from user input or from the db.
+     *
+     * @since 0.1.66
+     * @access private
+     *
+     * @param string $str           String to sanitize.
+     * @param bool   $keep_newlines Optional. Whether to keep newlines. Default: false.
+     * @return string Sanitized string.
+     */
+    public static function _sanitize_text_fields( $str, $keep_newlines = false ) {
+        if ( is_object( $str ) || is_array( $str ) ) {
+            return '';
+        }
+
+        $str = (string) $str;
+
+        $filtered = wp_check_invalid_utf8( $str );
+
+        if ( strpos( $filtered, '<' ) !== false ) {
+            $filtered = wp_pre_kses_less_than( $filtered );
+            // This will strip extra whitespace for us.
+            $filtered = wp_strip_all_tags( $filtered, false );
+
+            // Use HTML entities in a special case to make sure no later
+            // newline stripping stage could lead to a functional tag.
+            $filtered = str_replace( "<\n", "&lt;\n", $filtered );
+        }
+
+        if ( ! $keep_newlines ) {
+            $filtered = preg_replace( '/[\r\n\t ]+/', ' ', $filtered );
+        }
+        $filtered = trim( $filtered );
+
+        $found = false;
+        while ( preg_match( '`[^%](%[a-f0-9]{2})`i', $filtered, $match ) ) {
+            $filtered = str_replace( $match[1], '', $filtered );
+            $found = true;
+        }
+        unset( $match );
+
+        if ( $found ) {
+            // Strip out the whitespace that may now exist after removing the octets.
+            $filtered = trim( preg_replace( '` +`', ' ', $filtered ) );
+        }
+
+        return $filtered;
+    }
 }
\ No newline at end of file

vendor/ayecode/wp-ayecode-ui/includes/inc/bs4-js.php

Indentation +2 added lines, -2 removed lines

@@ -993,8 +993,8 @@
     aui_flip_color_scheme_on_scroll();
 
 	<?php
-	// FSE tweaks.
-	if(!empty($_REQUEST['postType']) && $_REQUEST['postType']=='wp_template'){ ?>
+    // FSE tweaks.
+    if(!empty($_REQUEST['postType']) && $_REQUEST['postType']=='wp_template'){ ?>
     function aui_fse_set_data_scroll() {
         console.log('init scroll');
         let Iframe = document.getElementsByClassName("edit-site-visual-editor__editor-canvas");

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 ( is_a( $invoice, 'WPInv_Invoice' ) && ! $invoice->needs_payment() ) {
-			return $invoice->get_mode() === 'test';
-		}
+        if ( is_a( $invoice, 'WPInv_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 );
 
-	}
+    }
 
 }

templates/payment-forms/form.php

Indentation +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
 
         // And the optional invoice id.
         if ( ! empty( $form->invoice ) ) {
-		    getpaid_hidden_field( 'invoice_id', $form->invoice->get_id() );
+            getpaid_hidden_field( 'invoice_id', $form->invoice->get_id() );
         }
 
         // We also want to include the form id.
@@ -76,7 +76,7 @@ 
                 <?php
 
                     foreach ( $form->get_elements() as $element ) {
-					    if ( isset( $element['type'] ) ) {
+                        if ( isset( $element['type'] ) ) {
                             $grid_class = getpaid_get_form_element_grid_class( $element );
                             do_action( 'getpaid_payment_form_element_before', $element, $form );
                             do_action( "getpaid_payment_form_element_before_{$element['type']}_template", $element, $form );