AyeCode / invoicing

includes/admin/class-getpaid-installer.php

Indentation +384 added lines, -384 removed lines

@@ -20,237 +20,237 @@ 
  */
 class GetPaid_Installer {
 
-	/**
-	 * Upgrades the install.
-	 *
-	 * @param string $upgrade_from The current invoicing version.
-	 */
-	public function upgrade_db( $upgrade_from ) {
-
-		// Save the current invoicing version.
-		update_option( 'wpinv_version', WPINV_VERSION );
-
-		// Setup the invoice Custom Post Type.
-		GetPaid_Post_Types::register_post_types();
-
-		// Clear the permalinks
-		flush_rewrite_rules();
-
-		// Maybe create new/missing pages.
-		$this->create_pages();
-
-		// Maybe re(add) admin capabilities.
-		$this->add_capabilities();
-
-		// Maybe create the default payment form.
-		wpinv_get_default_payment_form();
-
-		// Create any missing database tables.
-		$method = "upgrade_from_$upgrade_from";
-
-		$installed = get_option( 'gepaid_installed_on' );
-
-		if ( empty( $installed ) ) {
-			update_option( 'gepaid_installed_on', time() );
-		}
-
-		if ( method_exists( $this, $method ) ) {
-			$this->$method();
-		}
-
-	}
-
-	/**
-	 * Do a fresh install.
-	 *
-	 */
-	public function upgrade_from_0() {
-		$this->create_subscriptions_table();
-		$this->create_invoices_table();
-		$this->create_invoice_items_table();
-
-		// Save default tax rates.
-		update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) );
-	}
-
-	/**
-	 * Upgrade to 0.0.5
-	 *
-	 */
-	public function upgrade_from_004() {
-		global $wpdb;
-
-		// Invoices.
-		$results = $wpdb->get_results( "SELECT ID FROM {$wpdb->posts} WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" );
-		if ( ! empty( $results ) ) {
-			$wpdb->query( "UPDATE {$wpdb->posts} SET post_status = CONCAT( 'wpi-', post_status ) WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" );
-
-			// Clean post cache
-			foreach ( $results as $row ) {
-				clean_post_cache( $row->ID );
-			}
-		}
-
-		// Item meta key changes
-		$query = 'SELECT DISTINCT post_id FROM ' . $wpdb->postmeta . " WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id', '_wpinv_cpt_name', '_wpinv_cpt_singular_name' )";
-		$results = $wpdb->get_results( $query );
-
-		if ( ! empty( $results ) ) {
-			$wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_id' WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id' )" );
-			$wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_name' WHERE meta_key = '_wpinv_cpt_name'" );
-			$wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_singular_name' WHERE meta_key = '_wpinv_cpt_singular_name'" );
-
-			foreach ( $results as $row ) {
-				clean_post_cache( $row->post_id );
-			}
-		}
-
-		$this->upgrade_from_102();
-	}
-
-	/**
-	 * Upgrade to 1.0.3
-	 *
-	 */
-	public function upgrade_from_102() {
-		$this->create_subscriptions_table();
-		$this->upgrade_from_118();
-	}
-
-	/**
-	 * Upgrade to version 2.0.0.
-	 *
-	 */
-	public function upgrade_from_118() {
-		$this->create_invoices_table();
-		$this->create_invoice_items_table();
-		$this->migrate_old_invoices();
-	}
-
-	/**
-	 * Upgrade to version 2.0.8.
-	 *
-	 */
-	public function upgrade_from_207() {
-		global $wpdb;
-		$wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoice_items MODIFY COLUMN quantity FLOAT(20);" );
-		$this->upgrade_from_2615();
-	}
-
-	/**
-	 * Upgrade to version 2.6.16.
-	 *
-	 */
-	public function upgrade_from_2615() {
-		global $wpdb;
-		$wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoice_items MODIFY COLUMN item_price DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY custom_price DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY discount DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY subtotal DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY price DECIMAL(16,4) NOT NULL DEFAULT '0';" );
-		$wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices MODIFY COLUMN subtotal DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY tax DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY fees_total DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY total DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY discount DECIMAL(16,4) NOT NULL DEFAULT '0';" );
-	}
-
-	/**
-	 * Give administrators the capability to manage GetPaid.
-	 *
-	 */
-	public function add_capabilities() {
-		$GLOBALS['wp_roles']->add_cap( 'administrator', 'manage_invoicing' );
-	}
-
-	/**
-	 * Retreives GetPaid pages.
-	 *
-	 */
-	public static function get_pages() {
-
-		return apply_filters(
-			'wpinv_create_pages',
-			array(
-
-				// Checkout page.
-				'checkout_page'             => array(
-					'name'    => _x( 'gp-checkout', 'Page slug', 'invoicing' ),
-					'title'   => _x( 'Checkout', 'Page title', 'invoicing' ),
-					'content' => '
+    /**
+     * Upgrades the install.
+     *
+     * @param string $upgrade_from The current invoicing version.
+     */
+    public function upgrade_db( $upgrade_from ) {
+
+        // Save the current invoicing version.
+        update_option( 'wpinv_version', WPINV_VERSION );
+
+        // Setup the invoice Custom Post Type.
+        GetPaid_Post_Types::register_post_types();
+
+        // Clear the permalinks
+        flush_rewrite_rules();
+
+        // Maybe create new/missing pages.
+        $this->create_pages();
+
+        // Maybe re(add) admin capabilities.
+        $this->add_capabilities();
+
+        // Maybe create the default payment form.
+        wpinv_get_default_payment_form();
+
+        // Create any missing database tables.
+        $method = "upgrade_from_$upgrade_from";
+
+        $installed = get_option( 'gepaid_installed_on' );
+
+        if ( empty( $installed ) ) {
+            update_option( 'gepaid_installed_on', time() );
+        }
+
+        if ( method_exists( $this, $method ) ) {
+            $this->$method();
+        }
+
+    }
+
+    /**
+     * Do a fresh install.
+     *
+     */
+    public function upgrade_from_0() {
+        $this->create_subscriptions_table();
+        $this->create_invoices_table();
+        $this->create_invoice_items_table();
+
+        // Save default tax rates.
+        update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) );
+    }
+
+    /**
+     * Upgrade to 0.0.5
+     *
+     */
+    public function upgrade_from_004() {
+        global $wpdb;
+
+        // Invoices.
+        $results = $wpdb->get_results( "SELECT ID FROM {$wpdb->posts} WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" );
+        if ( ! empty( $results ) ) {
+            $wpdb->query( "UPDATE {$wpdb->posts} SET post_status = CONCAT( 'wpi-', post_status ) WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" );
+
+            // Clean post cache
+            foreach ( $results as $row ) {
+                clean_post_cache( $row->ID );
+            }
+        }
+
+        // Item meta key changes
+        $query = 'SELECT DISTINCT post_id FROM ' . $wpdb->postmeta . " WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id', '_wpinv_cpt_name', '_wpinv_cpt_singular_name' )";
+        $results = $wpdb->get_results( $query );
+
+        if ( ! empty( $results ) ) {
+            $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_id' WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id' )" );
+            $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_name' WHERE meta_key = '_wpinv_cpt_name'" );
+            $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_singular_name' WHERE meta_key = '_wpinv_cpt_singular_name'" );
+
+            foreach ( $results as $row ) {
+                clean_post_cache( $row->post_id );
+            }
+        }
+
+        $this->upgrade_from_102();
+    }
+
+    /**
+     * Upgrade to 1.0.3
+     *
+     */
+    public function upgrade_from_102() {
+        $this->create_subscriptions_table();
+        $this->upgrade_from_118();
+    }
+
+    /**
+     * Upgrade to version 2.0.0.
+     *
+     */
+    public function upgrade_from_118() {
+        $this->create_invoices_table();
+        $this->create_invoice_items_table();
+        $this->migrate_old_invoices();
+    }
+
+    /**
+     * Upgrade to version 2.0.8.
+     *
+     */
+    public function upgrade_from_207() {
+        global $wpdb;
+        $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoice_items MODIFY COLUMN quantity FLOAT(20);" );
+        $this->upgrade_from_2615();
+    }
+
+    /**
+     * Upgrade to version 2.6.16.
+     *
+     */
+    public function upgrade_from_2615() {
+        global $wpdb;
+        $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoice_items MODIFY COLUMN item_price DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY custom_price DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY discount DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY subtotal DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY price DECIMAL(16,4) NOT NULL DEFAULT '0';" );
+        $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices MODIFY COLUMN subtotal DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY tax DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY fees_total DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY total DECIMAL(16,4) NOT NULL DEFAULT '0', MODIFY discount DECIMAL(16,4) NOT NULL DEFAULT '0';" );
+    }
+
+    /**
+     * Give administrators the capability to manage GetPaid.
+     *
+     */
+    public function add_capabilities() {
+        $GLOBALS['wp_roles']->add_cap( 'administrator', 'manage_invoicing' );
+    }
+
+    /**
+     * Retreives GetPaid pages.
+     *
+     */
+    public static function get_pages() {
+
+        return apply_filters(
+            'wpinv_create_pages',
+            array(
+
+                // Checkout page.
+                'checkout_page'             => array(
+                    'name'    => _x( 'gp-checkout', 'Page slug', 'invoicing' ),
+                    'title'   => _x( 'Checkout', 'Page title', 'invoicing' ),
+                    'content' => '
 						<!-- wp:shortcode -->
 						[wpinv_checkout]
 						<!-- /wp:shortcode -->
 					',
-					'parent'  => '',
-				),
-
-				// Invoice history page.
-				'invoice_history_page'      => array(
-					'name'    => _x( 'gp-invoices', 'Page slug', 'invoicing' ),
-					'title'   => _x( 'My Invoices', 'Page title', 'invoicing' ),
-					'content' => '
+                    'parent'  => '',
+                ),
+
+                // Invoice history page.
+                'invoice_history_page'      => array(
+                    'name'    => _x( 'gp-invoices', 'Page slug', 'invoicing' ),
+                    'title'   => _x( 'My Invoices', 'Page title', 'invoicing' ),
+                    'content' => '
 					<!-- wp:shortcode -->
 					[wpinv_history]
 					<!-- /wp:shortcode -->
 				',
-					'parent'  => '',
-				),
-
-				// Success page content.
-				'success_page'              => array(
-					'name'    => _x( 'gp-receipt', 'Page slug', 'invoicing' ),
-					'title'   => _x( 'Payment Confirmation', 'Page title', 'invoicing' ),
-					'content' => '
+                    'parent'  => '',
+                ),
+
+                // Success page content.
+                'success_page'              => array(
+                    'name'    => _x( 'gp-receipt', 'Page slug', 'invoicing' ),
+                    'title'   => _x( 'Payment Confirmation', 'Page title', 'invoicing' ),
+                    'content' => '
 					<!-- wp:shortcode -->
 					[wpinv_receipt]
 					<!-- /wp:shortcode -->
 				',
-					'parent'  => 'gp-checkout',
-				),
-
-				// Failure page content.
-				'failure_page'              => array(
-					'name'    => _x( 'gp-transaction-failed', 'Page slug', 'invoicing' ),
-					'title'   => _x( 'Transaction Failed', 'Page title', 'invoicing' ),
-					'content' => __( 'Your transaction failed, please try again or contact site support.', 'invoicing' ),
-					'parent'  => 'gp-checkout',
-				),
-
-				// Subscriptions history page.
-				'invoice_subscription_page' => array(
-					'name'    => _x( 'gp-subscriptions', 'Page slug', 'invoicing' ),
-					'title'   => _x( 'My Subscriptions', 'Page title', 'invoicing' ),
-					'content' => '
+                    'parent'  => 'gp-checkout',
+                ),
+
+                // Failure page content.
+                'failure_page'              => array(
+                    'name'    => _x( 'gp-transaction-failed', 'Page slug', 'invoicing' ),
+                    'title'   => _x( 'Transaction Failed', 'Page title', 'invoicing' ),
+                    'content' => __( 'Your transaction failed, please try again or contact site support.', 'invoicing' ),
+                    'parent'  => 'gp-checkout',
+                ),
+
+                // Subscriptions history page.
+                'invoice_subscription_page' => array(
+                    'name'    => _x( 'gp-subscriptions', 'Page slug', 'invoicing' ),
+                    'title'   => _x( 'My Subscriptions', 'Page title', 'invoicing' ),
+                    'content' => '
 					<!-- wp:shortcode -->
 					[wpinv_subscriptions]
 					<!-- /wp:shortcode -->
 				',
-					'parent'  => '',
-				),
+                    'parent'  => '',
+                ),
 
-			)
-		);
+            )
+        );
 
