AyeCode / invoicing

includes/wpinv-subscription.php

Indentation +1003 added lines, -1003 removed lines

@@ -15,125 +15,125 @@ 
  */
 class WPInv_Subscription extends GetPaid_Data {
 
-	/**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
-	protected $data_store_name = 'subscription';
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'subscription';
-
-	/**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'customer_id'       => 0,
-		'frequency'         => 1,
-		'period'            => 'D',
-		'initial_amount'    => null,
-		'recurring_amount'  => null,
-		'bill_times'        => 0,
-		'transaction_id'    => '',
-		'parent_payment_id' => null,
-		'product_id'        => 0,
-		'created'           => '0000-00-00 00:00:00',
-		'expiration'        => '0000-00-00 00:00:00',
-		'trial_period'      => '',
-		'status'            => 'pending',
-		'profile_id'        => '',
-		'gateway'           => '',
-		'customer'          => '',
-	);
-
-	/**
-	 * Stores the status transition information.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $status_transition = false;
-
-	/**
-	 * Get the subscription if ID is passed, otherwise the subscription is new and empty.
-	 *
-	 * @param  int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read.
-	 * @param  bool $deprecated
-	 */
-	function __construct( $subscription = 0, $deprecated = false ) {
-
-		parent::__construct( $subscription );
-
-		if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) {
-			$this->set_id( $subscription );
-		} elseif ( $subscription instanceof self ) {
-			$this->set_id( $subscription->get_id() );
-		} elseif ( ! empty( $subscription->id ) ) {
-			$this->set_id( $subscription->id );
-		} elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
-			$this->set_id( $subscription_id );
-		} else {
-			$this->set_object_read( true );
-		}
-
-		// Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
-
-		if ( $this->get_id() > 0 ) {
-			$this->data_store->read( $this );
-		}
-
-	}
-
-	/**
-	 * Given an invoice id, profile id, transaction id, it returns the subscription's id.
-	 *
-	 *
-	 * @static
-	 * @param string $value
-	 * @param string $field Either invoice_id, transaction_id or profile_id.
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) {
+    /**
+     * Which data store to load.
+     *
+     * @var string
+     */
+    protected $data_store_name = 'subscription';
+
+    /**
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'subscription';
+
+    /**
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'customer_id'       => 0,
+        'frequency'         => 1,
+        'period'            => 'D',
+        'initial_amount'    => null,
+        'recurring_amount'  => null,
+        'bill_times'        => 0,
+        'transaction_id'    => '',
+        'parent_payment_id' => null,
+        'product_id'        => 0,
+        'created'           => '0000-00-00 00:00:00',
+        'expiration'        => '0000-00-00 00:00:00',
+        'trial_period'      => '',
+        'status'            => 'pending',
+        'profile_id'        => '',
+        'gateway'           => '',
+        'customer'          => '',
+    );
+
+    /**
+     * Stores the status transition information.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $status_transition = false;
+
+    /**
+     * Get the subscription if ID is passed, otherwise the subscription is new and empty.
+     *
+     * @param  int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read.
+     * @param  bool $deprecated
+     */
+    function __construct( $subscription = 0, $deprecated = false ) {
+
+        parent::__construct( $subscription );
+
+        if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) {
+            $this->set_id( $subscription );
+        } elseif ( $subscription instanceof self ) {
+            $this->set_id( $subscription->get_id() );
+        } elseif ( ! empty( $subscription->id ) ) {
+            $this->set_id( $subscription->id );
+        } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
+            $this->set_id( $subscription_id );
+        } else {
+            $this->set_object_read( true );
+        }
+
+        // Load the datastore.
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+
+        if ( $this->get_id() > 0 ) {
+            $this->data_store->read( $this );
+        }
+
+    }
+
+    /**
+     * Given an invoice id, profile id, transaction id, it returns the subscription's id.
+     *
+     *
+     * @static
+     * @param string $value
+     * @param string $field Either invoice_id, transaction_id or profile_id.
+     * @since 1.0.19
+     * @return int
+     */
+    public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) {
         global $wpdb;
 
-		// Trim the value.
-		$value = trim( $value );
+        // Trim the value.
+        $value = trim( $value );
 
-		if ( empty( $value ) ) {
-			return 0;
-		}
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
-		if ( 'invoice_id' == $field ) {
-			$field = 'parent_payment_id';
-		}
+        if ( 'invoice_id' == $field ) {
+            $field = 'parent_payment_id';
+        }
 
         // Valid fields.
         $fields = array(
-			'parent_payment_id',
-			'transaction_id',
-			'profile_id'
-		);
-
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		// Maybe retrieve from the cache.
-		$subscription_id   = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" );
-		if ( ! empty( $subscription_id ) ) {
-			return $subscription_id;
-		}
+            'parent_payment_id',
+            'transaction_id',
+            'profile_id'
+        );
+
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        // Maybe retrieve from the cache.
+        $subscription_id   = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" );
+        if ( ! empty( $subscription_id ) ) {
+            return $subscription_id;
+        }
 
         // Fetch from the db.
         $table            = $wpdb->prefix . 'wpinv_subscriptions';
@@ -141,34 +141,34 @@ 
             $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value )
         );
 
-		if ( empty( $subscription_id ) ) {
-			return 0;
-		}
+        if ( empty( $subscription_id ) ) {
+            return 0;
+        }
 
-		// Update the cache with our data.
-		wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" );
+        // Update the cache with our data.
+        wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" );
 
-		return $subscription_id;
-	}
+        return $subscription_id;
+    }
 
-	/**
+    /**
      * Clears the subscription's cache.
      */
     public function clear_cache() {
-		wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' );
-		wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' );
-	}
+        wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' );
+        wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' );
+    }
 
-	/**
+    /**
      * Checks if a subscription key is set.
      */
     public function _isset( $key ) {
         return isset( $this->data[$key] ) || method_exists( $this, "get_$key" );
-	}
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD methods
 	|--------------------------------------------------------------------------
