AyeCode / invoicing

widgets/subscriptions.php

Indentation +346 added lines, -346 removed lines

@@ -14,144 +14,144 @@ 
  */
 class WPInv_Subscriptions_Widget extends WP_Super_Duper {
 
-	/**
-	 * Register the widget with WordPress.
-	 *
-	 */
-	public function __construct() {
-
-		$options = array(
-			'textdomain'    => 'invoicing',
-			'block-icon'    => 'controls-repeat',
-			'block-category'=> 'widgets',
-			'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
-			'class_name'     => __CLASS__,
-			'base_id'       => 'wpinv_subscriptions',
-			'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
-			'widget_ops'    => array(
-				'classname'   => 'getpaid-subscriptions bsui',
-				'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
-			),
-			'arguments'     => array(
-				'title'  => array(
-					'title'       => __( 'Widget title', 'invoicing' ),
-					'desc'        => __( 'Enter widget title.', 'invoicing' ),
-					'type'        => 'text',
-					'desc_tip'    => true,
-					'default'     => '',
-					'advanced'    => false
-				),
-			)
-
-		);
-
-
-		parent::__construct( $options );
-	}
-
-	/**
-	 * Retrieves current user's subscriptions.
-	 *
-	 * @return GetPaid_Subscriptions_Query
-	 */
-	public function get_subscriptions() {
-
-		// Prepare license args.
-		$args  = array(
-			'customer_in' => get_current_user_id(),
-			'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
-		);
-
-		return new GetPaid_Subscriptions_Query( $args );
-
-	}
-
-	/**
-	 * The Super block output function.
-	 *
-	 * @param array $args
-	 * @param array $widget_args
-	 * @param string $content
-	 *
-	 * @return mixed|string|bool
-	 */
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
-
-		// Ensure that the user is logged in.
-		if ( ! is_user_logged_in() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Are we displaying a single subscription?
-		if ( isset( $_GET['subscription'] ) ) {
-			return $this->display_single_subscription( trim( $_GET['subscription'] ) );
-		}
-
-		// Retrieve the user's subscriptions.
-		$subscriptions = $this->get_subscriptions();
-
-		// Start the output buffer.
-		ob_start();
-
-		// Backwards compatibility.
-		do_action( 'wpinv_before_user_subscriptions' );
-
-		// Display errors and notices.
-		wpinv_print_errors();
-
-		do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
-
-		// Print the table header.
-		$this->print_table_header();
-
-		// Print table body.
-		$this->print_table_body( $subscriptions->get_results() );
-
-		// Print table footer.
-		$this->print_table_footer();
-
-		// Print the navigation.
-		$this->print_navigation( $subscriptions->get_total() );
-
-		// Backwards compatibility.
-		do_action( 'wpinv_after_user_subscriptions' );
-
-		// Return the output.
-		return ob_get_clean();
-
-	}
-
-	/**
-	 * Retrieves the subscription columns.
-	 *
-	 * @return array
-	 */
-	public function get_subscriptions_table_columns() {
+    /**
+     * Register the widget with WordPress.
+     *
+     */
+    public function __construct() {
+
+        $options = array(
+            'textdomain'    => 'invoicing',
+            'block-icon'    => 'controls-repeat',
+            'block-category'=> 'widgets',
+            'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
+            'class_name'     => __CLASS__,
+            'base_id'       => 'wpinv_subscriptions',
+            'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
+            'widget_ops'    => array(
+                'classname'   => 'getpaid-subscriptions bsui',
+                'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
+            ),
+            'arguments'     => array(
+                'title'  => array(
+                    'title'       => __( 'Widget title', 'invoicing' ),
+                    'desc'        => __( 'Enter widget title.', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'advanced'    => false
+                ),
+            )
+
+        );
+
+
+        parent::__construct( $options );
+    }
+
+    /**
+     * Retrieves current user's subscriptions.
+     *
+     * @return GetPaid_Subscriptions_Query
+     */
+    public function get_subscriptions() {
+
+        // Prepare license args.
+        $args  = array(
+            'customer_in' => get_current_user_id(),
+            'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
+        );
+
+        return new GetPaid_Subscriptions_Query( $args );
+
+    }
+
+    /**
+     * The Super block output function.
+     *
+     * @param array $args
+     * @param array $widget_args
+     * @param string $content
+     *
+     * @return mixed|string|bool
+     */
+    public function output( $args = array(), $widget_args = array(), $content = '' ) {
+
+        // Ensure that the user is logged in.
+        if ( ! is_user_logged_in() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Are we displaying a single subscription?
+        if ( isset( $_GET['subscription'] ) ) {
+            return $this->display_single_subscription( trim( $_GET['subscription'] ) );
+        }
+
+        // Retrieve the user's subscriptions.
+        $subscriptions = $this->get_subscriptions();
+
+        // Start the output buffer.
+        ob_start();
+
+        // Backwards compatibility.
+        do_action( 'wpinv_before_user_subscriptions' );
+
+        // Display errors and notices.
+        wpinv_print_errors();
+
+        do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
+
+        // Print the table header.
+        $this->print_table_header();
+
+        // Print table body.
+        $this->print_table_body( $subscriptions->get_results() );
+
+        // Print table footer.
+        $this->print_table_footer();
+
+        // Print the navigation.
+        $this->print_navigation( $subscriptions->get_total() );
+
+        // Backwards compatibility.
+        do_action( 'wpinv_after_user_subscriptions' );
+
+        // Return the output.
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Retrieves the subscription columns.
+     *
+     * @return array
+     */
+    public function get_subscriptions_table_columns() {
 
-		$columns = array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'renewal-date'   => __( 'Next payment', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		);
+        $columns = array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'renewal-date'   => __( 'Next payment', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        );
 
-		return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
-	}
+        return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
+    }
 
-	/**
-	 * Displays the table header.
-	 *
-	 */
-	public function print_table_header() {
+    /**
+     * Displays the table header.
+     *
+     */
+    public function print_table_header() {
 
-		?>
+        ?>
 
 			<table class="table table-bordered table-striped">
 
@@ -167,121 +167,121 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the table body.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body( $subscriptions ) {
+    /**
+     * Displays the table body.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body( $subscriptions ) {
 
-		if ( empty( $subscriptions ) ) {
-			$this->print_table_body_no_subscriptions();
-		} else {
-			$this->print_table_body_subscriptions( $subscriptions );
-		}
+        if ( empty( $subscriptions ) ) {
+            $this->print_table_body_no_subscriptions();
+        } else {
+            $this->print_table_body_subscriptions( $subscriptions );
+        }
 
-	}
+    }
 
-	/**
-	 * Displays the table body if no subscriptions were found.
-	 *
-	 */
-	public function print_table_body_no_subscriptions() {
+    /**
+     * Displays the table body if no subscriptions were found.
+     *
+     */
+    public function print_table_body_no_subscriptions() {
 
-		?>
+        ?>
 		<tbody>
 
 			<tr>
 				<td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>">
 
 					<?php
-						echo aui()->alert(
-							array(
-								'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
-								'type'    => 'warning',
-							)
-						);
-					?>
+                        echo aui()->alert(
+                            array(
+                                'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
+                                'type'    => 'warning',
+                            )
+                        );
+                    ?>
 
 				</td>
 			</tr>
 
 		</tbody>
 		<?php
-	}
+    }
 
-	/**
-	 * Displays the table body if subscriptions were found.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body_subscriptions( $subscriptions ) {
+    /**
+     * Displays the table body if subscriptions were found.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body_subscriptions( $subscriptions ) {
 
-		?>
+        ?>
 		<tbody>
 
 			<?php foreach ( $subscriptions as $subscription ) : ?>
 				<tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>">
 					<?php
-						wpinv_get_template(
-							'subscriptions/subscriptions-table-row.php',
-							array(
-								'subscription' => $subscription,
-								'widget'       => $this
-							)
-						);
-					?>
+                        wpinv_get_template(
+                            'subscriptions/subscriptions-table-row.php',
+                            array(
+                                'subscription' => $subscription,
+                                'widget'       => $this
+                            )
+                        );
+                    ?>
 				</tr>
 			<?php endforeach; ?>
 
 		</tbody>
 		<?php
-	}
-
-	/**
-	 * Adds row actions to a column
-	 *
-	 * @param string $content column content
-	 * @param WPInv_Subscription $subscription
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function add_row_actions( $content, $subscription ) {
-
-		// Prepare row actions.
-		$actions = array();
-
-		// View subscription action.
-		$view_url        = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
-		$view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) );
-		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
-
-		// Filter the actions.
-		$actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
-
-		$sanitized  = array();
-		foreach ( $actions as $key => $action ) {
-			$key         = sanitize_html_class( $key );
-			$action      = wp_kses_post( $action );
-			$sanitized[] = "<span class='$key'>$action</span>";
-		}
-
-		$row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
-		$row_actions .= implode( ' | ', $sanitized );
-		$row_actions .= '</small>';
-
-		return $content . $row_actions;
-	}
-
-	/**
-	 * Displays the table footer.
-	 *
-	 */
-	public function print_table_footer() {
-
-		?>
+    }
+
+    /**
+     * Adds row actions to a column
+     *
+     * @param string $content column content
+     * @param WPInv_Subscription $subscription
+     * @since       1.0.0
+     * @return      string
+     */
+    public function add_row_actions( $content, $subscription ) {
+
+        // Prepare row actions.
+        $actions = array();
+
+        // View subscription action.
+        $view_url        = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
+        $view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) );
+        $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
+
+        // Filter the actions.
+        $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
+
+        $sanitized  = array();
+        foreach ( $actions as $key => $action ) {
+            $key         = sanitize_html_class( $key );
+            $action      = wp_kses_post( $action );
+            $sanitized[] = "<span class='$key'>$action</span>";
+        }
+
+        $row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
+        $row_actions .= implode( ' | ', $sanitized );
+        $row_actions .= '</small>';
+
+        return $content . $row_actions;
+    }
+
+    /**
+     * Displays the table footer.
+     *
+     */
+    public function print_table_footer() {
+
+        ?>
 
 				<tfoot>
 					<tr>
@@ -296,143 +296,143 @@ 
 			</table>
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the navigation.
-	 *
-	 * @param int $total
-	 */
-	public function print_navigation( $total ) {
+    /**
+     * Displays the navigation.
+     *
+     * @param int $total
+     */
+    public function print_navigation( $total ) {
 
-		if ( $total < 1 ) {
+        if ( $total < 1 ) {
 
-			// Out-of-bounds, run the query again without LIMIT for total count.
-			$args  = array(
-				'customer_in' => get_current_user_id(),
-				'fields'      => 'id',
-			);
+            // Out-of-bounds, run the query again without LIMIT for total count.
+            $args  = array(
+                'customer_in' => get_current_user_id(),
+                'fields'      => 'id',
+            );
 
-			$count_query = new GetPaid_Subscriptions_Query( $args );
-			$total       = $count_query->get_total();
-		}
+            $count_query = new GetPaid_Subscriptions_Query( $args );
+            $total       = $count_query->get_total();
+        }
 
-		// Abort if we do not have pages.
-		if ( 2 > $total ) {
-			return;
-		}
+        // Abort if we do not have pages.
+        if ( 2 > $total ) {
+            return;
+        }
 
-		?>
+        ?>
 
 		<div class="getpaid-subscriptions-pagination">
 			<?php
-				$big = 999999;
-
-				echo getpaid_paginate_links(
-					array(
-						'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-						'format'  => '?paged=%#%',
-						'total'   => (int) ceil( $total / 10 ),
-					)
-				);
-			?>
+                $big = 999999;
+
+                echo getpaid_paginate_links(
+                    array(
+                        'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                        'format'  => '?paged=%#%',
+                        'total'   => (int) ceil( $total / 10 ),
+                    )
+                );
+            ?>
 		</div>
 
 		<?php
-	}
-
-	/**
-	 * Returns a single subscription's columns.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 *
-	 * @return array
-	 */
-	public function get_single_subscription_columns( $subscription ) {
-
-		// Prepare subscription detail columns.
-		$subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_invoice_id(), $subscription->get_id() );
-		$items_count        = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] );
-		$fields             = apply_filters(
-			'getpaid_single_subscription_details_fields',
-			array(
-				'status'           => __( 'Status', 'invoicing' ),
-				'initial_amount'   => __( 'Initial amount', 'invoicing' ),
-				'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
-				'start_date'       => __( 'Start date', 'invoicing' ),
-				'expiry_date'      => __( 'Next payment', 'invoicing' ),
-				'payments'         => __( 'Payments', 'invoicing' ),
-				'item'             => _n( 'Item', 'Items', $items_count, 'invoicing' ),
-			),
-			$subscription
-		);
-
-		if ( isset( $fields['expiry_date'] ) ) {
-
-			if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
-				$fields['expiry_date'] = __( 'End date', 'invoicing' );
-			}
-
-			if ( 'pending' == $subscription->get_status() ) {
-				unset( $fields['expiry_date'] );
-			}
-
-		}
-
-		if ( isset( $fields['start_date'] ) && 'pending' == $subscription->get_status() ) {
-			unset( $fields['start_date'] );
-		}
-
-		if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
-			unset( $fields['initial_amount'] );
-		}
-
-		return $fields;
-	}
-
-	/**
-	 * Displays a single subscription.
-	 *
-	 * @param string $subscription
-	 *
-	 * @return string
-	 */
-	public function display_single_subscription( $subscription ) {
-
-		// Fetch the subscription.
-		$subscription = new WPInv_Subscription( (int) $subscription );
-
-		if ( ! $subscription->exists() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Ensure that the user owns this subscription key.
-		if ( get_current_user_id() != $subscription->get_customer_id() && ! wpinv_current_user_can_manage_invoicing() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		return wpinv_get_template_html(
-			'subscriptions/subscription-details.php',
-			array(
-				'subscription' => $subscription,
-				'widget'       => $this
-			)
-		);
-
-	}
+    }
+
+    /**
+     * Returns a single subscription's columns.
+     *
+     * @param WPInv_Subscription $subscription
+     *
+     * @return array
+     */
+    public function get_single_subscription_columns( $subscription ) {
+
+        // Prepare subscription detail columns.
+        $subscription_group = getpaid_get_invoice_subscription_group( $subscription->get_parent_invoice_id(), $subscription->get_id() );
+        $items_count        = empty( $subscription_group ) ? 1 : count( $subscription_group['items'] );
+        $fields             = apply_filters(
+            'getpaid_single_subscription_details_fields',
+            array(
+                'status'           => __( 'Status', 'invoicing' ),
+                'initial_amount'   => __( 'Initial amount', 'invoicing' ),
+                'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
+                'start_date'       => __( 'Start date', 'invoicing' ),
+                'expiry_date'      => __( 'Next payment', 'invoicing' ),
+                'payments'         => __( 'Payments', 'invoicing' ),
+                'item'             => _n( 'Item', 'Items', $items_count, 'invoicing' ),
+            ),
+            $subscription
+        );
+
+        if ( isset( $fields['expiry_date'] ) ) {
+
+            if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
+                $fields['expiry_date'] = __( 'End date', 'invoicing' );
+            }
+
+            if ( 'pending' == $subscription->get_status() ) {
+                unset( $fields['expiry_date'] );
+            }
+
+        }
+
+        if ( isset( $fields['start_date'] ) && 'pending' == $subscription->get_status() ) {
+            unset( $fields['start_date'] );
+        }
+
+        if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
+            unset( $fields['initial_amount'] );
+        }
+
+        return $fields;
+    }
+
+    /**
+     * Displays a single subscription.
+     *
+     * @param string $subscription
+     *
+     * @return string
+     */
+    public function display_single_subscription( $subscription ) {
+
+        // Fetch the subscription.
+        $subscription = new WPInv_Subscription( (int) $subscription );
+
+        if ( ! $subscription->exists() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Ensure that the user owns this subscription key.
+        if ( get_current_user_id() != $subscription->get_customer_id() && ! wpinv_current_user_can_manage_invoicing() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        return wpinv_get_template_html(
+            'subscriptions/subscription-details.php',
+            array(
+                'subscription' => $subscription,
+                'widget'       => $this
+            )
+        );
+
+    }
 
 }

templates/subscriptions/subscription-details.php

Indentation +52 added lines, -52 removed lines

@@ -46,64 +46,64 @@ 
 				<td style="width: 65%">
 					<?php
 
-						switch ( $key ) {
+                        switch ( $key ) {
 
-							case 'status':
-								echo sanitize_text_field( $subscription->get_status_label() );
-								break;
+                            case 'status':
+                                echo sanitize_text_field( $subscription->get_status_label() );
+                                break;
 
-							case 'start_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
-								break;
+                            case 'start_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
+                                break;
 
-							case 'expiry_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
-								break;
+                            case 'expiry_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
+                                break;
 
-							case 'initial_amount':
-								echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
+                            case 'initial_amount':
+                                echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
 
-								if ( $subscription->has_trial_period() ) {
+                                if ( $subscription->has_trial_period() ) {
 
-									echo "<small class='text-muted'>&nbsp;";
-									printf(
-										_x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
-										sanitize_text_field( $subscription->get_trial_period() )
-									);
-									echo '</small>';
+                                    echo "<small class='text-muted'>&nbsp;";
+                                    printf(
+                                        _x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
+                                        sanitize_text_field( $subscription->get_trial_period() )
+                                    );
+                                    echo '</small>';
 
-								}
+                                }
 
-								break;
+                                break;
 
-							case 'recurring_amount':
-								$frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-								$amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-								echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
-								break;
+                            case 'recurring_amount':
+                                $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+                                $amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+                                echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
+                                break;
 
-							case 'item':
+                            case 'item':
 
-								if ( empty( $subscription_group ) ) {
-									echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() );
-								} else {
-									$markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-									echo implode( ' | ', $markup );
-								}
+                                if ( empty( $subscription_group ) ) {
+                                    echo WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() );
+                                } else {
+                                    $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+                                    echo implode( ' | ', $markup );
+                                }
 
-								break;
+                                break;
 
-							case 'payments':
+                            case 'payments':
 
-								$max_activations = (int) $subscription->get_bill_times();
-								echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
+                                $max_activations = (int) $subscription->get_bill_times();
+                                echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
 
-								break;
+                                break;
 
-						}
-						do_action( "getpaid_render_single_subscription_column_$key", $subscription );
+                        }
+                        do_action( "getpaid_render_single_subscription_column_$key", $subscription );
 