-	}
+    }
 
-	/**
-	 * Re-create GetPaid pages.
-	 *
-	 */
-	public function create_pages() {
+    /**
+     * Re-create GetPaid pages.
+     *
+     */
+    public function create_pages() {
 
-		foreach ( self::get_pages() as $key => $page ) {
-			wpinv_create_page( esc_sql( $page['name'] ), $key, $page['title'], $page['content'], $page['parent'] );
-		}
+        foreach ( self::get_pages() as $key => $page ) {
+            wpinv_create_page( esc_sql( $page['name'] ), $key, $page['title'], $page['content'], $page['parent'] );
+        }
 
-	}
+    }
 
-	/**
-	 * Create subscriptions table.
-	 *
-	 */
-	public function create_subscriptions_table() {
+    /**
+     * Create subscriptions table.
+     *
+     */
+    public function create_subscriptions_table() {
 
-		global $wpdb;
+        global $wpdb;
 
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
 
-		// Create tables.
-		$charset_collate = $wpdb->get_charset_collate();
-		$sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}wpinv_subscriptions (
+        // Create tables.
+        $charset_collate = $wpdb->get_charset_collate();
+        $sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}wpinv_subscriptions (
 			id bigint(20) unsigned NOT NULL auto_increment,
 			customer_id bigint(20) NOT NULL,
 			frequency int(11) NOT NULL DEFAULT '1',
@@ -273,22 +273,22 @@ 
 			KEY customer_and_status (customer_id, status)
 		  ) $charset_collate;";
 
-		dbDelta( $sql );
+        dbDelta( $sql );
 
-	}
+    }
 
