AyeCode / invoicing

includes/wpinv-subscription.php

Indentation +1023 added lines, -1023 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 ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
-			$this->set_id( $subscription_id );
-		} elseif ( ! empty( $subscription->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 ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) {
+            $this->set_id( $subscription_id );
+        } elseif ( ! empty( $subscription->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,57 +177,57 @@ 
 	|
     */
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| 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
@@ -237,484 +237,484 @@ 
         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 );
+    /**
+     * 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 );
+    }
+
+    /**
+     * 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 ) {
+        $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_created().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_date_created( $value ) {
-		$this->set_created( $value );
+    /**
+     * 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 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 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 );
+    }
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
+    /**
+     * 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;
-		}
-
-		$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 = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status();
-		if ( true === $this->object_read && $old_status !== $new_status ) {
-			$this->status_transition = array(
-				'from' => $old_status,
-				'to'   => $new_status,
-			);
-		}
-
-		$this->set_prop( 'status', $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 = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status();
+        if ( true === $this->object_read && $old_status !== $new_status ) {
+            $this->status_transition = array(
+                'from' => $old_status,
+                'to'   => $new_status,
+            );
+        }
+
+        $this->set_prop( 'status', $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
 	|--------------------------------------------------------------------------
@@ -723,55 +723,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( 'timestamp' ) );
-	}
-
-	/**
-	 * 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( 'timestamp' ) );
+    }
+
+    /**
+     * 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
 	|--------------------------------------------------------------------------
@@ -780,27 +780,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
@@ -810,22 +810,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'       => 'ASC',
-            	'post_type'   => 'wpi_invoice',
-			)
-		);
+            array(
+                'post_parent' => $this->get_parent_payment_id(),
+                'numberposts' => -1,
+                'post_status' => $statuses,
+                'orderby'     => 'ID',
+                'order'       => 'ASC',
+                'post_type'   => 'wpi_invoice',
+            )
+        );
     }
 
     /**
@@ -835,7 +835,7 @@ 
      * @return int
      */
     public function get_total_payments() {
-		return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
+        return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
     }
 
     /**
@@ -859,56 +859,56 @@ 
      *
      * @since  2.4
      * @param  array $args Array of values for the payment, including amount and transaction ID
-	 * @param  WPInv_Invoice $invoice If adding an existing invoice.
+     * @param  WPInv_Invoice $invoice If adding an existing invoice.
      * @return bool
      */
     public function add_payment( $args = array(), $invoice = false ) {
 
-		// Process each payment once.
+        // Process each payment once.
         if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
             return false;
         }
 
-		// Are we creating a new invoice?
-		if ( empty( $invoice ) ) {
-			$invoice = $this->create_payment();
+        // Are we creating a new invoice?
+        if ( empty( $invoice ) ) {
+            $invoice = $this->create_payment();
 
-			if ( empty( $invoice ) ) {
-				return false;
-			}
+            if ( empty( $invoice ) ) {
+                return false;
+            }
 }
 
-		$invoice->set_status( 'wpi-renewal' );
+        $invoice->set_status( 'wpi-renewal' );
 
-		// Maybe set a transaction id.
-		if ( ! empty( $args['transaction_id'] ) ) {
-			$invoice->set_transaction_id( $args['transaction_id'] );
-		}
+        // Maybe set a transaction id.
+        if ( ! empty( $args['transaction_id'] ) ) {
+            $invoice->set_transaction_id( $args['transaction_id'] );
+        }
 
-		// Set the completed date.
-		$invoice->set_completed_date( current_time( 'mysql' ) );
+        // Set the completed date.
+        $invoice->set_completed_date( current_time( 'mysql' ) );
 
-		// And the gateway.
-		if ( ! empty( $args['gateway'] ) ) {
-			$invoice->set_gateway( $args['gateway'] );
-		}
+        // And the gateway.
+        if ( ! empty( $args['gateway'] ) ) {
+            $invoice->set_gateway( $args['gateway'] );
+        }
 
-		$invoice->save();
+        $invoice->save();
 
-		if ( ! $invoice->exists() ) {
-			return false;
-		}
+        if ( ! $invoice->exists() ) {
+            return false;
+        }
 
-		do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
-		do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
+        do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
+        do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
         do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() );
 
         update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id );
 
         return $invoice->get_id();
-	}
+    }
 
-	/**
+    /**
      * Creates a new invoice and returns it.
      *
      * @since  1.0.19
@@ -916,124 +916,124 @@ 
      */
     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->set_subscription_id( $this->get_id() );
