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->get_id() ) {
-			return 0;
-		}
+        if ( ! $invoice->get_id() ) {
+            return 0;
+        }
 
-		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/admin/subscriptions.php

Indentation +203 added lines, -203 removed lines

@@ -14,7 +14,7 @@ 
  */
 function wpinv_subscriptions_page() {
 
-	?>
+    ?>
 
 	<div class="wrap">
 		<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
@@ -22,27 +22,27 @@ 
 
 			<?php
 
-				// Verify user permissions.
-				if ( ! wpinv_current_user_can_manage_invoicing() ) {
+                // Verify user permissions.
+                if ( ! wpinv_current_user_can_manage_invoicing() ) {
 
-					echo aui()->alert(
-						array(
-							'type'    => 'danger',
-							'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
-						)
-					);
+                    echo aui()->alert(
+                        array(
+                            'type'    => 'danger',
+                            'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
+                        )
+                    );
 
-				} else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
+                } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
 
-					// Display a single subscription.
-					wpinv_recurring_subscription_details();
-				} else {
+                    // Display a single subscription.
+                    wpinv_recurring_subscription_details();
+                } else {
 
-					// Display a list of available subscriptions.
-					getpaid_print_subscriptions_list();
-				}
+                    // Display a list of available subscriptions.
+                    getpaid_print_subscriptions_list();
+                }
 
-			?>
+            ?>
 
 		</div>
 	</div>
