AyeCode / invoicing

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

Indentation +469 added lines, -469 removed lines

@@ -12,492 +12,492 @@
  */
 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',
-			)
-		);
-
-		add_action( 'init', array( $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();
-		}
-
-		$due_date   = $invoice->get_due_date();
-		$due_date   = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
-		$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}'               => $due_date < time() ? __( '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',
+            )
+        );
+
+        add_action( 'init', array( $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();
+        }
+
+        $due_date   = $invoice->get_due_date();
+        $due_date   = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
+        $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}'               => $due_date < time() ? __( '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 +128 added lines, -128 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',
@@ -41,7 +41,7 @@ 
 			)
 		);
 
-		add_action( 'init', array( $this, 'init_hooks' ) );
+		add_action('init', array($this, 'init_hooks'));
 	}
 
 	/**
@@ -49,11 +49,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);
 		}
 	}
 
@@ -63,25 +63,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);
 		}
 
 	}
@@ -92,19 +92,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())
 			);
 		}
 
@@ -118,52 +118,52 @@ 
 	 * @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();
 		}
 
 		$due_date   = $invoice->get_due_date();
-		$due_date   = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
+		$due_date   = empty($due_date) ? time() + MINUTE_IN_SECONDS : strtotime($due_date) + ((int) get_option('gmt_offset') * HOUR_IN_SECONDS);
 		$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}'               => $due_date < time() ? __( '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}'               => $due_date < time() ? __('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);
 	}
 
 	/**
@@ -175,12 +175,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;
 		}
 
@@ -188,43 +188,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;
 	}
@@ -235,20 +235,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)));
 			}
 		}
 
@@ -261,17 +261,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);
 
 	}
 
@@ -280,12 +280,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);
 	}
 
 	/**
@@ -293,12 +293,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);
 
 	}
 
@@ -307,12 +307,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);
 
 	}
 
@@ -321,12 +321,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);
 
 	}
 
@@ -335,17 +335,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);
 
 	}
 
@@ -354,12 +354,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);
 
 	}
 
@@ -369,21 +369,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);
 
 	}
 
@@ -393,11 +393,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;
 	}
 
 	/**
@@ -406,12 +406,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));
 
 	}
 
@@ -420,9 +420,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());
 	}
 
 	/**
@@ -433,38 +433,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());
 				}
 			}
 		}
@@ -477,14 +477,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'],
@@ -494,7 +494,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/class-getpaid-subscription-notification-emails.php

Indentation +284 added lines, -284 removed lines

@@ -13,324 +13,324 @@
 class GetPaid_Subscription_Notification_Emails {
 
     /**
-	 * The array of subscription email actions.
-	 *
-	 * @param array
-	 */
-	public $subscription_actions;
+     * The array of subscription email actions.
+     *
+     * @param array
+     */
+    public $subscription_actions;
 
     /**
-	 * Class constructor
+     * Class constructor
      *
-	 */
-	public function __construct() {
-
-		$this->subscription_actions = apply_filters(
-			'getpaid_notification_email_subscription_triggers',
-			array(
-				'getpaid_subscription_active'    => 'subscription_active',
-				'getpaid_subscription_trialling' => 'subscription_trial',
-				'getpaid_subscription_cancelled' => 'subscription_cancelled',
-				'getpaid_subscription_expired'   => 'subscription_expired',
-				'getpaid_subscription_completed' => 'subscription_complete',
-				'getpaid_daily_maintenance'      => 'renewal_reminder'
-			)
-		);
-
-		add_action( 'init', array( $this, 'init_hooks' ) );
-	}
+     */
+    public function __construct() {
+
+        $this->subscription_actions = apply_filters(
+            'getpaid_notification_email_subscription_triggers',
+            array(
+                'getpaid_subscription_active'    => 'subscription_active',
+                'getpaid_subscription_trialling' => 'subscription_trial',
+                'getpaid_subscription_cancelled' => 'subscription_cancelled',
+                'getpaid_subscription_expired'   => 'subscription_expired',
+                'getpaid_subscription_completed' => 'subscription_complete',
+                'getpaid_daily_maintenance'      => 'renewal_reminder'
+            )
+        );
+
+        add_action( 'init', array( $this, 'init_hooks' ) );
+    }
 
     /**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
-		foreach ( $this->subscription_actions as $hook => $email_type ) {
-
-			$email = new GetPaid_Notification_Email( $email_type );
-
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $email_type ) ) {
-				add_action( $hook, array( $this, $email_type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
-
-		}
-
-	}
-
-	/**
-	 * Filters subscription merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function subscription_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			$merge_tags = array_merge(
-				$merge_tags,
-				$this->get_subscription_merge_tags( $object )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates subscription merge tags.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @return array
-	 */
-	public function get_subscription_merge_tags( $subscription ) {
-
-		// Abort if it does not exist.
-		if ( ! $subscription->get_id() ) {
-			return array();
-		}
-
-		$invoice    = $subscription->get_parent_invoice();
-		return array(
-			'{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
-			'{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
-			'{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
-			'{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
-			'{subscription_id}'               => absint( $subscription->get_id() ),
-			'{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
-			'{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
-			'{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
-			'{subscription_bill_times}'       => $subscription->get_bill_times(),
-			'{subscription_url}'              => esc_url( $subscription->get_view_url() ),
-		);
-
-	}
-
-	/**
-	 * Checks if we should send a notification for a subscription.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return bool
-	 */
-	public function should_send_notification( $invoice ) {
-		return 0 != $invoice->get_id();
-	}
-
-	/**
-	 * Returns notification recipients.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_recipients( $invoice ) {
-		$recipients = array( $invoice->get_email() );
-
-		$cc = $invoice->get_email_cc();
-
-		if ( ! empty( $cc ) ) {
-			$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-			$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-		}
-
-		return $recipients;
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $subscription, $email, $type, $extra_args = array() ) {
-
-		if ( empty( $subscription ) ) {
-			return;
-		}
-
-		if ( is_array( $subscription ) ) {
-			$subscription = current( $subscription );
-		}
-
-		if ( ! $subscription instanceof WPInv_Subscription ) {
-			return;
-		}
-
-		// Abort in case the parent invoice does not exist.
-		$invoice = $subscription->get_parent_invoice();
-		if ( ! $this->should_send_notification( $invoice ) ) {
-			return;
-		}
-
-		if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
-			return;
-		}
-
-		do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
-
-		$recipients  = $this->get_recipients( $invoice );
-		$mailer      = new GetPaid_Notification_Email_Sender();
-		$merge_tags  = $email->get_merge_tags();
-		$content     = $email->get_content( $merge_tags, $extra_args );
-		$subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
-		$attachments = $email->get_attachments();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$subject,
-			$content,
-			$attachments
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
-				$content,
-				$attachments
-			);
-		}
-
-		if ( $result ) {
-			$invoice->add_system_note(
-				sprintf(
-					__( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
-				)
-			);
-		} else {
-			$invoice->add_system_note(
-				sprintf(
-					__( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
-				)
-			);
-		}
-
-		do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
-
-	}
-
-	/**
-	 * Sends a subscription active.
-	 *
-	 * @since 2.8.4
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_active( $subscription ) {
-		$email = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-
-		$this->send_email( $subscription, $email, __FUNCTION__ );
-	}
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
+        foreach ( $this->subscription_actions as $hook => $email_type ) {
+
+            $email = new GetPaid_Notification_Email( $email_type );
+
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $email_type ) ) {
+                add_action( $hook, array( $this, $email_type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
+
+        }
+
+    }
 
     /**
-	 * Sends a new trial notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_trial( $subscription ) {
+     * Filters subscription merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function subscription_merge_tags( $merge_tags, $object ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            $merge_tags = array_merge(
+                $merge_tags,
+                $this->get_subscription_merge_tags( $object )
+            );
+        }
 
-	}
+        return $merge_tags;
 
-	/**
-	 * Sends a cancelled subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_cancelled( $subscription ) {
+    }
+
+    /**
+     * Generates subscription merge tags.
+     *
+     * @param WPInv_Subscription $subscription
+     * @return array
+     */
+    public function get_subscription_merge_tags( $subscription ) {
+
+        // Abort if it does not exist.
+        if ( ! $subscription->get_id() ) {
+            return array();
+        }
+
+        $invoice    = $subscription->get_parent_invoice();
+        return array(
+            '{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
+            '{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
+            '{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
+            '{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
+            '{subscription_id}'               => absint( $subscription->get_id() ),
+            '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
+            '{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
+            '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
+            '{subscription_bill_times}'       => $subscription->get_bill_times(),
+            '{subscription_url}'              => esc_url( $subscription->get_view_url() ),
+        );
+
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Checks if we should send a notification for a subscription.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return bool
+     */
+    public function should_send_notification( $invoice ) {
+        return 0 != $invoice->get_id();
+    }
 
-	}
+    /**
+     * Returns notification recipients.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_recipients( $invoice ) {
+        $recipients = array( $invoice->get_email() );
 
-	/**
-	 * Sends a subscription expired notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_expired( $subscription ) {
+        $cc = $invoice->get_email_cc();
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        if ( ! empty( $cc ) ) {
+            $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+            $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+        }
 
-	}
+        return $recipients;
+    }
 
-	/**
-	 * Sends a completed subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_complete( $subscription ) {
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Subscription $subscription
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $subscription, $email, $type, $extra_args = array() ) {
+
+        if ( empty( $subscription ) ) {
+            return;
+        }
+
+        if ( is_array( $subscription ) ) {
+            $subscription = current( $subscription );
+        }
+
+        if ( ! $subscription instanceof WPInv_Subscription ) {
+            return;
+        }
+
+        // Abort in case the parent invoice does not exist.
+        $invoice = $subscription->get_parent_invoice();
+        if ( ! $this->should_send_notification( $invoice ) ) {
+            return;
+        }
+
+        if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
+            return;
+        }
+
+        do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
+
+        $recipients  = $this->get_recipients( $invoice );
+        $mailer      = new GetPaid_Notification_Email_Sender();
+        $merge_tags  = $email->get_merge_tags();
+        $content     = $email->get_content( $merge_tags, $extra_args );
+        $subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
+        $attachments = $email->get_attachments();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $subject,
+            $content,
+            $attachments
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
+                $content,
+                $attachments
+            );
+        }
+
+        if ( $result ) {
+            $invoice->add_system_note(
+                sprintf(
+                    __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+                )
+            );
+        } else {
+            $invoice->add_system_note(
+                sprintf(
+                    __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
+                    sanitize_key( $type ),
+                    $email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+                )
+            );
+        }
+
+        do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
+
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Sends a subscription active.
+     *
+     * @since 2.8.4
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_active( $subscription ) {
+        $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
 
-	}
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+    }
 
-	/**
-	 * Sends a subscription renewal reminder notification.
-	 *
-	 */
-	public function renewal_reminder() {
+    /**
+     * Sends a new trial notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_trial( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a cancelled subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_cancelled( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription expired notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_expired( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a completed subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_complete( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription renewal reminder notification.
+     *
+     */
+    public function renewal_reminder() {
 
-		$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' ) ) );
+        // 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;
-		}
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
 
-		// Fetch matching subscriptions.
+        // Fetch matching subscriptions.
         $args  = array(
             'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active',
+            'count_total'        => false,
+            'status'             => 'trialling active',
             'date_expires_query' => array(
-				'relation' => 'OR',
+                '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' ) ) ) );
 