@@ -177,545 +177,545 @@ 
 	|
     */
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Getters
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Get customer id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'customer_id', $context );
-	}
-
-	/**
-	 * Get customer information.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WP_User|false WP_User object on success, false on failure.
-	 */
-	public function get_customer( $context = 'view' ) {
-		return get_userdata( $this->get_customer_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_invoice_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_payment_id', $context );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice_id().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
+    /**
+     * Get customer id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'customer_id', $context );
+    }
+
+    /**
+     * Get customer information.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WP_User|false WP_User object on success, false on failure.
+     */
+    public function get_customer( $context = 'view' ) {
+        return get_userdata( $this->get_customer_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_invoice_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_payment_id', $context );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
     public function get_parent_payment_id( $context = 'view' ) {
         return $this->get_parent_invoice_id( $context );
-	}
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_original_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Get parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_invoice( $context = 'view' ) {
+        return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_payment( $context = 'view' ) {
+        return $this->get_parent_invoice( $context );
+    }
+
+    /**
+     * Get subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_product_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'product_id', $context );
+    }
+
+    /**
+     * Get the subscription product.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Item
+     */
+    public function get_product( $context = 'view' ) {
+        return new WPInv_Item( $this->get_product_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice's gateway.
+     *
+     * Here for backwards compatibility.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gateway( $context = 'view' ) {
+        return $this->get_parent_invoice( $context )->get_gateway();
+    }
+
+    /**
+     * Get the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_period( $context = 'view' ) {
+        return $this->get_prop( 'period', $context );
+    }
+
+    /**
+     * Get number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_frequency( $context = 'view' ) {
+        return (int) $this->get_prop( 'frequency', $context );
+    }
+
+    /**
+     * Get the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
+    }
+
+    /**
+     * Get the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
+    }
+
+    /**
+     * Get number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_bill_times( $context = 'view' ) {
+        return (int) $this->get_prop( 'bill_times', $context );
+    }
+
+    /**
+     * Get transaction id of this subscription's parent invoice.
+     *
+     * @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 date that the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_created( $context = 'view' ) {
+        return $this->get_prop( 'created', $context );
+    }
+
+    /**
+     * Alias for self::get_created().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_created( $context );
+    }
+
+    /**
+     * Retrieves the creation date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_time_created() {
+        $created = $this->get_date_created();
+        return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get GMT date when the subscription 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;
+    }
+
+    /**
+     * Get the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date( $context = 'view' ) {
+        return $this->get_prop( 'expiration', $context );
+    }
+
+    /**
+     * Alias for self::get_next_renewal_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration( $context = 'view' ) {
+        return $this->get_next_renewal_date( $context );
+    }
+
+    /**
+     * Retrieves the expiration date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_expiration_time() {
+        $expiration = $this->get_expiration();
+
+        if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
+            return current_time( 'timestamp' );
+        }
+
+        $expiration = strtotime( $expiration, current_time( 'timestamp' ) );
+        return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
+    }
+
+    /**
+     * Get GMT date when the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date_gmt( $context = 'view' ) {
+        $date = $this->get_next_renewal_date( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_trial_period( $context = 'view' ) {
+        return $this->get_prop( 'trial_period', $context );
+    }
+
+    /**
+     * Get the subscription's 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 the subscription's profile id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_profile_id( $context = 'view' ) {
+        return $this->get_prop( 'profile_id', $context );
+    }
+
+    /*
+	|--------------------------------------------------------------------------
+	| Setters
+	|--------------------------------------------------------------------------
+	*/
+
+    /**
+     * Set customer id.
+     *
+     * @since 1.0.19
+     * @param  int $value The customer's id.
+     */
+    public function set_customer_id( $value ) {
+        $this->set_prop( 'customer_id', (int) $value );
+    }
+
+    /**
+     * Set parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_invoice_id( $value ) {
+        $this->set_prop( 'parent_payment_id', (int) $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_original_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Set subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription product id.
+     */
+    public function set_product_id( $value ) {
+        $this->set_prop( 'product_id', (int) $value );
+    }
+
+    /**
+     * Set the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $value The renewal period.
+     */
+    public function set_period( $value ) {
+        $this->set_prop( 'period', $value );
+    }
+
+    /**
+     * Set number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription frequency.
+     */
+    public function set_frequency( $value ) {
+        $value = empty( $value ) ? 1 : (int) $value;
+        $this->set_prop( 'frequency', absint( $value ) );
+    }
+
+    /**
+     * Set the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The initial subcription amount.
+     */
+    public function set_initial_amount( $value ) {
+        $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The recurring subcription amount.
+     */
+    public function set_recurring_amount( $value ) {
+        $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  int $value Bill times.
+     */
+    public function set_bill_times( $value ) {
+        $this->set_prop( 'bill_times', (int) $value );
+    }
 
-	/**
-     * Alias for self::get_parent_invoice_id().
+    /**
+     * Get transaction id of this subscription's parent invoice.
      *
-     * @since  1.0.0
-     * @return int
+     * @since 1.0.19
+     * @param string $value Bill times.
      */
-    public function get_original_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
+    public function set_transaction_id( $value ) {
+        $this->set_prop( 'transaction_id', sanitize_text_field( $value ) );
     }
 
-	/**
-	 * Get parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-	public function get_parent_invoice( $context = 'view' ) {
-		return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-    public function get_parent_payment( $context = 'view' ) {
-        return $this->get_parent_invoice( $context );
-	}
-
-	/**
-	 * Get subscription's product id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_product_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'product_id', $context );
-	}
-
-	/**
-	 * Get the subscription product.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Item
-	 */
-	public function get_product( $context = 'view' ) {
-		return new WPInv_Item( $this->get_product_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice's gateway.
-	 *
-	 * Here for backwards compatibility.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gateway( $context = 'view' ) {
-		return $this->get_parent_invoice( $context )->get_gateway();
-	}
-
-	/**
-	 * Get the period of a renewal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_period( $context = 'view' ) {
-		return $this->get_prop( 'period', $context );
-	}
-
-	/**
-	 * Get number of periods each renewal is valid for.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_frequency( $context = 'view' ) {
-		return (int) $this->get_prop( 'frequency', $context );
-	}
-
-	/**
-	 * Get the initial amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
-	}
-
-	/**
-	 * Get the recurring amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
-	}
-
-	/**
-	 * Get number of times that this subscription can be renewed.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_bill_times( $context = 'view' ) {
-		return (int) $this->get_prop( 'bill_times', $context );
-	}
-
-	/**
-	 * Get transaction id of this subscription's parent invoice.
-	 *
-	 * @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 date that the subscription was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_created( $context = 'view' ) {
-		return $this->get_prop( 'created', $context );
-	}
-
-	/**
-	 * Alias for self::get_created().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_created( $context );
-	}
-
-	/**
-	 * Retrieves the creation date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_time_created() {
-		$created = $this->get_date_created();
-		return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
-	}
-
-	/**
-	 * Get GMT date when the subscription 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 );
+    /**
+     * Set date when this subscription started.
+     *
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
+     */
+    public function set_created( $value ) {
+        $date = strtotime( $value );
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
+        if ( $date && $value !== '0000-00-00 00:00:00' ) {
+            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+            return;
         }
-		return $date;
-	}
-
-	/**
-	 * Get the date that the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_next_renewal_date( $context = 'view' ) {
-		return $this->get_prop( 'expiration', $context );
-	}
-
-	/**
-	 * Alias for self::get_next_renewal_date().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_expiration( $context = 'view' ) {
-		return $this->get_next_renewal_date( $context );
-	}
-
-	/**
-	 * Retrieves the expiration date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_expiration_time() {
-		$expiration = $this->get_expiration();
-
-		if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
-			return current_time( 'timestamp' );
-		}
-
-		$expiration = strtotime( $expiration, current_time( 'timestamp' ) );
-		return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
-	}
-
-	/**
-	 * Get GMT date when the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_next_renewal_date_gmt( $context = 'view' ) {
-        $date = $this->get_next_renewal_date( $context );
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
-        }
-		return $date;
-	}
-
-	/**
-	 * Get the subscription's trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_trial_period( $context = 'view' ) {
-		return $this->get_prop( 'trial_period', $context );
-	}
-
-	/**
-	 * Get the subscription's 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 the subscription's profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_profile_id( $context = 'view' ) {
-		return $this->get_prop( 'profile_id', $context );
-	}
-
-	/*
-	|--------------------------------------------------------------------------
-	| Setters
-	|--------------------------------------------------------------------------
-	*/
+        $this->set_prop( 'created', '' );
 
-	/**
-	 * Set customer id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The customer's id.
-	 */
-	public function set_customer_id( $value ) {
-		$this->set_prop( 'customer_id', (int) $value );
-	}
-
-	/**
-	 * Set parent invoice id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The parent invoice id.
-	 */
-	public function set_parent_invoice_id( $value ) {
-		$this->set_prop( 'parent_payment_id', (int) $value );
-	}
-
-	/**
-	 * Alias for self::set_parent_invoice_id().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The parent invoice id.
-	 */
-    public function set_parent_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
-	}
+    }
 
-	/**
-     * Alias for self::set_parent_invoice_id().
+    /**
+     * Alias for self::set_created().
      *
      * @since 1.0.19
-	 * @param  int $value The parent invoice id.
+     * @param string $value strtotime compliant date.
      */
-    public function set_original_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
-	}
-
-	/**
-	 * Set subscription's product id.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The subscription product id.
-	 */
-	public function set_product_id( $value ) {
-		$this->set_prop( 'product_id', (int) $value );
-	}
-
-	/**
-	 * Set the period of a renewal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value The renewal period.
-	 */
-	public function set_period( $value ) {
-		$this->set_prop( 'period', $value );
-	}
-
-	/**
-	 * Set number of periods each renewal is valid for.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value The subscription frequency.
-	 */
-	public function set_frequency( $value ) {
-		$value = empty( $value ) ? 1 : (int) $value;
-		$this->set_prop( 'frequency', absint( $value ) );
-	}
-
-	/**
-	 * Set the initial amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value The initial subcription amount.
-	 */
-	public function set_initial_amount( $value ) {
-		$this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Set the recurring amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value The recurring subcription amount.
-	 */
-	public function set_recurring_amount( $value ) {
-		$this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
-	}
-
-	/**
-	 * Set number of times that this subscription can be renewed.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value Bill times.
-	 */
-	public function set_bill_times( $value ) {
-		$this->set_prop( 'bill_times', (int) $value );
-	}
-
-	/**
-	 * Get transaction id of this subscription's parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Bill times.
-	 */
-	public function set_transaction_id( $value ) {
-		$this->set_prop( 'transaction_id', sanitize_text_field( $value ) );
-	}
-
-	/**
-	 * Set date when this subscription started.
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_created( $value ) {
+    public function set_date_created( $value ) {
+        $this->set_created( $value );
+    }
+
+    /**
+     * Set the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
+     */
+    public function set_next_renewal_date( $value ) {
         $date = strtotime( $value );
 
         if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
             return;
         }
 
-		$this->set_prop( 'created', '' );
+        $this->set_prop( 'expiration', '' );
 
-	}
+    }
+
+    /**
+     * Alias for self::set_next_renewal_date().
+     *
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
+     */
+    public function set_expiration( $value ) {
+        $this->set_next_renewal_date( $value );
+    }
 
-	/**
-	 * Alias for self::set_created().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_date_created( $value ) {
-		$this->set_created( $value );
+    /**
+     * Set the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param string $value trial period e.g 1 year.
+     */
+    public function set_trial_period( $value ) {
+        $this->set_prop( 'trial_period', $value );
     }
 
-	/**
-	 * Set the date that the subscription will renew.
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_next_renewal_date( $value ) {
-		$date = strtotime( $value );
+    /**
+     * Set the subscription's status.
+     *
+     * @since 1.0.19
+     * @param string $new_status    New subscription status.
+     */
+    public function set_status( $new_status ) {
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
+        // Abort if this is not a valid status;
+        if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) {
             return;
-		}
-
-		$this->set_prop( 'expiration', '' );
-
-	}
-
-	/**
-	 * Alias for self::set_next_renewal_date().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_expiration( $value ) {
-		$this->set_next_renewal_date( $value );
-    }
-
-	/**
-	 * Set the subscription's trial period.
-	 *
-	 * @since 1.0.19
-	 * @param string $value trial period e.g 1 year.
-	 */
-	public function set_trial_period( $value ) {
-		$this->set_prop( 'trial_period', $value );
-	}
-
-	/**
-	 * Set the subscription's status.
-	 *
-	 * @since 1.0.19
-	 * @param string $new_status    New subscription status.
-	 */
-	public function set_status( $new_status ) {
-
-		// Abort if this is not a valid status;
-		if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) {
-			return;
-		}
-
-		$old_status = $this->get_status();
-		$this->set_prop( 'status', $new_status );
-
-		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,
-			);
-		}
-
-	}
-
-	/**
-	 * Set the subscription's (remote) profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value the remote profile id.
-	 */
-	public function set_profile_id( $value ) {
-		$this->set_prop( 'profile_id', sanitize_text_field( $value ) );
-	}
-
-	/*
+        }
+
+        $old_status = $this->get_status();
+        $this->set_prop( 'status', $new_status );
+
+        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,
+            );
+        }
+
+    }
+
+    /**
+     * Set the subscription's (remote) profile id.
+     *
+     * @since 1.0.19
+     * @param  string $value the remote profile id.
+     */
+    public function set_profile_id( $value ) {
+        $this->set_prop( 'profile_id', sanitize_text_field( $value ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Boolean methods
 	|--------------------------------------------------------------------------
@@ -724,55 +724,55 @@ 
 	|
 	*/
 
-	/**
+    /**
      * Checks if the subscription has a given status.
-	 *
-	 * @param string|array String or array of strings to check for.
-	 * @return bool
+     *
+     * @param string|array String or array of strings to check for.
+     * @return bool
      */
     public function has_status( $status ) {
         return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) );
-	}
+    }
 
-	/**
+    /**
      * Checks if the subscription has a trial period.
-	 *
-	 * @return bool
+     *
+     * @return bool
      */
     public function has_trial_period() {
-		$period = $this->get_trial_period();
+        $period = $this->get_trial_period();
         return ! empty( $period );
-	}
-
-	/**
-	 * Is the subscription active?
-	 *
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->has_status( 'active trialling' ) && ! $this->is_expired();
-	}
-
-	/**
-	 * Is the subscription expired?
-	 *
-	 * @return bool
-	 */
-	public function is_expired() {
-		return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
-	}
-
-	/**
-	 * Is this the last renewals?
-	 *
-	 * @return bool
-	 */
-	public function is_last_renewal() {
-		$max_bills = $this->get_bill_times();
-		return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
-	}
-
-	/*
+    }
+
+    /**
+     * Is the subscription active?
+     *
+     * @return bool
+     */
+    public function is_active() {
+        return $this->has_status( 'active trialling' ) && ! $this->is_expired();
+    }
+
+    /**
+     * Is the subscription expired?
+     *
+     * @return bool
+     */
+    public function is_expired() {
+        return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
+    }
+
+    /**
+     * Is this the last renewals?
+     *
+     * @return bool
+     */
+    public function is_last_renewal() {
+        $max_bills = $this->get_bill_times();
+        return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional methods
 	|--------------------------------------------------------------------------
@@ -781,27 +781,27 @@ 
 	|
 	*/
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function create( $data = array() ) {
+    /**
+     * Backwards compatibilty.
+     */
+    public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
-	}
+    }
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function update( $args = array() ) {
-		return $this->create( $args );
-	}
+    /**
+     * Backwards compatibilty.
+     */
+    public function update( $args = array() ) {
+        return $this->create( $args );
+    }
 
     /**
      * Retrieve renewal payments for a subscription
@@ -811,22 +811,22 @@ 
      */
     public function get_child_payments( $hide_pending = true ) {
 
-		$statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
+        $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
 
-		if ( ! $hide_pending ) {
-			$statuses = array_keys( wpinv_get_invoice_statuses() );
-		}
+        if ( ! $hide_pending ) {
+            $statuses = array_keys( wpinv_get_invoice_statuses() );
+        }
 
         return get_posts(
-			array(
-            	'post_parent'    => $this->get_parent_payment_id(),
-            	'numberposts'    => -1,
-            	'post_status'    => $statuses,
-            	'orderby'        => 'ID',
-            	'order'          => 'DESC',
-            	'post_type'      => 'wpi_invoice'
-			)
-		);
+            array(
+                'post_parent'    => $this->get_parent_payment_id(),
+                'numberposts'    => -1,
+                'post_status'    => $statuses,
+                'orderby'        => 'ID',
+                'order'          => 'DESC',
+                'post_type'      => 'wpi_invoice'
+            )
+        );
     }
 
     /**
@@ -836,16 +836,16 @@ 
      * @return int
      */
     public function get_total_payments() {
-		global $wpdb;
+        global $wpdb;
 
-		$count = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-				$this->get_parent_invoice_id()
-			)
-		);
+        $count = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+                $this->get_parent_invoice_id()
+            )
+        );
 
