AyeCode / invoicing

includes/admin/class-getpaid-installer.php

Indentation +369 added lines, -369 removed lines

@@ -20,222 +20,222 @@ 
  */
 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";
-
-		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);" );
-	}
-
-	/**
-	 * 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";
+
+        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);" );
+    }
+
+    /**
+     * 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',
@@ -258,22 +258,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),
@@ -309,22 +309,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,
@@ -346,159 +346,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/wpinv-gateway-functions.php

Indentation +28 added lines, -28 removed lines

@@ -276,26 +276,26 @@ 
 }
 
 function wpinv_get_chosen_gateway( $invoice_id = 0 ) {
-	$gateways = array_keys( wpinv_get_enabled_payment_gateways() );
+    $gateways = array_keys( wpinv_get_enabled_payment_gateways() );
 
     $chosen = false;
     if ( $invoice_id > 0 && $invoice = wpinv_get_invoice( $invoice_id ) ) {
         $chosen = $invoice->get_gateway();
     }
 
-	$chosen   = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen;
+    $chosen   = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen;
 
-	if ( false !== $chosen ) {
-		$chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen );
-	}
+    if ( false !== $chosen ) {
+        $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen );
+    }
 
-	if ( ! empty ( $chosen ) ) {
-		$enabled_gateway = urldecode( $chosen );
-	} else if (  !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) {
-		$enabled_gateway = 'manual';
-	} else {
-		$enabled_gateway = wpinv_get_default_gateway();
-	}
+    if ( ! empty ( $chosen ) ) {
+        $enabled_gateway = urldecode( $chosen );
+    } else if (  !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) {
+        $enabled_gateway = 'manual';
+    } else {
+        $enabled_gateway = wpinv_get_default_gateway();
+    }
 
     if ( !wpinv_is_gateway_active( $enabled_gateway ) && !empty( $gateways ) ) {
         if(wpinv_is_gateway_active( wpinv_get_default_gateway()) ){
@@ -306,7 +306,7 @@ 
 
     }
 
-	return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway );
+    return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway );
 }
 
 function wpinv_record_gateway_error( $title = '', $message = '' ) {
@@ -314,21 +314,21 @@ 
 }
 
 function wpinv_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) {
-	$ret  = 0;
-	$args = array(
-		'meta_key'    => '_wpinv_gateway',
-		'meta_value'  => $gateway_id,
-		'nopaging'    => true,
-		'post_type'   => 'wpi_invoice',
-		'post_status' => $status,
-		'fields'      => 'ids'
-	);
-
-	$payments = new WP_Query( $args );
-
-	if( $payments )
-		$ret = $payments->post_count;
-	return $ret;
+    $ret  = 0;
+    $args = array(
+        'meta_key'    => '_wpinv_gateway',
+        'meta_value'  => $gateway_id,
+        'nopaging'    => true,
+        'post_type'   => 'wpi_invoice',
+        'post_status' => $status,
+        'fields'      => 'ids'
+    );
+
+    $payments = new WP_Query( $args );
+
+    if( $payments )
+        $ret = $payments->post_count;
+    return $ret;
 }
 
 /**

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

Indentation +610 added lines, -610 removed lines

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

includes/class-getpaid-post-types.php

Indentation +305 added lines, -305 removed lines

@@ -15,331 +15,331 @@
 class GetPaid_Post_Types {
 
     /**
-	 * Hook in methods.
-	 */
-	public function __construct() {
-		add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 );
-		add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 );
-		add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) );
-		add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) );
-	}
+     * Hook in methods.
+     */
+    public function __construct() {
+        add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 );
+        add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 );
+        add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) );
+        add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) );
+    }
 
-	/**
-	 * Register core post types.
-	 */
-	public static function register_post_types() {
+    /**
+     * Register core post types.
+     */
+    public static function register_post_types() {
 
-		if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) {
-			return;
-		}
+        if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) {
+            return;
+        }
 
-		$capabilities = wpinv_current_user_can_manage_invoicing();
+        $capabilities = wpinv_current_user_can_manage_invoicing();
 
-		// Fires before registering post types.
-		do_action( 'getpaid_register_post_types' );
+        // Fires before registering post types.
+        do_action( 'getpaid_register_post_types' );
 
-		// Register item post type.
-		register_post_type(
-			'wpi_item',
-			apply_filters(
-				'wpinv_register_post_type_invoice_item',
-				array(
-					'labels'             => array(
-						'name'               => _x( 'Items', 'post type general name', 'invoicing' ),
-						'singular_name'      => _x( 'Item', 'post type singular name', 'invoicing' ),
-						'menu_name'          => _x( 'Items', 'admin menu', 'invoicing' ),
-						'name_admin_bar'     => _x( 'Item', 'add new on admin bar', 'invoicing' ),
-						'add_new'            => _x( 'Add New', 'Item', 'invoicing' ),
-						'add_new_item'       => __( 'Add New Item', 'invoicing' ),
-						'new_item'           => __( 'New Item', 'invoicing' ),
-						'edit_item'          => __( 'Edit Item', 'invoicing' ),
-						'view_item'          => __( 'View Item', 'invoicing' ),
-						'all_items'          => __( 'Items', 'invoicing' ),
-						'search_items'       => __( 'Search items', 'invoicing' ),
-						'parent_item_colon'  => __( 'Parent item:', 'invoicing' ),
-						'not_found'          => __( 'No items found.', 'invoicing' ),
-						'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' )
-					),
-					'description'           => __( 'This is where you can add new invoice items.', 'invoicing' ),
-					'public'                => false,
-					'has_archive'           => false,
-					'_builtin'              => false,
-					'show_ui'               => true,
-					'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'show_in_nav_menus'     => false,
-					'supports'              => array( 'title', 'excerpt', 'thumbnail' ),
-					'rewrite'               => false,
-					'query_var'             => false,
-					'map_meta_cap'          => true,
-					'show_in_admin_bar'     => true,
-					'can_export'            => true,
-				)
-			)
-		);
+        // Register item post type.
+        register_post_type(
+            'wpi_item',
+            apply_filters(
+                'wpinv_register_post_type_invoice_item',
+                array(
+                    'labels'             => array(
+                        'name'               => _x( 'Items', 'post type general name', 'invoicing' ),
+                        'singular_name'      => _x( 'Item', 'post type singular name', 'invoicing' ),
+                        'menu_name'          => _x( 'Items', 'admin menu', 'invoicing' ),
+                        'name_admin_bar'     => _x( 'Item', 'add new on admin bar', 'invoicing' ),
+                        'add_new'            => _x( 'Add New', 'Item', 'invoicing' ),
+                        'add_new_item'       => __( 'Add New Item', 'invoicing' ),
+                        'new_item'           => __( 'New Item', 'invoicing' ),
+                        'edit_item'          => __( 'Edit Item', 'invoicing' ),
+                        'view_item'          => __( 'View Item', 'invoicing' ),
+                        'all_items'          => __( 'Items', 'invoicing' ),
+                        'search_items'       => __( 'Search items', 'invoicing' ),
+                        'parent_item_colon'  => __( 'Parent item:', 'invoicing' ),
+                        'not_found'          => __( 'No items found.', 'invoicing' ),
+                        'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' )
+                    ),
+                    'description'           => __( 'This is where you can add new invoice items.', 'invoicing' ),
+                    'public'                => false,
+                    'has_archive'           => false,
+                    '_builtin'              => false,
+                    'show_ui'               => true,
+                    'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'show_in_nav_menus'     => false,
+                    'supports'              => array( 'title', 'excerpt', 'thumbnail' ),
+                    'rewrite'               => false,
+                    'query_var'             => false,
+                    'map_meta_cap'          => true,
+                    'show_in_admin_bar'     => true,
+                    'can_export'            => true,
+                )
+            )
+        );
 