-			$args['date_expires_query'][] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $args['date_expires_query'][] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
 
         foreach ( $subscriptions->get_results() as $subscription ) {
 
-			// Skip packages.
-			if ( apply_filters( 'getpaid_send_subscription_renewal_reminder_email', true ) ) {
-				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
-			}
-		}
+            // Skip packages.
+            if ( apply_filters( 'getpaid_send_subscription_renewal_reminder_email', true ) ) {
+                $email->object = $subscription;
+                $this->send_email( $subscription, $email, __FUNCTION__ );
+            }
+        }
 
-	}
+    }
 
 }

Spacing +77 added lines, -77 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * This class handles subscription notificaiton emails.
@@ -37,7 +37,7 @@ 
 			)
 		);
 
-		add_action( 'init', array( $this, 'init_hooks' ) );
+		add_action('init', array($this, 'init_hooks'));
 	}
 
     /**
@@ -45,21 +45,21 @@ 
 	 */
 	public function init_hooks() {
 
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
-		foreach ( $this->subscription_actions as $hook => $email_type ) {
+		add_filter('getpaid_get_email_merge_tags', array($this, 'subscription_merge_tags'), 10, 2);
+		foreach ($this->subscription_actions as $hook => $email_type) {
 
-			$email = new GetPaid_Notification_Email( $email_type );
+			$email = new GetPaid_Notification_Email($email_type);
 
-			if ( ! $email->is_active() ) {
+			if (!$email->is_active()) {
 				continue;
 			}
 
-			if ( method_exists( $this, $email_type ) ) {
-				add_action( $hook, array( $this, $email_type ), 100, 2 );
+			if (method_exists($this, $email_type)) {
+				add_action($hook, array($this, $email_type), 100, 2);
 				continue;
 			}
 
-			do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
+			do_action('getpaid_subscription_notification_email_register_hook', $email_type, $hook);
 
 		}
 
@@ -71,12 +71,12 @@ 
 	 * @param array $merge_tags
 	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
 	 */
-	public function subscription_merge_tags( $merge_tags, $object ) {
+	public function subscription_merge_tags($merge_tags, $object) {
 
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
+		if (is_a($object, 'WPInv_Subscription')) {
 			$merge_tags = array_merge(
 				$merge_tags,
-				$this->get_subscription_merge_tags( $object )
+				$this->get_subscription_merge_tags($object)
 			);
 		}
 
@@ -90,25 +90,25 @@ 
 	 * @param WPInv_Subscription $subscription
 	 * @return array
 	 */
-	public function get_subscription_merge_tags( $subscription ) {
+	public function get_subscription_merge_tags($subscription) {
 
 		// Abort if it does not exist.
-		if ( ! $subscription->get_id() ) {
+		if (!$subscription->get_id()) {
 			return array();
 		}
 
-		$invoice    = $subscription->get_parent_invoice();
+		$invoice = $subscription->get_parent_invoice();
 		return array(
-			'{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
-			'{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
-			'{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
-			'{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
-			'{subscription_id}'               => absint( $subscription->get_id() ),
-			'{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
-			'{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
-			'{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
+			'{subscription_renewal_date}'     => getpaid_format_date_value($subscription->get_next_renewal_date(), __('Never', 'invoicing')),
+			'{subscription_created}'          => getpaid_format_date_value($subscription->get_date_created()),
+			'{subscription_status}'           => sanitize_text_field($subscription->get_status_label()),
+			'{subscription_profile_id}'       => sanitize_text_field($subscription->get_profile_id()),
+			'{subscription_id}'               => absint($subscription->get_id()),
+			'{subscription_recurring_amount}' => sanitize_text_field(wpinv_price($subscription->get_recurring_amount(), $invoice->get_currency())),
+			'{subscription_initial_amount}'   => sanitize_text_field(wpinv_price($subscription->get_initial_amount(), $invoice->get_currency())),
+			'{subscription_recurring_period}' => getpaid_get_subscription_period_label($subscription->get_period(), $subscription->get_frequency(), ''),
 			'{subscription_bill_times}'       => $subscription->get_bill_times(),
-			'{subscription_url}'              => esc_url( $subscription->get_view_url() ),
+			'{subscription_url}'              => esc_url($subscription->get_view_url()),
 		);
 
 	}
@@ -119,7 +119,7 @@ 
 	 * @param WPInv_Invoice $invoice
 	 * @return bool
 	 */
-	public function should_send_notification( $invoice ) {
+	public function should_send_notification($invoice) {
 		return 0 != $invoice->get_id();
 	}
 
@@ -129,14 +129,14 @@ 
 	 * @param WPInv_Invoice $invoice
 	 * @return array
 	 */
-	public function get_recipients( $invoice ) {
-		$recipients = array( $invoice->get_email() );
+	public function get_recipients($invoice) {
+		$recipients = array($invoice->get_email());
 
 		$cc = $invoice->get_email_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)) {
+			$cc = array_map('sanitize_email', wpinv_parse_list($cc));
+			$recipients = array_filter(array_unique(array_merge($recipients, $cc)));
 		}
 
 		return $recipients;
@@ -150,75 +150,75 @@ 
 	 * @param string $type
 	 * @param array $extra_args Extra template args.
 	 */
-	public function send_email( $subscription, $email, $type, $extra_args = array() ) {
+	public function send_email($subscription, $email, $type, $extra_args = array()) {
 
-		if ( empty( $subscription ) ) {
+		if (empty($subscription)) {
 			return;
 		}
 
-		if ( is_array( $subscription ) ) {
-			$subscription = current( $subscription );
+		if (is_array($subscription)) {
+			$subscription = current($subscription);
 		}
 
-		if ( ! $subscription instanceof WPInv_Subscription ) {
+		if (!$subscription instanceof WPInv_Subscription) {
 			return;
 		}
 
 		// Abort in case the parent invoice does not exist.
 		$invoice = $subscription->get_parent_invoice();
-		if ( ! $this->should_send_notification( $invoice ) ) {
+		if (!$this->should_send_notification($invoice)) {
 			return;
 		}
 
-		if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
+		if (apply_filters('getpaid_skip_subscription_email', false, $type, $subscription)) {
 			return;
 		}
 
-		do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
+		do_action('getpaid_before_send_subscription_notification', $type, $subscription, $email);
 
-		$recipients  = $this->get_recipients( $invoice );
+		$recipients  = $this->get_recipients($invoice);
 		$mailer      = new GetPaid_Notification_Email_Sender();
 		$merge_tags  = $email->get_merge_tags();
-		$content     = $email->get_content( $merge_tags, $extra_args );
-		$subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
+		$content     = $email->get_content($merge_tags, $extra_args);
+		$subject     = $email->add_merge_tags($email->get_subject(), $merge_tags);
 		$attachments = $email->get_attachments();
 
 		$result = $mailer->send(
-			apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
+			apply_filters('getpaid_subscription_email_recipients', wpinv_parse_list($recipients), $email),
 			$subject,
 			$content,
 			$attachments
 		);
 
 		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
+		if ($email->include_admin_bcc()) {
 			$mailer->send(
 				wpinv_get_admin_email(),
-				$subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
+				$subject . __(' - ADMIN BCC COPY', 'invoicing'),
 				$content,
 				$attachments
 			);
 		}
 
-		if ( $result ) {
+		if ($result) {
 			$invoice->add_system_note(
 				sprintf(
-					__( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+					__('Successfully sent %1$s notification email to %2$s.', 'invoicing'),
+					sanitize_key($type),
+					$email->is_admin_email() ? __('admin') : __('the customer')
 				)
 			);
 		} else {
 			$invoice->add_system_note(
 				sprintf(
-					__( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ),
-					sanitize_key( $type ),
-					$email->is_admin_email() ? __( 'admin' ) : __( 'the customer' )
+					__('Failed sending %1$s notification email to %2$s.', 'invoicing'),
+					sanitize_key($type),
+					$email->is_admin_email() ? __('admin') : __('the customer')
 				)
 			);
 		}
 
-		do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
+		do_action('getpaid_after_send_subscription_notification', $type, $subscription, $email);
 
 	}
 
@@ -229,10 +229,10 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function subscription_active( $subscription ) {
-		$email = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+	public function subscription_active($subscription) {
+		$email = new GetPaid_Notification_Email(__FUNCTION__, $subscription);
 
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+		$this->send_email($subscription, $email, __FUNCTION__);
 	}
 
     /**
@@ -240,10 +240,10 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function subscription_trial( $subscription ) {
+	public function subscription_trial($subscription) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+		$email = new GetPaid_Notification_Email(__FUNCTION__, $subscription);
+		$this->send_email($subscription, $email, __FUNCTION__);
 
 	}
 
@@ -252,10 +252,10 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function subscription_cancelled( $subscription ) {
+	public function subscription_cancelled($subscription) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+		$email = new GetPaid_Notification_Email(__FUNCTION__, $subscription);
+		$this->send_email($subscription, $email, __FUNCTION__);
 
 	}
 
@@ -264,10 +264,10 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function subscription_expired( $subscription ) {
+	public function subscription_expired($subscription) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+		$email = new GetPaid_Notification_Email(__FUNCTION__, $subscription);
+		$this->send_email($subscription, $email, __FUNCTION__);
 
 	}
 
@@ -276,10 +276,10 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function subscription_complete( $subscription ) {
+	public function subscription_complete($subscription) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+		$email = new GetPaid_Notification_Email(__FUNCTION__, $subscription);
+		$this->send_email($subscription, $email, __FUNCTION__);
 
 	}
 
@@ -289,18 +289,18 @@ 
 	 */
 	public function renewal_reminder() {
 
-		$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;
 		}
 
 		// Fetch matching subscriptions.
-        $args  = array(
+        $args = array(
             'number'             => -1,
 			'count_total'        => false,
 			'status'             => 'trialling active',
@@ -309,8 +309,8 @@ 
             ),
 		);
 
-		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'))));
 
 			$args['date_expires_query'][] = array(
 				'year'  => $date['year'],
@@ -320,14 +320,14 @@ 
 
 		}
 
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
+		$subscriptions = new GetPaid_Subscriptions_Query($args);
 
-        foreach ( $subscriptions->get_results() as $subscription ) {
+        foreach ($subscriptions->get_results() as $subscription) {
 
 			// Skip packages.
-			if ( apply_filters( 'getpaid_send_subscription_renewal_reminder_email', true ) ) {
+			if (apply_filters('getpaid_send_subscription_renewal_reminder_email', true)) {
 				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
+            	$this->send_email($subscription, $email, __FUNCTION__);
 			}
 		}