-	/**
-	 * Create invoices table.
-	 *
-	 */
-	public function create_invoices_table() {
-		global $wpdb;
+    /**
+     * Create invoices table.
+     *
+     */
+    public function create_invoices_table() {
+        global $wpdb;
 
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
 
-		// Create tables.
-		$charset_collate = $wpdb->get_charset_collate();
-		$sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}getpaid_invoices (
+        // Create tables.
+        $charset_collate = $wpdb->get_charset_collate();
+        $sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}getpaid_invoices (
 			post_id BIGINT(20) NOT NULL,
             `number` VARCHAR(100),
             `key` VARCHAR(100),
@@ -324,22 +324,22 @@ 
 			KEY `key` (`key`)
 		  ) $charset_collate;";
 
-		dbDelta( $sql );
+        dbDelta( $sql );
 
-	}
+    }
 
-	/**
-	 * Create invoice items table.
-	 *
-	 */
-	public function create_invoice_items_table() {
-		global $wpdb;
+    /**
+     * Create invoice items table.
+     *
+     */
+    public function create_invoice_items_table() {
+        global $wpdb;
 
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
 
-		// Create tables.
-		$charset_collate = $wpdb->get_charset_collate();
-		$sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}getpaid_invoice_items (
+        // Create tables.
+        $charset_collate = $wpdb->get_charset_collate();
+        $sql             = "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}getpaid_invoice_items (
 			ID BIGINT(20) NOT NULL AUTO_INCREMENT,
             post_id BIGINT(20) NOT NULL,
             item_id BIGINT(20) NOT NULL,
@@ -361,159 +361,159 @@ 
 			KEY post_id (post_id)
 		  ) $charset_collate;";
 
-		dbDelta( $sql );
-
-	}
-
-	/**
-	 * Migrates old invoices to new invoices.
-	 *
-	 */
-	public function migrate_old_invoices() {
-		global $wpdb;
-
-		$invoices_table      = $wpdb->prefix . 'getpaid_invoices';
-		$invoice_items_table = $wpdb->prefix . 'getpaid_invoice_items';
-		$migrated            = $wpdb->get_col( "SELECT post_id FROM $invoices_table" );
-		$invoices            = array_unique(
-			get_posts(
-				array(
-					'post_type'      => array( 'wpi_invoice', 'wpi_quote' ),
-					'posts_per_page' => -1,
-					'fields'         => 'ids',
-					'post_status'    => array_keys( get_post_stati() ),
-					'exclude'        => (array) $migrated,
-				)
-			)
-		);
-
-		// Abort if we do not have any invoices.
-		if ( empty( $invoices ) ) {
-			return;
-		}
-
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-legacy-invoice.php';
-
-		$invoice_rows = array();
-		foreach ( $invoices as $invoice ) {
-
-			$invoice = new WPInv_Legacy_Invoice( $invoice );
-
-			if ( empty( $invoice->ID ) ) {
-				return;
-			}
-
-			$fields = array(
-				'post_id'            => $invoice->ID,
-				'number'             => $invoice->get_number(),
-				'key'                => $invoice->get_key(),
-				'type'               => str_replace( 'wpi_', '', $invoice->post_type ),
-				'mode'               => $invoice->mode,
-				'user_ip'            => $invoice->get_ip(),
-				'first_name'         => $invoice->get_first_name(),
-				'last_name'          => $invoice->get_last_name(),
-				'address'            => $invoice->get_address(),
-				'city'               => $invoice->city,
-				'state'              => $invoice->state,
-				'country'            => $invoice->country,
-				'zip'                => $invoice->zip,
-				'adddress_confirmed' => (int) $invoice->adddress_confirmed,
-				'gateway'            => $invoice->get_gateway(),
-				'transaction_id'     => $invoice->get_transaction_id(),
-				'currency'           => $invoice->get_currency(),
-				'subtotal'           => $invoice->get_subtotal(),
-				'tax'                => $invoice->get_tax(),
-				'fees_total'         => $invoice->get_fees_total(),
-				'total'              => $invoice->get_total(),
-				'discount'           => $invoice->get_discount(),
-				'discount_code'      => $invoice->get_discount_code(),
-				'disable_taxes'      => $invoice->disable_taxes,
-				'due_date'           => $invoice->get_due_date(),
-				'completed_date'     => $invoice->get_completed_date(),
-				'company'            => $invoice->company,
-				'vat_number'         => $invoice->vat_number,
-				'vat_rate'           => $invoice->vat_rate,
-				'custom_meta'        => $invoice->payment_meta,
-			);
-
-			foreach ( $fields as $key => $val ) {
-				if ( is_null( $val ) ) {
-					$val = '';
-				}
-				$val = maybe_serialize( $val );
-				$fields[ $key ] = $wpdb->prepare( '%s', $val );
-			}
-
-			$fields = implode( ', ', $fields );
-			$invoice_rows[] = "($fields)";
-
-			$item_rows    = array();
-			$item_columns = array();
-			foreach ( $invoice->get_cart_details() as $details ) {
-				$fields = array(
-					'post_id'          => $invoice->ID,
-					'item_id'          => $details['id'],
-					'item_name'        => $details['name'],
-					'item_description' => empty( $details['meta']['description'] ) ? '' : $details['meta']['description'],
-					'vat_rate'         => $details['vat_rate'],
-					'vat_class'        => empty( $details['vat_class'] ) ? '_standard' : $details['vat_class'],
-					'tax'              => $details['tax'],
-					'item_price'       => $details['item_price'],
-					'custom_price'     => $details['custom_price'],
-					'quantity'         => $details['quantity'],
-					'discount'         => $details['discount'],
-					'subtotal'         => $details['subtotal'],
-					'price'            => $details['price'],
-					'meta'             => $details['meta'],
-					'fees'             => $details['fees'],
-				);
-
-				$item_columns = array_keys( $fields );
-
-				foreach ( $fields as $key => $val ) {
-					if ( is_null( $val ) ) {
-						$val = '';
-					}
-					$val = maybe_serialize( $val );
-					$fields[ $key ] = $wpdb->prepare( '%s', $val );
-				}
-
-				$fields = implode( ', ', $fields );
-				$item_rows[] = "($fields)";
-			}
-
-			$item_rows    = implode( ', ', $item_rows );
-			$item_columns = implode( ', ', $item_columns );
-			$wpdb->query( "INSERT INTO $invoice_items_table ($item_columns) VALUES $item_rows" );
-		}
-
-		if ( empty( $invoice_rows ) ) {
-			return;
-		}
-
-		$invoice_rows = implode( ', ', $invoice_rows );
-		$wpdb->query( "INSERT INTO $invoices_table VALUES $invoice_rows" );
-
-	}
-
-	/**
-	 * Migrates old invoices to new invoices.
-	 *
-	 */
-	public static function rename_gateways_label() {
-		global $wpdb;
-
-		foreach ( array_keys( wpinv_get_payment_gateways() ) as $gateway ) {
-
-			$wpdb->update(
-				$wpdb->prefix . 'getpaid_invoices',
-				array( 'gateway' => $gateway ),
-				array( 'gateway' => wpinv_get_gateway_admin_label( $gateway ) ),
-				'%s',
-				'%s'
-			);
-
-		}
-	}
+        dbDelta( $sql );
+
+    }
+
+    /**
+     * Migrates old invoices to new invoices.
+     *
+     */
+    public function migrate_old_invoices() {
+        global $wpdb;
+
+        $invoices_table      = $wpdb->prefix . 'getpaid_invoices';
+        $invoice_items_table = $wpdb->prefix . 'getpaid_invoice_items';
+        $migrated            = $wpdb->get_col( "SELECT post_id FROM $invoices_table" );
+        $invoices            = array_unique(
+            get_posts(
+                array(
+                    'post_type'      => array( 'wpi_invoice', 'wpi_quote' ),
+                    'posts_per_page' => -1,
+                    'fields'         => 'ids',
+                    'post_status'    => array_keys( get_post_stati() ),
+                    'exclude'        => (array) $migrated,
+                )
+            )
+        );
+
+        // Abort if we do not have any invoices.
+        if ( empty( $invoices ) ) {
+            return;
+        }
+
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-legacy-invoice.php';
+
+        $invoice_rows = array();
+        foreach ( $invoices as $invoice ) {
+
+            $invoice = new WPInv_Legacy_Invoice( $invoice );
+
+            if ( empty( $invoice->ID ) ) {
+                return;
+            }
+
+            $fields = array(
+                'post_id'            => $invoice->ID,
+                'number'             => $invoice->get_number(),
+                'key'                => $invoice->get_key(),
+                'type'               => str_replace( 'wpi_', '', $invoice->post_type ),
+                'mode'               => $invoice->mode,
+                'user_ip'            => $invoice->get_ip(),
+                'first_name'         => $invoice->get_first_name(),
+                'last_name'          => $invoice->get_last_name(),
+                'address'            => $invoice->get_address(),
+                'city'               => $invoice->city,
+                'state'              => $invoice->state,
+                'country'            => $invoice->country,
+                'zip'                => $invoice->zip,
+                'adddress_confirmed' => (int) $invoice->adddress_confirmed,
+                'gateway'            => $invoice->get_gateway(),
+                'transaction_id'     => $invoice->get_transaction_id(),
+                'currency'           => $invoice->get_currency(),
+                'subtotal'           => $invoice->get_subtotal(),
+                'tax'                => $invoice->get_tax(),
+                'fees_total'         => $invoice->get_fees_total(),
+                'total'              => $invoice->get_total(),
+                'discount'           => $invoice->get_discount(),
+                'discount_code'      => $invoice->get_discount_code(),
+                'disable_taxes'      => $invoice->disable_taxes,
+                'due_date'           => $invoice->get_due_date(),
+                'completed_date'     => $invoice->get_completed_date(),
+                'company'            => $invoice->company,
+                'vat_number'         => $invoice->vat_number,
+                'vat_rate'           => $invoice->vat_rate,
+                'custom_meta'        => $invoice->payment_meta,
+            );
+
+            foreach ( $fields as $key => $val ) {
+                if ( is_null( $val ) ) {
+                    $val = '';
+                }
+                $val = maybe_serialize( $val );
+                $fields[ $key ] = $wpdb->prepare( '%s', $val );
+            }
+
+            $fields = implode( ', ', $fields );
+            $invoice_rows[] = "($fields)";
+
+            $item_rows    = array();
+            $item_columns = array();
+            foreach ( $invoice->get_cart_details() as $details ) {
+                $fields = array(
+                    'post_id'          => $invoice->ID,
+                    'item_id'          => $details['id'],
+                    'item_name'        => $details['name'],
+                    'item_description' => empty( $details['meta']['description'] ) ? '' : $details['meta']['description'],
+                    'vat_rate'         => $details['vat_rate'],
+                    'vat_class'        => empty( $details['vat_class'] ) ? '_standard' : $details['vat_class'],
+                    'tax'              => $details['tax'],
+                    'item_price'       => $details['item_price'],
+                    'custom_price'     => $details['custom_price'],
+                    'quantity'         => $details['quantity'],
+                    'discount'         => $details['discount'],
+                    'subtotal'         => $details['subtotal'],
+                    'price'            => $details['price'],
+                    'meta'             => $details['meta'],
+                    'fees'             => $details['fees'],
+                );
+
+                $item_columns = array_keys( $fields );
+
+                foreach ( $fields as $key => $val ) {
+                    if ( is_null( $val ) ) {
+                        $val = '';
+                    }
+                    $val = maybe_serialize( $val );
+                    $fields[ $key ] = $wpdb->prepare( '%s', $val );
+                }
+
+                $fields = implode( ', ', $fields );
+                $item_rows[] = "($fields)";
+            }
+
+            $item_rows    = implode( ', ', $item_rows );
+            $item_columns = implode( ', ', $item_columns );
+            $wpdb->query( "INSERT INTO $invoice_items_table ($item_columns) VALUES $item_rows" );
+        }
+
+        if ( empty( $invoice_rows ) ) {
+            return;
+        }
+
+        $invoice_rows = implode( ', ', $invoice_rows );
+        $wpdb->query( "INSERT INTO $invoices_table VALUES $invoice_rows" );
+
+    }
+
+    /**
+     * Migrates old invoices to new invoices.
+     *
+     */
+    public static function rename_gateways_label() {
+        global $wpdb;
+
+        foreach ( array_keys( wpinv_get_payment_gateways() ) as $gateway ) {
+
+            $wpdb->update(
+                $wpdb->prefix . 'getpaid_invoices',
+                array( 'gateway' => $gateway ),
+                array( 'gateway' => wpinv_get_gateway_admin_label( $gateway ) ),
+                '%s',
+                '%s'
+            );
+
+        }
+    }
 
 }

