AyeCode / invoicing

includes/class-wpinv-item.php

Indentation +732 added lines, -732 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,30 +10,30 @@ 
 class WPInv_Item  extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'item';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'item';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'item';
 
     /**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'parent_id'            => 0,
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'parent_id'            => 0,
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'description'          => '',
@@ -58,13 +58,13 @@ 
     );
 
     /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_items';
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_items';
 
     /**
      * Stores a reference to the original WP_Post object
@@ -74,37 +74,37 @@ 
     protected $post = null;
 
     /**
-	 * Get the item if ID is passed, otherwise the item is new and empty.
-	 *
-	 * @param  int|object|WPInv_Item|WP_Post $item Item to read.
-	 */
-	public function __construct( $item = 0 ) {
-		parent::__construct( $item );
-
-		if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
-			$this->set_id( $item );
-		} elseif ( $item instanceof self ) {
-			$this->set_id( $item->get_id() );
-		} elseif ( ! empty( $item->ID ) ) {
-			$this->set_id( $item->ID );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
-			$this->set_id( $item_id );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
-			$this->set_id( $item_id );
-		} else {
-			$this->set_object_read( true );
-		}
+     * Get the item if ID is passed, otherwise the item is new and empty.
+     *
+     * @param  int|object|WPInv_Item|WP_Post $item Item to read.
+     */
+    public function __construct( $item = 0 ) {
+        parent::__construct( $item );
+
+        if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
+            $this->set_id( $item );
+        } elseif ( $item instanceof self ) {
+            $this->set_id( $item->get_id() );
+        } elseif ( ! empty( $item->ID ) ) {
+            $this->set_id( $item->ID );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
+            $this->set_id( $item_id );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
+            $this->set_id( $item_id );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
             $this->ID   = $this->get_id();
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -122,401 +122,401 @@ 
     */
 
     /**
-	 * Get parent item ID.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_id', $context );
+     * Get parent item ID.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_id', $context );
     }
 
     /**
-	 * Get item 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 item 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 plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the item name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->get_name( $context );
     }
 
     /**
-	 * Get the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-		return $this->get_prop( 'description', $context );
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+        return $this->get_prop( 'description', $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_excerpt( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_excerpt( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_summary( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_summary( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Get the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
-	}
+     * Get the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
+    }
 	
-	/**
-	 * Alias of self::get_author().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_owner( $context = 'view' ) {
-		return $this->get_author( $context );
-    }
-
-    /**
-	 * Get the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_price( $context = 'view' ) {
+    /**
+     * Alias of self::get_author().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_owner( $context = 'view' ) {
+        return $this->get_author( $context );
+    }
+
+    /**
+     * Get the price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) );
-	}
+    }
 	
-	/**
-	 * Get the inital price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_price( $context = 'view' ) {
+    /**
+     * Get the inital price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_price( $context = 'view' ) {
 
-		$price = (float) $this->get_price( $context );
+        $price = (float) $this->get_price( $context );
 
-		if ( $this->has_free_trial() ) {
-			$price = 0;
-		}
+        if ( $this->has_free_trial() ) {
+            $price = 0;
+        }
 
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) );
     }
 
     /**
-	 * Returns a formated price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+     * Returns a formated price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_price() {
         return wpinv_price( $this->get_price() );
-	}
-
-	/**
-	 * Returns the formated initial price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Returns the formated initial price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_initial_price() {
         return wpinv_price( $this->get_initial_price() );
     }
 
     /**
-	 * Get the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_rule( $context = 'view' ) {
+     * Get the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_rule( $context = 'view' ) {
         return $this->get_prop( 'vat_rule', $context );
     }
 
     /**
-	 * Get the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_class( $context = 'view' ) {
+     * Get the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_class( $context = 'view' ) {
         return $this->get_prop( 'vat_class', $context );
     }
 
     /**
-	 * Get the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
+     * Get the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_type( $context = 'view' ) {
         return $this->get_prop( 'type', $context );
     }
 
     /**
-	 * Get the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_id( $context = 'view' ) {
+     * Get the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_id( $context = 'view' ) {
         return $this->get_prop( 'custom_id', $context );
     }
 
     /**
-	 * Get the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_name( $context = 'view' ) {
+     * Get the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_name( $context = 'view' ) {
         return $this->get_prop( 'custom_name', $context );
     }
 
     /**
-	 * Get the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_singular_name( $context = 'view' ) {
+     * Get the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_singular_name( $context = 'view' ) {
         return $this->get_prop( 'custom_singular_name', $context );
     }
 
     /**
-	 * Checks if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_editable( $context = 'view' ) {
+     * Checks if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_editable( $context = 'view' ) {
         return (int) $this->get_prop( 'is_editable', $context );
     }
 
     /**
-	 * Alias of self::get_is_editable().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_editable( $context = 'view' ) {
-		return $this->get_is_editable( $context );
+     * Alias of self::get_is_editable().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_editable( $context = 'view' ) {
+        return $this->get_is_editable( $context );
     }
 
     /**
-	 * Checks if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_dynamic_pricing( $context = 'view' ) {
+     * Checks if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_dynamic_pricing( $context = 'view' ) {
         return (int) $this->get_prop( 'is_dynamic_pricing', $context );
     }
 
     /**
-	 * Returns the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_minimum_price( $context = 'view' ) {
+     * Returns the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_minimum_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) );
     }
 
     /**
-	 * Checks if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_recurring( $context = 'view' ) {
+     * Checks if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_recurring( $context = 'view' ) {
         return (int) $this->get_prop( 'is_recurring', $context );
-	}
+    }
 	
-	/**
-	 * Get the recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_price( $context = 'view' ) {
-		$price = $this->get_price( $context );
+    /**
+     * Get the recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_price( $context = 'view' ) {
+        $price = $this->get_price( $context );
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) );
-	}
-
-	/**
-	 * Get the formatted recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Get the formatted recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_recurring_price() {
         return wpinv_price( $this->get_recurring_price() );
-	}
-
-	/**
-	 * Get the first renewal date (in timestamps) of the item.
-	 *
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public function get_first_renewal_date() {
-
-		$periods = array(
-			'D' => 'days',
-			'W' => 'weeks',
-			'M' => 'months',
-			'Y' => 'years',
-		);
-
-		$period   = $this->get_recurring_period();
-		$interval = $this->get_recurring_interval();
-
-		if ( $this->has_free_trial() ) {
-			$period   = $this->get_trial_period();
-			$interval = $this->get_trial_interval();
-		}
-
-		$period       = $periods[ $period ];
-		$interval     = empty( $interval ) ? 1 : $interval;
-		$next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get the first renewal date (in timestamps) of the item.
+     *
+     * @since 1.0.19
+     * @return int
+     */
+    public function get_first_renewal_date() {
+
+        $periods = array(
+            'D' => 'days',
+            'W' => 'weeks',
+            'M' => 'months',
+            'Y' => 'years',
+        );
+
+        $period   = $this->get_recurring_period();
+        $interval = $this->get_recurring_interval();
+
+        if ( $this->has_free_trial() ) {
+            $period   = $this->get_trial_period();
+            $interval = $this->get_trial_interval();
+        }
+
+        $period       = $periods[ $period ];
+        $interval     = empty( $interval ) ? 1 : $interval;
+        $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
         return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this );
     }
 
     /**
-	 * Get the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_recurring_period( $full = false ) {
+     * Get the recurring period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_recurring_period( $full = false ) {
         $period = $this->get_prop( 'recurring_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -527,58 +527,58 @@ 
     }
 
     /**
-	 * Get the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_interval( $context = 'view' ) {
-		$interval = absint( $this->get_prop( 'recurring_interval', $context ) );
-		return max( 1, $interval );
+     * Get the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_interval( $context = 'view' ) {
+        $interval = absint( $this->get_prop( 'recurring_interval', $context ) );
+        return max( 1, $interval );
     }
 
     /**
-	 * Get the recurring limit.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_limit( $context = 'view' ) {
+     * Get the recurring limit.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_limit( $context = 'view' ) {
         return (int) $this->get_prop( 'recurring_limit', $context );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_free_trial( $context = 'view' ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_free_trial( $context = 'view' ) {
         return (int) $this->get_prop( 'is_free_trial', $context );
     }
 
     /**
-	 * Alias for self::get_is_free_trial().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_free_trial( $context = 'view' ) {
+     * Alias for self::get_is_free_trial().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_free_trial( $context = 'view' ) {
         return $this->get_is_free_trial( $context );
     }
 
     /**
-	 * Get the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_trial_period( $full = false ) {
+     * Get the trial period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_trial_period( $full = false ) {
         $period = $this->get_prop( 'trial_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -589,104 +589,104 @@ 
     }
 
     /**
-	 * Get the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_trial_interval( $context = 'view' ) {
+     * Get the trial interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_trial_interval( $context = 'view' ) {
         return (int) $this->get_prop( 'trial_interval', $context );
-	}
+    }
 	
-	/**
-	 * Get the item's edit url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_edit_url() {
+    /**
+     * Get the item's edit url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_edit_url() {
         return get_edit_post_link( $this->get_id(), 'edit' );
-	}
-
-	/**
-	 * Given an item's name/custom id, it returns its id.
-	 *
-	 *
-	 * @static
-	 * @param string $value The item name or custom id.
-	 * @param string $field Either name or custom_id.
-	 * @param string $type in case you need to search for a given type.
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
-
-		// Trim the value.
-		$value = sanitize_text_field( $value );
-		if ( empty( $value ) ) {
-			return 0;
-		}
+    }
+
+    /**
+     * Given an item's name/custom id, it returns its id.
+     *
+     *
+     * @static
+     * @param string $value The item name or custom id.
+     * @param string $field Either name or custom_id.
+     * @param string $type in case you need to search for a given type.
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
+
+        // Trim the value.
+        $value = sanitize_text_field( $value );
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
         // Valid fields.
         $fields = array( 'custom_id', 'name', 'slug' );
 
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		if ( $field == 'name' ) {
-			$field = 'slug';
-		}
-
-		// Maybe retrieve from the cache.
-		$item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-		if ( ! empty( $item_id ) ) {
-			return $item_id;
-		}
-
-		// Fetch from the db.
-		$items = array();
-		if ( $field == 'slug' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'name'           => $value,
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-				)
-			);
-		}
-
-		if ( $field =='custom_id' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-					'meta_query'     => array(
-						array(
-							'key'   => '_wpinv_type',
-                			'value' => $type,
-						),
-						array(
-							'key'   => '_wpinv_custom_id',
-                			'value' => $value,
-						)
-					)
-				)
-			);
-		}
-
-		if ( empty( $items ) ) {
-			return 0;
-		}
-
-		// Update the cache with our data
-		wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-
-		return $items[0]->ID;
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        if ( $field == 'name' ) {
+            $field = 'slug';
+        }
+
+        // Maybe retrieve from the cache.
+        $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+        if ( ! empty( $item_id ) ) {
+            return $item_id;
+        }
+
+        // Fetch from the db.
+        $items = array();
+        if ( $field == 'slug' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'name'           => $value,
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                )
+            );
+        }
+
+        if ( $field =='custom_id' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                    'meta_query'     => array(
+                        array(
+                            'key'   => '_wpinv_type',
+                            'value' => $type,
+                        ),
+                        array(
+                            'key'   => '_wpinv_custom_id',
+                            'value' => $value,
+                        )
+                    )
+                )
+            );
+        }
+
+        if ( empty( $items ) ) {
+            return 0;
+        }
+
+        // Update the cache with our data
+        wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+
+        return $items[0]->ID;
     }
 
     /**
@@ -719,52 +719,52 @@ 
     */
 
     /**
-	 * Set parent order ID.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_parent_id( $value ) {
-		if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
-			return;
-		}
-		$this->set_prop( 'parent_id', absint( $value ) );
-	}
-
-    /**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+     * Set parent order ID.
+     *
+     * @since 1.0.19
+     */
+    public function set_parent_id( $value ) {
+        if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
+            return;
+        }
+        $this->set_prop( 'parent_id', absint( $value ) );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param  string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
         $this->set_prop( 'status', $status );
 
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
     }
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -777,13 +777,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -796,115 +796,115 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
         $name = sanitize_text_field( $value );