-		// Register payment form post type.
-		register_post_type(
-			'wpi_payment_form',
-			apply_filters(
-				'wpinv_register_post_type_payment_form',
-				array(
-					'labels'             => array(
-						'name'               => _x( 'Payment Forms', 'post type general name', 'invoicing' ),
-						'singular_name'      => _x( 'Payment Form', 'post type singular name', 'invoicing' ),
-						'menu_name'          => _x( 'Payment Forms', 'admin menu', 'invoicing' ),
-						'name_admin_bar'     => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ),
-						'add_new'            => _x( 'Add New', 'Payment Form', 'invoicing' ),
-						'add_new_item'       => __( 'Add New Payment Form', 'invoicing' ),
-						'new_item'           => __( 'New Payment Form', 'invoicing' ),
-						'edit_item'          => __( 'Edit Payment Form', 'invoicing' ),
-						'view_item'          => __( 'View Payment Form', 'invoicing' ),
-						'all_items'          => __( 'Payment Forms', 'invoicing' ),
-						'search_items'       => __( 'Search Payment Forms', 'invoicing' ),
-						'parent_item_colon'  => __( 'Parent Payment Forms:', 'invoicing' ),
-						'not_found'          => __( 'No payment forms found.', 'invoicing' ),
-						'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' )
-					),
-					'description'        => __( 'Add new payment forms.', 'invoicing' ),
-					'public'             => false,
-					'show_ui'            => true,
-					'show_in_menu'       => $capabilities ? 'wpinv' : true,
-					'show_in_nav_menus'  => false,
-					'query_var'          => false,
-					'rewrite'            => true,
-					'map_meta_cap'       => true,
-					'has_archive'        => false,
-					'hierarchical'       => false,
-					'menu_position'      => null,
-					'supports'           => array( 'title' ),
-					'menu_icon'          => 'dashicons-media-form',
-					'capabilities' => array(
-						'edit_post'          => $capabilities,
-						'read_post'          => $capabilities,
-						'delete_post'        => $capabilities,
-						'edit_posts'         => 'update_core',
-						'edit_others_posts'  => 'update_core',
-						'delete_posts'       => 'update_core',
-						'publish_posts'      => 'update_core',
-						'read_private_posts' => 'update_core'
-					),
-				)
-			)
-		);
+        // Register payment form post type.
+        register_post_type(
+            'wpi_payment_form',
+            apply_filters(
+                'wpinv_register_post_type_payment_form',
+                array(
+                    'labels'             => array(
+                        'name'               => _x( 'Payment Forms', 'post type general name', 'invoicing' ),
+                        'singular_name'      => _x( 'Payment Form', 'post type singular name', 'invoicing' ),
+                        'menu_name'          => _x( 'Payment Forms', 'admin menu', 'invoicing' ),
+                        'name_admin_bar'     => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ),
+                        'add_new'            => _x( 'Add New', 'Payment Form', 'invoicing' ),
+                        'add_new_item'       => __( 'Add New Payment Form', 'invoicing' ),
+                        'new_item'           => __( 'New Payment Form', 'invoicing' ),
+                        'edit_item'          => __( 'Edit Payment Form', 'invoicing' ),
+                        'view_item'          => __( 'View Payment Form', 'invoicing' ),
+                        'all_items'          => __( 'Payment Forms', 'invoicing' ),
+                        'search_items'       => __( 'Search Payment Forms', 'invoicing' ),
+                        'parent_item_colon'  => __( 'Parent Payment Forms:', 'invoicing' ),
+                        'not_found'          => __( 'No payment forms found.', 'invoicing' ),
+                        'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' )
+                    ),
+                    'description'        => __( 'Add new payment forms.', 'invoicing' ),
+                    'public'             => false,
+                    'show_ui'            => true,
+                    'show_in_menu'       => $capabilities ? 'wpinv' : true,
+                    'show_in_nav_menus'  => false,
+                    'query_var'          => false,
+                    'rewrite'            => true,
+                    'map_meta_cap'       => true,
+                    'has_archive'        => false,
+                    'hierarchical'       => false,
+                    'menu_position'      => null,
+                    'supports'           => array( 'title' ),
+                    'menu_icon'          => 'dashicons-media-form',
+                    'capabilities' => array(
+                        'edit_post'          => $capabilities,
+                        'read_post'          => $capabilities,
+                        'delete_post'        => $capabilities,
+                        'edit_posts'         => 'update_core',
+                        'edit_others_posts'  => 'update_core',
+                        'delete_posts'       => 'update_core',
+                        'publish_posts'      => 'update_core',
+                        'read_private_posts' => 'update_core'
+                    ),
+                )
+            )
+        );
 
