AyeCode / invoicing

includes/class-wpinv-invoice.php

Indentation +2084 added lines, -2084 removed lines

@@ -11,30 +11,30 @@ 
 class WPInv_Invoice extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'invoice';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
+     * This is the name of this object type.
+     *
+     * @var string
+     */
     protected $object_type = 'invoice';
 
     /**
-	 * 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'               => 'wpi-pending',
-		'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'               => 'wpi-pending',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'due_date'             => null,
         'completed_date'       => null,
@@ -76,20 +76,20 @@ 
         'transaction_id'       => '',
         'currency'             => '',
         'disable_taxes'        => false,
-		'subscription_id'      => null,
-		'is_viewed'            => false,
-		'email_cc'             => '',
-		'template'             => 'quantity', // hours, amount only
+        'subscription_id'      => null,
+        'is_viewed'            => false,
+        'email_cc'             => '',
+        'template'             => 'quantity', // hours, amount only
     );
 
     /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_invoices';
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_invoices';
 
     /**
      * Stores a reference to the original WP_Post object
@@ -103,97 +103,97 @@ 
      *
      * @var int
      */
-	protected $recurring_item = null;
+    protected $recurring_item = null;
 
-	/**
+    /**
      * Stores an array of item totals.
-	 *
-	 * e.g $totals['discount'] = array(
-	 * 		'initial'   => 10,
-	 * 		'recurring' => 10,
-	 * )
+     *
+     * e.g $totals['discount'] = array(
+     * 		'initial'   => 10,
+     * 		'recurring' => 10,
+     * )
      *
      * @var array
      */
-	protected $totals = array();
+    protected $totals = array();
 
-	/**
-	 * Stores the status transition information.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $status_transition = false;
+    /**
+     * Stores the status transition information.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $status_transition = false;
 
     /**
-	 * Get the invoice if ID is passed, otherwise the invoice is new and empty.
-	 *
-	 * @param  int/string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, number or object to read.
-	 */
+     * Get the invoice if ID is passed, otherwise the invoice is new and empty.
+     *
+     * @param  int/string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, number or object to read.
+     */
     public function __construct( $invoice = false ) {
 
         parent::__construct( $invoice );
 
-		if ( is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( $invoice ) ) ) {
-			$this->set_id( $invoice );
-		} elseif ( $invoice instanceof self ) {
-			$this->set_id( $invoice->get_id() );
-		} elseif ( ! empty( $invoice->ID ) ) {
-			$this->set_id( $invoice->ID );
-		} elseif ( is_array( $invoice ) ) {
-			$this->set_props( $invoice );
-
-			if ( isset( $invoice['ID'] ) ) {
-				$this->set_id( $invoice['ID'] );
-			}
-
-		} elseif ( is_scalar( $invoice ) && $invoice_id = self::get_discount_id_by_code( $invoice, 'key' ) ) {
-			$this->set_id( $invoice_id );
-		} elseif ( is_scalar( $invoice ) && $invoice_id = self::get_discount_id_by_code( $invoice, 'number' ) ) {
-			$this->set_id( $invoice_id );
-		} else {
-			$this->set_object_read( true );
-		}
+        if ( is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( $invoice ) ) ) {
+            $this->set_id( $invoice );
+        } elseif ( $invoice instanceof self ) {
+            $this->set_id( $invoice->get_id() );
+        } elseif ( ! empty( $invoice->ID ) ) {
+            $this->set_id( $invoice->ID );
+        } elseif ( is_array( $invoice ) ) {
+            $this->set_props( $invoice );
+
+            if ( isset( $invoice['ID'] ) ) {
+                $this->set_id( $invoice['ID'] );
+            }
+
+        } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_discount_id_by_code( $invoice, 'key' ) ) {
+            $this->set_id( $invoice_id );
+        } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_discount_id_by_code( $invoice, 'number' ) ) {
+            $this->set_id( $invoice_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 );
         }
 
     }
 
     /**
-	 * Given a discount code, it returns a discount id.
-	 *
-	 *
-	 * @static
-	 * @param string $discount_code
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_discount_id_by_code( $invoice_key_or_number, $field = 'key' ) {
+     * Given a discount code, it returns a discount id.
+     *
+     *
+     * @static
+     * @param string $discount_code
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_discount_id_by_code( $invoice_key_or_number, $field = 'key' ) {
         global $wpdb;
 
-		// Trim the code.
+        // Trim the code.
         $key = trim( $invoice_key_or_number );
 
         // Valid fields.
         $fields = array( 'key', 'number' );
 
-		// Ensure a value has been passed.
-		if ( empty( $key ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
+        // Ensure a value has been passed.
+        if ( empty( $key ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
 
-		// Maybe retrieve from the cache.
-		$invoice_id   = wp_cache_get( $key, 'getpaid_invoice_keys_' . $field );
-		if ( ! empty( $invoice_id ) ) {
-			return $invoice_id;
-		}
+        // Maybe retrieve from the cache.
+        $invoice_id   = wp_cache_get( $key, 'getpaid_invoice_keys_' . $field );
+        if ( ! empty( $invoice_id ) ) {
+            return $invoice_id;
+        }
 
         // Fetch from the db.
         $table       = $wpdb->prefix . 'getpaid_invoices';
@@ -201,14 +201,14 @@ 
             $wpdb->prepare( "SELECT `post_id` FROM $table WHERE $field=%s LIMIT 1", $key )
         );
 
-		if ( empty( $invoice_id ) ) {
-			return 0;
-		}
+        if ( empty( $invoice_id ) ) {
+            return 0;
+        }
 
-		// Update the cache with our data
-		wp_cache_set( $key, $invoice_id, 'getpaid_invoice_keys_' . $field );
+        // Update the cache with our data
+        wp_cache_set( $key, $invoice_id, 'getpaid_invoice_keys_' . $field );
 
-		return $invoice_id;
+        return $invoice_id;
     }
 
     /**
@@ -234,53 +234,53 @@ 
     */
 
     /**
-	 * Get parent invoice 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 invoice 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 invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
+     * Get parent invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
     public function get_parent_payment() {
         return new WPInv_Invoice( $this->get_parent_id() );
     }
 
     /**
-	 * Alias for self::get_parent_payment().
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
+     * Alias for self::get_parent_payment().
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
     public function get_parent() {
         return $this->get_parent_payment();
     }
 
     /**
-	 * Get invoice 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 invoice 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 invoice status nice name.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
+     * Get invoice status nice name.
+     *
+     * @since 1.0.19
+     * @return string
+     */
     public function get_status_nicename() {
         $statuses = wpinv_get_invoice_statuses( true, true, $this );
 
@@ -294,20 +294,20 @@ 
     }
 
     /**
-	 * Get plugin version when the invoice 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 invoice 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 );
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function get_invoice_date( $formatted = true ) {
+    /**
+     * @deprecated
+     */
+    public function get_invoice_date( $formatted = true ) {
         $date_completed = $this->get_date_completed();
         $invoice_date   = $date_completed != '0000-00-00 00:00:00' ? $date_completed : '';
 
@@ -324,187 +324,187 @@ 
     }
 
     /**
-	 * Get date when the invoice 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 invoice 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 );
+    }
 	
-	/**
-	 * Alias for self::get_date_created().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_created_date( $context = 'view' ) {
-		return $this->get_date_created( $context );
-    }
-
-    /**
-	 * Get GMT date when the invoice was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+    /**
+     * Alias for self::get_date_created().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_created_date( $context = 'view' ) {
+        return $this->get_date_created( $context );
+    }
+
+    /**
+     * Get GMT date when the invoice 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 invoice 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 invoice 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 );
+    }
 
-	/**
-	 * Alias for self::get_date_modified().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_modified_date( $context = 'view' ) {
-		return $this->get_date_modified( $context );
+    /**
+     * Alias for self::get_date_modified().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_modified_date( $context = 'view' ) {
+        return $this->get_date_modified( $context );
     }
 
     /**
-	 * Get GMT date when the invoice 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 invoice 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 invoice due date.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_due_date( $context = 'view' ) {
-		return $this->get_prop( 'due_date', $context );
+     * Get the invoice due date.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_due_date( $context = 'view' ) {
+        return $this->get_prop( 'due_date', $context );
     }
 
     /**
-	 * Alias for self::get_due_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_due( $context = 'view' ) {
-		return $this->get_due_date( $context );
+     * Alias for self::get_due_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_due( $context = 'view' ) {
+        return $this->get_due_date( $context );
     }
 
     /**
-	 * Get the invoice GMT due date.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_due_date_gmt( $context = 'view' ) {
+     * Get the invoice GMT due date.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_due_date_gmt( $context = 'view' ) {
         $date = $this->get_due_date( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Alias for self::get_due_date_gmt().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gmt_date_due( $context = 'view' ) {
-		return $this->get_due_date_gmt( $context );
+     * Alias for self::get_due_date_gmt().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gmt_date_due( $context = 'view' ) {
+        return $this->get_due_date_gmt( $context );
     }
 
     /**
-	 * Get date when the invoice was completed.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_completed_date( $context = 'view' ) {
-		return $this->get_prop( 'completed_date', $context );
+     * Get date when the invoice was completed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_completed_date( $context = 'view' ) {
+        return $this->get_prop( 'completed_date', $context );
     }
 
     /**
-	 * Alias for self::get_completed_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_completed( $context = 'view' ) {
-		return $this->get_completed_date( $context );
+     * Alias for self::get_completed_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_completed( $context = 'view' ) {
+        return $this->get_completed_date( $context );
     }
 
     /**
-	 * Get GMT date when the invoice was was completed.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_completed_date_gmt( $context = 'view' ) {
+     * Get GMT date when the invoice was was completed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_completed_date_gmt( $context = 'view' ) {
         $date = $this->get_completed_date( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Alias for self::get_completed_date_gmt().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gmt_completed_date( $context = 'view' ) {
-		return $this->get_completed_date_gmt( $context );
+     * Alias for self::get_completed_date_gmt().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gmt_completed_date( $context = 'view' ) {
+        return $this->get_completed_date_gmt( $context );
     }
 
     /**
-	 * Get the invoice number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_number( $context = 'view' ) {
+     * Get the invoice number.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_number( $context = 'view' ) {
         $number = $this->get_prop( 'number', $context );
 
         if ( empty( $number ) ) {
@@ -512,17 +512,17 @@ 
             $this->set_number( $number );
         }
 
-		return $number;
+        return $number;
     }
 
     /**
-	 * Get the invoice key.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_key( $context = 'view' ) {
+     * Get the invoice key.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_key( $context = 'view' ) {
         $key = $this->get_prop( 'key', $context );
 
         if ( empty( $key ) ) {
@@ -530,24 +530,24 @@ 
             $this->set_key( $key );
         }
 
-		return $key;
+        return $key;
     }
 
     /**
-	 * Get the invoice type.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
+     * Get the invoice type.
+     *
+     * @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 );
-	}
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function get_invoice_quote_type( $post_id ) {
+    /**
+     * @deprecated
+     */
+    public function get_invoice_quote_type( $post_id ) {
         if ( empty( $post_id ) ) {
             return '';
         }
@@ -564,35 +564,35 @@ 
     }
 
     /**
-	 * Get the invoice post type.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_post_type( $context = 'view' ) {
+     * Get the invoice post type.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_post_type( $context = 'view' ) {
         return $this->get_prop( 'post_type', $context );
     }
 
     /**
-	 * Get the invoice mode.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_mode( $context = 'view' ) {
+     * Get the invoice mode.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_mode( $context = 'view' ) {
         return $this->get_prop( 'mode', $context );
     }
 
     /**
-	 * Get the invoice path.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_path( $context = 'view' ) {
+     * Get the invoice path.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_path( $context = 'view' ) {
         $path = $this->get_prop( 'path', $context );
 
         if ( empty( $path ) ) {
@@ -600,73 +600,73 @@ 
             $path   = sanitize_title( $prefix . $this->get_id() );
         }
 
-		return $path;
+        return $path;
     }
 
     /**
-	 * Get the invoice name/title.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
+     * Get the invoice name/title.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
         $name = $this->get_prop( 'title', $context );
 
-		return empty( $name ) ? $this->get_number( $context ) : $name;
+        return empty( $name ) ? $this->get_number( $context ) : $name;
     }
 
     /**
-	 * 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 invoice 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 invoice 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 );
     }
 
     /**
-	 * Returns the user info.
-	 *
-	 * @since 1.0.19
+     * Returns the user info.
+     *
+     * @since 1.0.19
      * @param  string $context View or edit context.
-	 * @return array
-	 */
+     * @return array
+     */
     public function get_user_info( $context = 'view' ) {
         $user_info = array(
             'user_id'    => $this->get_user_id( $context ),
@@ -687,598 +687,598 @@ 
     }
 
     /**
-	 * Get the customer id.
-	 *
-	 * @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 customer id.
+     *
+     * @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_user_id( $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_user_id( $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_customer_id( $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_customer_id( $context = 'view' ) {
+        return $this->get_author( $context );
     }
 
     /**
-	 * Get the customer's ip.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_ip( $context = 'view' ) {
-		return $this->get_prop( 'user_ip', $context );
+     * Get the customer's ip.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_ip( $context = 'view' ) {
+        return $this->get_prop( 'user_ip', $context );
     }
 
     /**
-	 * Alias of self::get_ip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_ip( $context = 'view' ) {
-		return $this->get_ip( $context );
+     * Alias of self::get_ip().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_ip( $context = 'view' ) {
+        return $this->get_ip( $context );
     }
 
-     /**
-	 * Alias of self::get_ip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_ip( $context = 'view' ) {
-		return $this->get_ip( $context );
+        /**
+         * Alias of self::get_ip().
+         *
+         * @since 1.0.19
+         * @param  string $context View or edit context.
+         * @return string
+         */
+    public function get_customer_ip( $context = 'view' ) {
+        return $this->get_ip( $context );
     }
 
     /**
-	 * Get the customer's first name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_first_name( $context = 'view' ) {
-		return $this->get_prop( 'first_name', $context );
+     * Get the customer's first name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_first_name( $context = 'view' ) {
+        return $this->get_prop( 'first_name', $context );
     }
 
     /**
-	 * Alias of self::get_first_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_first_name( $context = 'view' ) {
-		return $this->get_first_name( $context );
+     * Alias of self::get_first_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_first_name( $context = 'view' ) {
+        return $this->get_first_name( $context );
     }
 
-     /**
-	 * Alias of self::get_first_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_first_name( $context = 'view' ) {
-		return $this->get_first_name( $context );
+        /**
+         * Alias of self::get_first_name().
+         *
+         * @since 1.0.19
+         * @param  string $context View or edit context.
+         * @return int
+         */
+    public function get_customer_first_name( $context = 'view' ) {
+        return $this->get_first_name( $context );
     }
 
     /**
-	 * Get the customer's last name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_last_name( $context = 'view' ) {
-		return $this->get_prop( 'last_name', $context );
+     * Get the customer's last name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_last_name( $context = 'view' ) {
+        return $this->get_prop( 'last_name', $context );
     }
 
     /**
-	 * Alias of self::get_last_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_last_name( $context = 'view' ) {
-		return $this->get_last_name( $context );
+     * Alias of self::get_last_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_last_name( $context = 'view' ) {
+        return $this->get_last_name( $context );
     }
 
     /**
-	 * Alias of self::get_last_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_last_name( $context = 'view' ) {
-		return $this->get_last_name( $context );
+     * Alias of self::get_last_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_last_name( $context = 'view' ) {
+        return $this->get_last_name( $context );
     }
 
     /**
-	 * Get the customer's full name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_full_name( $context = 'view' ) {
-		return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) );
+     * Get the customer's full name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_full_name( $context = 'view' ) {
+        return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) );
     }
 
     /**
-	 * Alias of self::get_full_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_full_name( $context = 'view' ) {
-		return $this->get_full_name( $context );
+     * Alias of self::get_full_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_full_name( $context = 'view' ) {
+        return $this->get_full_name( $context );
     }
 
     /**
-	 * Alias of self::get_full_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_full_name( $context = 'view' ) {
-		return $this->get_full_name( $context );
+     * Alias of self::get_full_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_full_name( $context = 'view' ) {
+        return $this->get_full_name( $context );
     }
 
     /**
-	 * Get the customer's phone number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_phone( $context = 'view' ) {
-		return $this->get_prop( 'phone', $context );
+     * Get the customer's phone number.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_phone( $context = 'view' ) {
+        return $this->get_prop( 'phone', $context );
     }
 
     /**
-	 * Alias of self::get_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_phone_number( $context = 'view' ) {
-		return $this->get_phone( $context );
+     * Alias of self::get_phone().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_phone_number( $context = 'view' ) {
+        return $this->get_phone( $context );
     }
 
     /**
-	 * Alias of self::get_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_phone( $context = 'view' ) {
-		return $this->get_phone( $context );
+     * Alias of self::get_phone().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_phone( $context = 'view' ) {
+        return $this->get_phone( $context );
     }
 
     /**
-	 * Alias of self::get_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_phone( $context = 'view' ) {
-		return $this->get_phone( $context );
+     * Alias of self::get_phone().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_phone( $context = 'view' ) {
+        return $this->get_phone( $context );
     }
 
     /**
-	 * Get the customer's email address.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_email( $context = 'view' ) {
-		return $this->get_prop( 'email', $context );
+     * Get the customer's email address.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_email( $context = 'view' ) {
+        return $this->get_prop( 'email', $context );
     }
 
     /**
-	 * Alias of self::get_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_email_address( $context = 'view' ) {
-		return $this->get_email( $context );
+     * Alias of self::get_email().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_email_address( $context = 'view' ) {
+        return $this->get_email( $context );
     }
 
     /**
-	 * Alias of self::get_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_email( $context = 'view' ) {
-		return $this->get_email( $context );
+     * Alias of self::get_email().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_email( $context = 'view' ) {
+        return $this->get_email( $context );
     }
 
     /**
-	 * Alias of self::get_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_email( $context = 'view' ) {
-		return $this->get_email( $context );
+     * Alias of self::get_email().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_email( $context = 'view' ) {
+        return $this->get_email( $context );
     }
 
     /**
-	 * Get the customer's country.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_country( $context = 'view' ) {
-		$country = $this->get_prop( 'country', $context );
-		return empty( $country ) ? wpinv_get_default_country() : $country;
+     * Get the customer's country.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_country( $context = 'view' ) {
+        $country = $this->get_prop( 'country', $context );
+        return empty( $country ) ? wpinv_get_default_country() : $country;
     }
 
     /**
-	 * Alias of self::get_country().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_country( $context = 'view' ) {
-		return $this->get_country( $context );
+     * Alias of self::get_country().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_country( $context = 'view' ) {
+        return $this->get_country( $context );
     }
 
     /**
-	 * Alias of self::get_country().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_country( $context = 'view' ) {
-		return $this->get_country( $context );
+     * Alias of self::get_country().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_country( $context = 'view' ) {
+        return $this->get_country( $context );
     }
 
     /**
-	 * Get the customer's state.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_state( $context = 'view' ) {
-		$state = $this->get_prop( 'state', $context );
-		return empty( $state ) ? wpinv_get_default_state() : $state;
+     * Get the customer's state.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_state( $context = 'view' ) {
+        $state = $this->get_prop( 'state', $context );
+        return empty( $state ) ? wpinv_get_default_state() : $state;
     }
 
     /**
-	 * Alias of self::get_state().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_user_state( $context = 'view' ) {
-		return $this->get_state( $context );
+     * Alias of self::get_state().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_user_state( $context = 'view' ) {
+        return $this->get_state( $context );
     }
 
     /**
-	 * Alias of self::get_state().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_state( $context = 'view' ) {
-		return $this->get_state( $context );
+     * Alias of self::get_state().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_state( $context = 'view' ) {
+        return $this->get_state( $context );
     }
 
     /**
-	 * Get the customer's city.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_city( $context = 'view' ) {
-		return $this->get_prop( 'city', $context );
+     * Get the customer's city.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_city( $context = 'view' ) {
+        return $this->get_prop( 'city', $context );
     }
 
     /**
-	 * Alias of self::get_city().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_city( $context = 'view' ) {
-		return $this->get_city( $context );
+     * Alias of self::get_city().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_city( $context = 'view' ) {
+        return $this->get_city( $context );
     }
 
     /**
-	 * Alias of self::get_city().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_city( $context = 'view' ) {
-		return $this->get_city( $context );
+     * Alias of self::get_city().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_city( $context = 'view' ) {
+        return $this->get_city( $context );
     }
 
     /**
-	 * Get the customer's zip.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_zip( $context = 'view' ) {
-		return $this->get_prop( 'zip', $context );
+     * Get the customer's zip.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_zip( $context = 'view' ) {
+        return $this->get_prop( 'zip', $context );
     }
 
     /**
-	 * Alias of self::get_zip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_zip( $context = 'view' ) {
-		return $this->get_zip( $context );
+     * Alias of self::get_zip().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_zip( $context = 'view' ) {
+        return $this->get_zip( $context );
     }
 
     /**
-	 * Alias of self::get_zip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_zip( $context = 'view' ) {
-		return $this->get_zip( $context );
+     * Alias of self::get_zip().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_zip( $context = 'view' ) {
+        return $this->get_zip( $context );
     }
 
     /**
-	 * Get the customer's company.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_company( $context = 'view' ) {
-		return $this->get_prop( 'company', $context );
+     * Get the customer's company.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_company( $context = 'view' ) {
+        return $this->get_prop( 'company', $context );
     }
 
     /**
-	 * Alias of self::get_company().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_company( $context = 'view' ) {
-		return $this->get_company( $context );
+     * Alias of self::get_company().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_company( $context = 'view' ) {
+        return $this->get_company( $context );
     }
 
     /**
-	 * Alias of self::get_company().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_company( $context = 'view' ) {
-		return $this->get_company( $context );
+     * Alias of self::get_company().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_company( $context = 'view' ) {
+        return $this->get_company( $context );
     }
 
     /**
-	 * Get the customer's vat number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_number( $context = 'view' ) {
-		return $this->get_prop( 'vat_number', $context );
+     * Get the customer's vat number.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_number( $context = 'view' ) {
+        return $this->get_prop( 'vat_number', $context );
     }
 
     /**
-	 * Alias of self::get_vat_number().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_vat_number( $context = 'view' ) {
-		return $this->get_vat_number( $context );
+     * Alias of self::get_vat_number().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_vat_number( $context = 'view' ) {
+        return $this->get_vat_number( $context );
     }
 
     /**
-	 * Alias of self::get_vat_number().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_vat_number( $context = 'view' ) {
-		return $this->get_vat_number( $context );
+     * Alias of self::get_vat_number().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_vat_number( $context = 'view' ) {
+        return $this->get_vat_number( $context );
     }
 
     /**
-	 * Get the customer's vat rate.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_rate( $context = 'view' ) {
-		return $this->get_prop( 'vat_rate', $context );
+     * Get the customer's vat rate.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_rate( $context = 'view' ) {
+        return $this->get_prop( 'vat_rate', $context );
     }
 
     /**
-	 * Alias of self::get_vat_rate().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_vat_rate( $context = 'view' ) {
-		return $this->get_vat_rate( $context );
+     * Alias of self::get_vat_rate().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_vat_rate( $context = 'view' ) {
+        return $this->get_vat_rate( $context );
     }
 
     /**
-	 * Alias of self::get_vat_rate().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_vat_rate( $context = 'view' ) {
-		return $this->get_vat_rate( $context );
-    }
+     * Alias of self::get_vat_rate().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_vat_rate( $context = 'view' ) {
+        return $this->get_vat_rate( $context );
+    }
+
+    /**
+     * Get the customer's address.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_address( $context = 'view' ) {
+        return $this->get_prop( 'address', $context );
+    }
+
+    /**
+     * Alias of self::get_address().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_user_address( $context = 'view' ) {
+        return $this->get_address( $context );
+    }
+
+    /**
+     * Alias of self::get_address().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_customer_address( $context = 'view' ) {
+        return $this->get_address( $context );
+    }
+
+    /**
+     * Get whether the customer has viewed the invoice or not.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_is_viewed( $context = 'view' ) {
+        return (bool) $this->get_prop( 'is_viewed', $context );
+    }
+
+    /**
+     * Get other recipients for invoice communications.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_email_cc( $context = 'view' ) {
+        return $this->get_prop( 'email_cc', $context );
+    }
 
     /**
-	 * Get the customer's address.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_address( $context = 'view' ) {
-		return $this->get_prop( 'address', $context );
-    }
-
-    /**
-	 * Alias of self::get_address().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_user_address( $context = 'view' ) {
-		return $this->get_address( $context );
-    }
-
-    /**
-	 * Alias of self::get_address().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_customer_address( $context = 'view' ) {
-		return $this->get_address( $context );
-    }
-
-    /**
-	 * Get whether the customer has viewed the invoice or not.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_is_viewed( $context = 'view' ) {
-		return (bool) $this->get_prop( 'is_viewed', $context );
-	}
-
-	/**
-	 * Get other recipients for invoice communications.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_email_cc( $context = 'view' ) {
-		return $this->get_prop( 'email_cc', $context );
-	}
-
-	/**
-	 * Get invoice template.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_template( $context = 'view' ) {
-		return $this->get_prop( 'template', $context );
-	}
-
-	/**
-	 * Get whether the customer has confirmed their address.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_address_confirmed( $context = 'view' ) {
-		return (bool) $this->get_prop( 'address_confirmed', $context );
-    }
-
-    /**
-	 * Alias of self::get_address_confirmed().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_user_address_confirmed( $context = 'view' ) {
-		return $this->get_address_confirmed( $context );
-    }
-
-    /**
-	 * Alias of self::get_address().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_customer_address_confirmed( $context = 'view' ) {
-		return $this->get_address_confirmed( $context );
-    }
-
-    /**
-	 * Get the invoice subtotal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_subtotal( $context = 'view' ) {
+     * Get invoice template.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_template( $context = 'view' ) {
+        return $this->get_prop( 'template', $context );
+    }
+
+    /**
+     * Get whether the customer has confirmed their address.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_address_confirmed( $context = 'view' ) {
+        return (bool) $this->get_prop( 'address_confirmed', $context );
+    }
+
+    /**
+     * Alias of self::get_address_confirmed().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_user_address_confirmed( $context = 'view' ) {
+        return $this->get_address_confirmed( $context );
+    }
+
+    /**
+     * Alias of self::get_address().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_customer_address_confirmed( $context = 'view' ) {
+        return $this->get_address_confirmed( $context );
+    }
+
+    /**
+     * Get the invoice subtotal.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_subtotal( $context = 'view' ) {
         $subtotal = (float) $this->get_prop( 'subtotal', $context );
 
         // Backwards compatibility.
@@ -1290,155 +1290,155 @@ 
     }
 
     /**
-	 * Get the invoice discount total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_total_discount( $context = 'view' ) {
-		return (float) $this->get_prop( 'total_discount', $context );
+     * Get the invoice discount total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_total_discount( $context = 'view' ) {
+        return (float) $this->get_prop( 'total_discount', $context );
     }
 
     /**
-	 * Get the invoice tax total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_total_tax( $context = 'view' ) {
-		return (float) $this->get_prop( 'total_tax', $context );
-	}
+     * Get the invoice tax total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_total_tax( $context = 'view' ) {
+        return (float) $this->get_prop( 'total_tax', $context );
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function get_final_tax( $currency = false ) {
-		$tax = $this->get_total_tax();
+    /**
+     * @deprecated
+     */
+    public function get_final_tax( $currency = false ) {
+        $tax = $this->get_total_tax();
 
         if ( $currency ) {
-			return wpinv_price( wpinv_format_amount( $tax, NULL, false ), $this->get_currency() );
+            return wpinv_price( wpinv_format_amount( $tax, NULL, false ), $this->get_currency() );
         }
 
         return $tax;
     }
 
     /**
-	 * Get the invoice fees total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_total_fees( $context = 'view' ) {
-		return (float) $this->get_prop( 'total_fees', $context );
+     * Get the invoice fees total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_total_fees( $context = 'view' ) {
+        return (float) $this->get_prop( 'total_fees', $context );
     }
 
     /**
-	 * Alias for self::get_total_fees().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_fees_total( $context = 'view' ) {
-		return $this->get_total_fees( $context );
+     * Alias for self::get_total_fees().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_fees_total( $context = 'view' ) {
+        return $this->get_total_fees( $context );
     }
 
     /**
-	 * Get the invoice total.
-	 *
-	 * @since 1.0.19
+     * Get the invoice total.
+     *
+     * @since 1.0.19
      * @return float
-	 */
-	public function get_total() {
-		$total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total();
-		return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this  );
+     */
+    public function get_total() {
+        $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total();
+        return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this  );
     }
 
     /**
-	 * Get the initial invoice total.
-	 *
-	 * @since 1.0.19
+     * Get the initial invoice total.
+     *
+     * @since 1.0.19
      * @param  string $context View or edit context.
      * @return float
-	 */
+     */
     public function get_initial_total() {
 
-		if ( empty( $this->totals ) ) {
-			$this->recalculate_total();
-		}
+        if ( empty( $this->totals ) ) {
+            $this->recalculate_total();
+        }
 
-		$tax      = $this->totals['tax']['initial'];
-		$fee      = $this->totals['fee']['initial'];
-		$discount = $this->totals['discount']['initial'];
-		$subtotal = $this->totals['subtotal']['initial'];
-		$total    = $tax + $fee - $discount + $subtotal;
+        $tax      = $this->totals['tax']['initial'];
+        $fee      = $this->totals['fee']['initial'];
+        $discount = $this->totals['discount']['initial'];
+        $subtotal = $this->totals['subtotal']['initial'];
+        $total    = $tax + $fee - $discount + $subtotal;
 
-		if ( 0 > $total ) {
-			$total = 0;
-		}
+        if ( 0 > $total ) {
+            $total = 0;
+        }
 
         return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this );
