AyeCode / invoicing

includes/data-stores/class-getpaid-data.php

Indentation +862 added lines, -862 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,356 +21,356 @@ 
  */
 abstract class GetPaid_Data {
 
-	/**
-	 * ID for this object.
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	protected $id = 0;
-
-	/**
-	 * Core data for this object. Name value pairs (name + default value).
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Core data changes for this object.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $changes = array();
-
-	/**
-	 * This is false until the object is read from the DB.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $object_read = false;
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $object_type = 'data';
-
-	/**
-	 * Extra data for this object. Name value pairs (name + default value).
-	 * Used as a standard way for sub classes (like item types) to add
-	 * additional information to an inherited class.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $extra_data = array();
-
-	/**
-	 * Set to _data on construct so we can track and reset data if needed.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $default_data = array();
-
-	/**
-	 * Contains a reference to the data store for this class.
-	 *
-	 * @since 1.0.19
-	 * @var GetPaid_Data_Store
-	 */
-	protected $data_store;
-
-	/**
-	 * Stores meta in cache for future reads.
-	 * A group must be set to to enable caching.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $cache_group = '';
-
-	/**
-	 * Stores the last error.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $last_error = '';
-
-	/**
-	 * Stores additional meta data.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $meta_data = null;
-
-	/**
-	 * Default constructor.
-	 *
-	 * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
-	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
-		$this->default_data = $this->data;
-	}
-
-	/**
-	 * Only store the object ID to avoid serializing the data object instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'id' );
-	}
-
-	/**
-	 * Re-run the constructor with the object ID.
-	 *
-	 * If the object no longer exists, remove the ID.
-	 */
-	public function __wakeup() {
-		$this->__construct( absint( $this->id ) );
-
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
-		}
-
-	}
-
-	/**
-	 * When the object is cloned, make sure meta is duplicated correctly.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __clone() {
-		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get the data store.
-	 *
-	 * @since  1.0.19
-	 * @return object
-	 */
-	public function get_data_store() {
-		return $this->data_store;
-	}
-
-	/**
-	 * Get the object type.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Returns the unique ID for this object.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function get_id() {
-		return $this->id;
-	}
-
-	/**
-	 * Get form 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 );
-    }
-
-	/**
-	 * Delete an object, set the ID to 0, and return result.
-	 *
-	 * @since  1.0.19
-	 * @param  bool $force_delete Should the data be deleted permanently.
-	 * @return bool result
-	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store && $this->exists() ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Save should create or update based on object existence.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function save() {
-		if ( ! $this->data_store ) {
-			return $this->get_id();
-		}
-
-		/**
-		 * Trigger action before saving to the DB. Allows you to adjust object props before save.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
-		} else {
-			$this->data_store->create( $this );
-		}
-
-		/**
-		 * Trigger action after saving to the DB.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Change data to JSON format.
-	 *
-	 * @since  1.0.19
-	 * @return string Data in JSON format.
-	 */
-	public function __toString() {
-		return wp_json_encode( $this->get_data() );
-	}
-
-	/**
-	 * Returns all data for this object.
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
-	}
-
-	/**
-	 * Returns array of expected data keys for this object.
-	 *
-	 * @since   1.0.19
-	 * @return array
-	 */
-	public function get_data_keys() {
-		return array_keys( $this->data );
-	}
-
-	/**
-	 * Returns all "extra" data keys for an object (for sub objects like item types).
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
-	}
-
-	/**
-	 * Filter null meta values from array.
-	 *
-	 * @since  1.0.19
-	 * @param mixed $meta Meta value to check.
-	 * @return bool
-	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
-	}
-
-	/**
-	 * Get All Meta Data.
-	 *
-	 * @since 1.0.19
-	 * @return array of objects.
-	 */
-	public function get_meta_data() {
-		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
-	}
-
-	/**
-	 * Check if the key is an internal one.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Key to check.
-	 * @return bool   true if it's an internal key, false otherwise
-	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
-
-		if ( ! $internal_meta_key ) {
-			return false;
-		}
-
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
-
-		if ( ! $has_setter_or_getter ) {
-			return false;
-		}
-
-		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Magic method for setting data fields.
-	 *
-	 * This method does not update custom fields in the database.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 */
-	public function __set( $key, $value ) {
-
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
-		}
-
-		if ( method_exists( $this, "set_$key") ) {
-
-			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-			call_user_func( array( $this, "set_$key" ), $value );
-		} else {
-			$this->set_prop( $key, $value );
-		}
-
-	}
-
-	/**
+    /**
+     * ID for this object.
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    protected $id = 0;
+
+    /**
+     * Core data for this object. Name value pairs (name + default value).
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Core data changes for this object.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $changes = array();
+
+    /**
+     * This is false until the object is read from the DB.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $object_read = false;
+
+    /**
+     * This is the name of this object type.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $object_type = 'data';
+
+    /**
+     * Extra data for this object. Name value pairs (name + default value).
+     * Used as a standard way for sub classes (like item types) to add
+     * additional information to an inherited class.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $extra_data = array();
+
+    /**
+     * Set to _data on construct so we can track and reset data if needed.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $default_data = array();
+
+    /**
+     * Contains a reference to the data store for this class.
+     *
+     * @since 1.0.19
+     * @var GetPaid_Data_Store
+     */
+    protected $data_store;
+
+    /**
+     * Stores meta in cache for future reads.
+     * A group must be set to to enable caching.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $cache_group = '';
+
+    /**
+     * Stores the last error.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $last_error = '';
+
+    /**
+     * Stores additional meta data.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $meta_data = null;
+
+    /**
+     * Default constructor.
+     *
+     * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
+     */
+    public function __construct( $read = 0 ) {
+        $this->data         = array_merge( $this->data, $this->extra_data );
+        $this->default_data = $this->data;
+    }
+
+    /**
+     * Only store the object ID to avoid serializing the data object instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'id' );
+    }
+
+    /**
+     * Re-run the constructor with the object ID.
+     *
+     * If the object no longer exists, remove the ID.
+     */
+    public function __wakeup() {
+        $this->__construct( absint( $this->id ) );
+
+        if ( ! empty( $this->last_error ) ) {
+            $this->set_id( 0 );
+        }
+
+    }
+
+    /**
+     * When the object is cloned, make sure meta is duplicated correctly.
+     *
+     * @since 1.0.19
+     */
+    public function __clone() {
+        $this->maybe_read_meta_data();
+        if ( ! empty( $this->meta_data ) ) {
+            foreach ( $this->meta_data as $array_key => $meta ) {
+                $this->meta_data[ $array_key ] = clone $meta;
+                if ( ! empty( $meta->id ) ) {
+                    $this->meta_data[ $array_key ]->id = null;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the data store.
+     *
+     * @since  1.0.19
+     * @return object
+     */
+    public function get_data_store() {
+        return $this->data_store;
+    }
+
+    /**
+     * Get the object type.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Returns the unique ID for this object.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function get_id() {
+        return $this->id;
+    }
+
+    /**
+     * Get form 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 );
+    }
+
+    /**
+     * Delete an object, set the ID to 0, and return result.
+     *
+     * @since  1.0.19
+     * @param  bool $force_delete Should the data be deleted permanently.
+     * @return bool result
+     */
+    public function delete( $force_delete = false ) {
+        if ( $this->data_store && $this->exists() ) {
+            $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
+            $this->set_id( 0 );
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Save should create or update based on object existence.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function save() {
+        if ( ! $this->data_store ) {
+            return $this->get_id();
+        }
+
+        /**
+         * Trigger action before saving to the DB. Allows you to adjust object props before save.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        if ( $this->get_id() ) {
+            $this->data_store->update( $this );
+        } else {
+            $this->data_store->create( $this );
+        }
+
+        /**
+         * Trigger action after saving to the DB.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Change data to JSON format.
+     *
+     * @since  1.0.19
+     * @return string Data in JSON format.
+     */
+    public function __toString() {
+        return wp_json_encode( $this->get_data() );
+    }
+
+    /**
+     * Returns all data for this object.
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+    }
+
+    /**
+     * Returns array of expected data keys for this object.
+     *
+     * @since   1.0.19
+     * @return array
+     */
+    public function get_data_keys() {
+        return array_keys( $this->data );
+    }
+
+    /**
+     * Returns all "extra" data keys for an object (for sub objects like item types).
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_extra_data_keys() {
+        return array_keys( $this->extra_data );
+    }
+
+    /**
+     * Filter null meta values from array.
+     *
+     * @since  1.0.19
+     * @param mixed $meta Meta value to check.
+     * @return bool
+     */
+    protected function filter_null_meta( $meta ) {
+        return ! is_null( $meta->value );
+    }
+
+    /**
+     * Get All Meta Data.
+     *
+     * @since 1.0.19
+     * @return array of objects.
+     */
+    public function get_meta_data() {
+        $this->maybe_read_meta_data();
+        return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+    }
+
+    /**
+     * Check if the key is an internal one.
+     *
+     * @since  1.0.19
+     * @param  string $key Key to check.
+     * @return bool   true if it's an internal key, false otherwise
+     */
+    protected function is_internal_meta_key( $key ) {
+        $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+
+        if ( ! $internal_meta_key ) {
+            return false;
+        }
+
+        $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+
+        if ( ! $has_setter_or_getter ) {
+            return false;
+        }
+
+        /* translators: %s: $key Key to check */
+        getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Magic method for setting data fields.
+     *
+     * This method does not update custom fields in the database.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     */
+    public function __set( $key, $value ) {
+
+        if ( 'id' == strtolower( $key ) ) {
+            return $this->set_id( $value );
+        }
+
+        if ( method_exists( $this, "set_$key") ) {
+
+            /* translators: %s: $key Key to set */
+            getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+            call_user_func( array( $this, "set_$key" ), $value );
+        } else {
+            $this->set_prop( $key, $value );
+        }
+
+    }
+
+    /**
      * Margic method for retrieving a property.
      */
     public function __get( $key ) {
@@ -378,10 +378,10 @@ 
         // Check if we have a helper method for that.
         if ( method_exists( $this, 'get_' . $key ) ) {
 
-			if ( 'post_type' != $key ) {
-				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-			}
+            if ( 'post_type' != $key ) {
+                /* translators: %s: $key Key to set */
+                getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,514 +391,514 @@ 
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
-
-    }
-
-	/**
-	 * Get Meta Data by Key.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @param  bool   $single return first found meta with key, or all with $key.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
-
-		// Check if this is an internal meta key.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_key );
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'get_' . $_key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}();
-			}
-		}
-
-		// Read the meta data if not yet read.
-		$this->maybe_read_meta_data();
-		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
-		$value      = $single ? '' : array();
-
-		if ( ! empty( $array_keys ) ) {
-			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
-			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
-			}
-		}
-
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * See if meta data exists, since get_meta always returns a '' or array().
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @return boolean
-	 */
-	public function meta_exists( $key = '' ) {
-		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
-	}
-
-	/**
-	 * Set all meta data from array.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Key/Value pairs.
-	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
-			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
-				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
-					$this->meta_data[] = new GetPaid_Meta_Data(
-						array(
-							'id'    => $meta['id'],
-							'key'   => $meta['key'],
-							'value' => $meta['value'],
-						)
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Add meta data.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string       $key Meta key.
-	 * @param string|array $value Meta value.
-	 * @param bool         $unique Should this be a unique key?.
-	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
-		}
-		$this->meta_data[] = new GetPaid_Meta_Data(
-			array(
-				'key'   => $key,
-				'value' => $value,
-			)
-		);
-
-		$this->save();
-	}
-
-	/**
-	 * Update meta data by key or ID, if provided.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param  string       $key Meta key.
-	 * @param  string|array $value Meta value.
-	 * @param  int          $meta_id Meta ID.
-	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-
-		$array_key = false;
-
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
-		} else {
-			// Find matches by key.
-			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
-					$matches[] = $meta_data_array_key;
-				}
-			}
-
-			if ( ! empty( $matches ) ) {
-				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
-				}
-				$array_key = current( $matches );
-			}
-		}
-
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
-			$meta->key   = $key;
-			$meta->value = $value;
-		} else {
-			$this->add_meta_data( $key, $value, true );
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param string $key Meta key.
-	 */
-	public function delete_meta_data( $key ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param int $mid Meta ID.
-	 */
-	public function delete_meta_data_by_mid( $mid ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Read meta data if null.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
-			$this->read_meta_data();
-		}
-	}
-
-	/**
-	 * Read Meta Data from the database. Ignore any internal properties.
-	 * Uses it's own caches because get_metadata does not provide meta_ids.
-	 *
-	 * @since 1.0.19
-	 * @param bool $force_read True to force a new DB read (and update cache).
-	 */
-	public function read_meta_data( $force_read = false ) {
-
-		// Reset meta data.
-		$this->meta_data = array();
-
-		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
-			return;
-		}
-
-		// Only read from cache if the cache key is set.
-		$cache_key = null;
-		if ( ! $force_read && ! empty( $this->cache_group ) ) {
-			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
-		}
-
-		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
-
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-
-		}
-
-		// Set meta data.
-		if ( is_array( $raw_meta_data ) ) {
-
-			foreach ( $raw_meta_data as $meta ) {
-				$this->meta_data[] = new GetPaid_Meta_Data(
-					array(
-						'id'    => (int) $meta->meta_id,
-						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
-					)
-				);
-			}
-
-		}
-
-	}
-
-	/**
-	 * Update Meta Data in the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
-			return;
-		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
-				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
-				$meta->apply_changes();
-			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
-					$meta->apply_changes();
-				}
-			}
-		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
-		}
-	}
-
-	/**
-	 * Set ID.
-	 *
-	 * @since 1.0.19
-	 * @param int $id ID.
-	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+        return $this->get_prop( $key );
+
+    }
+
+    /**
+     * Get Meta Data by Key.
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @param  bool   $single return first found meta with key, or all with $key.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    public function get_meta( $key = '', $single = true, $context = 'view' ) {
+
+        // Check if this is an internal meta key.
+        $_key = str_replace( '_wpinv', '', $key );
+        $_key = str_replace( 'wpinv', '', $_key );
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'get_' . $_key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}();
+            }
+        }
+
+        // Read the meta data if not yet read.
+        $this->maybe_read_meta_data();
+        $meta_data  = $this->get_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+        $value      = $single ? '' : array();
+
+        if ( ! empty( $array_keys ) ) {
+            // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
+            if ( $single ) {
+                $value = $meta_data[ current( $array_keys ) ]->value;
+            } else {
+                $value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+            }
+        }
+
+        if ( 'view' === $context ) {
+            $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+        }
+
+        return $value;
+    }
+
+    /**
+     * See if meta data exists, since get_meta always returns a '' or array().
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @return boolean
+     */
+    public function meta_exists( $key = '' ) {
+        $this->maybe_read_meta_data();
+        $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
+        return in_array( $key, $array_keys, true );
+    }
+
+    /**
+     * Set all meta data from array.
+     *
+     * @since 1.0.19
+     * @param array $data Key/Value pairs.
+     */
+    public function set_meta_data( $data ) {
+        if ( ! empty( $data ) && is_array( $data ) ) {
+            $this->maybe_read_meta_data();
+            foreach ( $data as $meta ) {
+                $meta = (array) $meta;
+                if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+                    $this->meta_data[] = new GetPaid_Meta_Data(
+                        array(
+                            'id'    => $meta['id'],
+                            'key'   => $meta['key'],
+                            'value' => $meta['value'],
+                        )
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * Add meta data.
+     *
+     * @since 1.0.19
+     *
+     * @param string       $key Meta key.
+     * @param string|array $value Meta value.
+     * @param bool         $unique Should this be a unique key?.
+     */
+    public function add_meta_data( $key, $value, $unique = false ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+        if ( $unique ) {
+            $this->delete_meta_data( $key );
+        }
+        $this->meta_data[] = new GetPaid_Meta_Data(
+            array(
+                'key'   => $key,
+                'value' => $value,
+            )
+        );
+
+        $this->save();
+    }
+
+    /**
+     * Update meta data by key or ID, if provided.
+     *
+     * @since  1.0.19
+     *
+     * @param  string       $key Meta key.
+     * @param  string|array $value Meta value.
+     * @param  int          $meta_id Meta ID.
+     */
+    public function update_meta_data( $key, $value, $meta_id = 0 ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+
+        $array_key = false;
+
+        if ( $meta_id ) {
+            $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
+            $array_key  = $array_keys ? current( $array_keys ) : false;
+        } else {
+            // Find matches by key.
+            $matches = array();
+            foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
+                if ( $meta->key === $key ) {
+                    $matches[] = $meta_data_array_key;
+                }
+            }
+
+            if ( ! empty( $matches ) ) {
+                // Set matches to null so only one key gets the new value.
+                foreach ( $matches as $meta_data_array_key ) {
+                    $this->meta_data[ $meta_data_array_key ]->value = null;
+                }
+                $array_key = current( $matches );
+            }
+        }
+
+        if ( false !== $array_key ) {
+            $meta        = $this->meta_data[ $array_key ];
+            $meta->key   = $key;
+            $meta->value = $value;
+        } else {
+            $this->add_meta_data( $key, $value, true );
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param string $key Meta key.
+     */
+    public function delete_meta_data( $key ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param int $mid Meta ID.
+     */
+    public function delete_meta_data_by_mid( $mid ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Read meta data if null.
+     *
+     * @since 1.0.19
+     */
+    protected function maybe_read_meta_data() {
+        if ( is_null( $this->meta_data ) ) {
+            $this->read_meta_data();
+        }
+    }
+
+    /**
+     * Read Meta Data from the database. Ignore any internal properties.
+     * Uses it's own caches because get_metadata does not provide meta_ids.
+     *
+     * @since 1.0.19
+     * @param bool $force_read True to force a new DB read (and update cache).
+     */
+    public function read_meta_data( $force_read = false ) {
+
+        // Reset meta data.
+        $this->meta_data = array();
+
+        // Maybe abort early.
+        if ( ! $this->get_id() || ! $this->data_store ) {
+            return;
+        }
+
+        // Only read from cache if the cache key is set.
+        $cache_key = null;
+        if ( ! $force_read && ! empty( $this->cache_group ) ) {
+            $cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+        }
+
+        // Should we force read?
+        if ( empty( $raw_meta_data ) ) {
+            $raw_meta_data = $this->data_store->read_meta( $this );
+
+            if ( ! empty( $cache_key ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+
+        }
+
+        // Set meta data.
+        if ( is_array( $raw_meta_data ) ) {
+
+            foreach ( $raw_meta_data as $meta ) {
+                $this->meta_data[] = new GetPaid_Meta_Data(
+                    array(
+                        'id'    => (int) $meta->meta_id,
+                        'key'   => $meta->meta_key,
+                        'value' => maybe_unserialize( $meta->meta_value ),
+                    )
+                );
+            }
+
+        }
+
+    }
+
+    /**
+     * Update Meta Data in the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_meta_data() {
+        if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+            return;
+        }
+        foreach ( $this->meta_data as $array_key => $meta ) {
+            if ( is_null( $meta->value ) ) {
+                if ( ! empty( $meta->id ) ) {
+                    $this->data_store->delete_meta( $this, $meta );
+                    unset( $this->meta_data[ $array_key ] );
+                }
+            } elseif ( empty( $meta->id ) ) {
+                $meta->id = $this->data_store->add_meta( $this, $meta );
+                $meta->apply_changes();
+            } else {
+                if ( $meta->get_changes() ) {
+                    $this->data_store->update_meta( $this, $meta );
+                    $meta->apply_changes();
+                }
+            }
+        }
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            wp_cache_delete( $cache_key, $this->cache_group );
+        }
+    }
+
+    /**
+     * Set ID.
+     *
+     * @since 1.0.19
+     * @param int $id ID.
+     */
+    public function set_id( $id ) {
+        $this->id = absint( $id );
+    }
+
+    /**
+     * 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,
-		);
-    }
-
-	/**
-	 * Set all props to default values.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_defaults() {
-		$this->data    = $this->default_data;
-		$this->changes = array();
-		$this->set_object_read( false );
-	}
-
-	/**
-	 * Set object read property.
-	 *
-	 * @since 1.0.19
-	 * @param boolean $read Should read?.
-	 */
-	public function set_object_read( $read = true ) {
-		$this->object_read = (bool) $read;
-	}
-
-	/**
-	 * Get object read property.
-	 *
-	 * @since  1.0.19
-	 * @return boolean
-	 */
-	public function get_object_read() {
-		return (bool) $this->object_read;
-	}
-
-	/**
-	 * Set a collection of props in one go, collect any errors, and return the result.
-	 * Only sets using public methods.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @param string $context In what context to run this.
-	 *
-	 * @return bool|WP_Error
-	 */
-	public function set_props( $props, $context = 'set' ) {
-		$errors = false;
-
-		foreach ( $props as $prop => $value ) {
-			try {
-				/**
-				 * Checks if the prop being set is allowed, and the value is not null.
-				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
-					continue;
-				}
-				$setter = "set_$prop";
-
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
-				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
-					$errors = new WP_Error();
-				}
-				$errors->add( $e->getCode(), $e->getMessage() );
-				$this->last_error = $e->getMessage();
-			}
-		}
-
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
-	}
-
-	/**
-	 * Sets a prop for a setter method.
-	 *
-	 * This stores changes in a special array so we can track what needs saving
-	 * the the DB later.
-	 *
-	 * @since 1.0.19
-	 * @param string $prop Name of prop to set.
-	 * @param mixed  $value Value of the prop.
-	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
-				}
-			} else {
-				$this->data[ $prop ] = $value;
-			}
-		}
-	}
-
-	/**
-	 * Return data changes only.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_changes() {
-		return $this->changes;
-	}
-
-	/**
-	 * Merge changes with data and clear.
-	 *
-	 * @since 1.0.19
-	 */
-	public function apply_changes() {
-		$this->data    = array_replace( $this->data, $this->changes );
-		$this->changes = array();
-	}
-
-	/**
-	 * Prefix for action and filter hooks on data.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	protected function get_hook_prefix() {
-		return 'wpinv_get_' . $this->object_type . '_';
-	}
-
-	/**
-	 * Gets a prop for a getter method.
-	 *
-	 * Gets the value from either current pending changes, or the data itself.
-	 * Context controls what happens to the value before it's returned.
-	 *
-	 * @since  1.0.19
-	 * @param  string $prop Name of prop to get.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	protected function get_prop( $prop, $context = 'view' ) {
-		$value = null;
-
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
-
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
-			}
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Sets a date prop whilst handling formatting and datetime objects.
-	 *
-	 * @since 1.0.19
-	 * @param string         $prop Name of prop to set.
-	 * @param string|integer $value Value of the prop.
-	 */
-	protected function set_date_prop( $prop, $value ) {
-
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
-			return;
-		}
-		$this->set_prop( $prop, $value );
-
-	}
-
-	/**
-	 * When invalid data is found, throw an exception unless reading from the DB.
-	 *
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		$this->last_error = $message;
-	}
-
-	/**
-	 * Checks if the object is saved in the database
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function exists() {
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
+        $this->set_prop( 'status', $status );
+
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
+    }
+
+    /**
+     * Set all props to default values.
+     *
+     * @since 1.0.19
+     */
+    public function set_defaults() {
+        $this->data    = $this->default_data;
+        $this->changes = array();
+        $this->set_object_read( false );
+    }
+
+    /**
+     * Set object read property.
+     *
+     * @since 1.0.19
+     * @param boolean $read Should read?.
+     */
+    public function set_object_read( $read = true ) {
+        $this->object_read = (bool) $read;
+    }
+
+    /**
+     * Get object read property.
+     *
+     * @since  1.0.19
+     * @return boolean
+     */
+    public function get_object_read() {
+        return (bool) $this->object_read;
+    }
+
+    /**
+     * Set a collection of props in one go, collect any errors, and return the result.
+     * Only sets using public methods.
+     *
+     * @since  1.0.19
+     *
+     * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
+     * @param string $context In what context to run this.
+     *
+     * @return bool|WP_Error
+     */
+    public function set_props( $props, $context = 'set' ) {
+        $errors = false;
+
+        foreach ( $props as $prop => $value ) {
+            try {
+                /**
+                 * Checks if the prop being set is allowed, and the value is not null.
+                 */
+                if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+                    continue;
+                }
+                $setter = "set_$prop";
+
+                if ( is_callable( array( $this, $setter ) ) ) {
+                    $this->{$setter}( $value );
+                }
+            } catch ( Exception $e ) {
+                if ( ! $errors ) {
+                    $errors = new WP_Error();
+                }
+                $errors->add( $e->getCode(), $e->getMessage() );
+                $this->last_error = $e->getMessage();
+            }
+        }
+
+        return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+    }
+
+    /**
+     * Sets a prop for a setter method.
+     *
+     * This stores changes in a special array so we can track what needs saving
+     * the the DB later.
+     *
+     * @since 1.0.19
+     * @param string $prop Name of prop to set.
+     * @param mixed  $value Value of the prop.
+     */
+    protected function set_prop( $prop, $value ) {
+        if ( array_key_exists( $prop, $this->data ) ) {
+            if ( true === $this->object_read ) {
+                if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
+                    $this->changes[ $prop ] = $value;
+                }
+            } else {
+                $this->data[ $prop ] = $value;
+            }
+        }
+    }
+
+    /**
+     * Return data changes only.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_changes() {
+        return $this->changes;
+    }
+
+    /**
+     * Merge changes with data and clear.
+     *
+     * @since 1.0.19
+     */
+    public function apply_changes() {
+        $this->data    = array_replace( $this->data, $this->changes );
+        $this->changes = array();
+    }
+
+    /**
+     * Prefix for action and filter hooks on data.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    protected function get_hook_prefix() {
+        return 'wpinv_get_' . $this->object_type . '_';
+    }
+
+    /**
+     * Gets a prop for a getter method.
+     *
+     * Gets the value from either current pending changes, or the data itself.
+     * Context controls what happens to the value before it's returned.
+     *
+     * @since  1.0.19
+     * @param  string $prop Name of prop to get.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    protected function get_prop( $prop, $context = 'view' ) {
+        $value = null;
+
+        if ( array_key_exists( $prop, $this->data ) ) {
+            $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+
+            if ( 'view' === $context ) {
+                $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Sets a date prop whilst handling formatting and datetime objects.
+     *
+     * @since 1.0.19
+     * @param string         $prop Name of prop to set.
+     * @param string|integer $value Value of the prop.
+     */
+    protected function set_date_prop( $prop, $value ) {
+
+        if ( empty( $value ) ) {
+            $this->set_prop( $prop, null );
+            return;
+        }
+        $this->set_prop( $prop, $value );
+
+    }
+
+    /**
+     * When invalid data is found, throw an exception unless reading from the DB.
+     *
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        $this->last_error = $message;
+    }
+
+    /**
+     * Checks if the object is saved in the database
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function exists() {
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
 
 }

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

Indentation +793 added lines, -793 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,187 +10,187 @@ 
 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,
-		),
-
-	);
-
-	/**
-	 * 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,
+        ),
+
+    );
+
+    /**
+     * 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;
-
-    /**
-	 * 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( $_POST );
-		}
-
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Remove slashes from the submitted data...
-		$data       = wp_unslash( $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 ( Exception $e ) {
-			$this->last_error = $e->getMessage();
-		}
-
-		// 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;
+
+    /**
+     * 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( $_POST );
+        }
+
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Remove slashes from the submitted data...
+        $data       = wp_unslash( $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 ( Exception $e ) {
+            $this->last_error = $e->getMessage();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -199,39 +199,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.
 	|--------------------------------------------------------------------------
@@ -240,84 +240,84 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_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'] ) ) {
-			return;
-		}
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+            return;
+        }
 
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
 
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', '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() ) {
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
 
-			$items    = array();
-			$item_ids = array();
+            $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 ( $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;
-				}
-			}
+            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 );
+            $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 );
-	}
-
-	/*
+        } 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.
 	|--------------------------------------------------------------------------
@@ -326,115 +326,115 @@ 
 	| 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() ) {
-
-			if ( $this->has_recurring != 0 ) {
-				throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
-			}
-
-			$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;
-	}
-
-	/*
+    /**
+     * 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() ) {
+
+            if ( $this->has_recurring != 0 ) {
+                throw new Exception( __( 'You can only buy one recurring item at a time.', 'invoicing' ) );
+            }
+
+            $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;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -443,128 +443,128 @@ 
 	| 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 ( 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 ( 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
 	|--------------------------------------------------------------------------
@@ -573,99 +573,99 @@ 
 	| 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
 	|--------------------------------------------------------------------------
@@ -675,89 +675,89 @@ 
 	| 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 ) {
-
-		$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 ] );
-		}
-
-	}
-
-	/**
-	 * 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 ) {
+
+        $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 ] );
+        }
+
+    }
+
+    /**
+     * 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
 	|--------------------------------------------------------------------------
@@ -765,119 +765,119 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return 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_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_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() );
-	}
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return 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_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_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() );
+    }
 
 }