AyeCode / invoicing

includes/class-getpaid-subscriptions-query.php

Indentation +478 added lines, -478 removed lines

@@ -16,483 +16,483 @@
  */
 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 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[]        $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'] );
-
-			$this->query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field                = 'id' === strtolower( $field ) ? 'id' : sanitize_key( $field );
-				$this->query_fields[] = "$table.`$field`";
-			}
-			$this->query_fields = implode( ',', $this->query_fields );
-		} elseif ( 'all' === $qv['fields'] ) {
-			$this->query_fields = "$table.*";
-		} else {
-			$this->query_fields = "$table.id";
-		}
-
-		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['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'] ) ) {
-			$ordersby = 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->results[ $key ] = new WPInv_Subscription( $subscription );
-			}
-		}
-
-	}
-
-	/**
-	 * 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';
-		}
-	}
+    /**
+     * 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 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[]        $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'] );
+
+            $this->query_fields = array();
+            foreach ( $qv['fields'] as $field ) {
+                $field                = 'id' === strtolower( $field ) ? 'id' : sanitize_key( $field );
+                $this->query_fields[] = "$table.`$field`";
+            }
+            $this->query_fields = implode( ',', $this->query_fields );
+        } elseif ( 'all' === $qv['fields'] ) {
+            $this->query_fields = "$table.*";
+        } else {
+            $this->query_fields = "$table.id";
+        }
+
+        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['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'] ) ) {
+            $ordersby = 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->results[ $key ] = new WPInv_Subscription( $subscription );
+            }
+        }
+
+    }
+
+    /**
+     * 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';
+        }
+    }
 
 }

Spacing +89 added lines, -89 removed lines

@@ -97,9 +97,9 @@ 
 	 *
 	 * @param null|string|array $query Optional. The query variables.
 	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
+	public function __construct($query = null) {
+		if (!is_null($query)) {
+			$this->prepare_query($query);
 			$this->query();
 		}
 	}
@@ -112,7 +112,7 @@ 
 	 * @param 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 ) {
+	public static function fill_query_vars($args) {
 		$defaults = array(
 			'status'            => 'all',
 			'customer_in'       => array(),
@@ -130,7 +130,7 @@ 
 			'fields'            => 'all',
 		);
 
-		return wp_parse_args( $args, $defaults );
+		return wp_parse_args($args, $defaults);
 	}
 
 	/**
@@ -180,45 +180,45 @@ 
 	 *                                             Use 'all' for all fields. Default 'all'.
 	 * }
 	 */
-	public function prepare_query( $query = array() ) {
+	public function prepare_query($query = array()) {
 		global $wpdb;
 
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+		if (empty($this->query_vars) || !empty($query)) {
 			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
+			$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'] );
+		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 ) );
+		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 );
+		$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 );
+		$this->prepare_query_fields($qv, $table);
 
 		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
+		$this->prepare_query_where($qv, $table);
 
 		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
+		$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'] );
+		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'] );
+				$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 ) );
+		do_action_ref_array('getpaid_after_subscriptions_query', array(&$this));
 	}
 
 	/**
@@ -229,24 +229,24 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_fields( &$qv, $table ) {
+	protected function prepare_query_fields(&$qv, $table) {
 
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
+		if (is_array($qv['fields'])) {
+			$qv['fields'] = array_unique($qv['fields']);
 
 			$this->query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field                = 'id' === strtolower( $field ) ? 'id' : sanitize_key( $field );
+			foreach ($qv['fields'] as $field) {
+				$field                = 'id' === strtolower($field) ? 'id' : sanitize_key($field);
 				$this->query_fields[] = "$table.`$field`";
 			}
-			$this->query_fields = implode( ',', $this->query_fields );
-		} elseif ( 'all' === $qv['fields'] ) {
+			$this->query_fields = implode(',', $this->query_fields);
+		} elseif ('all' === $qv['fields']) {
 			$this->query_fields = "$table.*";
 		} else {
 			$this->query_fields = "$table.id";
 		}
 
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+		if (isset($qv['count_total']) && $qv['count_total']) {
 			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 		}
 
@@ -260,50 +260,50 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_where( &$qv, $table ) {
+	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 ('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'] ) );
+		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'] ) );
+		} 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'] ) );
+		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'] ) );
+		} 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['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+		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'] ) );
+		} 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" );
+		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" );
+		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();
 		}
 
@@ -317,24 +317,24 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_order( &$qv, $table ) {
+	protected function prepare_query_order(&$qv, $table) {
 
 		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
+		$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'] ) ) {
-			$ordersby = array( 'id' );
+		if (empty($qv['orderby'])) {
+			$ordersby = array('id');
 		}
 
 		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
+		$ordersby      = array_filter(wpinv_parse_list($qv['orderby']));
 
 		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
+		foreach ($ordersby as $_key => $_value) {
 
-			if ( is_int( $_key ) ) {
+			if (is_int($_key)) {
 				// Integer key means this is a flat array of 'orderby' fields.
 				$_orderby = $_value;
 				$_order   = $order;
@@ -344,20 +344,20 @@ 
 				$_order   = $_value;
 			}
 
-			$parsed = $this->parse_orderby( $_orderby, $table );
+			$parsed = $this->parse_orderby($_orderby, $table);
 
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+			if ($parsed) {
+				$orderby_array[] = $parsed . ' ' . $this->parse_order($_order);
 			}
 
 		}
 
 		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
+		if (empty($orderby_array)) {
 			$orderby_array[] = "id $order";
 		}
 
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+		$this->query_orderby = 'ORDER BY ' . implode(', ', $orderby_array);
 
 	}
 
@@ -371,30 +371,30 @@ 
 	public function query() {
 		global $wpdb;
 
-		$qv =& $this->query_vars;
+		$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 ) );
+		$this->results = apply_filters_ref_array('getpaid_subscriptions_pre_query', array(null, &$this));
 
-		if ( null === $this->results ) {
+		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 );
+			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 );
+				$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 (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->results[ $key ] = new WPInv_Subscription( $subscription );
+		if ('all' == $qv['fields']) {
+			foreach ($this->results as $key => $subscription) {
+				$this->results[$key] = new WPInv_Subscription($subscription);
 			}
 		}
 
@@ -408,9 +408,9 @@ 
 	 * @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 ];
+	public function get($query_var) {
+		if (isset($this->query_vars[$query_var])) {
+			return $this->query_vars[$query_var];
 		}
 
 		return null;
@@ -424,8 +424,8 @@ 
 	 * @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;
+	public function set($query_var, $value) {
+		$this->query_vars[$query_var] = $value;
 	}
 
 	/**
@@ -459,16 +459,16 @@ 
 	 *  @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 ) {
+	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' ) ) ) {
+		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 ) ) {
+		} 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 );
+		} 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 )";
 		}
 
@@ -483,12 +483,12 @@ 
 	 * @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 ) ) {
+	protected function parse_order($order) {
+		if (!is_string($order) || empty($order)) {
 			return 'DESC';
 		}
 
-		if ( 'ASC' === strtoupper( $order ) ) {
+		if ('ASC' === strtoupper($order)) {
 			return 'ASC';
 		} else {
 			return 'DESC';

includes/wpinv-helper-functions.php

Spacing +285 added lines, -285 removed lines

@@ -7,86 +7,86 @@ 
  */
 
 // MUST have WordPress.