-		$this->set_prop( 'name', $name );
+        $this->set_prop( 'name', $name );
     }
 
     /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
     }
 
     /**
-	 * Set the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
-		$description = wp_kses_post( $value );
-		return $this->set_prop( 'description', $description );
+     * Set the item description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
+        $description = wp_kses_post( $value );
+        return $this->set_prop( 'description', $description );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_excerpt( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_excerpt( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_summary( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_summary( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
 	
-	/**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_owner( $value ) {
-		$this->set_author( $value );
-    }
-
-    /**
-	 * Set the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value New price.
-	 */
-	public function set_price( $value ) {
+    /**
+     * Alias of self::set_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_owner( $value ) {
+        $this->set_author( $value );
+    }
+
+    /**
+     * Set the price of the item.
+     *
+     * @since 1.0.19
+     * @param  float $value New price.
+     */
+    public function set_price( $value ) {
         $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Set the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new rule.
-	 */
-	public function set_vat_rule( $value ) {
+     * Set the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new rule.
+     */
+    public function set_vat_rule( $value ) {
         $this->set_prop( 'vat_rule', $value );
     }
 
     /**
-	 * Set the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new class.
-	 */
-	public function set_vat_class( $value ) {
+     * Set the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new class.
+     */
+    public function set_vat_class( $value ) {
         $this->set_prop( 'vat_class', $value );
     }
 
     /**
-	 * Set the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new item type.
-	 * @return string
-	 */
-	public function set_type( $value ) {
+     * Set the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new item type.
+     * @return string
+     */
+    public function set_type( $value ) {
 
         if ( empty( $value ) ) {
             $value = 'custom';
@@ -914,132 +914,132 @@ 
     }
 
     /**
-	 * Set the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom id.
-	 */
-	public function set_custom_id( $value ) {
+     * Set the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom id.
+     */
+    public function set_custom_id( $value ) {
         $this->set_prop( 'custom_id', $value );
     }
 
     /**
-	 * Set the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom name.
-	 */
-	public function set_custom_name( $value ) {
+     * Set the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom name.
+     */
+    public function set_custom_name( $value ) {
         $this->set_prop( 'custom_name', $value );
     }
 
     /**
-	 * Set the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom singular name.
-	 */
-	public function set_custom_singular_name( $value ) {
+     * Set the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom singular name.
+     */
+    public function set_custom_singular_name( $value ) {
         $this->set_prop( 'custom_singular_name', $value );
     }
 
     /**
-	 * Sets if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not the item is editable.
-	 */
-	public function set_is_editable( $value ) {
-		$this->set_prop( 'is_editable', (int) $value );
+     * Sets if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not the item is editable.
+     */
+    public function set_is_editable( $value ) {
+        $this->set_prop( 'is_editable', (int) $value );
     }
 
     /**
-	 * Sets if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_dynamic_pricing( $value ) {
+     * Sets if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_dynamic_pricing( $value ) {
         $this->set_prop( 'is_dynamic_pricing', (int) $value );
     }
 
     /**
-	 * Sets the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value minimum price.
-	 */
-	public function set_minimum_price( $value ) {
+     * Sets the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  float $value minimum price.
+     */
+    public function set_minimum_price( $value ) {
         $this->set_prop( 'minimum_price',  (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Sets if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_recurring( $value ) {
+     * Sets if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_recurring( $value ) {
         $this->set_prop( 'is_recurring', (int) $value );
     }
 
     /**
-	 * Set the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new period.
-	 */
-	public function set_recurring_period( $value ) {
+     * Set the recurring period.
+     *
+     * @since 1.0.19
+     * @param  string $value new period.
+     */
+    public function set_recurring_period( $value ) {
         $this->set_prop( 'recurring_period', $value );
     }
 
     /**
-	 * Set the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value recurring interval.
-	 */
-	public function set_recurring_interval( $value ) {
+     * Set the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  int $value recurring interval.
+     */
+    public function set_recurring_interval( $value ) {
         return $this->set_prop( 'recurring_interval', (int) $value );
     }
 
     /**
-	 * Get the recurring limit.
-	 * @since 1.0.19
-	 * @param  int $value The recurring limit.
-	 * @return int
-	 */
-	public function set_recurring_limit( $value ) {
+     * Get the recurring limit.
+     * @since 1.0.19
+     * @param  int $value The recurring limit.
+     * @return int
+     */
+    public function set_recurring_limit( $value ) {
         $this->set_prop( 'recurring_limit', (int) $value );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not it has a free trial.
-	 */
-	public function set_is_free_trial( $value ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not it has a free trial.
+     */
+    public function set_is_free_trial( $value ) {
         $this->set_prop( 'is_free_trial', (int) $value );
     }
 
     /**
-	 * Set the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value trial period.
-	 */
-	public function set_trial_period( $value ) {
+     * Set the trial period.
+     *
+     * @since 1.0.19
+     * @param  string $value trial period.
+     */
+    public function set_trial_period( $value ) {
         $this->set_prop( 'trial_period', $value );
     }
 
     /**
-	 * Set the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value trial interval.
-	 */
-	public function set_trial_interval( $value ) {
+     * Set the trial interval.
+     *
+     * @since 1.0.19
+     * @param  int $value trial interval.
+     */
+    public function set_trial_interval( $value ) {
         $this->set_prop( 'trial_interval', $value );
     }
 
@@ -1047,17 +1047,17 @@ 
      * Create an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
     }
 
@@ -1065,7 +1065,7 @@ 
      * Updates an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -1081,93 +1081,93 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function user_can_set_their_price() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function user_can_set_their_price() {
         return (bool) $this->get_is_dynamic_pricing();
-	}
+    }
 	
-	/**
-	 * Checks whether the item is recurring.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_recurring() {
+    /**
+     * Checks whether the item is recurring.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_recurring() {
         return (bool) $this->get_is_recurring();
     }
 
     /**
-	 * Checks whether the item has a free trial.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item has a free trial.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_free_trial() {
         $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false;
         return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this );
     }
 
     /**
-	 * Checks whether the item is free.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is free.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_free() {
         $is_free   = $this->get_price() == 0;
         return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this );
     }
 
     /**
-	 * Checks the item status against a passed in status.
-	 *
-	 * @param array|string $status Status to check.
-	 * @return bool
-	 */
-	public function has_status( $status ) {
-		$has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
-		return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
+     * Checks the item status against a passed in status.
+     *
+     * @param array|string $status Status to check.
+     * @return bool
+     */
+    public function has_status( $status ) {
+        $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
+        return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
     }
 
     /**
-	 * Checks the item type against a passed in types.
-	 *
-	 * @param array|string $type Type to check.
-	 * @return bool
-	 */
-	public function is_type( $type ) {
-		$is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
-		return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
-	}
+     * Checks the item type against a passed in types.
+     *
+     * @param array|string $type Type to check.
+     * @return bool
+     */
+    public function is_type( $type ) {
+        $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
+        return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
+    }
 
     /**
-	 * Checks whether the item is editable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is editable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_editable() {
         $is_editable = $this->get_is_editable();
         return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this );
-	}
+    }
 
-	/**
-	 * Returns an array of cart fees.
-	 */
-	public function get_fees() {
+    /**
+     * Returns an array of cart fees.
+     */
+    public function get_fees() {
         return array();
     }
 
     /**
-	 * Checks whether the item is purchasable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is purchasable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function can_purchase() {
         $can_purchase = $this->exists();
 
@@ -1179,11 +1179,11 @@ 
     }
 
     /**
-	 * Checks whether the item supports dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item supports dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function supports_dynamic_pricing() {
         return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this );
     }

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

Indentation +223 added lines, -223 removed lines

@@ -13,94 +13,94 @@ 
 class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'paypal';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox', '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' ) );
 
         parent::__construct();
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -123,15 +123,15 @@ 
     }
 
     /**
-	 * Get the PayPal request URL for an invoice.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_request_url( $invoice ) {
+     * Get the PayPal request URL for an invoice.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_request_url( $invoice ) {
 
         // Endpoint for this request
-		$this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
+        $this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
 
         // Retrieve paypal args.
         $paypal_args       = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' );
@@ -144,44 +144,44 @@ 
 
         return add_query_arg( $paypal_args, $this->endpoint );
 
-	}
+    }
 
     /**
-	 * Get PayPal Args for passing to PP.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_paypal_args( $invoice ) {
+     * Get PayPal Args for passing to PP.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_paypal_args( $invoice ) {
 
         // Whether or not to send the line items as one item.
-		$force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', 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 ) {
-
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        return array(
             'cmd'           => '_cart',
             'business'      => wpinv_get_option( 'paypal_email', false ),
             'no_shipping'   => '1',
@@ -206,16 +206,16 @@ 
     }
 
     /**
-	 * Get line item args for paypal request.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @param  bool     $force_one_line_item Create only one item for this invoice.
-	 * @return array
-	 */
-	protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
+     * Get line item args for paypal request.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @param  bool     $force_one_line_item Create only one item for this invoice.
+     * @return array
+     */
+    protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
 
         // Maybe send invoice as a single item.
-		if ( $force_one_line_item ) {
+        if ( $force_one_line_item ) {
             return $this->get_line_item_args_single_item( $invoice );
         }
 
@@ -235,129 +235,129 @@ 
             $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 );
         }
 
-		return array_merge( $line_item_args, $this->get_line_items() );
+        return array_merge( $line_item_args, $this->get_line_items() );
 
     }
 
     /**
-	 * Get line item args for paypal request as a single line item.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_line_item_args_single_item( $invoice ) {
-		$this->delete_line_items();
+     * Get line item args for paypal request as a single line item.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_line_item_args_single_item( $invoice ) {
+        $this->delete_line_items();
 
         $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() );
-		$this->add_line_item( $item_name, 1, wpinv_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 ) ) {
@@ -382,11 +382,11 @@ 
 
             $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount;
 
-			// Trial period length.
-			$paypal_args['p1'] = $subscription_item->get_trial_interval();
+            // Trial period length.
+            $paypal_args['p1'] = $subscription_item->get_trial_interval();
 
-			// Trial period.
-			$paypal_args['t1'] = $subscription_item->get_trial_period();
+            // Trial period.
+            $paypal_args['t1'] = $subscription_item->get_trial_period();
 
         } else if ( $initial_amount != $recurring_amount ) {
 
@@ -409,40 +409,40 @@ 
         }
 
         // We have a recurring payment
-		if ( ! isset( $param_number ) || 1 == $param_number ) {
+        if ( ! isset( $param_number ) || 1 == $param_number ) {
 
-			// Subscription price
-			$paypal_args['a3'] = $recurring_amount;
+            // Subscription price
+            $paypal_args['a3'] = $recurring_amount;
 
-			// Subscription duration
-			$paypal_args['p3'] = $interval;
+            // Subscription duration
+            $paypal_args['p3'] = $interval;
 
-			// Subscription period
-			$paypal_args['t3'] = $period;
+            // Subscription period
+            $paypal_args['t3'] = $period;
 
         }
 
         // Recurring payments
-		if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
+        if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
 
-			// Non-recurring payments
-			$paypal_args['src'] = 0;
+            // Non-recurring payments
+            $paypal_args['src'] = 0;
 
-		} else {
+        } else {
 
-			$paypal_args['src'] = 1;
+            $paypal_args['src'] = 1;
 
-			if ( $bill_times > 0 ) {
+            if ( $bill_times > 0 ) {
 
-				// An initial period is being used to charge a sign-up fee
-				if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
-					$bill_times--;
-				}
+                // An initial period is being used to charge a sign-up fee
+                if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
+                    $bill_times--;
+                }
 
                 // Make sure it's not over the max of 52
                 $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 );
 
-			}
+            }
         }
 
         // Force return URL so that order description & instructions display
@@ -458,19 +458,19 @@ 
         }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -480,10 +480,10 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %sPayPal Sandbox Testing Guide%s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 

includes/class-getpaid-daily-maintenance.php

Indentation +103 added lines, -103 removed lines

@@ -12,108 +12,108 @@
  */
 class GetPaid_Daily_Maintenance {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct(){
-
-		// Clear deprecated events.
-		add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
-
-		// (Maybe) schedule a cron that runs daily.
-		add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
-
-		// Fired everyday at 7 a.m (this might vary for sites with few visitors)
-		add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
-
-	}
-
-	/**
-	 * Schedules a cron to run every day at 7 a.m
-	 *
-	 */
-	public function maybe_create_scheduled_event() {
-
-		if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
-			$timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
-			wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
-		}
-
-	}
-
-	/**
-	 * Clears deprecated events.
-	 *
-	 */
-	public function maybe_clear_deprecated_events() {
-
-		if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
-			update_option( 'wpinv_cleared_old_events', 1 );
-		}
-
-	}
-
-	/**
-	 * Fires the old hook for backwards compatibility.
-	 *
-	 */
-	public function backwards_compat() {
-		do_action( 'wpinv_register_schedule_event_daily' );
-	}
-
-	/**
-	 * Expires expired subscriptions.
-	 *
-	 */
-	public function maybe_expire_subscriptions() {
-
-		// Fetch expired subscriptions (skips those that expire today).
-		$args  = array(
-			'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active failing cancelled',
-			'date_expires_query' => array(
-				'before'    => 'today',
-				'inclusive' => false,
-			),
-		);
-
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
-
-		foreach ( $subscriptions->get_results() as $subscription ) {
-			if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', true, $subscription ) ) {
-				$subscription->set_status( 'expired' );
-				$subscription->save();
-			}
-		}
-
-	}
-
-	/**
-	 * Logs cron runs.
-	 *
-	 */
-	public function log_cron_run() {
-		wpinv_error_log( 'GetPaid Daily Cron', false );
-	}
-
-	/**
-	 * Updates GeoIP databases.
-	 *
-	 */
-	public function maybe_update_geoip_databases() {
-		$updated = get_transient( 'getpaid_updated_geoip_databases' );
-
-		if ( false === $updated ) {
-			set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
-			do_action( 'getpaid_update_geoip_databases' );
-		}
-
-	}
+    /**
+     * Class constructor.
+     */
+    public function __construct(){
+
+        // Clear deprecated events.
+        add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
+
+        // (Maybe) schedule a cron that runs daily.
+        add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
+
+        // Fired everyday at 7 a.m (this might vary for sites with few visitors)
+        add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
+
+    }
+
+    /**
+     * Schedules a cron to run every day at 7 a.m
+     *
+     */
+    public function maybe_create_scheduled_event() {
+
+        if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
+            $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
+            wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
+        }
+
+    }
+
+    /**
+     * Clears deprecated events.
+     *
+     */
+    public function maybe_clear_deprecated_events() {
+
+        if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
+            update_option( 'wpinv_cleared_old_events', 1 );
+        }
+
+    }
+
+    /**
+     * Fires the old hook for backwards compatibility.
+     *
+     */
+    public function backwards_compat() {
+        do_action( 'wpinv_register_schedule_event_daily' );
+    }
+
+    /**
+     * Expires expired subscriptions.
+     *
+     */
+    public function maybe_expire_subscriptions() {
+
+        // Fetch expired subscriptions (skips those that expire today).
+        $args  = array(
+            'number'             => -1,
+            'count_total'        => false,
+            'status'             => 'trialling active failing cancelled',
+            'date_expires_query' => array(
+                'before'    => 'today',
+                'inclusive' => false,
+            ),
+        );
+
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
+
+        foreach ( $subscriptions->get_results() as $subscription ) {
+            if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', true, $subscription ) ) {
+                $subscription->set_status( 'expired' );
+                $subscription->save();
+            }
+        }
+
+    }
+
+    /**
+     * Logs cron runs.
+     *
+     */
+    public function log_cron_run() {
+        wpinv_error_log( 'GetPaid Daily Cron', false );
+    }
+
+    /**
+     * Updates GeoIP databases.
+     *
+     */
+    public function maybe_update_geoip_databases() {
+        $updated = get_transient( 'getpaid_updated_geoip_databases' );
+
+        if ( false === $updated ) {
+            set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
+            do_action( 'getpaid_update_geoip_databases' );
+        }
+
+    }
 
 }

includes/admin/class-getpaid-metaboxes.php

Indentation +240 added lines, -240 removed lines

@@ -12,276 +12,276 @@
  */
 class GetPaid_Metaboxes {
 
-	/**
-	 * Only save metaboxes once.
-	 *
-	 * @var boolean
-	 */
-	private static $saved_meta_boxes = false;
-
     /**
-	 * Hook in methods.
-	 */
-	public static function init() {
-
-		// Register metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 );
-
-		// Remove metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
-
-		// Rename metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
-
-		// Save metaboxes.
-		add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
-	}
-
-	/**
-	 * Register core metaboxes.
-	 */
-	public static function add_meta_boxes( $post_type, $post ) {
+     * Only save metaboxes once.
+     *
+     * @var boolean
+     */
+    private static $saved_meta_boxes = false;
 
-		// For invoices...
-		self::add_invoice_meta_boxes( $post_type, $post );
-
-		// For payment forms.
-		self::add_payment_form_meta_boxes( $post_type );
-
-		// For invoice items.
-		self::add_item_meta_boxes( $post_type );
-
-		// For invoice discounts.
-		if ( $post_type == 'wpi_discount' ) {
-			add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
-		}
-
-	}
+    /**
+     * Hook in methods.
+     */
+    public static function init() {
 
-	/**
-	 * Register core metaboxes.
-	 */
-	protected static function add_payment_form_meta_boxes( $post_type ) {
+        // Register metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 );
 
-		// For payment forms.
-		if ( $post_type == 'wpi_payment_form' ) {
+        // Remove metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
 
-			// Design payment form.
-			add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
+        // Rename metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
 
-			// Payment form information.
-			add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
+        // Save metaboxes.
+        add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
+    }
 
-		}
+    /**
+     * Register core metaboxes.
+     */
+    public static function add_meta_boxes( $post_type, $post ) {
 
-	}
+        // For invoices...
+        self::add_invoice_meta_boxes( $post_type, $post );
 
-	/**
-	 * Register core metaboxes.
-	 */
-	protected static function add_item_meta_boxes( $post_type ) {
+        // For payment forms.
+        self::add_payment_form_meta_boxes( $post_type );
 
-		if ( $post_type == 'wpi_item' ) {
+        // For invoice items.
+        self::add_item_meta_boxes( $post_type );
 
-			// Item details.
-			add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
+        // For invoice discounts.
+        if ( $post_type == 'wpi_discount' ) {
+            add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
+        }
 
-			// If taxes are enabled, register the tax metabox.
-			if ( wpinv_use_taxes() ) {
-				add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
-			}
+    }
 
-			// Item info.
-			add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
+    /**
+     * Register core metaboxes.
+     */
+    protected static function add_payment_form_meta_boxes( $post_type ) {
 
-		}
+        // For payment forms.
+        if ( $post_type == 'wpi_payment_form' ) {
 
-	}
+            // Design payment form.
+            add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
 
-	/**
-	 * Register invoice metaboxes.
-	 */
-	protected static function add_invoice_meta_boxes( $post_type, $post ) {
+            // Payment form information.
+            add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
 
-		// For invoices...
-		if ( getpaid_is_invoice_post_type( $post_type ) ) {
-			$invoice = new WPInv_Invoice( $post );
+        }
 
-			// Resend invoice.
-			if ( ! $invoice->is_draft() ) {
+    }
 
-				add_meta_box(
-					'wpinv-mb-resend-invoice',
-					sprintf(
-						__( 'Resend %s', 'invoicing' ),
-						ucfirst( $invoice->get_invoice_quote_type() )
-					),
-					'GetPaid_Meta_Box_Resend_Invoice::output',
-					$post_type,
-					'side',
-					'low'
-				);
+    /**
+     * Register core metaboxes.
+     */
+    protected static function add_item_meta_boxes( $post_type ) {
 
-			}
+        if ( $post_type == 'wpi_item' ) {
 
-			// Subscriptions.
-			$subscriptions = getpaid_get_invoice_subscriptions( $invoice );
-			if ( ! empty( $subscriptions ) ) {
+            // Item details.
+            add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
 
-				if ( is_array( $subscriptions ) ) {
-					add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' );
-				} else {
-					add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' );
-				}
+            // If taxes are enabled, register the tax metabox.
+            if ( wpinv_use_taxes() ) {
+                add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
+            }
 
-				if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) {
-					add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' );
-				}
+            // Item info.
+            add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
 
-			}
+        }
 
-			// Invoice details.
-			add_meta_box(
-				'wpinv-details',
-				sprintf(
-					__( '%s Details', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'GetPaid_Meta_Box_Invoice_Details::output',
-				$post_type,
-				'side'
-			);
-
-			// Payment details.
-			if ( ! $invoice->is_draft() ) {
-				add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' );
-			}
+    }
 
-			// Billing details.
-			add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' );
+    /**
+     * Register invoice metaboxes.
+     */
+    protected static function add_invoice_meta_boxes( $post_type, $post ) {
+
+        // For invoices...
+        if ( getpaid_is_invoice_post_type( $post_type ) ) {
+            $invoice = new WPInv_Invoice( $post );
+
+            // Resend invoice.
+            if ( ! $invoice->is_draft() ) {
+
+                add_meta_box(
+                    'wpinv-mb-resend-invoice',
+                    sprintf(
+                        __( 'Resend %s', 'invoicing' ),
+                        ucfirst( $invoice->get_invoice_quote_type() )
+                    ),
+                    'GetPaid_Meta_Box_Resend_Invoice::output',
+                    $post_type,
+                    'side',
+                    'low'
+                );
+
+            }
+
+            // Subscriptions.
+            $subscriptions = getpaid_get_invoice_subscriptions( $invoice );
+            if ( ! empty( $subscriptions ) ) {
+
+                if ( is_array( $subscriptions ) ) {
+                    add_meta_box( 'wpinv-mb-subscriptions', __( 'Related Subscriptions', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_related', $post_type, 'advanced' );
+                } else {
+                    add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' );
+                }
+
+                if ( getpaid_count_subscription_invoices( $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id() ) > 1 ) {
+                    add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' );
+                }
+
+            }
+
+            // Invoice details.
+            add_meta_box(
+                'wpinv-details',
+                sprintf(
+                    __( '%s Details', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'GetPaid_Meta_Box_Invoice_Details::output',
+                $post_type,
+                'side'
+            );
+
+            // Payment details.
+            if ( ! $invoice->is_draft() ) {
+                add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' );
+            }
+
+            // Billing details.
+            add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' );
 			
-			// Invoice items.
-			add_meta_box(
-				'wpinv-items',
-				sprintf(
-					__( '%s Items', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'GetPaid_Meta_Box_Invoice_Items::output',
-				$post_type,
-				'normal',
-				'high'
-			);
+            // Invoice items.
+            add_meta_box(
+                'wpinv-items',
+                sprintf(
+                    __( '%s Items', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'GetPaid_Meta_Box_Invoice_Items::output',
+                $post_type,
+                'normal',
+                'high'
+            );
 			
-			// Invoice notes.
-			add_meta_box(
-				'wpinv-notes',
-				sprintf(
-					__( '%s Notes', 'invoicing' ),
-					ucfirst( $invoice->get_invoice_quote_type() )
-				),
-				'WPInv_Meta_Box_Notes::output',
-				$post_type,
-				'side',
-				'low'
-			);
-
-			// Shipping Address.
-			if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) {
-				add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' );
-			}
-
-			// Payment form information.
-			if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) {
-				add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' );
-			}
-
-		}
-
-	}
-
-	/**
-	 * Remove some metaboxes.
-	 */
-	public static function remove_meta_boxes() {
-		remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
-	}
-
-	/**
-	 * Rename other metaboxes.
-	 */
-	public static function rename_meta_boxes() {
+            // Invoice notes.
+            add_meta_box(
+                'wpinv-notes',
+                sprintf(
+                    __( '%s Notes', 'invoicing' ),
+                    ucfirst( $invoice->get_invoice_quote_type() )
+                ),
+                'WPInv_Meta_Box_Notes::output',
+                $post_type,
+                'side',
+                'low'
+            );
+
+            // Shipping Address.
+            if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) {
+                add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' );
+            }
+
+            // Payment form information.
+            if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) {
+                add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' );
+            }
+
+        }
+
+    }
+
+    /**
+     * Remove some metaboxes.
+     */
+    public static function remove_meta_boxes() {
+        remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
+    }
+
+    /**
+     * Rename other metaboxes.
+     */
+    public static function rename_meta_boxes() {
 		
-	}
-
-	/**
-	 * Check if we're saving, then trigger an action based on the post type.
-	 *
-	 * @param  int    $post_id Post ID.
-	 * @param  object $post Post object.
-	 */
-	public static function save_meta_boxes( $post_id, $post ) {
-		$post_id = absint( $post_id );
-		$data    = wp_unslash( $_POST );
-
-		// Do not save for ajax requests.
-		if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
-			return;
-		}
-
-		// $post_id and $post are required
-		if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
-			return;
-		}
-
-		// Dont' save meta boxes for revisions or autosaves.
-		if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
-			return;
-		}
-
-		// Check the nonce.
-		if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
-			return;
-		}
-
-		// Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
-		if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
-			return;
-		}
-
-		// Check user has permission to edit.
-		if ( ! current_user_can( 'edit_post', $post_id ) ) {
-			return;
-		}
-
-		if ( getpaid_is_invoice_post_type( $post->post_type ) ) {
-
-			// We need this save event to run once to avoid potential endless loops.
-			self::$saved_meta_boxes = true;
-
-			return GetPaid_Meta_Box_Invoice_Address::save( $post_id );
-
-		}
-
-		// Ensure this is our post type.
-		$post_types_map = array(
-			'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
-			'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
-			'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
-		);
-
-		// Is this our post type?
-		if ( ! isset( $post_types_map[ $post->post_type ] ) ) {
-			return;
-		}
-
-		// We need this save event to run once to avoid potential endless loops.
-		self::$saved_meta_boxes = true;
+    }
+
+    /**
+     * Check if we're saving, then trigger an action based on the post type.
+     *
+     * @param  int    $post_id Post ID.
+     * @param  object $post Post object.
+     */
+    public static function save_meta_boxes( $post_id, $post ) {
+        $post_id = absint( $post_id );
+        $data    = wp_unslash( $_POST );
+
+        // Do not save for ajax requests.
+        if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
+            return;
+        }
+
+        // $post_id and $post are required
+        if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
+            return;
+        }
+
+        // Dont' save meta boxes for revisions or autosaves.
+        if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
+            return;
+        }
+
+        // Check the nonce.
+        if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
+            return;
+        }
+
+        // Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
+        if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
+            return;
+        }
+
+        // Check user has permission to edit.
+        if ( ! current_user_can( 'edit_post', $post_id ) ) {
+            return;
+        }
+
+        if ( getpaid_is_invoice_post_type( $post->post_type ) ) {
+
+            // We need this save event to run once to avoid potential endless loops.
+            self::$saved_meta_boxes = true;
+
+            return GetPaid_Meta_Box_Invoice_Address::save( $post_id );
+
+        }
+
+        // Ensure this is our post type.
+        $post_types_map = array(
+            'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
+            'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
+            'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
+        );
+
+        // Is this our post type?
+        if ( ! isset( $post_types_map[ $post->post_type ] ) ) {
+            return;
+        }
+
+        // We need this save event to run once to avoid potential endless loops.
+        self::$saved_meta_boxes = true;
 		
-		// Save the post.
-		$class = $post_types_map[ $post->post_type ];
-		$class::save( $post_id, $_POST, $post );
+        // Save the post.
+        $class = $post_types_map[ $post->post_type ];
+        $class::save( $post_id, $_POST, $post );
 
-	}
+    }
 
 }

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

Indentation +390 added lines, -390 removed lines

@@ -12,472 +12,472 @@
  */
 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_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( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', 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;
-		}
+    /**
+     * 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_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( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', 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;
+        }
 
-		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'] );
-
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		// Process a refund.
-		if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
+        // Process a refund.
+        if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], 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 %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', 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/wpinv-subscription.php

Indentation +1035 added lines, -1035 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,545 +177,545 @@ 
 	|
     */
 
-	/*
-	|--------------------------------------------------------------------------
-	| Getters
-	|--------------------------------------------------------------------------
-	*/
+    /*
+	|--------------------------------------------------------------------------
+	| 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
+     */
+    public function get_parent_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_original_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Get parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_invoice( $context = 'view' ) {
+        return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_payment( $context = 'view' ) {
+        return $this->get_parent_invoice( $context );
+    }
+
+    /**
+     * Get subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_product_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'product_id', $context );
+    }
+
+    /**
+     * Get the subscription product.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Item
+     */
+    public function get_product( $context = 'view' ) {
+        return new WPInv_Item( $this->get_product_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice's gateway.
+     *
+     * Here for backwards compatibility.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gateway( $context = 'view' ) {
+        return $this->get_parent_invoice( $context )->get_gateway();
+    }
+
+    /**
+     * Get the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_period( $context = 'view' ) {
+        return $this->get_prop( 'period', $context );
+    }
+
+    /**
+     * Get number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_frequency( $context = 'view' ) {
+        return (int) $this->get_prop( 'frequency', $context );
+    }
+
+    /**
+     * Get the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
+    }
+
+    /**
+     * Get the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
+    }
+
+    /**
+     * Get number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_bill_times( $context = 'view' ) {
+        return (int) $this->get_prop( 'bill_times', $context );
+    }
+
+    /**
+     * Get transaction id of this subscription's parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_transaction_id( $context = 'view' ) {
+        return $this->get_prop( 'transaction_id', $context );
+    }
+
+    /**
+     * Get the date that the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_created( $context = 'view' ) {
+        return $this->get_prop( 'created', $context );
+    }
+
+    /**
+     * Alias for self::get_created().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_created( $context );
+    }
+
+    /**
+     * Retrieves the creation date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_time_created() {
+        $created = $this->get_date_created();
+        return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get GMT date when the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
+        $date = $this->get_date_created( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date( $context = 'view' ) {
+        return $this->get_prop( 'expiration', $context );
+    }
+
+    /**
+     * Alias for self::get_next_renewal_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration( $context = 'view' ) {
+        return $this->get_next_renewal_date( $context );
+    }
+
+    /**
+     * Retrieves the expiration date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_expiration_time() {
+        $expiration = $this->get_expiration();
+
+        if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
+            return current_time( 'timestamp' );
+        }
+
+        $expiration = strtotime( $expiration, current_time( 'timestamp' ) );
+        return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
+    }
+
+    /**
+     * Get GMT date when the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date_gmt( $context = 'view' ) {
+        $date = $this->get_next_renewal_date( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_trial_period( $context = 'view' ) {
+        return $this->get_prop( 'trial_period', $context );
+    }
+
+    /**
+     * Get the subscription's status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
+    }
+
+    /**
+     * Get the subscription's profile id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_profile_id( $context = 'view' ) {
+        return $this->get_prop( 'profile_id', $context );
+    }
+
+    /*
+	|--------------------------------------------------------------------------
+	| Setters
+	|--------------------------------------------------------------------------
+	*/
+
+    /**
+     * Set customer id.
+     *
+     * @since 1.0.19
+     * @param  int $value The customer's id.
+     */
+    public function set_customer_id( $value ) {
+        $this->set_prop( 'customer_id', (int) $value );
+    }
+
+    /**
+     * Set parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_invoice_id( $value ) {
+        $this->set_prop( 'parent_payment_id', (int) $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_original_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Set subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription product id.
+     */
+    public function set_product_id( $value ) {
+        $this->set_prop( 'product_id', (int) $value );
+    }
+
+    /**
+     * Set the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $value The renewal period.
+     */
+    public function set_period( $value ) {
+        $this->set_prop( 'period', $value );
+    }
+
+    /**
+     * Set number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription frequency.
+     */
+    public function set_frequency( $value ) {
+        $value = empty( $value ) ? 1 : (int) $value;
+        $this->set_prop( 'frequency', absint( $value ) );
+    }
+
+    /**
+     * Set the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The initial subcription amount.
+     */
+    public function set_initial_amount( $value ) {
+        $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The recurring subcription amount.
+     */
+    public function set_recurring_amount( $value ) {
+        $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  int $value Bill times.
+     */
+    public function set_bill_times( $value ) {
+        $this->set_prop( 'bill_times', (int) $value );
+    }
+
+    /**
+     * 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 && $value !== '0000-00-00 00:00:00' ) {
+            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+            return;
+        }
+
+        $this->set_prop( 'created', '' );
 
-	/**
-	 * 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().
+    /**
+     * Alias for self::set_created().
      *
-     * @since  1.0.0
-     * @return int
+     * @since 1.0.19
+     * @param string $value strtotime compliant date.
      */
-    public function get_original_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
+    public function set_date_created( $value ) {
+        $this->set_created( $value );
     }
 
-	/**
-	 * Get parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-	public function get_parent_invoice( $context = 'view' ) {
-		return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Invoice
-	 */
-    public function get_parent_payment( $context = 'view' ) {
-        return $this->get_parent_invoice( $context );
-	}
-
-	/**
-	 * Get subscription's product id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_product_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'product_id', $context );
-	}
-
-	/**
-	 * Get the subscription product.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WPInv_Item
-	 */
-	public function get_product( $context = 'view' ) {
-		return new WPInv_Item( $this->get_product_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice's gateway.
-	 *
-	 * Here for backwards compatibility.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_gateway( $context = 'view' ) {
-		return $this->get_parent_invoice( $context )->get_gateway();
-	}
-
-	/**
-	 * Get the period of a renewal.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_period( $context = 'view' ) {
-		return $this->get_prop( 'period', $context );
-	}
-
-	/**
-	 * Get number of periods each renewal is valid for.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_frequency( $context = 'view' ) {
-		return (int) $this->get_prop( 'frequency', $context );
-	}
-
-	/**
-	 * Get the initial amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
-	}
-
-	/**
-	 * Get the recurring amount for the subscription.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_amount( $context = 'view' ) {
-		return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
-	}
-
-	/**
-	 * Get number of times that this subscription can be renewed.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_bill_times( $context = 'view' ) {
-		return (int) $this->get_prop( 'bill_times', $context );
-	}
-
-	/**
-	 * Get transaction id of this subscription's parent invoice.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_transaction_id( $context = 'view' ) {
-		return $this->get_prop( 'transaction_id', $context );
-	}
-
-	/**
-	 * Get the date that the subscription was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_created( $context = 'view' ) {
-		return $this->get_prop( 'created', $context );
-	}
-
-	/**
-	 * Alias for self::get_created().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_created( $context );
-	}
-
-	/**
-	 * Retrieves the creation date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_time_created() {
-		$created = $this->get_date_created();
-		return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
-	}
-
-	/**
-	 * Get GMT date when the subscription was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
-        $date = $this->get_date_created( $context );
+    /**
+     * Set 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 ) {
-            $date = get_gmt_from_date( $date );
+        if ( $date && $value !== '0000-00-00 00:00:00' ) {
+            $this->set_prop( 'expiration', 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( 'expiration', '' );
 
-	/**
-	 * 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_next_renewal_date().
      *
      * @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 ) {
-        $date = strtotime( $value );
+    public function set_expiration( $value ) {
+        $this->set_next_renewal_date( $value );
+    }
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) );
+    /**
+     * 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;
         }
 
-		$this->set_prop( 'created', '' );
+        $old_status = $this->get_status();
+        $this->set_prop( 'status', $new_status );
 
-	}
+        if ( true === $this->object_read && $old_status !== $new_status ) {
+            $this->status_transition = array(
+                'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
+                'to'     => $new_status,
+            );
+        }
 
-	/**
-	 * Alias for self::set_created().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_date_created( $value ) {
-		$this->set_created( $value );
     }
 
-	/**
-	 * Set the 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 (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 ) );
+    }
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
-            return;
-		}
-
-		$this->set_prop( 'expiration', '' );
-
-	}
-
-	/**
-	 * Alias for self::set_next_renewal_date().
-	 *
-	 * @since 1.0.19
-	 * @param string $value strtotime compliant date.
-	 */
-	public function set_expiration( $value ) {
-		$this->set_next_renewal_date( $value );
-    }
-
-	/**
-	 * Set the subscription's trial period.
-	 *
-	 * @since 1.0.19
-	 * @param string $value trial period e.g 1 year.
-	 */
-	public function set_trial_period( $value ) {
-		$this->set_prop( 'trial_period', $value );
-	}
-
-	/**
-	 * Set the subscription's status.
-	 *
-	 * @since 1.0.19
-	 * @param string $new_status    New subscription status.
-	 */
-	public function set_status( $new_status ) {
-
-		// Abort if this is not a valid status;
-		if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) {
-			return;
-		}
-
-		$old_status = $this->get_status();
-		$this->set_prop( 'status', $new_status );
-
-		if ( true === $this->object_read && $old_status !== $new_status ) {
-			$this->status_transition = array(
-				'from'   => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status,
-				'to'     => $new_status,
-			);
-		}
-
-	}
-
-	/**
-	 * Set the subscription's (remote) profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value the remote profile id.
-	 */
-	public function set_profile_id( $value ) {
-		$this->set_prop( 'profile_id', sanitize_text_field( $value ) );
-	}
-
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Boolean methods
 	|--------------------------------------------------------------------------
@@ -724,55 +724,55 @@ 
 	|
 	*/
 
-	/**
+    /**
      * Checks if the subscription has a given status.
-	 *
-	 * @param string|array String or array of strings to check for.
-	 * @return bool
+     *
+     * @param string|array String or array of strings to check for.
+     * @return bool
      */
     public function has_status( $status ) {
         return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) );
-	}
+    }
 
-	/**
+    /**
      * Checks if the subscription has a trial period.
-	 *
-	 * @return bool
+     *
+     * @return bool
      */
     public function has_trial_period() {
-		$period = $this->get_trial_period();
+        $period = $this->get_trial_period();
         return ! empty( $period );
-	}
-
-	/**
-	 * Is the subscription active?
-	 *
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->has_status( 'active trialling' ) && ! $this->is_expired();
-	}
-
-	/**
-	 * Is the subscription expired?
-	 *
-	 * @return bool
-	 */
-	public function is_expired() {
-		return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
-	}
-
-	/**
-	 * Is this the last renewals?
-	 *
-	 * @return bool
-	 */
-	public function is_last_renewal() {
-		$max_bills = $this->get_bill_times();
-		return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
-	}
-
-	/*
+    }
+
+    /**
+     * Is the subscription active?
+     *
+     * @return bool
+     */
+    public function is_active() {
+        return $this->has_status( 'active trialling' ) && ! $this->is_expired();
+    }
+
+    /**
+     * Is the subscription expired?
+     *
+     * @return bool
+     */
+    public function is_expired() {
+        return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) );
+    }
+
+    /**
+     * Is this the last renewals?
+     *
+     * @return bool
+     */
+    public function is_last_renewal() {
+        $max_bills = $this->get_bill_times();
+        return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional methods
 	|--------------------------------------------------------------------------
@@ -781,27 +781,27 @@ 
 	|
 	*/
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function create( $data = array() ) {
+    /**
+     * Backwards compatibilty.
+     */
+    public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
-	}
+    }
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function update( $args = array() ) {
-		return $this->create( $args );
-	}
+    /**
+     * Backwards compatibilty.
+     */
+    public function update( $args = array() ) {
+        return $this->create( $args );
+    }
 
     /**
      * Retrieve renewal payments for a subscription
@@ -811,22 +811,22 @@ 
      */
     public function get_child_payments( $hide_pending = true ) {
 
-		$statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
+        $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
 
-		if ( ! $hide_pending ) {
-			$statuses = array_keys( wpinv_get_invoice_statuses() );
-		}
+        if ( ! $hide_pending ) {
+            $statuses = array_keys( wpinv_get_invoice_statuses() );
+        }
 
         return get_posts(
-			array(
-            	'post_parent'    => $this->get_parent_payment_id(),
-            	'numberposts'    => -1,
-            	'post_status'    => $statuses,
-            	'orderby'        => 'ID',
-            	'order'          => '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'
+            )
+        );
     }
 
     /**
@@ -836,7 +836,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() );
     }
 
     /**
@@ -860,57 +860,57 @@ 
      *
      * @since  2.4
      * @param  array $args Array of values for the payment, including amount and transaction ID
-	 * @param  WPInv_Invoice $invoice If adding an existing invoice.
+     * @param  WPInv_Invoice $invoice If adding an existing invoice.
      * @return bool
      */
     public function add_payment( $args = array(), $invoice = false ) {
 
-		// Process each payment once.
+        // Process each payment once.
         if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
             return false;
         }
 
-		// Are we creating a new invoice?
-		if ( empty( $invoice ) ) {
-			$invoice = $this->create_payment();
+        // Are we creating a new invoice?
+        if ( empty( $invoice ) ) {
+            $invoice = $this->create_payment();
 
-			if ( empty( $invoice ) ) {
-				return false;
-			}
+            if ( empty( $invoice ) ) {
+                return false;
+            }
 
-		}
+        }
 
-		$invoice->set_status( 'wpi-renewal' );
+        $invoice->set_status( 'wpi-renewal' );
 
-		// Maybe set a transaction id.
-		if ( ! empty( $args['transaction_id'] ) ) {
-			$invoice->set_transaction_id( $args['transaction_id'] );
-		}
+        // Maybe set a transaction id.
+        if ( ! empty( $args['transaction_id'] ) ) {
+            $invoice->set_transaction_id( $args['transaction_id'] );
+        }
 
-		// Set the completed date.
-		$invoice->set_completed_date( current_time( 'mysql' ) );
+        // Set the completed date.
+        $invoice->set_completed_date( current_time( 'mysql' ) );
 
-		// And the gateway.
-		if ( ! empty( $args['gateway'] ) ) {
-			$invoice->set_gateway( $args['gateway'] );
-		}
+        // And the gateway.
+        if ( ! empty( $args['gateway'] ) ) {
+            $invoice->set_gateway( $args['gateway'] );
+        }
 
-		$invoice->save();
+        $invoice->save();
 
-		if ( ! $invoice->exists() ) {
-			return false;
-		}
+        if ( ! $invoice->exists() ) {
+            return false;
+        }
 
-		do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
-		do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
+        do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
+        do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
         do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() );
 
         update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id );
 
         return $invoice->get_id();
-	}
+    }
 
-	/**
+    /**
      * Creates a new invoice and returns it.
      *
      * @since  1.0.19
@@ -918,124 +918,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
@@ -1044,19 +1044,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
@@ -1069,96 +1069,96 @@ 
         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( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' );
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can have their payment method updated
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
-	}
-
-	/**
-	 * Retrieves the URL to update subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_update_url() {
-		$url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the subscription status label
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_status_label() {
-		return getpaid_get_subscription_status_label( $this->get_status() );
-	}
-
-	/**
-	 * Retrieves the subscription status class
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_status_class() {
-		$statuses = getpaid_get_subscription_status_classes();
-		return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
-	}
+    /**
+     * 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-nonce' );
+        return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can have their payment method updated
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_update() {
+        return apply_filters( 'wpinv_subscription_can_update', false, $this );
+    }
+
+    /**
+     * Retrieves the URL to update subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_update_url() {
+        $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) );
+        return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the subscription status label
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_status_label() {
+        return getpaid_get_subscription_status_label( $this->get_status() );
+    }
+
+    /**
+     * Retrieves the subscription status class
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_status_class() {
+        $statuses = getpaid_get_subscription_status_classes();
+        return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
+    }
 
     /**
      * Retrieves the subscription status label
@@ -1168,11 +1168,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>";
     }
 
     /**
@@ -1183,75 +1183,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/gateways/class-getpaid-payment-gateway.php

Indentation +608 added lines, -608 removed lines

@@ -13,462 +13,462 @@ 
  */
 abstract class GetPaid_Payment_Gateway {
 
-	/**
-	 * Set if the place checkout button should be renamed on selection.
-	 *
-	 * @var string
-	 */
-	public $checkout_button_text;
-
-	/**
-	 * Boolean whether the method is enabled.
-	 *
-	 * @var bool
-	 */
-	public $enabled = true;
-
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	public $id;
-
-	/**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 10;
-
-	/**
-	 * Payment method title for the frontend.
-	 *
-	 * @var string
-	 */
-	public $title;
-
-	/**
-	 * Payment method description for the frontend.
-	 *
-	 * @var string
-	 */
-	public $description;
-
-	/**
-	 * Gateway title.
-	 *
-	 * @var string
-	 */
-	public $method_title = '';
-
-	/**
-	 * Gateway description.
-	 *
-	 * @var string
-	 */
-	public $method_description = '';
-
-	/**
-	 * Countries this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $countries;
-
-	/**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies;
-
-	/**
-	 * Currencies this gateway is not allowed for.
-	 *
-	 * @var array
-	 */
-	public $exclude_currencies;
-
-	/**
-	 * Maximum transaction amount, zero does not define a maximum.
-	 *
-	 * @var int
-	 */
-	public $max_amount = 0;
-
-	/**
-	 * Optional URL to view a transaction.
-	 *
-	 * @var string
-	 */
-	public $view_transaction_url = '';
-
-	/**
-	 * Optional URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = '';
-
-	/**
-	 * Optional label to show for "new payment method" in the payment
-	 * method/token selection radio selection.
-	 *
-	 * @var string
-	 */
-	public $new_method_label = '';
-
-	/**
-	 * Contains a user's saved tokens for this gateway.
-	 *
-	 * @var array
-	 */
-	protected $tokens = array();
-
-	/**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
-	protected $supports = array();
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Register gateway.
-		add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
-
-		$this->enabled = wpinv_is_gateway_active( $this->id );
-
-		// Add support for various features.
-		foreach ( $this->supports as $feature ) {
-			add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' );
-		}
-
-		// Invoice addons.
-		if ( $this->supports( 'addons' ) ) {
-			add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 );
-		}
-
-		// Gateway settings.
-		add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
+    /**
+     * Set if the place checkout button should be renamed on selection.
+     *
+     * @var string
+     */
+    public $checkout_button_text;
+
+    /**
+     * Boolean whether the method is enabled.
+     *
+     * @var bool
+     */
+    public $enabled = true;
+
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 10;
+
+    /**
+     * Payment method title for the frontend.
+     *
+     * @var string
+     */
+    public $title;
+
+    /**
+     * Payment method description for the frontend.
+     *
+     * @var string
+     */
+    public $description;
+
+    /**
+     * Gateway title.
+     *
+     * @var string
+     */
+    public $method_title = '';
+
+    /**
+     * Gateway description.
+     *
+     * @var string
+     */
+    public $method_description = '';
+
+    /**
+     * Countries this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $countries;
+
+    /**
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies;
+
+    /**
+     * Currencies this gateway is not allowed for.
+     *
+     * @var array
+     */
+    public $exclude_currencies;
+
+    /**
+     * Maximum transaction amount, zero does not define a maximum.
+     *
+     * @var int
+     */
+    public $max_amount = 0;
+
+    /**
+     * Optional URL to view a transaction.
+     *
+     * @var string
+     */
+    public $view_transaction_url = '';
+
+    /**
+     * Optional URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = '';
+
+    /**
+     * Optional label to show for "new payment method" in the payment
+     * method/token selection radio selection.
+     *
+     * @var string
+     */
+    public $new_method_label = '';
+
+    /**
+     * Contains a user's saved tokens for this gateway.
+     *
+     * @var array
+     */
+    protected $tokens = array();
+
+    /**
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
+    protected $supports = array();
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Register gateway.
+        add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
+
+        $this->enabled = wpinv_is_gateway_active( $this->id );
+
+        // Add support for various features.
+        foreach ( $this->supports as $feature ) {
+            add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' );
+        }
+
+        // Invoice addons.
+        if ( $this->supports( 'addons' ) ) {
+            add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 );
+        }
+
+        // Gateway settings.
+        add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
 		
 
-		// Gateway checkout fiellds.
-		add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
-
-		// Process payment.
-		add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
-
-		// Change the checkout button text.
-		if ( ! empty( $this->checkout_button_text ) ) {
-			add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
-		}
-
-		// Check if a gateway is valid for a given currency.
-		add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
-
-		// Generate the transaction url.
-		add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
-
-		// Generate the subscription url.
-		add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 );
-
-		// Confirm payments.
-		add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
-
-		// Verify IPNs.
-		add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
-
-	}
-
-	/**
-	 * Checks if this gateway is a given gateway.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is( $gateway ) {
-		return $gateway == $this->id;
-	}
-
-	/**
-	 * Returns a users saved tokens for this gateway.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_tokens( $sandbox = null ) {
-
-		if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
-			$tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
-
-			if ( is_array( $tokens ) ) {
-				$this->tokens = $tokens;
-			}
-
-		}
-
-		if ( ! is_bool( $sandbox ) ) {
-			return $this->tokens;
-		}
-
-		// Filter tokens.
-		$args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
-		return wp_list_filter( $this->tokens, $args );
-
-	}
-
-	/**
-	 * Saves a token for this gateway.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_token( $token ) {
-
-		$tokens   = $this->get_tokens();
-		$tokens[] = $token;
-
-		update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
-
-		$this->tokens = $tokens;
-
-	}
-
-	/**
-	 * Return the title for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_title() {
-		return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
-	}
-
-	/**
-	 * Return the description for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_description() {
-		return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
-	}
-
-	/**
-	 * Get the success url.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_return_url( $invoice ) {
-
-		// Payment success url
-		$return_url = add_query_arg(
-			array(
-				'payment-confirm' => $this->id,
-				'invoice_key'     => $invoice->get_key(),
-				'utm_nooverride'  => 1
-			),
-			wpinv_get_success_page_uri()
-		);
-
-		return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
-	}
-
-	/**
-	 * Confirms payments when rendering the success page.
-	 *
-	 * @param string $content Success page content.
-	 * @return string
-	 */
-	public function confirm_payment( $content ) {
-
-		// Retrieve the invoice.
-		$invoice_id = getpaid_get_current_invoice_id();
-		$invoice    = wpinv_get_invoice( $invoice_id );
-
-		// Ensure that it exists and that it is pending payment.
-		if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
-			return $content;
-		}
-
-		// Can the user view this invoice??
-		if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
-			return $content;
-		}
-
-		// Show payment processing indicator.
-		return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {}
-
-	/**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
-
-	}
-
-	/**
-	 * Get a link to the transaction on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $transaction_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string transaction URL, or empty string.
-	 */
-	public function filter_transaction_url( $transaction_url, $invoice ) {
-
-		$transaction_id  = $invoice->get_transaction_id();
-
-		if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
-			$transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
-			$replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
-		}
-
-		return $transaction_url;
-	}
-
-	/**
-	 * Get a link to the subscription on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $subscription_url transaction url.
-	 * @param WPInv_Subscription $subscription Subscription objectt.
-	 * @return string subscription URL, or empty string.
-	 */
-	public function generate_subscription_url( $subscription_url, $subscription ) {
-
-		$profile_id      = $subscription->get_profile_id();
-
-		if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
-
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : '';
-			$subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
-
-		}
-
-		return $subscription_url;
-	}
-
-	/**
-	 * Check if the gateway is available for use.
-	 *
-	 * @return bool
-	 */
-	public function is_available() {
-		return ! empty( $this->enabled );
-	}
-
-	/**
-	 * Return the gateway's title.
-	 *
-	 * @return string
-	 */
-	public function get_title() {
-		return apply_filters( 'getpaid_gateway_title', $this->title, $this );
-	}
-
-	/**
-	 * Return the gateway's description.
-	 *
-	 * @return string
-	 */
-	public function get_description() {
-		return apply_filters( 'getpaid_gateway_description', $this->description, $this );
-	}
-
-	/**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return void
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
-		// Process the payment then either redirect to the success page or the gateway.
-		do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
-	}
-
-	/**
-	 * Process refund.
-	 *
-	 * If the gateway declares 'refunds' support, this will allow it to refund.
-	 * a passed in amount.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param  float  $amount Refund amount.
-	 * @param  string $reason Refund reason.
-	 * @return WP_Error|bool True or false based on success, or a WP_Error object.
-	 */
-	public function process_refund( $invoice, $amount = null, $reason = '' ) {
-		return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
-	}
-
-	/**
-	 * Displays the payment fields, credit cards etc.
-	 * 
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
-	public function payment_fields( $invoice_id, $form ) {
-		do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
-	}
-
-	/**
-	 * Filters the gateway settings.
-	 * 
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the value of a gateway setting.
-	 * 
-	 * @param string $option
-	 */
-	public function get_option( $option, $default = false ) {
-		return wpinv_get_option( $this->id . '_' . $option, $default );
-	}
-
-	/**
-	 * Check if a gateway supports a given feature.
-	 *
-	 * Gateways should override this to declare support (or lack of support) for a feature.
-	 * For backward compatibility, gateways support 'products' by default, but nothing else.
-	 *
-	 * @param string $feature string The name of a feature to test support for.
-	 * @return bool True if the gateway supports the feature, false otherwise.
-	 * @since 1.0.19
-	 */
-	public function supports( $feature ) {
-		return getpaid_payment_gateway_supports( $this->id, $feature );
-	}
-
-	/**
-	 * Returns the credit card form html.
-	 * 
-	 * @param bool $save whether or not to display the save button.
-	 */
+        // Gateway checkout fiellds.
+        add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
+
+        // Process payment.
+        add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+
+        // Change the checkout button text.
+        if ( ! empty( $this->checkout_button_text ) ) {
+            add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
+        }
+
+        // Check if a gateway is valid for a given currency.
+        add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
+
+        // Generate the transaction url.
+        add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
+
+        // Generate the subscription url.
+        add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 );
+
+        // Confirm payments.
+        add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
+
+        // Verify IPNs.
+        add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
+
+    }
+
+    /**
+     * Checks if this gateway is a given gateway.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is( $gateway ) {
+        return $gateway == $this->id;
+    }
+
+    /**
+     * Returns a users saved tokens for this gateway.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_tokens( $sandbox = null ) {
+
+        if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
+            $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
+
+            if ( is_array( $tokens ) ) {
+                $this->tokens = $tokens;
+            }
+
+        }
+
+        if ( ! is_bool( $sandbox ) ) {
+            return $this->tokens;
+        }
+
+        // Filter tokens.
+        $args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
+        return wp_list_filter( $this->tokens, $args );
+
+    }
+
+    /**
+     * Saves a token for this gateway.
+     *
+     * @since 1.0.19
+     */
+    public function save_token( $token ) {
+
+        $tokens   = $this->get_tokens();
+        $tokens[] = $token;
+
+        update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
+
+        $this->tokens = $tokens;
+
+    }
+
+    /**
+     * Return the title for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_title() {
+        return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
+    }
+
+    /**
+     * Return the description for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_description() {
+        return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
+    }
+
+    /**
+     * Get the success url.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_return_url( $invoice ) {
+
+        // Payment success url
+        $return_url = add_query_arg(
+            array(
+                'payment-confirm' => $this->id,
+                'invoice_key'     => $invoice->get_key(),
+                'utm_nooverride'  => 1
+            ),
+            wpinv_get_success_page_uri()
+        );
+
+        return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
+    }
+
+    /**
+     * Confirms payments when rendering the success page.
+     *
+     * @param string $content Success page content.
+     * @return string
+     */
+    public function confirm_payment( $content ) {
+
+        // Retrieve the invoice.
+        $invoice_id = getpaid_get_current_invoice_id();
+        $invoice    = wpinv_get_invoice( $invoice_id );
+
+        // Ensure that it exists and that it is pending payment.
+        if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
+            return $content;
+        }
+
+        // Can the user view this invoice??
+        if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
+            return $content;
+        }
+
+        // Show payment processing indicator.
+        return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {}
+
+    /**
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
+
+    }
+
+    /**
+     * Get a link to the transaction on the 3rd party gateway site (if applicable).
+     *
+     * @param string $transaction_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string transaction URL, or empty string.
+     */
+    public function filter_transaction_url( $transaction_url, $invoice ) {
+
+        $transaction_id  = $invoice->get_transaction_id();
+
+        if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
+            $transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
+            $replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
+        }
+
+        return $transaction_url;
+    }
+
+    /**
+     * Get a link to the subscription on the 3rd party gateway site (if applicable).
+     *
+     * @param string $subscription_url transaction url.
+     * @param WPInv_Subscription $subscription Subscription objectt.
+     * @return string subscription URL, or empty string.
+     */
+    public function generate_subscription_url( $subscription_url, $subscription ) {
+
+        $profile_id      = $subscription->get_profile_id();
+
+        if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+
+            $subscription_url = sprintf( $this->view_subscription_url, $profile_id );
+            $replace          = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : '';
+            $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
+
+        }
+
+        return $subscription_url;
+    }
+
+    /**
+     * Check if the gateway is available for use.
+     *
+     * @return bool
+     */
+    public function is_available() {
+        return ! empty( $this->enabled );
+    }
+
+    /**
+     * Return the gateway's title.
+     *
+     * @return string
+     */
+    public function get_title() {
+        return apply_filters( 'getpaid_gateway_title', $this->title, $this );
+    }
+
+    /**
+     * Return the gateway's description.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return apply_filters( 'getpaid_gateway_description', $this->description, $this );
+    }
+
+    /**
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return void
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
+        // Process the payment then either redirect to the success page or the gateway.
+        do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
+    }
+
+    /**
+     * Process refund.
+     *
+     * If the gateway declares 'refunds' support, this will allow it to refund.
+     * a passed in amount.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param  float  $amount Refund amount.
+     * @param  string $reason Refund reason.
+     * @return WP_Error|bool True or false based on success, or a WP_Error object.
+     */
+    public function process_refund( $invoice, $amount = null, $reason = '' ) {
+        return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
+    }
+
+    /**
+     * Displays the payment fields, credit cards etc.
+     * 
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
+    public function payment_fields( $invoice_id, $form ) {
+        do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
+    }
+
+    /**
+     * Filters the gateway settings.
+     * 
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the value of a gateway setting.
+     * 
+     * @param string $option
+     */
+    public function get_option( $option, $default = false ) {
+        return wpinv_get_option( $this->id . '_' . $option, $default );
+    }
+
+    /**
+     * Check if a gateway supports a given feature.
+     *
+     * Gateways should override this to declare support (or lack of support) for a feature.
+     * For backward compatibility, gateways support 'products' by default, but nothing else.
+     *
+     * @param string $feature string The name of a feature to test support for.
+     * @return bool True if the gateway supports the feature, false otherwise.
+     * @since 1.0.19
+     */
+    public function supports( $feature ) {
+        return getpaid_payment_gateway_supports( $this->id, $feature );
+    }
+
+    /**
+     * Returns the credit card form html.
+     * 
+     * @param bool $save whether or not to display the save button.
+     */
     public function get_cc_form( $save = false ) {
 
-		ob_start();
+        ob_start();
 
         $id_prefix = esc_attr( uniqid( $this->id ) );
 
@@ -563,11 +563,11 @@ 
                                         'name'              => $this->id . '[cc_cvv2]',
                                         'id'                => "$id_prefix-cc-cvv2",
                                         'label'             => __( 'CCV', 'invoicing' ),
-										'label_type'        => 'vertical',
-										'class'             => 'form-control-sm',
-										'extra_attributes'  => array(
-											'autocomplete'  => "cc-csc",
-										),
+                                        'label_type'        => 'vertical',
+                                        'class'             => 'form-control-sm',
+                                        'extra_attributes'  => array(
+                                            'autocomplete'  => "cc-csc",
+                                        ),
                                     )
                                 );
                             ?>