-		// Register invoice post type.
-		register_post_type(
-			'wpi_invoice',
-			apply_filters(
-				'wpinv_register_post_type_invoice',
-				array(
-					'labels'                 => array(
-						'name'                  => __( 'Invoices', 'invoicing' ),
-						'singular_name'         => __( 'Invoice', 'invoicing' ),
-						'all_items'             => __( 'Invoices', 'invoicing' ),
-						'menu_name'             => _x( 'Invoices', 'Admin menu name', 'invoicing' ),
-						'add_new'               => __( 'Add New', 'invoicing' ),
-						'add_new_item'          => __( 'Add new invoice', 'invoicing' ),
-						'edit'                  => __( 'Edit', 'invoicing' ),
-						'edit_item'             => __( 'Edit invoice', 'invoicing' ),
-						'new_item'              => __( 'New invoice', 'invoicing' ),
-						'view_item'             => __( 'View invoice', 'invoicing' ),
-						'view_items'            => __( 'View Invoices', 'invoicing' ),
-						'search_items'          => __( 'Search invoices', 'invoicing' ),
-						'not_found'             => __( 'No invoices found', 'invoicing' ),
-						'not_found_in_trash'    => __( 'No invoices found in trash', 'invoicing' ),
-						'parent'                => __( 'Parent invoice', 'invoicing' ),
-						'featured_image'        => __( 'Invoice image', 'invoicing' ),
-						'set_featured_image'    => __( 'Set invoice image', 'invoicing' ),
-						'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ),
-						'use_featured_image'    => __( 'Use as invoice image', 'invoicing' ),
-						'insert_into_item'      => __( 'Insert into invoice', 'invoicing' ),
-						'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ),
-						'filter_items_list'     => __( 'Filter invoices', 'invoicing' ),
-						'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ),
-						'items_list'            => __( 'Invoices list', 'invoicing' ),
-					),
-					'description'           => __( 'This is where invoices are stored.', 'invoicing' ),
-					'public'                => true,
-					'has_archive'           => false,
-					'publicly_queryable'    => true,
-        			'exclude_from_search'   => true,
-        			'show_ui'               => true,
-					'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'show_in_nav_menus'     => false,
-					'supports'              => array( 'title', 'author', 'excerpt'  ),
-					'rewrite'               => array(
-						'slug'              => 'invoice',
-						'with_front'        => false,
-					),
-					'query_var'             => false,
-					'map_meta_cap'          => true,
-					'show_in_admin_bar'     => true,
-					'can_export'            => true,
-					'hierarchical'          => false,
-					'menu_position'         => null,
-					'menu_icon'             => 'dashicons-media-spreadsheet',
-				)
-			)
-		);
+        // Register invoice post type.
+        register_post_type(
+            'wpi_invoice',
+            apply_filters(
+                'wpinv_register_post_type_invoice',
+                array(
+                    'labels'                 => array(
+                        'name'                  => __( 'Invoices', 'invoicing' ),
+                        'singular_name'         => __( 'Invoice', 'invoicing' ),
+                        'all_items'             => __( 'Invoices', 'invoicing' ),
+                        'menu_name'             => _x( 'Invoices', 'Admin menu name', 'invoicing' ),
+                        'add_new'               => __( 'Add New', 'invoicing' ),
+                        'add_new_item'          => __( 'Add new invoice', 'invoicing' ),
+                        'edit'                  => __( 'Edit', 'invoicing' ),
+                        'edit_item'             => __( 'Edit invoice', 'invoicing' ),
+                        'new_item'              => __( 'New invoice', 'invoicing' ),
+                        'view_item'             => __( 'View invoice', 'invoicing' ),
+                        'view_items'            => __( 'View Invoices', 'invoicing' ),
+                        'search_items'          => __( 'Search invoices', 'invoicing' ),
+                        'not_found'             => __( 'No invoices found', 'invoicing' ),
+                        'not_found_in_trash'    => __( 'No invoices found in trash', 'invoicing' ),
+                        'parent'                => __( 'Parent invoice', 'invoicing' ),
+                        'featured_image'        => __( 'Invoice image', 'invoicing' ),
+                        'set_featured_image'    => __( 'Set invoice image', 'invoicing' ),
+                        'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ),
+                        'use_featured_image'    => __( 'Use as invoice image', 'invoicing' ),
+                        'insert_into_item'      => __( 'Insert into invoice', 'invoicing' ),
+                        'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ),
+                        'filter_items_list'     => __( 'Filter invoices', 'invoicing' ),
+                        'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ),
+                        'items_list'            => __( 'Invoices list', 'invoicing' ),
+                    ),
+                    'description'           => __( 'This is where invoices are stored.', 'invoicing' ),
+                    'public'                => true,
+                    'has_archive'           => false,
+                    'publicly_queryable'    => true,
+                    'exclude_from_search'   => true,
+                    'show_ui'               => true,
+                    'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'show_in_nav_menus'     => false,
+                    'supports'              => array( 'title', 'author', 'excerpt'  ),
+                    'rewrite'               => array(
+                        'slug'              => 'invoice',
+                        'with_front'        => false,
+                    ),
+                    'query_var'             => false,
+                    'map_meta_cap'          => true,
+                    'show_in_admin_bar'     => true,
+                    'can_export'            => true,
+                    'hierarchical'          => false,
+                    'menu_position'         => null,
+                    'menu_icon'             => 'dashicons-media-spreadsheet',
+                )
+            )
+        );
 