-		// Maybe include parent invoice.
+        // Maybe include parent invoice.
         if ( $this->get_parent_payment()->is_paid() ) {
             $count++;
         }
@@ -874,57 +874,57 @@ 
      *
      * @since  2.4
      * @param  array $args Array of values for the payment, including amount and transaction ID
-	 * @param  WPInv_Invoice $invoice If adding an existing invoice.
+     * @param  WPInv_Invoice $invoice If adding an existing invoice.
      * @return bool
      */
     public function add_payment( $args = array(), $invoice = false ) {
 
-		// Process each payment once.
+        // Process each payment once.
         if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
             return false;
         }
 
-		// Are we creating a new invoice?
-		if ( empty( $invoice ) ) {
-			$invoice = $this->create_payment();
+        // Are we creating a new invoice?
+        if ( empty( $invoice ) ) {
+            $invoice = $this->create_payment();
 
-			if ( empty( $invoice ) ) {
-				return false;
-			}
+            if ( empty( $invoice ) ) {
+                return false;
+            }
 
-		}
+        }
 
-		$invoice->set_status( 'wpi-renewal' );
+        $invoice->set_status( 'wpi-renewal' );
 
-		// Maybe set a transaction id.
-		if ( ! empty( $args['transaction_id'] ) ) {
-			$invoice->set_transaction_id( $args['transaction_id'] );
-		}
+        // Maybe set a transaction id.
+        if ( ! empty( $args['transaction_id'] ) ) {
+            $invoice->set_transaction_id( $args['transaction_id'] );
+        }
 