-if ( !defined( 'WPINC' ) ) {
-    exit( 'Do NOT access this file directly: ' . basename( __FILE__ ) );
+if (!defined('WPINC')) {
+    exit('Do NOT access this file directly: ' . basename(__FILE__));
 }
 
 function wpinv_item_quantities_enabled() {
-    $ret = wpinv_get_option( 'item_quantities', true );
+    $ret = wpinv_get_option('item_quantities', true);
 
-    return (bool) apply_filters( 'wpinv_item_quantities_enabled', $ret );
+    return (bool) apply_filters('wpinv_item_quantities_enabled', $ret);
 }
 
 function wpinv_get_ip() {
     $ip = '127.0.0.1';
 
-    if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
-        $ip = sanitize_text_field( $_SERVER['HTTP_CLIENT_IP'] );
-    } elseif ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
-        $ip = sanitize_text_field( $_SERVER['HTTP_X_FORWARDED_FOR'] );
-    } elseif( !empty( $_SERVER['REMOTE_ADDR'] ) ) {
-        $ip = sanitize_text_field( $_SERVER['REMOTE_ADDR'] );
+    if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
+        $ip = sanitize_text_field($_SERVER['HTTP_CLIENT_IP']);
+    } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
+        $ip = sanitize_text_field($_SERVER['HTTP_X_FORWARDED_FOR']);
+    } elseif (!empty($_SERVER['REMOTE_ADDR'])) {
+        $ip = sanitize_text_field($_SERVER['REMOTE_ADDR']);
     }
 