-	}
+    }
 
-	/**
-	 * Get the recurring invoice total.
-	 *
-	 * @since 1.0.19
+    /**
+     * Get the recurring invoice total.
+     *
+     * @since 1.0.19
      * @param  string $context View or edit context.
      * @return float
-	 */
+     */
     public function get_recurring_total() {
 
-		if ( empty( $this->totals ) ) {
-			$this->recalculate_total();
-		}
+        if ( empty( $this->totals ) ) {
+            $this->recalculate_total();
+        }
 
-		$tax      = $this->totals['tax']['recurring'];
-		$fee      = $this->totals['fee']['recurring'];
-		$discount = $this->totals['discount']['recurring'];
-		$subtotal = $this->totals['subtotal']['recurring'];
-		$total    = $tax + $fee - $discount + $subtotal;
+        $tax      = $this->totals['tax']['recurring'];
+        $fee      = $this->totals['fee']['recurring'];
+        $discount = $this->totals['discount']['recurring'];
+        $subtotal = $this->totals['subtotal']['recurring'];
+        $total    = $tax + $fee - $discount + $subtotal;
 
-		if ( 0 > $total ) {
-			$total = 0;
-		}
+        if ( 0 > $total ) {
+            $total = 0;
+        }
 
         return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this );
-	}
+    }
 
-	/**
-	 * Returns recurring payment details.
-	 *
-	 * @since 1.0.19
+    /**
+     * Returns recurring payment details.
+     *
+     * @since 1.0.19
      * @param  string $field Optionally provide a field to return.
-	 * @param string $currency Whether to include the currency.
+     * @param string $currency Whether to include the currency.
      * @return float
-	 */
+     */
     public function get_recurring_details( $field = '', $currency = false ) {
 
-		// Maybe recalculate totals.
-		if ( empty( $this->totals ) ) {
-			$this->recalculate_total();
-		}
+        // Maybe recalculate totals.
+        if ( empty( $this->totals ) ) {
+            $this->recalculate_total();
+        }
 
-		// Prepare recurring totals.
+        // Prepare recurring totals.
         $data = apply_filters(
-			'wpinv_get_invoice_recurring_details',
-			array(
-				'cart_details' => $this->get_cart_details(),
-				'subtotal'     => $this->totals['subtotal']['recurring'],
-				'discount'     => $this->totals['discount']['recurring'],
-				'tax'          => $this->totals['tax']['recurring'],
-				'fee'          => $this->totals['fee']['recurring'],
-				'total'        => $this->get_recurring_total(),
-			),
-			$this,
-			$field,
-			$currency
-		);
+            'wpinv_get_invoice_recurring_details',
+            array(
+                'cart_details' => $this->get_cart_details(),
+                'subtotal'     => $this->totals['subtotal']['recurring'],
+                'discount'     => $this->totals['discount']['recurring'],
+                'tax'          => $this->totals['tax']['recurring'],
+                'fee'          => $this->totals['fee']['recurring'],
+                'total'        => $this->get_recurring_total(),
+            ),
+            $this,
+            $field,
+            $currency
+        );
 
         if ( isset( $data[$field] ) ) {
             return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] );
@@ -1448,145 +1448,145 @@ 
     }
 
     /**
-	 * Get the invoice fees.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_fees( $context = 'view' ) {
-		return wpinv_parse_list( $this->get_prop( 'fees', $context ) );
+     * Get the invoice fees.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_fees( $context = 'view' ) {
+        return wpinv_parse_list( $this->get_prop( 'fees', $context ) );
     }
 
     /**
-	 * Get the invoice discounts.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_discounts( $context = 'view' ) {
-		return wpinv_parse_list( $this->get_prop( 'discounts', $context ) );
+     * Get the invoice discounts.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_discounts( $context = 'view' ) {
+        return wpinv_parse_list( $this->get_prop( 'discounts', $context ) );
     }
 
     /**
-	 * Get the invoice taxes.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
-	public function get_taxes( $context = 'view' ) {
-		return wpinv_parse_list( $this->get_prop( 'taxes', $context ) );
+     * Get the invoice taxes.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
+    public function get_taxes( $context = 'view' ) {
+        return wpinv_parse_list( $this->get_prop( 'taxes', $context ) );
     }
 
     /**
-	 * Get the invoice items.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items( $context = 'view' ) {
+     * Get the invoice items.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items( $context = 'view' ) {
         return $this->get_prop( 'items', $context );
     }
 
     /**
-	 * Get the invoice's payment form.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_payment_form( $context = 'view' ) {
-		return intval( $this->get_prop( 'payment_form', $context ) );
+     * Get the invoice's payment form.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_payment_form( $context = 'view' ) {
+        return intval( $this->get_prop( 'payment_form', $context ) );
     }
 
     /**
-	 * Get the invoice's submission id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_submission_id( $context = 'view' ) {
-		return $this->get_prop( 'submission_id', $context );
+     * Get the invoice's submission id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_submission_id( $context = 'view' ) {
+        return $this->get_prop( 'submission_id', $context );
     }
 
     /**
-	 * Get the invoice's discount code.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_discount_code( $context = 'view' ) {
-		return $this->get_prop( 'discount_code', $context );
+     * Get the invoice's discount code.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_discount_code( $context = 'view' ) {
+        return $this->get_prop( 'discount_code', $context );
     }
 
     /**
-	 * Get the invoice's gateway.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gateway( $context = 'view' ) {
-		return $this->get_prop( 'gateway', $context );
+     * Get the invoice's gateway.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gateway( $context = 'view' ) {
+        return $this->get_prop( 'gateway', $context );
     }
 
     /**
-	 * Get the invoice's gateway display title.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
+     * Get the invoice's gateway display title.
+     *
+     * @since 1.0.19
+     * @return string
+     */
     public function get_gateway_title() {
         $title =  wpinv_get_gateway_checkout_label( $this->get_gateway() );
         return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this );
     }
 
     /**
-	 * Get the invoice's transaction id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_transaction_id( $context = 'view' ) {
-		return $this->get_prop( 'transaction_id', $context );
+     * Get the invoice's transaction id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_transaction_id( $context = 'view' ) {
+        return $this->get_prop( 'transaction_id', $context );
     }
 
     /**
-	 * Get the invoice's currency.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_currency( $context = 'view' ) {
+     * Get the invoice's currency.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_currency( $context = 'view' ) {
         $currency = $this->get_prop( 'currency', $context );
         return empty( $currency ) ? wpinv_get_currency() : $currency;
     }
 
     /**
-	 * Checks if we are charging taxes for this invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_disable_taxes( $context = 'view' ) {
+     * Checks if we are charging taxes for this invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_disable_taxes( $context = 'view' ) {
         return (bool) $this->get_prop( 'disable_taxes', $context );
     }
 
     /**
-	 * Retrieves the subscription id for an invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
+     * Retrieves the subscription id for an invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
     public function get_subscription_id( $context = 'view' ) {
         $subscription_id = $this->get_prop( 'subscription_id', $context );
 
@@ -1599,12 +1599,12 @@ 
     }
 
     /**
-	 * Retrieves the payment meta for an invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return array
-	 */
+     * Retrieves the payment meta for an invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return array
+     */
     public function get_payment_meta( $context = 'view' ) {
 
         return array(
@@ -1624,11 +1624,11 @@ 
     }
 
     /**
-	 * Retrieves the cart details for an invoice.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
+     * Retrieves the cart details for an invoice.
+     *
+     * @since 1.0.19
+     * @return array
+     */
     public function get_cart_details() {
         $items        = $this->get_items();
         $cart_details = array();
@@ -1638,16 +1638,16 @@ 
         }
 
         return $cart_details;
-	}
+    }
 