-		// Set the completed date.
-		$invoice->set_completed_date( current_time( 'mysql' ) );
+        // Set the completed date.
+        $invoice->set_completed_date( current_time( 'mysql' ) );
 
-		// And the gateway.
-		if ( ! empty( $args['gateway'] ) ) {
-			$invoice->set_gateway( $args['gateway'] );
-		}
+        // And the gateway.
+        if ( ! empty( $args['gateway'] ) ) {
+            $invoice->set_gateway( $args['gateway'] );
+        }
 
-		$invoice->save();
+        $invoice->save();
 
-		if ( ! $invoice->exists() ) {
-			return false;
-		}
+        if ( ! $invoice->exists() ) {
+            return false;
+        }
 
-		do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
-		do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
+        do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
+        do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
         do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() );
 
         update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id );
 
         return $invoice->get_id();
-	}
+    }
 
-	/**
+    /**
      * Creates a new invoice and returns it.
      *
      * @since  1.0.19
@@ -932,97 +932,97 @@ 
      */
     public function create_payment() {
 
-		$parent_invoice = $this->get_parent_payment();
-
-		if ( ! $parent_invoice->exists() ) {
-			return false;
-		}
-
-		// Duplicate the parent invoice.
-		$invoice = getpaid_duplicate_invoice( $parent_invoice );
-		$invoice->set_parent_id( $parent_invoice->get_id() );
-		$invoice->recalculate_total();
-		$invoice->set_status( 'wpi-pending' );
-		$invoice->save();
-
-		return $invoice->exists() ? $invoice : false;
-    }
-
-	/**
-	 * Renews or completes a subscription
-	 *
-	 * @since  1.0.0
-	 * @return int The subscription's id
-	 */
-	public function renew() {
-
-		// Complete subscription if applicable
-		if ( $this->is_last_renewal() ) {
-			return $this->complete();
-		}
-
-		// Calculate new expiration
-		$frequency      = $this->get_frequency();
-		$period         = $this->get_period();
-		$new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() );
-
-		$this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) );
-		$this->set_status( 'active' );
-		return $this->save();
-
-		do_action( 'getpaid_subscription_renewed', $this );
-
-	}
-
-	/**
-	 * Marks a subscription as completed
-	 *
-	 * Subscription is completed when the number of payments matches the billing_times field
-	 *
-	 * @since  1.0.0
-	 * @return int|bool Subscription id or false if the subscription is cancelled.
-	 */
-	public function complete() {
-
-		// Only mark a subscription as complete if it's not already cancelled.
-		if ( $this->has_status( 'cancelled' ) ) {
-			return false;
-		}
-
-		$this->set_status( 'completed' );
-		return $this->save();
-
-	}
-
-	/**
-	 * Marks a subscription as expired
-	 *
-	 * @since  1.0.0
-	 * @param  bool $check_expiration
-	 * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future.
-	 */
-	public function expire( $check_expiration = false ) {
-
-		if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) {
-			// Do not mark as expired since real expiration date is in the future
-			return false;
-		}
-
-		$this->set_status( 'expired' );
-		return $this->save();
-
-	}
-
-	/**
-	 * Marks a subscription as failing
-	 *
-	 * @since  2.4.2
-	 * @return int Subscription id.
-	 */
-	public function failing() {
-		$this->set_status( 'failing' );
-		return $this->save();
-	}
+        $parent_invoice = $this->get_parent_payment();
+
+        if ( ! $parent_invoice->exists() ) {
+            return false;
+        }
+
+        // Duplicate the parent invoice.
+        $invoice = getpaid_duplicate_invoice( $parent_invoice );
+        $invoice->set_parent_id( $parent_invoice->get_id() );
+        $invoice->recalculate_total();
+        $invoice->set_status( 'wpi-pending' );
+        $invoice->save();
+
+        return $invoice->exists() ? $invoice : false;
+    }
+
+    /**
+     * Renews or completes a subscription
+     *
+     * @since  1.0.0
+     * @return int The subscription's id
+     */
+    public function renew() {
+
+        // Complete subscription if applicable
+        if ( $this->is_last_renewal() ) {
+            return $this->complete();
+        }
+
+        // Calculate new expiration
+        $frequency      = $this->get_frequency();
+        $period         = $this->get_period();
+        $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() );
+
+        $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) );
+        $this->set_status( 'active' );
+        return $this->save();
+
+        do_action( 'getpaid_subscription_renewed', $this );
+
+    }
+
+    /**
+     * Marks a subscription as completed
+     *
+     * Subscription is completed when the number of payments matches the billing_times field
+     *
+     * @since  1.0.0
+     * @return int|bool Subscription id or false if the subscription is cancelled.
+     */
+    public function complete() {
+
+        // Only mark a subscription as complete if it's not already cancelled.
+        if ( $this->has_status( 'cancelled' ) ) {
+            return false;
+        }
+
+        $this->set_status( 'completed' );
+        return $this->save();
+
+    }
+
+    /**
+     * Marks a subscription as expired
+     *
+     * @since  1.0.0
+     * @param  bool $check_expiration
+     * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future.
+     */
+    public function expire( $check_expiration = false ) {
+
+        if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) {
+            // Do not mark as expired since real expiration date is in the future
+            return false;
+        }
+
+        $this->set_status( 'expired' );
+        return $this->save();
+
+    }
+
+    /**
+     * Marks a subscription as failing
+     *
+     * @since  2.4.2
+     * @return int Subscription id.
+     */
+    public function failing() {
+        $this->set_status( 'failing' );
+        return $this->save();
+    }
 
     /**
      * Marks a subscription as cancelled
@@ -1031,19 +1031,19 @@ 
      * @return int Subscription id.
      */
     public function cancel() {
-		$this->set_status( 'cancelled' );
-		return $this->save();
+        $this->set_status( 'cancelled' );
+        return $this->save();
     }
 