-    return apply_filters( 'wpinv_get_ip', $ip );
+    return apply_filters('wpinv_get_ip', $ip);
 }
 
 function wpinv_get_user_agent() {
-    if ( ! empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
-        $user_agent = sanitize_text_field( $_SERVER['HTTP_USER_AGENT'] );
+    if (!empty($_SERVER['HTTP_USER_AGENT'])) {
+        $user_agent = sanitize_text_field($_SERVER['HTTP_USER_AGENT']);
     } else {
         $user_agent = '';
     }
 
-    return apply_filters( 'wpinv_get_user_agent', $user_agent );
+    return apply_filters('wpinv_get_user_agent', $user_agent);
 }
 
-function wpinv_sanitize_amount( $amount, $decimals = NULL ) {
+function wpinv_sanitize_amount($amount, $decimals = NULL) {
     $is_negative   = false;
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
-    if ( $decimals === NULL ) {
+    if ($decimals === NULL) {
         $decimals = wpinv_decimals();
     }
 
     // Sanitize the amount
-    if ( $decimal_sep == ',' && false !== ( $found = strpos( $amount, $decimal_sep ) ) ) {
-        if ( ( $thousands_sep == '.' || $thousands_sep == ' ' ) && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-            $amount = str_replace( $thousands_sep, '', $amount );
-        } elseif( empty( $thousands_sep ) && false !== ( $found = strpos( $amount, '.' ) ) ) {
-            $amount = str_replace( '.', '', $amount );
+    if ($decimal_sep == ',' && false !== ($found = strpos($amount, $decimal_sep))) {
+        if (($thousands_sep == '.' || $thousands_sep == ' ') && false !== ($found = strpos($amount, $thousands_sep))) {
+            $amount = str_replace($thousands_sep, '', $amount);
+        } elseif (empty($thousands_sep) && false !== ($found = strpos($amount, '.'))) {
+            $amount = str_replace('.', '', $amount);
         }
 
-        $amount = str_replace( $decimal_sep, '.', $amount );
-    } elseif( $thousands_sep == ',' && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-        $amount = str_replace( $thousands_sep, '', $amount );
+        $amount = str_replace($decimal_sep, '.', $amount);
+    } elseif ($thousands_sep == ',' && false !== ($found = strpos($amount, $thousands_sep))) {
+        $amount = str_replace($thousands_sep, '', $amount);
     }
 
-    if( $amount < 0 ) {
+    if ($amount < 0) {
         $is_negative = true;
     }
 
-    $amount   = preg_replace( '/[^0-9\.]/', '', $amount );
+    $amount   = preg_replace('/[^0-9\.]/', '', $amount);
 
-    $decimals = apply_filters( 'wpinv_sanitize_amount_decimals', absint( $decimals ), $amount );
-    $amount   = number_format( (double) $amount, absint( $decimals ), '.', '' );
+    $decimals = apply_filters('wpinv_sanitize_amount_decimals', absint($decimals), $amount);
+    $amount   = number_format((double) $amount, absint($decimals), '.', '');
 
-    if( $is_negative ) {
+    if ($is_negative) {
         $amount *= -1;
     }
 
-    return apply_filters( 'wpinv_sanitize_amount', $amount, $decimals );
+    return apply_filters('wpinv_sanitize_amount', $amount, $decimals);
 }
-add_filter( 'wpinv_sanitize_amount_decimals', 'wpinv_currency_decimal_filter', 10, 1 );
+add_filter('wpinv_sanitize_amount_decimals', 'wpinv_currency_decimal_filter', 10, 1);
 
-function wpinv_round_amount( $amount, $decimals = NULL ) {
-    if ( $decimals === NULL ) {
+function wpinv_round_amount($amount, $decimals = NULL) {
+    if ($decimals === NULL) {
         $decimals = wpinv_decimals();
     }
     
-    $amount = round( (double)$amount, wpinv_currency_decimal_filter( absint( $decimals ) ) );
+    $amount = round((double) $amount, wpinv_currency_decimal_filter(absint($decimals)));
 
-    return apply_filters( 'wpinv_round_amount', $amount, $decimals );
+    return apply_filters('wpinv_round_amount', $amount, $decimals);
 }
 
 /**
@@ -95,32 +95,32 @@ 
  * @since 1.0.19
  * @return array
  */
-function wpinv_get_invoice_statuses( $draft = false, $trashed = false, $invoice = false ) {
+function wpinv_get_invoice_statuses($draft = false, $trashed = false, $invoice = false) {
 	$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-failed'     => _x( 'Failed', 'Invoice status', 'invoicing' ),
-        'wpi-renewal'    => _x( 'Renewal Payment', 'Invoice status', 'invoicing' ),
+		'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-failed'     => _x('Failed', 'Invoice status', 'invoicing'),
+        'wpi-renewal'    => _x('Renewal Payment', 'Invoice status', 'invoicing'),
     );
 
-    if ( $draft ) {
-        $invoice_statuses['draft'] = __( 'Draft', 'invoicing' );
+    if ($draft) {
+        $invoice_statuses['draft'] = __('Draft', 'invoicing');
     }
 
-    if ( $trashed ) {
-        $invoice_statuses['trash'] = __( 'Trash', 'invoicing' );
+    if ($trashed) {
+        $invoice_statuses['trash'] = __('Trash', 'invoicing');
     }
 
-	return apply_filters( 'wpinv_statuses', $invoice_statuses, $invoice );
+	return apply_filters('wpinv_statuses', $invoice_statuses, $invoice);
 }
 
-function wpinv_status_nicename( $status ) {
-    $statuses = wpinv_get_invoice_statuses( true, true );
-    $status   = isset( $statuses[$status] ) ? $statuses[$status] : __( $status, 'invoicing' );
+function wpinv_status_nicename($status) {
+    $statuses = wpinv_get_invoice_statuses(true, true);
+    $status   = isset($statuses[$status]) ? $statuses[$status] : __($status, 'invoicing');
 
     return $status;
 }
@@ -129,7 +129,7 @@ 
  * Retrieves the default currency code.
  */
 function wpinv_get_currency() {
-    return apply_filters( 'wpinv_currency', wpinv_get_option( 'currency', 'USD' ) );
+    return apply_filters('wpinv_currency', wpinv_get_option('currency', 'USD'));
 }
 
 /**
@@ -137,61 +137,61 @@ 
  * 
  * @param string|null $currency The currency code. Defaults to the default currency.
  */
-function wpinv_currency_symbol( $currency = null ) {
+function wpinv_currency_symbol($currency = null) {
 
     // Prepare the currency.
-    $currency = empty( $currency ) ? wpinv_get_currency() : wpinv_clean( $currency );
+    $currency = empty($currency) ? wpinv_get_currency() : wpinv_clean($currency);
 
     // Fetch all symbols.
     $symbols = wpinv_get_currency_symbols();
 
     // Fetch this currencies symbol.
-    $currency_symbol = isset( $symbols[$currency] ) ? $symbols[$currency] : $currency;
+    $currency_symbol = isset($symbols[$currency]) ? $symbols[$currency] : $currency;
 
     // Filter the symbol.
-    return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
+    return apply_filters('wpinv_currency_symbol', $currency_symbol, $currency);
 }
 
 function wpinv_currency_position() {
-    $position = wpinv_get_option( 'currency_position', 'left' );
+    $position = wpinv_get_option('currency_position', 'left');
     
-    return apply_filters( 'wpinv_currency_position', $position );
+    return apply_filters('wpinv_currency_position', $position);
 }
 
 function wpinv_thousands_separator() {
-    $thousand_sep = wpinv_get_option( 'thousands_separator', ',' );
+    $thousand_sep = wpinv_get_option('thousands_separator', ',');
     
-    return apply_filters( 'wpinv_thousands_separator', $thousand_sep );
+    return apply_filters('wpinv_thousands_separator', $thousand_sep);
 }
 
 function wpinv_decimal_separator() {
-    $decimal_sep = wpinv_get_option( 'decimal_separator', '.' );
+    $decimal_sep = wpinv_get_option('decimal_separator', '.');
     
-    return apply_filters( 'wpinv_decimal_separator', $decimal_sep );
+    return apply_filters('wpinv_decimal_separator', $decimal_sep);
 }
 
 function wpinv_decimals() {
-    $decimals = apply_filters( 'wpinv_decimals', wpinv_get_option( 'decimals', 2 ) );
+    $decimals = apply_filters('wpinv_decimals', wpinv_get_option('decimals', 2));
     
-    return absint( $decimals );
+    return absint($decimals);
 }
 
 /**
  * Retrieves a list of all supported currencies.
  */
 function wpinv_get_currencies() {
-    return apply_filters( 'wpinv_currencies', wpinv_get_data( 'currencies' ) );
+    return apply_filters('wpinv_currencies', wpinv_get_data('currencies'));
 }
 
 /**
  * Retrieves a list of all currency symbols.
  */
 function wpinv_get_currency_symbols() {
-    return apply_filters( 'wpinv_currency_symbols', wpinv_get_data( 'currency-symbols' ) );
+    return apply_filters('wpinv_currency_symbols', wpinv_get_data('currency-symbols'));
 }
 
-function wpinv_price( $amount = '', $currency = '' ) {
-    if( empty( $currency ) ) {
+function wpinv_price($amount = '', $currency = '') {
+    if (empty($currency)) {
         $currency = wpinv_get_currency();
     }
 
@@ -199,14 +199,14 @@ 
 
     $negative = $amount < 0;
 
-    if ( $negative ) {
-        $amount = substr( $amount, 1 );
+    if ($negative) {
+        $amount = substr($amount, 1);
     }
 
-    $symbol = wpinv_currency_symbol( $currency );
+    $symbol = wpinv_currency_symbol($currency);
 
-    if ( $position == 'left' || $position == 'left_space' ) {
-        switch ( $currency ) {
+    if ($position == 'left' || $position == 'left_space') {
+        switch ($currency) {
             case "GBP" :
             case "BRL" :
             case "EUR" :
@@ -218,15 +218,15 @@ 
             case "NZD" :
             case "SGD" :
             case "JPY" :
-                $price = $position == 'left_space' ? $symbol . ' ' .  $amount : $symbol . $amount;
+                $price = $position == 'left_space' ? $symbol . ' ' . $amount : $symbol . $amount;
                 break;
             default :
                 //$price = $currency . ' ' . $amount;
-                $price = $position == 'left_space' ? $symbol . ' ' .  $amount : $symbol . $amount;
+                $price = $position == 'left_space' ? $symbol . ' ' . $amount : $symbol . $amount;
                 break;
         }
     } else {
-        switch ( $currency ) {
+        switch ($currency) {
             case "GBP" :
             case "BRL" :
             case "EUR" :
@@ -237,83 +237,83 @@ 
             case "MXN" :
             case "SGD" :
             case "JPY" :
-                $price = $position == 'right_space' ? $amount . ' ' .  $symbol : $amount . $symbol;
+                $price = $position == 'right_space' ? $amount . ' ' . $symbol : $amount . $symbol;
                 break;
             default :
                 //$price = $amount . ' ' . $currency;
-                $price = $position == 'right_space' ? $amount . ' ' .  $symbol : $amount . $symbol;
+                $price = $position == 'right_space' ? $amount . ' ' . $symbol : $amount . $symbol;
                 break;
         }
     }
     
-    if ( $negative ) {
+    if ($negative) {
         $price = '-' . $price;
     }
     
-    $price = apply_filters( 'wpinv_' . strtolower( $currency ) . '_currency_filter_' . $position, $price, $currency, $amount );
+    $price = apply_filters('wpinv_' . strtolower($currency) . '_currency_filter_' . $position, $price, $currency, $amount);
 
     return $price;
 }
 
-function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
+function wpinv_format_amount($amount, $decimals = NULL, $calculate = false) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
 
-    if ( $decimals === NULL ) {
+    if ($decimals === NULL) {
         $decimals = wpinv_decimals();
     }
 
-    if ( $decimal_sep == ',' && false !== ( $sep_found = strpos( $amount, $decimal_sep ) ) ) {
-        $whole = substr( $amount, 0, $sep_found );
-        $part = substr( $amount, $sep_found + 1, ( strlen( $amount ) - 1 ) );
+    if ($decimal_sep == ',' && false !== ($sep_found = strpos($amount, $decimal_sep))) {
+        $whole = substr($amount, 0, $sep_found);
+        $part = substr($amount, $sep_found + 1, (strlen($amount) - 1));
         $amount = $whole . '.' . $part;
     }
 
-    if ( $thousands_sep == ',' && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-        $amount = str_replace( ',', '', $amount );
+    if ($thousands_sep == ',' && false !== ($found = strpos($amount, $thousands_sep))) {
+        $amount = str_replace(',', '', $amount);
     }
 
-    if ( $thousands_sep == ' ' && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-        $amount = str_replace( ' ', '', $amount );
+    if ($thousands_sep == ' ' && false !== ($found = strpos($amount, $thousands_sep))) {
+        $amount = str_replace(' ', '', $amount);
     }
 
-    if ( empty( $amount ) ) {
+    if (empty($amount)) {
         $amount = 0;
     }
     
-    $decimals  = apply_filters( 'wpinv_amount_format_decimals', $decimals ? $decimals : 0, $amount, $calculate );
-    $formatted = number_format( (float)$amount, $decimals, $decimal_sep, $thousands_sep );
+    $decimals  = apply_filters('wpinv_amount_format_decimals', $decimals ? $decimals : 0, $amount, $calculate);
+    $formatted = number_format((float) $amount, $decimals, $decimal_sep, $thousands_sep);
     
-    if ( $calculate ) {
-        if ( $thousands_sep === "," ) {
-            $formatted = str_replace( ",", "", $formatted );
+    if ($calculate) {
+        if ($thousands_sep === ",") {
+            $formatted = str_replace(",", "", $formatted);
         }
         
-        if ( $decimal_sep === "," ) {
-            $formatted = str_replace( ",", ".", $formatted );
+        if ($decimal_sep === ",") {
+            $formatted = str_replace(",", ".", $formatted);
         }
     }
 
-    return apply_filters( 'wpinv_amount_format', $formatted, $amount, $decimals, $decimal_sep, $thousands_sep, $calculate );
+    return apply_filters('wpinv_amount_format', $formatted, $amount, $decimals, $decimal_sep, $thousands_sep, $calculate);
 }
-add_filter( 'wpinv_amount_format_decimals', 'wpinv_currency_decimal_filter', 10, 1 );
+add_filter('wpinv_amount_format_decimals', 'wpinv_currency_decimal_filter', 10, 1);
 
-function wpinv_sanitize_key( $key ) {
+function wpinv_sanitize_key($key) {
     $raw_key = $key;
-    $key = preg_replace( '/[^a-zA-Z0-9_\-\.\:\/]/', '', $key );
+    $key = preg_replace('/[^a-zA-Z0-9_\-\.\:\/]/', '', $key);
 
-    return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
+    return apply_filters('wpinv_sanitize_key', $key, $raw_key);
 }
 
-function wpinv_get_file_extension( $str ) {
-    $parts = explode( '.', $str );
-    return end( $parts );
+function wpinv_get_file_extension($str) {
+    $parts = explode('.', $str);
+    return end($parts);
 }
 
-function wpinv_string_is_image_url( $str ) {
-    $ext = wpinv_get_file_extension( $str );
+function wpinv_string_is_image_url($str) {
+    $ext = wpinv_get_file_extension($str);
 
-    switch ( strtolower( $ext ) ) {
+    switch (strtolower($ext)) {
         case 'jpeg';
         case 'jpg';
             $return = true;
@@ -329,33 +329,33 @@ 
             break;
     }
 
-    return (bool)apply_filters( 'wpinv_string_is_image', $return, $str );
+    return (bool) apply_filters('wpinv_string_is_image', $return, $str);
 }
 
-function wpinv_error_log( $log, $title = '', $file = '', $line = '', $exit = false ) {
-    $should_log = apply_filters( 'wpinv_log_errors', WP_DEBUG );
+function wpinv_error_log($log, $title = '', $file = '', $line = '', $exit = false) {
+    $should_log = apply_filters('wpinv_log_errors', WP_DEBUG);
     
-    if ( true === $should_log ) {
+    if (true === $should_log) {
         $label = '';
-        if ( $file && $file !== '' ) {
-            $label .= basename( $file ) . ( $line ? '(' . $line . ')' : '' );
+        if ($file && $file !== '') {
+            $label .= basename($file) . ($line ? '(' . $line . ')' : '');
         }
         
-        if ( $title && $title !== '' ) {
+        if ($title && $title !== '') {
             $label = $label !== '' ? $label . ' ' : '';
             $label .= $title . ' ';
         }
         
-        $label = $label !== '' ? trim( $label ) . ' : ' : '';
+        $label = $label !== '' ? trim($label) . ' : ' : '';
         
-        if ( is_array( $log ) || is_object( $log ) ) {
-            error_log( $label . print_r( $log, true ) );
+        if (is_array($log) || is_object($log)) {
+            error_log($label . print_r($log, true));
         } else {
-            error_log( $label . $log );
+            error_log($label . $log);
         }
 
-        error_log( wp_debug_backtrace_summary() );
-        if ( $exit ) {
+        error_log(wp_debug_backtrace_summary());
+        if ($exit) {
             exit;
         }
     }
@@ -363,32 +363,32 @@ 
 
 function wpinv_is_ajax_disabled() {
     $retval = false;
-    return apply_filters( 'wpinv_is_ajax_disabled', $retval );
+    return apply_filters('wpinv_is_ajax_disabled', $retval);
 }
 
-function wpinv_get_current_page_url( $nocache = false ) {
+function wpinv_get_current_page_url($nocache = false) {
     global $wp;
 
-    if ( get_option( 'permalink_structure' ) ) {
-        $base = trailingslashit( home_url( $wp->request ) );
+    if (get_option('permalink_structure')) {
+        $base = trailingslashit(home_url($wp->request));
     } else {
-        $base = add_query_arg( $wp->query_string, '', trailingslashit( home_url( $wp->request ) ) );
-        $base = remove_query_arg( array( 'post_type', 'name' ), $base );
+        $base = add_query_arg($wp->query_string, '', trailingslashit(home_url($wp->request)));
+        $base = remove_query_arg(array('post_type', 'name'), $base);
     }
 
     $scheme = is_ssl() ? 'https' : 'http';
-    $uri    = set_url_scheme( $base, $scheme );
+    $uri    = set_url_scheme($base, $scheme);
 
-    if ( is_front_page() ) {
-        $uri = home_url( '/' );
-    } elseif ( wpinv_is_checkout( array(), false ) ) {
+    if (is_front_page()) {
+        $uri = home_url('/');
+    } elseif (wpinv_is_checkout(array(), false)) {
         $uri = wpinv_get_checkout_uri();
     }
 
-    $uri = apply_filters( 'wpinv_get_current_page_url', $uri );
+    $uri = apply_filters('wpinv_get_current_page_url', $uri);
 
-    if ( $nocache ) {
-        $uri = wpinv_add_cache_busting( $uri );
+    if ($nocache) {
+        $uri = wpinv_add_cache_busting($uri);
     }
 
     return $uri;
@@ -401,46 +401,46 @@ 
  * @param string $name  Constant name.
  * @param mixed  $value Value.
  */
-function getpaid_maybe_define_constant( $name, $value ) {
-	if ( ! defined( $name ) ) {
-		define( $name, $value );
+function getpaid_maybe_define_constant($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 ) {
-    $color = str_replace( '#', '', $color );
+function wpinv_rgb_from_hex($color) {
+    $color = str_replace('#', '', $color);
 
     // Convert shorthand colors to full format, e.g. "FFF" -> "FFFFFF"
-    $color = preg_replace( '~^(.)(.)(.)$~', '$1$1$2$2$3$3', $color );
-    if ( empty( $color ) ) {
+    $color = preg_replace('~^(.)(.)(.)$~', '$1$1$2$2$3$3', $color);
+    if (empty($color)) {
         return NULL;
     }
 
-    $color = str_split( $color );
+    $color = str_split($color);
 
     $rgb      = array();
-    $rgb['R'] = hexdec( $color[0] . $color[1] );
-    $rgb['G'] = hexdec( $color[2] . $color[3] );
-    $rgb['B'] = hexdec( $color[4] . $color[5] );
+    $rgb['R'] = hexdec($color[0] . $color[1]);
+    $rgb['G'] = hexdec($color[2] . $color[3]);
+    $rgb['B'] = hexdec($color[4] . $color[5]);
 
     return $rgb;
 }
 
-function wpinv_hex_darker( $color, $factor = 30 ) {
-    $base  = wpinv_rgb_from_hex( $color );
+function wpinv_hex_darker($color, $factor = 30) {
+    $base  = wpinv_rgb_from_hex($color);
     $color = '#';
 
-    foreach ( $base as $k => $v ) {
+    foreach ($base as $k => $v) {
         $amount      = $v / 100;
-        $amount      = round( $amount * $factor );
+        $amount      = round($amount * $factor);
         $new_decimal = $v - $amount;
 
-        $new_hex_component = dechex( $new_decimal );
-        if ( strlen( $new_hex_component ) < 2 ) {
+        $new_hex_component = dechex($new_decimal);
+        if (strlen($new_hex_component) < 2) {
             $new_hex_component = "0" . $new_hex_component;
         }
         $color .= $new_hex_component;
@@ -449,18 +449,18 @@ 
     return $color;
 }
 
-function wpinv_hex_lighter( $color, $factor = 30 ) {
-    $base  = wpinv_rgb_from_hex( $color );
+function wpinv_hex_lighter($color, $factor = 30) {
+    $base  = wpinv_rgb_from_hex($color);
     $color = '#';
 
-    foreach ( $base as $k => $v ) {
+    foreach ($base as $k => $v) {
         $amount      = 255 - $v;
         $amount      = $amount / 100;
-        $amount      = round( $amount * $factor );
+        $amount      = round($amount * $factor);
         $new_decimal = $v + $amount;
 
-        $new_hex_component = dechex( $new_decimal );
-        if ( strlen( $new_hex_component ) < 2 ) {
+        $new_hex_component = dechex($new_decimal);
+        if (strlen($new_hex_component) < 2) {
             $new_hex_component = "0" . $new_hex_component;
         }
         $color .= $new_hex_component;
@@ -469,22 +469,22 @@ 
     return $color;
 }
 
-function wpinv_light_or_dark( $color, $dark = '#000000', $light = '#FFFFFF' ) {
-    $hex = str_replace( '#', '', $color );
+function wpinv_light_or_dark($color, $dark = '#000000', $light = '#FFFFFF') {
+    $hex = str_replace('#', '', $color);
 
-    $c_r = hexdec( substr( $hex, 0, 2 ) );
-    $c_g = hexdec( substr( $hex, 2, 2 ) );
-    $c_b = hexdec( substr( $hex, 4, 2 ) );
+    $c_r = hexdec(substr($hex, 0, 2));
+    $c_g = hexdec(substr($hex, 2, 2));
+    $c_b = hexdec(substr($hex, 4, 2));
 
-    $brightness = ( ( $c_r * 299 ) + ( $c_g * 587 ) + ( $c_b * 114 ) ) / 1000;
+    $brightness = (($c_r * 299) + ($c_g * 587) + ($c_b * 114)) / 1000;
 
     return $brightness > 155 ? $dark : $light;
 }
 
-function wpinv_format_hex( $hex ) {
-    $hex = trim( str_replace( '#', '', $hex ) );
+function wpinv_format_hex($hex) {
+    $hex = trim(str_replace('#', '', $hex));
 
-    if ( strlen( $hex ) == 3 ) {
+    if (strlen($hex) == 3) {
         $hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
     }
 
@@ -504,12 +504,12 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return string
  */
-function wpinv_utf8_strimwidth( $str, $start, $width, $trimmaker = '', $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strimwidth' ) ) {
-        return mb_strimwidth( $str, $start, $width, $trimmaker, $encoding );
+function wpinv_utf8_strimwidth($str, $start, $width, $trimmaker = '', $encoding = 'UTF-8') {
+    if (function_exists('mb_strimwidth')) {
+        return mb_strimwidth($str, $start, $width, $trimmaker, $encoding);
     }
     
-    return wpinv_utf8_substr( $str, $start, $width, $encoding ) . $trimmaker;
+    return wpinv_utf8_substr($str, $start, $width, $encoding) . $trimmaker;
 }
 
 /**
@@ -521,28 +521,28 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return int Returns the number of characters in string.
  */
-function wpinv_utf8_strlen( $str, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strlen' ) ) {
-        return mb_strlen( $str, $encoding );
+function wpinv_utf8_strlen($str, $encoding = 'UTF-8') {
+    if (function_exists('mb_strlen')) {
+        return mb_strlen($str, $encoding);
     }
         
-    return strlen( $str );
+    return strlen($str);
 }
 
-function wpinv_utf8_strtolower( $str, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strtolower' ) ) {
-        return mb_strtolower( $str, $encoding );
+function wpinv_utf8_strtolower($str, $encoding = 'UTF-8') {
+    if (function_exists('mb_strtolower')) {
+        return mb_strtolower($str, $encoding);
     }
     
-    return strtolower( $str );
+    return strtolower($str);
 }
 
-function wpinv_utf8_strtoupper( $str, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strtoupper' ) ) {
-        return mb_strtoupper( $str, $encoding );
+function wpinv_utf8_strtoupper($str, $encoding = 'UTF-8') {
+    if (function_exists('mb_strtoupper')) {
+        return mb_strtoupper($str, $encoding);
     }
     
-    return strtoupper( $str );
+    return strtoupper($str);
 }
 
 /**
@@ -556,12 +556,12 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return int Returns the position of the first occurrence of search in the string.
  */
-function wpinv_utf8_strpos( $str, $find, $offset = 0, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strpos' ) ) {
-        return mb_strpos( $str, $find, $offset, $encoding );
+function wpinv_utf8_strpos($str, $find, $offset = 0, $encoding = 'UTF-8') {
+    if (function_exists('mb_strpos')) {
+        return mb_strpos($str, $find, $offset, $encoding);
     }
         
-    return strpos( $str, $find, $offset );
+    return strpos($str, $find, $offset);
 }
 
 /**
@@ -575,12 +575,12 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return int Returns the position of the last occurrence of search.
  */
-function wpinv_utf8_strrpos( $str, $find, $offset = 0, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strrpos' ) ) {
-        return mb_strrpos( $str, $find, $offset, $encoding );
+function wpinv_utf8_strrpos($str, $find, $offset = 0, $encoding = 'UTF-8') {
+    if (function_exists('mb_strrpos')) {
+        return mb_strrpos($str, $find, $offset, $encoding);
     }
         
-    return strrpos( $str, $find, $offset );
+    return strrpos($str, $find, $offset);
 }
 
 /**
@@ -595,16 +595,16 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return string
  */
-function wpinv_utf8_substr( $str, $start, $length = null, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_substr' ) ) {
-        if ( $length === null ) {
-            return mb_substr( $str, $start, wpinv_utf8_strlen( $str, $encoding ), $encoding );
+function wpinv_utf8_substr($str, $start, $length = null, $encoding = 'UTF-8') {
+    if (function_exists('mb_substr')) {
+        if ($length === null) {
+            return mb_substr($str, $start, wpinv_utf8_strlen($str, $encoding), $encoding);
         } else {
-            return mb_substr( $str, $start, $length, $encoding );
+            return mb_substr($str, $start, $length, $encoding);
         }
     }
         
-    return substr( $str, $start, $length );
+    return substr($str, $start, $length);
 }
 
 /**
@@ -616,48 +616,48 @@ 
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
  * @return string The width of string.
  */
-function wpinv_utf8_strwidth( $str, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strwidth' ) ) {
-        return mb_strwidth( $str, $encoding );
+function wpinv_utf8_strwidth($str, $encoding = 'UTF-8') {
+    if (function_exists('mb_strwidth')) {
+        return mb_strwidth($str, $encoding);
     }
     
-    return wpinv_utf8_strlen( $str, $encoding );
+    return wpinv_utf8_strlen($str, $encoding);
 }
 
-function wpinv_utf8_ucfirst( $str, $lower_str_end = false, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_strlen' ) ) {
-        $first_letter = wpinv_utf8_strtoupper( wpinv_utf8_substr( $str, 0, 1, $encoding ), $encoding );
+function wpinv_utf8_ucfirst($str, $lower_str_end = false, $encoding = 'UTF-8') {
+    if (function_exists('mb_strlen')) {
+        $first_letter = wpinv_utf8_strtoupper(wpinv_utf8_substr($str, 0, 1, $encoding), $encoding);
         $str_end = "";
         
-        if ( $lower_str_end ) {
-            $str_end = wpinv_utf8_strtolower( wpinv_utf8_substr( $str, 1, wpinv_utf8_strlen( $str, $encoding ), $encoding ), $encoding );
+        if ($lower_str_end) {
+            $str_end = wpinv_utf8_strtolower(wpinv_utf8_substr($str, 1, wpinv_utf8_strlen($str, $encoding), $encoding), $encoding);
         } else {
-            $str_end = wpinv_utf8_substr( $str, 1, wpinv_utf8_strlen( $str, $encoding ), $encoding );
+            $str_end = wpinv_utf8_substr($str, 1, wpinv_utf8_strlen($str, $encoding), $encoding);
         }
 
         return $first_letter . $str_end;
     }
     
-    return ucfirst( $str );
+    return ucfirst($str);
 }
 
-function wpinv_utf8_ucwords( $str, $encoding = 'UTF-8' ) {
-    if ( function_exists( 'mb_convert_case' ) ) {
-        return mb_convert_case( $str, MB_CASE_TITLE, $encoding );
+function wpinv_utf8_ucwords($str, $encoding = 'UTF-8') {
+    if (function_exists('mb_convert_case')) {
+        return mb_convert_case($str, MB_CASE_TITLE, $encoding);
     }
     
-    return ucwords( $str );
+    return ucwords($str);
 }
 
-function wpinv_period_in_days( $period, $unit ) {
-    $period = absint( $period );
+function wpinv_period_in_days($period, $unit) {
+    $period = absint($period);
     
-    if ( $period > 0 ) {
-        if ( in_array( strtolower( $unit ), array( 'w', 'week', 'weeks' ) ) ) {
+    if ($period > 0) {
+        if (in_array(strtolower($unit), array('w', 'week', 'weeks'))) {
             $period = $period * 7;
-        } else if ( in_array( strtolower( $unit ), array( 'm', 'month', 'months' ) ) ) {
+        } else if (in_array(strtolower($unit), array('m', 'month', 'months'))) {
             $period = $period * 30;
-        } else if ( in_array( strtolower( $unit ), array( 'y', 'year', 'years' ) ) ) {
+        } else if (in_array(strtolower($unit), array('y', 'year', 'years'))) {
             $period = $period * 365;
         }
     }
@@ -665,14 +665,14 @@ 
     return $period;
 }
 
-function wpinv_cal_days_in_month( $calendar, $month, $year ) {
-    if ( function_exists( 'cal_days_in_month' ) ) {
-        return cal_days_in_month( $calendar, $month, $year );
+function wpinv_cal_days_in_month($calendar, $month, $year) {
+    if (function_exists('cal_days_in_month')) {
+        return cal_days_in_month($calendar, $month, $year);
     }
 
     // Fallback in case the calendar extension is not loaded in PHP
     // Only supports Gregorian calendar
-    return date( 't', mktime( 0, 0, 0, $month, 1, $year ) );
+    return date('t', mktime(0, 0, 0, $month, 1, $year));
 }
 
 /**
@@ -683,11 +683,11 @@ 
  *
  * @return string
  */
-function wpi_help_tip( $tip, $allow_html = false ) {
-    if ( $allow_html ) {
-        $tip = wpi_sanitize_tooltip( $tip );
+function wpi_help_tip($tip, $allow_html = false) {
+    if ($allow_html) {
+        $tip = wpi_sanitize_tooltip($tip);
     } else {
-        $tip = esc_attr( $tip );
+        $tip = esc_attr($tip);
     }
 
     return '<span class="wpi-help-tip dashicons dashicons-editor-help" title="' . $tip . '"></span>';
@@ -701,8 +701,8 @@ 
  * @param string $var
  * @return string
  */
-function wpi_sanitize_tooltip( $var ) {
-    return htmlspecialchars( wp_kses( html_entity_decode( $var ), array(
+function wpi_sanitize_tooltip($var) {
+    return htmlspecialchars(wp_kses(html_entity_decode($var), array(
         'br'     => array(),
         'em'     => array(),
         'strong' => array(),
@@ -712,7 +712,7 @@ 
         'li'     => array(),
         'ol'     => array(),
         'p'      => array(),
-    ) ) );
+    )));
 }
 
 /**
@@ -722,7 +722,7 @@ 
  */
 function wpinv_get_screen_ids() {
 
-    $screen_id = sanitize_title( __( 'Invoicing', 'invoicing' ) );
+    $screen_id = sanitize_title(__('Invoicing', 'invoicing'));
 
     $screen_ids = array(
         'toplevel_page_' . $screen_id,
@@ -740,7 +740,7 @@ 
         'invoicing_page_wpi-addons',
     );
 
-    return apply_filters( 'wpinv_screen_ids', $screen_ids );
+    return apply_filters('wpinv_screen_ids', $screen_ids);
 }
 
 /**
@@ -751,14 +751,14 @@ 
  * @param array|string $list List of values.
  * @return array Sanitized array of values.
  */
-function wpinv_parse_list( $list ) {
+function wpinv_parse_list($list) {
 
-    if ( empty( $list ) ) {
+    if (empty($list)) {
         $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;
@@ -772,16 +772,16 @@ 
  * @param string $key Type of data to fetch.
  * @return mixed Fetched data.
  */
-function wpinv_get_data( $key ) {
+function wpinv_get_data($key) {
 
     // Try fetching it from the cache.
-    $data = wp_cache_get( "wpinv-data-$key", 'wpinv' );
-    if( $data ) {
+    $data = wp_cache_get("wpinv-data-$key", 'wpinv');
+    if ($data) {
         return $data;
     }
 
-    $data = apply_filters( "wpinv_get_$key", include WPINV_PLUGIN_DIR . "includes/data/$key.php" );
-	wp_cache_set( "wpinv-data-$key", $data, 'wpinv' );
+    $data = apply_filters("wpinv_get_$key", include WPINV_PLUGIN_DIR . "includes/data/$key.php");
+	wp_cache_set("wpinv-data-$key", $data, 'wpinv');
 
 	return $data;
 }
@@ -795,10 +795,10 @@ 
  * @param bool $first_empty Whether or not the first item in the list should be empty
  * @return mixed Fetched data.
  */
-function wpinv_maybe_add_empty_option( $options, $first_empty ) {
+function wpinv_maybe_add_empty_option($options, $first_empty) {
 
-    if ( ! empty( $options ) && $first_empty ) {
-        return array_merge( array( '' => '' ), $options );
+    if (!empty($options) && $first_empty) {
+        return array_merge(array('' => ''), $options);
     }
     return $options;
 
@@ -810,21 +810,21 @@ 
  * @param mixed $var Data to sanitize.
  * @return string|array
  */
-function wpinv_clean( $var ) {
+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 );
+    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);
         }
         return $var;
 	}
     
-    return is_string( $var ) ? sanitize_text_field( $var ) : $var;
+    return is_string($var) ? sanitize_text_field($var) : $var;
 }
 
 /**
@@ -833,43 +833,43 @@ 
  * @param string $str Data to convert.
  * @return string|array
  */
-function getpaid_convert_price_string_to_options( $str ) {
+function getpaid_convert_price_string_to_options($str) {
 
-	$raw_options = array_map( 'trim', explode( ',', $str ) );
-    $options     = array();
+	$raw_options = array_map('trim', explode(',', $str));
+    $options = array();
 
-    foreach ( $raw_options as $option ) {
+    foreach ($raw_options as $option) {
 
-        if ( '' == $option ) {
+        if ('' == $option) {
             continue;
         }
 
-        $option = array_map( 'trim', explode( '|', $option ) );
+        $option = array_map('trim', explode('|', $option));
 
         $price = null;
         $label = null;
 
-        if ( isset( $option[0] ) && '' !=  $option[0] ) {
-            $label  = $option[0];
+        if (isset($option[0]) && '' != $option[0]) {
+            $label = $option[0];
         }
 
-        if ( isset( $option[1] ) && '' !=  $option[1] ) {
+        if (isset($option[1]) && '' != $option[1]) {
             $price = $option[1];
         }
 
-        if ( ! isset( $price ) ) {
+        if (!isset($price)) {
             $price = $label;
         }
 
-        if ( ! isset( $price ) || ! is_numeric( $price ) ) {
+        if (!isset($price) || !is_numeric($price)) {
             continue;
         }
 
-        if ( ! isset( $label ) ) {
+        if (!isset($label)) {
             $label = $price;
         }
 
-        $options[ $price ] = $label;
+        $options[$price] = $label;
     }
 
     return $options;
@@ -878,23 +878,23 @@ 
 /**
  * Returns the help tip.
  */
-function getpaid_get_help_tip( $tip, $additional_classes = '' ) {
-    $additional_classes = sanitize_html_class( $additional_classes );
-    $tip                = esc_attr__( $tip );
+function getpaid_get_help_tip($tip, $additional_classes = '') {
+    $additional_classes = sanitize_html_class($additional_classes);
+    $tip                = esc_attr__($tip);
     return "<span class='wpi-help-tip dashicons dashicons-editor-help $additional_classes' title='$tip'></span>";
 }
 
 /**
  * Formats a date
  */
-function getpaid_format_date( $date ) {
+function getpaid_format_date($date) {
 
-    if ( empty( $date ) || $date == '0000-00-00 00:00:00' ) {
+    if (empty($date) || $date == '0000-00-00 00:00:00') {
         return '';
     }
 
 
-    return date_i18n( get_option( 'date_format' ), strtotime( $date ) );
+    return date_i18n(get_option('date_format'), strtotime($date));
 
 }
 
@@ -905,16 +905,16 @@ 
  * @param  integer $limit Limit size in characters.
  * @return string
  */
-function getpaid_limit_length( $string, $limit ) {
+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 ) . '...';
+	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 (strlen($string) > $limit) {
+			$string = substr($string, 0, $str_limit) . '...';
 		}
 	}
     return $string;
@@ -928,7 +928,7 @@ 
  * @since 1.0.19
  */
 function getpaid_api() {
-    return getpaid()->get( 'api' );
+    return getpaid()->get('api');
 }
 
 /**
@@ -938,7 +938,7 @@ 
  * @since 1.0.19
  */
 function getpaid_post_types() {
-    return getpaid()->get( 'post_types' );
+    return getpaid()->get('post_types');
 }
 
 /**
@@ -948,7 +948,7 @@ 
  * @since 1.0.19
  */
 function getpaid_session() {
-    return getpaid()->get( 'session' );
+    return getpaid()->get('session');
 }
 
 /**
@@ -958,7 +958,7 @@ 
  * @since 1.0.19
  */
 function getpaid_notes() {
-    return getpaid()->get( 'notes' );
+    return getpaid()->get('notes');
 }
 
 /**
@@ -970,15 +970,15 @@ 
  * 
  * @return int|array|WPInv_Subscription[]|GetPaid_Subscriptions_Query
  */
-function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
+function getpaid_get_subscriptions($args = array(), $return = 'results') {
 
-    $query = new GetPaid_Subscriptions_Query( $args );
+    $query = new GetPaid_Subscriptions_Query($args);
 
-    if ( 'results' == $return ) {
+    if ('results' == $return) {
         return $query->get_results();
     }
 
-    if ( 'count' == $return ) {
+    if ('count' == $return) {
         return $query->get_total();
     }