-		$invoice->set_remote_subscription_id( $this->get_profile_id() );
-
-		// Set invoice items.
-		$subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() );
-		$allowed_items      = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] );
-		$invoice_items      = array();
-
-		foreach ( $invoice->get_items() as $item ) {
-			if ( in_array( $item->get_id(), $allowed_items ) ) {
-				$invoice_items[] = $item;
-			}
-		}
-
-		$invoice->set_items( $invoice_items );
-
-		if ( ! empty( $subscription_group['fees'] ) ) {
-			$invoice->set_fees( $subscription_group['fees'] );
-		}
-
-		// Maybe recalculate discount (Pre-GetPaid Fix).
-		$discount = new WPInv_Discount( $invoice->get_discount_code() );
-		if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) {
-			$invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
-		}
-
-		$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' );
-		$this->save();
-
-		do_action( 'getpaid_subscription_renewed', $this );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * 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->set_subscription_id( $this->get_id() );
+        $invoice->set_remote_subscription_id( $this->get_profile_id() );
+
+        // Set invoice items.
+        $subscription_group = getpaid_get_invoice_subscription_group( $parent_invoice->get_id(), $this->get_id() );
+        $allowed_items      = empty( $subscription_group ) ? array( $this->get_product_id() ) : array_keys( $subscription_group['items'] );
+        $invoice_items      = array();
+
+        foreach ( $invoice->get_items() as $item ) {
+            if ( in_array( $item->get_id(), $allowed_items ) ) {
+                $invoice_items[] = $item;
+            }
+        }
+
+        $invoice->set_items( $invoice_items );
+
+        if ( ! empty( $subscription_group['fees'] ) ) {
+            $invoice->set_fees( $subscription_group['fees'] );
+        }
+
+        // Maybe recalculate discount (Pre-GetPaid Fix).
+        $discount = new WPInv_Discount( $invoice->get_discount_code() );
+        if ( $discount->exists() && $discount->is_recurring() && 0 == $invoice->get_total_discount() ) {
+            $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
+        }
+
+        $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' );
+        $this->save();
+
+        do_action( 'getpaid_subscription_renewed', $this );
+
+        return $this->get_id();
+    }
+
+    /**
+     * 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
@@ -1042,19 +1042,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
@@ -1067,109 +1067,109 @@ 
         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 = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
-		$url = add_query_arg( 'subscription', $this->get_id(), $url );
-
-		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(
+    /**
+     * 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 = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
+        $url = add_query_arg( 'subscription', $this->get_id(), $url );
+
+        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-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(
+        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(),
+                '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() ] : 'badge-dark';
-	}
+        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() ] : 'badge-dark';
+    }
 
     /**
      * Retrieves the subscription status label
@@ -1179,11 +1179,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() );
+        $status_label = sanitize_text_field( $this->get_status_label() );
+        $class        = esc_attr( $this->get_status_class() );
+        $status       = sanitize_html_class( $this->get_status() );
 
-		return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>";
+        return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>";
     }
 
     /**
@@ -1194,75 +1194,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/wpinv-email-functions.php

Indentation +3 added lines, -3 removed lines

@@ -109,8 +109,8 @@ 
     $css = getpaid_get_email_css();
 
     // include css inliner
-	if ( ! class_exists( 'Emogrifier' ) ) {
-		include_once WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php';
+    if ( ! class_exists( 'Emogrifier' ) ) {
+        include_once WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php';
     }
 
     // Inline the css.
@@ -189,7 +189,7 @@ 
     $message = wpinv_email_style_body( $message );
     $to      = array_merge( wpinv_parse_list( $to ), wpinv_parse_list( $cc ) );
 
-	return $mailer->send(
+    return $mailer->send(
         $to,
         $subject,
         $message,

includes/class-wpinv-ajax.php

Indentation +65 added lines, -65 removed lines

@@ -14,70 +14,70 @@ 
 class WPInv_Ajax {
 
     /**
-	 * Hook in ajax handlers.
-	 */
-	public static function init() {
-		add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
-		add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
-		self::add_ajax_events();
+     * Hook in ajax handlers.
+     */
+    public static function init() {
+        add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
+        add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
+        self::add_ajax_events();
     }
 
     /**
-	 * Set GetPaid AJAX constant and headers.
-	 */
-	public static function define_ajax() {
-
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			getpaid_maybe_define_constant( 'DOING_AJAX', true );
-			getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
-			if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
-				/** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
-			}
-			$GLOBALS['wpdb']->hide_errors();
-		}
+     * Set GetPaid AJAX constant and headers.
+     */
+    public static function define_ajax() {
+
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            getpaid_maybe_define_constant( 'DOING_AJAX', true );
+            getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
+            if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
+                /** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
+            }
+            $GLOBALS['wpdb']->hide_errors();
+        }
 
     }
 
     /**
-	 * Send headers for GetPaid Ajax Requests.
-	 *
-	 * @since 1.0.18
-	 */
-	private static function wpinv_ajax_headers() {
-		if ( ! headers_sent() ) {
-			send_origin_headers();
-			send_nosniff_header();
-			nocache_headers();
-			header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
-			header( 'X-Robots-Tag: noindex' );
-			status_header( 200 );
-		}
+     * Send headers for GetPaid Ajax Requests.
+     *
+     * @since 1.0.18
+     */
+    private static function wpinv_ajax_headers() {
+        if ( ! headers_sent() ) {
+            send_origin_headers();
+            send_nosniff_header();
+            nocache_headers();
+            header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
+            header( 'X-Robots-Tag: noindex' );
+            status_header( 200 );
+        }
     }
 
     /**
-	 * Check for GetPaid Ajax request and fire action.
-	 */
-	public static function do_wpinv_ajax() {
-		global $wp_query;
+     * Check for GetPaid Ajax request and fire action.
+     */
+    public static function do_wpinv_ajax() {
+        global $wp_query;
 
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			$wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
-		}
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            $wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
+        }
 
-		$action = $wp_query->get( 'wpinv-ajax' );
+        $action = $wp_query->get( 'wpinv-ajax' );
 
-		if ( $action ) {
-			self::wpinv_ajax_headers();
-			$action = sanitize_text_field( $action );
-			do_action( 'wpinv_ajax_' . $action );
-			wp_die();
-		}
+        if ( $action ) {
+            self::wpinv_ajax_headers();
+            $action = sanitize_text_field( $action );
+            do_action( 'wpinv_ajax_' . $action );
+            wp_die();
+        }
 
     }
 
     /**
-	 * Hook in ajax methods.
-	 */
+     * Hook in ajax methods.
+     */
     public static function add_ajax_events() {
 
         // array( 'event' => is_frontend )
@@ -261,18 +261,18 @@ 
         check_ajax_referer( 'getpaid_form_nonce' );
 
         // Is the request set up correctly?
-		if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) && empty( $_GET['invoice'] ) ) {
-			echo aui()->alert(
-				array(
-					'type'    => 'warning',
-					'content' => __( 'No payment form or item provided', 'invoicing' ),
-				)
+        if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) && empty( $_GET['invoice'] ) ) {
+            echo aui()->alert(
+                array(
+                    'type'    => 'warning',
+                    'content' => __( 'No payment form or item provided', 'invoicing' ),
+                )
             );
             exit;
         }
 
         // Payment form or button?
-		if ( ! empty( $_GET['form'] ) ) {
+        if ( ! empty( $_GET['form'] ) ) {
             $form = sanitize_text_field( urldecode( $_GET['form'] ) );
 
             if ( false !== strpos( $form, '|' ) ) {
@@ -325,10 +325,10 @@ 
                 getpaid_display_payment_form( $form );
             }
 } elseif ( ! empty( $_GET['invoice'] ) ) {
-		    getpaid_display_invoice_payment_form( (int) urldecode( $_GET['invoice'] ) );
+            getpaid_display_invoice_payment_form( (int) urldecode( $_GET['invoice'] ) );
         } else {
-			$items = getpaid_convert_items_to_array( sanitize_text_field( urldecode( $_GET['item'] ) ) );
-		    getpaid_display_item_payment_form( $items );
+            $items = getpaid_convert_items_to_array( sanitize_text_field( urldecode( $_GET['item'] ) ) );
+            getpaid_display_item_payment_form( $items );
         }
 
         exit;
@@ -648,7 +648,7 @@ 
         if ( is_wp_error( $error ) ) {
             $alert = $error->get_error_message();
             wp_send_json_success( compact( 'alert' ) );
-         }
+            }
 
         // Update totals.
         $invoice->recalculate_total();
@@ -1083,12 +1083,12 @@ 
     }
 
     /**
-	 * Handles file uploads.
-	 *
-	 * @since       1.0.0
-	 * @return      void
-	 */
-	public static function file_upload() {
+     * Handles file uploads.
+     *
+     * @since       1.0.0
+     * @return      void
+     */
+    public static function file_upload() {
 
         // Check nonce.
         check_ajax_referer( 'getpaid_form_nonce' );
@@ -1149,7 +1149,7 @@ 
 
         wp_send_json_success( $response );
 
-	}
+    }
 
 }
 

includes/class-wpinv-notes.php

Indentation +191 added lines, -191 removed lines