-		// Register discount post type.
-		register_post_type(
-			'wpi_discount',
-			apply_filters(
-				'wpinv_register_post_type_discount',
-				array(
-					'labels'                 => array(
-						'name'                  => __( 'Discounts', 'invoicing' ),
-						'singular_name'         => __( 'Discount', 'invoicing' ),
-						'all_items'             => __( 'Discounts', 'invoicing' ),
-						'menu_name'             => _x( 'Discounts', 'Admin menu name', 'invoicing' ),
-						'add_new'               => __( 'Add New', 'invoicing' ),
-						'add_new_item'          => __( 'Add new discount', 'invoicing' ),
-						'edit'                  => __( 'Edit', 'invoicing' ),
-						'edit_item'             => __( 'Edit discount', 'invoicing' ),
-						'new_item'              => __( 'New discount', 'invoicing' ),
-						'view_item'             => __( 'View discount', 'invoicing' ),
-						'view_items'            => __( 'View Discounts', 'invoicing' ),
-						'search_items'          => __( 'Search discounts', 'invoicing' ),
-						'not_found'             => __( 'No discounts found', 'invoicing' ),
-						'not_found_in_trash'    => __( 'No discounts found in trash', 'invoicing' ),
-						'parent'                => __( 'Parent discount', 'invoicing' ),
-						'featured_image'        => __( 'Discount image', 'invoicing' ),
-						'set_featured_image'    => __( 'Set discount image', 'invoicing' ),
-						'remove_featured_image' => __( 'Remove discount image', 'invoicing' ),
-						'use_featured_image'    => __( 'Use as discount image', 'invoicing' ),
-						'insert_into_item'      => __( 'Insert into discount', 'invoicing' ),
-						'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ),
-						'filter_items_list'     => __( 'Filter discounts', 'invoicing' ),
-						'items_list_navigation' => __( 'Discount navigation', 'invoicing' ),
-						'items_list'            => __( 'Discounts list', 'invoicing' ),
-					),
-					'description'        => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ),
-					'public'             => false,
-					'can_export'         => true,
-					'_builtin'           => false,
-					'publicly_queryable' => false,
-					'exclude_from_search'=> true,
-					'show_ui'            => true,
-					'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'query_var'          => false,
-					'rewrite'            => false,
-					'map_meta_cap'       => true,
-					'has_archive'        => false,
-					'hierarchical'       => false,
-					'supports'           => array( 'title', 'excerpt' ),
-					'show_in_nav_menus'  => false,
-					'show_in_admin_bar'  => true,
-					'menu_position'      => null,
-				)
-			)
-		);
+        // Register discount post type.
+        register_post_type(
+            'wpi_discount',
+            apply_filters(
+                'wpinv_register_post_type_discount',
+                array(
+                    'labels'                 => array(
+                        'name'                  => __( 'Discounts', 'invoicing' ),
+                        'singular_name'         => __( 'Discount', 'invoicing' ),
+                        'all_items'             => __( 'Discounts', 'invoicing' ),
+                        'menu_name'             => _x( 'Discounts', 'Admin menu name', 'invoicing' ),
+                        'add_new'               => __( 'Add New', 'invoicing' ),
+                        'add_new_item'          => __( 'Add new discount', 'invoicing' ),
+                        'edit'                  => __( 'Edit', 'invoicing' ),
+                        'edit_item'             => __( 'Edit discount', 'invoicing' ),
+                        'new_item'              => __( 'New discount', 'invoicing' ),
+                        'view_item'             => __( 'View discount', 'invoicing' ),
+                        'view_items'            => __( 'View Discounts', 'invoicing' ),
+                        'search_items'          => __( 'Search discounts', 'invoicing' ),
+                        'not_found'             => __( 'No discounts found', 'invoicing' ),
+                        'not_found_in_trash'    => __( 'No discounts found in trash', 'invoicing' ),
+                        'parent'                => __( 'Parent discount', 'invoicing' ),
+                        'featured_image'        => __( 'Discount image', 'invoicing' ),
+                        'set_featured_image'    => __( 'Set discount image', 'invoicing' ),
+                        'remove_featured_image' => __( 'Remove discount image', 'invoicing' ),
+                        'use_featured_image'    => __( 'Use as discount image', 'invoicing' ),
+                        'insert_into_item'      => __( 'Insert into discount', 'invoicing' ),
+                        'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ),
+                        'filter_items_list'     => __( 'Filter discounts', 'invoicing' ),
+                        'items_list_navigation' => __( 'Discount navigation', 'invoicing' ),
+                        'items_list'            => __( 'Discounts list', 'invoicing' ),
+                    ),
+                    'description'        => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ),
+                    'public'             => false,
+                    'can_export'         => true,
+                    '_builtin'           => false,
+                    'publicly_queryable' => false,
+                    'exclude_from_search'=> true,
+                    'show_ui'            => true,
+                    'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'query_var'          => false,
+                    'rewrite'            => false,
+                    'map_meta_cap'       => true,
+                    'has_archive'        => false,
+                    'hierarchical'       => false,
+                    'supports'           => array( 'title', 'excerpt' ),
+                    'show_in_nav_menus'  => false,
+                    'show_in_admin_bar'  => true,
+                    'menu_position'      => null,
+                )
+            )
+        );
 
-		do_action( 'getpaid_after_register_post_types' );
-	}
+        do_action( 'getpaid_after_register_post_types' );
+    }
 