@@ -577,192 +577,192 @@ 
 					
 					<?php
 
-						if ( $save ) {
-							echo $this->save_payment_method_checkbox();
-						}
+                        if ( $save ) {
+                            echo $this->save_payment_method_checkbox();
+                        }
 
-					?>
+                    ?>
                 </div>
 
             </div>
 		<?php
 		
-		return ob_get_clean();
+        return ob_get_clean();
+
+    }
 
+    /**
+     * Displays a new payment method entry form.
+     *
+     * @since 1.0.19
+     */
+    public function new_payment_method_entry( $form ) {
+        echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
     }
 
-	/**
-	 * Displays a new payment method entry form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function new_payment_method_entry( $form ) {
-		echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
-	}
-
-	/**
-	 * Grab and display our saved payment methods.
-	 *
-	 * @since 1.0.19
-	 */
-	public function saved_payment_methods() {
-		$html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
-
-		foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
-			$html .= $this->get_saved_payment_method_option_html( $token );
-		}
-
-		$html .= $this->get_new_payment_method_option_html();
-		$html .= '</ul>';
-
-		echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
-	}
-
-	/**
-	 * Gets saved payment method HTML from a token.
-	 *
-	 * @since 1.0.19
-	 * @param  array $token Payment Token.
-	 * @return string Generated payment method HTML
-	 */
-	public function get_saved_payment_method_option_html( $token ) {
-
-		return sprintf(
-			'<li class="getpaid-payment-method form-group">
+    /**
+     * Grab and display our saved payment methods.
+     *
+     * @since 1.0.19
+     */
+    public function saved_payment_methods() {
+        $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
+
+        foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
+            $html .= $this->get_saved_payment_method_option_html( $token );
+        }
+
+        $html .= $this->get_new_payment_method_option_html();
+        $html .= '</ul>';
+
+        echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
+    }
+
+    /**
+     * Gets saved payment method HTML from a token.
+     *
+     * @since 1.0.19
+     * @param  array $token Payment Token.
+     * @return string Generated payment method HTML
+     */
+    public function get_saved_payment_method_option_html( $token ) {
+
+        return sprintf(
+            '<li class="getpaid-payment-method form-group">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" data-currency="%5$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s />
 					<span>%3$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_attr( $token['id'] ),
-			esc_html( $token['name'] ),
-			checked( empty( $token['default'] ), false, false ),
-			empty( $token['currency'] ) ? 'none' : esc_attr( $token['currency'] )
-		);
-
-	}
-
-	/**
-	 * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_new_payment_method_option_html() {
-
-		$label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
-
-		return sprintf(
-			'<li class="getpaid-new-payment-method">
+            esc_attr( $this->id ),
+            esc_attr( $token['id'] ),
+            esc_html( $token['name'] ),
+            checked( empty( $token['default'] ), false, false ),
+            empty( $token['currency'] ) ? 'none' : esc_attr( $token['currency'] )
+        );
+
+    }
+
+    /**
+     * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
+     *
+     * @since 1.0.19
+     */
+    public function get_new_payment_method_option_html() {
+
+        $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
+
+        return sprintf(
+            '<li class="getpaid-new-payment-method">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" data-currency="none" value="new" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_html( $label )
-		);
-
-	}
-
-	/**
-	 * Outputs a checkbox for saving a new payment method to the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_payment_method_checkbox() {
-
-		return aui()->input(
-			array(
-				'type'       => 'checkbox',
-				'name'       => esc_attr( "getpaid-$this->id-new-payment-method" ),
-				'id'         => esc_attr( uniqid( $this->id ) ),
-				'required'   => false,
-				'label'      => esc_html__( 'Save payment method', 'invoicing' ),
-				'value'      => 'true',
-				'checked'    => true,
-				'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1',
-			)
-		);
-
-	}
-
-	/**
-	 * Registers the gateway.
-	 *
-	 * @return array
-	 */
-	public function register_gateway( $gateways ) {
-
-		$gateways[ $this->id ] = array(
-
-			'admin_label'    => $this->method_title,
+            esc_attr( $this->id ),
+            esc_html( $label )
+        );
+
+    }
+
+    /**
+     * Outputs a checkbox for saving a new payment method to the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_payment_method_checkbox() {
+
+        return aui()->input(
+            array(
+                'type'       => 'checkbox',
+                'name'       => esc_attr( "getpaid-$this->id-new-payment-method" ),
+                'id'         => esc_attr( uniqid( $this->id ) ),
+                'required'   => false,
+                'label'      => esc_html__( 'Save payment method', 'invoicing' ),
+                'value'      => 'true',
+                'checked'    => true,
+                'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1',
+            )
+        );
+
+    }
+
+    /**
+     * Registers the gateway.
+     *
+     * @return array
+     */
+    public function register_gateway( $gateways ) {
+
+        $gateways[ $this->id ] = array(
+
+            'admin_label'    => $this->method_title,
             'checkout_label' => $this->title,
-			'ordering'       => $this->order,
+            'ordering'       => $this->order,
 
-		);
+        );
 
-		return $gateways;
+        return $gateways;
 
-	}
+    }
 