@@ -12,207 +12,207 @@
  */
 class WPInv_Notes {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Filter inovice notes.
-		add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
-		add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
-
-		// Delete comments count cache whenever there is a new comment or a comment status changes.
-		add_action( 'wp_insert_comment', array( $this, 'delete_comments_count_cache' ) );
-		add_action( 'wp_set_comment_status', array( $this, 'delete_comments_count_cache' ) );
-
-		// Count comments.
-		add_filter( 'wp_count_comments', array( $this, 'wp_count_comments' ), 100, 2 );
-
-		// Fires after notes are loaded.
-		do_action( 'wpinv_notes_init', $this );
-	}
-
-	/**
-	 * Filters invoice notes query to only include our notes.
-	 *
-	 * @param WP_Comment_Query $query
-	 */
-	public function set_invoice_note_type( $query ) {
-		$post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
-
-		if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
-			$query->query_vars['type'] = 'wpinv_note';
-		} else {
-
-			if ( empty( $query->query_vars['type__not_in'] ) ) {
-				$query->query_vars['type__not_in'] = array();
-			}
-
-			$query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
-			$query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
-		}
-
-		return $query;
-	}
-
-	/**
-	 * Exclude notes from the comments feed.
-	 */
-	function wpinv_comment_feed_where( $where ) {
-		return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
-	}
-
-	/**
-	 * Delete comments count cache whenever there is
-	 * new comment or the status of a comment changes. Cache
-	 * will be regenerated next time WPInv_Notes::wp_count_comments()
-	 * is called.
-	 */
-	public function delete_comments_count_cache() {
-		delete_transient( 'getpaid_count_comments' );
-	}
-
-	/**
-	 * Remove invoice notes from wp_count_comments().
-	 *
-	 * @since  2.2
-	 * @param  object $stats   Comment stats.
-	 * @param  int    $post_id Post ID.
-	 * @return object
-	 */
-	public function wp_count_comments( $stats, $post_id ) {
-		global $wpdb;
-
-		if ( empty( $post_id ) ) {
-			$stats = get_transient( 'getpaid_count_comments' );
-
-			if ( ! $stats ) {
-				$stats = array(
-					'total_comments' => 0,
-					'all'            => 0,
-				);
-
-				$count = $wpdb->get_results(
-					"
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Filter inovice notes.
+        add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
+        add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
+
+        // Delete comments count cache whenever there is a new comment or a comment status changes.
+        add_action( 'wp_insert_comment', array( $this, 'delete_comments_count_cache' ) );
+        add_action( 'wp_set_comment_status', array( $this, 'delete_comments_count_cache' ) );
+
+        // Count comments.
+        add_filter( 'wp_count_comments', array( $this, 'wp_count_comments' ), 100, 2 );
+
+        // Fires after notes are loaded.
+        do_action( 'wpinv_notes_init', $this );
+    }
+
+    /**
+     * Filters invoice notes query to only include our notes.
+     *
+     * @param WP_Comment_Query $query
+     */
+    public function set_invoice_note_type( $query ) {
+        $post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
+
+        if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
+            $query->query_vars['type'] = 'wpinv_note';
+        } else {
+
+            if ( empty( $query->query_vars['type__not_in'] ) ) {
+                $query->query_vars['type__not_in'] = array();
+            }
+
+            $query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
+            $query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
+        }
+
+        return $query;
+    }
+
+    /**
+     * Exclude notes from the comments feed.
+     */
+    function wpinv_comment_feed_where( $where ) {
+        return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
+    }
+
+    /**
+     * Delete comments count cache whenever there is
+     * new comment or the status of a comment changes. Cache
+     * will be regenerated next time WPInv_Notes::wp_count_comments()
+     * is called.
+     */
+    public function delete_comments_count_cache() {
+        delete_transient( 'getpaid_count_comments' );
+    }
+
+    /**
+     * Remove invoice notes from wp_count_comments().
+     *
+     * @since  2.2
+     * @param  object $stats   Comment stats.
+     * @param  int    $post_id Post ID.
+     * @return object
+     */
+    public function wp_count_comments( $stats, $post_id ) {
+        global $wpdb;
+
+        if ( empty( $post_id ) ) {
+            $stats = get_transient( 'getpaid_count_comments' );
+
+            if ( ! $stats ) {
+                $stats = array(
+                    'total_comments' => 0,
+                    'all'            => 0,
+                );
+
+                $count = $wpdb->get_results(
+                    "
 					SELECT comment_approved, COUNT(*) AS num_comments
 					FROM {$wpdb->comments}
 					WHERE comment_type NOT IN ('action_log', 'order_note', 'webhook_delivery', 'wpinv_note')
 					GROUP BY comment_approved
 					",
-					ARRAY_A
-				);
-
-				$approved = array(
-					'0'            => 'moderated',
-					'1'            => 'approved',
-					'spam'         => 'spam',
-					'trash'        => 'trash',
-					'post-trashed' => 'post-trashed',
-				);
-
-				foreach ( (array) $count as $row ) {
-					// Don't count post-trashed toward totals.
-					if ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash', 'spam' ), true ) ) {
-						$stats['all']            += $row['num_comments'];
-						$stats['total_comments'] += $row['num_comments'];
-					} elseif ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash' ), true ) ) {
-						$stats['total_comments'] += $row['num_comments'];
-					}
-					if ( isset( $approved[ $row['comment_approved'] ] ) ) {
-						$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
-					}
-				}
-
-				foreach ( $approved as $key ) {
-					if ( empty( $stats[ $key ] ) ) {
-						$stats[ $key ] = 0;
-					}
-				}
-
-				$stats = (object) $stats;
-				set_transient( 'getpaid_count_comments', $stats );
-			}
+                    ARRAY_A
+                );
+
+                $approved = array(
+                    '0'            => 'moderated',
+                    '1'            => 'approved',
+                    'spam'         => 'spam',
+                    'trash'        => 'trash',
+                    'post-trashed' => 'post-trashed',
+                );
+
+                foreach ( (array) $count as $row ) {
+                    // Don't count post-trashed toward totals.
+                    if ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash', 'spam' ), true ) ) {
+                        $stats['all']            += $row['num_comments'];
+                        $stats['total_comments'] += $row['num_comments'];
+                    } elseif ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash' ), true ) ) {
+                        $stats['total_comments'] += $row['num_comments'];
+                    }
+                    if ( isset( $approved[ $row['comment_approved'] ] ) ) {
+                        $stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
+                    }
+                }
+
+                foreach ( $approved as $key ) {
+                    if ( empty( $stats[ $key ] ) ) {
+                        $stats[ $key ] = 0;
+                    }
+                }
+
+                $stats = (object) $stats;
+                set_transient( 'getpaid_count_comments', $stats );
+            }
 }
 
-		return $stats;
-	}
-
-	/**
-	 * Returns an array of invoice notes.
-	 *
-	 * @param int $invoice_id The invoice ID whose notes to retrieve.
-	 * @param string $type Optional. Pass in customer to only return customer notes.
-	 * @return WP_Comment[]
-	 */
-	public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
-
-		// Default comment args.
-		$args = array(
-			'post_id' => $invoice_id,
-			'orderby' => 'comment_ID',
-			'order'   => 'ASC',
-		);
-
-		// Maybe only show customer comments.
-		if ( $type == 'customer' ) {
-			$args['meta_key']   = '_wpi_customer_note';
-			$args['meta_value'] = 1;
-		}
-
-		$args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
-
-		return get_comments( $args );
-	}
-
-	/**
-	 * Saves an invoice comment.
-	 *
-	 * @param WPInv_Invoice $invoice The invoice to add the comment to.
-	 * @param string $note The note content.
-	 * @param string $note_author The name of the author of the note.
-	 * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
-	 * @return int|false The new note's ID on success, false on failure.
-	 */
-	function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ) {
-
-		do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
-
-		/**
-		 * Insert the comment.
-		 */
-		$note_id = wp_insert_comment(
-			wp_filter_comment(
-				array(
-					'comment_post_ID'      => $invoice->get_id(),
-					'comment_content'      => $note,
-					'comment_agent'        => 'Invoicing',
-					'user_id'              => get_current_user_id(),
-					'comment_author'       => $note_author,
-					'comment_author_IP'    => wpinv_get_ip(),
-					'comment_author_email' => $author_email,
-					'comment_author_url'   => $invoice->get_view_url(),
-					'comment_type'         => 'wpinv_note',
-				)
-			)
-		);
-
-		do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
-
-		// Are we notifying the customer?
-		if ( empty( $note_id ) || empty( $for_customer ) ) {
-			return $note_id;
-		}
-
-		add_comment_meta( $note_id, '_wpi_customer_note', 1 );
-		do_action(
+        return $stats;
+    }
+
+    /**
+     * Returns an array of invoice notes.
+     *
+     * @param int $invoice_id The invoice ID whose notes to retrieve.
+     * @param string $type Optional. Pass in customer to only return customer notes.
+     * @return WP_Comment[]
+     */
+    public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
+
+        // Default comment args.
+        $args = array(
+            'post_id' => $invoice_id,
+            'orderby' => 'comment_ID',
+            'order'   => 'ASC',
+        );
+
+        // Maybe only show customer comments.
+        if ( $type == 'customer' ) {
+            $args['meta_key']   = '_wpi_customer_note';
+            $args['meta_value'] = 1;
+        }
+
+        $args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
+
+        return get_comments( $args );
+    }
+
+    /**
+     * Saves an invoice comment.
+     *
+     * @param WPInv_Invoice $invoice The invoice to add the comment to.
+     * @param string $note The note content.
+     * @param string $note_author The name of the author of the note.
+     * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
+     * @return int|false The new note's ID on success, false on failure.
+     */
+    function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ) {
+
+        do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
+
+        /**
+         * Insert the comment.
+         */
+        $note_id = wp_insert_comment(
+            wp_filter_comment(
+                array(
+                    'comment_post_ID'      => $invoice->get_id(),
+                    'comment_content'      => $note,
+                    'comment_agent'        => 'Invoicing',
+                    'user_id'              => get_current_user_id(),
+                    'comment_author'       => $note_author,
+                    'comment_author_IP'    => wpinv_get_ip(),
+                    'comment_author_email' => $author_email,
+                    'comment_author_url'   => $invoice->get_view_url(),
+                    'comment_type'         => 'wpinv_note',
+                )
+            )
+        );
+
+        do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
+
+        // Are we notifying the customer?
+        if ( empty( $note_id ) || empty( $for_customer ) ) {
+            return $note_id;
+        }
+
+        add_comment_meta( $note_id, '_wpi_customer_note', 1 );
+        do_action(
             'wpinv_new_customer_note',
             array(
-				'invoice_id' => $invoice->get_id(),
-				'user_note'  => $note,
+                'invoice_id' => $invoice->get_id(),
+                'user_note'  => $note,
             )
         );
-		do_action( 'getpaid_new_customer_note', $invoice, $note );
-		return $note_id;
-	}
+        do_action( 'getpaid_new_customer_note', $invoice, $note );
+        return $note_id;
+    }
 
 }

