AyeCode / invoicing

includes/class-wpinv-item.php

Indentation +751 added lines, -751 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,30 +10,30 @@ 
 class WPInv_Item extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'item';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'item';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'item';
 
     /**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'parent_id'            => 0,
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'parent_id'            => 0,
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'description'          => '',
@@ -62,13 +62,13 @@ 
     );
 
     /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_items';
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_items';
 
     /**
      * Stores a reference to the original WP_Post object
@@ -78,36 +78,36 @@ 
     protected $post = null;
 
     /**
-	 * Get the item if ID is passed, otherwise the item is new and empty.
-	 *
-	 * @param  int|object|WPInv_Item|WP_Post $item Item to read.
-	 */
-	public function __construct( $item = 0 ) {
-		parent::__construct( $item );
-
-		if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
-			$this->set_id( $item );
-		} elseif ( $item instanceof self ) {
-			$this->set_id( $item->get_id() );
-		} elseif ( ! empty( $item->ID ) ) {
-			$this->set_id( $item->ID );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
-			$this->set_id( $item_id );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
-			$this->set_id( $item_id );
-		} else {
-			$this->set_object_read( true );
-		}
+     * Get the item if ID is passed, otherwise the item is new and empty.
+     *
+     * @param  int|object|WPInv_Item|WP_Post $item Item to read.
+     */
+    public function __construct( $item = 0 ) {
+        parent::__construct( $item );
+
+        if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
+            $this->set_id( $item );
+        } elseif ( $item instanceof self ) {
+            $this->set_id( $item->get_id() );
+        } elseif ( ! empty( $item->ID ) ) {
+            $this->set_id( $item->ID );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
+            $this->set_id( $item_id );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
+            $this->set_id( $item_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->ID   = $this->get_id();
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -125,188 +125,188 @@ 
     */
 
     /**
-	 * Get parent item ID.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_id', $context );
+     * Get parent item ID.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_id', $context );
     }
 
     /**
-	 * Get item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
+     * Get item status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
     }
 
     /**
-	 * Get plugin version when the item 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 item 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 item 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 item 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 item 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 item 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 item 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 item 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 item 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 item 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 item 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 item 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 item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-		return $this->get_prop( 'description', $context );
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+        return $this->get_prop( 'description', $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_excerpt( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_excerpt( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_summary( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_summary( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Get the owner of the item.
-	 *
-	 * @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 item.
+     *
+     * @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 );
+    }
 
-	/**
-	 * Alias of self::get_author().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_owner( $context = 'view' ) {
-		return $this->get_author( $context );
+    /**
+     * Alias of self::get_author().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_owner( $context = 'view' ) {
+        return $this->get_author( $context );
     }
 
     /**
-	 * Get the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_price( $context = 'view' ) {
+     * Get the price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) );
-	}
-
-	/**
-	 * Get the inital price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_price( $context = 'view', $price_id = null ) {
+    }
+
+    /**
+     * Get the inital price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_price( $context = 'view', $price_id = null ) {
         $price = 0;
 
         if ( null === $price_id ) {
@@ -327,134 +327,134 @@ 
     }
 
     /**
-	 * Returns a formated price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+     * Returns a formated price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_price() {
         return wpinv_price( $this->get_price() );
-	}
-
-	/**
-	 * Returns the formated initial price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Returns the formated initial price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_initial_price() {
         return wpinv_price( $this->get_initial_price() );
     }
 
     /**
-	 * Get the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_rule( $context = 'view' ) {
+     * Get the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_rule( $context = 'view' ) {
         return $this->get_prop( 'vat_rule', $context );
     }
 
     /**
-	 * Get the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_class( $context = 'view' ) {
+     * Get the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_class( $context = 'view' ) {
         return $this->get_prop( 'vat_class', $context );
     }
 
     /**
-	 * Get the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
+     * Get the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_type( $context = 'view' ) {
         return $this->get_prop( 'type', $context );
     }
 
     /**
-	 * Get the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_id( $context = 'view' ) {
+     * Get the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_id( $context = 'view' ) {
         return $this->get_prop( 'custom_id', $context );
     }
 
     /**
-	 * Get the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_name( $context = 'view' ) {
+     * Get the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_name( $context = 'view' ) {
         return $this->get_prop( 'custom_name', $context );
     }
 
     /**
-	 * Get the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_singular_name( $context = 'view' ) {
+     * Get the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_singular_name( $context = 'view' ) {
         return $this->get_prop( 'custom_singular_name', $context );
     }
 
     /**
-	 * Checks if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_editable( $context = 'view' ) {
+     * Checks if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_editable( $context = 'view' ) {
         return (int) $this->get_prop( 'is_editable', $context );
     }
 
     /**
-	 * Alias of self::get_is_editable().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_editable( $context = 'view' ) {
-		return $this->get_is_editable( $context );
+     * Alias of self::get_is_editable().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_editable( $context = 'view' ) {
+        return $this->get_is_editable( $context );
     }
 
     /**
-	 * Checks if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_dynamic_pricing( $context = 'view' ) {
+     * Checks if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_dynamic_pricing( $context = 'view' ) {
         return (int) $this->get_prop( 'is_dynamic_pricing', $context );
     }
 
     /**
-	 * Returns the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_minimum_price( $context = 'view' ) {
+     * Returns the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_minimum_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) );
     }
 
@@ -528,7 +528,7 @@ 
     /**
      * Retrieve the variable prices
      *
-    * @since 2.8.9
+     * @since 2.8.9
      * @return array List of the variable prices
      */
     public function get_variable_prices() {
@@ -542,76 +542,76 @@ 
     }
 
     /**
-	 * Checks if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_recurring( $context = 'view' ) {
+     * Checks if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_recurring( $context = 'view' ) {
         return (int) $this->get_prop( 'is_recurring', $context );
-	}
-
-	/**
-	 * Get the recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_price( $context = 'view' ) {
-		$price = $this->get_price( $context );
+    }
+
+    /**
+     * Get the recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_price( $context = 'view' ) {
+        $price = $this->get_price( $context );
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) );
-	}
-
-	/**
-	 * Get the formatted recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Get the formatted recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_recurring_price() {
         return wpinv_price( $this->get_recurring_price() );
-	}
-
-	/**
-	 * Get the first renewal date (in timestamps) of the item.
-	 *
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public function get_first_renewal_date() {
-
-		$periods = array(
-			'D' => 'days',
-			'W' => 'weeks',
-			'M' => 'months',
-			'Y' => 'years',
-		);
-
-		$period   = $this->get_recurring_period();
-		$interval = $this->get_recurring_interval();
-
-		if ( $this->has_free_trial() ) {
-			$period   = $this->get_trial_period();
-			$interval = $this->get_trial_interval();
-		}
-
-		$period       = $periods[ $period ];
-		$interval     = empty( $interval ) ? 1 : $interval;
-		$next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get the first renewal date (in timestamps) of the item.
+     *
+     * @since 1.0.19
+     * @return int
+     */
+    public function get_first_renewal_date() {
+
+        $periods = array(
+            'D' => 'days',
+            'W' => 'weeks',
+            'M' => 'months',
+            'Y' => 'years',
+        );
+
+        $period   = $this->get_recurring_period();
+        $interval = $this->get_recurring_interval();
+
+        if ( $this->has_free_trial() ) {
+            $period   = $this->get_trial_period();
+            $interval = $this->get_trial_interval();
+        }
+
+        $period       = $periods[ $period ];
+        $interval     = empty( $interval ) ? 1 : $interval;
+        $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
         return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this );
     }
 
     /**
-	 * Get the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_recurring_period( $full = false ) {
+     * Get the recurring period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_recurring_period( $full = false ) {
         $period = $this->get_prop( 'recurring_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -622,58 +622,58 @@ 
     }
 
     /**
-	 * Get the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_interval( $context = 'view' ) {
-		$interval = absint( $this->get_prop( 'recurring_interval', $context ) );
-		return max( 1, $interval );
+     * Get the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_interval( $context = 'view' ) {
+        $interval = absint( $this->get_prop( 'recurring_interval', $context ) );
+        return max( 1, $interval );
     }
 
     /**
-	 * Get the recurring limit.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_limit( $context = 'view' ) {
+     * Get the recurring limit.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_limit( $context = 'view' ) {
         return (int) $this->get_prop( 'recurring_limit', $context );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_free_trial( $context = 'view' ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_free_trial( $context = 'view' ) {
         return (int) $this->get_prop( 'is_free_trial', $context );
     }
 
     /**
-	 * Alias for self::get_is_free_trial().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_free_trial( $context = 'view' ) {
+     * Alias for self::get_is_free_trial().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_free_trial( $context = 'view' ) {
         return $this->get_is_free_trial( $context );
     }
 
     /**
-	 * Get the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_trial_period( $full = false ) {
+     * Get the trial period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_trial_period( $full = false ) {
         $period = $this->get_prop( 'trial_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -684,104 +684,104 @@ 
     }
 
     /**
-	 * Get the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_trial_interval( $context = 'view' ) {
+     * Get the trial interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_trial_interval( $context = 'view' ) {
         return (int) $this->get_prop( 'trial_interval', $context );
-	}
-
-	/**
-	 * Get the item's edit url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_edit_url() {
+    }
+
+    /**
+     * Get the item's edit url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_edit_url() {
         return get_edit_post_link( $this->get_id(), 'edit' );
-	}
-
-	/**
-	 * Given an item's name/custom id, it returns its id.
-	 *
-	 *
-	 * @static
-	 * @param string $value The item name or custom id.
-	 * @param string $field Either name or custom_id.
-	 * @param string $type in case you need to search for a given type.
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
-
-		// Trim the value.
-		$value = sanitize_text_field( $value );
-		if ( empty( $value ) ) {
-			return 0;
-		}
+    }
+
+    /**
+     * Given an item's name/custom id, it returns its id.
+     *
+     *
+     * @static
+     * @param string $value The item name or custom id.
+     * @param string $field Either name or custom_id.
+     * @param string $type in case you need to search for a given type.
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
+
+        // Trim the value.
+        $value = sanitize_text_field( $value );
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
         // Valid fields.
         $fields = array( 'custom_id', 'name', 'slug' );
 
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		if ( $field == 'name' ) {
-			$field = 'slug';
-		}
-
-		// Maybe retrieve from the cache.
-		$item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-		if ( ! empty( $item_id ) ) {
-			return $item_id;
-		}
-
-		// Fetch from the db.
-		$items = array();
-		if ( $field == 'slug' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'name'           => $value,
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-				)
-			);
-		}
-
-		if ( $field == 'custom_id' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-					'meta_query'     => array(
-						array(
-							'key'   => '_wpinv_type',
-                			'value' => $type,
-						),
-						array(
-							'key'   => '_wpinv_custom_id',
-                			'value' => $value,
-						),
-					),
-				)
-			);
-		}
-
-		if ( empty( $items ) ) {
-			return 0;
-		}
-
-		// Update the cache with our data
-		wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-
-		return $items[0]->ID;
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        if ( $field == 'name' ) {
+            $field = 'slug';
+        }
+
+        // Maybe retrieve from the cache.
+        $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+        if ( ! empty( $item_id ) ) {
+            return $item_id;
+        }
+
+        // Fetch from the db.
+        $items = array();
+        if ( $field == 'slug' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'name'           => $value,
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                )
+            );
+        }
+
+        if ( $field == 'custom_id' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                    'meta_query'     => array(
+                        array(
+                            'key'   => '_wpinv_type',
+                            'value' => $type,
+                        ),
+                        array(
+                            'key'   => '_wpinv_custom_id',
+                            'value' => $value,
+                        ),
+                    ),
+                )
+            );
+        }
+
+        if ( empty( $items ) ) {
+            return 0;
+        }
+
+        // Update the cache with our data
+        wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+
+        return $items[0]->ID;
     }
 
     /**
@@ -813,52 +813,52 @@ 
     */
 
     /**
-	 * Set parent order ID.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_parent_id( $value ) {
-		if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
-			return;
-		}
-		$this->set_prop( 'parent_id', absint( $value ) );
-	}
-
-    /**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+     * Set parent order ID.
+     *
+     * @since 1.0.19
+     */
+    public function set_parent_id( $value ) {
+        if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
+            return;
+        }
+        $this->set_prop( 'parent_id', absint( $value ) );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param  string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
         $this->set_prop( 'status', $status );
 
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
     }
 
     /**
-	 * 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 ) {
@@ -870,13 +870,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 ) {
@@ -888,115 +888,115 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
         $name = sanitize_text_field( $value );
-		$this->set_prop( 'name', $name );
+        $this->set_prop( 'name', $name );
     }
 
     /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $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 item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
-		$description = wp_kses_post( wp_unslash( $value ) );
-		return $this->set_prop( 'description', $description );
+     * Set the item description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
+        $description = wp_kses_post( wp_unslash( $value ) );
+        return $this->set_prop( 'description', $description );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_excerpt( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_excerpt( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_summary( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_summary( $value ) {
+        $this->set_description( $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 owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
 
-	/**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_owner( $value ) {
-		$this->set_author( $value );
+    /**
+     * Alias of self::set_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_owner( $value ) {
+        $this->set_author( $value );
     }
 
     /**
-	 * Set the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value New price.
-	 */
-	public function set_price( $value ) {
+     * Set the price of the item.
+     *
+     * @since 1.0.19
+     * @param  float $value New price.
+     */
+    public function set_price( $value ) {
         $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Set the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new rule.
-	 */
-	public function set_vat_rule( $value ) {
+     * Set the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new rule.
+     */
+    public function set_vat_rule( $value ) {
         $this->set_prop( 'vat_rule', $value );
     }
 
     /**
-	 * Set the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new class.
-	 */
-	public function set_vat_class( $value ) {
+     * Set the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new class.
+     */
+    public function set_vat_class( $value ) {
         $this->set_prop( 'vat_class', $value );
     }
 
     /**
-	 * Set the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new item type.
-	 * @return string
-	 */
-	public function set_type( $value ) {
+     * Set the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new item type.
+     * @return string
+     */
+    public function set_type( $value ) {
 
         if ( empty( $value ) ) {
             $value = 'custom';
@@ -1006,102 +1006,102 @@ 
     }
 
     /**
-	 * Set the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom id.
-	 */
-	public function set_custom_id( $value ) {
+     * Set the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom id.
+     */
+    public function set_custom_id( $value ) {
         $this->set_prop( 'custom_id', $value );
     }
 
     /**
-	 * Set the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom name.
-	 */
-	public function set_custom_name( $value ) {
+     * Set the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom name.
+     */
+    public function set_custom_name( $value ) {
         $this->set_prop( 'custom_name', $value );
     }
 
     /**
-	 * Set the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom singular name.
-	 */
-	public function set_custom_singular_name( $value ) {
+     * Set the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom singular name.
+     */
+    public function set_custom_singular_name( $value ) {
         $this->set_prop( 'custom_singular_name', $value );
     }
 
     /**
-	 * Sets if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not the item is editable.
-	 */
-	public function set_is_editable( $value ) {
-		$this->set_prop( 'is_editable', (int) $value );
+     * Sets if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not the item is editable.
+     */
+    public function set_is_editable( $value ) {
+        $this->set_prop( 'is_editable', (int) $value );
     }
 
     /**
-	 * Sets if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_dynamic_pricing( $value ) {
+     * Sets if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_dynamic_pricing( $value ) {
         $this->set_prop( 'is_dynamic_pricing', (int) $value );
     }
 
     /**
-	 * Sets the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value minimum price.
-	 */
-	public function set_minimum_price( $value ) {
+     * Sets the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  float $value minimum price.
+     */
+    public function set_minimum_price( $value ) {
         $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Sets if this item has multi price mode.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_multi_price_mode( $value ) {
+     * Sets if this item has multi price mode.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_multi_price_mode( $value ) {
         $this->set_prop( 'is_multi_price_mode', (int) $value );
     }
 
     /**
-	 * Sets if this item has variable pricing.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_has_variable_pricing( $value ) {
+     * Sets if this item has variable pricing.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_has_variable_pricing( $value ) {
         $this->set_prop( 'has_variable_pricing', (int) $value );
     }
 
     /**
-	 * Set the default price ID.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value default price ID.
-	 */
-	public function set_default_price_id( $value ) {
+     * Set the default price ID.
+     *
+     * @since 1.0.19
+     * @param  int $value default price ID.
+     */
+    public function set_default_price_id( $value ) {
         return $this->set_prop( 'default_price_id', (int) $value );
     }
 
     /**
-	 * Set the variable prices.
-	 *
-	 * @since 1.0.19
-	 * @param  int $prices variable prices.
-	 */
-	public function set_variable_prices( $prices ) {
+     * Set the variable prices.
+     *
+     * @since 1.0.19
+     * @param  int $prices variable prices.
+     */
+    public function set_variable_prices( $prices ) {
         if ( ! is_array( $prices ) ) {
             $prices = array();
         }
@@ -1121,72 +1121,72 @@ 
     }
 
     /**
-	 * Sets if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_recurring( $value ) {
+     * Sets if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_recurring( $value ) {
         $this->set_prop( 'is_recurring', (int) $value );
     }
 
     /**
-	 * Set the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new period.
-	 */
-	public function set_recurring_period( $value ) {
+     * Set the recurring period.
+     *
+     * @since 1.0.19
+     * @param  string $value new period.
+     */
+    public function set_recurring_period( $value ) {
         $this->set_prop( 'recurring_period', $value );
     }
 
     /**
-	 * Set the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value recurring interval.
-	 */
-	public function set_recurring_interval( $value ) {
+     * Set the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  int $value recurring interval.
+     */
+    public function set_recurring_interval( $value ) {
         return $this->set_prop( 'recurring_interval', (int) $value );
     }
 
     /**
-	 * Get the recurring limit.
-	 * @since 1.0.19
-	 * @param  int $value The recurring limit.
-	 * @return int
-	 */
-	public function set_recurring_limit( $value ) {
+     * Get the recurring limit.
+     * @since 1.0.19
+     * @param  int $value The recurring limit.
+     * @return int
+     */
+    public function set_recurring_limit( $value ) {
         $this->set_prop( 'recurring_limit', (int) $value );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not it has a free trial.
-	 */
-	public function set_is_free_trial( $value ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not it has a free trial.
+     */
+    public function set_is_free_trial( $value ) {
         $this->set_prop( 'is_free_trial', (int) $value );
     }
 
     /**
-	 * Set the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value trial period.
-	 */
-	public function set_trial_period( $value ) {
+     * Set the trial period.
+     *
+     * @since 1.0.19
+     * @param  string $value trial period.
+     */
+    public function set_trial_period( $value ) {
         $this->set_prop( 'trial_period', $value );
     }
 
     /**
-	 * Set the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value trial interval.
-	 */
-	public function set_trial_interval( $value ) {
+     * Set the trial interval.
+     *
+     * @since 1.0.19
+     * @param  int $value trial interval.
+     */
+    public function set_trial_interval( $value ) {
         $this->set_prop( 'trial_interval', $value );
     }
 
@@ -1194,24 +1194,24 @@ 
      * 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();
     }
 
     /**
      * Updates an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -1227,93 +1227,93 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function user_can_set_their_price() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function user_can_set_their_price() {
         return (bool) $this->get_is_dynamic_pricing();
-	}
-
-	/**
-	 * Checks whether the item is recurring.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_recurring() {
+    }
+
+    /**
+     * Checks whether the item is recurring.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_recurring() {
         return (bool) $this->get_is_recurring();
     }
 
     /**
-	 * Checks whether the item has a free trial.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item has a free trial.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_free_trial() {
         $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false;
         return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this );
     }
 
     /**
-	 * Checks whether the item is free.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is free.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_free() {
         $is_free   = $this->get_price() == 0;
         return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this );
     }
 
     /**
-	 * Checks the item status against a passed in status.
-	 *
-	 * @param array|string $status Status to check.
-	 * @return bool
-	 */
-	public function has_status( $status ) {
-		$has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
-		return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
+     * Checks the item status against a passed in status.
+     *
+     * @param array|string $status Status to check.
+     * @return bool
+     */
+    public function has_status( $status ) {
+        $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
+        return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
     }
 
     /**
-	 * Checks the item type against a passed in types.
-	 *
-	 * @param array|string $type Type to check.
-	 * @return bool
-	 */
-	public function is_type( $type ) {
-		$is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
-		return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
-	}
+     * Checks the item type against a passed in types.
+     *
+     * @param array|string $type Type to check.
+     * @return bool
+     */
+    public function is_type( $type ) {
+        $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
+        return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
+    }
 
     /**
-	 * Checks whether the item is editable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is editable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_editable() {
         $is_editable = $this->get_is_editable();
         return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this );
-	}
+    }
 
-	/**
-	 * Returns an array of cart fees.
-	 */
-	public function get_fees() {
+    /**
+     * Returns an array of cart fees.
+     */
+    public function get_fees() {
         return array();
     }
 
     /**
-	 * Checks whether the item is purchasable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is purchasable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function can_purchase() {
         $can_purchase = $this->exists();
 
@@ -1325,11 +1325,11 @@ 
     }
 
     /**
-	 * Checks whether the item supports dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item supports dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function supports_dynamic_pricing() {
         return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this );
     }

includes/admin/class-getpaid-installer.php

Indentation +494 added lines, -494 removed lines

@@ -20,411 +20,411 @@ 
  */
 class GetPaid_Installer {
 
-	private static $schema = null;
-	private static $schema_version = null;
-
-	/**
-	 * Upgrades the install.
-	 *
-	 * @param string $upgrade_from The current invoicing version.
-	 */
-	public function upgrade_db( $upgrade_from ) {
-
-		// Save the current invoicing version.
-		update_option( 'wpinv_version', WPINV_VERSION );
-
-		// Setup the invoice Custom Post Type.
-		GetPaid_Post_Types::register_post_types();
-
-		// Clear the permalinks
-		flush_rewrite_rules();
-
-		// Maybe create new/missing pages.
-		$this->create_pages();
-
-		// Maybe re(add) admin capabilities.
-		$this->add_capabilities();
-
-		// Maybe create the default payment form.
-		wpinv_get_default_payment_form();
-
-		// Create any missing database tables.
-		$method = "upgrade_from_$upgrade_from";
-
-		$installed = get_option( 'gepaid_installed_on' );
-
-		if ( empty( $installed ) ) {
-			update_option( 'gepaid_installed_on', time() );
-		}
-
-		if ( method_exists( $this, $method ) ) {
-			$this->$method();
-		}
-
-	}
-
-	/**
-	 * Do a fresh install.
-	 *
-	 */
-	public function upgrade_from_0() {
-
-		// 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_118();
-	}
-
-	/**
-	 * Upgrade to version 2.0.0.
-	 *
-	 */
-	public function upgrade_from_118() {
-		$this->migrate_old_invoices();
-		$this->upgrade_from_279();
-	}
-
-	/**
-	 * Upgrade to version 2.0.0.
-	 *
-	 */
-	public function upgrade_from_279() {
-		self::migrate_old_customers();
-	}
-
-	/**
-	 * 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' => '
+    private static $schema = null;
+    private static $schema_version = null;
+
+    /**
+     * Upgrades the install.
+     *
+     * @param string $upgrade_from The current invoicing version.
+     */
+    public function upgrade_db( $upgrade_from ) {
+
+        // Save the current invoicing version.
+        update_option( 'wpinv_version', WPINV_VERSION );
+
+        // Setup the invoice Custom Post Type.
+        GetPaid_Post_Types::register_post_types();
+
+        // Clear the permalinks
+        flush_rewrite_rules();
+
+        // Maybe create new/missing pages.
+        $this->create_pages();
+
+        // Maybe re(add) admin capabilities.
+        $this->add_capabilities();
+
+        // Maybe create the default payment form.
+        wpinv_get_default_payment_form();
+
+        // Create any missing database tables.
+        $method = "upgrade_from_$upgrade_from";
+
+        $installed = get_option( 'gepaid_installed_on' );
+
+        if ( empty( $installed ) ) {
+            update_option( 'gepaid_installed_on', time() );
+        }
+
+        if ( method_exists( $this, $method ) ) {
+            $this->$method();
+        }
+
+    }
+
+    /**
+     * Do a fresh install.
+     *
+     */
+    public function upgrade_from_0() {
+
+        // 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_118();
+    }
+
+    /**
+     * Upgrade to version 2.0.0.
+     *
+     */
+    public function upgrade_from_118() {
+        $this->migrate_old_invoices();
+        $this->upgrade_from_279();
+    }
+
+    /**
+     * Upgrade to version 2.0.0.
+     *
+     */
+    public function upgrade_from_279() {
+        self::migrate_old_customers();
+    }
+
+    /**
+     * 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'  => '',
-				),
-
-			)
-		);
-
-	}
-
-	/**
-	 * 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'] );
-		}
-
-	}
-
-	/**
-	 * 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 customers to new table.
-	 *
-	 */
-	public static function migrate_old_customers() {
-		global $wpdb;
-
-		// Fetch post_id from $wpdb->prefix . 'getpaid_invoices' where customer_id = 0 or null.
-		$invoice_ids = $wpdb->get_col( "SELECT post_id FROM {$wpdb->prefix}getpaid_invoices WHERE customer_id = 0 OR customer_id IS NULL" );
-
-		foreach ( $invoice_ids as $invoice_id ) {
-			$invoice = wpinv_get_invoice( $invoice_id );
-
-			if ( empty( $invoice ) ) {
-				continue;
-			}
-
-			// Fetch customer from the user ID.
-			$user_id = $invoice->get_user_id();
-
-			if ( empty( $user_id ) ) {
-				continue;
-			}
-
-			$customer = getpaid_get_customer_by_user_id( $user_id );
-
-			// Create if not exists.
-			if ( empty( $customer ) ) {
-				$customer = new GetPaid_Customer( 0 );
-				$customer->clone_user( $user_id );
-				$customer->save();
-			}
-
-			$invoice->set_customer_id( $customer->get_id() );
-			$invoice->save();
-		}
-
-	}
-
-	/**
-	 * 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'
-			);
-
-		}
-	}
-
-	/**
-	 * Returns the DB schema.
-	 *
-	 */
-	public static function get_db_schema() {
-		global $wpdb;
-
-		if ( ! empty( self::$schema ) ) {
-			return self::$schema;
-		}
+                    'parent'  => '',
+                ),
+
+            )
+        );
+
+    }
+
+    /**
+     * 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'] );
+        }
+
+    }
+
+    /**
+     * 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 customers to new table.
+     *
+     */
+    public static function migrate_old_customers() {
+        global $wpdb;
+
+        // Fetch post_id from $wpdb->prefix . 'getpaid_invoices' where customer_id = 0 or null.
+        $invoice_ids = $wpdb->get_col( "SELECT post_id FROM {$wpdb->prefix}getpaid_invoices WHERE customer_id = 0 OR customer_id IS NULL" );
+
+        foreach ( $invoice_ids as $invoice_id ) {
+            $invoice = wpinv_get_invoice( $invoice_id );
+
+            if ( empty( $invoice ) ) {
+                continue;
+            }
+
+            // Fetch customer from the user ID.
+            $user_id = $invoice->get_user_id();
+
+            if ( empty( $user_id ) ) {
+                continue;
+            }
+
+            $customer = getpaid_get_customer_by_user_id( $user_id );
+
+            // Create if not exists.
+            if ( empty( $customer ) ) {
+                $customer = new GetPaid_Customer( 0 );
+                $customer->clone_user( $user_id );
+                $customer->save();
+            }
+
+            $invoice->set_customer_id( $customer->get_id() );
+            $invoice->save();
+        }
+
+    }
+
+    /**
+     * 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'
+            );
+
+        }
+    }
+
+    /**
+     * Returns the DB schema.
+     *
+     */
+    public static function get_db_schema() {
+        global $wpdb;
+
+        if ( ! empty( self::$schema ) ) {
+            return self::$schema;
+        }
 
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
 
-		$charset_collate = $wpdb->get_charset_collate();
+        $charset_collate = $wpdb->get_charset_collate();
 
-		$schema = array();
+        $schema = array();
 
-		// Subscriptions.
-		$schema['subscriptions'] = "CREATE TABLE {$wpdb->prefix}wpinv_subscriptions (
+        // Subscriptions.
+        $schema['subscriptions'] = "CREATE TABLE {$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',
@@ -447,8 +447,8 @@ 
 			KEY customer_and_status (customer_id, status)
 		  ) $charset_collate;";
 
-		// Invoices.
-		$schema['invoices'] = "CREATE TABLE {$wpdb->prefix}getpaid_invoices (
+        // Invoices.
+        $schema['invoices'] = "CREATE TABLE {$wpdb->prefix}getpaid_invoices (
 			post_id BIGINT(20) NOT NULL,
 			customer_id BIGINT(20) NOT NULL DEFAULT 0,
             `number` VARCHAR(100),
@@ -485,8 +485,8 @@ 
 			KEY invoice_key (invoice_key)
 		  ) $charset_collate;";
 
-		// Invoice items.
-		$schema['items'] = "CREATE TABLE {$wpdb->prefix}getpaid_invoice_items (
+        // Invoice items.
+        $schema['items'] = "CREATE TABLE {$wpdb->prefix}getpaid_invoice_items (
 			ID BIGINT(20) NOT NULL AUTO_INCREMENT,
             post_id BIGINT(20) NOT NULL,
             item_id BIGINT(20) NOT NULL,
@@ -510,8 +510,8 @@ 
 			KEY price_id (price_id)
 		  ) $charset_collate;";
 
-		// Customers.
-		$schema['customers'] = "CREATE TABLE {$wpdb->prefix}getpaid_customers (
+        // Customers.
+        $schema['customers'] = "CREATE TABLE {$wpdb->prefix}getpaid_customers (
 			id BIGINT(20) NOT NULL AUTO_INCREMENT,
 			user_id BIGINT(20) NOT NULL,
 			email VARCHAR(100) NOT NULL,
@@ -521,38 +521,38 @@ 
 			purchase_count BIGINT(20) NOT NULL DEFAULT 0,
 			";
 
-		// Add address fields.
-		foreach ( array_keys( getpaid_user_address_fields( true ) ) as $field ) {
-			// Skip id, user_id and email.
-			if ( in_array( $field, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid' ), true ) ) {
-				continue;
-			}
-
-			$field   = sanitize_key( $field );
-			$length  = 100;
-			$default = '';
-
-			// Country.
-			if ( 'country' === $field ) {
-				$length  = 2;
-				$default = wpinv_get_default_country();
-			}
-
-			// State.
-			if ( 'state' === $field ) {
-				$default = wpinv_get_default_state();
-			}
-
-			// Phone, zip.
-			if ( in_array( $field, array( 'phone', 'zip' ), true ) ) {
-				$length = 20;
-			}
-
-			$schema['customers'] .= "`$field` VARCHAR($length) NOT NULL DEFAULT '$default',
+        // Add address fields.
+        foreach ( array_keys( getpaid_user_address_fields( true ) ) as $field ) {
+            // Skip id, user_id and email.
+            if ( in_array( $field, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid' ), true ) ) {
+                continue;
+            }
+
+            $field   = sanitize_key( $field );
+            $length  = 100;
+            $default = '';
+
+            // Country.
+            if ( 'country' === $field ) {
+                $length  = 2;
+                $default = wpinv_get_default_country();
+            }
+
+            // State.
+            if ( 'state' === $field ) {
+                $default = wpinv_get_default_state();
+            }
+
+            // Phone, zip.
+            if ( in_array( $field, array( 'phone', 'zip' ), true ) ) {
+                $length = 20;
+            }
+
+            $schema['customers'] .= "`$field` VARCHAR($length) NOT NULL DEFAULT '$default',
 			";
-		}
+        }
 
-		$schema['customers'] .= "date_created DATETIME NOT NULL,
+        $schema['customers'] .= "date_created DATETIME NOT NULL,
 			date_modified DATETIME NOT NULL,
 			uuid VARCHAR(100) NOT NULL,
 			PRIMARY KEY  (id),
@@ -560,8 +560,8 @@ 
 			KEY email (email)
 		  ) $charset_collate;";
 
-		// Customer meta.
-		$schema['customer_meta'] = "CREATE TABLE {$wpdb->prefix}getpaid_customer_meta (
+        // Customer meta.
+        $schema['customer_meta'] = "CREATE TABLE {$wpdb->prefix}getpaid_customer_meta (
 			meta_id BIGINT(20) NOT NULL AUTO_INCREMENT,
 			customer_id BIGINT(20) NOT NULL,
 			meta_key VARCHAR(255) NOT NULL,
@@ -571,75 +571,75 @@ 
 			KEY meta_key (meta_key(191))
 		  ) $charset_collate;";
 
-		// Filter.
-		$schema = apply_filters( 'getpaid_db_schema', $schema );
-
-		self::$schema         = implode( "\n", array_values( $schema ) );
-		self::$schema_version = md5( sanitize_key( self::$schema ) );
-
-		return self::$schema;
-	}
-
-	/**
-	 * Returns the DB schema version.
-	 *
-	 */
-	public static function get_db_schema_version() {
-		if ( ! empty( self::$schema_version ) ) {
-			return self::$schema_version;
-		}
-
-		self::get_db_schema();
-
-		return self::$schema_version;
-	}
-
-	/**
-	 * Checks if the db schema is up to date.
-	 *
-	 * @return bool
-	 */
-	public static function is_db_schema_up_to_date() {
-		return self::get_db_schema_version() === get_option( 'getpaid_db_schema' );
-	}
-
-	/**
-	 * Set up the database tables which the plugin needs to function.
-	 */
-	public static function create_db_tables() {
-		global $wpdb;
-
-		$wpdb->hide_errors();
-
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
-
-		$schema = self::get_db_schema();
-
-		// If invoices table exists, rename key to invoice_key.
-		$invoices_table = "{$wpdb->prefix}getpaid_invoices";
-
-		if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) === $invoices_table ) {
-			$fields = $wpdb->get_results( "SHOW COLUMNS FROM {$wpdb->prefix}getpaid_invoices" );
-
-			foreach ( $fields as $field ) {
-				if ( 'key' === $field->Field ) {
-					$wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices CHANGE `key` `invoice_key` VARCHAR(100)" );
-					break;
-				}
-			}
-		}
-
-		dbDelta( $schema );
-		wp_cache_flush();
-		update_option( 'getpaid_db_schema', self::get_db_schema_version() );
-	}
-
-	/**
-	 * Creates tables if schema is not up to date.
-	 */
-	public static function maybe_create_db_tables() {
-		if ( ! self::is_db_schema_up_to_date() ) {
-			self::create_db_tables();
-		}
-	}
+        // Filter.
+        $schema = apply_filters( 'getpaid_db_schema', $schema );
+
+        self::$schema         = implode( "\n", array_values( $schema ) );
+        self::$schema_version = md5( sanitize_key( self::$schema ) );
+
+        return self::$schema;
+    }
+
+    /**
+     * Returns the DB schema version.
+     *
+     */
+    public static function get_db_schema_version() {
+        if ( ! empty( self::$schema_version ) ) {
+            return self::$schema_version;
+        }
+
+        self::get_db_schema();
+
+        return self::$schema_version;
+    }
+
+    /**
+     * Checks if the db schema is up to date.
+     *
+     * @return bool
+     */
+    public static function is_db_schema_up_to_date() {
+        return self::get_db_schema_version() === get_option( 'getpaid_db_schema' );
+    }
+
+    /**
+     * Set up the database tables which the plugin needs to function.
+     */
+    public static function create_db_tables() {
+        global $wpdb;
+
+        $wpdb->hide_errors();
+
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+
+        $schema = self::get_db_schema();
+
+        // If invoices table exists, rename key to invoice_key.
+        $invoices_table = "{$wpdb->prefix}getpaid_invoices";
+
+        if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) === $invoices_table ) {
+            $fields = $wpdb->get_results( "SHOW COLUMNS FROM {$wpdb->prefix}getpaid_invoices" );
+
+            foreach ( $fields as $field ) {
+                if ( 'key' === $field->Field ) {
+                    $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices CHANGE `key` `invoice_key` VARCHAR(100)" );
+                    break;
+                }
+            }
+        }
+
+        dbDelta( $schema );
+        wp_cache_flush();
+        update_option( 'getpaid_db_schema', self::get_db_schema_version() );
+    }
+
+    /**
+     * Creates tables if schema is not up to date.
+     */
+    public static function maybe_create_db_tables() {
+        if ( ! self::is_db_schema_up_to_date() ) {
+            self::create_db_tables();
+        }
+    }
 }

includes/admin/meta-boxes/class-getpaid-meta-box-item-details.php

Indentation +1 added lines, -1 removed lines

@@ -696,7 +696,7 @@
                                     $extra_attributes,
                                     array( 'size' => 4 )
                                 ),
-							),
+                            ),
                             true
                         );
                         ?>

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

Indentation +388 added lines, -388 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,75 +10,75 @@ 
 class GetPaid_Form_Item extends WPInv_Item {
 
     /**
-	 * Stores a custom description for the item.
-	 *
-	 * @var string
-	 */
-	protected $custom_description = null;
-
-	/**
-	 * Stores the item quantity.
-	 *
-	 * @var float
-	 */
-	protected $quantity = 1;
-
-	/**
-	 * Stores the item meta.
-	 *
-	 * @var array
-	 */
-	protected $meta = array();
-
-	/**
-	 * Is this item required?
-	 *
-	 * @var int
-	 */
-	protected $is_required = true;
-
-	/**
-	 * Are quantities allowed?
-	 *
-	 * @var int
-	 */
-	protected $allow_quantities = false;
-
-	/**
-	 * Associated invoice.
-	 *
-	 * @var int
-	 */
-	public $invoice_id = 0;
-
-	/**
-	 * Item discount.
-	 *
-	 * @var float
-	 */
-	public $item_discount = 0;
-
-	/**
-	 * Recurring item discount.
-	 *
-	 * @var float
-	 */
-	public $recurring_item_discount = 0;
-
-	/**
-	 * Item tax.
-	 *
-	 * @var float
-	 */
-	public $item_tax = 0;
-
-
-    /**
-	 * Item price ID.
-	 *
-	 * @var int
-	 */
-	public $price_id = 0;
+     * Stores a custom description for the item.
+     *
+     * @var string
+     */
+    protected $custom_description = null;
+
+    /**
+     * Stores the item quantity.
+     *
+     * @var float
+     */
+    protected $quantity = 1;
+
+    /**
+     * Stores the item meta.
+     *
+     * @var array
+     */
+    protected $meta = array();
+
+    /**
+     * Is this item required?
+     *
+     * @var int
+     */
+    protected $is_required = true;
+
+    /**
+     * Are quantities allowed?
+     *
+     * @var int
+     */
+    protected $allow_quantities = false;
+
+    /**
+     * Associated invoice.
+     *
+     * @var int
+     */
+    public $invoice_id = 0;
+
+    /**
+     * Item discount.
+     *
+     * @var float
+     */
+    public $item_discount = 0;
+
+    /**
+     * Recurring item discount.
+     *
+     * @var float
+     */
+    public $recurring_item_discount = 0;
+
+    /**
+     * Item tax.
+     *
+     * @var float
+     */
+    public $item_tax = 0;
+
+
+    /**
+     * Item price ID.
+     *
+     * @var int
+     */
+    public $price_id = 0;
 
     /*
 	|--------------------------------------------------------------------------
@@ -96,242 +96,242 @@ 
     */
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		$name = parent::get_name( $context );
-		return $name . wpinv_get_item_suffix( $this );
-	}
-
-	/**
-	 * Get the item name without a suffix.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_raw_name( $context = 'view' ) {
-		return parent::get_name( $context );
-	}
-
-	/**
-	 * Get the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-
-		if ( isset( $this->custom_description ) ) {
-			return $this->custom_description;
-		}
-
-		return parent::get_description( $context );
-	}
-
-	/**
-	 * Returns the sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_sub_total( $context = 'view', $price_id = null ) {
-		return $this->get_quantity( $context ) * $this->get_initial_price( $context, $price_id );
-	}
-
-	/**
-	 * Returns the recurring sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_sub_total( $context = 'view' ) {
-
-		if ( $this->is_recurring() ) {
-			return $this->get_quantity( $context ) * $this->get_price( $context );
-		}
-
-		return 0;
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function get_qantity( $context = 'view' ) {
-		return $this->get_quantity( $context );
-	}
-
-	/**
-	 * Get the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_quantity( $context = 'view' ) {
-		$quantity = (float) $this->quantity;
-
-		if ( 'view' === $context ) {
-			return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this );
-		}
-
-		return $quantity;
-	}
-
-	/**
-	 * Get the item meta data.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return meta
-	 */
-	public function get_item_meta( $context = 'view' ) {
-		$meta = $this->meta;
-
-		if ( 'view' === $context ) {
-			return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this );
-		}
-
-		return $meta;
-	}
-
-	/**
-	 * Returns whether or not customers can update the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_allow_quantities( $context = 'view' ) {
-		$allow_quantities = (bool) $this->allow_quantities;
-
-		if ( 'view' === $context ) {
-			return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this );
-		}
-
-		return $allow_quantities;
-	}
-
-	/**
-	 * Returns whether or not the item is required.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_is_required( $context = 'view' ) {
-		$is_required = (bool) $this->is_required;
-
-		if ( 'view' === $context ) {
-			return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this );
-		}
-
-		return $is_required;
-	}
-
-    /**
-	 * Returns whether or not customers can update the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_price_id( $context = 'view' ) {
-		$price_id = (int) $this->price_id;
-
-		if ( 'view' === $context ) {
-			return apply_filters( 'getpaid_payment_form_item_price_id', $price_id, $this );
-		}
-
-		return $price_id;
-	}
-
-	/**
-	 * Prepares form data for use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_use( $required = null ) {
-
-		$required = is_null( $required ) ? $this->is_required() : $required;
-		return array(
-			'title'            => wp_strip_all_tags( $this->get_name() ),
-			'id'               => $this->get_id(),
-			'price'            => $this->get_price(),
-			'recurring'        => $this->is_recurring(),
-			'description'      => $this->get_description(),
-			'allow_quantities' => $this->allows_quantities(),
-			'price_id'         => $this->get_price_id(),
-			'required'         => $required,
-		);
-	}
-
-	/**
-	 * Prepares form data for ajax use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) {
-
-		$description = getpaid_item_recurring_price_help_text( $this, $currency );
-
-		if ( $description ) {
-			$description = "<div class='getpaid-subscription-help-text'>$description</div>";
-		}
-
-		$price    = ! $is_renewal ? $this->get_price() : $this->get_recurring_price();
-		$subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total();
-		return array(
-			'id'     => $this->get_id(),
-			'texts'  => array(
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ) . $description,
-				'item-quantity'    => floatval( $this->get_quantity() ),
-				'item-price'       => wpinv_price( $price, $currency ),
-				'item-total'       => wpinv_price( $subtotal, $currency ),
-			),
-			'inputs' => array(
-				'item-id'          => $this->get_id(),
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ),
-				'item-quantity'    => floatval( $this->get_quantity() ),
-				'item-price'       => $price,
-			),
-		);
-	}
-
-	/**
-	 * Prepares form data for saving (cart_details).
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_saving() {
-
-		return array(
-			'post_id'          => $this->invoice_id,
-			'item_id'          => $this->get_id(),
-			'item_name'        => sanitize_text_field( $this->get_raw_name( 'edit' ) ),
-			'item_description' => $this->get_description( 'edit' ),
-			'tax'              => $this->item_tax,
-			'item_price'       => $this->get_price( 'edit' ),
-			'quantity'         => (float) $this->get_quantity( 'edit' ),
-			'discount'         => $this->item_discount,
-			'subtotal'         => $this->get_sub_total( 'edit' ),
-			'price'            => $this->get_sub_total( 'edit' ) + $this->item_tax - $this->item_discount,
-			'price_id'         => (int) $this->get_price_id( 'edit' ),
-			'meta'             => $this->get_item_meta( 'edit' ),
-		);
-	}
+     * Get the item name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        $name = parent::get_name( $context );
+        return $name . wpinv_get_item_suffix( $this );
+    }
+
+    /**
+     * Get the item name without a suffix.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_raw_name( $context = 'view' ) {
+        return parent::get_name( $context );
+    }
+
+    /**
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+
+        if ( isset( $this->custom_description ) ) {
+            return $this->custom_description;
+        }
+
+        return parent::get_description( $context );
+    }
+
+    /**
+     * Returns the sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_sub_total( $context = 'view', $price_id = null ) {
+        return $this->get_quantity( $context ) * $this->get_initial_price( $context, $price_id );
+    }
+
+    /**
+     * Returns the recurring sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_sub_total( $context = 'view' ) {
+
+        if ( $this->is_recurring() ) {
+            return $this->get_quantity( $context ) * $this->get_price( $context );
+        }
+
+        return 0;
+    }
+
+    /**
+     * @deprecated
+     */
+    public function get_qantity( $context = 'view' ) {
+        return $this->get_quantity( $context );
+    }
+
+    /**
+     * Get the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_quantity( $context = 'view' ) {
+        $quantity = (float) $this->quantity;
+
+        if ( 'view' === $context ) {
+            return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this );
+        }
+
+        return $quantity;
+    }
+
+    /**
+     * Get the item meta data.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return meta
+     */
+    public function get_item_meta( $context = 'view' ) {
+        $meta = $this->meta;
+
+        if ( 'view' === $context ) {
+            return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this );
+        }
+
+        return $meta;
+    }
+
+    /**
+     * Returns whether or not customers can update the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_allow_quantities( $context = 'view' ) {
+        $allow_quantities = (bool) $this->allow_quantities;
+
+        if ( 'view' === $context ) {
+            return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this );
+        }
+
+        return $allow_quantities;
+    }
+
+    /**
+     * Returns whether or not the item is required.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_is_required( $context = 'view' ) {
+        $is_required = (bool) $this->is_required;
+
+        if ( 'view' === $context ) {
+            return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this );
+        }
+
+        return $is_required;
+    }
+
+    /**
+     * Returns whether or not customers can update the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_price_id( $context = 'view' ) {
+        $price_id = (int) $this->price_id;
+
+        if ( 'view' === $context ) {
+            return apply_filters( 'getpaid_payment_form_item_price_id', $price_id, $this );
+        }
+
+        return $price_id;
+    }
+
+    /**
+     * Prepares form data for use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_use( $required = null ) {
+
+        $required = is_null( $required ) ? $this->is_required() : $required;
+        return array(
+            'title'            => wp_strip_all_tags( $this->get_name() ),
+            'id'               => $this->get_id(),
+            'price'            => $this->get_price(),
+            'recurring'        => $this->is_recurring(),
+            'description'      => $this->get_description(),
+            'allow_quantities' => $this->allows_quantities(),
+            'price_id'         => $this->get_price_id(),
+            'required'         => $required,
+        );
+    }
+
+    /**
+     * Prepares form data for ajax use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) {
+
+        $description = getpaid_item_recurring_price_help_text( $this, $currency );
+
+        if ( $description ) {
+            $description = "<div class='getpaid-subscription-help-text'>$description</div>";
+        }
+
+        $price    = ! $is_renewal ? $this->get_price() : $this->get_recurring_price();
+        $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total();
+        return array(
+            'id'     => $this->get_id(),
+            'texts'  => array(
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ) . $description,
+                'item-quantity'    => floatval( $this->get_quantity() ),
+                'item-price'       => wpinv_price( $price, $currency ),
+                'item-total'       => wpinv_price( $subtotal, $currency ),
+            ),
+            'inputs' => array(
+                'item-id'          => $this->get_id(),
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ),
+                'item-quantity'    => floatval( $this->get_quantity() ),
+                'item-price'       => $price,
+            ),
+        );
+    }
+
+    /**
+     * Prepares form data for saving (cart_details).
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_saving() {
+
+        return array(
+            'post_id'          => $this->invoice_id,
+            'item_id'          => $this->get_id(),
+            'item_name'        => sanitize_text_field( $this->get_raw_name( 'edit' ) ),
+            'item_description' => $this->get_description( 'edit' ),
+            'tax'              => $this->item_tax,
+            'item_price'       => $this->get_price( 'edit' ),
+            'quantity'         => (float) $this->get_quantity( 'edit' ),
+            'discount'         => $this->item_discount,
+            'subtotal'         => $this->get_sub_total( 'edit' ),
+            'price'            => $this->get_sub_total( 'edit' ) + $this->item_tax - $this->item_discount,
+            'price_id'         => (int) $this->get_price_id( 'edit' ),
+            'meta'             => $this->get_item_meta( 'edit' ),
+        );
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -343,84 +343,84 @@ 
 	| object.
     */
 
-	/**
-	 * Set the item qantity.
-	 *
-	 * @since 1.0.19
-	 * @param  float $quantity The item quantity.
-	 */
-	public function set_quantity( $quantity ) {
+    /**
+     * Set the item qantity.
+     *
+     * @since 1.0.19
+     * @param  float $quantity The item quantity.
+     */
+    public function set_quantity( $quantity ) {
+
+        if ( ! is_numeric( $quantity ) ) {
+            $quantity = 1;
+        }
+
+        $this->quantity = (float) $quantity;
+    }
+
+    /**
+     * Set the item price ID.
+     *
+     * @since 1.0.19
+     * @param  float $price_id The item price ID.
+     */
+    public function set_price_id( $price_id ) {
+
+        if ( ! is_numeric( $price_id ) ) {
+            $price_id = $this->get_default_price_id();
+        }
 
-		if ( ! is_numeric( $quantity ) ) {
-			$quantity = 1;
-		}
+        $this->price_id = (int) $price_id;
+    }
 
-		$this->quantity = (float) $quantity;
+    /**
+     * Set the item meta data.
+     *
+     * @since 1.0.19
+     * @param  array $meta The item meta data.
+     */
+    public function set_item_meta( $meta ) {
+        $this->meta = maybe_unserialize( $meta );
     }
 
     /**
-	 * Set the item price ID.
-	 *
-	 * @since 1.0.19
-	 * @param  float $price_id The item price ID.
-	 */
-	public function set_price_id( $price_id ) {
-
-		if ( ! is_numeric( $price_id ) ) {
-			$price_id = $this->get_default_price_id();
-		}
-
-		$this->price_id = (int) $price_id;
-	}
-
-	/**
-	 * Set the item meta data.
-	 *
-	 * @since 1.0.19
-	 * @param  array $meta The item meta data.
-	 */
-	public function set_item_meta( $meta ) {
-		$this->meta = maybe_unserialize( $meta );
-	}
-
-	/**
-	 * Set whether or not the quantities are allowed.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $allow_quantities
-	 */
-	public function set_allow_quantities( $allow_quantities ) {
-		$this->allow_quantities = (bool) $allow_quantities;
-	}
-
-	/**
-	 * Set whether or not the item is required.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $is_required
-	 */
-	public function set_is_required( $is_required ) {
-		$this->is_required = (bool) $is_required;
-	}
-
-	/**
-	 * Sets the custom item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $description
-	 */
-	public function set_custom_description( $description ) {
-		$this->custom_description = $description;
-	}
+     * Set whether or not the quantities are allowed.
+     *
+     * @since 1.0.19
+     * @param  bool $allow_quantities
+     */
+    public function set_allow_quantities( $allow_quantities ) {
+        $this->allow_quantities = (bool) $allow_quantities;
+    }
+
+    /**
+     * Set whether or not the item is required.
+     *
+     * @since 1.0.19
+     * @param  bool $is_required
+     */
+    public function set_is_required( $is_required ) {
+        $this->is_required = (bool) $is_required;
+    }
+
+    /**
+     * Sets the custom item description.
+     *
+     * @since 1.0.19
+     * @param  string $description
+     */
+    public function set_custom_description( $description ) {
+        $this->custom_description = $description;
+    }
 
     /**
      * We do not want to save items to the database.
      *
-	 * @return int item id
+     * @return int item id
      */
     public function save( $data = array() ) {
         return $this->get_id();
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -432,22 +432,22 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_required() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_required() {
         return (bool) $this->get_is_required();
-	}
-
-	/**
-	 * Checks whether users can edit the quantities.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function allows_quantities() {
+    }
+
+    /**
+     * Checks whether users can edit the quantities.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function allows_quantities() {
         return (bool) $this->get_allow_quantities();
-	}
+    }
 }

includes/payments/class-getpaid-checkout.php

Indentation +308 added lines, -308 removed lines

@@ -12,185 +12,185 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items    = $this->get_submission_items();
-		$invoice  = $this->get_submission_invoice();
-		$invoice  = $this->process_submission_invoice( $invoice, $items );
-		$prepared = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->set_is_viewed( true );
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items    = $this->get_submission_items();
+        $invoice  = $this->get_submission_invoice();
+        $invoice  = $this->process_submission_invoice( $invoice, $items );
+        $prepared = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->set_is_viewed( true );
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	} 
+    } 
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->set_created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
+
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->set_created_via( 'payment_form' );
+            return $invoice;
+        }
 
-		return $invoice;
-	}
+        $invoice = $submission->get_invoice();
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		$submission = $this->payment_form_submission;
+        return $invoice;
+    }
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_submission_id( $submission->id );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
+
+        $submission = $this->payment_form_submission;
+
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_submission_id( $submission->id );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
-		$invoice->set_currency( $submission->get_currency() );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
+        $invoice->set_currency( $submission->get_currency() );
 
-		if ( $submission->has_shipping() ) {
-			$invoice->set_shipping( $submission->get_shipping() );
-		}
+        if ( $submission->has_shipping() ) {
+            $invoice->set_shipping( $submission->get_shipping() );
+        }
 
-		$address_confirmed = $submission->get_field( 'confirm-address' );
-		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
+        $address_confirmed = $submission->get_field( 'confirm-address' );
+        $invoice->set_address_confirmed( ! empty( $address_confirmed ) );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -198,16 +198,16 @@ 
         }
 
         if ( empty( $user ) ) {
-			$name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
-			$name = implode( '', array_filter( $name ) );
+            $name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
+            $name = implode( '', array_filter( $name ) );
             $user = wpinv_create_user( $submission->get_billing_email(), $name );
 
-			// (Maybe) send new user notification.
-			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
-				wp_send_new_user_notifications( $user, 'user' );
-			}
-		}
+            // (Maybe) send new user notification.
+            $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+            if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
+                wp_send_new_user_notifications( $user, 'user' );
+            }
+        }
 
         if ( is_wp_error( $user ) ) {
             wp_send_json_error( $user->get_error_message() );
@@ -215,47 +215,47 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array(
-			'all'  => array(),
-			'meta' => array(),
-		);
+            'all'  => array(),
+            'meta' => array(),
+        );
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) ) {
                 continue;
             }
 
-			// Ensure address is provided.
-			if ( 'address' === $field['type'] ) {
+            // Ensure address is provided.
+            if ( 'address' === $field['type'] ) {
                 $address_type = isset( $field['address_type'] ) && 'shipping' === $field['address_type'] ? 'shipping' : 'billing';
 
-				foreach ( $field['fields'] as $address_field ) {
+                foreach ( $field['fields'] as $address_field ) {
 
-					if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
-						wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
-					}
+                    if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+                        wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
+                    }
                 }
             }
 
@@ -267,31 +267,31 @@ 
             // Handle misc fields.
             if ( isset( $data[ $field['id'] ] ) ) {
 
-				// Uploads.
-				if ( 'file_upload' === $field['type'] ) {
-					$max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
+                // Uploads.
+                if ( 'file_upload' === $field['type'] ) {
+                    $max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
 
-					if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
-						wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
-					}
+                    if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
+                        wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
+                    }
 
-					$value = array();
+                    $value = array();
 
-					foreach ( $data[ $field['id'] ] as $url => $name ) {
-						$value[] = sprintf(
-							'<a href="%s" target="_blank">%s</a>',
-							esc_url_raw( $url ),
-							esc_html( $name )
-						);
-					}
+                    foreach ( $data[ $field['id'] ] as $url => $name ) {
+                        $value[] = sprintf(
+                            '<a href="%s" target="_blank">%s</a>',
+                            esc_url_raw( $url ),
+                            esc_html( $name )
+                        );
+                    }
 
-					$value = implode( ' | ', $value );
+                    $value = implode( ' | ', $value );
 
-				} elseif ( 'checkbox' === $field['type'] ) {
-					$value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
-				} else {
-					$value = wp_kses_post( $data[ $field['id'] ] );
-				}
+                } elseif ( 'checkbox' === $field['type'] ) {
+                    $value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
+                } else {
+                    $value = wp_kses_post( $data[ $field['id'] ] );
+                }
 
                 $label = $field['id'];
 
@@ -299,192 +299,192 @@ 
                     $label = $field['label'];
                 }
 
-				if ( ! empty( $field['add_meta'] ) ) {
-					$prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
-				}
-				$prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                if ( ! empty( $field['add_meta'] ) ) {
+                    $prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                }
+                $prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
 
             }
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
 
-		// Save payment form data.
-		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
+        // Save payment form data.
+        $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
         delete_post_meta( $invoice->get_id(), 'payment_form_data' );
-		delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
-		if ( ! empty( $prepared_payment_form_data ) ) {
+        delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
+        if ( ! empty( $prepared_payment_form_data ) ) {
 
-			if ( ! empty( $prepared_payment_form_data['all'] ) ) {
-				update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
-			}
+            if ( ! empty( $prepared_payment_form_data['all'] ) ) {
+                update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
+            }
 
-			if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
-				update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
-			}
-		}
+            if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
+                update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
+            }
+        }
 
-		// Save payment form data.
-		$shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
+        // Save payment form data.
+        $shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		try {
-			$this->process_payment( $invoice );
-		} catch ( Exception $e ) {
-			wpinv_set_error( 'payment_error', $e->getMessage() );
-		}
+        try {
+            $this->process_payment( $invoice );
+        } catch ( Exception $e ) {
+            wpinv_set_error( 'payment_error', $e->getMessage() );
+        }
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency' );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency' );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */

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

Indentation +57 added lines, -57 removed lines

@@ -12,28 +12,28 @@ 
  */
 class GetPaid_Payment_Form_Submission_Items {
 
-	/**
-	 * Submission items.
-	 * @var GetPaid_Form_Item[]
-	 */
-	public $items = array();
+    /**
+     * Submission items.
+     * @var GetPaid_Form_Item[]
+     */
+    public $items = array();
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$data         = $submission->get_data();
-		$payment_form = $submission->get_payment_form();
-		$invoice      = $submission->get_invoice();
-		$force_prices = array();
-
-		// Prepare the selected items.
-		$selected_items = array();
-		if ( ! empty( $data['getpaid-items'] ) ) {
-			$selected_items = wpinv_clean( $data['getpaid-items'] );
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $data         = $submission->get_data();
+        $payment_form = $submission->get_payment_form();
+        $invoice      = $submission->get_invoice();
+        $force_prices = array();
+
+        // Prepare the selected items.
+        $selected_items = array();
+        if ( ! empty( $data['getpaid-items'] ) ) {
+            $selected_items = wpinv_clean( $data['getpaid-items'] );
 
             if ( is_array( $submission->get_field( 'getpaid-variable-items' ) ) ) {
                 $selected_prices = $submission->get_field( 'getpaid-variable-items' );
@@ -46,28 +46,28 @@ 
                 );
             }
 
-			if ( ! empty( $invoice ) && $submission->is_initial_fetch() ) {
-				foreach ( $invoice->get_items() as $invoice_item ) {
+            if ( ! empty( $invoice ) && $submission->is_initial_fetch() ) {
+                foreach ( $invoice->get_items() as $invoice_item ) {
                     if ( ! $invoice_item->has_variable_pricing() && isset( $selected_items[ $invoice_item->get_id() ] ) ) {
                         $selected_items[ $invoice_item->get_id() ]['quantity'] = $invoice_item->get_quantity();
                         $selected_items[ $invoice_item->get_id() ]['price']    = $invoice_item->get_price();
 
                         $force_prices[ $invoice_item->get_id() ] = $invoice_item->get_price();
                     }
-				}
-			}
-		}
+                }
+            }
+        }
 
-		// (Maybe) set form items.
-		if ( isset( $data['getpaid-form-items'] ) ) {
+        // (Maybe) set form items.
+        if ( isset( $data['getpaid-form-items'] ) ) {
 
-			// Confirm items key.
-			$form_items = wpinv_clean( $data['getpaid-form-items'] );
-			if ( ! isset( $data['getpaid-form-items-key'] ) || md5( NONCE_KEY . AUTH_KEY . $form_items ) !== $data['getpaid-form-items-key'] ) {
-				throw new Exception( __( 'We could not validate the form items. Please reload the page and try again.', 'invoicing' ) );
-			}
+            // Confirm items key.
+            $form_items = wpinv_clean( $data['getpaid-form-items'] );
+            if ( ! isset( $data['getpaid-form-items-key'] ) || md5( NONCE_KEY . AUTH_KEY . $form_items ) !== $data['getpaid-form-items-key'] ) {
+                throw new Exception( __( 'We could not validate the form items. Please reload the page and try again.', 'invoicing' ) );
+            }
 
-			$items    = array();
+            $items    = array();
             $item_ids = array();
 
             foreach ( getpaid_convert_items_to_array( $form_items ) as $item_id => $qty ) {
@@ -101,25 +101,25 @@ 
                         $items[]    = $item;
                     }
                 }
-			}
+            }
 
             $payment_form->set_items( $items );
-		}
-
-		// Process each individual item.
-		foreach ( $payment_form->get_items() as $item ) {
-			$this->process_item( $item, $selected_items, $submission );
-		}
-	}
-
-	/**
-	 * Process a single item.
-	 *
-	 * @param GetPaid_Form_Item $item
-	 * @param array $selected_items
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function process_item( $item, $selected_items, $submission ) {
+        }
+
+        // Process each individual item.
+        foreach ( $payment_form->get_items() as $item ) {
+            $this->process_item( $item, $selected_items, $submission );
+        }
+    }
+
+    /**
+     * Process a single item.
+     *
+     * @param GetPaid_Form_Item $item
+     * @param array $selected_items
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function process_item( $item, $selected_items, $submission ) {
 
         if ( $item->has_variable_pricing() ) {
 
@@ -165,7 +165,7 @@ 
                 }
             }
         } else {
-		    // Abort if this is an optional item and it has not been selected.
+            // Abort if this is an optional item and it has not been selected.
             if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) {
                 return;
             }
@@ -191,11 +191,11 @@ 
             }
         }
 
-		if ( 0 == $item->get_quantity() ) {
-			return;
-		}
+        if ( 0 == $item->get_quantity() ) {
+            return;
+        }
 
-		// Save the item.
-		$this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item', $item, $submission );
-	}
+        // Save the item.
+        $this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item', $item, $submission );
+    }
 }

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

Indentation +868 added lines, -868 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,197 +10,197 @@ 
 class GetPaid_Payment_Form_Submission {
 
     /**
-	 * Submission ID
-	 *
-	 * @var string
-	 */
-	public $id = null;
-
-	/**
-	 * The raw submission data.
-	 *
-	 * @var array
-	 */
-	protected $data = null;
-
-	/**
-	 * Submission totals
-	 *
-	 * @var array
-	 */
-	protected $totals = array(
-
-		'subtotal' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'discount' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'fees'     => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'taxes'    => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'shipping' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-	);
-
-	/**
-	 * Sets the associated payment form.
-	 *
-	 * @var GetPaid_Payment_Form
-	 */
+     * Submission ID
+     *
+     * @var string
+     */
+    public $id = null;
+
+    /**
+     * The raw submission data.
+     *
+     * @var array
+     */
+    protected $data = null;
+
+    /**
+     * Submission totals
+     *
+     * @var array
+     */
+    protected $totals = array(
+
+        'subtotal' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'discount' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'fees'     => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'taxes'    => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'shipping' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+    );
+
+    /**
+     * Sets the associated payment form.
+     *
+     * @var GetPaid_Payment_Form
+     */
     protected $payment_form = null;
 
     /**
-	 * The country for the submission.
-	 *
-	 * @var string
-	 */
-	public $country = null;
-
-    /**
-	 * The state for the submission.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $state = null;
-
-	/**
-	 * The invoice associated with the submission.
-	 *
-	 * @var WPInv_Invoice
-	 */
-	protected $invoice = null;
-
-	/**
-	 * The recurring item for the submission.
-	 *
-	 * @var int
-	 */
-	public $has_recurring = 0;
-
-	/**
-	 * An array of fees for the submission.
-	 *
-	 * @var array
-	 */
-	protected $fees = array();
-
-	/**
-	 * An array of discounts for the submission.
-	 *
-	 * @var array
-	 */
-	protected $discounts = array();
-
-	/**
-	 * An array of taxes for the submission.
-	 *
-	 * @var array
-	 */
-	protected $taxes = array();
-
-	/**
-	 * An array of items for the submission.
-	 *
-	 * @var GetPaid_Form_Item[]
-	 */
-	protected $items = array();
-
-	/**
-	 * The last error.
-	 *
-	 * @var string
-	 */
-	public $last_error = null;
-
-	/**
-	 * The last error code.
-	 *
-	 * @var string
-	 */
-	public $last_error_code = null;
-
-    /**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-
-		// Set the state and country to the default state and country.
-		$this->country = wpinv_default_billing_country();
-		$this->state   = wpinv_get_default_state();
-
-		// Do we have an actual submission?
-		if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
-			$this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
-		}
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Allow plugins to filter the data.
-		$data       = apply_filters( 'getpaid_submission_data', $data, $this );
-
-		// Cache it...
-		$this->data = $data;
-
-		// Then generate a unique id from the data.
-		$this->id   = md5( wp_json_encode( $data ) );
-
-		// Finally, process the submission.
-		try {
-
-			// Each process is passed an instance of the class (with reference)
-			// and should throw an Exception whenever it encounters one.
-			$processors = apply_filters(
-				'getpaid_payment_form_submission_processors',
-				array(
-					array( $this, 'process_payment_form' ),
-					array( $this, 'process_invoice' ),
-					array( $this, 'process_fees' ),
-					array( $this, 'process_items' ),
-					array( $this, 'process_discount' ),
-					array( $this, 'process_taxes' ),
-				),
-				$this
-			);
-
-			foreach ( $processors as $processor ) {
-				call_user_func_array( $processor, array( &$this ) );
-			}
-		} catch ( GetPaid_Payment_Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getErrorCode();
-		} catch ( Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getCode();
-		}
-
-		// Fired when we are done processing a submission.
-		do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
-	}
-
-	/*
+     * The country for the submission.
+     *
+     * @var string
+     */
+    public $country = null;
+
+    /**
+     * The state for the submission.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $state = null;
+
+    /**
+     * The invoice associated with the submission.
+     *
+     * @var WPInv_Invoice
+     */
+    protected $invoice = null;
+
+    /**
+     * The recurring item for the submission.
+     *
+     * @var int
+     */
+    public $has_recurring = 0;
+
+    /**
+     * An array of fees for the submission.
+     *
+     * @var array
+     */
+    protected $fees = array();
+
+    /**
+     * An array of discounts for the submission.
+     *
+     * @var array
+     */
+    protected $discounts = array();
+
+    /**
+     * An array of taxes for the submission.
+     *
+     * @var array
+     */
+    protected $taxes = array();
+
+    /**
+     * An array of items for the submission.
+     *
+     * @var GetPaid_Form_Item[]
+     */
+    protected $items = array();
+
+    /**
+     * The last error.
+     *
+     * @var string
+     */
+    public $last_error = null;
+
+    /**
+     * The last error code.
+     *
+     * @var string
+     */
+    public $last_error_code = null;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+
+        // Set the state and country to the default state and country.
+        $this->country = wpinv_default_billing_country();
+        $this->state   = wpinv_get_default_state();
+
+        // Do we have an actual submission?
+        if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
+            $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
+        }
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Allow plugins to filter the data.
+        $data       = apply_filters( 'getpaid_submission_data', $data, $this );
+
+        // Cache it...
+        $this->data = $data;
+
+        // Then generate a unique id from the data.
+        $this->id   = md5( wp_json_encode( $data ) );
+
+        // Finally, process the submission.
+        try {
+
+            // Each process is passed an instance of the class (with reference)
+            // and should throw an Exception whenever it encounters one.
+            $processors = apply_filters(
+                'getpaid_payment_form_submission_processors',
+                array(
+                    array( $this, 'process_payment_form' ),
+                    array( $this, 'process_invoice' ),
+                    array( $this, 'process_fees' ),
+                    array( $this, 'process_items' ),
+                    array( $this, 'process_discount' ),
+                    array( $this, 'process_taxes' ),
+                ),
+                $this
+            );
+
+            foreach ( $processors as $processor ) {
+                call_user_func_array( $processor, array( &$this ) );
+            }
+        } catch ( GetPaid_Payment_Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getErrorCode();
+        } catch ( Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getCode();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -209,39 +209,39 @@ 
 	| submission has an active payment form etc.
     */
 
-	/**
-	 * Prepares the submission's payment form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_payment_form() {
+    /**
+     * Prepares the submission's payment form.
+     *
+     * @since 1.0.19
+     */
+    public function process_payment_form() {
 
-		// Every submission needs an active payment form.
-		if ( empty( $this->data['form_id'] ) ) {
-			throw new Exception( __( 'Missing payment form', 'invoicing' ) );
-		}
+        // Every submission needs an active payment form.
+        if ( empty( $this->data['form_id'] ) ) {
+            throw new Exception( __( 'Missing payment form', 'invoicing' ) );
+        }
 
-		// Fetch the payment form.
-		$this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
+        // Fetch the payment form.
+        $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
 
-		if ( ! $this->payment_form->is_active() ) {
-			throw new Exception( __( 'Payment form not active', 'invoicing' ) );
-		}
+        if ( ! $this->payment_form->is_active() ) {
+            throw new Exception( __( 'Payment form not active', 'invoicing' ) );
+        }
 
-		do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
-	}
+        do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
+    }
 
     /**
-	 * Returns the payment form.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Payment_Form
-	 */
-	public function get_payment_form() {
-		return $this->payment_form;
-	}
+     * Returns the payment form.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Payment_Form
+     */
+    public function get_payment_form() {
+        return $this->payment_form;
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Invoices.
 	|--------------------------------------------------------------------------
@@ -250,95 +250,95 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_invoice() {
-
-		// Abort if there is no invoice.
-		if ( empty( $this->data['invoice_id'] ) ) {
-
-			// Check if we are resuming a payment.
-			if ( empty( $this->data['maybe_use_invoice'] ) ) {
-				return;
-			}
-
-			$invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
-			if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
-				return;
-			}
-		}
-
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		if ( empty( $invoice ) ) {
-			$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
-		}
+    /**
+     * Prepares the submission's invoice.
+     *
+     * @since 1.0.19
+     */
+    public function process_invoice() {
+
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+
+            // Check if we are resuming a payment.
+            if ( empty( $this->data['maybe_use_invoice'] ) ) {
+                return;
+            }
+
+            $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
+            if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
+                return;
+            }
+        }
+
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        if ( empty( $invoice ) ) {
+            $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        }
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
-
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
-
-		$this->payment_form->invoice = $invoice;
-		if ( ! $this->payment_form->is_default() ) {
-
-			$items    = array();
-			$item_ids = array();
-
-			foreach ( $invoice->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			foreach ( $this->payment_form->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			$this->payment_form->set_items( $items );
-
-		} else {
-			$this->payment_form->set_items( $invoice->get_items() );
-		}
-
-		$this->country = $invoice->get_country();
-		$this->state   = $invoice->get_state();
-		$this->invoice = $invoice;
-
-		do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
-	}
-
-	/**
-	 * Returns the associated invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
-	public function get_invoice() {
-		return $this->invoice;
-	}
-
-	/**
-	 * Checks whether there is an invoice associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_invoice() {
-		return ! empty( $this->invoice );
-	}
-
-	/*
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
+
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
+
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
+
+            $items    = array();
+            $item_ids = array();
+
+            foreach ( $invoice->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            foreach ( $this->payment_form->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            $this->payment_form->set_items( $items );
+
+        } else {
+            $this->payment_form->set_items( $invoice->get_items() );
+        }
+
+        $this->country = $invoice->get_country();
+        $this->state   = $invoice->get_state();
+        $this->invoice = $invoice;
+
+        do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
+    }
+
+    /**
+     * Returns the associated invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
+    public function get_invoice() {
+        return $this->invoice;
+    }
+
+    /**
+     * Checks whether there is an invoice associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_invoice() {
+        return ! empty( $this->invoice );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Items.
 	|--------------------------------------------------------------------------
@@ -347,127 +347,127 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-			$this->has_recurring = $item->get_id();
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-	}
-
-	/**
-	 * Removes a specific item.
-	 *
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/**
-	 * Checks if there's a single subscription group in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_subscription_group() {
-		return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/**
-	 * Checks if there are multipe subscription groups in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_multiple_subscription_groups() {
-		return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+            $this->has_recurring = $item->get_id();
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+    }
+
+    /**
+     * Removes a specific item.
+     *
+     * You should not call this method after the discounts and taxes
+     * have been calculated.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
+
+        if ( isset( $this->items[ $item_id ] ) ) {
+            $this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
+            $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
+
+            if ( $this->items[ $item_id ]->is_recurring() ) {
+                $this->has_recurring = 0;
+            }
+
+            unset( $this->items[ $item_id ] );
+        }
+    }
+
+    /**
+     * Returns the subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
+        }
+
+        return $this->totals['subtotal']['initial'];
+    }
+
+    /**
+     * Returns the recurring subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
+        }
+
+        return $this->totals['subtotal']['recurring'];
+    }
+
+    /**
+     * Returns all items.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items() {
+        return $this->items;
+    }
+
+    /**
+     * Checks if there's a single subscription group in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_subscription_group() {
+        return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /**
+     * Checks if there are multipe subscription groups in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_multiple_subscription_groups() {
+        return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -476,125 +476,125 @@ 
 	| or only one-time.
     */
 
-	/**
-	 * Prepares the submission's taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_taxes() {
-
-		// Abort if we're not using taxes.
-		if ( ! $this->use_taxes() ) {
-			return;
-		}
-
-		// If a custom country && state has been passed in, use it to calculate taxes.
-		$country = $this->get_field( 'wpinv_country', 'billing' );
-		if ( ! empty( $country ) ) {
-			$this->country = $country;
-		}
-
-		$state = $this->get_field( 'wpinv_state', 'billing' );
-		if ( ! empty( $state ) ) {
-			$this->state = $state;
-		}
-
-		// Confirm if the provided country and the ip country are similar.
-		$address_confirmed = $this->get_field( 'confirm-address' );
-		if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
-			throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
-		}
-
-		// Abort if the country is not taxable.
-		if ( ! wpinv_is_country_taxable( $this->country ) ) {
-			return;
-		}
-
-		$processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
-
-		foreach ( $processor->taxes as $tax ) {
-			$this->add_tax( $tax );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
-	}
-
-	/**
-	 * Adds a tax to the submission.
-	 *
-	 * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
-	 * @since 1.0.19
-	 */
-	public function add_tax( $tax ) {
-
-		if ( wpinv_round_tax_per_tax_rate() ) {
-			$tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
-			$tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
-		}
-
-		$this->taxes[ $tax['name'] ]         = $tax;
-		$this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
-		$this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
-	}
-
-	/**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax_name ) {
-
-		if ( isset( $this->taxes[ $tax_name ] ) ) {
-			$this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
-			$this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
-			unset( $this->taxes[ $tax_name ] );
-		}
-	}
-
-	/**
-	 * Whether or not we'll use taxes for the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function use_taxes() {
-
-		$use_taxes = wpinv_use_taxes();
-
-		if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
-			$use_taxes = false;
-		}
-
-		return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
-	}
-
-	/**
-	 * Returns the tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax() {
-		return $this->totals['taxes']['initial'];
-	}
-
-	/**
-	 * Returns the recurring tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_tax() {
-		return $this->totals['taxes']['recurring'];
-	}
-
-	/**
-	 * Returns all taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_taxes() {
-		return $this->taxes;
-	}
-
-	/*
+    /**
+     * Prepares the submission's taxes.
+     *
+     * @since 1.0.19
+     */
+    public function process_taxes() {
+
+        // Abort if we're not using taxes.
+        if ( ! $this->use_taxes() ) {
+            return;
+        }
+
+        // If a custom country && state has been passed in, use it to calculate taxes.
+        $country = $this->get_field( 'wpinv_country', 'billing' );
+        if ( ! empty( $country ) ) {
+            $this->country = $country;
+        }
+
+        $state = $this->get_field( 'wpinv_state', 'billing' );
+        if ( ! empty( $state ) ) {
+            $this->state = $state;
+        }
+
+        // Confirm if the provided country and the ip country are similar.
+        $address_confirmed = $this->get_field( 'confirm-address' );
+        if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
+            throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
+        }
+
+        // Abort if the country is not taxable.
+        if ( ! wpinv_is_country_taxable( $this->country ) ) {
+            return;
+        }
+
+        $processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
+
+        foreach ( $processor->taxes as $tax ) {
+            $this->add_tax( $tax );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
+    }
+
+    /**
+     * Adds a tax to the submission.
+     *
+     * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
+     * @since 1.0.19
+     */
+    public function add_tax( $tax ) {
+
+        if ( wpinv_round_tax_per_tax_rate() ) {
+            $tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
+            $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
+        }
+
+        $this->taxes[ $tax['name'] ]         = $tax;
+        $this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
+        $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
+    }
+
+    /**
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax_name ) {
+
+        if ( isset( $this->taxes[ $tax_name ] ) ) {
+            $this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
+            $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
+            unset( $this->taxes[ $tax_name ] );
+        }
+    }
+
+    /**
+     * Whether or not we'll use taxes for the submission.
+     *
+     * @since 1.0.19
+     */
+    public function use_taxes() {
+
+        $use_taxes = wpinv_use_taxes();
+
+        if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
+            $use_taxes = false;
+        }
+
+        return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
+    }
+
+    /**
+     * Returns the tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax() {
+        return $this->totals['taxes']['initial'];
+    }
+
+    /**
+     * Returns the recurring tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_tax() {
+        return $this->totals['taxes']['recurring'];
+    }
+
+    /**
+     * Returns all taxes.
+     *
+     * @since 1.0.19
+     */
+    public function get_taxes() {
+        return $this->taxes;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Discounts
 	|--------------------------------------------------------------------------
@@ -603,98 +603,98 @@ 
 	| or only one-time. They also do not have to come from a discount code.
     */
 
-	/**
-	 * Prepares the submission's discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_discount() {
-
-		$initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
-		$recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
-		$processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
-
-		foreach ( $processor->discounts as $discount ) {
-			$this->add_discount( $discount );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
-	}
-
-	/**
-	 * Adds a discount to the submission.
-	 *
-	 * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
-	 * @since 1.0.19
-	 */
-	public function add_discount( $discount ) {
-		$this->discounts[ $discount['name'] ]   = $discount;
-		$this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
-		$this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
-	}
-
-	/**
-	 * Removes a discount from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $name ) {
-
-		if ( isset( $this->discounts[ $name ] ) ) {
-			$this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
-			$this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
-			unset( $this->discounts[ $name ] );
-		}
-	}
-
-	/**
-	 * Checks whether there is a discount code associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_discount_code() {
-		return ! empty( $this->discounts['discount_code'] );
-	}
-
-	/**
-	 * Returns the discount code.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_discount_code() {
-		return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
-	}
-
-	/**
-	 * Returns the discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount() {
-		return $this->totals['discount']['initial'];
-	}
-
-	/**
-	 * Returns the recurring discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_discount() {
-		return $this->totals['discount']['recurring'];
-	}
-
-	/**
-	 * Returns all discounts.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discounts() {
-		return $this->discounts;
-	}
-
-	/*
+    /**
+     * Prepares the submission's discount.
+     *
+     * @since 1.0.19
+     */
+    public function process_discount() {
+
+        $initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
+        $recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
+        $processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
+
+        foreach ( $processor->discounts as $discount ) {
+            $this->add_discount( $discount );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
+    }
+
+    /**
+     * Adds a discount to the submission.
+     *
+     * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
+     * @since 1.0.19
+     */
+    public function add_discount( $discount ) {
+        $this->discounts[ $discount['name'] ]   = $discount;
+        $this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
+        $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
+    }
+
+    /**
+     * Removes a discount from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $name ) {
+
+        if ( isset( $this->discounts[ $name ] ) ) {
+            $this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
+            $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
+            unset( $this->discounts[ $name ] );
+        }
+    }
+
+    /**
+     * Checks whether there is a discount code associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_discount_code() {
+        return ! empty( $this->discounts['discount_code'] );
+    }
+
+    /**
+     * Returns the discount code.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_discount_code() {
+        return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
+    }
+
+    /**
+     * Returns the discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount() {
+        return $this->totals['discount']['initial'];
+    }
+
+    /**
+     * Returns the recurring discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_discount() {
+        return $this->totals['discount']['recurring'];
+    }
+
+    /**
+     * Returns all discounts.
+     *
+     * @since 1.0.19
+     */
+    public function get_discounts() {
+        return $this->discounts;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Fees
 	|--------------------------------------------------------------------------
@@ -704,98 +704,98 @@ 
 	| fees.
     */
 
-	/**
-	 * Prepares the submission's fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_fees() {
-
-		$fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
-
-		foreach ( $fees_processor->fees as $fee ) {
-			$this->add_fee( $fee );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
-	}
-
-	/**
-	 * Adds a fee to the submission.
-	 *
-	 * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
-	 * @since 1.0.19
-	 */
-	public function add_fee( $fee ) {
-
-		if ( $fee['name'] == 'shipping' ) {
-			$this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-			$this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-			return;
-		}
-
-		$this->fees[ $fee['name'] ]         = $fee;
-		$this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-		$this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-	}
-
-	/**
-	 * Removes a fee from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $name ) {
-
-		if ( isset( $this->fees[ $name ] ) ) {
-			$this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
-			$this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
-			unset( $this->fees[ $name ] );
-		}
-
-		if ( 'shipping' == $name ) {
-			$this->totals['shipping']['initial']   = 0;
-			$this->totals['shipping']['recurring'] = 0;
-		}
-	}
-
-	/**
-	 * Returns the fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee() {
-		return $this->totals['fees']['initial'];
-	}
-
-	/**
-	 * Returns the recurring fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_fee() {
-		return $this->totals['fees']['recurring'];
-	}
-
-	/**
-	 * Returns all fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fees() {
-		return $this->fees;
-	}
-
-	/**
-	 * Checks if there are any fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_fees() {
-		return count( $this->fees ) !== 0;
-	}
-
-	/*
+    /**
+     * Prepares the submission's fees.
+     *
+     * @since 1.0.19
+     */
+    public function process_fees() {
+
+        $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
+
+        foreach ( $fees_processor->fees as $fee ) {
+            $this->add_fee( $fee );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
+    }
+
+    /**
+     * Adds a fee to the submission.
+     *
+     * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
+     * @since 1.0.19
+     */
+    public function add_fee( $fee ) {
+
+        if ( $fee['name'] == 'shipping' ) {
+            $this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+            $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+            return;
+        }
+
+        $this->fees[ $fee['name'] ]         = $fee;
+        $this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+        $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+    }
+
+    /**
+     * Removes a fee from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $name ) {
+
+        if ( isset( $this->fees[ $name ] ) ) {
+            $this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
+            $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
+            unset( $this->fees[ $name ] );
+        }
+
+        if ( 'shipping' == $name ) {
+            $this->totals['shipping']['initial']   = 0;
+            $this->totals['shipping']['recurring'] = 0;
+        }
+    }
+
+    /**
+     * Returns the fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee() {
+        return $this->totals['fees']['initial'];
+    }
+
+    /**
+     * Returns the recurring fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_fee() {
+        return $this->totals['fees']['recurring'];
+    }
+
+    /**
+     * Returns all fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fees() {
+        return $this->fees;
+    }
+
+    /**
+     * Checks if there are any fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_fees() {
+        return count( $this->fees ) !== 0;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| MISC
 	|--------------------------------------------------------------------------
@@ -803,146 +803,146 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Returns the shipping amount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_shipping() {
-		return $this->totals['shipping']['initial'];
-	}
-
-	/**
-	 * Returns the recurring shipping.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_shipping() {
-		return $this->totals['shipping']['recurring'];
-	}
-
-	/**
-	 * Checks if there are any shipping fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_shipping() {
-		return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
-	}
-
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] );
-	}
-
-	/**
-	 * Returns the total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_total() {
-		$total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Returns the recurring total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_total() {
-		$total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Whether payment details should be collected for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function should_collect_payment_details() {
-		$initial   = $this->get_total();
-		$recurring = $this->get_recurring_total();
-
-		if ( $this->has_recurring == 0 ) {
-			$recurring = 0;
-		}
-
-		$collect = $initial > 0 || $recurring > 0;
-		return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
-	}
-
-	/**
-	 * Returns the billing email of the user.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_billing_email() {
-		return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
-	}
-
-	/**
-	 * Checks if the submitter has a billing email.
-	 *
-	 * @since 1.0.19
-	 */
-	public function has_billing_email() {
-		$billing_email = $this->get_billing_email();
-		return ! empty( $billing_email ) && is_email( $billing_email );
-	}
-
-	/**
-	 * Returns the appropriate currency for the submission.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_currency() {
-		return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
-    }
-
-    /**
-	 * Returns the raw submission data.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return $this->data;
-	}
-
-	/**
-	 * Returns a field from the submission data
-	 *
-	 * @param string $field
-	 * @since 1.0.19
-	 * @return mixed|null
-	 */
-	public function get_field( $field, $sub_array_key = null ) {
-		return getpaid_get_array_field( $this->data, $field, $sub_array_key );
-	}
-
-	/**
-	 * Checks if a required field is set.
-	 *
-	 * @since 1.0.19
-	 */
-	public function is_required_field_set( $field ) {
-		return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
-	}
-
-	/**
-	 * Formats an amount
-	 *
-	 * @since 1.0.19
-	 */
-	public function format_amount( $amount ) {
-		return wpinv_price( $amount, $this->get_currency() );
-	}
+    /**
+     * Returns the shipping amount.
+     *
+     * @since 1.0.19
+     */
+    public function get_shipping() {
+        return $this->totals['shipping']['initial'];
+    }
+
+    /**
+     * Returns the recurring shipping.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_shipping() {
+        return $this->totals['shipping']['recurring'];
+    }
+
+    /**
+     * Checks if there are any shipping fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_shipping() {
+        return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
+    }
+
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] );
+    }
+
+    /**
+     * Returns the total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_total() {
+        $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Returns the recurring total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_total() {
+        $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Whether payment details should be collected for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function should_collect_payment_details() {
+        $initial   = $this->get_total();
+        $recurring = $this->get_recurring_total();
+
+        if ( $this->has_recurring == 0 ) {
+            $recurring = 0;
+        }
+
+        $collect = $initial > 0 || $recurring > 0;
+        return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
+    }
+
+    /**
+     * Returns the billing email of the user.
+     *
+     * @since 1.0.19
+     */
+    public function get_billing_email() {
+        return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
+    }
+
+    /**
+     * Checks if the submitter has a billing email.
+     *
+     * @since 1.0.19
+     */
+    public function has_billing_email() {
+        $billing_email = $this->get_billing_email();
+        return ! empty( $billing_email ) && is_email( $billing_email );
+    }
+
+    /**
+     * Returns the appropriate currency for the submission.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_currency() {
+        return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
+    }
+
+    /**
+     * Returns the raw submission data.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return $this->data;
+    }
+
+    /**
+     * Returns a field from the submission data
+     *
+     * @param string $field
+     * @since 1.0.19
+     * @return mixed|null
+     */
+    public function get_field( $field, $sub_array_key = null ) {
+        return getpaid_get_array_field( $this->data, $field, $sub_array_key );
+    }
+
+    /**
+     * Checks if a required field is set.
+     *
+     * @since 1.0.19
+     */
+    public function is_required_field_set( $field ) {
+        return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
+    }
+
+    /**
+     * Formats an amount
+     *
+     * @since 1.0.19
+     */
+    public function format_amount( $amount ) {
+        return wpinv_price( $amount, $this->get_currency() );
+    }
 }

includes/payments/class-getpaid-payment-form-submission-refresh-prices.php

Indentation +259 added lines, -259 removed lines

@@ -12,293 +12,293 @@
  */
 class GetPaid_Payment_Form_Submission_Refresh_Prices {
 
-	/**
-	 * Contains the response for refreshing prices.
-	 * @var array
-	 */
-	public $response = array();
+    /**
+     * Contains the response for refreshing prices.
+     * @var array
+     */
+    public $response = array();
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$this->response = array(
-			'submission_id'                    => $submission->id,
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $this->response = array(
+            'submission_id'                    => $submission->id,
             'has_recurring'                    => $submission->has_recurring,
-			'has_subscription_group'           => $submission->has_subscription_group(),
-			'has_multiple_subscription_groups' => $submission->has_multiple_subscription_groups(),
+            'has_subscription_group'           => $submission->has_subscription_group(),
+            'has_multiple_subscription_groups' => $submission->has_multiple_subscription_groups(),
             'is_free'                          => ! $submission->should_collect_payment_details(),
-		);
-
-		$payment_form = $submission->get_payment_form();
-		if ( ! empty( $payment_form->invoice ) ) {
-			$this->response['invoice'] = $payment_form->invoice->get_id();
-		}
-
-		$this->add_totals( $submission );
-		$this->add_texts( $submission );
-		$this->add_items( $submission );
-		$this->add_fees( $submission );
-		$this->add_discounts( $submission );
-		$this->add_taxes( $submission );
-		$this->add_gateways( $submission );
-		$this->add_data( $submission );
-	}
-
-	/**
-	 * Adds totals to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_totals( $submission ) {
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-
-				'totals'      => array(
-					'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
-					'discount'  => $submission->format_amount( $submission->get_discount() ),
-					'fees'      => $submission->format_amount( $submission->get_fee() ),
-					'tax'       => $submission->format_amount( $submission->get_tax() ),
-					'total'     => $submission->format_amount( $submission->get_total() ),
-					'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
-				),
-
-				'recurring'   => array(
-					'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ),
-					'discount' => $submission->format_amount( $submission->get_recurring_discount() ),
-					'fees'     => $submission->format_amount( $submission->get_recurring_fee() ),
-					'tax'      => $submission->format_amount( $submission->get_recurring_tax() ),
-					'total'    => $submission->format_amount( $submission->get_recurring_total() ),
-				),
-
-				'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ),
-				'currency'    => $submission->get_currency(),
-
-			)
-		);
-	}
-
-	/**
-	 * Adds texts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_texts( $submission ) {
-
-		$payable = $submission->format_amount( $submission->get_total() );
-		$groups  = getpaid_get_subscription_groups( $submission );
-
-		if ( $submission->has_recurring && 2 > count( $groups ) ) {
-
-			$recurring = new WPInv_Item( $submission->has_recurring );
-			$period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
-			$main_item = reset( $groups );
-
-			if ( $submission->get_total() == $submission->get_recurring_total() ) {
-				$payable = "$payable / $period";
-			} elseif ( $main_item ) {
-
-				$main_item = reset( $main_item );
-
-				// Calculate the next renewal date.
-				$_period      = $main_item->get_recurring_period( true );
-				$_interval    = $main_item->get_recurring_interval();
-
-				// If the subscription item has a trial period...
-				if ( $main_item->has_free_trial() ) {
-					$_period   = $main_item->get_trial_period( true );
-					$_interval = $main_item->get_trial_interval();
-				}
-
-				$payable = sprintf(
-					__( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
-					$submission->format_amount( $submission->get_total() ),
-					$submission->format_amount( $submission->get_recurring_total() ),
-					$period
-				);
-
-				$payable .= sprintf(
-					'<small class="text-muted form-text">%s</small>',
-					sprintf(
-						__( 'First renewal on %s', 'invoicing' ),
-						getpaid_format_date( date( 'Y-m-d H:i:s', strtotime( "+$_interval $_period", current_time( 'timestamp' ) ) ) )
-					)
-				);
-
-			} else {
-				$payable = sprintf(
-					__( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
-					$submission->format_amount( $submission->get_total() ),
-					$submission->format_amount( $submission->get_recurring_total() ),
-					$period
-				);
-			}
+        );
+
+        $payment_form = $submission->get_payment_form();
+        if ( ! empty( $payment_form->invoice ) ) {
+            $this->response['invoice'] = $payment_form->invoice->get_id();
+        }
+
+        $this->add_totals( $submission );
+        $this->add_texts( $submission );
+        $this->add_items( $submission );
+        $this->add_fees( $submission );
+        $this->add_discounts( $submission );
+        $this->add_taxes( $submission );
+        $this->add_gateways( $submission );
+        $this->add_data( $submission );
+    }
+
+    /**
+     * Adds totals to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_totals( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+
+                'totals'      => array(
+                    'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
+                    'discount'  => $submission->format_amount( $submission->get_discount() ),
+                    'fees'      => $submission->format_amount( $submission->get_fee() ),
+                    'tax'       => $submission->format_amount( $submission->get_tax() ),
+                    'total'     => $submission->format_amount( $submission->get_total() ),
+                    'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
+                ),
+
+                'recurring'   => array(
+                    'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ),
+                    'discount' => $submission->format_amount( $submission->get_recurring_discount() ),
+                    'fees'     => $submission->format_amount( $submission->get_recurring_fee() ),
+                    'tax'      => $submission->format_amount( $submission->get_recurring_tax() ),
+                    'total'    => $submission->format_amount( $submission->get_recurring_total() ),
+                ),
+
+                'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ),
+                'currency'    => $submission->get_currency(),
+
+            )
+        );
+    }
+
+    /**
+     * Adds texts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_texts( $submission ) {
+
+        $payable = $submission->format_amount( $submission->get_total() );
+        $groups  = getpaid_get_subscription_groups( $submission );
+
+        if ( $submission->has_recurring && 2 > count( $groups ) ) {
+
+            $recurring = new WPInv_Item( $submission->has_recurring );
+            $period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
+            $main_item = reset( $groups );
+
+            if ( $submission->get_total() == $submission->get_recurring_total() ) {
+                $payable = "$payable / $period";
+            } elseif ( $main_item ) {
+
+                $main_item = reset( $main_item );
+
+                // Calculate the next renewal date.
+                $_period      = $main_item->get_recurring_period( true );
+                $_interval    = $main_item->get_recurring_interval();
+
+                // If the subscription item has a trial period...
+                if ( $main_item->has_free_trial() ) {
+                    $_period   = $main_item->get_trial_period( true );
+                    $_interval = $main_item->get_trial_interval();
+                }
+
+                $payable = sprintf(
+                    __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
+                    $submission->format_amount( $submission->get_total() ),
+                    $submission->format_amount( $submission->get_recurring_total() ),
+                    $period
+                );
+
+                $payable .= sprintf(
+                    '<small class="text-muted form-text">%s</small>',
+                    sprintf(
+                        __( 'First renewal on %s', 'invoicing' ),
+                        getpaid_format_date( date( 'Y-m-d H:i:s', strtotime( "+$_interval $_period", current_time( 'timestamp' ) ) ) )
+                    )
+                );
+
+            } else {
+                $payable = sprintf(
+                    __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
+                    $submission->format_amount( $submission->get_total() ),
+                    $submission->format_amount( $submission->get_recurring_total() ),
+                    $period
+                );
+            }
         }
 
-		$texts = array(
-			'.getpaid-checkout-total-payable' => $payable,
-		);
+        $texts = array(
+            '.getpaid-checkout-total-payable' => $payable,
+        );
 
-		foreach ( $submission->get_items() as $item ) {
+        foreach ( $submission->get_items() as $item ) {
             $item_id = $item->has_variable_pricing() ? $item->get_price_id() : $item->get_id();
 
-			$initial_price                                         = $submission->format_amount( $item->get_sub_total() - $item->item_discount );
-			$recurring_price                                       = $submission->format_amount( $item->get_recurring_sub_total() - $item->recurring_item_discount );
-			$texts[ ".item-$item_id .getpaid-form-item-price-desc" ] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
-			$texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = sprintf( __( 'Subtotal: %s', 'invoicing' ), $submission->format_amount( $item->get_sub_total() ) );
+            $initial_price                                         = $submission->format_amount( $item->get_sub_total() - $item->item_discount );
+            $recurring_price                                       = $submission->format_amount( $item->get_recurring_sub_total() - $item->recurring_item_discount );
+            $texts[ ".item-$item_id .getpaid-form-item-price-desc" ] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
+            $texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = sprintf( __( 'Subtotal: %s', 'invoicing' ), $submission->format_amount( $item->get_sub_total() ) );
 
-			if ( $item->get_quantity() == 1 ) {
-				$texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = '';
-			}
+            if ( $item->get_quantity() == 1 ) {
+                $texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = '';
+            }
         }
 
-		$this->response = array_merge( $this->response, array( 'texts' => $texts ) );
-	}
+        $this->response = array_merge( $this->response, array( 'texts' => $texts ) );
+    }
 
-	/**
-	 * Adds items to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_items( $submission ) {
+    /**
+     * Adds items to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_items( $submission ) {
 
-		// Add items.
-		$items          = array();
-		$selected_items = array();
+        // Add items.
+        $items          = array();
+        $selected_items = array();
 
         foreach ( $submission->get_items() as $item ) {
             $item_id = $item->has_variable_pricing() ? $item->get_price_id() : $item->get_id();
-			$items[ "$item_id" ] = $submission->format_amount( $item->get_sub_total() );
+            $items[ "$item_id" ] = $submission->format_amount( $item->get_sub_total() );
 
-			$selected_items[ "$item_id" ] = array(
-				'quantity'  => $item->get_quantity(),
-				'price'     => $item->get_price(),
+            $selected_items[ "$item_id" ] = array(
+                'quantity'  => $item->get_quantity(),
+                'price'     => $item->get_price(),
                 'price_id'  => (int) $item_id,
-				'price_fmt' => $submission->format_amount( $item->get_price() ),
-			);
-		}
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-				'items'          => $items,
-				'selected_items' => $selected_items,
-			)
-		);
-	}
-
-	/**
-	 * Adds fees to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_fees( $submission ) {
-
-		$fees = array();
+                'price_fmt' => $submission->format_amount( $item->get_price() ),
+            );
+        }
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+                'items'          => $items,
+                'selected_items' => $selected_items,
+            )
+        );
+    }
+
+    /**
+     * Adds fees to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_fees( $submission ) {
+
+        $fees = array();
 
         foreach ( $submission->get_fees() as $name => $data ) {
-			$fees[ $name ] = $submission->format_amount( $data['initial_fee'] );
-		}
+            $fees[ $name ] = $submission->format_amount( $data['initial_fee'] );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'fees' => $fees )
-		);
-	}
+        $this->response = array_merge(
+            $this->response,
+            array( 'fees' => $fees )
+        );
+    }
 
-	/**
-	 * Adds discounts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_discounts( $submission ) {
+    /**
+     * Adds discounts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_discounts( $submission ) {
 
-		$discounts = array();
+        $discounts = array();
 
         foreach ( $submission->get_discounts() as $name => $data ) {
-			$discounts[ $name ] = $submission->format_amount( $data['initial_discount'] );
-		}
-
-		$this->response = array_merge(
-			$this->response,
-			array( 'discounts' => $discounts )
-		);
-	}
-
-	/**
-	 * Adds taxes to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_taxes( $submission ) {
-
-		$taxes  = array();
-		$markup = '';
+            $discounts[ $name ] = $submission->format_amount( $data['initial_discount'] );
+        }
+
+        $this->response = array_merge(
+            $this->response,
+            array( 'discounts' => $discounts )
+        );
+    }
+
+    /**
+     * Adds taxes to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_taxes( $submission ) {
+
+        $taxes  = array();
+        $markup = '';
         foreach ( $submission->get_taxes() as $name => $data ) {
-			$name           = sanitize_text_field( $name );
-			$amount         = $submission->format_amount( $data['initial_tax'] );
-			$taxes[ $name ] = $amount;
-			$markup        .= "<small class='form-text'>$name : $amount</small>";
-		}
-
-		$this->response = array_merge(
-			$this->response,
-			array( 'taxes' => $taxes )
-		);
-	}
-
-	/**
-	 * Adds gateways to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_gateways( $submission ) {
-
-		$gateways = array_keys( wpinv_get_enabled_payment_gateways() );
-
-		if ( $this->response['has_recurring'] ) {
-
-			foreach ( $gateways as $i => $gateway ) {
-
-				if (
-					! getpaid_payment_gateway_supports( $gateway, 'subscription' )
-					|| ( $this->response['has_subscription_group'] && ! getpaid_payment_gateway_supports( $gateway, 'single_subscription_group' ) )
-					|| ( $this->response['has_multiple_subscription_groups'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscription_groups' ) ) ) {
-					unset( $gateways[ $i ] );
-				}
+            $name           = sanitize_text_field( $name );
+            $amount         = $submission->format_amount( $data['initial_tax'] );
+            $taxes[ $name ] = $amount;
+            $markup        .= "<small class='form-text'>$name : $amount</small>";
+        }
+
+        $this->response = array_merge(
+            $this->response,
+            array( 'taxes' => $taxes )
+        );
+    }
+
+    /**
+     * Adds gateways to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_gateways( $submission ) {
+
+        $gateways = array_keys( wpinv_get_enabled_payment_gateways() );
+
+        if ( $this->response['has_recurring'] ) {
+
+            foreach ( $gateways as $i => $gateway ) {
+
+                if (
+                    ! getpaid_payment_gateway_supports( $gateway, 'subscription' )
+                    || ( $this->response['has_subscription_group'] && ! getpaid_payment_gateway_supports( $gateway, 'single_subscription_group' ) )
+                    || ( $this->response['has_multiple_subscription_groups'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscription_groups' ) ) ) {
+                    unset( $gateways[ $i ] );
+                }
             }
         }
 
-		$gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
-		$this->response = array_merge(
-			$this->response,
-			array( 'gateways' => $gateways )
-		);
-	}
-
-	/**
-	 * Adds data to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_data( $submission ) {
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-				'js_data' => apply_filters(
-					'getpaid_submission_js_data',
-					array(
-						'is_recurring' => $this->response['has_recurring'],
-					),
-					$submission
-				),
-			)
-		);
-	}
+        $gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
+        $this->response = array_merge(
+            $this->response,
+            array( 'gateways' => $gateways )
+        );
+    }
+
+    /**
+     * Adds data to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_data( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+                'js_data' => apply_filters(
+                    'getpaid_submission_js_data',
+                    array(
+                        'is_recurring' => $this->response['has_recurring'],
+                    ),
+                    $submission
+                ),
+            )
+        );
+    }
 }

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

Indentation +579 added lines, -579 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,34 +68,34 @@ 
     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 );
         }
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -113,354 +113,354 @@ 
     */
 
     /**
-	 * 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 );
+
+                if ( $item->can_purchase() ) {
+
+                    $value = (float) $value;
+                    $item->set_quantity( $value );
+                    if ( 0 == $value ) {
+                        $item->set_quantity( 1 );
+                        $item->set_allow_quantities( true );
+                    }
+
+                    $prepared[] = $item;
+                }
+
+                continue;
+            }
 
-		foreach ( $items as $key => $value ) {
+            // Items saved via payment forms editor.
+            if ( is_array( $value ) && isset( $value['id'] ) ) {
 
-			// Form items.
-			if ( $value instanceof GetPaid_Form_Item ) {
+                $item = new GetPaid_Form_Item( $value['id'] );
 
-				if ( $value->can_purchase() ) {
-					$prepared[] = $value;
-				}
+                if ( ! $item->can_purchase() ) {
+                    continue;
+                }
 
-				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 => $quantity (buy buttons)
-			if ( is_numeric( $key ) && is_numeric( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
+                if ( isset( $value['allow_quantities'] ) ) {
+                    $item->set_allow_quantities( $value['allow_quantities'] );
+                }
 
-				if ( $item->can_purchase() ) {
+                if ( isset( $value['required'] ) ) {
+                    $item->set_is_required( $value['required'] );
+                }
 
-					$value = (float) $value;
-					$item->set_quantity( $value );
-					if ( 0 == $value ) {
-						$item->set_quantity( 1 );
-						$item->set_allow_quantities( true );
-					}
+                if ( isset( $value['description'] ) ) {
+                    $item->set_custom_description( $value['description'] );
+                }
 
-					$prepared[] = $item;
-				}
+                $prepared[] = $item;
+                continue;
 
-				continue;
-			}
+            }
 
-			// Items saved via payment forms editor.
-			if ( is_array( $value ) && isset( $value['id'] ) ) {
+            // $item_id => array( 'price' => 10 ) (item variations)
+            if ( is_numeric( $key ) && is_array( $value ) ) {
+                $item = new GetPaid_Form_Item( $key );
 
-				$item = new GetPaid_Form_Item( $value['id'] );
+                if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) {
+                    $item->set_price( $value['price'] );
+                }
 
-				if ( ! $item->can_purchase() ) {
-					continue;
-				}
+                if ( $item->can_purchase() ) {
+                    $prepared[] = $item;
+                }
 
-				// Sub-total (Cart items).
-				if ( isset( $value['subtotal'] ) ) {
-					$item->set_price( $value['subtotal'] );
-				}
+                continue;
+            }
+        }
 
-				if ( isset( $value['quantity'] ) ) {
-					$item->set_quantity( $value['quantity'] );
-				}
+        if ( 'objects' == $return && 'view' == $context ) {
+            return $prepared;
+        }
 
-				if ( isset( $value['allow_quantities'] ) ) {
-					$item->set_allow_quantities( $value['allow_quantities'] );
-				}
+        $items = array();
+        foreach ( $prepared as $item ) {
+            $items[] = $item->prepare_data_for_use();
+        }
+
+        return $items;
+    }
 
-				if ( isset( $value['required'] ) ) {
-					$item->set_is_required( $value['required'] );
-				}
-
-				if ( isset( $value['description'] ) ) {
-					$item->set_custom_description( $value['description'] );
-				}
-
-				$prepared[] = $item;
-				continue;
-
-			}
-
-			// $item_id => array( 'price' => 10 ) (item variations)
-			if ( is_numeric( $key ) && is_array( $value ) ) {
-				$item = new GetPaid_Form_Item( $key );
-
-				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 );
-	}
+    /**
+     * 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 );
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -473,22 +473,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 ) {
@@ -500,13 +500,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 ) {
@@ -518,171 +518,171 @@ 
     }
 
     /**
-	 * 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 ) ) {
-			$this->set_prop( 'elements', wp_kses_post_deep( $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'] ) ) {
+     * 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 ) ) {
+            $this->set_prop( 'elements', wp_kses_post_deep( $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 );
-					}
-				}
+                    // 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 );
-	}
+        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();
     }
 
     /**
      * Updates an item. For backwards compatibilty.
      *
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -698,22 +698,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();
 
@@ -722,79 +722,79 @@ 
         }
 
         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 = '' ) {
-		wpinv_get_template(
-			'payment-forms/form.php',
-			array(
-				'form'         => $this,
-				'extra_markup' => $extra_markup,
-			)
-		);
+        wpinv_get_template(
+            'payment-forms/form.php',
+            array(
+                'form'         => $this,
+                'extra_markup' => $extra_markup,
+            )
+        );
     }
 }