-	/**
-	 * Checks whether or not this is a sandbox request.
-	 *
-	 * @param  WPInv_Invoice|null $invoice Invoice object or null.
-	 * @return bool
-	 */
-	public function is_sandbox( $invoice = null ) {
+    /**
+     * Checks whether or not this is a sandbox request.
+     *
+     * @param  WPInv_Invoice|null $invoice Invoice object or null.
+     * @return bool
+     */
+    public function is_sandbox( $invoice = null ) {
 
-		if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
-			return $invoice->get_mode() == 'test';
-		}
+        if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
+            return $invoice->get_mode() == 'test';
+        }
 
-		return wpinv_is_test_mode( $this->id );
+        return wpinv_is_test_mode( $this->id );
 
-	}
+    }
 
-	/**
-	 * Renames the checkout button
-	 *
-	 * @return string
-	 */
-	public function rename_checkout_button() {
-		return $this->checkout_button_text;
-	}
+    /**
+     * Renames the checkout button
+     *
+     * @return string
+     */
+    public function rename_checkout_button() {
+        return $this->checkout_button_text;
+    }
 
-	/**
-	 * Validate gateway currency
-	 *
-	 * @return bool
-	 */
-	public function validate_currency( $validation, $currency ) {
+    /**
+     * Validate gateway currency
+     *
+     * @return bool
+     */
+    public function validate_currency( $validation, $currency ) {
 
-		// Required currencies.
-		if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
-			return false;
-		}
+        // Required currencies.
+        if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
+            return false;
+        }
 