-	/**
-	 * Register our custom post statuses.
-	 */
-	public static function register_post_status() {
+    /**
+     * Register our custom post statuses.
+     */
+    public static function register_post_status() {
 
-		$invoice_statuses = apply_filters(
-			'getpaid_register_invoice_post_statuses',
-			array(
+        $invoice_statuses = apply_filters(
+            'getpaid_register_invoice_post_statuses',
+            array(
 
-				'wpi-pending' => array(
-					'label'                     => _x( 'Pending Payment', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-pending' => array(
+                    'label'                     => _x( 'Pending Payment', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-processing' => array(
-					'label'                     => _x( 'Processing', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-processing' => array(
+                    'label'                     => _x( 'Processing', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-onhold' => array(
-					'label'                     => _x( 'On Hold', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-onhold' => array(
+                    'label'                     => _x( 'On Hold', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-cancelled' => array(
-					'label'                     => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-cancelled' => array(
+                    'label'                     => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-refunded' => array(
-					'label'                     => _x( 'Refunded', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-refunded' => array(
+                    'label'                     => _x( 'Refunded', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-failed' => array(
-					'label'                     => _x( 'Failed', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-failed' => array(
+                    'label'                     => _x( 'Failed', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-renewal' => array(
-					'label'                     => _x( 'Renewal', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' )
-				)
-			)
-		);
+                'wpi-renewal' => array(
+                    'label'                     => _x( 'Renewal', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' )
+                )
+            )
+        );
 
-		foreach ( $invoice_statuses as $invoice_statuse => $args ) {
-			register_post_status( $invoice_statuse, $args );
-		}
-	}
+        foreach ( $invoice_statuses as $invoice_statuse => $args ) {
+            register_post_status( $invoice_statuse, $args );
+        }
+    }
 
-	/**
-	 * Flush rewrite rules.
-	 */
-	public static function flush_rewrite_rules() {
-		flush_rewrite_rules();
-	}
+    /**
+     * Flush rewrite rules.
+     */
+    public static function flush_rewrite_rules() {
+        flush_rewrite_rules();
+    }
 
-	/**
-	 * Flush rules to prevent 404.
-	 *
-	 */
-	public static function maybe_flush_rewrite_rules() {
-		if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) {
-			update_option( 'getpaid_flushed_rewrite_rules', '1' );
-			self::flush_rewrite_rules();
-		}
-	}
+    /**
+     * Flush rules to prevent 404.
+     *
+     */
+    public static function maybe_flush_rewrite_rules() {
+        if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) {
+            update_option( 'getpaid_flushed_rewrite_rules', '1' );
+            self::flush_rewrite_rules();
+        }
+    }
 
 }

includes/payments/class-getpaid-payment-form.php

Indentation +584 added lines, -584 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,55 +10,55 @@ 
 class GetPaid_Payment_Form extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'payment_form';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'payment_form';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'payment_form';
 
     /**
-	 * Form Data array. This is the core form data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Form Data array. This is the core form data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'author'               => 1,
         'elements'             => null,
-		'items'                => null,
-		'earned'               => 0,
-		'refunded'             => 0,
-		'cancelled'            => 0,
-		'failed'               => 0,
-	);
-
-    /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_forms';
-
-	/**
-	 * Stores a reference to the invoice if the form is for an invoice..
-	 *
-	 * @var WPInv_Invoice
-	 */
-	public $invoice = 0;
+        'items'                => null,
+        'earned'               => 0,
+        'refunded'             => 0,
+        'cancelled'            => 0,
+        'failed'               => 0,
+    );
+
+    /**
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_forms';
+
+    /**
+     * Stores a reference to the invoice if the form is for an invoice..
+     *
+     * @var WPInv_Invoice
+     */
+    public $invoice = 0;
 
     /**
      * Stores a reference to the original WP_Post object
@@ -68,35 +68,35 @@ 
     protected $post = null;
 
     /**
-	 * Get the form if ID is passed, otherwise the form is new and empty.
-	 *
-	 * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
-	 */
-	public function __construct( $form = 0 ) {
-		parent::__construct( $form );
+     * Get the form if ID is passed, otherwise the form is new and empty.
+     *
+     * @param  int|object|GetPaid_Payment_Form|WP_Post $form Form to read.
+     */
+    public function __construct( $form = 0 ) {
+        parent::__construct( $form );
 
-		if ( is_numeric( $form ) && $form > 0 ) {
-			$this->set_id( $form );
-		} elseif ( $form instanceof self ) {
+        if ( is_numeric( $form ) && $form > 0 ) {
+            $this->set_id( $form );
+        } elseif ( $form instanceof self ) {
 
-			$this->set_id( $form->get_id() );
-			$this->invoice = $form->invoice;
+            $this->set_id( $form->get_id() );
+            $this->invoice = $form->invoice;
 
-		} elseif ( ! empty( $form->ID ) ) {
-			$this->set_id( $form->ID );
-		} else {
-			$this->set_object_read( true );
-		}
+        } elseif ( ! empty( $form->ID ) ) {
+            $this->set_id( $form->ID );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -114,358 +114,358 @@ 
     */
 
     /**
-	 * Get plugin version when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the form was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the form was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the form was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the form was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the form name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the form name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
-	}
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
+    }
 
     /**
-	 * Get the owner of the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
+     * Get the owner of the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
     }
 
     /**
-	 * Get the elements that make up the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_elements( $context = 'view' ) {
-		$elements = $this->get_prop( 'elements', $context );
+     * Get the elements that make up the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_elements( $context = 'view' ) {
+        $elements = $this->get_prop( 'elements', $context );
 
-		if ( empty( $elements ) || ! is_array( $elements ) ) {
+        if ( empty( $elements ) || ! is_array( $elements ) ) {
             return wpinv_get_data( 'sample-payment-form' );
-		}
+        }
 
-		// Ensure that all required elements exist.
-		$_elements = array();
-		foreach ( $elements as $element ) {
+        // Ensure that all required elements exist.
+        $_elements = array();
+        foreach ( $elements as $element ) {
 
-			if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
+            if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) {
 
-				$_elements[] = array(
-					'text'        => __( 'Select Payment Method', 'invoicing' ),
-					'id'          => 'gtscicd',
-					'name'        => 'gtscicd',
-					'type'        => 'gateway_select',
-					'premade'     => true
+                $_elements[] = array(
+                    'text'        => __( 'Select Payment Method', 'invoicing' ),
+                    'id'          => 'gtscicd',
+                    'name'        => 'gtscicd',
+                    'type'        => 'gateway_select',
+                    'premade'     => true
 			
-				);
+                );
 
-			}
+            }
 
-			$_elements[] = $element;
+            $_elements[] = $element;
 
-		}
+        }
 
         return $_elements;
-	}
-
-	/**
-	 * Get the items sold via the form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @param  string $return objects or arrays.
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items( $context = 'view', $return = 'objects' ) {
-		$items = $this->get_prop( 'items', $context );
-
-		if ( empty( $items ) || ! is_array( $items ) ) {
+    }
+
+    /**
+     * Get the items sold via the form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @param  string $return objects or arrays.
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items( $context = 'view', $return = 'objects' ) {
+        $items = $this->get_prop( 'items', $context );
+
+        if ( empty( $items ) || ! is_array( $items ) ) {
             $items = wpinv_get_data( 'sample-payment-form-items' );
-		}
+        }
+
+        // Convert the items.
+        $prepared = array();
+
+        foreach ( $items as $key => $value ) {
+
+            // Form items.
+            if ( $value instanceof GetPaid_Form_Item ) {
+
+                if ( $value->can_purchase() ) {
+                    $prepared[] = $value;
+                }
+
+                continue;
+
+            }
 
-		// Convert the items.
-		$prepared = array();
+            // $item_id => $quantity (buy buttons)
+            if ( is_numeric( $key ) && is_numeric( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
 
-		foreach ( $items as $key => $value ) {
+                if ( $item->can_purchase() ) {
 
-			// Form items.
-			if ( $value instanceof GetPaid_Form_Item ) {
+                    $value = (float) $value;
+                    $item->set_quantity( $value );
+                    if ( 0 == $value ) {
+                        $item->set_quantity( 1 );
+                        $item->set_allow_quantities( true );
+                    }
 
-				if ( $value->can_purchase() ) {
-					$prepared[] = $value;
-				}
+                    $prepared[] = $item;
+                }
 
-				continue;
+                continue;
+            }
 
-			}
+            // Items saved via payment forms editor.
+            if ( is_array( $value ) && isset( $value['id'] ) ) {
 
-			// $item_id => $quantity (buy buttons)
-			if ( is_numeric( $key ) && is_numeric( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+                $item = new GetPaid_Form_Item( $value['id'] );
 
-				if ( $item->can_purchase() ) {
+                if ( ! $item->can_purchase() ) {
+                    continue;
+                }
 
-					$value = (float) $value;
-					$item->set_quantity( $value );
-					if ( 0 == $value ) {
-						$item->set_quantity( 1 );
-						$item->set_allow_quantities( true );
-					}
+                // Sub-total (Cart items).
+                if ( isset( $value['subtotal'] ) ) {
+                    $item->set_price( $value['subtotal'] );
+                }
 
-					$prepared[] = $item;
-				}
+                if ( isset( $value['quantity'] ) ) {
+                    $item->set_quantity( $value['quantity'] );
+                }
 
-				continue;
-			}
+                if ( isset( $value['allow_quantities'] ) ) {
+                    $item->set_allow_quantities( $value['allow_quantities'] );
+                }
 
-			// Items saved via payment forms editor.
-			if ( is_array( $value ) && isset( $value['id'] ) ) {
+                if ( isset( $value['required'] ) ) {
+                    $item->set_is_required( $value['required'] );
+                }
 
-				$item = new GetPaid_Form_Item( $value['id'] );
+                if ( isset( $value['description'] ) ) {
+                    $item->set_custom_description( $value['description'] );
+                }
 
-				if ( ! $item->can_purchase() ) {
-					continue;
-				}
+                $prepared[] = $item;
+                continue;
 
-				// Sub-total (Cart items).
-				if ( isset( $value['subtotal'] ) ) {
-					$item->set_price( $value['subtotal'] );
-				}
+            }
 
-				if ( isset( $value['quantity'] ) ) {
-					$item->set_quantity( $value['quantity'] );
-				}
+            // $item_id => array( 'price' => 10 ) (item variations)
+            if ( is_numeric( $key ) && is_array( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
 
-				if ( isset( $value['allow_quantities'] ) ) {
-					$item->set_allow_quantities( $value['allow_quantities'] );
-				}
+                if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
+                    $item->set_price( $value['price'] );
+                }
 
-				if ( isset( $value['required'] ) ) {
-					$item->set_is_required( $value['required'] );
-				}
+                if ( $item->can_purchase() ) {
+                    $prepared[] = $item;
+                }
 
-				if ( isset( $value['description'] ) ) {
-					$item->set_custom_description( $value['description'] );
-				}
+                continue;
+            }
 
-				$prepared[] = $item;
-				continue;
+        }
+
+        if ( 'objects' == $return && 'view' == $context ) {
+            return $prepared;
+        }
+
+        $items = array();
+        foreach ( $prepared as $item ) {
+            $items[] = $item->prepare_data_for_use();
+        }
+
+        return $items;
+    }
 
-			}
+    /**
+     * Get a single item belonging to the form.
+     *
+     * @since 1.0.19
+     * @param  int $item_id The item id to return.
+     * @return GetPaid_Form_Item|bool
+     */
+    public function get_item( $item_id ) {
 
-			// $item_id => array( 'price' => 10 ) (item variations)
-			if ( is_numeric( $key ) && is_array( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+        if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
+            return false;
+        }
 
-				if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
-					$item->set_price( $value['price'] );
-				}
-
-				if ( $item->can_purchase() ) {
-					$prepared[] = $item;
-				}
-
-				continue;
-			}
-
-		}
-
-		if ( 'objects' == $return && 'view' == $context ) {
-			return $prepared;
-		}
-
-		$items = array();
-		foreach ( $prepared as $item ) {
-			$items[] = $item->prepare_data_for_use();
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Get a single item belonging to the form.
-	 *
-	 * @since 1.0.19
-	 * @param  int $item_id The item id to return.
-	 * @return GetPaid_Form_Item|bool
-	 */
-	public function get_item( $item_id ) {
-
-		if ( empty( $item_id ) || ! is_numeric( $item_id ) ) {
-			return false;
-		}
-
-		foreach( $this->get_items() as $item ) {
-			if ( $item->get_id() == (int) $item_id ) {
-				return $item;
-			}
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Gets a single element.
-	 *
-	 * @since 1.0.19
-	 * @param  string $element_type The element type to return.
-	 * @return array|bool
-	 */
-	public function get_element_type( $element_type ) {
-
-		if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
-			return false;
-		}
-
-		foreach ( $this->get_prop( 'elements' ) as $element ) {
-
-			if ( $element['type'] == $element_type ) {
-				return $element;
-			}
-
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Get the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_earned( $context = 'view' ) {
-		return $this->get_prop( 'earned', $context );
-	}
-
-	/**
-	 * Get the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_refunded( $context = 'view' ) {
-		return $this->get_prop( 'refunded', $context );
-	}
-
-	/**
-	 * Get the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_cancelled( $context = 'view' ) {
-		return $this->get_prop( 'cancelled', $context );
-	}
-
-	/**
-	 * Get the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_failed( $context = 'view' ) {
-		return $this->get_prop( 'failed', $context );
-	}
-
-	/**
-	 * Get the currency.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_currency() {
-		$currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
-		return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
-	}
+        foreach( $this->get_items() as $item ) {
+            if ( $item->get_id() == (int) $item_id ) {
+                return $item;
+            }
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Gets a single element.
+     *
+     * @since 1.0.19
+     * @param  string $element_type The element type to return.
+     * @return array|bool
+     */
+    public function get_element_type( $element_type ) {
+
+        if ( empty( $element_type ) || ! is_scalar( $element_type ) ) {
+            return false;
+        }
+
+        foreach ( $this->get_prop( 'elements' ) as $element ) {
+
+            if ( $element['type'] == $element_type ) {
+                return $element;
+            }
+
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Get the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_earned( $context = 'view' ) {
+        return $this->get_prop( 'earned', $context );
+    }
+
+    /**
+     * Get the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_refunded( $context = 'view' ) {
+        return $this->get_prop( 'refunded', $context );
+    }
+
+    /**
+     * Get the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_cancelled( $context = 'view' ) {
+        return $this->get_prop( 'cancelled', $context );
+    }
+
+    /**
+     * Get the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_failed( $context = 'view' ) {
+        return $this->get_prop( 'failed', $context );
+    }
+
+    /**
+     * Get the currency.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_currency() {
+        $currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency();
+        return apply_filters( 'getpaid-payment-form-currency', $currency, $this );
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -478,22 +478,22 @@ 
     */
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -506,13 +506,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -525,169 +525,169 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
-		$this->set_prop( 'name', sanitize_text_field( $value ) );
-    }
-
-    /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
-    }
-
-    /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
-
-	/**
-	 * Set the form elements.
-	 *
-	 * @since 1.0.19
-	 * @sinve 2.3.4 Array values sanitized.
-	 * @param  array $value Form elements.
-	 */
-	public function set_elements( $value ) {
-		if ( is_array( $value ) ) {
-
-			// sanitize
-			$value = $this->sanitize_array_values( $value );
-
-			$this->set_prop( 'elements', $value );
-		}
-	}
-
-	/**
-	 * Sanitize array values.
-	 *
-	 * @param $value
-	 *
-	 * @return mixed
-	 */
-	public function sanitize_array_values($value){
-
-		// sanitize
-		if(!empty($value )){
-
-			foreach($value as $key => $val_arr){
-
-				if(is_array($val_arr)){
-					// check if we have sub array items.
-					$sub_arr = array();
-					foreach($val_arr as $key2 => $val2){
-						if(is_array($val2)){
-							$sub_arr[$key2] = $this->sanitize_array_values($val2);
-							unset($val_arr[$key][$key2]);
-						}
-					}
-
-					// we allow some html in description so we sanitize it separately.
-					$help_text = !empty($val_arr['description']) ? wp_kses_post($val_arr['description']) : '';
-
-					// sanitize array elements
-					$value[$key] = array_map( 'sanitize_text_field', $val_arr );
-
-					// add back the description if set
-					if(isset($val_arr['description'])){ $value[$key]['description'] = $help_text;}
-
-					// add back sub array items after its been sanitized.
-					if ( ! empty( $sub_arr ) ) {
-						$value[$key] = array_merge($value[$key],$sub_arr);
-					}
-				}
-
-			}
-
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Set the form items.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value Form elements.
-	 */
-	public function set_items( $value ) {
-		if ( is_array( $value ) ) {
-			$this->set_prop( 'items', $value );
-		}
-	}
-
-	/**
-	 * Set the total amount earned via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount earned.
-	 */
-	public function set_earned( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'earned', $value );
-	}
-
-	/**
-	 * Set the total amount refunded via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount refunded.
-	 */
-	public function set_refunded( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'refunded', $value );
-	}
-
-	/**
-	 * Set the total amount cancelled via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_cancelled( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'cancelled', $value );
-	}
-
-	/**
-	 * Set the total amount failed via this form.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value Amount cancelled.
-	 */
-	public function set_failed( $value ) {
-		$value = max( (float) $value, 0 );
-		$this->set_prop( 'failed', $value );
-	}
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
+        $this->set_prop( 'name', sanitize_text_field( $value ) );
+    }
+
+    /**
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
+    }
+
+    /**
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
+
+    /**
+     * Set the form elements.
+     *
+     * @since 1.0.19
+     * @sinve 2.3.4 Array values sanitized.
+     * @param  array $value Form elements.
+     */
+    public function set_elements( $value ) {
+        if ( is_array( $value ) ) {
+
+            // sanitize
+            $value = $this->sanitize_array_values( $value );
+
+            $this->set_prop( 'elements', $value );
+        }
+    }
+
+    /**
+     * Sanitize array values.
+     *
+     * @param $value
+     *
+     * @return mixed
+     */
+    public function sanitize_array_values($value){
+
+        // sanitize
+        if(!empty($value )){
+
+            foreach($value as $key => $val_arr){
+
+                if(is_array($val_arr)){
+                    // check if we have sub array items.
+                    $sub_arr = array();
+                    foreach($val_arr as $key2 => $val2){
+                        if(is_array($val2)){
+                            $sub_arr[$key2] = $this->sanitize_array_values($val2);
+                            unset($val_arr[$key][$key2]);
+                        }
+                    }
+
+                    // we allow some html in description so we sanitize it separately.
+                    $help_text = !empty($val_arr['description']) ? wp_kses_post($val_arr['description']) : '';
+
+                    // sanitize array elements
+                    $value[$key] = array_map( 'sanitize_text_field', $val_arr );
+
+                    // add back the description if set
+                    if(isset($val_arr['description'])){ $value[$key]['description'] = $help_text;}
+
+                    // add back sub array items after its been sanitized.
+                    if ( ! empty( $sub_arr ) ) {
+                        $value[$key] = array_merge($value[$key],$sub_arr);
+                    }
+                }
+
+            }
+
+        }
+
+        return $value;
+    }
+
+    /**
+     * Set the form items.
+     *
+     * @since 1.0.19
+     * @param  array $value Form elements.
+     */
+    public function set_items( $value ) {
+        if ( is_array( $value ) ) {
+            $this->set_prop( 'items', $value );
+        }
+    }
+
+    /**
+     * Set the total amount earned via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount earned.
+     */
+    public function set_earned( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'earned', $value );
+    }
+
+    /**
+     * Set the total amount refunded via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount refunded.
+     */
+    public function set_refunded( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'refunded', $value );
+    }
+
+    /**
+     * Set the total amount cancelled via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_cancelled( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'cancelled', $value );
+    }
+
+    /**
+     * Set the total amount failed via this form.
+     *
+     * @since 1.0.19
+     * @param  float $value Amount cancelled.
+     */
+    public function set_failed( $value ) {
+        $value = max( (float) $value, 0 );
+        $this->set_prop( 'failed', $value );
+    }
 
     /**
      * Create an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
     }
 
@@ -695,7 +695,7 @@ 
      * Updates an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -711,22 +711,22 @@ 
 	*/
 
     /**
-	 * Checks whether this is the default payment form.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether this is the default payment form.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_default() {
         $is_default = $this->get_id() == wpinv_get_default_payment_form();
         return (bool) apply_filters( 'wpinv_is_default_payment_form', $is_default, $this->get_id(), $this );
-	}
+    }
 
     /**
-	 * Checks whether the form is active.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the form is active.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_active() {
         $is_active = 0 !== (int) $this->get_id();
 
@@ -735,76 +735,76 @@ 
         }
 
         return (bool) apply_filters( 'wpinv_is_payment_form_active', $is_active, $this );
-	}
-
-	/**
-	 * Checks whether the form has a given item.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given item.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_item( $item_id ) {
         return false !== $this->get_item( $item_id );
-	}
-
-	/**
-	 * Checks whether the form has a given element.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether the form has a given element.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_element_type( $element_type ) {
         return false !== $this->get_element_type( $element_type );
-	}
-
-	/**
-	 * Checks whether this form is recurring or not.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+    }
+
+    /**
+     * Checks whether this form is recurring or not.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_recurring() {
 
-		if ( ! empty( $this->invoice ) ) {
-			return $this->invoice->is_recurring();
-		}
+        if ( ! empty( $this->invoice ) ) {
+            return $this->invoice->is_recurring();
+        }
 
-		foreach ( $this->get_items() as $item ) {
+        foreach ( $this->get_items() as $item ) {
 
-			if ( $item->is_recurring() ) {
-				return true;
-			}
+            if ( $item->is_recurring() ) {
+                return true;
+            }
 
-		}
+        }
 
         return false;
-	}
+    }
 
-	/**
-	 * Retrieves the form's html.
-	 *
-	 * @since 1.0.19
-	 */
+    /**
+     * Retrieves the form's html.
+     *
+     * @since 1.0.19
+     */
     public function get_html( $extra_markup = '' ) {
 
-		// Return the HTML.
-		return wpinv_get_template_html(
-			'payment-forms/form.php',
-			array(
-				'form'         => $this,
-				'extra_markup' => $extra_markup,
-			)
-		);
-
-	}
-
-	/**
-	 * Displays the payment form.
-	 *
-	 * @since 1.0.19
-	 */
+        // Return the HTML.
+        return wpinv_get_template_html(
+            'payment-forms/form.php',
+            array(
+                'form'         => $this,
+                'extra_markup' => $extra_markup,
+            )
+        );
+
+    }
+
+    /**
+     * Displays the payment form.
+     *
+     * @since 1.0.19
+     */
     public function display( $extra_markup = '' ) {
-		echo $this->get_html( $extra_markup );
+        echo $this->get_html( $extra_markup );
     }
 
 }

includes/payments/class-getpaid-payment-form-submission-fees.php

Indentation +107 added lines, -107 removed lines

@@ -12,114 +12,114 @@
  */
 class GetPaid_Payment_Form_Submission_Fees {
 
-	/**
-	 * The fee validation error.
-	 * @var string
-	 */
-	public $fee_error;
-
-	/**
-	 * Submission fees.
-	 * @var array
-	 */
-	public $fees = array();
+    /**
+     * The fee validation error.
+     * @var string
+     */
+    public $fee_error;
+
+    /**
+     * Submission fees.
+     * @var array
+     */
+    public $fees = array();
+
+    /**
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        // Process any existing invoice fees.
+        if ( $submission->has_invoice() ) {
+            $this->fees = $submission->get_invoice()->get_fees();
+        }
+
+        // Process price fields.
+        $data         = $submission->get_data();
+        $payment_form = $submission->get_payment_form();
+
+        foreach ( $payment_form->get_elements() as $element ) {
+
+            if ( 'price_input' == $element['type'] ) {
+                $this->process_price_input( $element, $data, $submission );
+            }
+
+            if ( 'price_select' == $element['type'] ) {
+                $this->process_price_select( $element, $data );
+            }
+
+        }
+
+    }
+
+    /**
+     * Process a price input field.
+     *
+     * @param array $element
+     * @param array $data
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function process_price_input( $element, $data, $submission ) {
+
+        // Abort if not passed.
+        if ( empty( $data[ $element['id'] ] ) ) {
+            return;
+        }
+
+        $amount  = (float) wpinv_sanitize_amount( $data[ $element['id'] ] );
+        $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] );
+
+        if ( $amount < $minimum ) {
+            throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) );
+        }
+
+        $this->fees[ $element['label'] ] = array(
+            'name'          => $element['label'],
+            'initial_fee'   => $amount,
+            'recurring_fee' => 0,
+        );
+
+    }
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		// Process any existing invoice fees.
-		if ( $submission->has_invoice() ) {
-			$this->fees = $submission->get_invoice()->get_fees();
-		}
-
-		// Process price fields.
-		$data         = $submission->get_data();
-		$payment_form = $submission->get_payment_form();
-
-		foreach ( $payment_form->get_elements() as $element ) {
-
-			if ( 'price_input' == $element['type'] ) {
-				$this->process_price_input( $element, $data, $submission );
-			}
-
-			if ( 'price_select' == $element['type'] ) {
-				$this->process_price_select( $element, $data );
-			}
-
-		}
-
-	}
-
-	/**
-	 * Process a price input field.
-	 *
-	 * @param array $element
-	 * @param array $data
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function process_price_input( $element, $data, $submission ) {
-
-		// Abort if not passed.
-		if ( empty( $data[ $element['id'] ] ) ) {
-			return;
-		}
-
-		$amount  = (float) wpinv_sanitize_amount( $data[ $element['id'] ] );
-		$minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] );
-
-		if ( $amount < $minimum ) {
-			throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) );
-		}
-
-		$this->fees[ $element['label'] ] = array(
-			'name'          => $element['label'],
-			'initial_fee'   => $amount,
-			'recurring_fee' => 0,
-		);
-
-	}
-
-	/**
-	 * Process a price select field.
-	 *
-	 * @param array $element
-	 * @param array $data
-	 */
-	public function process_price_select( $element, $data ) {
-
-		// Abort if not passed.
-		if ( empty( $data[ $element['id'] ] ) ) {
-			return;
-		}
-
-		$options    = getpaid_convert_price_string_to_options( $element['options'] );
-		$selected   = array_filter( array_map( 'trim', explode( ',', $data[ $element['id'] ] ) ) );
-		$total      = 0;
-		$sub_labels = array();
-
-		foreach ( $selected as $price ) {
-
-			if ( ! isset( $options[ $price ] ) ) {
-				throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) );
-			}
-
-			$price = explode( '|', $price );
-
-			$sub_labels[] = $price[0];
-			$total += (float) wpinv_sanitize_amount( $price[1] );
-		}
-
-		$this->fees[ $element['label'] ] = array(
-			'name'          => $element['label'],
-			'initial_fee'   => $total,
-			'recurring_fee' => 0,
-			'description'   => implode( ', ', $sub_labels ),
-		);
-
-	}
+     * Process a price select field.
+     *
+     * @param array $element
+     * @param array $data
+     */
+    public function process_price_select( $element, $data ) {
+
+        // Abort if not passed.
+        if ( empty( $data[ $element['id'] ] ) ) {
+            return;
+        }
+
+        $options    = getpaid_convert_price_string_to_options( $element['options'] );
+        $selected   = array_filter( array_map( 'trim', explode( ',', $data[ $element['id'] ] ) ) );
+        $total      = 0;
+        $sub_labels = array();
+
+        foreach ( $selected as $price ) {
+
+            if ( ! isset( $options[ $price ] ) ) {
+                throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) );
+            }
+
+            $price = explode( '|', $price );
+
+            $sub_labels[] = $price[0];
+            $total += (float) wpinv_sanitize_amount( $price[1] );
+        }
+
+        $this->fees[ $element['label'] ] = array(
+            'name'          => $element['label'],
+            'initial_fee'   => $total,
+            'recurring_fee' => 0,
+            'description'   => implode( ', ', $sub_labels ),
+        );
+
+    }
 
 }

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

Indentation +232 added lines, -232 removed lines

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

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

Indentation +160 added lines, -160 removed lines

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

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

Indentation +37 added lines, -37 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'manual';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'addons', 'single_subscription_group', 'multiple_subscription_groups' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 11;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 11;
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title        = __( 'Test Gateway', 'invoicing' );
@@ -46,15 +46,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Mark it as paid.
         $invoice->mark_paid();
@@ -85,12 +85,12 @@ 
     }
 
     /**
-	 * (Maybe) renews a manual subscription profile.
-	 *
-	 *
+     * (Maybe) renews a manual subscription profile.
+     *
+     *
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $subscription ) {
+     */
+    public function maybe_renew_subscription( $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( $this->id == $subscription->get_gateway() && $subscription->has_status( 'active trialling' ) ) {
@@ -110,13 +110,13 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
 
         foreach ( $items as $item ) {
             $invoice->add_item( $item );