@@ -59,10 +59,10 @@ 
  */
 function getpaid_print_subscriptions_list() {
 
-	$subscribers_table = new WPInv_Subscriptions_List_Table();
-	$subscribers_table->prepare_items();
+    $subscribers_table = new WPInv_Subscriptions_List_Table();
+    $subscribers_table->prepare_items();
 
-	?>
+    ?>
 	<form id="subscribers-filter" class="bsui" method="get">
 		<input type="hidden" name="page" value="wpinv-subscriptions" />
 		<?php $subscribers_table->views(); ?>
@@ -80,27 +80,27 @@ 
  */
 function wpinv_recurring_subscription_details() {
 
-	// Fetch the subscription.
-	$sub = new WPInv_Subscription( (int) $_GET['id'] );
-	if ( ! $sub->get_id() ) {
+    // Fetch the subscription.
+    $sub = new WPInv_Subscription( (int) $_GET['id'] );
+    if ( ! $sub->get_id() ) {
 
-		echo aui()->alert(
-			array(
-				'type'    => 'danger',
-				'content' => __( 'Subscription not found.', 'invoicing' ),
-			)
-		);
+        echo aui()->alert(
+            array(
+                'type'    => 'danger',
+                'content' => __( 'Subscription not found.', 'invoicing' ),
+            )
+        );
 
-		return;
-	}
+        return;
+    }
 
-	// Use metaboxes to display the subscription details.
-	add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' );
-	add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
-	add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
-	do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
+    // Use metaboxes to display the subscription details.
+    add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' );
+    add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
+    add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
+    do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
 
-	?>
+    ?>
 
 		<form method="post" action="<?php echo admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $sub->get_id() ) ); ?>">
 
@@ -140,41 +140,41 @@ 
  */
 function getpaid_admin_subscription_details_metabox( $sub ) {
 
-	// Prepare subscription detail columns.
-	$fields = apply_filters(
-		'getpaid_subscription_admin_page_fields',
-		array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'customer'       => __( 'Customer', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'start_date'     => __( 'Start Date', 'invoicing' ),
-			'renews_on'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'       => __( 'Payments', 'invoicing' ),
-			'item'           => __( 'Item', 'invoicing' ),
-			'gateway'        => __( 'Payment Method', 'invoicing' ),
-			'profile_id'     => __( 'Profile ID', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		)
-	);
-
-	if ( ! $sub->is_active() ) {
-
-		if ( isset( $fields['renews_on'] ) ) {
-			unset( $fields['renews_on'] );
-		}
-
-		if ( isset( $fields['gateway'] ) ) {
-			unset( $fields['gateway'] );
-		}
+    // Prepare subscription detail columns.
+    $fields = apply_filters(
+        'getpaid_subscription_admin_page_fields',
+        array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'customer'       => __( 'Customer', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'start_date'     => __( 'Start Date', 'invoicing' ),
+            'renews_on'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'       => __( 'Payments', 'invoicing' ),
+            'item'           => __( 'Item', 'invoicing' ),
+            'gateway'        => __( 'Payment Method', 'invoicing' ),
+            'profile_id'     => __( 'Profile ID', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        )
+    );
+
+    if ( ! $sub->is_active() ) {
+
+        if ( isset( $fields['renews_on'] ) ) {
+            unset( $fields['renews_on'] );
+        }
+
+        if ( isset( $fields['gateway'] ) ) {
+            unset( $fields['gateway'] );
+        }
 		
-	}
+    }
 
-	$profile_id = $sub->get_profile_id();
-	if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
-		unset( $fields['profile_id'] );
-	}
+    $profile_id = $sub->get_profile_id();
+    if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
+        unset( $fields['profile_id'] );
+    }
 
-	?>
+    ?>
 
 		<table class="table table-borderless" style="font-size: 14px;">
 			<tbody>
@@ -208,20 +208,20 @@ 
  */
 function getpaid_admin_subscription_metabox_display_customer( $subscription ) {
 
-	$username = __( '(Missing User)', 'invoicing' );
+    $username = __( '(Missing User)', 'invoicing' );
 
-	$user = get_userdata( $subscription->get_customer_id() );
-	if ( $user ) {
+    $user = get_userdata( $subscription->get_customer_id() );
+    if ( $user ) {
 
-		$username = sprintf(
-			'<a href="user-edit.php?user_id=%s">%s</a>',
-			absint( $user->ID ),
-			! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
-		);
+        $username = sprintf(
+            '<a href="user-edit.php?user_id=%s">%s</a>',
+            absint( $user->ID ),
+            ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
+        );
 
-	}
+    }
 
-	echo  $username;
+    echo  $username;
 }
 add_action( 'getpaid_subscription_admin_display_customer', 'getpaid_admin_subscription_metabox_display_customer' );
 
@@ -231,8 +231,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_amount( $subscription ) {
-	$amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
-	echo "<span>$amount</span>";
+    $amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
+    echo "<span>$amount</span>";
 }
 add_action( 'getpaid_subscription_admin_display_amount', 'getpaid_admin_subscription_metabox_display_amount' );
 
@@ -242,7 +242,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_id( $subscription ) {
-	echo  '#' . absint( $subscription->get_id() );
+    echo  '#' . absint( $subscription->get_id() );
 }
 add_action( 'getpaid_subscription_admin_display_subscription', 'getpaid_admin_subscription_metabox_display_id' );
 
@@ -252,7 +252,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_start_date( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_date_created() );
+    echo getpaid_format_date_value( $subscription->get_date_created() );
 }
 add_action( 'getpaid_subscription_admin_display_start_date', 'getpaid_admin_subscription_metabox_display_start_date' );
 
@@ -262,7 +262,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renews_on( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_expiration() );
+    echo getpaid_format_date_value( $subscription->get_expiration() );
 }
 add_action( 'getpaid_subscription_admin_display_renews_on', 'getpaid_admin_subscription_metabox_display_renews_on' );
 
@@ -272,8 +272,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renewals( $subscription ) {
-	$max_bills = $subscription->get_bill_times();
-	echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+    $max_bills = $subscription->get_bill_times();
+    echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
 }
 add_action( 'getpaid_subscription_admin_display_renewals', 'getpaid_admin_subscription_metabox_display_renewals' );
 /**
@@ -283,16 +283,16 @@ 
  */
 function getpaid_admin_subscription_metabox_display_item( $subscription ) {
 
-	$item = get_post( $subscription->get_product_id() );
+    $item = get_post( $subscription->get_product_id() );
 
-	if ( ! empty( $item ) ) {
-		$link = get_edit_post_link( $item );
-		$link = esc_url( $link );
-		$name = esc_html( get_the_title( $item ) );
-		echo "<a href='$link'>$name</a>";
-	} else {
-		echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
-	}
+    if ( ! empty( $item ) ) {
+        $link = get_edit_post_link( $item );
+        $link = esc_url( $link );
+        $name = esc_html( get_the_title( $item ) );
+        echo "<a href='$link'>$name</a>";
+    } else {
+        echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_item', 'getpaid_admin_subscription_metabox_display_item' );
@@ -304,13 +304,13 @@ 
  */
 function getpaid_admin_subscription_metabox_display_gateway( $subscription ) {
 
-	$gateway = $subscription->get_gateway();
+    $gateway = $subscription->get_gateway();
 
-	if ( ! empty( $gateway ) ) {
-		echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
-	} else {
-		echo "&mdash;";
-	}
+    if ( ! empty( $gateway ) ) {
+        echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
+    } else {
+        echo "&mdash;";
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_gateway', 'getpaid_admin_subscription_metabox_display_gateway' );
@@ -321,7 +321,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_status( $subscription ) {
-	echo $subscription->get_status_label_html();
+    echo $subscription->get_status_label_html();
 }
 add_action( 'getpaid_subscription_admin_display_status', 'getpaid_admin_subscription_metabox_display_status' );
 
@@ -332,14 +332,14 @@ 
  */
 function getpaid_admin_subscription_metabox_display_profile_id( $subscription ) {
 
-	$profile_id = $subscription->get_profile_id();
+    $profile_id = $subscription->get_profile_id();
 
-	if ( ! empty( $profile_id ) ) {
-		$profile_id = sanitize_text_field( $profile_id );
-		echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription );
-	} else {
-		echo "&mdash;";
-	}
+    if ( ! empty( $profile_id ) ) {
+        $profile_id = sanitize_text_field( $profile_id );
+        echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription );
+    } else {
+        echo "&mdash;";
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_profile_id', 'getpaid_admin_subscription_metabox_display_profile_id' );
@@ -351,39 +351,39 @@ 
  */
 function getpaid_admin_subscription_update_metabox( $subscription ) {
 
-	?>
+    ?>
 	<div class="mt-3">
 
 		<?php
-			echo aui()->select(
-				array(
-					'options'          => getpaid_get_subscription_statuses(),
-					'name'             => 'subscription_status',
-					'id'               => 'subscription_status_update_select',
-					'required'         => true,
-					'no_wrap'          => false,
-					'label'            => __( 'Subscription Status', 'invoicing' ),
-					'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
-					'select2'          => true,
-					'value'            => $subscription->get_status( 'edit' ),
-				)
-			);
-		?>
+            echo aui()->select(
+                array(
+                    'options'          => getpaid_get_subscription_statuses(),
+                    'name'             => 'subscription_status',
+                    'id'               => 'subscription_status_update_select',
+                    'required'         => true,
+                    'no_wrap'          => false,
+                    'label'            => __( 'Subscription Status', 'invoicing' ),
+                    'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
+                    'select2'          => true,
+                    'value'            => $subscription->get_status( 'edit' ),
+                )
+            );
+        ?>
 
 		<div class="mt-2 px-3 py-2 bg-light border-top" style="margin: -12px;">
 	
 		<?php
-			submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
+            submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
 
-			$url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
-			$anchor = __( 'Renew Subscription', 'invoicing' );
-			$title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
+            $url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
+            $anchor = __( 'Renew Subscription', 'invoicing' );
+            $title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
 
-			if ( $subscription->is_active() ) {
-				echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
-			}
+            if ( $subscription->is_active() ) {
+                echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
+            }
 
-	echo '</div></div>';
+    echo '</div></div>';
 }
 
 /**
@@ -393,33 +393,33 @@ 
  */
 function getpaid_admin_subscription_invoice_details_metabox( $subscription ) {
 
-	$columns = apply_filters(
-		'getpaid_subscription_related_invoices_columns',
-		array(
-			'invoice'      => __( 'Invoice', 'invoicing' ),
-			'relationship' => __( 'Relationship', 'invoicing' ),
-			'date'         => __( 'Date', 'invoicing' ),
-			'status'       => __( 'Status', 'invoicing' ),
-			'total'        => __( 'Total', 'invoicing' ),
-		),
-		$subscription
-	);
-
-	// Prepare the invoices.
-	$payments = $subscription->get_child_payments( ! is_admin() );
-	$parent   = $subscription->get_parent_invoice();
-
-	if ( $parent->get_id() ) {
-		$payments = array_merge( array( $parent ), $payments );
-	}
+    $columns = apply_filters(
+        'getpaid_subscription_related_invoices_columns',
+        array(
+            'invoice'      => __( 'Invoice', 'invoicing' ),
+            'relationship' => __( 'Relationship', 'invoicing' ),
+            'date'         => __( 'Date', 'invoicing' ),
+            'status'       => __( 'Status', 'invoicing' ),
+            'total'        => __( 'Total', 'invoicing' ),
+        ),
+        $subscription
+    );
+
+    // Prepare the invoices.
+    $payments = $subscription->get_child_payments( ! is_admin() );
+    $parent   = $subscription->get_parent_invoice();
+
+    if ( $parent->get_id() ) {
+        $payments = array_merge( array( $parent ), $payments );
+    }
 	
-	$table_class = 'w-100 bg-white';
+    $table_class = 'w-100 bg-white';
 
-	if ( ! is_admin() ) {
-		$table_class = 'table table-bordered table-striped';
-	}
+    if ( ! is_admin() ) {
+        $table_class = 'table table-bordered table-striped';
+    }
 
-	?>
+    ?>
 		<div class="m-0" style="overflow: auto;">
 
 			<table class="<?php echo $table_class; ?>">
@@ -427,13 +427,13 @@ 
 				<thead>
 					<tr>
 						<?php
-							foreach ( $columns as $key => $label ) {
-								$key   = esc_attr( $key );
-								$label = sanitize_text_field( $label );
+                            foreach ( $columns as $key => $label ) {
+                                $key   = esc_attr( $key );
+                                $label = sanitize_text_field( $label );
 
-								echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark'>$label</th>";
-							}
-						?>
+                                echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark'>$label</th>";
+                            }
+                        ?>
 					</tr>
 				</thead>
 
@@ -449,66 +449,66 @@ 
 
 					<?php
 
-						foreach( $payments as $payment ) :
+                        foreach( $payments as $payment ) :
 
-							// Ensure that we have an invoice.
-							$payment = new WPInv_Invoice( $payment );
+                            // Ensure that we have an invoice.
+                            $payment = new WPInv_Invoice( $payment );
 
-							// Abort if the invoice is invalid.
-							if ( ! $payment->get_id() ) {
-								continue;
-							}
+                            // Abort if the invoice is invalid.
+                            if ( ! $payment->get_id() ) {
+                                continue;
+                            }
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									echo '<td class="p-2 text-left">';
+                                    echo '<td class="p-2 text-left">';
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'total':
-												echo '<strong>' . wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $payment->get_total() ) ), $payment->get_currency() ) . '</strong>';
-												break;
+                                            case 'total':
+                                                echo '<strong>' . wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $payment->get_total() ) ), $payment->get_currency() ) . '</strong>';
+                                                break;
 