-		// Excluded currencies.
-		if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
-			return false;
-		}
+        // Excluded currencies.
+        if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
+            return false;
+        }
 
-		return $validation;
-	}
+        return $validation;
+    }
 
-	/**
-	 * Displays an error
-	 *
-	 */
-	public function show_error( $code, $message, $type ) {
+    /**
+     * Displays an error
+     *
+     */
+    public function show_error( $code, $message, $type ) {
 
-		if ( is_admin() ) {
-			getpaid_admin()->{"show_$type"}( $message );
-		}
+        if ( is_admin() ) {
+            getpaid_admin()->{"show_$type"}( $message );
+        }
 
-		wpinv_set_error( $code, $message, $type );
+        wpinv_set_error( $code, $message, $type );
 
-	}
+    }
 
 }

includes/class-getpaid-invoice-notification-emails.php

Indentation +412 added lines, -412 removed lines

@@ -12,473 +12,473 @@
  */
 class GetPaid_Invoice_Notification_Emails {
 
-	/**
-	 * The array of invoice email actions.
-	 *
-	 * @param array
-	 */
-	public $invoice_actions;
-
-	/**
-	 * Class constructor
-	 *
-	 */
-	public function __construct() {
-
-		$this->invoice_actions = apply_filters(
-			'getpaid_notification_email_invoice_triggers',
-			array(
-				'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
-				'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
-				'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
-				'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
-				'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
-				'getpaid_invoice_status_publish'        => 'completed_invoice',
-				'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
-				'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
-				'getpaid_new_customer_note'             => 'user_note',
-				'getpaid_daily_maintenance'             => 'overdue',
-			)
-		);
-
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
-		add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
-
-		foreach ( $this->invoice_actions as $hook => $email_type ) {
-			$this->init_email_type_hook( $hook, $email_type );
-		}
-	}
-
-	/**
-	 * Registers an email hook for an invoice action.
-	 * 
-	 * @param string $hook
-	 * @param string|array $email_type
-	 */
-	public function init_email_type_hook( $hook, $email_type ) {
-
-		$email_type = wpinv_parse_list( $email_type );
-
-		foreach ( $email_type as $type ) {
-
-			$email = new GetPaid_Notification_Email( $type );
-
-			// Abort if it is not active.
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $type ) ) {
-				add_action( $hook, array( $this, $type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
-		}
-
-	}
-
-	/**
-	 * Filters invoice merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function invoice_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Invoice' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object )
-			);
-		}
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object->get_parent_payment() )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates invoice merge tags.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_invoice_merge_tags( $invoice ) {
-
-		// Abort if it does not exist.
-		if ( ! $invoice->get_id() ) {
-			return array();
-		}
-
-		$merge_tags = array(
-			'{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
-			'{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
-			'{email}'               => sanitize_email( $invoice->get_email() ),
-			'{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
-			'{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
-			'{invoice_total}'       => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ),
-			'{invoice_link}'        => esc_url( $invoice->get_view_url() ),
-			'{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
-			'{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
-			'{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
-			'{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
-			'{invoice_quote}'       => sanitize_text_field( strtolower( $invoice->get_label() ) ),
-			'{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
-			'{invoice_description}' => wp_kses_post( $invoice->get_description() ),
-			'{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
-			'{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
-		);
-
-		$payment_form_data = $invoice->get_meta( 'payment_form_data', true );
-
-		if ( is_array( $payment_form_data ) ) {
-
-			foreach ( $payment_form_data as $label => $value ) {
-
-				$label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) );
-				$value = is_array( $value ) ? implode( ', ', $value ) : $value;
-
-				if ( is_scalar ( $value ) ) {
-					$merge_tags[ "{{$label}}" ] = wp_kses_post( $value );
-				}
-
-			}
-
-		}
-
-		return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param string|array $recipients
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
-
-		do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
-
-		if ( apply_filters( 'getpaid_skip_invoice_email', false, $type, $invoice ) ) {
-			return;
-		}
-
-		$mailer     = new GetPaid_Notification_Email_Sender();
-		$merge_tags = $email->get_merge_tags();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$email->add_merge_tags( $email->get_subject(), $merge_tags ),
-			$email->get_content( $merge_tags, $extra_args ),
-			$email->get_attachments()
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
-				$email->get_content( $merge_tags ),
-				$email->get_attachments()
-			);
-		}
-
-		if ( $result ) {
-			$invoice->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		} else {
-			$invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );	
-		}
-
-		do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
-
-		return $result;
-	}
-
-	/**
-	 * Also send emails to any cc users.
-	 *
-	 * @param array $recipients
-	 * @param GetPaid_Notification_Email $email
-	 */
-	public function filter_email_recipients( $recipients, $email ) {
-
-		if ( ! $email->is_admin_email() ) {
-			$cc = $email->object->get_email_cc();
-
-			if ( ! empty( $cc ) ) {
-				$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-			}
+    /**
+     * The array of invoice email actions.
+     *
+     * @param array
+     */
+    public $invoice_actions;
+
+    /**
+     * Class constructor
+     *
+     */
+    public function __construct() {
+
+        $this->invoice_actions = apply_filters(
+            'getpaid_notification_email_invoice_triggers',
+            array(
+                'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
+                'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
+                'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
+                'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
+                'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
+                'getpaid_invoice_status_publish'        => 'completed_invoice',
+                'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
+                'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
+                'getpaid_new_customer_note'             => 'user_note',
+                'getpaid_daily_maintenance'             => 'overdue',
+            )
+        );
+
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
+        add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
+
+        foreach ( $this->invoice_actions as $hook => $email_type ) {
+            $this->init_email_type_hook( $hook, $email_type );
+        }
+    }
+
+    /**
+     * Registers an email hook for an invoice action.
+     * 
+     * @param string $hook
+     * @param string|array $email_type
+     */
+    public function init_email_type_hook( $hook, $email_type ) {
+
+        $email_type = wpinv_parse_list( $email_type );
+
+        foreach ( $email_type as $type ) {
+
+            $email = new GetPaid_Notification_Email( $type );
+
+            // Abort if it is not active.
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $type ) ) {
+                add_action( $hook, array( $this, $type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
+        }
+
+    }
+
+    /**
+     * Filters invoice merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function invoice_merge_tags( $merge_tags, $object ) {
+
+        if ( is_a( $object, 'WPInv_Invoice' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object )
+            );
+        }
+
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object->get_parent_payment() )
+            );
+        }
+
+        return $merge_tags;
+
+    }
+
+    /**
+     * Generates invoice merge tags.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_invoice_merge_tags( $invoice ) {
+
+        // Abort if it does not exist.
+        if ( ! $invoice->get_id() ) {
+            return array();
+        }
+
+        $merge_tags = array(
+            '{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
+            '{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
+            '{email}'               => sanitize_email( $invoice->get_email() ),
+            '{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
+            '{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
+            '{invoice_total}'       => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ),
+            '{invoice_link}'        => esc_url( $invoice->get_view_url() ),
+            '{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
+            '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
+            '{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
+            '{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
+            '{invoice_quote}'       => sanitize_text_field( strtolower( $invoice->get_label() ) ),
+            '{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
+            '{invoice_description}' => wp_kses_post( $invoice->get_description() ),
+            '{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
+            '{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+        );
+
+        $payment_form_data = $invoice->get_meta( 'payment_form_data', true );
+
+        if ( is_array( $payment_form_data ) ) {
+
+            foreach ( $payment_form_data as $label => $value ) {
+
+                $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) );
+                $value = is_array( $value ) ? implode( ', ', $value ) : $value;
+
+                if ( is_scalar ( $value ) ) {
+                    $merge_tags[ "{{$label}}" ] = wp_kses_post( $value );
+                }
+
+            }
+
+        }
+
+        return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
+    }
+
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param string|array $recipients
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
+
+        do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
+
+        if ( apply_filters( 'getpaid_skip_invoice_email', false, $type, $invoice ) ) {
+            return;
+        }
+
+        $mailer     = new GetPaid_Notification_Email_Sender();
+        $merge_tags = $email->get_merge_tags();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $email->add_merge_tags( $email->get_subject(), $merge_tags ),
+            $email->get_content( $merge_tags, $extra_args ),
+            $email->get_attachments()
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
+                $email->get_content( $merge_tags ),
+                $email->get_attachments()
+            );
+        }
+
+        if ( $result ) {
+            $invoice->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        } else {
+            $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );	
+        }
+
+        do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
+
+        return $result;
+    }
+
+    /**
+     * Also send emails to any cc users.
+     *
+     * @param array $recipients
+     * @param GetPaid_Notification_Email $email
+     */
+    public function filter_email_recipients( $recipients, $email ) {
+
+        if ( ! $email->is_admin_email() ) {
+            $cc = $email->object->get_email_cc();
+
+            if ( ! empty( $cc ) ) {
+                $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+                $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+            }
 
-		}
+        }
 
-		return $recipients;
+        return $recipients;
 
-	}
+    }
 
-	/**
-	 * Sends a new invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function new_invoice( $invoice ) {
+    /**
+     * Sends a new invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function new_invoice( $invoice ) {
 
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
-			return;
-		}
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a cancelled invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function cancelled_invoice( $invoice ) {
+    /**
+     * Sends a cancelled invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function cancelled_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a failed invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function failed_invoice( $invoice ) {
+    /**
+     * Sends a failed invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function failed_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is put on hold.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function onhold_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is put on hold.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function onhold_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is marked as processing payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function processing_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is marked as processing payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function processing_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is paid.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function completed_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is paid.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function completed_invoice( $invoice ) {
 
-		// (Maybe) abort if it is a renewal invoice.
-		if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
-			return;
-		}
+        // (Maybe) abort if it is a renewal invoice.
+        if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is refunded.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function refunded_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is refunded.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function refunded_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Notifies a user about new invoices
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param bool $force
-	 */
-	public function user_invoice( $invoice, $force = false ) {
+    /**
+     * Notifies a user about new invoices
+     *
+     * @param WPInv_Invoice $invoice
+     * @param bool $force
+     */
+    public function user_invoice( $invoice, $force = false ) {
 
-		if ( ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) {
-			return;
-		}
-
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) {
-			return;
-		}
+        if ( ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) {
+            return;
+        }
+
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
-
-	/**
-	 * Checks if an invoice is a payment form invoice.
-	 *
-	 * @param int $invoice
-	 * @return bool
-	 */
-	public function is_payment_form_invoice( $invoice ) {
-		$is_payment_form_invoice = empty( $_GET['getpaid-admin-action'] ) && ( 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ) || 'geodirectory' == get_post_meta( $invoice, 'wpinv_created_via', true ) );
-		return apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice );
-	}
+    }
+
+    /**
+     * Checks if an invoice is a payment form invoice.
+     *
+     * @param int $invoice
+     * @return bool
+     */
+    public function is_payment_form_invoice( $invoice ) {
+        $is_payment_form_invoice = empty( $_GET['getpaid-admin-action'] ) && ( 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ) || 'geodirectory' == get_post_meta( $invoice, 'wpinv_created_via', true ) );
+        return apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice );
+    }
 