includes/class-bp-getpaid-component.php

Indentation +132 added lines, -132 removed lines

@@ -17,45 +17,45 @@ 
  */
 class BP_GetPaid_Component extends BP_Component {
 
-	/**
-	 * Start the component setup process.
-	 *
-	 * @since 2.1.5
-	 */
-	public function __construct() {
-		parent::start(
-			'getpaid',
-			'GetPaid',
-			buddypress()->plugin_dir,
-			array(
-				'adminbar_myaccount_order' => 30,
-			)
-		);
-	}
+    /**
+     * Start the component setup process.
+     *
+     * @since 2.1.5
+     */
+    public function __construct() {
+        parent::start(
+            'getpaid',
+            'GetPaid',
+            buddypress()->plugin_dir,
+            array(
+                'adminbar_myaccount_order' => 30,
+            )
+        );
+    }
 
     /**
-	 * Set up component global variables.
-	 *
-	 * @since 2.1.5
-	 *
-	 *
-	 * @param array $args {
-	 *     All values are optional.
-	 *     @type string   $slug                  The component slug. Used to construct certain URLs, such as 'friends' in
-	 *                                           http://example.com/members/joe/friends/. Default: the value of $this->id.
-	 *     @type string   $root_slug             The component root slug. Note that this value is generally unused if the
-	 *                                           component has a root directory (the slug will be overridden by the
-	 *                                           post_name of the directory page). Default: the slug of the directory page
-	 *                                           if one is found, otherwise an empty string.
-	 *     @type bool     $has_directory         Set to true if the component requires an associated WordPress page.
-	 *     @type callable $notification_callback Optional. The callable function that formats the component's notifications.
-	 *     @type string   $search_term           Optional. The placeholder text in the component directory search box. Eg,
-	 *                                           'Search Groups...'.
-	 *     @type array    $global_tables         Optional. An array of database table names.
-	 *     @type array    $meta_tables           Optional. An array of metadata table names.
-	 * }
-	 */
-	public function setup_globals( $args = array() ) {
+     * Set up component global variables.
+     *
+     * @since 2.1.5
+     *
+     *
+     * @param array $args {
+     *     All values are optional.
+     *     @type string   $slug                  The component slug. Used to construct certain URLs, such as 'friends' in
+     *                                           http://example.com/members/joe/friends/. Default: the value of $this->id.
+     *     @type string   $root_slug             The component root slug. Note that this value is generally unused if the
+     *                                           component has a root directory (the slug will be overridden by the
+     *                                           post_name of the directory page). Default: the slug of the directory page
+     *                                           if one is found, otherwise an empty string.
+     *     @type bool     $has_directory         Set to true if the component requires an associated WordPress page.
+     *     @type callable $notification_callback Optional. The callable function that formats the component's notifications.
+     *     @type string   $search_term           Optional. The placeholder text in the component directory search box. Eg,
+     *                                           'Search Groups...'.
+     *     @type array    $global_tables         Optional. An array of database table names.
+     *     @type array    $meta_tables           Optional. An array of metadata table names.
+     * }
+     */
+    public function setup_globals( $args = array() ) {
         parent::setup_globals(
             array(
                 'id'            => 'getpaid',
@@ -64,21 +64,21 @@ 
                 'has_directory' => false,
             )
         );
-	}
-
-	/**
-	 * Set up component navigation.
-	 *
-	 * @since 2.1.5
-	 *
-	 * @see BP_Component::setup_nav() for a description of arguments.
-	 *
-	 * @param array $main_nav Optional. See BP_Component::setup_nav() for description.
-	 * @param array $sub_nav  Optional. See BP_Component::setup_nav() for description.
-	 */
-	public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
-
-		// Abort if the integration is inactive.
+    }
+
+    /**
+     * Set up component navigation.
+     *
+     * @since 2.1.5
+     *
+     * @see BP_Component::setup_nav() for a description of arguments.
+     *
+     * @param array $main_nav Optional. See BP_Component::setup_nav() for description.
+     * @param array $sub_nav  Optional. See BP_Component::setup_nav() for description.
+     */
+    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
+
+        // Abort if the integration is inactive.
         if ( ! getpaid_is_buddypress_integration_active() || ! is_user_logged_in() ) {
             return;
         }
@@ -88,25 +88,25 @@ 
             return;
         }
 
-		// Determine user to use.
-		$user_domain   = bp_loggedin_user_domain();
-		$slug          = 'getpaid';
-		$payments_link = trailingslashit( $user_domain . $slug );
-
-		// Add 'Payments' to the main navigation.
-		$main_nav = array(
-			'name'                    => _x( 'Billing', 'BuddyPress profile payments screen nav', 'invoicing' ),
-			'slug'                    => $slug,
-			'position'                => apply_filters( 'wpinv_bp_nav_position', wpinv_get_option( 'wpinv_menu_position', 91 ), $slug ),
-			'screen_function'         => array( $this, 'display_current_tab' ),
-			'default_subnav_slug'     => apply_filters( 'getpaid_default_tab', 'gp-edit-address' ),
+        // Determine user to use.
+        $user_domain   = bp_loggedin_user_domain();
+        $slug          = 'getpaid';
+        $payments_link = trailingslashit( $user_domain . $slug );
+
+        // Add 'Payments' to the main navigation.
+        $main_nav = array(
+            'name'                    => _x( 'Billing', 'BuddyPress profile payments screen nav', 'invoicing' ),
+            'slug'                    => $slug,
+            'position'                => apply_filters( 'wpinv_bp_nav_position', wpinv_get_option( 'wpinv_menu_position', 91 ), $slug ),
+            'screen_function'         => array( $this, 'display_current_tab' ),
+            'default_subnav_slug'     => apply_filters( 'getpaid_default_tab', 'gp-edit-address' ),
             'show_for_displayed_user' => false,
-			'item_css_id'             => $this->id,
-			'parent_url'              => $user_domain,
-			'parent_slug'             => buddypress()->slug,
-		);
+            'item_css_id'             => $this->id,
+            'parent_url'              => $user_domain,
+            'parent_slug'             => buddypress()->slug,
+        );
 