-											case 'relationship':
-												echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
-												break;
+                                            case 'relationship':
+                                                echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
+                                                break;
 
-											case 'date':
-												echo getpaid_format_date_value( $payment->get_date_created() );
-												break;
+                                            case 'date':
+                                                echo getpaid_format_date_value( $payment->get_date_created() );
+                                                break;
 
-											case 'status':
+                                            case 'status':
 
-												$status = $payment->get_status_nicename();
-												if ( is_admin() ) {
-													$status = $payment->get_status_label_html();
-												}
+                                                $status = $payment->get_status_nicename();
+                                                if ( is_admin() ) {
+                                                    $status = $payment->get_status_label_html();
+                                                }
 
-												echo $status;
-												break;
+                                                echo $status;
+                                                break;
 
-											case 'invoice':
-												$link    = esc_url( get_edit_post_link( $payment->get_id() ) );
+                                            case 'invoice':
+                                                $link    = esc_url( get_edit_post_link( $payment->get_id() ) );
 
-												if ( ! is_admin() ) {
-													$link = esc_url( $payment->get_view_url() );
-												}
+                                                if ( ! is_admin() ) {
+                                                    $link = esc_url( $payment->get_view_url() );
+                                                }
 
-												$invoice = sanitize_text_field( $payment->get_number() );
-												echo "<a href='$link'>$invoice</a>";
-												break;
-										}
+                                                $invoice = sanitize_text_field( $payment->get_number() );
+                                                echo "<a href='$link'>$invoice</a>";
+                                                break;
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 
 				</tbody>
 

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