-	/**
-	 * Notifies admin about new invoice notes
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $note
-	 */
-	public function user_note( $invoice, $note ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+    /**
+     * Notifies admin about new invoice notes
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $note
+     */
+    public function user_note( $invoice, $note ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
-
-	}
-
-	/**
-	 * (Force) Sends overdue notices.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function force_send_overdue_notice( $invoice ) {
-		$email = new GetPaid_Notification_Email( 'overdue', $invoice );
-		return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
-	}
-
-	/**
-	 * Sends overdue notices.
-	 *
-	 * @TODO: Create an invoices query class.
-	 */
-	public function overdue() {
-		global $wpdb;
-
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
-
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
-
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
-
-		// Retrieve date query.
-		$date_query = $this->get_date_query( $reminder_days );
-
-		// Invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-
-		// Fetch invoices.
-		$invoices  = $wpdb->get_col(
-			"SELECT posts.ID FROM $wpdb->posts as posts
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
+
+    }
+
+    /**
+     * (Force) Sends overdue notices.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function force_send_overdue_notice( $invoice ) {
+        $email = new GetPaid_Notification_Email( 'overdue', $invoice );
+        return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
+    }
+
+    /**
+     * Sends overdue notices.
+     *
+     * @TODO: Create an invoices query class.
+     */
+    public function overdue() {
+        global $wpdb;
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Retrieve date query.
+        $date_query = $this->get_date_query( $reminder_days );
+
+        // Invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+
+        // Fetch invoices.
+        $invoices  = $wpdb->get_col(
+            "SELECT posts.ID FROM $wpdb->posts as posts
 			LEFT JOIN $table as invoices ON invoices.post_id = posts.ID
 			WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query");
 
-		foreach ( $invoices as $invoice ) {
+        foreach ( $invoices as $invoice ) {
 
-			// Only send this email for invoices created via the admin page.
-			if ( ! $this->is_payment_form_invoice( $invoice ) ) {
-				$invoice       = new WPInv_Invoice( $invoice );
-				$email->object = $invoice;
+            // Only send this email for invoices created via the admin page.
+            if ( ! $this->is_payment_form_invoice( $invoice ) ) {
+                $invoice       = new WPInv_Invoice( $invoice );
+                $email->object = $invoice;
 
-				if ( $invoice->needs_payment() ) {
-					$this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
-				}
+                if ( $invoice->needs_payment() ) {
+                    $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
+                }
 
-			}
+            }
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Calculates the date query for an invoices query
-	 *
-	 * @param array $reminder_days
-	 * @return string
-	 */
-	public function get_date_query( $reminder_days ) {
+    /**
+     * Calculates the date query for an invoices query
+     *
+     * @param array $reminder_days
+     * @return string
+     */
+    public function get_date_query( $reminder_days ) {
 
-		$date_query = array(
-			'relation'  => 'OR'
-		);
+        $date_query = array(
+            'relation'  => 'OR'
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
 
-			$date_query[] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $date_query[] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
+        $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
 
-		return $date_query->get_sql();
+        return $date_query->get_sql();
 
-	}
+    }
 
 }

includes/class-getpaid-notification-email-sender.php

Indentation +134 added lines, -134 removed lines

@@ -13,17 +13,17 @@ 
 class GetPaid_Notification_Email_Sender {
 
     /**
-	 * Whether or not we should inline CSS into the email.
-	 */
-	public $inline_css = true;
+     * Whether or not we should inline CSS into the email.
+     */
+    public $inline_css = true;
 
     /**
-	 * The wp_mail() data.
-	 */
+     * The wp_mail() data.
+     */
     public $wp_mail_data = null;
 
     /**
-	 * Sends a new email.
+     * Sends a new email.
      * 
      * @param string|array $to The recipients email or an array of recipient emails.
      * @param string $subject The email's subject.
@@ -31,49 +31,49 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	public function send( $to, $subject, $email, $attachments = array() ) {
+     */
+    public function send( $to, $subject, $email, $attachments = array() ) {
 
-		/*
+        /*
 		 * Allow to filter data on per-email basis.
 		 */
-		$data = apply_filters(
-			'getpaid_email_data',
-			array(
-				'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
-				'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
-				'email'       => apply_filters( 'wpinv_mail_content', $email ),
-				'headers'     => $this->get_headers(),
-				'attachments' => $attachments,
-			),
-			$this
-		);
+        $data = apply_filters(
+            'getpaid_email_data',
+            array(
+                'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
+                'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
+                'email'       => apply_filters( 'wpinv_mail_content', $email ),
+                'headers'     => $this->get_headers(),
+                'attachments' => $attachments,
+            ),
+            $this
+        );
 
         // Remove slashes.
         $data               = (array) wp_unslash( $data );
 
         // Cache it.
-		$this->wp_mail_data = $data;
+        $this->wp_mail_data = $data;
 
-		// Attach our own hooks.
-		$this->before_sending();
+        // Attach our own hooks.
+        $this->before_sending();
 
         $result = false;
 
         foreach ( $this->wp_mail_data['to'] as $to ) {
-			$result = $this->_send( $to, $data );
+            $result = $this->_send( $to, $data );
         }
 
-		// Remove our hooks.
-		$this->after_sending();		
+        // Remove our hooks.
+        $this->after_sending();		
 
-		$this->wp_mail_data = null;
+        $this->wp_mail_data = null;
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * Does the actual sending.
+    /**
+     * Does the actual sending.
      * 
      * @param string $to The recipient's email.
      * @param array $data The email's data.
@@ -81,81 +81,81 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	protected function _send( $to, $data ) {
-
-		// Prepare the sending function.
-		$sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
-
-		// Send the actual email.
-		$result = call_user_func(
-			$sending_function,
-			$to,
-			html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
-			$data['email'],
-			$data['headers'],
-			$data['attachments']
-		);
-
-		if ( ! $result ) {
-			$log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
-			wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
-		}
-
-		return $result;
-	}
+     */
+    protected function _send( $to, $data ) {
+
+        // Prepare the sending function.
+        $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
+
+        // Send the actual email.
+        $result = call_user_func(
+            $sending_function,
+            $to,
+            html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
+            $data['email'],
+            $data['headers'],
+            $data['attachments']
+        );
+
+        if ( ! $result ) {
+            $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
+            wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
+        }
+
+        return $result;
+    }
     
     /**
-	 * Retrieves email headers.
-	 */
-	public function get_headers() {
+     * Retrieves email headers.
+     */
+    public function get_headers() {
 
-		$name       = $this->get_from_name();
-		$reply_to   = $this->get_reply_to();
-		$headers    = array( "Reply-To:$name <$reply_to>" );
+        $name       = $this->get_from_name();
+        $reply_to   = $this->get_reply_to();
+        $headers    = array( "Reply-To:$name <$reply_to>" );
 
-		return apply_filters( 'getpaid_email_headers',  $headers, $this );
+        return apply_filters( 'getpaid_email_headers',  $headers, $this );
 
-	}
+    }
 
     /**
-	 * Fires before an email is sent
-	 *
-	 * @since 1.0.0
-	 */
-	public function before_sending() {
+     * Fires before an email is sent
+     *
+     * @since 1.0.0
+     */
+    public function before_sending() {
 
         do_action( 'getpaid_before_send_email', $this );
-		add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
+        add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
 
-	}
+    }
 
     /**
-	 * Returns the from name.
-	 */
-	public function get_from_name() {
+     * Returns the from name.
+     */
+    public function get_from_name() {
 
         $from_name = wpinv_get_option( 'email_from_name', get_bloginfo( 'name' ) );
 
-		if ( empty( $from_name ) ) {
-			$from_name =  get_bloginfo( 'name' );
+        if ( empty( $from_name ) ) {
+            $from_name =  get_bloginfo( 'name' );
         }
 
-		return wp_specialchars_decode( $from_name, ENT_QUOTES );
+        return wp_specialchars_decode( $from_name, ENT_QUOTES );
     }
 
     /**
-	 * Returns the from email.
-	 */
-	public function get_from_address() {
+     * Returns the from email.
+     */
+    public function get_from_address() {
 
         $from_address = wpinv_get_option( 'email_from', $this->default_from_address() );
 
-		if ( ! is_email( $from_address ) ) {
-			$from_address =  $this->default_from_address();
+        if ( ! is_email( $from_address ) ) {
+            $from_address =  $this->default_from_address();
         }
         
         return $from_address;
@@ -163,75 +163,75 @@ 
     }
 
     /**
-	 * The default emails from address.
-	 * 
-	 * Defaults to wordpress@$sitename
-	 * Some hosts will block outgoing mail from this address if it doesn't exist,
-	 * but there's no easy alternative. Defaulting to admin_email might appear to be
-	 * another option, but some hosts may refuse to relay mail from an unknown domain.
-	 *
-	 */
-	public function default_from_address() {
-
-		// Get the site domain and get rid of www.
-		$sitename = strtolower( $_SERVER['SERVER_NAME'] );
-		if ( substr( $sitename, 0, 4 ) == 'www.' ) {
-			$sitename = substr( $sitename, 4 );
-		}
-
-		$from_email = 'wordpress@' . $sitename;
-
-		return apply_filters( 'getpaid_default_from_address', $from_email );
+     * The default emails from address.
+     * 
+     * Defaults to wordpress@$sitename
+     * Some hosts will block outgoing mail from this address if it doesn't exist,
+     * but there's no easy alternative. Defaulting to admin_email might appear to be
+     * another option, but some hosts may refuse to relay mail from an unknown domain.
+     *
+     */
+    public function default_from_address() {
+
+        // Get the site domain and get rid of www.
+        $sitename = strtolower( $_SERVER['SERVER_NAME'] );
+        if ( substr( $sitename, 0, 4 ) == 'www.' ) {
+            $sitename = substr( $sitename, 4 );
+        }
+
+        $from_email = 'wordpress@' . $sitename;
+
+        return apply_filters( 'getpaid_default_from_address', $from_email );
 
     }
     
     /**
-	 * Get the email reply-to.
-	 *
-	 *
-	 * @return string The email reply-to address.
-	 */
-	public function get_reply_to() {
+     * Get the email reply-to.
+     *
+     *
+     * @return string The email reply-to address.
+     */
+    public function get_reply_to() {
 
-		$reply_to = wpinv_get_admin_email();
+        $reply_to = wpinv_get_admin_email();
 
-		if ( ! is_email( $reply_to ) ) {
-			$reply_to =  get_option( 'admin_email' );
-		}
+        if ( ! is_email( $reply_to ) ) {
+            $reply_to =  get_option( 'admin_email' );
+        }
 
-		return $reply_to;
+        return $reply_to;
     }
     
     /**
-	 * Get the email content type.
-	 *
-	 */
-	public function get_content_type() {
-		return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
+     * Get the email content type.
+     *
+     */
+    public function get_content_type() {
+        return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
     }
     
     /**
-	 * Ensures that our email messages are not messed up by template plugins.
-	 *
-	 * @return array wp_mail_data.
-	 */
-	public function ensure_email_content( $args ) {
-		$args['message'] = $this->wp_mail_data['email'];
-		return $args;
+     * Ensures that our email messages are not messed up by template plugins.
+     *
+     * @return array wp_mail_data.
+     */
+    public function ensure_email_content( $args ) {
+        $args['message'] = $this->wp_mail_data['email'];
+        return $args;
     }
     
     /**
-	 * A little house keeping after an email is sent.
-	 *
- 	 */
-	public function after_sending() {
+     * A little house keeping after an email is sent.
+     *
+     */
+    public function after_sending() {
 
         do_action( 'getpaid_after_send_email', $this->wp_mail_data );
-		remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
+        remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
 
-	}
+    }
 
 }