-	/**
-	 * Determines if a subscription can be cancelled both locally and with a payment processor.
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_cancel() {
-		return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this );
-	}
+    /**
+     * Determines if a subscription can be cancelled both locally and with a payment processor.
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_cancel() {
+        return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this );
+    }
 
     /**
      * Returns an array of subscription statuses that can be cancelled
@@ -1056,93 +1056,93 @@ 
         return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
     }
 
-	/**
-	 * Retrieves the URL to cancel subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_cancel_url() {
-		$url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
-		return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the URL to view a subscription
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_view_url() {
-		$url = add_query_arg( 'subscription', $this->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
-		return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can be manually renewed
-	 *
-	 * This method is filtered by payment gateways in order to return true on subscriptions
-	 * that can be renewed manually
-	 *
-	 * @since  2.5
-	 * @return bool
-	 */
-	public function can_renew() {
-		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
-	}
-
-	/**
-	 * Retrieves the URL to renew a subscription
-	 *
-	 * @since  2.5
-	 * @return string
-	 */
-	public function get_renew_url() {
-		$url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' );
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can have their payment method updated
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
-	}
-
-	/**
-	 * Retrieves the URL to update subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_update_url() {
-		$url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the subscription status label
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_status_label() {
-		return getpaid_get_subscription_status_label( $this->get_status() );
-	}
-
-	/**
-	 * Retrieves the subscription status class
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_status_class() {
-		$statuses = getpaid_get_subscription_status_classes();
-		return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'text-white bg-secondary';
-	}
+    /**
+     * Retrieves the URL to cancel subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_cancel_url() {
+        $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
+        return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the URL to view a subscription
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_view_url() {
+        $url = add_query_arg( 'subscription', $this->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
+        return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can be manually renewed
+     *
+     * This method is filtered by payment gateways in order to return true on subscriptions
+     * that can be renewed manually
+     *
+     * @since  2.5
+     * @return bool
+     */
+    public function can_renew() {
+        return apply_filters( 'wpinv_subscription_can_renew', true, $this );
+    }
+
+    /**
+     * Retrieves the URL to renew a subscription
+     *
+     * @since  2.5
+     * @return string
+     */
+    public function get_renew_url() {
+        $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' );
+        return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can have their payment method updated
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_update() {
+        return apply_filters( 'wpinv_subscription_can_update', false, $this );
+    }
+
+    /**
+     * Retrieves the URL to update subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_update_url() {
+        $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
+        return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the subscription status label
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_status_label() {
+        return getpaid_get_subscription_status_label( $this->get_status() );
+    }
+
+    /**
+     * Retrieves the subscription status class
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_status_class() {
+        $statuses = getpaid_get_subscription_status_classes();
+        return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'text-white bg-secondary';
+    }
 
     /**
      * Retrieves the subscription status label
@@ -1152,11 +1152,11 @@ 
      */
     public function get_status_label_html() {
 
-		$status_label = sanitize_text_field( $this->get_status_label() );
-		$class        = esc_attr( $this->get_status_class() );
-		$status       = sanitize_html_class( $this->get_status_label() );
+        $status_label = sanitize_text_field( $this->get_status_label() );
+        $class        = esc_attr( $this->get_status_class() );
+        $status       = sanitize_html_class( $this->get_status_label() );
 
-		return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded $class $status'>$status_label</span></span>";
+        return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded $class $status'>$status_label</span></span>";
     }
 
     /**
@@ -1167,75 +1167,75 @@ 
      * @return bool
      */
     public function payment_exists( $txn_id = '' ) {
-		$invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
+        $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
         return ! empty( $invoice_id );
-	}
-
-	/**
-	 * Handle the status transition.
-	 */
-	protected function status_transition() {
-		$status_transition = $this->status_transition;
-
-		// Reset status transition variable.
-		$this->status_transition = false;
-
-		if ( $status_transition ) {
-			try {
-
-				// Fire a hook for the status change.
-				do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
-				do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition );
-
-				if ( ! empty( $status_transition['from'] ) ) {
-
-					/* translators: 1: old subscription status 2: new subscription status */
-					$transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
-
-					// Note the transition occurred.
-					$this->get_parent_payment()->add_note( $transition_note, false, false, true );
-
-					// Fire another hook.
-					do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
-					do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] );
-
-				} else {
-					/* translators: %s: new invoice status */
-					$transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
-
-					// Note the transition occurred.
-					$this->get_parent_payment()->add_note( $transition_note, false, false, true );
-
-				}
-			} catch ( Exception $e ) {
-				$this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
-			}
-		}
-
-	}
-
-	/**
-	 * Save data to the database.
-	 *
-	 * @since 1.0.19
-	 * @return int subscription ID
-	 */
-	public function save() {
-		parent::save();
-		$this->status_transition();
-		return $this->get_id();
-	}
-
-	/**
-	 * Activates a subscription.
-	 *
-	 * @since 1.0.19
-	 * @return int subscription ID
-	 */
-	public function activate() {
-		$status = 'trialling' == $this->get_status() ? 'trialling' : 'active';
-		$this->set_status( $status );
-		return $this->save();
-	}
+    }
+
+    /**
+     * Handle the status transition.
+     */
+    protected function status_transition() {
+        $status_transition = $this->status_transition;
+
+        // Reset status transition variable.
+        $this->status_transition = false;
+
+        if ( $status_transition ) {
+            try {
+
+                // Fire a hook for the status change.
+                do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition );
+                do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition );
+
+                if ( ! empty( $status_transition['from'] ) ) {
+
+                    /* translators: 1: old subscription status 2: new subscription status */
+                    $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
+
+                    // Note the transition occurred.
+                    $this->get_parent_payment()->add_note( $transition_note, false, false, true );
+
+                    // Fire another hook.
+                    do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this );
+                    do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] );
+
+                } else {
+                    /* translators: %s: new invoice status */
+                    $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) );
+
+                    // Note the transition occurred.
+                    $this->get_parent_payment()->add_note( $transition_note, false, false, true );
+
+                }
+            } catch ( Exception $e ) {
+                $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() );
+            }
+        }
+
+    }
+
+    /**
+     * Save data to the database.
+     *
+     * @since 1.0.19
+     * @return int subscription ID
+     */
+    public function save() {
+        parent::save();
+        $this->status_transition();
+        return $this->get_id();
+    }
+
+    /**
+     * Activates a subscription.
+     *
+     * @since 1.0.19
+     * @return int subscription ID
+     */
+    public function activate() {
+        $status = 'trialling' == $this->get_status() ? 'trialling' : 'active';
+        $this->set_status( $status );
+        return $this->save();
+    }
 
 }

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