includes/reports/class-getpaid-reports-export.php

Indentation +188 added lines, -188 removed lines

@@ -12,47 +12,47 @@ 
  */
 class GetPaid_Reports_Export {
 
-	/**
-	 * Displays the reports tab.
-	 *
-	 */
-	public function display() {
-
-		echo "<div class='row mt-4' style='max-width: 920px;' >";
-		foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
-			$this->display_post_type_export( $post_type );
-		}
-		$this->display_subscription_export();
-		echo '</div>';
-
-	}
-
-	/**
-	 * Retrieves the download url.
-	 *
-	 */
-	public function get_download_url( $post_type ) {
-
-		return wp_nonce_url(
-			add_query_arg(
-				array(
-					'getpaid-admin-action' => 'export_invoices',
-					'post_type'            => urlencode( $post_type ),
-				)
-			),
-			'getpaid-nonce',
-			'getpaid-nonce'
-		);
-
-	}
-
-	/**
-	 * Displays a single post type export card.
-	 *
-	 */
-	public function display_post_type_export( $post_type ) {
-
-		?>
+    /**
+     * Displays the reports tab.
+     *
+     */
+    public function display() {
+
+        echo "<div class='row mt-4' style='max-width: 920px;' >";
+        foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
+            $this->display_post_type_export( $post_type );
+        }
+        $this->display_subscription_export();
+        echo '</div>';
+
+    }
+
+    /**
+     * Retrieves the download url.
+     *
+     */
+    public function get_download_url( $post_type ) {
+
+        return wp_nonce_url(
+            add_query_arg(
+                array(
+                    'getpaid-admin-action' => 'export_invoices',
+                    'post_type'            => urlencode( $post_type ),
+                )
+            ),
+            'getpaid-nonce',
+            'getpaid-nonce'
+        );
+
+    }
+
+    /**
+     * Displays a single post type export card.
+     *
+     */
+    public function display_post_type_export( $post_type ) {
+
+        ?>
 
 		<div class="col-12 col-md-6">
 			<div class="card m-0 p-0" style="max-width:100%">
@@ -60,11 +60,11 @@ 
 				<div class="card-header">
 					<strong>
 						<?php
-							printf(
-								esc_html__( 'Export %s', 'invoicing' ),
-								esc_html( getpaid_get_post_type_label( $post_type ) )
-							);
-						?>
+                            printf(
+                                esc_html__( 'Export %s', 'invoicing' ),
+                                esc_html( getpaid_get_post_type_label( $post_type ) )
+                            );
+                        ?>
 					</strong>
 				</div>
 
@@ -73,12 +73,12 @@ 
 					<form method="post" action="<?php echo esc_url( $this->get_download_url( $post_type ) ); ?>">
 
 						<?php
-							$this->generate_from_date( $post_type );
-							$this->generate_to_date( $post_type );
-							$this->generate_post_status_select( $post_type );
-							$this->generate_file_type_select( $post_type );
-							submit_button( __( 'Download', 'invoicing' ) );
-						?>
+                            $this->generate_from_date( $post_type );
+                            $this->generate_to_date( $post_type );
+                            $this->generate_post_status_select( $post_type );
+                            $this->generate_file_type_select( $post_type );
+                            submit_button( __( 'Download', 'invoicing' ) );
+                        ?>
 
 					</form>
 
@@ -89,135 +89,135 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Generates the from date input field.
-	 *
-	 */
-	public function generate_from_date( $post_type ) {
-
-		aui()->input(
-			array(
-				'type'             => 'datepicker',
-				'id'               => esc_attr( "$post_type-from_date" ),
-				'name'             => 'from_date',
-				'label'            => __( 'From Date', 'invoicing' ),
-				'label_type'       => 'vertical',
-				'placeholder'      => 'YYYY-MM-DD',
-				'extra_attributes' => array(
-					'data-enable-time' => 'false',
-					'data-allow-input' => 'true',
-				),
-			),
-			true
-		);
-
-	}
-
-	/**
-	 * Generates the to date input field.
-	 *
-	 */
-	public function generate_to_date( $post_type ) {
-
-		aui()->input(
-			array(
-				'type'             => 'datepicker',
-				'id'               => esc_attr( "$post_type-to_date" ),
-				'name'             => 'to_date',
-				'label'            => __( 'To Date', 'invoicing' ),
-				'label_type'       => 'vertical',
-				'placeholder'      => 'YYYY-MM-DD',
-				'extra_attributes' => array(
-					'data-enable-time' => 'false',
-					'data-allow-input' => 'true',
-				),
-			),
-			true
-		);
-	}
-
-	/**
-	 * Generates the to post status select field.
-	 *
-	 */
-	public function generate_post_status_select( $post_type ) {
-
-		if ( 'subscriptions' === $post_type ) {
-			$options = getpaid_get_subscription_statuses();
-		} else {
-			$options = wpinv_get_invoice_statuses( true, false, $post_type );
-		}
-
-		aui()->select(
-			array(
-				'name'        => 'status',
-				'id'          => esc_attr( "$post_type-status" ),
-				'placeholder' => __( 'All Statuses', 'invoicing' ),
-				'label'       => __( 'Status', 'invoicing' ),
-				'label_type'  => 'vertical',
-				'label_class' => 'd-block',
-				'options'     => $options,
-			),
-			true
-		);
-
-	}
-
-	/**
-	 * Generates the to file type select field.
-	 *
-	 */
-	public function generate_file_type_select( $post_type ) {
-
-		aui()->select(
-			array(
-				'name'        => 'file_type',
-				'id'          => esc_attr( "$post_type-file_type" ),
-				'placeholder' => __( 'Select File Type', 'invoicing' ),
-				'label'       => __( 'Export File', 'invoicing' ),
-				'label_type'  => 'vertical',
-				'label_class' => 'd-block',
-				'value'       => 'csv',
-				'options'     => array(
-					'csv'  => __( 'CSV', 'invoicing' ),
-					'xml'  => __( 'XML', 'invoicing' ),
-					'json' => __( 'JSON', 'invoicing' ),
-				),
-			),
-			true
-		);
-
-	}
-
-	/**
-	 * Displays a field's markup.
-	 *
-	 */
-	public function display_markup( $markup ) {
-
-		echo wp_kses(
-			str_replace(
-				array(
-					'form-control',
-					'custom-select',
-				),
-				'regular-text',
-				$markup
-			),
-			getpaid_allowed_html()
-		);
-
-	}
-
-	/**
-	 * Displays a subscription export card.
-	 *
-	 */
-	public function display_subscription_export() {
-
-		?>
+    }
+
+    /**
+     * Generates the from date input field.
+     *
+     */
+    public function generate_from_date( $post_type ) {
+
+        aui()->input(
+            array(
+                'type'             => 'datepicker',
+                'id'               => esc_attr( "$post_type-from_date" ),
+                'name'             => 'from_date',
+                'label'            => __( 'From Date', 'invoicing' ),
+                'label_type'       => 'vertical',
+                'placeholder'      => 'YYYY-MM-DD',
+                'extra_attributes' => array(
+                    'data-enable-time' => 'false',
+                    'data-allow-input' => 'true',
+                ),
+            ),
+            true
+        );
+
+    }
+
+    /**
+     * Generates the to date input field.
+     *
+     */
+    public function generate_to_date( $post_type ) {
+
+        aui()->input(
+            array(
+                'type'             => 'datepicker',
+                'id'               => esc_attr( "$post_type-to_date" ),
+                'name'             => 'to_date',
+                'label'            => __( 'To Date', 'invoicing' ),
+                'label_type'       => 'vertical',
+                'placeholder'      => 'YYYY-MM-DD',
+                'extra_attributes' => array(
+                    'data-enable-time' => 'false',
+                    'data-allow-input' => 'true',
+                ),
+            ),
+            true
+        );
+    }
+
+    /**
+     * Generates the to post status select field.
+     *
+     */
+    public function generate_post_status_select( $post_type ) {
+
+        if ( 'subscriptions' === $post_type ) {
+            $options = getpaid_get_subscription_statuses();
+        } else {
+            $options = wpinv_get_invoice_statuses( true, false, $post_type );
+        }
+
+        aui()->select(
+            array(
+                'name'        => 'status',
+                'id'          => esc_attr( "$post_type-status" ),
+                'placeholder' => __( 'All Statuses', 'invoicing' ),
+                'label'       => __( 'Status', 'invoicing' ),
+                'label_type'  => 'vertical',
+                'label_class' => 'd-block',
+                'options'     => $options,
+            ),
+            true
+        );
+
+    }
+
+    /**
+     * Generates the to file type select field.
+     *
+     */
+    public function generate_file_type_select( $post_type ) {
+
+        aui()->select(
+            array(
+                'name'        => 'file_type',
+                'id'          => esc_attr( "$post_type-file_type" ),
+                'placeholder' => __( 'Select File Type', 'invoicing' ),
+                'label'       => __( 'Export File', 'invoicing' ),
+                'label_type'  => 'vertical',
+                'label_class' => 'd-block',
+                'value'       => 'csv',
+                'options'     => array(
+                    'csv'  => __( 'CSV', 'invoicing' ),
+                    'xml'  => __( 'XML', 'invoicing' ),
+                    'json' => __( 'JSON', 'invoicing' ),
+                ),
+            ),
+            true
+        );
+
+    }
+
+    /**
+     * Displays a field's markup.
+     *
+     */
+    public function display_markup( $markup ) {
+
+        echo wp_kses(
+            str_replace(
+                array(
+                    'form-control',
+                    'custom-select',
+                ),
+                'regular-text',
+                $markup
+            ),
+            getpaid_allowed_html()
+        );
+
+    }
+
+    /**
+     * Displays a subscription export card.
+     *
+     */
+    public function display_subscription_export() {
+
+        ?>
 
 		<div class="col-12 col-md-6">
 			<div class="card m-0 p-0" style="max-width:100%">
@@ -233,12 +233,12 @@ 
 					<form method="post" action="<?php echo esc_url( $this->get_download_url( 'subscriptions' ) ); ?>">
 
 						<?php
-							$this->generate_from_date( 'subscriptions' );
-							$this->generate_to_date( 'subscriptions' );
-							$this->generate_post_status_select( 'subscriptions' );
-							$this->generate_file_type_select( 'subscriptions' );
-							submit_button( __( 'Download', 'invoicing' ) );
-						?>
+                            $this->generate_from_date( 'subscriptions' );
+                            $this->generate_to_date( 'subscriptions' );
+                            $this->generate_post_status_select( 'subscriptions' );
+                            $this->generate_file_type_select( 'subscriptions' );
+                            submit_button( __( 'Download', 'invoicing' ) );
+                        ?>
 
 					</form>
 
@@ -249,6 +249,6 @@ 
 
 		<?php
 
-	}
+    }
 
 }

includes/class-getpaid-subscriptions-query.php

Indentation +505 added lines, -505 removed lines

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

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

Indentation +222 added lines, -222 removed lines

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

includes/wpinv-helper-functions.php

Indentation +65 added lines, -65 removed lines

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

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

Indentation +468 added lines, -468 removed lines

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

includes/class-wpinv-ajax.php

Indentation +64 added lines, -64 removed lines

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

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

Indentation +232 added lines, -232 removed lines

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

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 );
 
-	}
+    }
 }