-					?>
+                    ?>
 				</td>
 
 			</tr>
@@ -130,17 +130,17 @@ 
 <span class="form-text">
 
 	<?php
-		if ( $subscription->can_cancel() ) {
-			printf(
-				'<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
-				esc_url( $subscription->get_cancel_url() ),
-				esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
-				__( 'Cancel Subscription', 'invoicing' )
-			);
-		}
-
-		do_action( 'getpaid-single-subscription-page-actions', $subscription );
-	?>
+        if ( $subscription->can_cancel() ) {
+            printf(
+                '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
+                esc_url( $subscription->get_cancel_url() ),
+                esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
+                __( 'Cancel Subscription', 'invoicing' )
+            );
+        }
+
+        do_action( 'getpaid-single-subscription-page-actions', $subscription );
+    ?>
 
 	<a href="<?php echo esc_url( getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); ?>" class="btn btn-secondary btn-sm"><?php _e( 'Go Back', 'invoicing' ); ?></a>
 </span>

includes/class-wpinv-subscriptions.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@ 
 class WPInv_Subscriptions {
 
     /**
-	 * Class constructor.
-	 */
+     * Class constructor.
+     */
     public function __construct(){
 
         // Fire gateway specific hooks when a subscription changes.
@@ -89,12 +89,12 @@ 
     }
 
     /**
-	 * Processes subscription status changes.
+     * Processes subscription status changes.
      *
      * @param WPInv_Subscription $subscription
      * @param string $from
      * @param string $to
-	 */
+     */
     public function process_subscription_status_change( $subscription, $from, $to ) {
 
         $gateway = $subscription->get_gateway();

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

Indentation +818 added lines, -818 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,198 +10,198 @@ 
 class GetPaid_Payment_Form_Submission {
 
     /**
-	 * Submission ID
-	 *
-	 * @var string
-	 */
-	public $id = null;
-
-	/**
-	 * The raw submission data.
-	 *
-	 * @var array
-	 */
-	protected $data = null;
-
-	/**
-	 * Submission totals
-	 *
-	 * @var array
-	 */
-	protected $totals = array(
-
-		'subtotal'      => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'discount'      => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'fees'          => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'taxes'         => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-	);
-
-	/**
-	 * Sets the associated payment form.
-	 *
-	 * @var GetPaid_Payment_Form
-	 */
+     * Submission ID
+     *
+     * @var string
+     */
+    public $id = null;
+
+    /**
+     * The raw submission data.
+     *
+     * @var array
+     */
+    protected $data = null;
+
+    /**
+     * Submission totals
+     *
+     * @var array
+     */
+    protected $totals = array(
+
+        'subtotal'      => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'discount'      => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'fees'          => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'taxes'         => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+    );
+
+    /**
+     * Sets the associated payment form.
+     *
+     * @var GetPaid_Payment_Form
+     */
     protected $payment_form = null;
 
     /**
-	 * The country for the submission.
-	 *
-	 * @var string
-	 */
-	public $country = null;
-
-    /**
-	 * The state for the submission.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $state = null;
-
-	/**
-	 * The invoice associated with the submission.
-	 *
-	 * @var WPInv_Invoice
-	 */
-	protected $invoice = null;
-
-	/**
-	 * The recurring item for the submission.
-	 *
-	 * @var int
-	 */
-	public $has_recurring = 0;
-
-	/**
-	 * An array of fees for the submission.
-	 *
-	 * @var array
-	 */
-	protected $fees = array();
-
-	/**
-	 * An array of discounts for the submission.
-	 *
-	 * @var array
-	 */
-	protected $discounts = array();
-
-	/**
-	 * An array of taxes for the submission.
-	 *
-	 * @var array
-	 */
-	protected $taxes = array();
-
-	/**
-	 * An array of items for the submission.
-	 *
-	 * @var GetPaid_Form_Item[]
-	 */
-	protected $items = array();
-
-	/**
-	 * The last error.
-	 *
-	 * @var string
-	 */
-	public $last_error = null;
-
-	/**
-	 * The last error code.
-	 *
-	 * @var string
-	 */
-	public $last_error_code = null;
-
-    /**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-
-		// Set the state and country to the default state and country.
-		$this->country = wpinv_default_billing_country();
-		$this->state   = wpinv_get_default_state();
-
-		// Do we have an actual submission?
-		if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
-			$this->load_data( $_POST );
-		}
-
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Remove slashes from the submitted data...
-		$data       = wp_unslash( $data );
-
-		// Allow plugins to filter the data.
-		$data       = apply_filters( 'getpaid_submission_data', $data, $this );
-
-		// Cache it...
-		$this->data = $data;
-
-		// Then generate a unique id from the data.
-		$this->id   = md5( wp_json_encode( $data ) );
-
-		// Finally, process the submission.
-		try {
-
-			// Each process is passed an instance of the class (with reference)
-			// and should throw an Exception whenever it encounters one.
-			$processors = apply_filters(
-				'getpaid_payment_form_submission_processors',
-				array(
-					array( $this, 'process_payment_form' ),
-					array( $this, 'process_invoice' ),
-					array( $this, 'process_fees' ),
-					array( $this, 'process_items' ),
-					array( $this, 'process_discount' ),
-					array( $this, 'process_taxes' ),
-				),
-				$this		
-			);
-
-			foreach ( $processors as $processor ) {
-				call_user_func_array( $processor, array( &$this ) );
-			}
-
-		} catch( GetPaid_Payment_Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getErrorCode();
-		} catch ( Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getCode();
-		}
-
-		// Fired when we are done processing a submission.
-		do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
-
-	}
-
-	/*
+     * The country for the submission.
+     *
+     * @var string
+     */
+    public $country = null;
+
+    /**
+     * The state for the submission.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $state = null;
+
+    /**
+     * The invoice associated with the submission.
+     *
+     * @var WPInv_Invoice
+     */
+    protected $invoice = null;
+
+    /**
+     * The recurring item for the submission.
+     *
+     * @var int
+     */
+    public $has_recurring = 0;
+
+    /**
+     * An array of fees for the submission.
+     *
+     * @var array
+     */
+    protected $fees = array();
+
+    /**
+     * An array of discounts for the submission.
+     *
+     * @var array
+     */
+    protected $discounts = array();
+
+    /**
+     * An array of taxes for the submission.
+     *
+     * @var array
+     */
+    protected $taxes = array();
+
+    /**
+     * An array of items for the submission.
+     *
+     * @var GetPaid_Form_Item[]
+     */
+    protected $items = array();
+
+    /**
+     * The last error.
+     *
+     * @var string
+     */
+    public $last_error = null;
+
+    /**
+     * The last error code.
+     *
+     * @var string
+     */
+    public $last_error_code = null;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+
+        // Set the state and country to the default state and country.
+        $this->country = wpinv_default_billing_country();
+        $this->state   = wpinv_get_default_state();
+
+        // Do we have an actual submission?
+        if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
+            $this->load_data( $_POST );
+        }
+
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Remove slashes from the submitted data...
+        $data       = wp_unslash( $data );
+
+        // Allow plugins to filter the data.
+        $data       = apply_filters( 'getpaid_submission_data', $data, $this );
+
+        // Cache it...
+        $this->data = $data;
+
+        // Then generate a unique id from the data.
+        $this->id   = md5( wp_json_encode( $data ) );
+
+        // Finally, process the submission.
+        try {
+
+            // Each process is passed an instance of the class (with reference)
+            // and should throw an Exception whenever it encounters one.
+            $processors = apply_filters(
+                'getpaid_payment_form_submission_processors',
+                array(
+                    array( $this, 'process_payment_form' ),
+                    array( $this, 'process_invoice' ),
+                    array( $this, 'process_fees' ),
+                    array( $this, 'process_items' ),
+                    array( $this, 'process_discount' ),
+                    array( $this, 'process_taxes' ),
+                ),
+                $this		
+            );
+
+            foreach ( $processors as $processor ) {
+                call_user_func_array( $processor, array( &$this ) );
+            }
+
+        } catch( GetPaid_Payment_Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getErrorCode();
+        } catch ( Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getCode();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -210,39 +210,39 @@ 
 	| submission has an active payment form etc.
     */
 
-	/**
-	 * Prepares the submission's payment form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_payment_form() {
+    /**
+     * Prepares the submission's payment form.
+     *
+     * @since 1.0.19
+     */
+    public function process_payment_form() {
 
-		// Every submission needs an active payment form.
-		if ( empty( $this->data['form_id'] ) ) {
-			throw new Exception( __( 'Missing payment form', 'invoicing' ) );
-		}
+        // Every submission needs an active payment form.
+        if ( empty( $this->data['form_id'] ) ) {
+            throw new Exception( __( 'Missing payment form', 'invoicing' ) );
+        }
 
-		// Fetch the payment form.
-		$this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
+        // Fetch the payment form.
+        $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
 
-		if ( ! $this->payment_form->is_active() ) {
-			throw new Exception( __( 'Payment form not active', 'invoicing' ) );
-		}
+        if ( ! $this->payment_form->is_active() ) {
+            throw new Exception( __( 'Payment form not active', 'invoicing' ) );
+        }
 
-		do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
-	}
+        do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
+    }
 
     /**
-	 * Returns the payment form.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Payment_Form
-	 */
-	public function get_payment_form() {
-		return $this->payment_form;
-	}
+     * Returns the payment form.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Payment_Form
+     */
+    public function get_payment_form() {
+        return $this->payment_form;
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Invoices.
 	|--------------------------------------------------------------------------
@@ -251,84 +251,84 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_invoice() {
+    /**
+     * Prepares the submission's invoice.
+     *
+     * @since 1.0.19
+     */
+    public function process_invoice() {
 
-		// Abort if there is no invoice.
-		if ( empty( $this->data['invoice_id'] ) ) {
-			return;
-		}
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+            return;
+        }
 
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
 
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
 
-		$this->payment_form->invoice = $invoice;
-		if ( ! $this->payment_form->is_default() ) {
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
 
-			$items    = array();
-			$item_ids = array();
+            $items    = array();
+            $item_ids = array();
 	
-			foreach ( $invoice->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
+            foreach ( $invoice->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
 	
-			foreach ( $this->payment_form->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
+            foreach ( $this->payment_form->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
 	
-			$this->payment_form->set_items( $items );
+            $this->payment_form->set_items( $items );
 	
-		} else {
-			$this->payment_form->set_items( $invoice->get_items() );
-		}
-
-		$this->country = $invoice->get_country();
-		$this->state   = $invoice->get_state();
-		$this->invoice = $invoice;
-
-		do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
-	}
-
-	/**
-	 * Returns the associated invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
-	public function get_invoice() {
-		return $this->invoice;
-	}
-
-	/**
-	 * Checks whether there is an invoice associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_invoice() {
-		return ! empty( $this->invoice );
-	}
-
-	/*
+        } else {
+            $this->payment_form->set_items( $invoice->get_items() );
+        }
+
+        $this->country = $invoice->get_country();
+        $this->state   = $invoice->get_state();
+        $this->invoice = $invoice;
+
+        do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
+    }
+
+    /**
+     * Returns the associated invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
+    public function get_invoice() {
+        return $this->invoice;
+    }
+
+    /**
+     * Checks whether there is an invoice associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_invoice() {
+        return ! empty( $this->invoice );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Items.
 	|--------------------------------------------------------------------------
@@ -337,129 +337,129 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-			$this->has_recurring = $item->get_id();
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-
-	}
-
-	/**
-	 * Removes a specific item.
-	 * 
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/**
-	 * Checks if there's a single subscription group in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_subscription_group() {
-		return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/**
-	 * Checks if there are multipe subscription groups in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_multiple_subscription_groups() {
-		return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+            $this->has_recurring = $item->get_id();
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+
+    }
+
+    /**
+     * Removes a specific item.
+     * 
+     * You should not call this method after the discounts and taxes
+     * have been calculated.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
+
+        if ( isset( $this->items[ $item_id ] ) ) {
+            $this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
+            $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
+
+            if ( $this->items[ $item_id ]->is_recurring() ) {
+                $this->has_recurring = 0;
+            }
+
+            unset( $this->items[ $item_id ] );
+        }
+
+    }
+
+    /**
+     * Returns the subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
+        }
+
+        return $this->totals['subtotal']['initial'];
+    }
+
+    /**
+     * Returns the recurring subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
+        }
+
+        return $this->totals['subtotal']['recurring'];
+    }
+
+    /**
+     * Returns all items.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items() {
+        return $this->items;
+    }
+
+    /**
+     * Checks if there's a single subscription group in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_subscription_group() {
+        return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /**
+     * Checks if there are multipe subscription groups in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_multiple_subscription_groups() {
+        return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -468,128 +468,128 @@ 
 	| or only one-time.
     */
 
-	/**
-	 * Prepares the submission's taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_taxes() {
-
-		// Abort if we're not using taxes.
-		if ( ! $this->use_taxes() ) {
-			return;
-		}
-
-		// If a custom country && state has been passed in, use it to calculate taxes.
-		$country = $this->get_field( 'wpinv_country', 'billing' );
-		if ( ! empty( $country ) ) {
-			$this->country = $country;
-		}
-
-		$state = $this->get_field( 'wpinv_state', 'billing' );
-		if ( ! empty( $state ) ) {
-			$this->state = $state;
-		}
-
-		// Confirm if the provided country and the ip country are similar.
-		$address_confirmed = $this->get_field( 'confirm-address' );
-		if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
-			throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
-		}
-
-		// Abort if the country is not taxable.
-		if ( ! wpinv_is_country_taxable( $this->country ) ) {
-			return;
-		}
-
-		$processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
-
-		foreach ( $processor->taxes as $tax ) {
-			$this->add_tax( $tax );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
-	}
-
-	/**
-	 * Adds a tax to the submission.
-	 *
-	 * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
-	 * @since 1.0.19
-	 */
-	public function add_tax( $tax ) {
-
-		if ( wpinv_round_tax_per_tax_rate() ) {
-			$tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
-			$tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
-		}
-
-		$this->taxes[ $tax['name'] ]         = $tax;
-		$this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
-		$this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
-
-	}
-
-	/**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax_name ) {
-
-		if ( isset( $this->taxes[ $tax_name ] ) ) {
-			$this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
-			$this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
-			unset( $this->taxes[ $tax_name ] );
-		}
-
-	}
-
-	/**
-	 * Whether or not we'll use taxes for the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function use_taxes() {
-
-		$use_taxes = wpinv_use_taxes();
-
-		if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
-			$use_taxes = false;
-		}
-
-		return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
-
-	}
-
-	/**
-	 * Returns the tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax() {
-		return $this->totals['taxes']['initial'];
-	}
-
-	/**
-	 * Returns the recurring tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_tax() {
-		return $this->totals['taxes']['recurring'];
-	}
-
-	/**
-	 * Returns all taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_taxes() {
-		return $this->taxes;
-	}
-
-	/*
+    /**
+     * Prepares the submission's taxes.
+     *
+     * @since 1.0.19
+     */
+    public function process_taxes() {
+
+        // Abort if we're not using taxes.
+        if ( ! $this->use_taxes() ) {
+            return;
+        }
+
+        // If a custom country && state has been passed in, use it to calculate taxes.
+        $country = $this->get_field( 'wpinv_country', 'billing' );
+        if ( ! empty( $country ) ) {
+            $this->country = $country;
+        }
+
+        $state = $this->get_field( 'wpinv_state', 'billing' );
+        if ( ! empty( $state ) ) {
+            $this->state = $state;
+        }
+
+        // Confirm if the provided country and the ip country are similar.
+        $address_confirmed = $this->get_field( 'confirm-address' );
+        if ( wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
+            throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
+        }
+
+        // Abort if the country is not taxable.
+        if ( ! wpinv_is_country_taxable( $this->country ) ) {
+            return;
+        }
+
+        $processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
+
+        foreach ( $processor->taxes as $tax ) {
+            $this->add_tax( $tax );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
+    }
+
+    /**
+     * Adds a tax to the submission.
+     *
+     * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
+     * @since 1.0.19
+     */
+    public function add_tax( $tax ) {
+
+        if ( wpinv_round_tax_per_tax_rate() ) {
+            $tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
+            $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
+        }
+
+        $this->taxes[ $tax['name'] ]         = $tax;
+        $this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
+        $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
+
+    }
+
+    /**
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax_name ) {
+
+        if ( isset( $this->taxes[ $tax_name ] ) ) {
+            $this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
+            $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
+            unset( $this->taxes[ $tax_name ] );
+        }
+
+    }
+
+    /**
+     * Whether or not we'll use taxes for the submission.
+     *
+     * @since 1.0.19
+     */
+    public function use_taxes() {
+
+        $use_taxes = wpinv_use_taxes();
+
+        if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
+            $use_taxes = false;
+        }
+
+        return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
+
+    }
+
+    /**
+     * Returns the tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax() {
+        return $this->totals['taxes']['initial'];
+    }
+
+    /**
+     * Returns the recurring tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_tax() {
+        return $this->totals['taxes']['recurring'];
+    }
+
+    /**
+     * Returns all taxes.
+     *
+     * @since 1.0.19
+     */
+    public function get_taxes() {
+        return $this->taxes;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Discounts
 	|--------------------------------------------------------------------------
@@ -598,99 +598,99 @@ 
 	| or only one-time. They also do not have to come from a discount code.
     */
 
-	/**
-	 * Prepares the submission's discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_discount() {
-
-		$initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
-		$recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
-		$processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
-
-		foreach ( $processor->discounts as $discount ) {
-			$this->add_discount( $discount );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
-	}
-
-	/**
-	 * Adds a discount to the submission.
-	 *
-	 * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
-	 * @since 1.0.19
-	 */
-	public function add_discount( $discount ) {
-		$this->discounts[ $discount['name'] ]   = $discount;
-		$this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
-		$this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
-	}
-
-	/**
-	 * Removes a discount from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $name ) {
-
-		if ( isset( $this->discounts[ $name ] ) ) {
-			$this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
-			$this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
-			unset( $this->discounts[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Checks whether there is a discount code associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_discount_code() {
-		return ! empty( $this->discounts['discount_code'] );
-	}
-
-	/**
-	 * Returns the discount code.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_discount_code() {
-		return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
-	}
-
-	/**
-	 * Returns the discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount() {
-		return $this->totals['discount']['initial'];
-	}
-
-	/**
-	 * Returns the recurring discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_discount() {
-		return $this->totals['discount']['recurring'];
-	}
-
-	/**
-	 * Returns all discounts.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discounts() {
-		return $this->discounts;
-	}
-
-	/*
+    /**
+     * Prepares the submission's discount.
+     *
+     * @since 1.0.19
+     */
+    public function process_discount() {
+
+        $initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
+        $recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
+        $processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
+
+        foreach ( $processor->discounts as $discount ) {
+            $this->add_discount( $discount );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
+    }
+
+    /**
+     * Adds a discount to the submission.
+     *
+     * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
+     * @since 1.0.19
+     */
+    public function add_discount( $discount ) {
+        $this->discounts[ $discount['name'] ]   = $discount;
+        $this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
+        $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
+    }
+
+    /**
+     * Removes a discount from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $name ) {
+
+        if ( isset( $this->discounts[ $name ] ) ) {
+            $this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
+            $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
+            unset( $this->discounts[ $name ] );
+        }
+
+    }
+
+    /**
+     * Checks whether there is a discount code associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_discount_code() {
+        return ! empty( $this->discounts['discount_code'] );
+    }
+
+    /**
+     * Returns the discount code.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_discount_code() {
+        return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
+    }
+
+    /**
+     * Returns the discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount() {
+        return $this->totals['discount']['initial'];
+    }
+
+    /**
+     * Returns the recurring discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_discount() {
+        return $this->totals['discount']['recurring'];
+    }
+
+    /**
+     * Returns all discounts.
+     *
+     * @since 1.0.19
+     */
+    public function get_discounts() {
+        return $this->discounts;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Fees
 	|--------------------------------------------------------------------------
@@ -700,89 +700,89 @@ 
 	| fees.
     */
 
-	/**
-	 * Prepares the submission's fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_fees() {
-
-		$fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
-
-		foreach ( $fees_processor->fees as $fee ) {
-			$this->add_fee( $fee );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
-	}
-
-	/**
-	 * Adds a fee to the submission.
-	 *
-	 * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
-	 * @since 1.0.19
-	 */
-	public function add_fee( $fee ) {
-
-		$this->fees[ $fee['name'] ]         = $fee;
-		$this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-		$this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-
-	}
-
-	/**
-	 * Removes a fee from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $name ) {
-
-		if ( isset( $this->fees[ $name ] ) ) {
-			$this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
-			$this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
-			unset( $this->fees[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Returns the fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee() {
-		return $this->totals['fees']['initial'];
-	}
-
-	/**
-	 * Returns the recurring fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_fee() {
-		return $this->totals['fees']['recurring'];
-	}
-
-	/**
-	 * Returns all fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fees() {
-		return $this->fees;
-	}
-
-	/**
-	 * Checks if there are any fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_fees() {
-		return count( $this->fees ) !== 0;
-	}
-
-	/*
+    /**
+     * Prepares the submission's fees.
+     *
+     * @since 1.0.19
+     */
+    public function process_fees() {
+
+        $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
+
+        foreach ( $fees_processor->fees as $fee ) {
+            $this->add_fee( $fee );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
+    }
+
+    /**
+     * Adds a fee to the submission.
+     *
+     * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
+     * @since 1.0.19
+     */
+    public function add_fee( $fee ) {
+
+        $this->fees[ $fee['name'] ]         = $fee;
+        $this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+        $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+
+    }
+
+    /**
+     * Removes a fee from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $name ) {
+
+        if ( isset( $this->fees[ $name ] ) ) {
+            $this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
+            $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
+            unset( $this->fees[ $name ] );
+        }
+
+    }
+
+    /**
+     * Returns the fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee() {
+        return $this->totals['fees']['initial'];
+    }
+
+    /**
+     * Returns the recurring fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_fee() {
+        return $this->totals['fees']['recurring'];
+    }
+
+    /**
+     * Returns all fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fees() {
+        return $this->fees;
+    }
+
+    /**
+     * Checks if there are any fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_fees() {
+        return count( $this->fees ) !== 0;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| MISC
 	|--------------------------------------------------------------------------
@@ -790,119 +790,119 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return empty( $this->data['initial_state'] );
-	}
-
-	/**
-	 * Returns the total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_total() {
-		$total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Returns the recurring total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_total() {
-		$total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Whether payment details should be collected for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function should_collect_payment_details() {
-		$initial   = $this->get_total();
-		$recurring = $this->get_recurring_total();
-
-		if ( $this->has_recurring == 0 ) {
-			$recurring = 0;
-		}
-
-		$collect = $initial > 0 || $recurring > 0;
-		return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this  );
-	}
-
-	/**
-	 * Returns the billing email of the user.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_billing_email() {
-		return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this  );
-	}
-
-	/**
-	 * Checks if the submitter has a billing email.
-	 *
-	 * @since 1.0.19
-	 */
-	public function has_billing_email() {
-		$billing_email = $this->get_billing_email();
-		return ! empty( $billing_email ) && is_email( $billing_email );
-	}
-
-	/**
-	 * Returns the appropriate currency for the submission.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_currency() {
-		return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
-    }
-
-    /**
-	 * Returns the raw submission data.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return $this->data;
-	}
-
-	/**
-	 * Returns a field from the submission data
-	 *
-	 * @param string $field
-	 * @since 1.0.19
-	 * @return mixed|null
-	 */
-	public function get_field( $field, $sub_array_key = null ) {
-		return getpaid_get_array_field( $this->data, $field, $sub_array_key );
-	}
-
-	/**
-	 * Checks if a required field is set.
-	 *
-	 * @since 1.0.19
-	 */
-	public function is_required_field_set( $field ) {
-		return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
-	}
-
-	/**
-	 * Formats an amount
-	 *
-	 * @since 1.0.19
-	 */
-	public function format_amount( $amount ) {
-		return wpinv_price( $amount, $this->get_currency() );
-	}
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return empty( $this->data['initial_state'] );
+    }
+
+    /**
+     * Returns the total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_total() {
+        $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() - $this->get_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Returns the recurring total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_total() {
+        $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() - $this->get_recurring_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Whether payment details should be collected for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function should_collect_payment_details() {
+        $initial   = $this->get_total();
+        $recurring = $this->get_recurring_total();
+
+        if ( $this->has_recurring == 0 ) {
+            $recurring = 0;
+        }
+
+        $collect = $initial > 0 || $recurring > 0;
+        return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this  );
+    }
+
+    /**
+     * Returns the billing email of the user.
+     *
+     * @since 1.0.19
+     */
+    public function get_billing_email() {
+        return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this  );
+    }
+
+    /**
+     * Checks if the submitter has a billing email.
+     *
+     * @since 1.0.19
+     */
+    public function has_billing_email() {
+        $billing_email = $this->get_billing_email();
+        return ! empty( $billing_email ) && is_email( $billing_email );
+    }
+
+    /**
+     * Returns the appropriate currency for the submission.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_currency() {
+        return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
+    }
+
+    /**
+     * Returns the raw submission data.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return $this->data;
+    }
+
+    /**
+     * Returns a field from the submission data
+     *
+     * @param string $field
+     * @since 1.0.19
+     * @return mixed|null
+     */
+    public function get_field( $field, $sub_array_key = null ) {
+        return getpaid_get_array_field( $this->data, $field, $sub_array_key );
+    }
+
+    /**
+     * Checks if a required field is set.
+     *
+     * @since 1.0.19
+     */
+    public function is_required_field_set( $field ) {
+        return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
+    }
+
+    /**
+     * Formats an amount
+     *
+     * @since 1.0.19
+     */
+    public function format_amount( $amount ) {
+        return wpinv_price( $amount, $this->get_currency() );
+    }
 
 }

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/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/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 );
 
-	}
+    }
 
 }