Indentation +354 added lines, -354 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 = null;
-
-	/**
-	 * 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 = null;
+
+    /**
+     * 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,232 +81,232 @@ 
     */
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		$name = parent::get_name( $context );
-		return $name . wpinv_get_item_suffix( $this );
-	}
-
-	/**
-	 * Get the item name without a suffix.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_raw_name( $context = 'view' ) {
-		return parent::get_name( $context );
-	}
-
-	/**
-	 * Get the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-
-		if ( isset( $this->custom_description ) ) {
-			return $this->custom_description;
-		}
-
-		return parent::get_description( $context );
-	}
-
-	/**
-	 * Returns the sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_sub_total( $context = 'view' ) {
-		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 float
-	 */
-	public function get_recurring_sub_total( $context = 'view' ) {
-
-		if ( $this->is_recurring() ) {
-			return $this->get_quantity( $context ) * $this->get_price( $context );
-		}
-
-		return 0;
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function get_qantity( $context = 'view' ) {
-		return $this->get_quantity( $context );
-	}
-
-	/**
-	 * Get the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return 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( $required = null ) {
-
-		$required = is_null( $required ) ? $this->is_required() : $required;
-		return array(
-			'title'            => strip_tags( $this->get_name() ),
-			'id'               => $this->get_id(),
-			'price'            => $this->get_price(),
-			'recurring'        => $this->is_recurring(),
-			'description'      => $this->get_description(),
-			'allow_quantities' => $this->allows_quantities(),
-			'required'         => $required,
-		);
-
-	}
-
-	/**
-	 * Prepares form data for ajax use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_invoice_edit_ajax( $currency = '' ) {
-
-		$description = getpaid_item_recurring_price_help_text( $this, $currency );
-
-		if ( $description ) {
-			$description = "<div class='getpaid-subscription-help-text'>$description</div>";
-		}
-
-		return array(
-			'id'     => $this->get_id(),
-			'texts'  => array(
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ) . $description,
-				'item-quantity'    => absint( $this->get_quantity() ),
-				'item-price'       => wpinv_price( wpinv_format_amount ( $this->get_price() ), $currency ),
-				'item-total'       => wpinv_price( wpinv_format_amount( $this->get_sub_total() ), $currency ),
-			),
-			'inputs' => array(
-				'item-id'          => $this->get_id(),
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ),
-				'item-quantity'    => 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_raw_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 name without a suffix.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_raw_name( $context = 'view' ) {
+        return parent::get_name( $context );
+    }
+
+    /**
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+
+        if ( isset( $this->custom_description ) ) {
+            return $this->custom_description;
+        }
+
+        return parent::get_description( $context );
+    }
+
+    /**
+     * Returns the sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_sub_total( $context = 'view' ) {
+        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 float
+     */
+    public function get_recurring_sub_total( $context = 'view' ) {
+
+        if ( $this->is_recurring() ) {
+            return $this->get_quantity( $context ) * $this->get_price( $context );
+        }
+
+        return 0;
+    }
+
+    /**
+     * @deprecated
+     */
+    public function get_qantity( $context = 'view' ) {
+        return $this->get_quantity( $context );
+    }
+
+    /**
+     * Get the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return 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( $required = null ) {
+
+        $required = is_null( $required ) ? $this->is_required() : $required;
+        return array(
+            'title'            => strip_tags( $this->get_name() ),
+            'id'               => $this->get_id(),
+            'price'            => $this->get_price(),
+            'recurring'        => $this->is_recurring(),
+            'description'      => $this->get_description(),
+            'allow_quantities' => $this->allows_quantities(),
+            'required'         => $required,
+        );
+
+    }
+
+    /**
+     * Prepares form data for ajax use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_invoice_edit_ajax( $currency = '' ) {
+
+        $description = getpaid_item_recurring_price_help_text( $this, $currency );
+
+        if ( $description ) {
+            $description = "<div class='getpaid-subscription-help-text'>$description</div>";
+        }
+
+        return array(
+            'id'     => $this->get_id(),
+            'texts'  => array(
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ) . $description,
+                'item-quantity'    => absint( $this->get_quantity() ),
+                'item-price'       => wpinv_price( wpinv_format_amount ( $this->get_price() ), $currency ),
+                'item-total'       => wpinv_price( wpinv_format_amount( $this->get_sub_total() ), $currency ),
+            ),
+            'inputs' => array(
+                'item-id'          => $this->get_id(),
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ),
+                'item-quantity'    => 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_raw_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(),
+        );
+
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -318,70 +318,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 = (int) $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 = (int) $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();
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -393,23 +393,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/wpinv-gateway-functions.php

Indentation +28 added lines, -28 removed lines

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

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

Indentation +223 added lines, -223 removed lines

@@ -13,94 +13,94 @@ 
 class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'paypal';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 1;
 
     /**
-	 * Stores line items to send to PayPal.
-	 *
-	 * @var array
-	 */
+     * Stores line items to send to PayPal.
+     *
+     * @var array
+     */
     protected $line_items = array();
 
     /**
-	 * Endpoint for requests from PayPal.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to PayPal.
+     *
+     * @var string
+     */
     protected $endpoint;
     
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s';
 
     /**
-	 * URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
+     * URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'PayPal Standard', 'invoicing' );
         $this->method_title         = __( 'PayPal Standard', 'invoicing' );
         $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' );
         $this->notify_url           = wpinv_get_ipn_url( $this->id );
 
-		add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
+        add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
         add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) );
 
         parent::__construct();
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -123,15 +123,15 @@ 
     }
 
     /**
-	 * Get the PayPal request URL for an invoice.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_request_url( $invoice ) {
+     * Get the PayPal request URL for an invoice.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_request_url( $invoice ) {
 
         // Endpoint for this request
-		$this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
+        $this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
 
         // Retrieve paypal args.
         $paypal_args       = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' );
@@ -144,44 +144,44 @@ 
 
         return add_query_arg( $paypal_args, $this->endpoint );
 
-	}
+    }
 
     /**
-	 * Get PayPal Args for passing to PP.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_paypal_args( $invoice ) {
+     * Get PayPal Args for passing to PP.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_paypal_args( $invoice ) {
 
         // Whether or not to send the line items as one item.
-		$force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice );
-
-		if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
-			$force_one_line_item = true;
-		}
-
-		$paypal_args = apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, $force_one_line_item )
-			),
-			$invoice
-		);
-
-		return $this->fix_request_length( $invoice, $paypal_args );
+        $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice );
+
+        if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
+            $force_one_line_item = true;
+        }
+
+        $paypal_args = apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, $force_one_line_item )
+            ),
+            $invoice
+        );
+
+        return $this->fix_request_length( $invoice, $paypal_args );
     }
 
     /**
-	 * Get transaction args for paypal request.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_transaction_args( $invoice ) {
-
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        return array(
             'cmd'           => '_cart',
             'business'      => wpinv_get_option( 'paypal_email', false ),
             'no_shipping'   => '1',
@@ -206,16 +206,16 @@ 
     }
 
     /**
-	 * Get line item args for paypal request.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @param  bool     $force_one_line_item Create only one item for this invoice.
-	 * @return array
-	 */
-	protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
+     * Get line item args for paypal request.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @param  bool     $force_one_line_item Create only one item for this invoice.
+     * @return array
+     */
+    protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
 
         // Maybe send invoice as a single item.
-		if ( $force_one_line_item ) {
+        if ( $force_one_line_item ) {
             return $this->get_line_item_args_single_item( $invoice );
         }
 
@@ -235,129 +235,129 @@ 
             $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 );
         }
 