-		// Add the subnav items to the payments nav item if we are using a theme that supports this.
+        // Add the subnav items to the payments nav item if we are using a theme that supports this.
         foreach ( getpaid_get_user_content_tabs() as $_slug => $tab ) {
 
             $sub_nav[] = array(
@@ -116,8 +116,8 @@ 
                 'parent_slug'             => $slug,
                 'position'                => 10,
                 'screen_function'         => function() use ( $tab ) {
-					$GLOBALS['getpaid_bp_current_tab'] = $tab;
-					$this->display_current_tab();
+                    $GLOBALS['getpaid_bp_current_tab'] = $tab;
+                    $this->display_current_tab();
                 },
                 'show_for_displayed_user' => false,
                 'item_css_id'             => "getpaid-bp-$_slug",
@@ -125,27 +125,27 @@ 
 
         }
 
-		parent::setup_nav( $main_nav, $sub_nav );
-	}
-
-	/**
-	 * Set up the component entries in the WordPress Admin Bar.
-	 *
-	 * @since 2.1.5
-	 *
-	 * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
-	 *      parameter array.
-	 *
-	 * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
-	 *                            description.
-	 */
-	public function setup_admin_bar( $wp_admin_nav = array() ) {
+        parent::setup_nav( $main_nav, $sub_nav );
+    }
 
-		// Menus for logged in user.
-		if ( is_user_logged_in() ) {
-
-			// Setup the logged in user variables.
-			$payments_link = trailingslashit( bp_loggedin_user_domain() . 'getpaid/' );
+    /**
+     * Set up the component entries in the WordPress Admin Bar.
+     *
+     * @since 2.1.5
+     *
+     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
+     *      parameter array.
+     *
+     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
+     *                            description.
+     */
+    public function setup_admin_bar( $wp_admin_nav = array() ) {
+
+        // Menus for logged in user.
+        if ( is_user_logged_in() ) {
+
+            // Setup the logged in user variables.
+            $payments_link = trailingslashit( bp_loggedin_user_domain() . 'getpaid/' );
 
             // Add the "Payments" sub menu.
             $wp_admin_nav[] = array(
@@ -168,48 +168,48 @@ 
             }
 }
 
-		parent::setup_admin_bar( $wp_admin_nav );
-	}
-
-	/**
-	 * Retrieves the current tab.
-	 *
-	 * @since 2.1.5
-	 */
-	public function get_current_tab() {
-		global $getpaid_bp_current_tab;
-
-		if ( empty( $getpaid_bp_current_tab ) ) {
-			return array(
-				'label'   => __( 'Invoices', 'invoicing' ),
-				'content' => '[wpinv_history]',
-				'icon'    => 'fas fa-file-invoice',
-			);
-		}
-
-		return $getpaid_bp_current_tab;
-	}
-
-	/**
-	 * Displays the current tab.
-	 *
-	 * @since 2.1.5
-	 */
-	public function display_current_tab() {
-
-		add_action( 'bp_template_content', array( $this, 'handle_display_current_tab' ) );
-		$template = apply_filters( 'bp_core_template_plugin', 'members/single/plugins' );
+        parent::setup_admin_bar( $wp_admin_nav );
+    }
+
+    /**
+     * Retrieves the current tab.
+     *
+     * @since 2.1.5
+     */
+    public function get_current_tab() {
+        global $getpaid_bp_current_tab;
+
+        if ( empty( $getpaid_bp_current_tab ) ) {
+            return array(
+                'label'   => __( 'Invoices', 'invoicing' ),
+                'content' => '[wpinv_history]',
+                'icon'    => 'fas fa-file-invoice',
+            );
+        }
+
+        return $getpaid_bp_current_tab;
+    }
+
+    /**
+     * Displays the current tab.
+     *
+     * @since 2.1.5
+     */
+    public function display_current_tab() {
+
+        add_action( 'bp_template_content', array( $this, 'handle_display_current_tab' ) );
+        $template = apply_filters( 'bp_core_template_plugin', 'members/single/plugins' );
 
         bp_core_load_template( apply_filters( 'wpinv_bp_core_template_plugin', $template ) );
-	}
-
-	/**
-	 * Handles the actual display of the current tab.
-	 *
-	 * @since 2.1.5
-	 */
-	public function handle_display_current_tab() {
-		 getpaid_prepare_user_content_tab( $this->get_current_tab() );
-	}
+    }
+
+    /**
+     * Handles the actual display of the current tab.
+     *
+     * @since 2.1.5
+     */
+    public function handle_display_current_tab() {
+            getpaid_prepare_user_content_tab( $this->get_current_tab() );
+    }
 
 }

includes/wpinv-template-functions.php

Indentation +138 added lines, -138 removed lines

@@ -140,7 +140,7 @@ 
  * @param string $default_path The root path to the default template. Defaults to invoicing/templates
  */
 function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
