AyeCode / invoicing

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

Indentation +468 added lines, -468 removed lines

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

Spacing +126 added lines, -126 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * This class handles invoice notificaiton emails.
@@ -28,7 +28,7 @@ 
 		$this->invoice_actions = apply_filters(
 			'getpaid_notification_email_invoice_triggers',
 			array(
-				'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
+				'getpaid_new_invoice'                   => array('new_invoice', 'user_invoice'),
 				'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
 				'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
 				'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
@@ -50,11 +50,11 @@ 
 	 */
 	public function init_hooks() {
 
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
-		add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
+		add_filter('getpaid_get_email_merge_tags', array($this, 'invoice_merge_tags'), 10, 2);
+		add_filter('getpaid_invoice_email_recipients', array($this, 'filter_email_recipients'), 10, 2);
 
-		foreach ( $this->invoice_actions as $hook => $email_type ) {
-			$this->init_email_type_hook( $hook, $email_type );
+		foreach ($this->invoice_actions as $hook => $email_type) {
+			$this->init_email_type_hook($hook, $email_type);
 		}
 	}
 
@@ -64,25 +64,25 @@ 
 	 * @param string $hook
 	 * @param string|array $email_type
 	 */
-	public function init_email_type_hook( $hook, $email_type ) {
+	public function init_email_type_hook($hook, $email_type) {
 
-		$email_type = wpinv_parse_list( $email_type );
+		$email_type = wpinv_parse_list($email_type);
 
-		foreach ( $email_type as $type ) {
+		foreach ($email_type as $type) {
 
-			$email = new GetPaid_Notification_Email( $type );
+			$email = new GetPaid_Notification_Email($type);
 
 			// Abort if it is not active.
-			if ( ! $email->is_active() ) {
+			if (!$email->is_active()) {
 				continue;
 			}
 
-			if ( method_exists( $this, $type ) ) {
-				add_action( $hook, array( $this, $type ), 100, 2 );
+			if (method_exists($this, $type)) {
+				add_action($hook, array($this, $type), 100, 2);
 				continue;
 			}
 
-			do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
+			do_action('getpaid_invoice_init_email_type_hook', $type, $hook);
 		}
 
 	}
@@ -93,19 +93,19 @@ 
 	 * @param array $merge_tags
 	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
 	 */
-	public function invoice_merge_tags( $merge_tags, $object ) {
+	public function invoice_merge_tags($merge_tags, $object) {
 
-		if ( is_a( $object, 'WPInv_Invoice' ) ) {
+		if (is_a($object, 'WPInv_Invoice')) {
 			return array_merge(
 				$merge_tags,
-				$this->get_invoice_merge_tags( $object )
+				$this->get_invoice_merge_tags($object)
 			);
 		}
 
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
+		if (is_a($object, 'WPInv_Subscription')) {
 			return array_merge(
 				$merge_tags,
-				$this->get_invoice_merge_tags( $object->get_parent_payment() )
+				$this->get_invoice_merge_tags($object->get_parent_payment())
 			);
 		}
 
@@ -119,50 +119,50 @@ 
 	 * @param WPInv_Invoice $invoice
 	 * @return array
 	 */
-	public function get_invoice_merge_tags( $invoice ) {
+	public function get_invoice_merge_tags($invoice) {
 
 		// Abort if it does not exist.
-		if ( ! $invoice->get_id() ) {
+		if (!$invoice->get_id()) {
 			return array();
 		}
 
 		$merge_tags = array(
-			'{name}'                 => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{full_name}'            => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{first_name}'           => sanitize_text_field( $invoice->get_first_name() ),
-			'{last_name}'            => sanitize_text_field( $invoice->get_last_name() ),
-			'{email}'                => sanitize_email( $invoice->get_email() ),
-			'{invoice_number}'       => sanitize_text_field( $invoice->get_number() ),
-			'{invoice_currency}'     => sanitize_text_field( $invoice->get_currency() ),
-			'{invoice_total}'        => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ),
-			'{invoice_link}'         => esc_url( $invoice->get_view_url() ),
-			'{invoice_pay_link}'     => esc_url( $invoice->get_checkout_payment_url() ),
-			'{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ),
-			'{invoice_date}'         => getpaid_format_date_value( $invoice->get_date_created() ),
-			'{invoice_due_date}'     => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
-			'{invoice_quote}'        => sanitize_text_field( strtolower( $invoice->get_label() ) ),
-			'{invoice_label}'        => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
-			'{invoice_description}'  => wp_kses_post( $invoice->get_description() ),
-			'{subscription_name}'    => wp_kses_post( $invoice->get_subscription_name() ),
-			'{is_was}'               => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+			'{name}'                 => sanitize_text_field($invoice->get_user_full_name()),
+			'{full_name}'            => sanitize_text_field($invoice->get_user_full_name()),
+			'{first_name}'           => sanitize_text_field($invoice->get_first_name()),
+			'{last_name}'            => sanitize_text_field($invoice->get_last_name()),
+			'{email}'                => sanitize_email($invoice->get_email()),
+			'{invoice_number}'       => sanitize_text_field($invoice->get_number()),
+			'{invoice_currency}'     => sanitize_text_field($invoice->get_currency()),
+			'{invoice_total}'        => sanitize_text_field(wpinv_price($invoice->get_total(), $invoice->get_currency())),
+			'{invoice_link}'         => esc_url($invoice->get_view_url()),
+			'{invoice_pay_link}'     => esc_url($invoice->get_checkout_payment_url()),
+			'{invoice_receipt_link}' => esc_url($invoice->get_receipt_url()),
+			'{invoice_date}'         => getpaid_format_date_value($invoice->get_date_created()),
+			'{invoice_due_date}'     => getpaid_format_date_value($invoice->get_due_date(), __('on receipt', 'invoicing')),
+			'{invoice_quote}'        => sanitize_text_field(strtolower($invoice->get_label())),
+			'{invoice_label}'        => sanitize_text_field(ucfirst($invoice->get_label())),
+			'{invoice_description}'  => wp_kses_post($invoice->get_description()),
+			'{subscription_name}'    => wp_kses_post($invoice->get_subscription_name()),
+			'{is_was}'               => strtotime($invoice->get_due_date()) < current_time('timestamp') ? __('was', 'invoicing') : __('is', 'invoicing'),
 		);
 
-		$payment_form_data = $invoice->get_meta( 'payment_form_data', true );
+		$payment_form_data = $invoice->get_meta('payment_form_data', true);
 
-		if ( is_array( $payment_form_data ) ) {
+		if (is_array($payment_form_data)) {
 
-			foreach ( $payment_form_data as $label => $value ) {
+			foreach ($payment_form_data as $label => $value) {
 
-				$label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) );
-				$value = is_array( $value ) ? implode( ', ', $value ) : $value;
+				$label = preg_replace('/[^a-z0-9]+/', '_', strtolower($label));
+				$value = is_array($value) ? implode(', ', $value) : $value;
 
-				if ( is_scalar( $value ) ) {
-					$merge_tags[ "{{$label}}" ] = wp_kses_post( $value );
+				if (is_scalar($value)) {
+					$merge_tags["{{$label}}"] = wp_kses_post($value);
 				}
 			}
 		}
 
-		return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
+		return apply_filters('getpaid_invoice_email_merge_tags', $merge_tags, $invoice);
 	}
 
 	/**
@@ -174,12 +174,12 @@ 
 	 * @param string|array $recipients
 	 * @param array $extra_args Extra template args.
 	 */
-	public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
+	public function send_email($invoice, $email, $type, $recipients, $extra_args = array()) {
 
-		do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
+		do_action('getpaid_before_send_invoice_notification', $type, $invoice, $email);
 
-		$skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' );
-		if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) {
+		$skip = $invoice->is_free() && wpinv_get_option('skip_email_free_invoice');
+		if (apply_filters('getpaid_skip_invoice_email', $skip, $type, $invoice)) {
 			return;
 		}
 
@@ -187,43 +187,43 @@ 
 		$merge_tags = $email->get_merge_tags();
 
 		$result = $mailer->send(
-			apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$email->add_merge_tags( $email->get_subject(), $merge_tags ),
-			$email->get_content( $merge_tags, $extra_args ),
+			apply_filters('getpaid_invoice_email_recipients', wpinv_parse_list($recipients), $email),
+			$email->add_merge_tags($email->get_subject(), $merge_tags),
+			$email->get_content($merge_tags, $extra_args),
 			$email->get_attachments()
 		);
 
 		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
+		if ($email->include_admin_bcc()) {
 			$mailer->send(
 				wpinv_get_admin_email(),
-				$email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
-				$email->get_content( $merge_tags ),
+				$email->add_merge_tags($email->get_subject() . __(' - ADMIN BCC COPY', 'invoicing'), $merge_tags),
+				$email->get_content($merge_tags),
 				$email->get_attachments()
 			);
 		}
 
-		if ( $result ) {
+		if ($result) {
 			$invoice->add_system_note(
 				sprintf(
 					// translators: %1 is the email type, %2 is the invoice recipient.
-					__( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
+					__('Successfully sent %1$s notification email to %2$s.', 'invoicing'),
+					sanitize_key($type),
+					$email->is_admin_email() ? __('admin', 'invoicing') : __('the customer', 'invoicing')
 				)
 			);
 		} else {
 			$invoice->add_system_note(
 				sprintf(
 					// translators: %1 is the email type, %2 is the invoice recipient.
-					__( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' )
+					__('Failed sending %1$s notification email to %2$s.', 'invoicing'),
+					sanitize_key($type),
+					$email->is_admin_email() ? __('admin', 'invoicing') : __('the customer', 'invoicing')
 				)
 			);
 		}
 
-		do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
+		do_action('getpaid_after_send_invoice_notification', $type, $invoice, $email);
 
 		return $result;
 	}
@@ -234,20 +234,20 @@ 
 	 * @param array $recipients
 	 * @param GetPaid_Notification_Email $email
 	 */
-	public function filter_email_recipients( $recipients, $email ) {
+	public function filter_email_recipients($recipients, $email) {
 
-		if ( ! $email->is_admin_email() ) {
+		if (!$email->is_admin_email()) {
 			$cc   = $email->object->get_email_cc();
-			$cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true );
+			$cc_2 = get_user_meta($email->object->get_user_id(), '_wpinv_email_cc', true);
 
-			if ( ! empty( $cc ) ) {
-				$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+			if (!empty($cc)) {
+				$cc = array_map('sanitize_email', wpinv_parse_list($cc));
+				$recipients = array_filter(array_unique(array_merge($recipients, $cc)));
 			}
 
-			if ( ! empty( $cc_2 ) ) {
-				$cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) );
+			if (!empty($cc_2)) {
+				$cc_2 = array_map('sanitize_email', wpinv_parse_list($cc_2));
+				$recipients = array_filter(array_unique(array_merge($recipients, $cc_2)));
 			}
 		}
 
@@ -260,17 +260,17 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function new_invoice( $invoice ) {
+	public function new_invoice($invoice) {
 
 		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+		if (!$invoice->is_type('invoice') || $invoice->is_paid() || $this->is_payment_form_invoice($invoice->get_id())) {
 			return;
 		}
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -279,12 +279,12 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function cancelled_invoice( $invoice ) {
+	public function cancelled_invoice($invoice) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 	}
 
 	/**
@@ -292,12 +292,12 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function failed_invoice( $invoice ) {
+	public function failed_invoice($invoice) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -306,12 +306,12 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function onhold_invoice( $invoice ) {
+	public function onhold_invoice($invoice) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -320,12 +320,12 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function processing_invoice( $invoice ) {
+	public function processing_invoice($invoice) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -334,17 +334,17 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function completed_invoice( $invoice ) {
+	public function completed_invoice($invoice) {
 
 		// (Maybe) abort if it is a renewal invoice.
-		if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
+		if ($invoice->is_renewal() && !wpinv_get_option('email_completed_invoice_renewal_active', false)) {
 			return;
 		}
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -353,12 +353,12 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function refunded_invoice( $invoice ) {
+	public function refunded_invoice($invoice) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -368,21 +368,21 @@ 
 	 * @param WPInv_Invoice $invoice
 	 * @param bool $force
 	 */
-	public function user_invoice( $invoice, $force = false ) {
+	public function user_invoice($invoice, $force = false) {
 
-		if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) {
+		if (!$force && !empty($GLOBALS['wpinv_skip_invoice_notification'])) {
 			return;
 		}
 
 		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) {
+		if (!$invoice->is_type('invoice') || (empty($force) && $invoice->is_paid()) || (empty($force) && $this->is_payment_form_invoice($invoice->get_id()))) {
 			return;
 		}
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient);
 
 	}
 
@@ -392,11 +392,11 @@ 
 	 * @param int $invoice
 	 * @return bool
 	 */
-	public function is_payment_form_invoice( $invoice ) {
-		$created_via             = get_post_meta( $invoice, 'wpinv_created_via', true );
+	public function is_payment_form_invoice($invoice) {
+		$created_via             = get_post_meta($invoice, 'wpinv_created_via', true);
 		$is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via;
-		$is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice );
-		return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice;
+		$is_payment_form_invoice = apply_filters('getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice);
+		return empty($_GET['getpaid-admin-action']) && $is_payment_form_invoice;
 	}
 
 	/**
@@ -405,12 +405,12 @@ 
 	 * @param WPInv_Invoice $invoice
 	 * @param string $note
 	 */
-	public function user_note( $invoice, $note ) {
+	public function user_note($invoice, $note) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+		$email     = new GetPaid_Notification_Email(__FUNCTION__, $invoice);
 		$recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
+		return $this->send_email($invoice, $email, __FUNCTION__, $recipient, array('customer_note' => $note));
 
 	}
 
@@ -419,9 +419,9 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice
 	 */
-	public function force_send_overdue_notice( $invoice ) {
-		$email = new GetPaid_Notification_Email( 'overdue', $invoice );
-		return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
+	public function force_send_overdue_notice($invoice) {
+		$email = new GetPaid_Notification_Email('overdue', $invoice);
+		return $this->send_email($invoice, $email, 'overdue', $invoice->get_email());
 	}
 
 	/**
@@ -432,38 +432,38 @@ 
 	public function overdue() {
 		global $wpdb;
 
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
+		$email = new GetPaid_Notification_Email(__FUNCTION__);
 
 		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+		$reminder_days = array_unique(wp_parse_id_list($email->get_option('days')));
 
 		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
+		if (empty($reminder_days)) {
 			return;
 		}
 
 		// Retrieve date query.
-		$date_query = $this->get_date_query( $reminder_days );
+		$date_query = $this->get_date_query($reminder_days);
 
 		// Invoices table.
 		$table = $wpdb->prefix . 'getpaid_invoices';
 
 		// Fetch invoices.
-		$invoices  = $wpdb->get_col(
+		$invoices = $wpdb->get_col(
 			"SELECT posts.ID FROM $wpdb->posts as posts
 			LEFT JOIN $table as invoices ON invoices.post_id = posts.ID
 			WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query"
         );
 
-		foreach ( $invoices as $invoice ) {
+		foreach ($invoices as $invoice) {
 
 			// Only send this email for invoices created via the admin page.
-			if ( ! $this->is_payment_form_invoice( $invoice ) ) {
-				$invoice       = new WPInv_Invoice( $invoice );
+			if (!$this->is_payment_form_invoice($invoice)) {
+				$invoice       = new WPInv_Invoice($invoice);
 				$email->object = $invoice;
 
-				if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) {
-					$this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
+				if ($invoice->needs_payment() && !$invoice->is_renewal()) {
+					$this->send_email($invoice, $email, __FUNCTION__, $invoice->get_email());
 				}
 			}
 		}
@@ -476,14 +476,14 @@ 
 	 * @param array $reminder_days
 	 * @return string
 	 */
-	public function get_date_query( $reminder_days ) {
+	public function get_date_query($reminder_days) {
 
 		$date_query = array(
 			'relation' => 'OR',
 		);
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
+		foreach ($reminder_days as $days) {
+			$date = date_parse(date('Y-m-d', strtotime("-$days days", current_time('timestamp'))));
 
 			$date_query[] = array(
 				'year'  => $date['year'],
@@ -493,7 +493,7 @@ 
 
 		}
 
-		$date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
+		$date_query = new WP_Date_Query($date_query, 'invoices.due_date');
 
 		return $date_query->get_sql();
 

includes/wpinv-subscription.php

Indentation +1039 added lines, -1039 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,544 +177,544 @@ 
 	|
     */
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Getters
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Get customer id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_customer_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'customer_id', $context );
-	}
-
-	/**
-	 * Get customer information.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return WP_User|false WP_User object on success, false on failure.
-	 */
-	public function get_customer( $context = 'view' ) {
-		return get_userdata( $this->get_customer_id( $context ) );
-	}
-
-	/**
-	 * Get parent invoice id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_invoice_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_payment_id', $context );
-	}
-
-	/**
-	 * Alias for self::get_parent_invoice_id().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
+    /**
+     * Get customer id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_customer_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'customer_id', $context );
+    }
+
+    /**
+     * Get customer information.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WP_User|false WP_User object on success, false on failure.
+     */
+    public function get_customer( $context = 'view' ) {
+        return get_userdata( $this->get_customer_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_invoice_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_payment_id', $context );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
     public function get_parent_payment_id( $context = 'view' ) {
         return $this->get_parent_invoice_id( $context );
-	}
+    }
+
+    /**
+     * Alias for self::get_parent_invoice_id().
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_original_payment_id( $context = 'view' ) {
+        return $this->get_parent_invoice_id( $context );
+    }
+
+    /**
+     * Get parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_invoice( $context = 'view' ) {
+        return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) );
+    }
+
+    /**
+     * Alias for self::get_parent_invoice().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Invoice
+     */
+    public function get_parent_payment( $context = 'view' ) {
+        return $this->get_parent_invoice( $context );
+    }
+
+    /**
+     * Get subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_product_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'product_id', $context );
+    }
+
+    /**
+     * Get the subscription product.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return WPInv_Item
+     */
+    public function get_product( $context = 'view' ) {
+        return new WPInv_Item( $this->get_product_id( $context ) );
+    }
+
+    /**
+     * Get parent invoice's gateway.
+     *
+     * Here for backwards compatibility.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_gateway( $context = 'view' ) {
+        return $this->get_parent_invoice( $context )->get_gateway();
+    }
+
+    /**
+     * Get the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_period( $context = 'view' ) {
+        return $this->get_prop( 'period', $context );
+    }
+
+    /**
+     * Get number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_frequency( $context = 'view' ) {
+        return (int) $this->get_prop( 'frequency', $context );
+    }
+
+    /**
+     * Get the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) );
+    }
+
+    /**
+     * Get the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_amount( $context = 'view' ) {
+        return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) );
+    }
+
+    /**
+     * Get number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_bill_times( $context = 'view' ) {
+        return (int) $this->get_prop( 'bill_times', $context );
+    }
+
+    /**
+     * Get transaction id of this subscription's parent invoice.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_transaction_id( $context = 'view' ) {
+        return $this->get_prop( 'transaction_id', $context );
+    }
+
+    /**
+     * Get the date that the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_created( $context = 'view' ) {
+        return $this->get_prop( 'created', $context );
+    }
+
+    /**
+     * Alias for self::get_created().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_created( $context );
+    }
+
+    /**
+     * Retrieves the creation date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_time_created() {
+        $created = $this->get_date_created();
+        return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get GMT date when the subscription was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
+        $date = $this->get_date_created( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the date that the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date( $context = 'view' ) {
+        return $this->get_prop( 'expiration', $context );
+    }
+
+    /**
+     * Alias for self::get_next_renewal_date().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_expiration( $context = 'view' ) {
+        return $this->get_next_renewal_date( $context );
+    }
+
+    /**
+     * Retrieves the expiration date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_expiration_time() {
+        $expiration = $this->get_expiration();
+
+        if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
+            return current_time( 'timestamp' );
+        }
+
+        $expiration = strtotime( $expiration, current_time( 'timestamp' ) );
+        return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration;
+    }
+
+    /**
+     * Get GMT date when the subscription will renew.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_next_renewal_date_gmt( $context = 'view' ) {
+        $date = $this->get_next_renewal_date( $context );
+
+        if ( $date ) {
+            $date = get_gmt_from_date( $date );
+        }
+        return $date;
+    }
+
+    /**
+     * Get the subscription's trial period.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_trial_period( $context = 'view' ) {
+        return $this->get_prop( 'trial_period', $context );
+    }
+
+    /**
+     * Get the subscription's status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
+    }
+
+    /**
+     * Get the subscription's profile id.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_profile_id( $context = 'view' ) {
+        return $this->get_prop( 'profile_id', $context );
+    }
+
+    /*
+	|--------------------------------------------------------------------------
+	| Setters
+	|--------------------------------------------------------------------------
+	*/
+
+    /**
+     * Set customer id.
+     *
+     * @since 1.0.19
+     * @param  int $value The customer's id.
+     */
+    public function set_customer_id( $value ) {
+        $this->set_prop( 'customer_id', (int) $value );
+    }
+
+    /**
+     * Set parent invoice id.
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_invoice_id( $value ) {
+        $this->set_prop( 'parent_payment_id', (int) $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_parent_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Alias for self::set_parent_invoice_id().
+     *
+     * @since 1.0.19
+     * @param  int $value The parent invoice id.
+     */
+    public function set_original_payment_id( $value ) {
+        $this->set_parent_invoice_id( $value );
+    }
+
+    /**
+     * Set subscription's product id.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription product id.
+     */
+    public function set_product_id( $value ) {
+        $this->set_prop( 'product_id', (int) $value );
+    }
+
+    /**
+     * Set the period of a renewal.
+     *
+     * @since 1.0.19
+     * @param  string $value The renewal period.
+     */
+    public function set_period( $value ) {
+        $this->set_prop( 'period', $value );
+    }
+
+    /**
+     * Set number of periods each renewal is valid for.
+     *
+     * @since 1.0.19
+     * @param  int $value The subscription frequency.
+     */
+    public function set_frequency( $value ) {
+        $value = empty( $value ) ? 1 : (int) $value;
+        $this->set_prop( 'frequency', absint( $value ) );
+    }
+
+    /**
+     * Set the initial amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The initial subcription amount.
+     */
+    public function set_initial_amount( $value ) {
+        $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set the recurring amount for the subscription.
+     *
+     * @since 1.0.19
+     * @param  float $value The recurring subcription amount.
+     */
+    public function set_recurring_amount( $value ) {
+        $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) );
+    }
+
+    /**
+     * Set number of times that this subscription can be renewed.
+     *
+     * @since 1.0.19
+     * @param  int $value Bill times.
+     */
+    public function set_bill_times( $value ) {
+        $this->set_prop( 'bill_times', (int) $value );
+    }
+
+    /**
+     * 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', '' );
 
-	/**
-     * 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 = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status();
+        if ( true === $this->object_read && $old_status !== $new_status ) {
+            $this->status_transition = array(
+                'from' => $old_status,
+                'to'   => $new_status,
+            );
+        }
 
-	/**
-	 * 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 );
+        $this->set_prop( 'status', $new_status );
     }
 
-	/**
-	 * 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 = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status();
-		if ( true === $this->object_read && $old_status !== $new_status ) {
-			$this->status_transition = array(
-				'from' => $old_status,
-				'to'   => $new_status,
-			);
-		}
-
-		$this->set_prop( 'status', $new_status );
-	}
-
-	/**
-	 * Set the subscription's (remote) profile id.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value the remote profile id.
-	 */
-	public function set_profile_id( $value ) {
-		$this->set_prop( 'profile_id', sanitize_text_field( $value ) );
-	}
-
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Boolean methods
 	|--------------------------------------------------------------------------
@@ -723,55 +723,55 @@ 
 	|
 	*/
 
-	/**
+    /**
      * Checks if the subscription has a given status.
-	 *
-	 * @param string|array String or array of strings to check for.
-	 * @return bool
+     *
+     * @param string|array String or array of strings to check for.
+     * @return bool
      */
     public function has_status( $status ) {
         return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) );
-	}
+    }
 
-	/**
+    /**
      * Checks if the subscription has a trial period.
-	 *
-	 * @return bool
+     *
+     * @return bool
      */
     public function has_trial_period() {
-		$period = $this->get_trial_period();
+        $period = $this->get_trial_period();
         return ! empty( $period );
-	}
-
-	/**
-	 * Is the subscription active?
-	 *
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->has_status( 'active trialling' ) && ! $this->is_expired();
-	}
-
-	/**
-	 * Is the subscription expired?
-	 *
-	 * @return bool
-	 */
-	public function is_expired() {
-		return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) );
-	}
-
-	/**
-	 * Is this the last renewals?
-	 *
-	 * @return bool
-	 */
-	public function is_last_renewal() {
-		$max_bills = $this->get_bill_times();
-		return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
-	}
-
-	/*
+    }
+
+    /**
+     * Is the subscription active?
+     *
+     * @return bool
+     */
+    public function is_active() {
+        return $this->has_status( 'active trialling' ) && ! $this->is_expired();
+    }
+
+    /**
+     * Is the subscription expired?
+     *
+     * @return bool
+     */
+    public function is_expired() {
+        return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Is this the last renewals?
+     *
+     * @return bool
+     */
+    public function is_last_renewal() {
+        $max_bills = $this->get_bill_times();
+        return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional methods
 	|--------------------------------------------------------------------------
@@ -780,27 +780,27 @@ 
 	|
 	*/
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function create( $data = array() ) {
+    /**
+     * Backwards compatibilty.
+     */
+    public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
-	}
+    }
 
-	/**
-	 * Backwards compatibilty.
-	 */
-	public function update( $args = array() ) {
-		return $this->create( $args );
-	}
+    /**
+     * Backwards compatibilty.
+     */
+    public function update( $args = array() ) {
+        return $this->create( $args );
+    }
 
     /**
      * Retrieve renewal payments for a subscription
@@ -810,22 +810,22 @@ 
      */
     public function get_child_payments( $hide_pending = true ) {
 
-		$statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
+        $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' );
 
-		if ( ! $hide_pending ) {
-			$statuses = array_keys( wpinv_get_invoice_statuses() );
-		}
+        if ( ! $hide_pending ) {
+            $statuses = array_keys( wpinv_get_invoice_statuses() );
+        }
 
         return get_posts(
-			array(
-            	'post_parent' => $this->get_parent_payment_id(),
-            	'numberposts' => -1,
-            	'post_status' => $statuses,
-            	'orderby'     => 'ID',
-            	'order'       => 'ASC',
-            	'post_type'   => 'wpi_invoice',
-			)
-		);
+            array(
+                'post_parent' => $this->get_parent_payment_id(),
+                'numberposts' => -1,
+                'post_status' => $statuses,
+                'orderby'     => 'ID',
+                'order'       => 'ASC',
+                'post_type'   => 'wpi_invoice',
+            )
+        );
     }
 
     /**
@@ -835,7 +835,7 @@ 
      * @return int
      */
     public function get_total_payments() {
-		return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
+        return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
     }
 
     /**
@@ -859,186 +859,186 @@ 
      *
      * @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( false );
+        // Are we creating a new invoice?
+        if ( empty( $invoice ) ) {
+            $invoice = $this->create_payment( false );
 
-			if ( empty( $invoice ) ) {
-				return false;
-			}
-		}
+            if ( empty( $invoice ) ) {
+                return false;
+            }
+        }
 
-		// 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
-	 * @param bool $save Whether we should save the invoice.
+     * @param bool $save Whether we should save the invoice.
      * @return WPInv_Invoice|bool
      */
     public function create_payment( $save = true ) {
 
-		$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' );
-
-		if ( ! $save ) {
-			return $invoice;
-		}
-
-		$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( $calculate_from = null ) {
-
-		// Complete subscription if applicable
-		if ( $this->is_last_renewal() ) {
-			return $this->complete();
-		}
-
-		// Calculate new expiration
-		$frequency      = $this->get_frequency();
-		$period         = $this->get_period();
-		$calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from;
-		$new_expiration = strtotime( "+ $frequency $period", $calculate_from );
-
-		$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' );
+
+        if ( ! $save ) {
+            return $invoice;
+        }
+
+        $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( $calculate_from = null ) {
+
+        // Complete subscription if applicable
+        if ( $this->is_last_renewal() ) {
+            return $this->complete();
+        }
+
+        // Calculate new expiration
+        $frequency      = $this->get_frequency();
+        $period         = $this->get_period();
+        $calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from;
+        $new_expiration = strtotime( "+ $frequency $period", $calculate_from );
+
+        $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
@@ -1047,19 +1047,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
@@ -1072,109 +1072,109 @@ 
         return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
     }
 
-	/**
-	 * Retrieves the URL to cancel subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_cancel_url() {
-		$url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
-		return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the URL to view a subscription
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_view_url() {
-
-		$url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
-		$url = add_query_arg( 'subscription', $this->get_id(), $url );
-
-		return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can be manually renewed
-	 *
-	 * This method is filtered by payment gateways in order to return true on subscriptions
-	 * that can be renewed manually
-	 *
-	 * @since  2.5
-	 * @return bool
-	 */
-	public function can_renew() {
-		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
-	}
-
-	/**
-	 * Retrieves the URL to renew a subscription
-	 *
-	 * @since  2.5
-	 * @return string
-	 */
-	public function get_renew_url() {
-		$url = wp_nonce_url(
+    /**
+     * Retrieves the URL to cancel subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_cancel_url() {
+        $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() );
+        return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the URL to view a subscription
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_view_url() {
+
+        $url = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
+        $url = add_query_arg( 'subscription', $this->get_id(), $url );
+
+        return apply_filters( 'getpaid_get_subscription_view_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can be manually renewed
+     *
+     * This method is filtered by payment gateways in order to return true on subscriptions
+     * that can be renewed manually
+     *
+     * @since  2.5
+     * @return bool
+     */
+    public function can_renew() {
+        return apply_filters( 'wpinv_subscription_can_renew', true, $this );
+    }
+
+    /**
+     * Retrieves the URL to renew a subscription
+     *
+     * @since  2.5
+     * @return string
+     */
+    public function get_renew_url() {
+        $url = wp_nonce_url(
             add_query_arg(
                 array(
-					'getpaid-action' => 'renew_subscription',
-					'sub_id'         => $this->get_id,
+                    'getpaid-action' => 'renew_subscription',
+                    'sub_id'         => $this->get_id,
                 )
             ),
             'getpaid-nonce'
         );
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can have their payment method updated
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
-	}
-
-	/**
-	 * Retrieves the URL to update subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_update_url() {
-		$url = add_query_arg(
+        return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can have their payment method updated
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_update() {
+        return apply_filters( 'wpinv_subscription_can_update', false, $this );
+    }
+
+    /**
+     * Retrieves the URL to update subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_update_url() {
+        $url = add_query_arg(
             array(
-				'action'          => 'update',
-				'subscription_id' => $this->get_id(),
+                'action'          => 'update',
+                'subscription_id' => $this->get_id(),
             )
         );
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
-	}
-
-	/**
-	 * Retrieves the subscription status label
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_status_label() {
-		return getpaid_get_subscription_status_label( $this->get_status() );
-	}
-
-	/**
-	 * Retrieves the subscription status class
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_status_class() {
-		$statuses = getpaid_get_subscription_status_classes();
-		return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
-	}
+        return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+    }
+
+    /**
+     * Retrieves the subscription status label
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_status_label() {
+        return getpaid_get_subscription_status_label( $this->get_status() );
+    }
+
+    /**
+     * Retrieves the subscription status class
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_status_class() {
+        $statuses = getpaid_get_subscription_status_classes();
+        return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
+    }
 
     /**
      * Retrieves the subscription status label
@@ -1184,11 +1184,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>";
     }
 
     /**
@@ -1199,75 +1199,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();
+    }
 
 }

Spacing +232 added lines, -232 removed lines

@@ -6,7 +6,7 @@ 
  * @package Invoicing
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * The Subscription Class
@@ -68,27 +68,27 @@ 
 	 * @param  int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read.
 	 * @param  bool $deprecated
 	 */
-	function __construct( $subscription = 0, $deprecated = false ) {
+	function __construct($subscription = 0, $deprecated = false) {
 
-		parent::__construct( $subscription );
+		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 );
+		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 );
+			$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 ) {
-			$this->data_store->read( $this );
+		if ($this->get_id() > 0) {
+			$this->data_store->read($this);
 		}
 
 	}
@@ -103,17 +103,17 @@ 
 	 * @since 1.0.19
 	 * @return int
 	 */
-	public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) {
+	public static function get_subscription_id_by_field($value, $field = 'profile_id') {
         global $wpdb;
 
 		// Trim the value.
-		$value = trim( $value );
+		$value = trim($value);
 
-		if ( empty( $value ) ) {
+		if (empty($value)) {
 			return 0;
 		}
 
-		if ( 'invoice_id' == $field ) {
+		if ('invoice_id' == $field) {
 			$field = 'parent_payment_id';
 		}
 
@@ -125,28 +125,28 @@ 
 		);
 
 		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+		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 ) ) {
+		$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';
         $subscription_id  = (int) $wpdb->get_var(
-            $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value )
+            $wpdb->prepare("SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value)
         );
 
-		if ( empty( $subscription_id ) ) {
+		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" );
+		wp_cache_set($value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids");
 
 		return $subscription_id;
 	}
@@ -155,17 +155,17 @@ 
      * 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" );
+    public function _isset($key) {
+        return isset($this->data[$key]) || method_exists($this, "get_$key");
 	}
 
 	/*
@@ -190,8 +190,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return int
 	 */
-	public function get_customer_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'customer_id', $context );
+	public function get_customer_id($context = 'view') {
+		return (int) $this->get_prop('customer_id', $context);
 	}
 
 	/**
@@ -201,8 +201,8 @@ 
 	 * @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 ) );
+	public function get_customer($context = 'view') {
+		return get_userdata($this->get_customer_id($context));
 	}
 
 	/**
@@ -212,8 +212,8 @@ 
 	 * @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 );
+	public function get_parent_invoice_id($context = 'view') {
+		return (int) $this->get_prop('parent_payment_id', $context);
 	}
 
 	/**
@@ -223,8 +223,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return int
 	 */
-    public function get_parent_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
+    public function get_parent_payment_id($context = 'view') {
+        return $this->get_parent_invoice_id($context);
 	}
 
 	/**
@@ -233,8 +233,8 @@ 
      * @since  1.0.0
      * @return int
      */
-    public function get_original_payment_id( $context = 'view' ) {
-        return $this->get_parent_invoice_id( $context );
+    public function get_original_payment_id($context = 'view') {
+        return $this->get_parent_invoice_id($context);
     }
 
 	/**
@@ -244,8 +244,8 @@ 
 	 * @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 ) );
+	public function get_parent_invoice($context = 'view') {
+		return new WPInv_Invoice($this->get_parent_invoice_id($context));
 	}
 
 	/**
@@ -255,8 +255,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return WPInv_Invoice
 	 */
-    public function get_parent_payment( $context = 'view' ) {
-        return $this->get_parent_invoice( $context );
+    public function get_parent_payment($context = 'view') {
+        return $this->get_parent_invoice($context);
 	}
 
 	/**
@@ -266,8 +266,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return int
 	 */
-	public function get_product_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'product_id', $context );
+	public function get_product_id($context = 'view') {
+		return (int) $this->get_prop('product_id', $context);
 	}
 
 	/**
@@ -277,8 +277,8 @@ 
 	 * @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 ) );
+	public function get_product($context = 'view') {
+		return new WPInv_Item($this->get_product_id($context));
 	}
 
 	/**
@@ -290,8 +290,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_gateway( $context = 'view' ) {
-		return $this->get_parent_invoice( $context )->get_gateway();
+	public function get_gateway($context = 'view') {
+		return $this->get_parent_invoice($context)->get_gateway();
 	}
 
 	/**
@@ -301,8 +301,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_period( $context = 'view' ) {
-		return $this->get_prop( 'period', $context );
+	public function get_period($context = 'view') {
+		return $this->get_prop('period', $context);
 	}
 
 	/**
@@ -312,8 +312,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return int
 	 */
-	public function get_frequency( $context = 'view' ) {
-		return (int) $this->get_prop( 'frequency', $context );
+	public function get_frequency($context = 'view') {
+		return (int) $this->get_prop('frequency', $context);
 	}
 
 	/**
@@ -323,8 +323,8 @@ 
 	 * @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 ) );
+	public function get_initial_amount($context = 'view') {
+		return (float) wpinv_sanitize_amount($this->get_prop('initial_amount', $context));
 	}
 
 	/**
@@ -334,8 +334,8 @@ 
 	 * @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 ) );
+	public function get_recurring_amount($context = 'view') {
+		return (float) wpinv_sanitize_amount($this->get_prop('recurring_amount', $context));
 	}
 
 	/**
@@ -345,8 +345,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return int
 	 */
-	public function get_bill_times( $context = 'view' ) {
-		return (int) $this->get_prop( 'bill_times', $context );
+	public function get_bill_times($context = 'view') {
+		return (int) $this->get_prop('bill_times', $context);
 	}
 
 	/**
@@ -356,8 +356,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_transaction_id( $context = 'view' ) {
-		return $this->get_prop( 'transaction_id', $context );
+	public function get_transaction_id($context = 'view') {
+		return $this->get_prop('transaction_id', $context);
 	}
 
 	/**
@@ -367,8 +367,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_created( $context = 'view' ) {
-		return $this->get_prop( 'created', $context );
+	public function get_created($context = 'view') {
+		return $this->get_prop('created', $context);
 	}
 
 	/**
@@ -378,8 +378,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_created( $context );
+	public function get_date_created($context = 'view') {
+		return $this->get_created($context);
 	}
 
 	/**
@@ -390,7 +390,7 @@ 
 	 */
 	public function get_time_created() {
 		$created = $this->get_date_created();
-		return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) );
+		return empty($created) ? current_time('timestamp') : strtotime($created, current_time('timestamp'));
 	}
 
 	/**
@@ -400,11 +400,11 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_date_created_gmt( $context = 'view' ) {
-        $date = $this->get_date_created( $context );
+	public function get_date_created_gmt($context = 'view') {
+        $date = $this->get_date_created($context);
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
+        if ($date) {
+            $date = get_gmt_from_date($date);
         }
 		return $date;
 	}
@@ -416,8 +416,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_next_renewal_date( $context = 'view' ) {
-		return $this->get_prop( 'expiration', $context );
+	public function get_next_renewal_date($context = 'view') {
+		return $this->get_prop('expiration', $context);
 	}
 
 	/**
@@ -427,8 +427,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_expiration( $context = 'view' ) {
-		return $this->get_next_renewal_date( $context );
+	public function get_expiration($context = 'view') {
+		return $this->get_next_renewal_date($context);
 	}
 
 	/**
@@ -440,12 +440,12 @@ 
 	public function get_expiration_time() {
 		$expiration = $this->get_expiration();
 
-		if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) {
-			return current_time( 'timestamp' );
+		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;
+		$expiration = strtotime($expiration, current_time('timestamp'));
+		return $expiration < current_time('timestamp') ? current_time('timestamp') : $expiration;
 	}
 
 	/**
@@ -455,11 +455,11 @@ 
 	 * @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 );
+	public function get_next_renewal_date_gmt($context = 'view') {
+        $date = $this->get_next_renewal_date($context);
 
-        if ( $date ) {
-            $date = get_gmt_from_date( $date );
+        if ($date) {
+            $date = get_gmt_from_date($date);
         }
 		return $date;
 	}
@@ -471,8 +471,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_trial_period( $context = 'view' ) {
-		return $this->get_prop( 'trial_period', $context );
+	public function get_trial_period($context = 'view') {
+		return $this->get_prop('trial_period', $context);
 	}
 
 	/**
@@ -482,8 +482,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
+	public function get_status($context = 'view') {
+		return $this->get_prop('status', $context);
 	}
 
 	/**
@@ -493,8 +493,8 @@ 
 	 * @param  string $context View or edit context.
 	 * @return string
 	 */
-	public function get_profile_id( $context = 'view' ) {
-		return $this->get_prop( 'profile_id', $context );
+	public function get_profile_id($context = 'view') {
+		return $this->get_prop('profile_id', $context);
 	}
 
 	/*
@@ -509,8 +509,8 @@ 
 	 * @since 1.0.19
 	 * @param  int $value The customer's id.
 	 */
-	public function set_customer_id( $value ) {
-		$this->set_prop( 'customer_id', (int) $value );
+	public function set_customer_id($value) {
+		$this->set_prop('customer_id', (int) $value);
 	}
 
 	/**
@@ -519,8 +519,8 @@ 
 	 * @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 );
+	public function set_parent_invoice_id($value) {
+		$this->set_prop('parent_payment_id', (int) $value);
 	}
 
 	/**
@@ -529,8 +529,8 @@ 
 	 * @since 1.0.19
 	 * @param  int $value The parent invoice id.
 	 */
-    public function set_parent_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
+    public function set_parent_payment_id($value) {
+        $this->set_parent_invoice_id($value);
 	}
 
 	/**
@@ -539,8 +539,8 @@ 
      * @since 1.0.19
 	 * @param  int $value The parent invoice id.
      */
-    public function set_original_payment_id( $value ) {
-        $this->set_parent_invoice_id( $value );
+    public function set_original_payment_id($value) {
+        $this->set_parent_invoice_id($value);
 	}
 
 	/**
@@ -549,8 +549,8 @@ 
 	 * @since 1.0.19
 	 * @param  int $value The subscription product id.
 	 */
-	public function set_product_id( $value ) {
-		$this->set_prop( 'product_id', (int) $value );
+	public function set_product_id($value) {
+		$this->set_prop('product_id', (int) $value);
 	}
 
 	/**
@@ -559,8 +559,8 @@ 
 	 * @since 1.0.19
 	 * @param  string $value The renewal period.
 	 */
-	public function set_period( $value ) {
-		$this->set_prop( 'period', $value );
+	public function set_period($value) {
+		$this->set_prop('period', $value);
 	}
 
 	/**
@@ -569,9 +569,9 @@ 
 	 * @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 ) );
+	public function set_frequency($value) {
+		$value = empty($value) ? 1 : (int) $value;
+		$this->set_prop('frequency', absint($value));
 	}
 
 	/**
@@ -580,8 +580,8 @@ 
 	 * @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 ) );
+	public function set_initial_amount($value) {
+		$this->set_prop('initial_amount', wpinv_sanitize_amount($value));
 	}
 
 	/**
@@ -590,8 +590,8 @@ 
 	 * @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 ) );
+	public function set_recurring_amount($value) {
+		$this->set_prop('recurring_amount', wpinv_sanitize_amount($value));
 	}
 
 	/**
@@ -600,8 +600,8 @@ 
 	 * @since 1.0.19
 	 * @param  int $value Bill times.
 	 */
-	public function set_bill_times( $value ) {
-		$this->set_prop( 'bill_times', (int) $value );
+	public function set_bill_times($value) {
+		$this->set_prop('bill_times', (int) $value);
 	}
 
 	/**
@@ -610,8 +610,8 @@ 
 	 * @since 1.0.19
 	 * @param string $value Bill times.
 	 */
-	public function set_transaction_id( $value ) {
-		$this->set_prop( 'transaction_id', sanitize_text_field( $value ) );
+	public function set_transaction_id($value) {
+		$this->set_prop('transaction_id', sanitize_text_field($value));
 	}
 
 	/**
@@ -620,15 +620,15 @@ 
 	 * @since 1.0.19
 	 * @param string $value strtotime compliant date.
 	 */
-	public function set_created( $value ) {
-        $date = strtotime( $value );
+	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 ) );
+        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', '' );
+		$this->set_prop('created', '');
 
 	}
 
@@ -638,8 +638,8 @@ 
 	 * @since 1.0.19
 	 * @param string $value strtotime compliant date.
 	 */
-	public function set_date_created( $value ) {
-		$this->set_created( $value );
+	public function set_date_created($value) {
+		$this->set_created($value);
     }
 
 	/**
@@ -648,15 +648,15 @@ 
 	 * @since 1.0.19
 	 * @param string $value strtotime compliant date.
 	 */
-	public function set_next_renewal_date( $value ) {
-		$date = strtotime( $value );
+	public function set_next_renewal_date($value) {
+		$date = strtotime($value);
 
-        if ( $date && $value !== '0000-00-00 00:00:00' ) {
-            $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) );
+        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', '' );
+		$this->set_prop('expiration', '');
 
 	}
 
@@ -666,8 +666,8 @@ 
 	 * @since 1.0.19
 	 * @param string $value strtotime compliant date.
 	 */
-	public function set_expiration( $value ) {
-		$this->set_next_renewal_date( $value );
+	public function set_expiration($value) {
+		$this->set_next_renewal_date($value);
     }
 
 	/**
@@ -676,8 +676,8 @@ 
 	 * @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 );
+	public function set_trial_period($value) {
+		$this->set_prop('trial_period', $value);
 	}
 
 	/**
@@ -686,22 +686,22 @@ 
 	 * @since 1.0.19
 	 * @param string $new_status    New subscription status.
 	 */
-	public function set_status( $new_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() ) ) {
+		if (!array_key_exists($new_status, getpaid_get_subscription_statuses())) {
 			return;
 		}
 
-		$old_status = ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $this->get_status();
-		if ( true === $this->object_read && $old_status !== $new_status ) {
+		$old_status = !empty($this->status_transition['from']) ? $this->status_transition['from'] : $this->get_status();
+		if (true === $this->object_read && $old_status !== $new_status) {
 			$this->status_transition = array(
 				'from' => $old_status,
 				'to'   => $new_status,
 			);
 		}
 
-		$this->set_prop( 'status', $new_status );
+		$this->set_prop('status', $new_status);
 	}
 
 	/**
@@ -710,8 +710,8 @@ 
 	 * @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 ) );
+	public function set_profile_id($value) {
+		$this->set_prop('profile_id', sanitize_text_field($value));
 	}
 
 	/*
@@ -729,8 +729,8 @@ 
 	 * @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 ) ) );
+    public function has_status($status) {
+        return in_array($this->get_status(), wpinv_clean(wpinv_parse_list($status)));
 	}
 
 	/**
@@ -740,7 +740,7 @@ 
      */
     public function has_trial_period() {
 		$period = $this->get_trial_period();
-        return ! empty( $period );
+        return !empty($period);
 	}
 
 	/**
@@ -749,7 +749,7 @@ 
 	 * @return bool
 	 */
 	public function is_active() {
-		return $this->has_status( 'active trialling' ) && ! $this->is_expired();
+		return $this->has_status('active trialling') && !$this->is_expired();
 	}
 
 	/**
@@ -758,7 +758,7 @@ 
 	 * @return bool
 	 */
 	public function is_expired() {
-		return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'timestamp' ) );
+		return $this->has_status('expired') || ($this->has_status('active cancelled trialling') && $this->get_expiration_time() < current_time('timestamp'));
 	}
 
 	/**
@@ -768,7 +768,7 @@ 
 	 */
 	public function is_last_renewal() {
 		$max_bills = $this->get_bill_times();
-		return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed();
+		return !empty($max_bills) && $max_bills <= $this->get_times_billed();
 	}
 
 	/*
@@ -783,11 +783,11 @@ 
 	/**
 	 * Backwards compatibilty.
 	 */
-	public function create( $data = array() ) {
+	public function create($data = array()) {
 
 		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
+		if (is_array($data)) {
+			$this->set_props($data);
 		}
 
 		// Save the item.
@@ -798,8 +798,8 @@ 
 	/**
 	 * Backwards compatibilty.
 	 */
-	public function update( $args = array() ) {
-		return $this->create( $args );
+	public function update($args = array()) {
+		return $this->create($args);
 	}
 
     /**
@@ -808,12 +808,12 @@ 
      * @since  1.0.0
      * @return WP_Post[]
      */
-    public function get_child_payments( $hide_pending = true ) {
+    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(
@@ -835,7 +835,7 @@ 
      * @return int
      */
     public function get_total_payments() {
-		return getpaid_count_subscription_invoices( $this->get_parent_invoice_id(), $this->get_id() );
+		return getpaid_count_subscription_invoices($this->get_parent_invoice_id(), $this->get_id());
     }
 
     /**
@@ -847,7 +847,7 @@ 
     public function get_times_billed() {
         $times_billed = $this->get_total_payments();
 
-        if ( (float) $this->get_initial_amount() == 0 && $times_billed > 0 ) {
+        if ((float) $this->get_initial_amount() == 0 && $times_billed > 0) {
             $times_billed--;
         }
 
@@ -862,46 +862,46 @@ 
 	 * @param  WPInv_Invoice $invoice If adding an existing invoice.
      * @return bool
      */
-    public function add_payment( $args = array(), $invoice = false ) {
+    public function add_payment($args = array(), $invoice = false) {
 
 		// Process each payment once.
-        if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
+        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( false );
+		if (empty($invoice)) {
+			$invoice = $this->create_payment(false);
 
-			if ( empty( $invoice ) ) {
+			if (empty($invoice)) {
 				return false;
 			}
 		}
 
 		// Maybe set a transaction id.
-		if ( ! empty( $args['transaction_id'] ) ) {
-			$invoice->set_transaction_id( $args['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' ) );
+		$invoice->set_completed_date(current_time('mysql'));
 
 		// And the gateway.
-		if ( ! empty( $args['gateway'] ) ) {
-			$invoice->set_gateway( $args['gateway'] );
+		if (!empty($args['gateway'])) {
+			$invoice->set_gateway($args['gateway']);
 		}
 
 		$invoice->save();
 
-		if ( ! $invoice->exists() ) {
+		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( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() );
+		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 );
+        update_post_meta($invoice->get_id(), '_wpinv_subscription_id', $this->id);
 
         return $invoice->get_id();
 	}
@@ -913,47 +913,47 @@ 
 	 * @param bool $save Whether we should save the invoice.
      * @return WPInv_Invoice|bool
      */
-    public function create_payment( $save = true ) {
+    public function create_payment($save = true) {
 
 		$parent_invoice = $this->get_parent_payment();
 
-		if ( ! $parent_invoice->exists() ) {
+		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() );
+		$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'] );
+		$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 ) ) {
+		foreach ($invoice->get_items() as $item) {
+			if (in_array($item->get_id(), $allowed_items)) {
 				$invoice_items[] = $item;
 			}
 		}
 
-		$invoice->set_items( $invoice_items );
+		$invoice->set_items($invoice_items);
 
-		if ( ! empty( $subscription_group['fees'] ) ) {
-			$invoice->set_fees( $subscription_group['fees'] );
+		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 ) );
+		$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->set_status('wpi-pending');
 
-		if ( ! $save ) {
+		if (!$save) {
 			return $invoice;
 		}
 
@@ -968,24 +968,24 @@ 
 	 * @since  1.0.0
 	 * @return int The subscription's id
 	 */
-	public function renew( $calculate_from = null ) {
+	public function renew($calculate_from = null) {
 
 		// Complete subscription if applicable
-		if ( $this->is_last_renewal() ) {
+		if ($this->is_last_renewal()) {
 			return $this->complete();
 		}
 
 		// Calculate new expiration
 		$frequency      = $this->get_frequency();
 		$period         = $this->get_period();
-		$calculate_from = empty( $calculate_from ) ? $this->get_expiration_time() : $calculate_from;
-		$new_expiration = strtotime( "+ $frequency $period", $calculate_from );
+		$calculate_from = empty($calculate_from) ? $this->get_expiration_time() : $calculate_from;
+		$new_expiration = strtotime("+ $frequency $period", $calculate_from);
 
-		$this->set_expiration( date( 'Y-m-d H:i:s', $new_expiration ) );
-		$this->set_status( 'active' );
+		$this->set_expiration(date('Y-m-d H:i:s', $new_expiration));
+		$this->set_status('active');
 		$this->save();
 
-		do_action( 'getpaid_subscription_renewed', $this );
+		do_action('getpaid_subscription_renewed', $this);
 
 		return $this->get_id();
 	}
@@ -1001,11 +1001,11 @@ 
 	public function complete() {
 
 		// Only mark a subscription as complete if it's not already cancelled.
-		if ( $this->has_status( 'cancelled' ) ) {
+		if ($this->has_status('cancelled')) {
 			return false;
 		}
 
-		$this->set_status( 'completed' );
+		$this->set_status('completed');
 		return $this->save();
 
 	}
@@ -1017,14 +1017,14 @@ 
 	 * @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 ) {
+	public function expire($check_expiration = false) {
 
-		if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) {
+		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' );
+		$this->set_status('expired');
 		return $this->save();
 
 	}
@@ -1036,7 +1036,7 @@ 
 	 * @return int Subscription id.
 	 */
 	public function failing() {
-		$this->set_status( 'failing' );
+		$this->set_status('failing');
 		return $this->save();
 	}
 
@@ -1047,7 +1047,7 @@ 
      * @return int Subscription id.
      */
     public function cancel() {
-		$this->set_status( 'cancelled' );
+		$this->set_status('cancelled');
 		return $this->save();
     }
 
@@ -1058,7 +1058,7 @@ 
 	 * @return bool
 	 */
 	public function can_cancel() {
-		return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this );
+		return apply_filters('wpinv_subscription_can_cancel', $this->has_status($this->get_cancellable_statuses()), $this);
 	}
 
     /**
@@ -1069,7 +1069,7 @@ 
      * @return      array
      */
     public function get_cancellable_statuses() {
-        return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
+        return apply_filters('wpinv_recurring_cancellable_statuses', array('active', 'trialling', 'failing'));
     }
 
 	/**
@@ -1079,8 +1079,8 @@ 
 	 * @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 );
+		$url = getpaid_get_authenticated_action_url('subscription_cancel', $this->get_view_url());
+		return apply_filters('wpinv_subscription_cancel_url', $url, $this);
 	}
 
 	/**
@@ -1091,10 +1091,10 @@ 
 	 */
 	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 );
+		$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 );
+		return apply_filters('getpaid_get_subscription_view_url', $url, $this);
 	}
 
 	/**
@@ -1107,7 +1107,7 @@ 
 	 * @return bool
 	 */
 	public function can_renew() {
-		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
+		return apply_filters('wpinv_subscription_can_renew', true, $this);
 	}
 
 	/**
@@ -1126,7 +1126,7 @@ 
             ),
             'getpaid-nonce'
         );
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+		return apply_filters('wpinv_subscription_renew_url', $url, $this);
 	}
 
 	/**
@@ -1136,7 +1136,7 @@ 
 	 * @return bool
 	 */
 	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
+		return apply_filters('wpinv_subscription_can_update', false, $this);
 	}
 
 	/**
@@ -1152,7 +1152,7 @@ 
 				'subscription_id' => $this->get_id(),
             )
         );
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+		return apply_filters('wpinv_subscription_update_url', $url, $this);
 	}
 
 	/**
@@ -1162,7 +1162,7 @@ 
 	 * @return string
 	 */
 	public function get_status_label() {
-		return getpaid_get_subscription_status_label( $this->get_status() );
+		return getpaid_get_subscription_status_label($this->get_status());
 	}
 
 	/**
@@ -1173,7 +1173,7 @@ 
 	 */
 	public function get_status_class() {
 		$statuses = getpaid_get_subscription_status_classes();
-		return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark';
+		return isset($statuses[$this->get_status()]) ? $statuses[$this->get_status()] : 'badge-dark';
 	}
 
     /**
@@ -1184,9 +1184,9 @@ 
      */
     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>";
     }
@@ -1198,9 +1198,9 @@ 
      * @param  string $txn_id The transaction ID from the merchant processor
      * @return bool
      */
-    public function payment_exists( $txn_id = '' ) {
-		$invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
-        return ! empty( $invoice_id );
+    public function payment_exists($txn_id = '') {
+		$invoice_id = WPInv_Invoice::get_invoice_id_by_field($txn_id, 'transaction_id');
+        return !empty($invoice_id);
 	}
 
 	/**
@@ -1212,35 +1212,35 @@ 
 		// Reset status transition variable.
 		$this->status_transition = false;
 
-		if ( $status_transition ) {
+		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 );
+				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'] ) ) {
+				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'] ) );
+					$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 );
+					$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'] );
+					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'] ) );
+					$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 );
+					$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() );
+			} catch (Exception $e) {
+				$this->get_parent_payment()->add_note(__('Error during subscription status transition.', 'invoicing') . ' ' . $e->getMessage());
 			}
 		}
 
@@ -1266,7 +1266,7 @@ 
 	 */
 	public function activate() {
 		$status = 'trialling' === $this->get_status() ? 'trialling' : 'active';
-		$this->set_status( $status );
+		$this->set_status($status);
 		return $this->save();
 	}