-		return array_merge( $line_item_args, $this->get_line_items() );
+        return array_merge( $line_item_args, $this->get_line_items() );
 
     }
 
     /**
-	 * Get line item args for paypal request as a single line item.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_line_item_args_single_item( $invoice ) {
-		$this->delete_line_items();
+     * Get line item args for paypal request as a single line item.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_line_item_args_single_item( $invoice ) {
+        $this->delete_line_items();
 
         $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() );
-		$this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() );
+        $this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() );
 
-		return $this->get_line_items();
+        return $this->get_line_items();
     }
 
     /**
-	 * Return all line items.
-	 */
-	protected function get_line_items() {
-		return $this->line_items;
-	}
+     * Return all line items.
+     */
+    protected function get_line_items() {
+        return $this->line_items;
+    }
 
     /**
-	 * Remove all line items.
-	 */
-	protected function delete_line_items() {
-		$this->line_items = array();
+     * Remove all line items.
+     */
+    protected function delete_line_items() {
+        $this->line_items = array();
     }
 
     /**
-	 * Prepare line items to send to paypal.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 */
-	protected function prepare_line_items( $invoice ) {
-		$this->delete_line_items();
-
-		// Items.
-		foreach ( $invoice->get_items() as $item ) {
-			$amount   = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total();
-			$quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
-			$this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
+     * Prepare line items to send to paypal.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     */
+    protected function prepare_line_items( $invoice ) {
+        $this->delete_line_items();
+
+        // Items.
+        foreach ( $invoice->get_items() as $item ) {
+            $amount   = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total();
+            $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
+            $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
         }
 
         // Fees.
-		foreach ( $invoice->get_fees() as $fee => $data ) {
+        foreach ( $invoice->get_fees() as $fee => $data ) {
             $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) );
         }
 
     }
 
     /**
-	 * Add PayPal Line Item.
-	 *
-	 * @param  string $item_name Item name.
-	 * @param  int    $quantity Item quantity.
-	 * @param  float  $amount Amount.
-	 * @param  string $item_number Item number.
-	 */
-	protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
-		$index = ( count( $this->line_items ) / 4 ) + 1;
-
-		$item = apply_filters(
-			'getpaid_paypal_line_item',
-			array(
-				'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
-				'quantity'    => (int) $quantity,
-				'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
-				'item_number' => $item_number,
-			),
-			$item_name,
-			$quantity,
-			$amount,
-			$item_number
-		);
-
-		$this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
+     * Add PayPal Line Item.
+     *
+     * @param  string $item_name Item name.
+     * @param  int    $quantity Item quantity.
+     * @param  float  $amount Amount.
+     * @param  string $item_number Item number.
+     */
+    protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
+        $index = ( count( $this->line_items ) / 4 ) + 1;
+
+        $item = apply_filters(
+            'getpaid_paypal_line_item',
+            array(
+                'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
+                'quantity'    => (int) $quantity,
+                'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
+                'item_number' => $item_number,
+            ),
+            $item_name,
+            $quantity,
+            $amount,
+            $item_number
+        );
+
+        $this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
         $this->line_items[ 'quantity_' . $index ]    = $item['quantity'];
         
         // The price or amount of the product, service, or contribution, not including shipping, handling, or tax.
-		$this->line_items[ 'amount_' . $index ]      = $item['amount'];
-		$this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
+        $this->line_items[ 'amount_' . $index ]      = $item['amount'];
+        $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
     }
 
     /**
-	 * If the default request with line items is too long, generate a new one with only one line item.
-	 *
-	 * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
-	 * @param array    $paypal_args Arguments sent to Paypal in the request.
-	 * @return array
-	 */
-	protected function fix_request_length( $invoice, $paypal_args ) {
-		$max_paypal_length = 2083;
-		$query_candidate   = http_build_query( $paypal_args, '', '&' );
-
-		if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
-			return $paypal_args;
-		}
-
-		return apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, true )
-			),
-			$invoice
-		);
+     * If the default request with line items is too long, generate a new one with only one line item.
+     *
+     * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
+     *
+     * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
+     * @param array    $paypal_args Arguments sent to Paypal in the request.
+     * @return array
+     */
+    protected function fix_request_length( $invoice, $paypal_args ) {
+        $max_paypal_length = 2083;
+        $query_candidate   = http_build_query( $paypal_args, '', '&' );
+
+        if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
+            return $paypal_args;
+        }
+
+        return apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, true )
+            ),
+            $invoice
+        );
 
     }
     
     /**
-	 * Processes recurring invoices.
-	 *
-	 * @param  array $paypal_args PayPal args.
-	 * @param  WPInv_Invoice    $invoice Invoice object.
-	 */
-	public function process_subscription( $paypal_args, $invoice ) {
+     * Processes recurring invoices.
+     *
+     * @param  array $paypal_args PayPal args.
+     * @param  WPInv_Invoice    $invoice Invoice object.
+     */
+    public function process_subscription( $paypal_args, $invoice ) {
 
         // Make sure this is a subscription.
         if ( ! $invoice->is_recurring() || ! $subscription = wpinv_get_subscription( $invoice ) ) {
@@ -382,11 +382,11 @@ 
 
             $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount;
 
-			// Trial period length.
-			$paypal_args['p1'] = $subscription_item->get_trial_interval();
+            // Trial period length.
+            $paypal_args['p1'] = $subscription_item->get_trial_interval();
 
-			// Trial period.
-			$paypal_args['t1'] = $subscription_item->get_trial_period();
+            // Trial period.
+            $paypal_args['t1'] = $subscription_item->get_trial_period();
 
         } else if ( $initial_amount != $recurring_amount ) {
 
@@ -409,40 +409,40 @@ 
         }
 
         // We have a recurring payment
-		if ( ! isset( $param_number ) || 1 == $param_number ) {
+        if ( ! isset( $param_number ) || 1 == $param_number ) {
 
-			// Subscription price
-			$paypal_args['a3'] = $recurring_amount;
+            // Subscription price
+            $paypal_args['a3'] = $recurring_amount;
 
-			// Subscription duration
-			$paypal_args['p3'] = $interval;
+            // Subscription duration
+            $paypal_args['p3'] = $interval;
 
-			// Subscription period
-			$paypal_args['t3'] = $period;
+            // Subscription period
+            $paypal_args['t3'] = $period;
 
         }
         
         // Recurring payments
-		if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
+        if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
 
-			// Non-recurring payments
-			$paypal_args['src'] = 0;
+            // Non-recurring payments
+            $paypal_args['src'] = 0;
 
-		} else {
+        } else {
 
-			$paypal_args['src'] = 1;
+            $paypal_args['src'] = 1;
 
-			if ( $bill_times > 0 ) {
+            if ( $bill_times > 0 ) {
 
-				// An initial period is being used to charge a sign-up fee
-				if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
-					$bill_times--;
-				}
+                // An initial period is being used to charge a sign-up fee
+                if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
+                    $bill_times--;
+                }
 
                 // Make sure it's not over the max of 52
                 $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 );
 
-			}
+            }
         }
         
         // Force return URL so that order description & instructions display
@@ -458,19 +458,19 @@ 
         }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -480,10 +480,10 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 

includes/wpinv-payment-functions.php