-	/**
-	 * Retrieves the recurring item.
-	 *
-	 * @return null|GetPaid_Form_Item
-	 */
-	public function get_recurring( $object = false ) {
+    /**
+     * Retrieves the recurring item.
+     *
+     * @return null|GetPaid_Form_Item
+     */
+    public function get_recurring( $object = false ) {
 
-		// Are we returning an object?
+        // Are we returning an object?
         if ( $object ) {
             return $this->get_item( $this->recurring_item );
         }
@@ -1655,58 +1655,58 @@ 
         return $this->recurring_item;
     }
 
-	/**
-	 * Retrieves the subscription name.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_subscription_name() {
+    /**
+     * Retrieves the subscription name.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_subscription_name() {
 
-		// Retrieve the recurring name
+        // Retrieve the recurring name
         $item = $this->get_recurring( true );
 
-		// Abort if it does not exist.
+        // Abort if it does not exist.
         if ( empty( $item ) ) {
             return '';
         }
 
-		// Return the item name.
+        // Return the item name.
         return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this );
-	}
-
-	/**
-	 * Retrieves the view url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_view_url() {
+    }
+
+    /**
+     * Retrieves the view url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_view_url() {
         $invoice_url = get_permalink( $this->get_id() );
-		$invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url );
+        $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url );
         return apply_filters( 'wpinv_get_view_url', $invoice_url, $this );
-	}
+    }
 
-	/**
-	 * Retrieves the payment url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_checkout_payment_url( $deprecated = false, $secret = false ) {
+    /**
+     * Retrieves the payment url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_checkout_payment_url( $deprecated = false, $secret = false ) {
 
-		// Retrieve the checkout url.
+        // Retrieve the checkout url.
         $pay_url = wpinv_get_checkout_uri();
 
-		// Maybe force ssl.
+        // Maybe force ssl.
         if ( is_ssl() ) {
             $pay_url = str_replace( 'http:', 'https:', $pay_url );
         }
 
-		// Add the invoice key.
-		$pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url );
+        // Add the invoice key.
+        $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url );
 
-		// (Maybe?) add a secret
+        // (Maybe?) add a secret
         if ( $secret ) {
             $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url );
         }
@@ -1715,18 +1715,18 @@ 
     }
 
     /**
-	 * Magic method for accessing invoice properties.
-	 *
-	 * @since 1.0.15
-	 * @access public
-	 *
-	 * @param string $key Discount data to retrieve
-	 * @param  string $context View or edit context.
-	 * @return mixed Value of the given invoice property (if set).
-	 */
-	public function get( $key, $context = 'view' ) {
+     * Magic method for accessing invoice properties.
+     *
+     * @since 1.0.15
+     * @access public
+     *
+     * @param string $key Discount data to retrieve
+     * @param  string $context View or edit context.
+     * @return mixed Value of the given invoice property (if set).
+     */
+    public function get( $key, $context = 'view' ) {
         return $this->get_prop( $key, $context );
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -1739,118 +1739,118 @@ 
     */
 
     /**
-	 * Magic method for setting invoice properties.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 * @param string $key Discount data to retrieve
-	 * @param  mixed $value new value.
-	 * @return mixed Value of the given invoice property (if set).
-	 */
-	public function set( $key, $value ) {
+     * Magic method for setting invoice properties.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     * @param string $key Discount data to retrieve
+     * @param  mixed $value new value.
+     * @return mixed Value of the given invoice property (if set).
+     */
+    public function set( $key, $value ) {
 
         $setter = "set_$key";
         if ( is_callable( array( $this, $setter ) ) ) {
             $this->{$setter}( $value );
         }
 
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param string $new_status    New status.
-	 * @param string $note          Optional note to add.
-	 * @param bool   $manual_update Is this a manual status change?.
-	 * @return array details of change.
-	 */
-	public function set_status( $new_status, $note = '', $manual_update = false ) {
-		$old_status = $this->get_status();
-
-		$this->set_prop( 'status', $new_status );
-
-		// If setting the status, ensure it's set to a valid status.
-		if ( true === $this->object_read ) {
-
-			// Only allow valid new status.
-			if ( ! array_key_exists( $new_status, wpinv_get_invoice_statuses( false, true ) ) ) {
-				$new_status = 'wpi-pending';
-			}
-
-			// If the old status is set but unknown (e.g. draft) assume its pending for action usage.
-			if ( $old_status && ! array_key_exists( $new_status, wpinv_get_invoice_statuses( false, true ) ) ) {
-				$old_status = 'wpi-pending';
-			}
-		}
-
-		if ( true === $this->object_read && $old_status !== $new_status ) {
-			$this->status_transition = array(
-				'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
-				'to'     => $new_status,
-				'note'   => $note,
-				'manual' => (bool) $manual_update,
-			);
-
-			if ( $manual_update ) {
-				do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status );
-			}
-
-			$this->maybe_set_date_paid();
-
-		}
-
-		return array(
-			'from' => $old_status,
-			'to'   => $new_status,
-		);
-	}
-
-	/**
-	 * Maybe set date paid.
-	 *
-	 * Sets the date paid variable when transitioning to the payment complete
-	 * order status.
-	 *
-	 * @since 1.0.19
-	 */
-	public function maybe_set_date_paid() {
-
-		if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) {
-			$this->set_date_completed( current_time( 'mysql' ) );
-		}
-	}
-
-    /**
-	 * Set parent invoice ID.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_parent_id( $value ) {
-		if ( $value && ( $value === $this->get_id() ) ) {
-			return;
-		}
-		$this->set_prop( 'parent_id', absint( $value ) );
-    }
-
-    /**
-	 * Set plugin version when the invoice was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
-    }
-
-    /**
-	 * Set date when the invoice was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param string $new_status    New status.
+     * @param string $note          Optional note to add.
+     * @param bool   $manual_update Is this a manual status change?.
+     * @return array details of change.
+     */
+    public function set_status( $new_status, $note = '', $manual_update = false ) {
+        $old_status = $this->get_status();
+
+        $this->set_prop( 'status', $new_status );
+
+        // If setting the status, ensure it's set to a valid status.
+        if ( true === $this->object_read ) {
+
+            // Only allow valid new status.
+            if ( ! array_key_exists( $new_status, wpinv_get_invoice_statuses( false, true ) ) ) {
+                $new_status = 'wpi-pending';
+            }
+
+            // If the old status is set but unknown (e.g. draft) assume its pending for action usage.
+            if ( $old_status && ! array_key_exists( $new_status, wpinv_get_invoice_statuses( false, true ) ) ) {
+                $old_status = 'wpi-pending';
+            }
+        }
+
+        if ( true === $this->object_read && $old_status !== $new_status ) {
+            $this->status_transition = array(
+                'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
+                'to'     => $new_status,
+                'note'   => $note,
+                'manual' => (bool) $manual_update,
+            );
+
+            if ( $manual_update ) {
+                do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status );
+            }
+
+            $this->maybe_set_date_paid();
+
+        }
+
+        return array(
+            'from' => $old_status,
+            'to'   => $new_status,
+        );
+    }
+
+    /**
+     * Maybe set date paid.
+     *
+     * Sets the date paid variable when transitioning to the payment complete
+     * order status.
+     *
+     * @since 1.0.19
+     */
+    public function maybe_set_date_paid() {
+
+        if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) {
+            $this->set_date_completed( current_time( 'mysql' ) );
+        }
+    }
+
+    /**
+     * Set parent invoice ID.
+     *
+     * @since 1.0.19
+     */
+    public function set_parent_id( $value ) {
+        if ( $value && ( $value === $this->get_id() ) ) {
+            return;
+        }
+        $this->set_prop( 'parent_id', absint( $value ) );
+    }
+
+    /**
+     * Set plugin version when the invoice was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
+    }
+
+    /**
+     * Set date when the invoice 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 && $value !== '0000-00-00 00:00:00' ) {
@@ -1863,13 +1863,13 @@ 
     }
 
     /**
-	 * Set date invoice due date.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date invoice due date.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_due_date( $value ) {
+     */
+    public function set_due_date( $value ) {
         $date = strtotime( $value );
 
         if ( $date && $value !== '0000-00-00 00:00:00' ) {
@@ -1877,29 +1877,29 @@ 
             return true;
         }
 
-		$this->set_prop( 'due_date', '' );
+        $this->set_prop( 'due_date', '' );
         return false;
 
     }
 
     /**
-	 * Alias of self::set_due_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_date_due( $value ) {
-		$this->set_due_date( $value );
+     * Alias of self::set_due_date().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_date_due( $value ) {
+        $this->set_due_date( $value );
     }
 
     /**
-	 * Set date invoice was completed.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date invoice was completed.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_completed_date( $value ) {
+     */
+    public function set_completed_date( $value ) {
         $date = strtotime( $value );
 
         if ( $date && $value !== '0000-00-00 00:00:00'  ) {
@@ -1907,29 +1907,29 @@ 
             return true;
         }
 
-		$this->set_prop( 'completed_date', '' );
+        $this->set_prop( 'completed_date', '' );
         return false;
 
     }
 
     /**
-	 * Alias of self::set_completed_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_date_completed( $value ) {
-		$this->set_completed_date( $value );
+     * Alias of self::set_completed_date().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_date_completed( $value ) {
+        $this->set_completed_date( $value );
     }
 
     /**
-	 * Set date when the invoice was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the invoice 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 && $value !== '0000-00-00 00:00:00' ) {
@@ -1937,706 +1937,706 @@ 
             return true;
         }
 
-		$this->set_prop( 'date_modified', '' );
+        $this->set_prop( 'date_modified', '' );
         return false;
 
     }
 
     /**
-	 * Set the invoice number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New number.
-	 */
-	public function set_number( $value ) {
+     * Set the invoice number.
+     *
+     * @since 1.0.19
+     * @param  string $value New number.
+     */
+    public function set_number( $value ) {
         $number = sanitize_text_field( $value );
-		$this->set_prop( 'number', $number );
+        $this->set_prop( 'number', $number );
     }
 
     /**
-	 * Set the invoice type.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value Type.
-	 */
-	public function set_type( $value ) {
+     * Set the invoice type.
+     *
+     * @since 1.0.19
+     * @param  string $value Type.
+     */
+    public function set_type( $value ) {
         $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) );
-		$this->set_prop( 'type', $type );
-	}
+        $this->set_prop( 'type', $type );
+    }
 
     /**
-	 * Set the invoice post type.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value Post type.
-	 */
-	public function set_post_type( $value ) {
+     * Set the invoice post type.
+     *
+     * @since 1.0.19
+     * @param  string $value Post type.
+     */
+    public function set_post_type( $value ) {
         if ( getpaid_is_invoice_post_type( $value ) ) {
-			$this->set_type( $value );
+            $this->set_type( $value );
             $this->set_prop( 'post_type', $value );
         }
     }
 
     /**
-	 * Set the invoice key.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New key.
-	 */
-	public function set_key( $value ) {
+     * Set the invoice key.
+     *
+     * @since 1.0.19
+     * @param  string $value New key.
+     */
+    public function set_key( $value ) {
         $key = sanitize_text_field( $value );
-		$this->set_prop( 'key', $key );
+        $this->set_prop( 'key', $key );
     }
 
     /**
-	 * Set the invoice mode.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value mode.
-	 */
-	public function set_mode( $value ) {
+     * Set the invoice mode.
+     *
+     * @since 1.0.19
+     * @param  string $value mode.
+     */
+    public function set_mode( $value ) {
         if ( ! in_array( $value, array( 'live', 'test' ) ) ) {
             $this->set_prop( 'value', $value );
         }
     }
 
     /**
-	 * Set the invoice path.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value path.
-	 */
-	public function set_path( $value ) {
+     * Set the invoice path.
+     *
+     * @since 1.0.19
+     * @param  string $value path.
+     */
+    public function set_path( $value ) {
         $this->set_prop( 'path', $value );
     }
 
     /**
-	 * Set the invoice name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the invoice 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 invoice description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
+     * Set the invoice description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
         $description = wp_kses_post( $value );
-		return $this->set_prop( 'description', $description );
+        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_summary( $value ) {
+        $this->set_description( $value );
+    }
+
+    /**
+     * Set the receiver of the invoice.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $user = get_user_by( 'id', (int) $value );
+
+        if ( $user && $user->ID ) {
+            $this->set_prop( 'author', $user->ID );
+            $this->set_prop( 'email', $user->user_email );
+        }
+		
     }
 
     /**
-	 * 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_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New user id.
+     */
+    public function set_user_id( $value ) {
+        $this->set_author( $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_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New user id.
+     */
+    public function set_customer_id( $value ) {
+        $this->set_author( $value );
     }
 
     /**
-	 * Set the receiver of the invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$user = get_user_by( 'id', (int) $value );
-
-		if ( $user && $user->ID ) {
-			$this->set_prop( 'author', $user->ID );
-			$this->set_prop( 'email', $user->user_email );
-		}
-		
+     * Set the customer's ip.
+     *
+     * @since 1.0.19
+     * @param  string $value ip address.
+     */
+    public function set_ip( $value ) {
+        $this->set_prop( 'ip', $value );
     }
 
     /**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New user id.
-	 */
-	public function set_user_id( $value ) {
-		$this->set_author( $value );
+     * Alias of self::set_ip().
+     *
+     * @since 1.0.19
+     * @param  string $value ip address.
+     */
+    public function set_user_ip( $value ) {
+        $this->set_ip( $value );
     }
 
     /**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New user id.
-	 */
-	public function set_customer_id( $value ) {
-		$this->set_author( $value );
+     * Set the customer's first name.
+     *
+     * @since 1.0.19
+     * @param  string $value first name.
+     */
+    public function set_first_name( $value ) {
+        $this->set_prop( 'first_name', $value );
     }
 
     /**
-	 * Set the customer's ip.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value ip address.
-	 */
-	public function set_ip( $value ) {
-		$this->set_prop( 'ip', $value );
+     * Alias of self::set_first_name().
+     *
+     * @since 1.0.19
+     * @param  string $value first name.
+     */
+    public function set_user_first_name( $value ) {
+        $this->set_first_name( $value );
     }
 
     /**
-	 * Alias of self::set_ip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value ip address.
-	 */
-	public function set_user_ip( $value ) {
-		$this->set_ip( $value );
+     * Alias of self::set_first_name().
+     *
+     * @since 1.0.19
+     * @param  string $value first name.
+     */
+    public function set_customer_first_name( $value ) {
+        $this->set_first_name( $value );
     }
 
     /**
-	 * Set the customer's first name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value first name.
-	 */
-	public function set_first_name( $value ) {
-		$this->set_prop( 'first_name', $value );
+     * Set the customer's last name.
+     *
+     * @since 1.0.19
+     * @param  string $value last name.
+     */
+    public function set_last_name( $value ) {
+        $this->set_prop( 'last_name', $value );
     }
 
     /**
-	 * Alias of self::set_first_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value first name.
-	 */
-	public function set_user_first_name( $value ) {
-		$this->set_first_name( $value );
+     * Alias of self::set_last_name().
+     *
+     * @since 1.0.19
+     * @param  string $value last name.
+     */
+    public function set_user_last_name( $value ) {
+        $this->set_last_name( $value );
     }
 
     /**
-	 * Alias of self::set_first_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value first name.
-	 */
-	public function set_customer_first_name( $value ) {
-		$this->set_first_name( $value );
+     * Alias of self::set_last_name().
+     *
+     * @since 1.0.19
+     * @param  string $value last name.
+     */
+    public function set_customer_last_name( $value ) {
+        $this->set_last_name( $value );
     }
 
     /**
-	 * Set the customer's last name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value last name.
-	 */
-	public function set_last_name( $value ) {
-		$this->set_prop( 'last_name', $value );
+     * Set the customer's phone number.
+     *
+     * @since 1.0.19
+     * @param  string $value phone.
+     */
+    public function set_phone( $value ) {
+        $this->set_prop( 'phone', $value );
     }
 
     /**
-	 * Alias of self::set_last_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value last name.
-	 */
-	public function set_user_last_name( $value ) {
-		$this->set_last_name( $value );
+     * Alias of self::set_phone().
+     *
+     * @since 1.0.19
+     * @param  string $value phone.
+     */
+    public function set_user_phone( $value ) {
+        $this->set_phone( $value );
     }
 
     /**
-	 * Alias of self::set_last_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value last name.
-	 */
-	public function set_customer_last_name( $value ) {
-		$this->set_last_name( $value );
+     * Alias of self::set_phone().
+     *
+     * @since 1.0.19
+     * @param  string $value phone.
+     */
+    public function set_customer_phone( $value ) {
+        $this->set_phone( $value );
     }
 
     /**
-	 * Set the customer's phone number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value phone.
-	 */
-	public function set_phone( $value ) {
-		$this->set_prop( 'phone', $value );
+     * Alias of self::set_phone().
+     *
+     * @since 1.0.19
+     * @param  string $value phone.
+     */
+    public function set_phone_number( $value ) {
+        $this->set_phone( $value );
     }
 
     /**
-	 * Alias of self::set_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value phone.
-	 */
-	public function set_user_phone( $value ) {
-		$this->set_phone( $value );
+     * Set the customer's email address.
+     *
+     * @since 1.0.19
+     * @param  string $value email address.
+     */
+    public function set_email( $value ) {
+        $this->set_prop( 'email', $value );
     }
 
     /**
-	 * Alias of self::set_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value phone.
-	 */
-	public function set_customer_phone( $value ) {
-		$this->set_phone( $value );
+     * Alias of self::set_email().
+     *
+     * @since 1.0.19
+     * @param  string $value email address.
+     */
+    public function set_user_email( $value ) {
+        $this->set_email( $value );
     }
 
     /**
-	 * Alias of self::set_phone().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value phone.
-	 */
-	public function set_phone_number( $value ) {
-		$this->set_phone( $value );
+     * Alias of self::set_email().
+     *
+     * @since 1.0.19
+     * @param  string $value email address.
+     */
+    public function set_email_address( $value ) {
+        $this->set_email( $value );
     }
 
     /**
-	 * Set the customer's email address.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email address.
-	 */
-	public function set_email( $value ) {
-		$this->set_prop( 'email', $value );
+     * Alias of self::set_email().
+     *
+     * @since 1.0.19
+     * @param  string $value email address.
+     */
+    public function set_customer_email( $value ) {
+        $this->set_email( $value );
     }
 
     /**
-	 * Alias of self::set_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email address.
-	 */
-	public function set_user_email( $value ) {
-		$this->set_email( $value );
+     * Set the customer's country.
+     *
+     * @since 1.0.19
+     * @param  string $value country.
+     */
+    public function set_country( $value ) {
+        $this->set_prop( 'country', $value );
     }
 
     /**
-	 * Alias of self::set_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email address.
-	 */
-	public function set_email_address( $value ) {
-		$this->set_email( $value );
+     * Alias of self::set_country().
+     *
+     * @since 1.0.19
+     * @param  string $value country.
+     */
+    public function set_user_country( $value ) {
+        $this->set_country( $value );
     }
 
     /**
-	 * Alias of self::set_email().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email address.
-	 */
-	public function set_customer_email( $value ) {
-		$this->set_email( $value );
+     * Alias of self::set_country().
+     *
+     * @since 1.0.19
+     * @param  string $value country.
+     */
+    public function set_customer_country( $value ) {
+        $this->set_country( $value );
     }
 
     /**
-	 * Set the customer's country.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value country.
-	 */
-	public function set_country( $value ) {
-		$this->set_prop( 'country', $value );
+     * Set the customer's state.
+     *
+     * @since 1.0.19
+     * @param  string $value state.
+     */
+    public function set_state( $value ) {
+        $this->set_prop( 'state', $value );
     }
 
     /**
-	 * Alias of self::set_country().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value country.
-	 */
-	public function set_user_country( $value ) {
-		$this->set_country( $value );
+     * Alias of self::set_state().
+     *
+     * @since 1.0.19
+     * @param  string $value state.
+     */
+    public function set_user_state( $value ) {
+        $this->set_state( $value );
     }
 
     /**
-	 * Alias of self::set_country().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value country.
-	 */
-	public function set_customer_country( $value ) {
-		$this->set_country( $value );
+     * Alias of self::set_state().
+     *
+     * @since 1.0.19
+     * @param  string $value state.
+     */
+    public function set_customer_state( $value ) {
+        $this->set_state( $value );
     }
 
     /**
-	 * Set the customer's state.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value state.
-	 */
-	public function set_state( $value ) {
-		$this->set_prop( 'state', $value );
+     * Set the customer's city.
+     *
+     * @since 1.0.19
+     * @param  string $value city.
+     */
+    public function set_city( $value ) {
+        $this->set_prop( 'city', $value );
     }
 
     /**
-	 * Alias of self::set_state().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value state.
-	 */
-	public function set_user_state( $value ) {
-		$this->set_state( $value );
+     * Alias of self::set_city().
+     *
+     * @since 1.0.19
+     * @param  string $value city.
+     */
+    public function set_user_city( $value ) {
+        $this->set_city( $value );
     }
 
     /**
-	 * Alias of self::set_state().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value state.
-	 */
-	public function set_customer_state( $value ) {
-		$this->set_state( $value );
+     * Alias of self::set_city().
+     *
+     * @since 1.0.19
+     * @param  string $value city.
+     */
+    public function set_customer_city( $value ) {
+        $this->set_city( $value );
     }
 
     /**
-	 * Set the customer's city.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value city.
-	 */
-	public function set_city( $value ) {
-		$this->set_prop( 'city', $value );
+     * Set the customer's zip code.
+     *
+     * @since 1.0.19
+     * @param  string $value zip.
+     */
+    public function set_zip( $value ) {
+        $this->set_prop( 'zip', $value );
     }
 
     /**
-	 * Alias of self::set_city().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value city.
-	 */
-	public function set_user_city( $value ) {
-		$this->set_city( $value );
+     * Alias of self::set_zip().
+     *
+     * @since 1.0.19
+     * @param  string $value zip.
+     */
+    public function set_user_zip( $value ) {
+        $this->set_zip( $value );
     }
 
     /**
-	 * Alias of self::set_city().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value city.
-	 */
-	public function set_customer_city( $value ) {
-		$this->set_city( $value );
+     * Alias of self::set_zip().
+     *
+     * @since 1.0.19
+     * @param  string $value zip.
+     */
+    public function set_customer_zip( $value ) {
+        $this->set_zip( $value );
     }
 
     /**
-	 * Set the customer's zip code.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value zip.
-	 */
-	public function set_zip( $value ) {
-		$this->set_prop( 'zip', $value );
+     * Set the customer's company.
+     *
+     * @since 1.0.19
+     * @param  string $value company.
+     */
+    public function set_company( $value ) {
+        $this->set_prop( 'company', $value );
     }
 
     /**
-	 * Alias of self::set_zip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value zip.
-	 */
-	public function set_user_zip( $value ) {
-		$this->set_zip( $value );
+     * Alias of self::set_company().
+     *
+     * @since 1.0.19
+     * @param  string $value company.
+     */
+    public function set_user_company( $value ) {
+        $this->set_company( $value );
     }
 
     /**
-	 * Alias of self::set_zip().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value zip.
-	 */
-	public function set_customer_zip( $value ) {
-		$this->set_zip( $value );
+     * Alias of self::set_company().
+     *
+     * @since 1.0.19
+     * @param  string $value company.
+     */
+    public function set_customer_company( $value ) {
+        $this->set_company( $value );
     }
 
     /**
-	 * Set the customer's company.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value company.
-	 */
-	public function set_company( $value ) {
-		$this->set_prop( 'company', $value );
+     * Set the customer's var number.
+     *
+     * @since 1.0.19
+     * @param  string $value var number.
+     */
+    public function set_vat_number( $value ) {
+        $this->set_prop( 'vat_number', $value );
     }
 
     /**
-	 * Alias of self::set_company().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value company.
-	 */
-	public function set_user_company( $value ) {
-		$this->set_company( $value );
+     * Alias of self::set_vat_number().
+     *
+     * @since 1.0.19
+     * @param  string $value var number.
+     */
+    public function set_user_vat_number( $value ) {
+        $this->set_vat_number( $value );
     }
 
     /**
-	 * Alias of self::set_company().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value company.
-	 */
-	public function set_customer_company( $value ) {
-		$this->set_company( $value );
+     * Alias of self::set_vat_number().
+     *
+     * @since 1.0.19
+     * @param  string $value var number.
+     */
+    public function set_customer_vat_number( $value ) {
+        $this->set_vat_number( $value );
     }
 
     /**
-	 * Set the customer's var number.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var number.
-	 */
-	public function set_vat_number( $value ) {
-		$this->set_prop( 'vat_number', $value );
+     * Set the customer's vat rate.
+     *
+     * @since 1.0.19
+     * @param  string $value var rate.
+     */
+    public function set_vat_rate( $value ) {
+        $this->set_prop( 'vat_rate', $value );
     }
 
     /**
-	 * Alias of self::set_vat_number().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var number.
-	 */
-	public function set_user_vat_number( $value ) {
-		$this->set_vat_number( $value );
+     * Alias of self::set_vat_rate().
+     *
+     * @since 1.0.19
+     * @param  string $value var number.
+     */
+    public function set_user_vat_rate( $value ) {
+        $this->set_vat_rate( $value );
     }
 
     /**
-	 * Alias of self::set_vat_number().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var number.
-	 */
-	public function set_customer_vat_number( $value ) {
-		$this->set_vat_number( $value );
+     * Alias of self::set_vat_rate().
+     *
+     * @since 1.0.19
+     * @param  string $value var number.
+     */
+    public function set_customer_vat_rate( $value ) {
+        $this->set_vat_rate( $value );
     }
 
     /**
-	 * Set the customer's vat rate.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var rate.
-	 */
-	public function set_vat_rate( $value ) {
-		$this->set_prop( 'vat_rate', $value );
+     * Set the customer's address.
+     *
+     * @since 1.0.19
+     * @param  string $value address.
+     */
+    public function set_address( $value ) {
+        $this->set_prop( 'address', $value );
     }
 
     /**
-	 * Alias of self::set_vat_rate().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var number.
-	 */
-	public function set_user_vat_rate( $value ) {
-		$this->set_vat_rate( $value );
+     * Alias of self::set_address().
+     *
+     * @since 1.0.19
+     * @param  string $value address.
+     */
+    public function set_user_address( $value ) {
+        $this->set_address( $value );
     }
 
     /**
-	 * Alias of self::set_vat_rate().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value var number.
-	 */
-	public function set_customer_vat_rate( $value ) {
-		$this->set_vat_rate( $value );
+     * Alias of self::set_address().
+     *
+     * @since 1.0.19
+     * @param  string $value address.
+     */
+    public function set_customer_address( $value ) {
+        $this->set_address( $value );
     }
 
     /**
-	 * Set the customer's address.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value address.
-	 */
-	public function set_address( $value ) {
-		$this->set_prop( 'address', $value );
+     * Set whether the customer has viewed the invoice or not.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value confirmed.
+     */
+    public function set_is_viewed( $value ) {
+        $this->set_prop( 'is_viewed', $value );
     }
 
     /**
-	 * Alias of self::set_address().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value address.
-	 */
-	public function set_user_address( $value ) {
-		$this->set_address( $value );
+     * Set extra email recipients.
+     *
+     * @since 1.0.19
+     * @param  string $value email recipients.
+     */
+    public function set_email_cc( $value ) {
+        $this->set_prop( 'email_cc', $value );
     }
 
     /**
-	 * Alias of self::set_address().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value address.
-	 */
-	public function set_customer_address( $value ) {
-		$this->set_address( $value );
+     * Set the invoice template.
+     *
+     * @since 1.0.19
+     * @param  string $value email recipients.
+     */
+    public function set_template( $value ) {
+        if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) {
+            $this->set_prop( 'template', $value );
+        }
     }
 
     /**
-	 * Set whether the customer has viewed the invoice or not.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value confirmed.
-	 */
-	public function set_is_viewed( $value ) {
-		$this->set_prop( 'is_viewed', $value );
-	}
-
-	/**
-	 * Set extra email recipients.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email recipients.
-	 */
-	public function set_email_cc( $value ) {
-		$this->set_prop( 'email_cc', $value );
-	}
-
-	/**
-	 * Set the invoice template.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value email recipients.
-	 */
-	public function set_template( $value ) {
-		if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) {
-			$this->set_prop( 'template', $value );
-		}
-	}
-
-	/**
-	 * Set the customer's address confirmed status.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value confirmed.
-	 */
-	public function set_address_confirmed( $value ) {
-		$this->set_prop( 'address_confirmed', $value );
+     * Set the customer's address confirmed status.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value confirmed.
+     */
+    public function set_address_confirmed( $value ) {
+        $this->set_prop( 'address_confirmed', $value );
     }
 
     /**
-	 * Alias of self::set_address_confirmed().
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value confirmed.
-	 */
-	public function set_user_address_confirmed( $value ) {
-		$this->set_address_confirmed( $value );
+     * Alias of self::set_address_confirmed().
+     *
+     * @since 1.0.19
+     * @param  int|bool $value confirmed.
+     */
+    public function set_user_address_confirmed( $value ) {
+        $this->set_address_confirmed( $value );
     }
 
     /**
-	 * Alias of self::set_address_confirmed().
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value confirmed.
-	 */
-	public function set_customer_address_confirmed( $value ) {
-		$this->set_address_confirmed( $value );
+     * Alias of self::set_address_confirmed().
+     *
+     * @since 1.0.19
+     * @param  int|bool $value confirmed.
+     */
+    public function set_customer_address_confirmed( $value ) {
+        $this->set_address_confirmed( $value );
     }
 
     /**
-	 * Set the invoice sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value sub total.
-	 */
-	public function set_subtotal( $value ) {
-		$this->set_prop( 'subtotal', $value );
+     * Set the invoice sub total.
+     *
+     * @since 1.0.19
+     * @param  float $value sub total.
+     */
+    public function set_subtotal( $value ) {
+        $this->set_prop( 'subtotal', $value );
     }
 
     /**
-	 * Set the invoice discount amount.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value discount total.
-	 */
-	public function set_total_discount( $value ) {
-		$this->set_prop( 'total_discount', $value );
+     * Set the invoice discount amount.
+     *
+     * @since 1.0.19
+     * @param  float $value discount total.
+     */
+    public function set_total_discount( $value ) {
+        $this->set_prop( 'total_discount', $value );
     }
 
     /**
-	 * Alias of self::set_total_discount().
-	 *
-	 * @since 1.0.19
-	 * @param  float $value discount total.
-	 */
-	public function set_discount( $value ) {
-		$this->set_total_discount( $value );
+     * Alias of self::set_total_discount().
+     *
+     * @since 1.0.19
+     * @param  float $value discount total.
+     */
+    public function set_discount( $value ) {
+        $this->set_total_discount( $value );
     }
 
     /**
-	 * Set the invoice tax amount.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value tax total.
-	 */
-	public function set_total_tax( $value ) {
-		$this->set_prop( 'total_tax', $value );
+     * Set the invoice tax amount.
+     *
+     * @since 1.0.19
+     * @param  float $value tax total.
+     */
+    public function set_total_tax( $value ) {
+        $this->set_prop( 'total_tax', $value );
     }
 
     /**
-	 * Alias of self::set_total_tax().
-	 *
-	 * @since 1.0.19
-	 * @param  float $value tax total.
-	 */
-	public function set_tax_total( $value ) {
-		$this->set_total_tax( $value );
+     * Alias of self::set_total_tax().
+     *
+     * @since 1.0.19
+     * @param  float $value tax total.
+     */
+    public function set_tax_total( $value ) {
+        $this->set_total_tax( $value );
     }
 
     /**
-	 * Set the invoice fees amount.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value fees total.
-	 */
-	public function set_total_fees( $value ) {
-		$this->set_prop( 'total_fees', $value );
+     * Set the invoice fees amount.
+     *
+     * @since 1.0.19
+     * @param  float $value fees total.
+     */
+    public function set_total_fees( $value ) {
+        $this->set_prop( 'total_fees', $value );
     }
 
     /**
-	 * Alias of self::set_total_fees().
-	 *
-	 * @since 1.0.19
-	 * @param  float $value fees total.
-	 */
-	public function set_fees_total( $value ) {
-		$this->set_total_fees( $value );
+     * Alias of self::set_total_fees().
+     *
+     * @since 1.0.19
+     * @param  float $value fees total.
+     */
+    public function set_fees_total( $value ) {
+        $this->set_total_fees( $value );
     }
 
     /**
-	 * Set the invoice fees.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value fees.
-	 */
-	public function set_fees( $value ) {
+     * Set the invoice fees.
+     *
+     * @since 1.0.19
+     * @param  array $value fees.
+     */
+    public function set_fees( $value ) {
 
         $this->set_prop( 'fees', array() );
 
@@ -2654,23 +2654,23 @@ 
     }
 
     /**
-	 * Set the invoice taxes.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value taxes.
-	 */
-	public function set_taxes( $value ) {
-		$this->set_prop( 'taxes', $value );
+     * Set the invoice taxes.
+     *
+     * @since 1.0.19
+     * @param  array $value taxes.
+     */
+    public function set_taxes( $value ) {
+        $this->set_prop( 'taxes', $value );
     }
 
     /**
-	 * Set the invoice discounts.
-	 *
-	 * @since 1.0.19
-	 * @param  array $value discounts.
-	 */
-	public function set_discounts( $value ) {
-		$this->set_prop( 'discounts', array() );
+     * Set the invoice discounts.
+     *
+     * @since 1.0.19
+     * @param  array $value discounts.
+     */
+    public function set_discounts( $value ) {
+        $this->set_prop( 'discounts', array() );
 
         // Ensure that we have an array.
         if ( ! is_array( $value ) ) {
@@ -2685,12 +2685,12 @@ 
     }
 
     /**
-	 * Set the invoice items.
-	 *
-	 * @since 1.0.19
-	 * @param  GetPaid_Form_Item[] $value items.
-	 */
-	public function set_items( $value ) {
+     * Set the invoice items.
+     *
+     * @since 1.0.19
+     * @param  GetPaid_Form_Item[] $value items.
+     */
+    public function set_items( $value ) {
 
         // Remove existing items.
         $this->set_prop( 'items', array() );
@@ -2707,83 +2707,83 @@ 
     }
 
     /**
-	 * Set the payment form.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value payment form.
-	 */
-	public function set_payment_form( $value ) {
-		$this->set_prop( 'payment_form', $value );
+     * Set the payment form.
+     *
+     * @since 1.0.19
+     * @param  int $value payment form.
+     */
+    public function set_payment_form( $value ) {
+        $this->set_prop( 'payment_form', $value );
     }
 
     /**
-	 * Set the submission id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value submission id.
-	 */
-	public function set_submission_id( $value ) {
-		$this->set_prop( 'submission_id', $value );
+     * Set the submission id.
+     *
+     * @since 1.0.19
+     * @param  string $value submission id.
+     */
+    public function set_submission_id( $value ) {
+        $this->set_prop( 'submission_id', $value );
     }
 
     /**
-	 * Set the discount code.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value discount code.
-	 */
-	public function set_discount_code( $value ) {
-		$this->set_prop( 'discount_code', $value );
+     * Set the discount code.
+     *
+     * @since 1.0.19
+     * @param  string $value discount code.
+     */
+    public function set_discount_code( $value ) {
+        $this->set_prop( 'discount_code', $value );
     }
 
     /**
-	 * Set the gateway.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value gateway.
-	 */
-	public function set_gateway( $value ) {
-		$this->set_prop( 'gateway', $value );
+     * Set the gateway.
+     *
+     * @since 1.0.19
+     * @param  string $value gateway.
+     */
+    public function set_gateway( $value ) {
+        $this->set_prop( 'gateway', $value );
     }
 
     /**
-	 * Set the transaction id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value transaction id.
-	 */
-	public function set_transaction_id( $value ) {
-		$this->set_prop( 'transaction_id', $value );
+     * Set the transaction id.
+     *
+     * @since 1.0.19
+     * @param  string $value transaction id.
+     */
+    public function set_transaction_id( $value ) {
+        $this->set_prop( 'transaction_id', $value );
     }
 
     /**
-	 * Set the currency id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value currency id.
-	 */
-	public function set_currency( $value ) {
-		$this->set_prop( 'currency', $value );
+     * Set the currency id.
+     *
+     * @since 1.0.19
+     * @param  string $value currency id.
+     */
+    public function set_currency( $value ) {
+        $this->set_prop( 'currency', $value );
     }
 
-	/**
-	 * Set whether to disable taxes.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $value value.
-	 */
-	public function set_disable_taxes( $value ) {
-		$this->set_prop( 'disable_taxes', (bool) $value );
-	}
+    /**
+     * Set whether to disable taxes.
+     *
+     * @since 1.0.19
+     * @param  bool $value value.
+     */
+    public function set_disable_taxes( $value ) {
+        $this->set_prop( 'disable_taxes', (bool) $value );
+    }
 
     /**
-	 * Set the subscription id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value subscription id.
-	 */
-	public function set_subscription_id( $value ) {
-		$this->set_prop( 'subscription_id', $value );
+     * Set the subscription id.
+     *
+     * @since 1.0.19
+     * @param  string $value subscription id.
+     */
+    public function set_subscription_id( $value ) {
+        $this->set_prop( 'subscription_id', $value );
     }
 
     /*
@@ -2822,12 +2822,12 @@ 
      */
     public function is_taxable() {
         return $this->get_disable_taxes();
-	}
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function has_vat() {
+    /**
+     * @deprecated
+     */
+    public function has_vat() {
         global $wpinv_euvat, $wpi_country;
 
         $requires_vat = false;
@@ -2838,17 +2838,17 @@ 
         }
 
         return apply_filters( 'wpinv_invoice_has_vat', $requires_vat, $this );
-	}
+    }
 
-	/**
-	 * Checks to see if the invoice requires payment.
-	 */
-	public function is_free() {
+    /**
+     * Checks to see if the invoice requires payment.
+     */
+    public function is_free() {
         $is_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 );
 
-		if ( $is_free && $this->is_recurring() ) {
-			$is_free = ! ( (float) wpinv_round_amount( $this->get_recurring_total() ) > 0 );
-		}
+        if ( $is_free && $this->is_recurring() ) {
+            $is_free = ! ( (float) wpinv_round_amount( $this->get_recurring_total() ) > 0 );
+        }
 
         return apply_filters( 'wpinv_invoice_is_free', $is_free, $this );
     }
@@ -2859,30 +2859,30 @@ 
     public function is_paid() {
         $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) );
         return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this );
-	}
+    }
 
-	/**
+    /**
      * Checks if the invoice needs payment.
      */
-	public function needs_payment() {
-		$needs_payment = ! $this->is_paid() && ! $this->is_free();
+    public function needs_payment() {
+        $needs_payment = ! $this->is_paid() && ! $this->is_free();
         return apply_filters( 'wpinv_needs_payment', $needs_payment, $this );
     }
 
-	/**
+    /**
      * Checks if the invoice is refunded.
      */
-	public function is_refunded() {
+    public function is_refunded() {
         $is_refunded = $this->has_status( 'wpi-refunded' );
         return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this );
-	}
+    }
 
-	/**
+    /**
      * Checks if the invoice is draft.
      */
-	public function is_draft() {
+    public function is_draft() {
         return $this->has_status( 'draft, auto-draft' );
-	}
+    }
 
     /**
      * Checks if the invoice has a given status.
@@ -2890,9 +2890,9 @@ 
     public function has_status( $status ) {
         $status = wpinv_parse_list( $status );
         return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status );
-	}
+    }
 
-	/**
+    /**
      * Checks if the invoice is of a given type.
      */
     public function is_type( $type ) {
@@ -2915,25 +2915,25 @@ 
      */
     public function has_free_trial() {
         return $this->is_recurring() && 0 == $this->get_initial_total();
-	}
+    }
 
-	/**
+    /**
      * @deprecated
      */
     public function is_free_trial() {
         $this->has_free_trial();
     }
 
-	/**
+    /**
      * Check if the initial payment if 0.
      *
      */
-	public function is_initial_free() {
+    public function is_initial_free() {
         $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 );
         return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this );
     }
 	
-	/**
+    /**
      * Check if the recurring item has a free trial.
      *
      */
@@ -2946,21 +2946,21 @@ 
 
         $item = new WPInv_Item( $this->recurring_item );
         return $item->has_free_trial();
-	}
+    }
 
-	/**
+    /**
      * Check if the free trial is a result of a discount.
      */
     public function is_free_trial_from_discount() {
-		return $this->has_free_trial() && ! $this->item_has_free_trial();
-	}
+        return $this->has_free_trial() && ! $this->item_has_free_trial();
+    }
 	
-	/**
+    /**
      * @deprecated
      */
     public function discount_first_payment_only() {
 
-		$discount_code = $this->get_discount_code();
+        $discount_code = $this->get_discount_code();
         if ( empty( $this->discount_code ) || ! $this->is_recurring() ) {
             return true;
         }
@@ -2992,19 +2992,19 @@ 
     public function add_item( $item ) {
 
         // Make sure that it is available for purchase.
-		if ( $item->get_id() > 0 && ! $item->can_purchase() ) {
-			return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) );
+        if ( $item->get_id() > 0 && ! $item->can_purchase() ) {
+            return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) );
         }
 
         // Do we have a recurring item?
-		if ( $item->is_recurring() ) {
+        if ( $item->is_recurring() ) {
 
-			// An invoice can only contain one recurring item.
-			if ( ! empty( $this->recurring_item ) ) {
-				return false;
-			}
+            // An invoice can only contain one recurring item.
+            if ( ! empty( $this->recurring_item ) ) {
+                return false;
+            }
 
-			$this->recurring_item = $item->get_id();
+            $this->recurring_item = $item->get_id();
         }
 
         // Invoice id.
@@ -3015,25 +3015,25 @@ 
         $items[ $item->get_id() ] = $item;
 
         $this->set_prop( 'items', $items );
-		return true;
+        return true;
     }
 
     /**
-	 * Retrieves a specific item.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_item( $item_id ) {
+     * Retrieves a specific item.
+     *
+     * @since 1.0.19
+     */
+    public function get_item( $item_id ) {
         $items = $this->get_items();
-		return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null;
+        return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null;
     }
 
     /**
-	 * Removes a specific item.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
+     * Removes a specific item.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
         $items = $this->get_items();
 
         if ( $item_id == $this->recurring_item ) {
@@ -3061,38 +3061,38 @@ 
         if ( isset( $fees[ $fee ] ) && isset( $fees[ $fee ]['amount'] ) ) {
 
             $amount = $fees[ $fee ]['amount'] += $amount;
-			$fees[ $fee ] = array(
+            $fees[ $fee ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
 
-		} else {
-			$fees[ $fee ] = array(
+        } else {
+            $fees[ $fee ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
-		}
+        }
 
         $this->set_prop( 'fees', $fee );
 
     }
 
     /**
-	 * Retrieves a specific fee.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee( $fee ) {
+     * Retrieves a specific fee.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee( $fee ) {
         $fees = $this->get_fees();
-		return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null;
+        return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null;
     }
 
     /**
-	 * Removes a specific fee.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $fee ) {
+     * Removes a specific fee.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $fee ) {
         $fees = $this->get_fees();
         if ( isset( $fees[ $fee ] ) ) {
             unset( $fees[ $fee ] );
@@ -3115,44 +3115,44 @@ 
         if ( isset( $discounts[ $discount ] ) && isset( $discounts[ $discount ]['amount'] ) ) {
 
             $amount = $discounts[ $discount ]['amount'] += $amount;
-			$discounts[ $discount ] = array(
+            $discounts[ $discount ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
 
-		} else {
-			$discounts[ $discount ] = array(
+        } else {
+            $discounts[ $discount ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
-		}
+        }
 
         $this->set_prop( 'discounts', $discount );
 
     }
 
     /**
-	 * Retrieves a specific discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount( $discount = false ) {
+     * Retrieves a specific discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount( $discount = false ) {
 
-		// Backwards compatibilty.
-		if ( empty( $discount ) ) {
-			return $this->get_total_discount();
-		}
+        // Backwards compatibilty.
+        if ( empty( $discount ) ) {
+            return $this->get_total_discount();
+        }
 
         $discounts = $this->get_discounts();
-		return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null;
+        return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null;
     }
 
     /**
-	 * Removes a specific discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $discount ) {
+     * Removes a specific discount.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $discount ) {
         $discounts = $this->get_discounts();
         if ( isset( $discounts[ $discount ] ) ) {
             unset( $discounts[ $discount ] );
@@ -3178,38 +3178,38 @@ 
         if ( isset( $taxes[ $tax ] ) && isset( $taxes[ $tax ]['amount'] ) ) {
 
             $amount = $taxes[ $tax ]['amount'] += $amount;
-			$taxes[ $tax ] = array(
+            $taxes[ $tax ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
 
-		} else {
-			$taxes[ $tax ] = array(
+        } else {
+            $taxes[ $tax ] = array(
                 'amount'    => $amount,
                 'recurring' => (bool) $recurring,
             );
-		}
+        }
 
         $this->set_prop( 'taxes', $tax );
 
     }
 
     /**
-	 * Retrieves a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax( $tax ) {
+     * Retrieves a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax( $tax ) {
         $taxes = $this->get_taxes();
-		return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null;
+        return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null;
     }
 
     /**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax ) {
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax ) {
         $taxes = $this->get_discounts();
         if ( isset( $taxes[ $tax ] ) ) {
             unset( $taxes[ $tax ] );
@@ -3218,160 +3218,160 @@ 
     }
 
     /**
-	 * Recalculates the invoice subtotal.
-	 *
-	 * @since 1.0.19
-	 * @return float The recalculated subtotal
-	 */
-	public function recalculate_subtotal() {
+     * Recalculates the invoice subtotal.
+     *
+     * @since 1.0.19
+     * @return float The recalculated subtotal
+     */
+    public function recalculate_subtotal() {
         $items     = $this->get_items();
-		$subtotal  = 0;
-		$recurring = 0;
+        $subtotal  = 0;
+        $recurring = 0;
 
         foreach ( $items as $item ) {
-			$subtotal  += $item->get_sub_total();
-			$recurring += $item->get_recurring_sub_total();
+            $subtotal  += $item->get_sub_total();
+            $recurring += $item->get_recurring_sub_total();
         }
 
-		if ( $this->is_renewal() ) {
-			$this->set_subtotal( $recurring );
-		} else {
-			$this->set_subtotal( $subtotal );
-		}
+        if ( $this->is_renewal() ) {
+            $this->set_subtotal( $recurring );
+        } else {
+            $this->set_subtotal( $subtotal );
+        }
 
-		$this->totals['subtotal'] = array(
-			'initial'   => $subtotal,
-			'recurring' => $recurring,
-		);
+        $this->totals['subtotal'] = array(
+            'initial'   => $subtotal,
+            'recurring' => $recurring,
+        );
 
         return $this->is_renewal() ? $recurring : $subtotal;
     }
 
     /**
-	 * Recalculates the invoice discount total.
-	 *
-	 * @since 1.0.19
-	 * @return float The recalculated discount
-	 */
-	public function recalculate_total_discount() {
+     * Recalculates the invoice discount total.
+     *
+     * @since 1.0.19
+     * @return float The recalculated discount
+     */
+    public function recalculate_total_discount() {
         $discounts = $this->get_discounts();
-		$discount  = 0;
-		$recurring = 0;
+        $discount  = 0;
+        $recurring = 0;
 
         foreach ( $discounts as $data ) {
 
-			if ( $data['recurring'] ) {
-				$recurring += $data['amount'];
-			} else {
-				$discount += $data['amount'];
-			}
+            if ( $data['recurring'] ) {
+                $recurring += $data['amount'];
+            } else {
+                $discount += $data['amount'];
+            }
 
-		}
+        }
 
-		if ( $this->is_renewal() ) {
-			$this->set_total_discount( $recurring );
-		} else {
-			$this->set_total_discount( $discount );
-		}
+        if ( $this->is_renewal() ) {
+            $this->set_total_discount( $recurring );
+        } else {
+            $this->set_total_discount( $discount );
+        }
 
-		$this->totals['discount'] = array(
-			'initial'   => $discount,
-			'recurring' => $recurring,
-		);
+        $this->totals['discount'] = array(
+            'initial'   => $discount,
+            'recurring' => $recurring,
+        );
 
-		return $this->is_renewal() ? $recurring : $discount;
+        return $this->is_renewal() ? $recurring : $discount;
 
     }
 
     /**
-	 * Recalculates the invoice tax total.
-	 *
-	 * @since 1.0.19
-	 * @return float The recalculated tax
-	 */
-	public function recalculate_total_tax() {
+     * Recalculates the invoice tax total.
+     *
+     * @since 1.0.19
+     * @return float The recalculated tax
+     */
+    public function recalculate_total_tax() {
         $taxes     = $this->get_taxes();
-		$tax       = 0;
-		$recurring = 0;
+        $tax       = 0;
+        $recurring = 0;
 
         foreach ( $taxes as $data ) {
 
-			if ( $data['recurring'] ) {
-				$recurring += $data['amount'];
-			} else {
-				$tax += $data['amount'];
-			}
+            if ( $data['recurring'] ) {
+                $recurring += $data['amount'];
+            } else {
+                $tax += $data['amount'];
+            }
 
-		}
+        }
 
-		if ( $this->is_renewal() ) {
-			$this->set_total_tax( $recurring );
-		} else {
-			$this->set_total_tax( $tax );
-		}
+        if ( $this->is_renewal() ) {
+            $this->set_total_tax( $recurring );
+        } else {
+            $this->set_total_tax( $tax );
+        }
 
-		$this->totals['tax'] = array(
-			'initial'   => $tax,
-			'recurring' => $recurring,
-		);
+        $this->totals['tax'] = array(
+            'initial'   => $tax,
+            'recurring' => $recurring,
+        );
 
-		return $this->is_renewal() ? $recurring : $tax;
+        return $this->is_renewal() ? $recurring : $tax;
 
     }
 
     /**
-	 * Recalculates the invoice fees total.
-	 *
-	 * @since 1.0.19
-	 * @return float The recalculated fee
-	 */
-	public function recalculate_total_fees() {
-		$fees      = $this->get_fees();
-		$fee       = 0;
-		$recurring = 0;
+     * Recalculates the invoice fees total.
+     *
+     * @since 1.0.19
+     * @return float The recalculated fee
+     */
+    public function recalculate_total_fees() {
+        $fees      = $this->get_fees();
+        $fee       = 0;
+        $recurring = 0;
 
         foreach ( $fees as $data ) {
 
-			if ( $data['recurring'] ) {
-				$recurring += $data['amount'];
-			} else {
-				$fee += $data['amount'];
-			}
+            if ( $data['recurring'] ) {
+                $recurring += $data['amount'];
+            } else {
+                $fee += $data['amount'];
+            }
 
-		}
+        }
 
         if ( $this->is_renewal() ) {
-			$this->set_total_fees( $recurring );
-		} else {
-			$this->set_total_fees( $fee );
-		}
+            $this->set_total_fees( $recurring );
+        } else {
+            $this->set_total_fees( $fee );
+        }
 
-		$this->totals['fee'] = array(
-			'initial'   => $fee,
-			'recurring' => $recurring,
-		);
+        $this->totals['fee'] = array(
+            'initial'   => $fee,
+            'recurring' => $recurring,
+        );
 
         $this->set_total_fees( $fee );
         return $this->is_renewal() ? $recurring : $fee;
     }
 
     /**
-	 * Recalculates the invoice total.
-	 *
-	 * @since 1.0.19
+     * Recalculates the invoice total.
+     *
+     * @since 1.0.19
      * @return float The invoice total
-	 */
-	public function recalculate_total() {
+     */
+    public function recalculate_total() {
         $this->recalculate_subtotal();
         $this->recalculate_total_fees();
         $this->recalculate_total_discount();
         $this->recalculate_total_tax();
-		return $this->get_total();
-	}
+        return $this->get_total();
+    }
 
-	/**
-	 * @deprecated
-	 */
+    /**
+     * @deprecated
+     */
     public function recalculate_totals( $temp = false ) {
         $this->update_items( $temp );
         $this->save( true );
@@ -3435,9 +3435,9 @@ 
         }
 
         return $note_id;
-	}
+    }
 
-	/**
+    /**
      * Generates a unique key for the invoice.
      */
     public function generate_key( $string = '' ) {
@@ -3458,106 +3458,106 @@ 
             $number      = $next_number;
         }
 
-		$number = wpinv_format_invoice_number( $number, $this->post_type );
+        $number = wpinv_format_invoice_number( $number, $this->post_type );
 
-		return $number;
-	}
+        return $number;
+    }
 
-	/**
-	 * Handle the status transition.
-	 */
-	protected function status_transition() {
-		$status_transition = $this->status_transition;
+    /**
+     * Handle the status transition.
+     */
+    protected function status_transition() {
+        $status_transition = $this->status_transition;
 
-		// Reset status transition variable.
-		$this->status_transition = false;
+        // Reset status transition variable.
+        $this->status_transition = false;
 
-		if ( $status_transition ) {
-			try {
+        if ( $status_transition ) {
+            try {
 
-				// Fire a hook for the status change.
-				do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
+                // Fire a hook for the status change.
+                do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
 
-				// @deprecated this is deprecated and will be removed in the future.
-				do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] );
+                // @deprecated this is deprecated and will be removed in the future.
+                do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] );
 
-				if ( ! empty( $status_transition['from'] ) ) {
+                if ( ! empty( $status_transition['from'] ) ) {
 
-					/* translators: 1: old invoice status 2: new invoice status */
-					$transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'] ), wpinv_status_nicename( $status_transition['to'] ) );
+                    /* translators: 1: old invoice status 2: new invoice status */
+                    $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'] ), wpinv_status_nicename( $status_transition['to'] ) );
 
-					// Fire another hook.
-					do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
-					do_action( 'getpaid_invoice_status_changed', $this->get_id(), $status_transition['from'], $status_transition['to'], $this );
+                    // Fire another hook.
+                    do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
+                    do_action( 'getpaid_invoice_status_changed', $this->get_id(), $status_transition['from'], $status_transition['to'], $this );
 
-					// @deprecated this is deprecated and will be removed in the future.
-					do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->ID, $status_transition['from'] );
+                    // @deprecated this is deprecated and will be removed in the future.
+                    do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->ID, $status_transition['from'] );
 
-					// Note the transition occurred.
-					$this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] );
+                    // Note the transition occurred.
+                    $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] );
 
-					// Work out if this was for a payment, and trigger a payment_status hook instead.
-					if (
-						in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed' ), true )
-						&& in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true )
-					) {
-						do_action( 'getpaid_invoice_payment_status_changed', $this->get_id(), $this, $status_transition );
-					}
-				} else {
-					/* translators: %s: new invoice status */
-					$transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'] ) );
+                    // Work out if this was for a payment, and trigger a payment_status hook instead.
+                    if (
+                        in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed' ), true )
+                        && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true )
+                    ) {
+                        do_action( 'getpaid_invoice_payment_status_changed', $this->get_id(), $this, $status_transition );
+                    }
+                } else {
+                    /* translators: %s: new invoice status */
+                    $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'] ) );
 
-					// Note the transition occurred.
-					$this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] );
+                    // Note the transition occurred.
+                    $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] );
 
-				}
-			} catch ( Exception $e ) {
-				$this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
-			}
-		}
-	}
+                }
+            } catch ( Exception $e ) {
+                $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
+            }
+        }
+    }
 
-	/**
-	 * Updates an invoice status.
-	 */
-	public function update_status( $new_status = false, $note = '', $manual = false ) {
+    /**
+     * Updates an invoice status.
+     */
+    public function update_status( $new_status = false, $note = '', $manual = false ) {
 
-		// Fires before updating a status.
-		do_action( 'wpinv_before_invoice_status_change', $this->ID, $new_status, $this->get_status( 'edit' ) );
+        // Fires before updating a status.
+        do_action( 'wpinv_before_invoice_status_change', $this->ID, $new_status, $this->get_status( 'edit' ) );
 
-		// Update the status.
-		$this->set_status( $new_status, $note, $manual );
+        // Update the status.
+        $this->set_status( $new_status, $note, $manual );
 
-		// Save the order.
-		return $this->save();
+        // Save the order.
+        return $this->save();
 
-	}
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function refresh_item_ids() {
+    /**
+     * @deprecated
+     */
+    public function refresh_item_ids() {
         $item_ids = implode( ',', array_unique( array_keys( $this->get_items() ) ) );
         update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids );
-	}
+    }
 
-	/**
-	 * @deprecated
-	 */
-	public function update_items( $temp = false ) {
+    /**
+     * @deprecated
+     */
+    public function update_items( $temp = false ) {
 
-		$this->set_items( $this->get_items() );
+        $this->set_items( $this->get_items() );
 
-		if ( ! $temp ) {
-			$this->save();
-		}
+        if ( ! $temp ) {
+            $this->save();
+        }
 
         return $this;
-	}
+    }
 
-	/**
-	 * @deprecated
-	 */
+    /**
+     * @deprecated
+     */
     public function validate_discount() {
 
         $discount_code = $this->get_discount_code();
@@ -3573,25 +3573,25 @@ 
 
     }
 
-	/**
-	 * Refunds an invoice.
-	 */
+    /**
+     * Refunds an invoice.
+     */
     public function refund() {
-		$this->set_status( 'wpi-refunded' );
+        $this->set_status( 'wpi-refunded' );
         $this->save();
     }
 
-	/**
-	 * Save data to the database.
-	 *
-	 * @since 1.0.19
-	 * @return int invoice ID
-	 */
-	public function save() {
-		$this->maybe_set_date_paid();
-		parent::save();
-		$this->status_transition();
-		return $this->get_id();
-	}
+    /**
+     * Save data to the database.
+     *
+     * @since 1.0.19
+     * @return int invoice ID
+     */
+    public function save() {
+        $this->maybe_set_date_paid();
+        parent::save();
+        $this->status_transition();
+        return $this->get_id();
+    }
 
 }

includes/class-getpaid-form-item.php

Indentation +329 added lines, -329 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,60 +10,60 @@ 
 class GetPaid_Form_Item  extends WPInv_Item {
 
     /**
-	 * Stores a custom description for the item.
-	 *
-	 * @var string
-	 */
-	protected $custom_description = '';
-
-	/**
-	 * Stores the item quantity.
-	 *
-	 * @var int
-	 */
-	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;
-
-	/**
-	 * Item tax.
-	 *
-	 * @var float
-	 */
-	public $item_tax = 0;
+     * Stores a custom description for the item.
+     *
+     * @var string
+     */
+    protected $custom_description = '';
+
+    /**
+     * Stores the item quantity.
+     *
+     * @var int
+     */
+    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;
+
+    /**
+     * Item tax.
+     *
+     * @var float
+     */
+    public $item_tax = 0;
 
     /*
 	|--------------------------------------------------------------------------
@@ -81,208 +81,208 @@ 
     */
 
     /**
-	 * 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 description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-
-		if ( ! empty( $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 int
-	 */
-	public function get_sub_total( $context = 'view' ) {
-		return $this->get_quantity( $context ) * $this->get_initial_price( $context );
-	}
-
-	/**
-	 * Returns the recurring sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_sub_total( $context = 'view' ) {
-		return $this->get_quantity( $context ) * $this->get_price( $context );
-	}
-
-	/**
-	 * @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 int
-	 */
-	public function get_quantity( $context = 'view' ) {
-		$quantity = (int) $this->quantity;
-
-		if ( empty( $quantity ) || 1 > $quantity ) {
-			$quantity = 1;
-		}
-
-		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;
-
-	}
-
-	/**
-	 * Prepares form data for use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_use() {
-
-		return array(
-			'title'            => sanitize_text_field( $this->get_name() ),
-			'id'               => $this->get_id(),
-			'price'            => $this->get_price(),
-			'recurring'        => $this->is_recurring(),
-			'description'      => $this->get_description(),
-			'allow_quantities' => $this->allows_quantities(),
-			'required'         => $this->is_required(),
-		);
-
-	}
-
-	/**
-	 * Prepares form data for ajax use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_invoice_edit_ajax() {
-
-		return array(
-			'id'     => $this->get_id(),
-			'texts'  => array(
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ),
-				'item-quantity'    => absint( $this->get_quantity() ),
-				'item-price'       => wpinv_price( wpinv_format_amount ( $this->get_price() ) ),
-				'item-total'       => wpinv_price( wpinv_format_amount( $this->get_sub_total() ) ),
-			),
-			'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'    => absint( $this->get_quantity() ),
-				'item-price'       => $this->get_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_name() ),
-			'item_description'  => $this->get_description(),
-			'tax'               => $this->item_tax,
-			'item_price'        => $this->get_price(),
-			'quantity'          => (int) $this->get_quantity(),
-			'discount'          => $this->item_discount,
-			'subtotal'          => $this->get_sub_total(),
-			'price'             => $this->get_sub_total() + $this->item_tax + $this->item_discount,
-			'meta'              => $this->get_item_meta(),
+     * 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 description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+
+        if ( ! empty( $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 int
+     */
+    public function get_sub_total( $context = 'view' ) {
+        return $this->get_quantity( $context ) * $this->get_initial_price( $context );
+    }
+
+    /**
+     * Returns the recurring sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_sub_total( $context = 'view' ) {
+        return $this->get_quantity( $context ) * $this->get_price( $context );
+    }
+
+    /**
+     * @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 int
+     */
+    public function get_quantity( $context = 'view' ) {
+        $quantity = (int) $this->quantity;
+
+        if ( empty( $quantity ) || 1 > $quantity ) {
+            $quantity = 1;
+        }
+
+        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;
+
+    }
+
+    /**
+     * Prepares form data for use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_use() {
+
+        return array(
+            'title'            => sanitize_text_field( $this->get_name() ),
+            'id'               => $this->get_id(),
+            'price'            => $this->get_price(),
+            'recurring'        => $this->is_recurring(),
+            'description'      => $this->get_description(),
+            'allow_quantities' => $this->allows_quantities(),
+            'required'         => $this->is_required(),
+        );
+
+    }
+
+    /**
+     * Prepares form data for ajax use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_invoice_edit_ajax() {
+
+        return array(
+            'id'     => $this->get_id(),
+            'texts'  => array(
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ),
+                'item-quantity'    => absint( $this->get_quantity() ),
+                'item-price'       => wpinv_price( wpinv_format_amount ( $this->get_price() ) ),
+                'item-total'       => wpinv_price( wpinv_format_amount( $this->get_sub_total() ) ),
+            ),
+            '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'    => absint( $this->get_quantity() ),
+                'item-price'       => $this->get_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_name() ),
+            'item_description'  => $this->get_description(),
+            'tax'               => $this->item_tax,
+            'item_price'        => $this->get_price(),
+            'quantity'          => (int) $this->get_quantity(),
+            'discount'          => $this->item_discount,
+            'subtotal'          => $this->get_sub_total(),
+            'price'             => $this->get_sub_total() + $this->item_tax + $this->item_discount,
+            'meta'              => $this->get_item_meta(),
         );
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -294,70 +294,70 @@ 
 	| object.
     */
 
-	/**
-	 * Set the item qantity.
-	 *
-	 * @since 1.0.19
-	 * @param  int $quantity The item quantity.
-	 */
-	public function set_quantity( $quantity ) {
-
-		if ( empty( $quantity ) || ! is_numeric( $quantity ) ) {
-			$quantity = 1;
-		}
-
-		$this->quantity = $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 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 the item qantity.
+     *
+     * @since 1.0.19
+     * @param  int $quantity The item quantity.
+     */
+    public function set_quantity( $quantity ) {
+
+        if ( empty( $quantity ) || ! is_numeric( $quantity ) ) {
+            $quantity = 1;
+        }
+
+        $this->quantity = $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 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();
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -369,23 +369,23 @@ 
 	*/
 
     /**
-	 * 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/data-stores/class-getpaid-payment-form-data-store.php

Indentation +169 added lines, -169 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,179 +14,179 @@ 
  */
 class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a form.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'wpinv_form_elements',
-		'wpinv_form_items',
-		'wpinv_form_earned',
-		'wpinv_form_refunded',
-		'wpinv_form_cancelled',
-		'wpinv_form_failed'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'wpinv_form_elements'  => 'elements',
-		'wpinv_form_items'     => 'items',
-		'wpinv_form_earned'    => 'earned',
-		'wpinv_form_refunded'  => 'refunded',
-		'wpinv_form_cancelled' => 'cancelled',
-		'wpinv_form_failed'    => 'failed',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a form.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        'wpinv_form_elements',
+        'wpinv_form_items',
+        'wpinv_form_earned',
+        'wpinv_form_refunded',
+        'wpinv_form_cancelled',
+        'wpinv_form_failed'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        'wpinv_form_elements'  => 'elements',
+        'wpinv_form_items'     => 'items',
+        'wpinv_form_earned'    => 'earned',
+        'wpinv_form_refunded'  => 'refunded',
+        'wpinv_form_cancelled' => 'cancelled',
+        'wpinv_form_failed'    => 'failed',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_payment_form_data',
-				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
-					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
-			$form->save_meta_data();
-			$form->apply_changes();
-			$this->clear_caches( $form );
-			do_action( 'getpaid_create_payment_form', $form->get_id(), $form );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$form->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a form from the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 *
-	 */
-	public function read( &$form ) {
-
-		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
-
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			$form->set_id( 0 );
-			return false;
-		}
-
-		$form->set_props(
-			array(
-				'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
-				'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
-				'status'        => $form_object->post_status,
-				'name'          => $form_object->post_title,
-				'author'        => $form_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $form, $form_object );
-		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form->get_id(), $form );
-
-	}
-
-	/**
-	 * Method to update a form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function update( &$form ) {
-		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
-
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $form->get_id() );
-
-		$changes = $form->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
-			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $form );
-		$form->apply_changes();
-		$this->clear_caches( $form );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $form->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_payment_form', $form->get_id(), $form );
-		} else {
-			do_action( 'getpaid_update_payment_form', $form->get_id(), $form );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function create( &$form ) {
+        $form->set_version( WPINV_VERSION );
+        $form->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_payment_form_data',
+                array(
+                    'post_date'     => $form->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_payment_form',
+                    'post_status'   => $this->get_post_status( $form ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $form->get_author( 'edit' ),
+                    'post_title'    => $form->get_name( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $form->set_id( $id );
+            $this->update_post_meta( $form );
+            $form->save_meta_data();
+            $form->apply_changes();
+            $this->clear_caches( $form );
+            do_action( 'getpaid_create_payment_form', $form->get_id(), $form );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $form->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a form from the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     *
+     */
+    public function read( &$form ) {
+
+        $form->set_defaults();
+        $form_object = get_post( $form->get_id() );
+
+        if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
+            $form->last_error = __( 'Invalid form.', 'invoicing' );
+            $form->set_id( 0 );
+            return false;
+        }
+
+        $form->set_props(
+            array(
+                'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
+                'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
+                'status'        => $form_object->post_status,
+                'name'          => $form_object->post_title,
+                'author'        => $form_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $form, $form_object );
+        $form->read_meta_data();
+        $form->set_object_read( true );
+        do_action( 'getpaid_read_payment_form', $form->get_id(), $form );
+
+    }
+
+    /**
+     * Method to update a form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function update( &$form ) {
+        $form->save_meta_data();
+        $form->set_version( WPINV_VERSION );
+
+        if ( null === $form->get_date_created( 'edit' ) ) {
+            $form->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $form->get_id() );
+
+        $changes = $form->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $form->get_date_created( 'edit' ),
+                'post_status'       => $form->get_status( 'edit' ),
+                'post_title'        => $form->get_name( 'edit' ),
+                'post_author'       => $form->get_author( 'edit' ),
+                'post_modified'     => $form->get_date_modified( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
+                clean_post_cache( $form->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+            }
+            $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $form );
+        $form->apply_changes();
+        $this->clear_caches( $form );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $form->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_payment_form', $form->get_id(), $form );
+        } else {
+            do_action( 'getpaid_update_payment_form', $form->get_id(), $form );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +186 added lines, -186 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,196 +15,196 @@ 
  */
 class GetPaid_Discount_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpi_discount_code',
-		'_wpi_discount_amount',
-		'_wpi_discount_start',
-		'_wpi_discount_expiration',
-		'_wpi_discount_type',
-		'_wpi_discount_uses',
-		'_wpi_discount_is_single_use',
-		'_wpi_discount_items',
-		'_wpi_discount_excluded_items',
-		'_wpi_discount_max_uses',
-		'_wpi_discount_is_recurring',
-		'_wpi_discount_min_total',
-		'_wpi_discount_max_total',
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpi_discount_code'           => 'code',
-		'_wpi_discount_amount'         => 'amount',
-		'_wpi_discount_start'          => 'start',
-		'_wpi_discount_expiration'     => 'expiration',
-		'_wpi_discount_type'           => 'type',
-		'_wpi_discount_uses'           => 'uses',
-		'_wpi_discount_is_single_use'  => 'is_single_use',
-		'_wpi_discount_items'          => 'items',
-		'_wpi_discount_excluded_items' => 'excluded_items',
-		'_wpi_discount_max_uses'       => 'max_uses',
-		'_wpi_discount_is_recurring'   => 'is_recurring',
-		'_wpi_discount_min_total'      => 'min_total',
-		'_wpi_discount_max_total'      => 'max_total',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpi_discount_code',
+        '_wpi_discount_amount',
+        '_wpi_discount_start',
+        '_wpi_discount_expiration',
+        '_wpi_discount_type',
+        '_wpi_discount_uses',
+        '_wpi_discount_is_single_use',
+        '_wpi_discount_items',
+        '_wpi_discount_excluded_items',
+        '_wpi_discount_max_uses',
+        '_wpi_discount_is_recurring',
+        '_wpi_discount_min_total',
+        '_wpi_discount_max_total',
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpi_discount_code'           => 'code',
+        '_wpi_discount_amount'         => 'amount',
+        '_wpi_discount_start'          => 'start',
+        '_wpi_discount_expiration'     => 'expiration',
+        '_wpi_discount_type'           => 'type',
+        '_wpi_discount_uses'           => 'uses',
+        '_wpi_discount_is_single_use'  => 'is_single_use',
+        '_wpi_discount_items'          => 'items',
+        '_wpi_discount_excluded_items' => 'excluded_items',
+        '_wpi_discount_max_uses'       => 'max_uses',
+        '_wpi_discount_is_recurring'   => 'is_recurring',
+        '_wpi_discount_min_total'      => 'min_total',
+        '_wpi_discount_max_total'      => 'max_total',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_discount_data',
-				array(
-					'post_date'     => $discount->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $discount ),
-					'ping_status'   => 'closed',
-					'post_author'   => $discount->get_author( 'edit' ),
-					'post_title'    => $discount->get_name( 'edit' ),
-					'post_excerpt'  => $discount->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$discount->set_id( $id );
-			$this->update_post_meta( $discount );
-			$discount->save_meta_data();
-			$discount->apply_changes();
-			$this->clear_caches( $discount );
-			do_action( 'getpaid_new_discount', $discount->get_id(), $discount );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$discount->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a discount from the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 *
-	 */
-	public function read( &$discount ) {
-
-		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
-
-		if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
-			$discount->last_error = __( 'Invalid discount.', 'invoicing' );
-			$discount->set_id( 0 );
-			return false;
-		}
-
-		$discount->set_props(
-			array(
-				'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
-				'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
-				'status'        => $discount_object->post_status,
-				'name'          => $discount_object->post_title,
-				'author'        => $discount_object->post_author,
-				'description'   => $discount_object->post_excerpt,
-			)
-		);
-
-		$this->read_object_data( $discount, $discount_object );
-		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount->get_id(), $discount );
-
-	}
-
-	/**
-	 * Method to update a discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function update( &$discount ) {
-		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
-
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $discount->get_id() );
-
-		$changes = $discount->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $discount->get_date_created( 'edit' ),
-				'post_status'       => $discount->get_status( 'edit' ),
-				'post_title'        => $discount->get_name( 'edit' ),
-				'post_author'       => $discount->get_author( 'edit' ),
-				'post_modified'     => $discount->get_date_modified( 'edit' ),
-				'post_excerpt'      => $discount->get_description( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
-				clean_post_cache( $discount->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
-			}
-			$discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $discount );
-		$discount->apply_changes();
-		$this->clear_caches( $discount );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $discount->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_discount', $discount->get_id(), $discount );
-		} else {
-			do_action( 'getpaid_update_discount', $discount->get_id(), $discount );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function create( &$discount ) {
+        $discount->set_version( WPINV_VERSION );
+        $discount->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_discount_data',
+                array(
+                    'post_date'     => $discount->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_discount',
+                    'post_status'   => $this->get_post_status( $discount ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $discount->get_author( 'edit' ),
+                    'post_title'    => $discount->get_name( 'edit' ),
+                    'post_excerpt'  => $discount->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $discount->set_id( $id );
+            $this->update_post_meta( $discount );
+            $discount->save_meta_data();
+            $discount->apply_changes();
+            $this->clear_caches( $discount );
+            do_action( 'getpaid_new_discount', $discount->get_id(), $discount );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $discount->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a discount from the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     *
+     */
+    public function read( &$discount ) {
+
+        $discount->set_defaults();
+        $discount_object = get_post( $discount->get_id() );
+
+        if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
+            $discount->last_error = __( 'Invalid discount.', 'invoicing' );
+            $discount->set_id( 0 );
+            return false;
+        }
+
+        $discount->set_props(
+            array(
+                'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
+                'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
+                'status'        => $discount_object->post_status,
+                'name'          => $discount_object->post_title,
+                'author'        => $discount_object->post_author,
+                'description'   => $discount_object->post_excerpt,
+            )
+        );
+
+        $this->read_object_data( $discount, $discount_object );
+        $discount->read_meta_data();
+        $discount->set_object_read( true );
+        do_action( 'getpaid_read_discount', $discount->get_id(), $discount );
+
+    }
+
+    /**
+     * Method to update a discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function update( &$discount ) {
+        $discount->save_meta_data();
+        $discount->set_version( WPINV_VERSION );
+
+        if ( null === $discount->get_date_created( 'edit' ) ) {
+            $discount->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $discount->get_id() );
+
+        $changes = $discount->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $discount->get_date_created( 'edit' ),
+                'post_status'       => $discount->get_status( 'edit' ),
+                'post_title'        => $discount->get_name( 'edit' ),
+                'post_author'       => $discount->get_author( 'edit' ),
+                'post_modified'     => $discount->get_date_modified( 'edit' ),
+                'post_excerpt'      => $discount->get_description( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
+                clean_post_cache( $discount->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
+            }
+            $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $discount );
+        $discount->apply_changes();
+        $this->clear_caches( $discount );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $discount->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_discount', $discount->get_id(), $discount );
+        } else {
+            do_action( 'getpaid_update_discount', $discount->get_id(), $discount );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +845 added lines, -845 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 $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() {
-		try {
-			$this->__construct( absint( $this->id ) );
-		} catch ( Exception $e ) {
-			$this->set_id( 0 );
-			$this->set_object_read( true );
-		}
-	}
-
-	/**
-	 * 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->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.', 'getpaid' ), $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.', 'getpaid' ), $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 $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() {
+        try {
+            $this->__construct( absint( $this->id ) );
+        } catch ( Exception $e ) {
+            $this->set_id( 0 );
+            $this->set_object_read( true );
+        }
+    }
+
+    /**
+     * 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->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.', 'getpaid' ), $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.', 'getpaid' ), $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.', 'getpaid' ), $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.', 'getpaid' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,497 +391,497 @@ 
             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.
-		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,
-			)
-		);
-	}
-
-	/**
-	 * 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 ) {
-		$this->meta_data = array();
-		$cache_loaded    = false;
-
-		if ( ! $this->get_id() ) {
-			return;
-		}
-
-		if ( ! $this->data_store ) {
-			return;
-		}
-
-		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();
-		}
-
-		if ( ! $force_read ) {
-			if ( ! empty( $this->cache_group ) ) {
-				$cached_meta  = wp_cache_get( $cache_key, $this->cache_group );
-				$cache_loaded = ! empty( $cached_meta );
-			}
-		}
-
-		$raw_meta_data = $cache_loaded ? $cached_meta : $this->data_store->read_meta( $this );
-		if ( $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 ),
-					)
-				);
-			}
-
-			if ( ! $cache_loaded && ! empty( $this->cache_group ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-		}
-	}
-
-	/**
-	 * 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.
+        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,
+            )
+        );
+    }
+
+    /**
+     * 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 ) {
+        $this->meta_data = array();
+        $cache_loaded    = false;
+
+        if ( ! $this->get_id() ) {
+            return;
+        }
+
+        if ( ! $this->data_store ) {
+            return;
+        }
+
+        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();
+        }
+
+        if ( ! $force_read ) {
+            if ( ! empty( $this->cache_group ) ) {
+                $cached_meta  = wp_cache_get( $cache_key, $this->cache_group );
+                $cache_loaded = ! empty( $cached_meta );
+            }
+        }
+
+        $raw_meta_data = $cache_loaded ? $cached_meta : $this->data_store->read_meta( $this );
+        if ( $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 ),
+                    )
+                );
+            }
+
+            if ( ! $cache_loaded && ! empty( $this->cache_group ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+        }
+    }
+
+    /**
+     * 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 ] = maybe_unserialize( $value );
-				}
-			} else {
-				$this->data[ $prop ] = maybe_unserialize( $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_recursive( $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.
-	 *
-	 * @throws Exception Data Exception.
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		throw new Exception( $message, $code );
-	}
+        $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 ] = maybe_unserialize( $value );
+                }
+            } else {
+                $this->data[ $prop ] = maybe_unserialize( $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_recursive( $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.
+     *
+     * @throws Exception Data Exception.
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        throw new Exception( $message, $code );
+    }
 
 }

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

Indentation +209 added lines, -209 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,228 +14,228 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
-					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
-					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item->get_id(), $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'     => $item->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_item',
+                    'post_status'   => $this->get_post_status( $item ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $item->get_author( 'edit' ),
+                    'post_title'    => $item->get_name( 'edit' ),
+                    'post_parent'   => 0,
+                    'post_excerpt'  => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            do_action( 'getpaid_new_item', $item->get_id(), $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
 		
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
-				'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item->get_id(), $item );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item->get_id(), $item );
-		} else {
-			do_action( 'getpaid_update_item', $item->get_id(), $item );
-		}
-
-	}
-
-	/*
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            $item->set_id( 0 );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
+                'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+        do_action( 'getpaid_read_item', $item->get_id(), $item );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $item->get_id() );
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $item->get_date_created( 'edit' ),
+                'post_status'       => $item->get_status( 'edit' ),
+                'post_parent'       => $item->get_parent_id( 'edit' ),
+                'post_excerpt'      => $item->get_description( 'edit' ),
+                'post_modified'     => $item->get_date_modified( 'edit' ),
+                'post_title'        => $item->get_name( 'edit' ),
+                'post_author'       => $item->get_author( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $item->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_item', $item->get_id(), $item );
+        } else {
+            do_action( 'getpaid_update_item', $item->get_id(), $item );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

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

Indentation +421 added lines, -421 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,490 +15,490 @@ 
  */
 class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_subscr_profile_id',
-		'_wpinv_taxes',
-		'_wpinv_fees',
-		'_wpinv_discounts',
-		'_wpinv_submission_id',
-		'_wpinv_payment_form',
-		'_wpinv_is_viewed',
-		'wpinv_email_cc',
-		'wpinv_template'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_subscr_profile_id' => 'subscription_id',
-		'_wpinv_taxes'             => 'taxes',
-		'_wpinv_fees'              => 'fees',
-		'_wpinv_discounts'         => 'discounts',
-		'_wpinv_submission_id'     => 'submission_id',
-		'_wpinv_payment_form'      => 'payment_form',
-		'_wpinv_is_viewed'         => 'is_viewed',
-		'wpinv_email_cc'           => 'email_cc',
-		'wpinv_template'           => 'template',
-	);
-
-	/**
-	 * A map of database fields to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $database_fields_to_props = array(
-		'post_id'            => 'id',
-		'number'             => 'number',
-		'currency'           => 'currency',
-		'key'                => 'key',
-		'type'               => 'type',
-		'mode'               => 'mode',
-		'user_ip'            => 'user_ip',
-		'first_name'         => 'first_name',
-		'last_name'          => 'last_name',
-		'address'            => 'address',
-		'city'               => 'city',
-		'state'              => 'state',
-		'country'            => 'country',
-		'zip'                => 'zip',
-		'zip'                => 'zip',
-		'adddress_confirmed' => 'address_confirmed',
-		'gateway'            => 'gateway',
-		'transaction_id'     => 'transaction_id',
-		'currency'           => 'currency',
-		'subtotal'           => 'subtotal',
-		'tax'                => 'total_tax',
-		'fees_total'         => 'total_fees',
-		'discount'           => 'total_discount',
-		'total'              => 'total',
-		'discount_code'      => 'discount_code',
-		'disable_taxes'      => 'disable_taxes',
-		'due_date'           => 'due_date',
-		'completed_date'     => 'completed_date',
-		'company'            => 'company',
-		'vat_number'         => 'vat_number',
-		'vat_rate'           => 'vat_rate',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_subscr_profile_id',
+        '_wpinv_taxes',
+        '_wpinv_fees',
+        '_wpinv_discounts',
+        '_wpinv_submission_id',
+        '_wpinv_payment_form',
+        '_wpinv_is_viewed',
+        'wpinv_email_cc',
+        'wpinv_template'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_subscr_profile_id' => 'subscription_id',
+        '_wpinv_taxes'             => 'taxes',
+        '_wpinv_fees'              => 'fees',
+        '_wpinv_discounts'         => 'discounts',
+        '_wpinv_submission_id'     => 'submission_id',
+        '_wpinv_payment_form'      => 'payment_form',
+        '_wpinv_is_viewed'         => 'is_viewed',
+        'wpinv_email_cc'           => 'email_cc',
+        'wpinv_template'           => 'template',
+    );
+
+    /**
+     * A map of database fields to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $database_fields_to_props = array(
+        'post_id'            => 'id',
+        'number'             => 'number',
+        'currency'           => 'currency',
+        'key'                => 'key',
+        'type'               => 'type',
+        'mode'               => 'mode',
+        'user_ip'            => 'user_ip',
+        'first_name'         => 'first_name',
+        'last_name'          => 'last_name',
+        'address'            => 'address',
+        'city'               => 'city',
+        'state'              => 'state',
+        'country'            => 'country',
+        'zip'                => 'zip',
+        'zip'                => 'zip',
+        'adddress_confirmed' => 'address_confirmed',
+        'gateway'            => 'gateway',
+        'transaction_id'     => 'transaction_id',
+        'currency'           => 'currency',
+        'subtotal'           => 'subtotal',
+        'tax'                => 'total_tax',
+        'fees_total'         => 'total_fees',
+        'discount'           => 'total_discount',
+        'total'              => 'total',
+        'discount_code'      => 'discount_code',
+        'disable_taxes'      => 'disable_taxes',
+        'due_date'           => 'due_date',
+        'completed_date'     => 'completed_date',
+        'company'            => 'company',
+        'vat_number'         => 'vat_number',
+        'vat_rate'           => 'vat_rate',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
-	/**
-	 * Method to create a new invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function create( &$invoice ) {
-		$invoice->set_version( WPINV_VERSION );
-		$invoice->set_date_created( current_time('mysql') );
-
-		// Ensure both the key and number are set.
-		$invoice->get_key();
-		$invoice->get_number();
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_invoice_data',
-				array(
-					'post_date'     => $invoice->get_date_created( 'edit' ),
-					'post_type'     => $invoice->get_post_type( 'edit' ),
-					'post_status'   => $this->get_post_status( $invoice ),
-					'ping_status'   => 'closed',
-					'post_author'   => $invoice->get_user_id( 'edit' ),
-					'post_title'    => $invoice->get_number( 'edit' ),
-					'post_excerpt'  => $invoice->get_description( 'edit' ),
-					'post_parent'   => $invoice->get_parent_id( 'edit' ),
-					'post_name'     => $invoice->get_path( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$invoice->set_id( $id );
-			getpaid_save_invoice_user_address( $invoice );
-			$this->save_special_fields( $invoice );
-			$this->save_items( $invoice );
-			$this->update_post_meta( $invoice );
-			$invoice->save_meta_data();
-			$invoice->apply_changes();
-			$this->clear_caches( $invoice );
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice->get_id(), $invoice );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$invoice->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read an invoice from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 *
-	 */
-	public function read( &$invoice ) {
-
-		$invoice->set_defaults();
-		$invoice_object = get_post( $invoice->get_id() );
-
-		if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
-			$invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
-			$invoice->set_id( 0 );
-			return false;
-		}
-
-		$invoice->set_props(
-			array(
-				'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
-				'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
-				'status'        => $invoice_object->post_status,
-				'author'        => $invoice_object->post_author,
-				'description'   => $invoice_object->post_excerpt,
-				'parent_id'     => $invoice_object->post_parent,
-				'name'          => $invoice_object->post_title,
-				'path'          => $invoice_object->post_name,
-				'post_type'     => $invoice_object->post_type,
-			)
-		);
-
-		$invoice->set_type( $invoice_object->post_type );
-
-		$this->read_object_data( $invoice, $invoice_object );
-		$this->add_special_fields( $invoice );
-		$this->add_items( $invoice );
-		$invoice->read_meta_data();
-		$invoice->set_object_read( true );
-		do_action( 'getpaid_read_' . $invoice->get_type(), $invoice->get_id(), $invoice );
-
-	}
-
-	/**
-	 * Method to update an invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function update( &$invoice ) {
-		$invoice->save_meta_data();
-		$invoice->set_version( WPINV_VERSION );
-
-		if ( null === $invoice->get_date_created( 'edit' ) ) {
-			$invoice->set_date_created(  current_time('mysql') );
-		}
-
-		// Ensure both the key and number are set.
-		$invoice->get_key();
-		$invoice->get_number();
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $invoice->get_id() );
-
-		$changes = $invoice->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $invoice->get_date_created( 'edit' ),
-				'post_status'       => $invoice->get_status( 'edit' ),
-				'post_title'        => $invoice->get_name( 'edit' ),
-				'post_author'       => $invoice->get_user_id( 'edit' ),
-				'post_modified'     => $invoice->get_date_modified( 'edit' ),
-				'post_excerpt'      => $invoice->get_description( 'edit' ),
-				'post_parent'       => $invoice->get_parent_id( 'edit' ),
-				'post_name'         => $invoice->get_path( 'edit' ),
-				'post_type'         => $invoice->get_post_type( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
-				clean_post_cache( $invoice->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
-			}
-			$invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $invoice );
-		$this->save_special_fields( $invoice );
-		$this->save_items( $invoice );
-		$invoice->apply_changes();
-		getpaid_save_invoice_user_address( $invoice );
-		$this->clear_caches( $invoice );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $invoice->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_' . $invoice->get_type(), $invoice->get_id(), $invoice );
-		} else {
-			do_action( 'getpaid_update_' . $invoice->get_type(), $invoice->get_id(), $invoice );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function create( &$invoice ) {
+        $invoice->set_version( WPINV_VERSION );
+        $invoice->set_date_created( current_time('mysql') );
+
+        // Ensure both the key and number are set.
+        $invoice->get_key();
+        $invoice->get_number();
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_invoice_data',
+                array(
+                    'post_date'     => $invoice->get_date_created( 'edit' ),
+                    'post_type'     => $invoice->get_post_type( 'edit' ),
+                    'post_status'   => $this->get_post_status( $invoice ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $invoice->get_user_id( 'edit' ),
+                    'post_title'    => $invoice->get_number( 'edit' ),
+                    'post_excerpt'  => $invoice->get_description( 'edit' ),
+                    'post_parent'   => $invoice->get_parent_id( 'edit' ),
+                    'post_name'     => $invoice->get_path( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $invoice->set_id( $id );
+            getpaid_save_invoice_user_address( $invoice );
+            $this->save_special_fields( $invoice );
+            $this->save_items( $invoice );
+            $this->update_post_meta( $invoice );
+            $invoice->save_meta_data();
+            $invoice->apply_changes();
+            $this->clear_caches( $invoice );
+            do_action( 'getpaid_new_' . $invoice->get_type(), $invoice->get_id(), $invoice );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $invoice->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read an invoice from the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     *
+     */
+    public function read( &$invoice ) {
+
+        $invoice->set_defaults();
+        $invoice_object = get_post( $invoice->get_id() );
+
+        if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
+            $invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
+            $invoice->set_id( 0 );
+            return false;
+        }
+
+        $invoice->set_props(
+            array(
+                'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
+                'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
+                'status'        => $invoice_object->post_status,
+                'author'        => $invoice_object->post_author,
+                'description'   => $invoice_object->post_excerpt,
+                'parent_id'     => $invoice_object->post_parent,
+                'name'          => $invoice_object->post_title,
+                'path'          => $invoice_object->post_name,
+                'post_type'     => $invoice_object->post_type,
+            )
+        );
+
+        $invoice->set_type( $invoice_object->post_type );
+
+        $this->read_object_data( $invoice, $invoice_object );
+        $this->add_special_fields( $invoice );
+        $this->add_items( $invoice );
+        $invoice->read_meta_data();
+        $invoice->set_object_read( true );
+        do_action( 'getpaid_read_' . $invoice->get_type(), $invoice->get_id(), $invoice );
+
+    }
+
+    /**
+     * Method to update an invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function update( &$invoice ) {
+        $invoice->save_meta_data();
+        $invoice->set_version( WPINV_VERSION );
+
+        if ( null === $invoice->get_date_created( 'edit' ) ) {
+            $invoice->set_date_created(  current_time('mysql') );
+        }
+
+        // Ensure both the key and number are set.
+        $invoice->get_key();
+        $invoice->get_number();
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $invoice->get_id() );
+
+        $changes = $invoice->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $invoice->get_date_created( 'edit' ),
+                'post_status'       => $invoice->get_status( 'edit' ),
+                'post_title'        => $invoice->get_name( 'edit' ),
+                'post_author'       => $invoice->get_user_id( 'edit' ),
+                'post_modified'     => $invoice->get_date_modified( 'edit' ),
+                'post_excerpt'      => $invoice->get_description( 'edit' ),
+                'post_parent'       => $invoice->get_parent_id( 'edit' ),
+                'post_name'         => $invoice->get_path( 'edit' ),
+                'post_type'         => $invoice->get_post_type( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
+                clean_post_cache( $invoice->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
+            }
+            $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $invoice );
+        $this->save_special_fields( $invoice );
+        $this->save_items( $invoice );
+        $invoice->apply_changes();
+        getpaid_save_invoice_user_address( $invoice );
+        $this->clear_caches( $invoice );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $invoice->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_' . $invoice->get_type(), $invoice->get_id(), $invoice );
+        } else {
+            do_action( 'getpaid_update_' . $invoice->get_type(), $invoice->get_id(), $invoice );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
+    /**
      * Retrieves special fields and adds to the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_special_fields( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        // Maybe retrieve from the cache.
+        $data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
 
-		// If not found, retrieve from the db.
-		if ( false === $data ) {
-			$table =  $wpdb->prefix . 'getpaid_invoices';
+        // If not found, retrieve from the db.
+        if ( false === $data ) {
+            $table =  $wpdb->prefix . 'getpaid_invoices';
 
-			$data  = $wpdb->get_row(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
-				ARRAY_A
-			);
+            $data  = $wpdb->get_row(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
+                ARRAY_A
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
 
-		}
+        }
 
-		// Abort if the data does not exist.
-		if ( empty( $data ) ) {
-			return;
-		}
+        // Abort if the data does not exist.
+        if ( empty( $data ) ) {
+            return;
+        }
 
-		$props = array();
+        $props = array();
 
-		foreach ( $this->database_fields_to_props as $db_field => $prop ) {
+        foreach ( $this->database_fields_to_props as $db_field => $prop ) {
 			
-			if ( $db_field == 'post_id' ) {
-				continue;
-			}
-
-			$props[ $prop ] = $data[ $db_field ];
-		}
-
-		$invoice->set_props( $props );
-
-	}
-
-	/**
-	 * Gets a list of special fields that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  WPInv_Invoice $invoice       The Invoice object.
-	 * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_special_fields_to_update( $invoice ) {
-		$fields_to_update = array();
-		$changed_props   = $invoice->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) ) {
-				$fields_to_update[ $database_field ] = $prop;
-			}
-		}
-
-		return $fields_to_update;
-	}
-
-	/**
-	 * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function update_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props    = array();
-		$fields_to_update = $this->get_special_fields_to_update( $invoice );
-
-		foreach ( $fields_to_update as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		if ( ! empty( $updated_props ) ) {
-
-			$table = $wpdb->prefix . 'getpaid_invoices';
-			$wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
-			wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-			do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
-
-		}
-
-	}
-
-	/**
-	 * Helper method that inserts special fields to the database.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function insert_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props   = array();
-
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$wpdb->insert( $table, $updated_props );
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-		do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
-
-	}
-
-	/**
+            if ( $db_field == 'post_id' ) {
+                continue;
+            }
+
+            $props[ $prop ] = $data[ $db_field ];
+        }
+
+        $invoice->set_props( $props );
+
+    }
+
+    /**
+     * Gets a list of special fields that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  WPInv_Invoice $invoice       The Invoice object.
+     * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_special_fields_to_update( $invoice ) {
+        $fields_to_update = array();
+        $changed_props   = $invoice->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) ) {
+                $fields_to_update[ $database_field ] = $prop;
+            }
+        }
+
+        return $fields_to_update;
+    }
+
+    /**
+     * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function update_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props    = array();
+        $fields_to_update = $this->get_special_fields_to_update( $invoice );
+
+        foreach ( $fields_to_update as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        if ( ! empty( $updated_props ) ) {
+
+            $table = $wpdb->prefix . 'getpaid_invoices';
+            $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
+            wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+            do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
+
+        }
+
+    }
+
+    /**
+     * Helper method that inserts special fields to the database.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function insert_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props   = array();
+
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $wpdb->insert( $table, $updated_props );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
+
+    }
+
+    /**
      * Saves all special fields.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_special_fields( $invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// The invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$id    = (int) $invoice->get_id();
+        // The invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $id    = (int) $invoice->get_id();
 
-		if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
+        if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
 
-			$this->update_special_fields( $invoice );
+            $this->update_special_fields( $invoice );
 
-		} else {
+        } else {
 
-			$this->insert_special_fields( $invoice );
+            $this->insert_special_fields( $invoice );
 
-		}
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Set's up cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_items( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        // Maybe retrieve from the cache.
+        $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
 
-		// If not found, retrieve from the db.
-		if ( false === $items ) {
-			$table =  $wpdb->prefix . 'getpaid_invoice_items';
+        // If not found, retrieve from the db.
+        if ( false === $items ) {
+            $table =  $wpdb->prefix . 'getpaid_invoice_items';
 
-			$items = $wpdb->get_results(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
-			);
+            $items = $wpdb->get_results(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
 
-		}
+        }
 
-		// Abort if no items found.
+        // Abort if no items found.
         if ( empty( $items ) ) {
             return;
-		}
+        }
 
-		foreach ( $items as $item_data ) {
-			$item = new GetPaid_Form_Item( $item_data->item_id );
+        foreach ( $items as $item_data ) {
+            $item = new GetPaid_Form_Item( $item_data->item_id );
 
-			// Set item data.
-			$item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
-			$item->item_discount = wpinv_sanitize_amount( $item_data->discount );
-			$item->set_name( $item_data->item_name );
-			$item->set_description( $item_data->item_description );
-			$item->set_price( $item_data->item_price );
-			$item->set_quantity( $item_data->quantity );
-			$item->set_item_meta( $item_data->meta );
+            // Set item data.
+            $item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
+            $item->item_discount = wpinv_sanitize_amount( $item_data->discount );
+            $item->set_name( $item_data->item_name );
+            $item->set_description( $item_data->item_description );
+            $item->set_price( $item_data->item_price );
+            $item->set_quantity( $item_data->quantity );
+            $item->set_item_meta( $item_data->meta );
 
-			$invoice->add_item( $item );
-		}
+            $invoice->add_item( $item );
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Saves cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_items( $invoice ) {
 
-		// Delete previously existing items.
-		$this->delete_items( $invoice );
+        // Delete previously existing items.
+        $this->delete_items( $invoice );
 
-		$table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        $table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
 
-		foreach ( $invoice->get_cart_details() as $item_data ) {
-			$item_data = array_map( 'maybe_serialize', $item_data );
-			$GLOBALS['wpdb']->insert( $table, $item_data );
-		}
+        foreach ( $invoice->get_cart_details() as $item_data ) {
+            $item_data = array_map( 'maybe_serialize', $item_data );
+            $GLOBALS['wpdb']->insert( $table, $item_data );
+        }
 
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
-		do_action( "getpaid_invoice_save_items", $invoice );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        do_action( "getpaid_invoice_save_items", $invoice );
 
-	}
+    }
 
-	/**
+    /**
      * Deletes an invoice's cart details from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_items( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 	
-	/**
+    /**
      * Deletes an invoice's special fields from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_special_fields( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
     }
 
 }

includes/wpinv-user-functions.php

Indentation +19 added lines, -19 removed lines

@@ -159,11 +159,11 @@ 
  */
 function wpinv_get_capability( $capalibilty = 'manage_invoicing' ) {
 
-	if ( current_user_can( 'manage_options' ) ) {
-		return 'manage_options';
-	};
+    if ( current_user_can( 'manage_options' ) ) {
+        return 'manage_options';
+    };
 
-	return $capalibilty;
+    return $capalibilty;
 }
 
 /**
@@ -185,10 +185,10 @@ 
 function wpinv_create_user( $email ) {
 
     // Prepare user values.
-	$args = array(
-		'user_login' => wpinv_generate_user_name( $email ),
-		'user_pass'  => wp_generate_password(),
-		'user_email' => $email,
+    $args = array(
+        'user_login' => wpinv_generate_user_name( $email ),
+        'user_pass'  => wp_generate_password(),
+        'user_email' => $email,
         'role'       => 'subscriber',
     );
 
@@ -205,20 +205,20 @@ 
 function wpinv_generate_user_name( $prefix = '' ) {
 
     // If prefix is an email, retrieve the part before the email.
-	$prefix = strtok( $prefix, '@' );
+    $prefix = strtok( $prefix, '@' );
 
-	// Trim to 4 characters max.
-	$prefix = sanitize_user( $prefix );
+    // Trim to 4 characters max.
+    $prefix = sanitize_user( $prefix );
 
-	$illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
-	if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) {
-		$prefix = 'gtp';
-	}
+    $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
+    if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) {
+        $prefix = 'gtp';
+    }
 
-	$username = $prefix . '_' . zeroise( wp_rand( 0, 9999 ), 4 );
-	if ( username_exists( $username ) ) {
-		return wpinv_generate_user_name( $username );
-	}
+    $username = $prefix . '_' . zeroise( wp_rand( 0, 9999 ), 4 );
+    if ( username_exists( $username ) ) {
+        return wpinv_generate_user_name( $username );
+    }
 
     return $username;
 }

includes/class-wpinv.php

Indentation +56 added lines, -56 removed lines

@@ -161,10 +161,10 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-error-functions.php' );
 
         // Register autoloader.
-		try {
-			spl_autoload_register( array( $this, 'autoload' ), true );
-		} catch ( Exception $e ) {
-			wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
+        try {
+            spl_autoload_register( array( $this, 'autoload' ), true );
+        } catch ( Exception $e ) {
+            wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
         }
 
         require_once( WPINV_PLUGIN_DIR . 'includes/class-getpaid-post-types.php' );
@@ -189,11 +189,11 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' );
         require_once( WPINV_PLUGIN_DIR . 'widgets/buy-item.php' );
         require_once( WPINV_PLUGIN_DIR . 'widgets/getpaid.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-payment-form-elements.php' );
@@ -253,47 +253,47 @@ 
     }
 
     /**
-	 * Class autoloader
-	 *
-	 * @param       string $class_name The name of the class to load.
-	 * @access      public
-	 * @since       1.0.19
-	 * @return      void
-	 */
-	public function autoload( $class_name ) {
-
-		// Normalize the class name...
-		$class_name  = strtolower( $class_name );
-
-		// ... and make sure it is our class.
-		if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
-			return;
-		}
-
-		// Next, prepare the file name from the class.
-		$file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
-
-		// And an array of possible locations in order of importance.
-		$locations = array(
-			'includes',
-			'includes/data-stores',
+     * Class autoloader
+     *
+     * @param       string $class_name The name of the class to load.
+     * @access      public
+     * @since       1.0.19
+     * @return      void
+     */
+    public function autoload( $class_name ) {
+
+        // Normalize the class name...
+        $class_name  = strtolower( $class_name );
+
+        // ... and make sure it is our class.
+        if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
+            return;
+        }
+
+        // Next, prepare the file name from the class.
+        $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
+
+        // And an array of possible locations in order of importance.
+        $locations = array(
+            'includes',
+            'includes/data-stores',
             'includes/admin',
             'includes/admin/meta-boxes'
-		);
+        );
 
-		// Base path of the classes.
-		$plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
+        // Base path of the classes.
+        $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
 
-		foreach ( $locations as $location ) {
+        foreach ( $locations as $location ) {
 
-			if ( file_exists( "$plugin_path/$location/$file_name" ) ) {
-				include "$plugin_path/$location/$file_name";
-				break;
-			}
+            if ( file_exists( "$plugin_path/$location/$file_name" ) ) {
+                include "$plugin_path/$location/$file_name";
+                break;
+            }
 
-		}
+        }
 
-	}
+    }
 
     public function init() {
     }
@@ -386,7 +386,7 @@ 
             wp_register_style( 'jquery-ui-css', WPINV_PLUGIN_URL . 'assets/css/jquery-ui' . $suffix . '.css', array(), '1.8.16' );
             wp_enqueue_style( 'jquery-ui-css' );
             wp_deregister_style( 'yoast-seo-select2' );
-	        wp_deregister_style( 'yoast-seo-monorepo' );
+            wp_deregister_style( 'yoast-seo-monorepo' );
         }
 
         wp_register_style( 'wpinv_meta_box_style', WPINV_PLUGIN_URL . 'assets/css/meta-box.css', array(), WPINV_VERSION );
@@ -400,7 +400,7 @@ 
         if ( $page == 'wpinv-subscriptions' ) {
             wp_enqueue_script( 'jquery-ui-datepicker' );
             wp_deregister_style( 'yoast-seo-select2' );
-	        wp_deregister_style( 'yoast-seo-monorepo' );
+            wp_deregister_style( 'yoast-seo-monorepo' );
         }
         
         if ( $enqueue_datepicker = apply_filters( 'wpinv_admin_enqueue_jquery_ui_datepicker', $enqueue ) ) {
@@ -569,19 +569,19 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-bp-core.php' );
     }
 
-	/**
-	 * Register widgets
-	 *
-	 */
-	public function register_widgets() {
-		register_widget( "WPInv_Checkout_Widget" );
-		register_widget( "WPInv_History_Widget" );
-		register_widget( "WPInv_Receipt_Widget" );
-		register_widget( "WPInv_Subscriptions_Widget" );
-		register_widget( "WPInv_Buy_Item_Widget" );
+    /**
+     * Register widgets
+     *
+     */
+    public function register_widgets() {
+        register_widget( "WPInv_Checkout_Widget" );
+        register_widget( "WPInv_History_Widget" );
+        register_widget( "WPInv_Receipt_Widget" );
+        register_widget( "WPInv_Subscriptions_Widget" );
+        register_widget( "WPInv_Buy_Item_Widget" );
         register_widget( "WPInv_Messages_Widget" );
         register_widget( 'WPInv_GetPaid_Widget' );
-	}
+    }
     
     /**
      * Remove our pages from yoast sitemaps.