Indentation +330 added lines, -330 removed lines

@@ -13,72 +13,72 @@ 
 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 from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
 
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+    /**
+     * 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' );
@@ -92,15 +92,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // 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 ) {
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
 
-		return array(
+        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, $data['amount'] );
         }
 
     }
 
     /**
-	 * 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,24 +458,24 @@ 
         }
 
         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() {
 
         // Validate the IPN.
         if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-		    wp_die( 'PayPal IPN Request Failure', 'PayPal IPN', array( 'response' => 500 ) );
-		}
+            wp_die( 'PayPal IPN Request Failure', 'PayPal IPN', array( 'response' => 500 ) );
+        }
 
         // Process the IPN.
         $posted  = wp_unslash( $_POST );
@@ -489,8 +489,8 @@ 
             wpinv_error_log( 'Found invoice #' . $invoice->get_number() );
             wpinv_error_log( 'Payment status:' . $posted['payment_status'] );
 
-			if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-				call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+                call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
             } else {
                 wpinv_error_log( 'Aborting, Invalid type:' . $posted['txn_type'] );
             }
@@ -502,33 +502,33 @@ 
     }
 
     /**
-	 * Check PayPal IPN validity.
-	 */
-	public function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response' );
-
-		// Get received values from post data.
-		$validate_ipn        = wp_unslash( $_POST );
-		$validate_ipn['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $validate_ipn,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
+     * Check PayPal IPN validity.
+     */
+    public function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response' );
+
+        // Get received values from post data.
+        $validate_ipn        = wp_unslash( $_POST );
+        $validate_ipn['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $validate_ipn,
+            '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->is_sandbox() ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->is_sandbox() ? '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'] >= 200 && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+        if ( ! is_wp_error( $response ) && $response['response']['code'] >= 200 && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
             wpinv_error_log( $response['body'], 'Received valid response from PayPal IPN' );
-			return true;
+            return true;
         }
 
         if ( is_wp_error( $response ) ) {
@@ -542,63 +542,63 @@ 
     }
 
     /**
-	 * 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 ) ) {
+     * 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 ) ) {
             wpinv_record_gateway_error( 'IPN Error', "Currencies do not match: {$currency} instead of {$invoice->get_currency()}" );
 
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
-			exit;
-		}
-	}
-
-	/**
-	 * 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: currency code. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            exit;
+        }
+    }
+
+    /**
+     * 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, '.', '' ) ) {
             wpinv_record_gateway_error( 'IPN Error', "Amounts do not match: {$amount} instead of {$invoice->get_total()}" );
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
-			exit;
-		}
-	}
-
-	/**
-	 * 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 ) {
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            exit;
+        }
+    }
+
+    /**
+     * 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 ) {
+        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 ) );
-			exit;
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
+            exit;
         }
 
-	}
+    }
 
     /**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function 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_web_accept( $invoice, $posted ) {
 
         // Collect payment details
         $payment_status = strtolower( $posted['payment_status'] );
@@ -659,27 +659,27 @@ 
         // Process failures.
 
         /* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), wpinv_clean( $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 );
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), wpinv_clean( $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 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 ) {
 
         // Make sure the invoice has a subscription.
         $subscription = wpinv_get_subscription( $invoice );
@@ -718,12 +718,12 @@ 
     }
 
     /**
-	 * 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 );
@@ -766,12 +766,12 @@ 
     }
 
     /**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice, $posted ) {
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice, $posted ) {
 
         if ( $subscription = wpinv_get_subscription( $invoice ) ) {
             $subscription->cancel();
@@ -780,12 +780,12 @@ 
     }
 
     /**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice, $posted ) {
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice, $posted ) {
 
         if ( $subscription = wpinv_get_subscription( $invoice ) ) {
             $subscription->complete();
@@ -794,12 +794,12 @@ 
     }
 
     /**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice, $posted ) {
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice, $posted ) {
 
         if ( $subscription = wpinv_get_subscription( $invoice ) ) {
             $subscription->failing();

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

Indentation +209 added lines, -209 removed lines

@@ -13,58 +13,58 @@ 
 class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'authorizenet';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox', 'tokens' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 4;
 
     /**
-	 * Endpoint for requests from Authorize.net.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to Authorize.net.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from Authorize.net.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to Authorize.net.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'Credit Card / Debit Card', 'invoicing' );
         $this->method_title         = __( 'Authorize.Net', 'invoicing' );
@@ -76,11 +76,11 @@ 
     }
 
     /**
-	 * Displays the payment method select field.
-	 *
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
+     * Displays the payment method select field.
+     *
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
     public function payment_fields( $invoice_id, $form ) {
 
         // Let the user select a payment method.
@@ -91,16 +91,16 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
+     * Creates a customer profile.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Payment profile id.
-	 */
-	public function create_customer_profile( $invoice, $submission_data, $save = true ) {
+     * @return string|WP_Error Payment profile id.
+     */
+    public function create_customer_profile( $invoice, $submission_data, $save = true ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -167,14 +167,14 @@ 
     }
 
     /**
-	 * Retrieves a customer profile.
-	 *
-	 *
-	 * @param string $profile_id profile id.
-	 * @return string|WP_Error Profile id.
+     * Retrieves a customer profile.
+     *
+     *
+     * @param string $profile_id profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile
-	 */
-	public function get_customer_profile( $profile_id ) {
+     */
+    public function get_customer_profile( $profile_id ) {
 
         // Generate args.
         $args = array(
@@ -189,17 +189,17 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
+     * Creates a customer profile.
+     *
+     *
      * @param string $profile_id profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Profile id.
-	 */
-	public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
+     * @return string|WP_Error Profile id.
+     */
+    public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -259,15 +259,15 @@ 
     }
 
     /**
-	 * Retrieves a customer payment profile.
-	 *
-	 *
-	 * @param string $customer_profile_id customer profile id.
+     * Retrieves a customer payment profile.
+     *
+     *
+     * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @return string|WP_Error Profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile
-	 */
-	public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
+     */
+    public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
 
         // Generate args.
         $args = array(
@@ -283,15 +283,15 @@ 
     }
 
     /**
-	 * Charges a customer payment profile.
-	 *
+     * Charges a customer payment profile.
+     *
      * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile
-	 * @return WP_Error|object
-	 */
-	public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
+     * @return WP_Error|object
+     */
+    public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
 
         // Generate args.
         $args = array(
@@ -333,41 +333,41 @@ 
     }
 
     /**
-	 * Processes a customer charge.
-	 *
+     * Processes a customer charge.
+     *
      * @param stdClass $result Api response.
-	 * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function process_charge_response( $result, $invoice ) {
+     * @param WPInv_Invoice $invoice Invoice.
+     */
+    public function process_charge_response( $result, $invoice ) {
 
         wpinv_clear_errors();
-		$response_code = (int) $result->transactionResponse->responseCode;
+        $response_code = (int) $result->transactionResponse->responseCode;
 
-		// Succeeded.
-		if ( 1 == $response_code || 4 == $response_code ) {
+        // Succeeded.
+        if ( 1 == $response_code || 4 == $response_code ) {
 
-			// Maybe set a transaction id.
-			if ( ! empty( $result->transactionResponse->transId ) ) {
-				$invoice->set_transaction_id( $result->transactionResponse->transId );
-			}
+            // Maybe set a transaction id.
+            if ( ! empty( $result->transactionResponse->transId ) ) {
+                $invoice->set_transaction_id( $result->transactionResponse->transId );
+            }
 
-			$invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
+            $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
 
-			if ( 1 == $response_code ) {
-				return $invoice->mark_paid();
-			}
+            if ( 1 == $response_code ) {
+                return $invoice->mark_paid();
+            }
 
-			$invoice->set_status( 'wpi-onhold' );
-        	$invoice->add_note(
+            $invoice->set_status( 'wpi-onhold' );
+            $invoice->add_note(
                 sprintf(
                     __( 'Held for review: %s', 'invoicing' ),
                     $result->transactionResponse->messages->message[0]->description
                 )
-			);
+            );
 
-			return $invoice->save();
+            return $invoice->save();
 
-		}
+        }
 
         wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) );
 
@@ -379,13 +379,13 @@ 
     }
 
     /**
-	 * Returns payment information.
-	 *
-	 *
-	 * @param array $card Card details.
-	 * @return array
-	 */
-	public function get_payment_information( $card ) {
+     * Returns payment information.
+     *
+     *
+     * @param array $card Card details.
+     * @return array
+     */
+    public function get_payment_information( $card ) {
         return array(
 
             'creditCard'         => array (
@@ -398,25 +398,25 @@ 
     }
 
     /**
-	 * Returns the customer profile meta name.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return string
-	 */
-	public function get_customer_profile_meta_name( $invoice ) {
+     * Returns the customer profile meta name.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return string
+     */
+    public function get_customer_profile_meta_name( $invoice ) {
         return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id';
     }
 
     /**
-	 * Validates the submitted data.
-	 *
-	 *
-	 * @param array $submission_data Posted checkout fields.
+     * Validates the submitted data.
+     *
+     *
+     * @param array $submission_data Posted checkout fields.
      * @param WPInv_Invoice $invoice
-	 * @return WP_Error|string The payment profile id
-	 */
-	public function validate_submission_data( $submission_data, $invoice ) {
+     * @return WP_Error|string The payment profile id
+     */
+    public function validate_submission_data( $submission_data, $invoice ) {
 
         // Validate authentication details.
         $auth = $this->get_auth_params();
@@ -448,13 +448,13 @@ 
     }
 
     /**
-	 * Returns invoice line items.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return array
-	 */
-	public function get_line_items( $invoice ) {
+     * Returns invoice line items.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return array
+     */
+    public function get_line_items( $invoice ) {
         $items = array();
 
         foreach ( $invoice->get_items() as $item ) {
@@ -474,15 +474,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Validate the submitted data.
         $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice );
@@ -515,69 +515,69 @@ 
 
         exit;
 
-	}
+    }
 	
-	/**
-	 * Processes the initial payment.
-	 *
+    /**
+     * Processes the initial payment.
+     *
      * @param WPInv_Invoice $invoice Invoice.
-	 */
-	protected function process_initial_payment( $invoice ) {
+     */
+    protected function process_initial_payment( $invoice ) {
 
-		$payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
         $customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
 
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
-			wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
-			wpinv_send_back_to_checkout();
-		}
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
+            wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
+            wpinv_send_back_to_checkout();
+        }
 
-		// Process the response.
-		$this->process_charge_response( $result, $invoice );
+        // Process the response.
+        $this->process_charge_response( $result, $invoice );
 
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout();
-		}
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout();
+        }
 
-	}
+    }
 
     /**
-	 * Processes recurring payments.
-	 *
+     * Processes recurring payments.
+     *
      * @param WPInv_Invoice $invoice Invoice.
      * @param WPInv_Subscription $subscription Subscription.
-	 */
-	public function process_subscription( $invoice, $subscription ) {
+     */
+    public function process_subscription( $invoice, $subscription ) {
 
         // Check if there is an initial amount to charge.
         if ( (float) $invoice->get_total() > 0 ) {
-			$this->process_initial_payment( $invoice );
+            $this->process_initial_payment( $invoice );
         }
 
         // Activate the subscription.
         $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
         $expiry   = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) );
 
-		$subscription->set_next_renewal_date( $expiry );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_profile_id( $invoice->generate_key() );
-		$subscription->activate();
+        $subscription->set_next_renewal_date( $expiry );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_profile_id( $invoice->generate_key() );
+        $subscription->activate();
 
-		// Redirect to the success page.
+        // Redirect to the success page.
         wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
     }
 
-	/**
-	 * (Maybe) renews an authorize.net subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+    /**
+     * (Maybe) renews an authorize.net subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( $this->id != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {
@@ -594,18 +594,18 @@ 
 
         return false;
 
-	}
+    }
 
     /**
-	 * Renews a subscription.
-	 *
+     * Renews a subscription.
+     *
      * @param WPInv_Subscription $subscription
-	 */
-	public function renew_subscription( $subscription ) {
+     */
+    public function renew_subscription( $subscription ) {
 
-		// Generate the renewal invoice.
-		$new_invoice = $subscription->create_payment();
-		$old_invoice = $subscription->get_parent_payment();
+        // Generate the renewal invoice.
+        $new_invoice = $subscription->create_payment();
+        $old_invoice = $subscription->get_parent_payment();
 
         if ( empty( $new_invoice ) ) {
             $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false );
@@ -613,38 +613,38 @@ 
             return;
         }
 
-		// Charge the payment method.
-		$payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
-		$customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
+        // Charge the payment method.
+        $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
 
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
 
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
 
-		}
+        }
 
-		// Process the response.
-		$this->process_charge_response( $result, $new_invoice );
+        // Process the response.
+        $this->process_charge_response( $result, $new_invoice );
 
-		if ( wpinv_get_errors() ) {
+        if ( wpinv_get_errors() ) {
 
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
 
         }
 
@@ -670,11 +670,11 @@ 
     }
 
     /**
-	 * Filters the gateway settings.
-	 *
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
+     * Filters the gateway settings.
+     *
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
 
         $currencies = sprintf(
             __( 'Supported Currencies: %s', 'invoicing' ),
@@ -714,7 +714,7 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
 }