Indentation +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
  */
 function wpinv_send_back_to_checkout() {
 
-	// Do we have any errors?
+    // Do we have any errors?
     if ( wpinv_get_errors() ) {
         wp_send_json_error( getpaid_get_errors_html( true, false ) );
     }

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +367 added lines, -367 removed lines

@@ -12,431 +12,431 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler' );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal' );
-			wp_die( 'Invoice not paid via PayPal', 500 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'] );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'] );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN' );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'] );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice' );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number() );
-				return $invoice;
-			}
-
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.' );
-		wp_die( 'Could not retrieve the associated invoice.', 500 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response' );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data' );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			wpinv_error_log( $response['body'], 'Received valid response from PayPal IPN' );
-			return true;
-		}
-
-		if ( is_wp_error( $response ) ) {
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler' );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal' );
+            wp_die( 'Invoice not paid via PayPal', 500 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'] );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'] );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN' );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'] );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice' );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number() );
+                return $invoice;
+            }
+
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.' );
+        wp_die( 'Could not retrieve the associated invoice.', 500 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response' );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data' );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            wpinv_error_log( $response['body'], 'Received valid response from PayPal IPN' );
+            return true;
+        }
+
+        if ( is_wp_error( $response ) ) {
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
 
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
 
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
 
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
 
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $currency, 'Validated IPN Currency' );
-	}
+        wpinv_error_log( $currency, 'Validated IPN Currency' );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount' );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount' );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = wpinv_get_option( 'paypal_email' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = wpinv_get_option( 'paypal_email' );
 
-		if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
+        if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
 
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email' );
-	}
+        wpinv_error_log( 'Validated PayPal Email' );
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
-
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
-
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
+
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		// Process a refund.
-		if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
+        // Process a refund.
+        if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'] );
-		}
+            return wpinv_error_log( $posted['reason_code'] );
+        }
 
-		// Process payments.
-		if ( $payment_status == 'completed' ) {
+        // Process payments.
+        if ( $payment_status == 'completed' ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.' );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.' );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
-
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            $note = '';
+
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.' );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.' );
 
-		}
+        }
 
-		// Pending payments.
-		if ( $payment_status == 'pending' ) {
+        // Pending payments.
+        if ( $payment_status == 'pending' ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".' );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".' );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup' );
+        wpinv_error_log( 'Processing subscription signup' );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
+        }
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.' );
-	}
+        wpinv_error_log( 'Subscription started.' );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = wpinv_get_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = wpinv_get_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
+        }
 
-		// Abort if this is the first payment.
-		if ( date( 'Ynd', $subscription->get_time_created() ) == date( 'Ynd', strtotime( $posted['payment_date'] ) ) ) {
-			$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
-			$invoice->save();
-			return;
-		}
-
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id() );
+        // Abort if this is the first payment.
+        if ( date( 'Ynd', $subscription->get_time_created() ) == date( 'Ynd', strtotime( $posted['payment_date'] ) ) ) {
+            $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
+            $invoice->save();
+            return;
+        }
+
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id() );
 
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed' );
-		}
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed' );
+        }
 
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
-
-		if ( empty( $invoice ) ) {
-			return;
-		}
-
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
-
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.' );
-
-	}
-
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
-
-		// Make sure the invoice has a subscription.
-		$subscription = wpinv_get_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id() );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.' );
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+
+        if ( empty( $invoice ) ) {
+            return;
+        }
+
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.' );
+
+    }
+
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
+
+        // Make sure the invoice has a subscription.
+        $subscription = wpinv_get_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id() );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.' );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
-
-		// Make sure the invoice has a subscription.
-		$subscription = wpinv_get_subscription( $invoice );
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
+
+        // Make sure the invoice has a subscription.
+        $subscription = wpinv_get_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id() );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.' );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id() );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.' );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = wpinv_get_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = wpinv_get_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found' );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id() );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.' );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id() );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.' );
 
-	}
+    }
 
 }

templates/subscriptions/subscription-details.php

Indentation +52 added lines, -52 removed lines

@@ -43,64 +43,64 @@ 
 				<td class="w-75">
 					<?php
 
-						switch ( $key ) {
+                        switch ( $key ) {
 
-							case 'status':
-								echo sanitize_text_field( $subscription->get_status_label() );
-								break;
+                            case 'status':
+                                echo sanitize_text_field( $subscription->get_status_label() );
+                                break;
 
-							case 'start_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
-								break;
+                            case 'start_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
+                                break;
 
-							case 'expiry_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
-								break;
+                            case 'expiry_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
+                                break;
 
-							case 'initial_amount':
-								echo wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
+                            case 'initial_amount':
+                                echo wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
 
-								if ( $subscription->has_trial_period() ) {
+                                if ( $subscription->has_trial_period() ) {
 
-									echo "<small class='text-muted'>&nbsp;";
-									printf(
-										_x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
-										sanitize_text_field( $subscription->get_trial_period() )
-									);
-									echo '</small>';
+                                    echo "<small class='text-muted'>&nbsp;";
+                                    printf(
+                                        _x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
+                                        sanitize_text_field( $subscription->get_trial_period() )
+                                    );
+                                    echo '</small>';
 
-								}
+                                }
 								
-								break;
+                                break;
 
-							case 'recurring_amount':
-								$frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-								$amount    = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
-								echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / $frequency" );
-								break;
+                            case 'recurring_amount':
+                                $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+                                $amount    = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
+                                echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / $frequency" );
+                                break;
 
-							case 'item':
-								$item = get_post( $subscription->get_product_id() );
+                            case 'item':
+                                $item = get_post( $subscription->get_product_id() );
 
-								if ( ! empty( $item ) ) {
-									echo esc_html( get_the_title( $item ) );
-								} else {
-									echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
-								}
+                                if ( ! empty( $item ) ) {
+                                    echo esc_html( get_the_title( $item ) );
+                                } else {
+                                    echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
+                                }
 
-								break;
+                                break;
 
-							case 'payments':
+                            case 'payments':
 
-								$max_activations = (int) $subscription->get_bill_times();
-								echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
+                                $max_activations = (int) $subscription->get_bill_times();
+                                echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
 
-								break;
+                                break;
 
-						}
-						do_action( "getpaid_render_single_subscription_column_$key", $subscription );
+                        }
+                        do_action( "getpaid_render_single_subscription_column_$key", $subscription );
 
-					?>
+                    ?>
 				</td>
 
 			</tr>
@@ -117,17 +117,17 @@ 
 <span class="form-text">
 
 	<?php
-		if ( $subscription->can_cancel() ) {
-			printf(
-				'<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
-				esc_url( $subscription->get_cancel_url() ),
-				esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
-				__( 'Cancel Subscription', 'invoicing' )
-			);
-		}
-
-		do_action( 'getpaid-single-subscription-page-actions', $subscription );
-	?>
+        if ( $subscription->can_cancel() ) {
+            printf(
+                '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
+                esc_url( $subscription->get_cancel_url() ),
+                esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
+                __( 'Cancel Subscription', 'invoicing' )
+            );
+        }
+
+        do_action( 'getpaid-single-subscription-page-actions', $subscription );
+    ?>
 
 	<a href="<?php echo esc_url( get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); ?>" class="btn btn-secondary btn-sm"><?php _e( 'Go Back', 'invoicing' ); ?></a>
 </span>
\ No newline at end of file

invoicing.php

Indentation +4 added lines, -4 removed lines

@@ -19,16 +19,16 @@ 
 
 // Define constants.
 if ( ! defined( 'WPINV_PLUGIN_FILE' ) ) {
-	define( 'WPINV_PLUGIN_FILE', __FILE__ );
+    define( 'WPINV_PLUGIN_FILE', __FILE__ );
 }
 
 if ( ! defined( 'WPINV_VERSION' ) ) {
-	define( 'WPINV_VERSION', '1.1.0' );
+    define( 'WPINV_VERSION', '1.1.0' );
 }
 
 // Include the main Invoicing class.
 if ( ! class_exists( 'WPInv_Plugin', false ) ) {
-	require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php';
+    require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php';
 }
 
 /**
@@ -43,7 +43,7 @@ 
         $GLOBALS['invoicing'] = new WPInv_Plugin();
     }
 
-	return $GLOBALS['invoicing'];
+    return $GLOBALS['invoicing'];
 }
 
 /**

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

Indentation +533 added lines, -533 removed lines

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