-	return getpaid_template()->get_template( $template_name, $args, $template_path, $default_path );
+    return getpaid_template()->get_template( $template_name, $args, $template_path, $default_path );
 }
 
 /**
@@ -158,7 +158,7 @@ 
  * @return string
  */
 function wpinv_get_theme_template_dir_name() {
-	return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
+    return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
 }
 
 /**
@@ -175,125 +175,125 @@ 
 }
 
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
-	do_action( 'get_template_part_' . $slug, $slug, $name );
+    do_action( 'get_template_part_' . $slug, $slug, $name );
 
-	// Setup possible parts
-	$templates = array();
-	if ( isset( $name ) ) {
-		$templates[] = $slug . '-' . $name . '.php';
+    // Setup possible parts
+    $templates = array();
+    if ( isset( $name ) ) {
+        $templates[] = $slug . '-' . $name . '.php';
     }
-	$templates[] = $slug . '.php';
+    $templates[] = $slug . '.php';
 
-	// Allow template parts to be filtered
-	$templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
+    // Allow template parts to be filtered
+    $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
 
-	// Return the part that is found
-	return wpinv_locate_tmpl( $templates, $load, false );
+    // Return the part that is found
+    return wpinv_locate_tmpl( $templates, $load, false );
 }
 
 function wpinv_locate_tmpl( $template_names, $load = false, $require_once = true ) {
-	// No file found yet
-	$located = false;
+    // No file found yet
+    $located = false;
 
-	// Try to find a template file
-	foreach ( (array)$template_names as $template_name ) {
+    // Try to find a template file
+    foreach ( (array)$template_names as $template_name ) {
 
-		// Continue if template is empty
-		if ( empty( $template_name ) ) {
-			continue;
+        // Continue if template is empty
+        if ( empty( $template_name ) ) {
+            continue;
         }
 
-		// Trim off any slashes from the template name
-		$template_name = ltrim( $template_name, '/' );
+        // Trim off any slashes from the template name
+        $template_name = ltrim( $template_name, '/' );
 
-		// try locating this template file by looping through the template paths
-		foreach ( wpinv_get_theme_template_paths() as $template_path ) {
+        // try locating this template file by looping through the template paths
+        foreach ( wpinv_get_theme_template_paths() as $template_path ) {
 
-			if ( file_exists( $template_path . $template_name ) ) {
-				$located = $template_path . $template_name;
-				break;
-			}
-		}
+            if ( file_exists( $template_path . $template_name ) ) {
+                $located = $template_path . $template_name;
+                break;
+            }
+        }
 
-		if ( ! empty( $located ) ) {
-			break;
-		}
-	}
+        if ( ! empty( $located ) ) {
+            break;
+        }
+    }
 
-	if ( ( true == $load ) && ! empty( $located ) ) {
-		load_template( $located, $require_once );
+    if ( ( true == $load ) && ! empty( $located ) ) {
+        load_template( $located, $require_once );
     }
 
-	return $located;
+    return $located;
 }
 
 function wpinv_get_theme_template_paths() {
-	$template_dir = wpinv_get_theme_template_dir_name();
+    $template_dir = wpinv_get_theme_template_dir_name();
 
-	$file_paths = array(
-		1   => trailingslashit( get_stylesheet_directory() ) . $template_dir,
-		10  => trailingslashit( get_template_directory() ) . $template_dir,
-		100 => wpinv_get_templates_dir(),
-	);
+    $file_paths = array(
+        1   => trailingslashit( get_stylesheet_directory() ) . $template_dir,
+        10  => trailingslashit( get_template_directory() ) . $template_dir,
+        100 => wpinv_get_templates_dir(),
+    );
 
-	$file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
+    $file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
 
-	// sort the file paths based on priority
-	ksort( $file_paths, SORT_NUMERIC );
+    // sort the file paths based on priority
+    ksort( $file_paths, SORT_NUMERIC );
 
-	return array_map( 'trailingslashit', $file_paths );
+    return array_map( 'trailingslashit', $file_paths );
 }
 
 function wpinv_checkout_meta_tags() {
 
-	$pages   = array();
-	$pages[] = wpinv_get_option( 'success_page' );
-	$pages[] = wpinv_get_option( 'failure_page' );
-	$pages[] = wpinv_get_option( 'invoice_history_page' );
-	$pages[] = wpinv_get_option( 'invoice_subscription_page' );
+    $pages   = array();
+    $pages[] = wpinv_get_option( 'success_page' );
+    $pages[] = wpinv_get_option( 'failure_page' );
+    $pages[] = wpinv_get_option( 'invoice_history_page' );
+    $pages[] = wpinv_get_option( 'invoice_subscription_page' );
 
-	if ( ! wpinv_is_checkout() && ! is_page( $pages ) ) {
-		return;
-	}
+    if ( ! wpinv_is_checkout() && ! is_page( $pages ) ) {
+        return;
+    }
 
-	echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
+    echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
 }
 add_action( 'wp_head', 'wpinv_checkout_meta_tags' );
 
 function wpinv_add_body_classes( $class ) {
-	$classes = (array)$class;
+    $classes = (array)$class;
 
-	if ( wpinv_is_checkout() ) {
-		$classes[] = 'wpinv-checkout';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_checkout() ) {
+        $classes[] = 'wpinv-checkout';
+        $classes[] = 'wpinv-page';
+    }
 
-	if ( wpinv_is_success_page() ) {
-		$classes[] = 'wpinv-success';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_success_page() ) {
+        $classes[] = 'wpinv-success';
+        $classes[] = 'wpinv-page';
+    }
 
-	if ( wpinv_is_failed_transaction_page() ) {
-		$classes[] = 'wpinv-failed-transaction';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_failed_transaction_page() ) {
+        $classes[] = 'wpinv-failed-transaction';
+        $classes[] = 'wpinv-page';
+    }
 
-	if ( wpinv_is_invoice_history_page() ) {
-		$classes[] = 'wpinv-history';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_invoice_history_page() ) {
+        $classes[] = 'wpinv-history';
+        $classes[] = 'wpinv-page';
+    }
 
-	if ( wpinv_is_subscriptions_history_page() ) {
-		$classes[] = 'wpinv-subscription';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_subscriptions_history_page() ) {
+        $classes[] = 'wpinv-subscription';
+        $classes[] = 'wpinv-page';
+    }
 
-	if ( wpinv_is_test_mode() ) {
-		$classes[] = 'wpinv-test-mode';
-		$classes[] = 'wpinv-page';
-	}
+    if ( wpinv_is_test_mode() ) {
+        $classes[] = 'wpinv-test-mode';
+        $classes[] = 'wpinv-page';
+    }
 
-	return array_unique( $classes );
+    return array_unique( $classes );
 }
 add_filter( 'body_class', 'wpinv_add_body_classes' );
 
@@ -311,11 +311,11 @@ 
 
     $output = wpinv_html_select(
         array(
-			'name'             => $name,
-			'selected'         => $selected,
-			'options'          => $options,
-			'show_option_all'  => false,
-			'show_option_none' => false,
+            'name'             => $name,
+            'selected'         => $selected,
+            'options'          => $options,
+            'show_option_all'  => false,
+            'show_option_none' => false,
         )
     );
 
@@ -344,11 +344,11 @@ 
 
     $output = wpinv_html_select(
         array(
-			'name'             => $name,
-			'selected'         => $selected,
-			'options'          => $options,
-			'show_option_all'  => false,
-			'show_option_none' => false,
+            'name'             => $name,
+            'selected'         => $selected,
+            'options'          => $options,
+            'show_option_all'  => false,
+            'show_option_none' => false,
         )
     );
 
@@ -512,16 +512,16 @@ 
 
     $output = wpinv_html_select(
         array(
-			'name'             => $args['name'],
-			'selected'         => $args['selected'],
-			'id'               => $args['id'],
-			'class'            => $args['class'],
-			'options'          => $options,
-			'multiple'         => $args['multiple'],
-			'placeholder'      => $args['placeholder'],
-			'show_option_all'  => $args['show_option_all'],
-			'show_option_none' => $args['show_option_none'],
-			'data'             => $args['data'],
+            'name'             => $args['name'],
+            'selected'         => $args['selected'],
+            'id'               => $args['id'],
+            'class'            => $args['class'],
+            'options'          => $options,
+            'multiple'         => $args['multiple'],
+            'placeholder'      => $args['placeholder'],
+            'show_option_all'  => $args['show_option_all'],
+            'show_option_none' => $args['show_option_none'],
+            'data'             => $args['data'],
         )
     );
 
@@ -822,21 +822,21 @@ 
 
     $formatted_address = str_ireplace( array_keys( $replacements ), $replacements, $format );
 
-	// Remove unavailable tags.
+    // Remove unavailable tags.
     $formatted_address = preg_replace( '/\{\{\w+\}\}/', '', $formatted_address );
 
     // Clean up white space.
-	$formatted_address = preg_replace( '/  +/', ' ', trim( $formatted_address ) );
+    $formatted_address = preg_replace( '/  +/', ' ', trim( $formatted_address ) );
     $formatted_address = preg_replace( '/\n\n+/', "\n", $formatted_address );
 
     // Break newlines apart and remove empty lines/trim commas and white space.
-	$formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) );
+    $formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) );
 
     // Add html breaks.
-	$formatted_address = implode( $separator, $formatted_address );
+    $formatted_address = implode( $separator, $formatted_address );
 
-	// We're done!
-	return $formatted_address;
+    // We're done!
+    return $formatted_address;
 
 }
 
@@ -882,7 +882,7 @@ 
 function getpaid_display_invoice_subscriptions( $invoice ) {
 
     // Subscriptions.
-	$subscriptions = getpaid_get_invoice_subscriptions( $invoice );
+    $subscriptions = getpaid_get_invoice_subscriptions( $invoice );
 
     if ( empty( $subscriptions ) || ! $invoice->is_recurring() ) {
         return;
@@ -1094,7 +1094,7 @@ 
 }
 
 function wpinv_empty_cart_message() {
-	return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
+    return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
 }
 
 /**
@@ -1291,10 +1291,10 @@ 
 
     if ( 0 == count( $form->get_items() ) ) {
         echo aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'No published items found', 'invoicing' ),
-			)
+            array(
+                'type'    => 'warning',
+                'content' => __( 'No published items found', 'invoicing' ),
+            )
         );
         return;
     }
@@ -1315,21 +1315,21 @@ 
     $invoice = wpinv_get_invoice( $invoice_id );
 
     if ( empty( $invoice ) ) {
-		echo aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'Invoice not found', 'invoicing' ),
-			)
+        echo aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'Invoice not found', 'invoicing' ),
+            )
         );
         return;
     }
 
     if ( $invoice->is_paid() ) {
-		echo aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'Invoice has already been paid', 'invoicing' ),
-			)
+        echo aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'Invoice has already been paid', 'invoicing' ),
+            )
         );
         return;
     }
@@ -1391,7 +1391,7 @@ 
         return "<button class='btn btn-primary getpaid-payment-button' type='button' data-form='$form'>$label</button>";
     }
 
-	if ( ! empty( $items ) ) {
+    if ( ! empty( $items ) ) {
         $items  = esc_attr( $items );
         return "<button class='btn btn-primary getpaid-payment-button' type='button' data-item='$items'>$label</button>";
     }
@@ -1577,21 +1577,21 @@ 
 
         return aui()->select(
             array(
-				'options'          => $states,
-				'name'             => esc_attr( $field_name ),
-				'id'               => sanitize_html_class( $field_name ) . $uniqid,
-				'value'            => sanitize_text_field( $state ),
-				'placeholder'      => $placeholder,
-				'required'         => $required,
-				'label'            => wp_kses_post( $label ),
-				'label_type'       => 'vertical',
-				'help_text'        => $help_text,
-				'class'            => 'getpaid-address-field wpinv_state',
-				'wrap_class'       => "$wrapper_class getpaid-address-field-wrapper__state",
-				'label_class'      => 'getpaid-address-field-label getpaid-address-field-label__state',
-				'extra_attributes' => array(
-					'autocomplete' => 'address-level1',
-				),
+                'options'          => $states,
+                'name'             => esc_attr( $field_name ),
+                'id'               => sanitize_html_class( $field_name ) . $uniqid,
+                'value'            => sanitize_text_field( $state ),
+                'placeholder'      => $placeholder,
+                'required'         => $required,
+                'label'            => wp_kses_post( $label ),
+                'label_type'       => 'vertical',
+                'help_text'        => $help_text,
+                'class'            => 'getpaid-address-field wpinv_state',
+                'wrap_class'       => "$wrapper_class getpaid-address-field-wrapper__state",
+                'label_class'      => 'getpaid-address-field-label getpaid-address-field-label__state',
+                'extra_attributes' => array(
+                    'autocomplete' => 'address-level1',
+                ),
             )
         );
 

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

Indentation +50 added lines, -50 removed lines

@@ -15,31 +15,31 @@ 
 abstract class GetPaid_Authorize_Net_Legacy_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
     }
 
     /**
-	 * Returns the API URL.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return string
-	 */
-	public function get_api_url( $invoice ) {
+     * Returns the API URL.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return string
+     */
+    public function get_api_url( $invoice ) {
         return $this->is_sandbox( $invoice ) ? 'https://apitest.authorize.net/xml/v1/request.api' : 'https://api.authorize.net/xml/v1/request.api';
     }
 
     /**
-	 * Communicates with authorize.net
-	 *
-	 *
-	 * @param array $post Data to post.
+     * Communicates with authorize.net
+     *
+     *
+     * @param array $post Data to post.
      * @param WPInv_Invoice $invoice Invoice.
-	 * @return stdClass|WP_Error
-	 */
+     * @return stdClass|WP_Error
+     */
     public function post( $post, $invoice ) {
 
         $url      = $this->get_api_url( $invoice );
@@ -89,12 +89,12 @@ 
     }
 
     /**
-	 * Returns the API authentication params.
-	 *
-	 *
-	 * @return array
-	 */
-	public function get_auth_params() {
+     * Returns the API authentication params.
+     *
+     *
+     * @return array
+     */
+    public function get_auth_params() {
 
         return array(
             'name'           => $this->get_option( 'login_id' ),
@@ -104,13 +104,13 @@ 
     }
 
     /**
-	 * Cancels a subscription remotely
-	 *
-	 *
-	 * @param WPInv_Subscription $subscription Subscription.
+     * Cancels a subscription remotely
+     *
+     *
+     * @param WPInv_Subscription $subscription Subscription.
      * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function cancel_subscription( $subscription, $invoice ) {
+     */
+    public function cancel_subscription( $subscription, $invoice ) {
 
         // Backwards compatibility. New version do not use authorize.net subscriptions.
         $this->post(
@@ -126,17 +126,17 @@ 
     }
 
     /**
-	 * Processes ipns.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
 
         $this->maybe_process_old_ipn();
 
         // Validate the IPN.
         if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-		    wp_die( 'Authorize.NET IPN Request Failure', 'Authorize.NET IPN', array( 'response' => 200 ) );
+            wp_die( 'Authorize.NET IPN Request Failure', 'Authorize.NET IPN', array( 'response' => 200 ) );
         }
 
         // Event type.
@@ -175,24 +175,24 @@ 
     }
 
     /**
-	 * Validates IPN invoices.
-	 *
+     * Validates IPN invoices.
+     *
      * @param WPInv_Invoice $invoice
      * @param object $payload
-	 * @return void
-	 */
-	public function validate_ipn_invoice( $invoice, $payload ) {
+     * @return void
+     */
+    public function validate_ipn_invoice( $invoice, $payload ) {
         if ( ! $invoice->exists() || $payload->id != $invoice->get_transaction_id() ) {
             exit;
         }
     }
 
     /**
-	 * Process subscriptio IPNS.
-	 *
-	 * @return void
-	 */
-	public function maybe_process_old_ipn() {
+     * Process subscriptio IPNS.
+     *
+     * @return void
+     */
+    public function maybe_process_old_ipn() {
 
         $data = wp_kses_post_deep( wp_unslash( $_POST ) );
 
@@ -234,11 +234,11 @@ 
     }
 
     /**
-	 * Validates the old IPN signature.
+     * Validates the old IPN signature.
      *
      * @param array $posted
-	 */
-	public function validate_old_ipn_signature( $posted ) {
+     */
+    public function validate_old_ipn_signature( $posted ) {
 
         $signature = $this->get_option( 'signature_key' );
         if ( ! empty( $signature ) ) {
@@ -256,9 +256,9 @@ 
     }
 
     /**
-	 * Check Authorize.NET IPN validity.
-	 */
-	public function validate_ipn() {
+     * Check Authorize.NET IPN validity.
+     */
+    public function validate_ipn() {
 
         wpinv_error_log( 'Validating Authorize.NET IPN response' );
 

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

Indentation +384 added lines, -384 removed lines

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

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

Indentation +344 added lines, -344 removed lines

@@ -13,96 +13,96 @@ 
 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', 'single_subscription_group' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 1;
 
     /**
-	 * Stores line items to send to PayPal.
-	 *
-	 * @var array
-	 */
+     * Stores line items to send to PayPal.
+     *
+     * @var array
+     */
     protected $line_items = array();
 
     /**
-	 * Endpoint for requests from PayPal.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to PayPal.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s';
 
     /**
-	 * URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
+     * URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'PayPal Standard', 'invoicing' );
         $this->method_title         = __( 'PayPal Standard', 'invoicing' );
         $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' );
         $this->notify_url           = wpinv_get_ipn_url( $this->id );
 
-		add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
+        add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
         add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) );
-		add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
-		add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
+        add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
+        add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
 
-		parent::__construct();
+        parent::__construct();
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -125,15 +125,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' );
@@ -146,45 +146,45 @@ 
 
         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', true, $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', true, $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 ) {
-
-		$email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        $email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+        return array(
             'cmd'           => '_cart',
             'business'      => $email,
             'no_shipping'   => '1',
@@ -209,16 +209,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 );
         }
 
@@ -238,129 +238,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_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() );
+        $this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $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   = $item->get_price();
-			$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   = $item->get_price();
+            $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
+            $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
         }
 
         // Fees.
-		foreach ( $invoice->get_fees() as $fee => $data ) {
+        foreach ( $invoice->get_fees() as $fee => $data ) {
             $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) );
         }
 
     }
 
     /**
-	 * Add PayPal Line Item.
-	 *
-	 * @param  string $item_name Item name.
-	 * @param  float    $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'    => (float) $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  float    $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'    => (float) $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'] * $item['quantity'];
-		$this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
+        $this->line_items[ 'amount_' . $index ]      = $item['amount'] * $item['quantity'];
+        $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 = getpaid_get_invoice_subscription( $invoice ) ) {
@@ -381,21 +381,21 @@ 
         $recurring_amount       = (float) wpinv_sanitize_amount( $invoice->get_recurring_total(), 2 );
         $subscription_item      = $invoice->get_recurring( true );
 
-		// Convert 365 days to 1 year.
-		if ( 'D' == $period && 365 == $interval ) {
-			$period = 'Y';
-			$interval = 1;
-		}
+        // Convert 365 days to 1 year.
+        if ( 'D' == $period && 365 == $interval ) {
+            $period = 'Y';
+            $interval = 1;
+        }
 
         if ( $subscription_item->has_free_trial() ) {
 
             $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();
 
         } elseif ( $initial_amount != $recurring_amount ) {
 
@@ -418,40 +418,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
@@ -466,19 +466,19 @@ 
 }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -488,19 +488,19 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 
-	/**
-	 * 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' ),
@@ -510,39 +510,39 @@ 
         $admin_settings['paypal_active']['desc'] .= " ($currencies)";
         $admin_settings['paypal_desc']['std']     = __( 'Pay via PayPal: you can pay with your credit card if you don\'t have a PayPal account.', 'invoicing' );
 
-		// Access tokens.
-		$live_email      = wpinv_get_option( 'paypal_email' );
-		$sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
-
-		$admin_settings['paypal_connect'] = array(
-			'type' => 'raw_html',
-			'id'   => 'paypal_connect',
-			'name' => __( 'Connect to PayPal', 'invoicing' ),
-			'desc' => sprintf(
-				'<div class="wpinv-paypal-connect-live"><a class="button button-primary" href="%s">%s</a></div><div class="wpinv-paypal-connect-sandbox"><a class="button button-primary" href="%s">%s</a></div>%s',
-				esc_url( self::get_connect_url( false ) ),
-				__( 'Connect to PayPal', 'invoicing' ),
-				esc_url( self::get_connect_url( true ) ),
-				__( 'Connect to PayPal Sandox', 'invoicing' ),
-				$this->get_js()
-			),
-		);
+        // Access tokens.
+        $live_email      = wpinv_get_option( 'paypal_email' );
+        $sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
+
+        $admin_settings['paypal_connect'] = array(
+            'type' => 'raw_html',
+            'id'   => 'paypal_connect',
+            'name' => __( 'Connect to PayPal', 'invoicing' ),
+            'desc' => sprintf(
+                '<div class="wpinv-paypal-connect-live"><a class="button button-primary" href="%s">%s</a></div><div class="wpinv-paypal-connect-sandbox"><a class="button button-primary" href="%s">%s</a></div>%s',
+                esc_url( self::get_connect_url( false ) ),
+                __( 'Connect to PayPal', 'invoicing' ),
+                esc_url( self::get_connect_url( true ) ),
+                __( 'Connect to PayPal Sandox', 'invoicing' ),
+                $this->get_js()
+            ),
+        );
 
         $admin_settings['paypal_email'] = array(
             'type'  => 'text',
-			'class' => 'live-auth-data',
+            'class' => 'live-auth-data',
             'id'    => 'paypal_email',
             'name'  => __( 'Live Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your PayPal account.', 'invoicing' ),
         );
 
-		$admin_settings['paypal_sandbox_email'] = array(
+        $admin_settings['paypal_sandbox_email'] = array(
             'type'  => 'text',
-			'class' => 'sandbox-auth-data',
+            'class' => 'sandbox-auth-data',
             'id'    => 'paypal_sandbox_email',
             'name'  => __( 'Sandbox Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your sandbox PayPal account.', 'invoicing' ),
-			'std'   => wpinv_get_option( 'paypal_email', '' ),
+            'std'   => wpinv_get_option( 'paypal_email', '' ),
         );
 
         $admin_settings['paypal_ipn_url'] = array(
@@ -554,29 +554,29 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
-	/**
-	 * Retrieves the PayPal connect URL when using the setup wizzard.
-	 *
-	 *
+    /**
+     * Retrieves the PayPal connect URL when using the setup wizzard.
+     *
+     *
      * @param array $data
      * @return string
-	 */
-	public static function maybe_get_connect_url( $url = '', $data = array() ) {
-		return self::get_connect_url( false, urldecode( $data['redirect'] ) );
-	}
-
-	/**
-	 * Retrieves the PayPal connect URL.
-	 *
-	 *
+     */
+    public static function maybe_get_connect_url( $url = '', $data = array() ) {
+        return self::get_connect_url( false, urldecode( $data['redirect'] ) );
+    }
+
+    /**
+     * Retrieves the PayPal connect URL.
+     *
+     *
      * @param bool $is_sandbox
-	 * @param string $redirect
+     * @param string $redirect
      * @return string
-	 */
-	public static function get_connect_url( $is_sandbox, $redirect = '' ) {
+     */
+    public static function get_connect_url( $is_sandbox, $redirect = '' ) {
 
         $redirect_url = add_query_arg(
             array(
@@ -586,7 +586,7 @@ 
                 'tab'                  => 'gateways',
                 'section'              => 'paypal',
                 'getpaid-nonce'        => wp_create_nonce( 'getpaid-nonce' ),
-				'redirect'             => urlencode( $redirect ),
+                'redirect'             => urlencode( $redirect ),
             ),
             admin_url( 'admin.php' )
         );
@@ -601,12 +601,12 @@ 
 
     }
 
-	/**
-	 * Generates settings page js.
-	 *
+    /**
+     * Generates settings page js.
+     *
      * @return void
-	 */
-	public static function get_js() {
+     */
+    public static function get_js() {
         ob_start();
         ?>
             <script>
@@ -642,70 +642,70 @@ 
         return ob_get_clean();
     }
 
-	/**
-	 * Connects to PayPal.
-	 *
-	 * @param array $data Connection data.
-	 * @return void
-	 */
-	public function connect_paypal( $data ) {
-
-		$sandbox      = $this->is_sandbox();
-		$data         = wp_unslash( $data );
-		$access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
-
-		if ( isset( $data['live_mode'] ) ) {
-			$sandbox = empty( $data['live_mode'] );
-		}
-
-		wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
-		wpinv_update_option( 'paypal_active', 1 );
-
-		if ( ! empty( $data['error_description'] ) ) {
-			getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
-		} else {
-
-			// Retrieve the user info.
-			$user_info = wp_remote_get(
-				! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
-				array(
-
-					'headers' => array(
-						'Authorization' => 'Bearer ' . $access_token,
-						'Content-type'  => 'application/json',
-					),
-
-				)
-			);
-
-			if ( is_wp_error( $user_info ) ) {
-				getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
-			} else {
-
-				// Create application.
-				$user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
-
-				if ( $sandbox ) {
-					wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
-				} else {
-					wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
-				}
+    /**
+     * Connects to PayPal.
+     *
+     * @param array $data Connection data.
+     * @return void
+     */
+    public function connect_paypal( $data ) {
+
+        $sandbox      = $this->is_sandbox();
+        $data         = wp_unslash( $data );
+        $access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
+
+        if ( isset( $data['live_mode'] ) ) {
+            $sandbox = empty( $data['live_mode'] );
+        }
+
+        wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
+        wpinv_update_option( 'paypal_active', 1 );
+
+        if ( ! empty( $data['error_description'] ) ) {
+            getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
+        } else {
+
+            // Retrieve the user info.
+            $user_info = wp_remote_get(
+                ! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
+                array(
+
+                    'headers' => array(
+                        'Authorization' => 'Bearer ' . $access_token,
+                        'Content-type'  => 'application/json',
+                    ),
+
+                )
+            );
+
+            if ( is_wp_error( $user_info ) ) {
+                getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
+            } else {
+
+                // Create application.
+                $user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
+
+                if ( $sandbox ) {
+                    wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
+                } else {
+                    wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
+                }
 }
 }
 
-		$redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
+        $redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
 
-		if ( isset( $data['step'] ) ) {
-			$redirect = add_query_arg( 'step', $data['step'], $redirect );
-		}
-		wp_redirect( $redirect );
-		exit;
-	}
+        if ( isset( $data['step'] ) ) {
+            $redirect = add_query_arg( 'step', $data['step'], $redirect );
+        }
+        wp_redirect( $redirect );
+        exit;
+    }
 
 }