Give_Email_Notification

Complexity

Total Complexity

55

Size/Duplication

Total Lines	712
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	3	1
A	get_instance()	0	8	3
A	load()	0	7	3
A	__set()	0	3	1
A	setup_filters()	0	23	3
A	add_setting_fields()	0	7	2
A	get_setting_fields()	0	3	1
A	add_metabox_setting_field()	0	10	1
A	get_extra_setting_fields()	0	3	1
A	get_id()	0	3	1
A	get_label()	0	3	1
A	get_description()	0	3	1
A	get_recipient()	0	14	3
A	get_recipient_group_name()	0	3	1
A	get_notification_status()	0	9	1
A	get_email_subject()	0	10	1
A	get_email_message()	0	10	1
A	get_email_message_field_description()	0	13	2
A	get_emails_tags_list_html()	0	19	3
B	get_allowed_email_tags()	0	28	8
A	get_default_email_subject()	0	3	1
A	get_default_email_message()	0	3	1
A	get_preview_email_recipient()	0	15	1
A	get_email_attachments()	0	8	1
A	get_email_type()	0	3	1
A	is_email_notification_active()	0	3	1
A	is_email_preview()	0	3	1
A	is_email_preview_has_header()	0	3	1
A	has_recipient_field()	0	3	1
A	has_preview()	0	3	1
A	send_preview_email()	0	10	1
A	send_email_notification()	0	30	2
B	preview_email_template_tags()	0	57	2
A	setup_email_data()	0	2	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 27 and the first side effect is on line 16.

/**
 * Email Notification
 *
 * This class handles all email notification settings.
 *
 * @package     Give
 * @subpackage  Classes/Emails
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.9
 */

// Exit if access directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'Give_Email_Notification' ) ) :

	/**
	 * Give_Email_Notification
	 *
	 * @abstract
	 * @since       1.9
	 */
	abstract class Give_Email_Notification {
		static private $singleton = array();

		/**
		 * @var     string $id The email's unique identifier.
		 */
		protected $id = '';

		/**
		 * @var     string $label Name of the email.
		 * @access  protected
		 * @since   1.9
		 */
		protected $label = '';

		/**
		 * @var     string $label Name of the email.
		 * @access  protected
		 * @since   1.9
		 */
		protected $description = '';

		/**
		 * @var     bool $has_preview Flag to check if email notification has preview setting field.
		 * @access  protected
		 * @since   1.9
		 */
		protected $has_preview = true;

		/**
		 * @var     bool $has_preview Flag to check if email notification has preview header.
		 * @access  protected
		 * @since   1.9
		 */
		protected $has_preview_header = true;

		/**
		 * @var     bool $preview_email_tags_values Default value to replace email template tags in preview email.
		 * @access  protected
		 * @since   1.9
		 */
		protected $preview_email_tags_values = true;

		/**
		 * @var     bool $has_recipient_field Flag to check if email notification has recipient setting field.
		 * @access  protected
		 * @since   1.9
		 */
		protected $has_recipient_field = false;

		/**
		 * @var     string $notification_status Flag to check if email notification enabled or not.
		 * @access  protected
		 * @since   1.9
		 */
		protected $notification_status = 'disabled';

		/**
		 * @var     string|array $email_tag_context List of template tags which we can add to email notification.
		 * @access  protected
		 * @since   1.9
		 */
		protected $email_tag_context = 'all';

		/**
		 * @var     string $recipient_email Donor email.
		 * @access  protected
		 * @since   1.9
		 */
		protected $recipient_email = '';

		/**
		 * @var     string $recipient_group_name Categories single or group of recipient.
		 * @access  protected
		 * @since   1.9
		 */
		protected $recipient_group_name = '';

		/**
		 * @var     bool $form_metabox_setting Flag to check if email notification setting add to form or not.
		 * @access  protected
		 * @since   1.9
		 */
		protected $form_metabox_setting = false;

		/**
		 * Setup email notification.
		 *
		 * @since 1.9
		 */
		public function init(){

		}


		/**
		 * Get instance.
		 *
		 * @since 1.9
		 * @access public
		 * @return Give_Email_Notification
		 */
		public static function get_instance() {
			$class = get_called_class();
			if ( ! array_key_exists( $class, self::$singleton ) || is_null( self::$singleton[ $class ] ) ) {
				self::$singleton[ $class ] = new $class();
			}

			return self::$singleton[ $class ];
		}

		/**
		 * Setup action and filters.
		 *
		 * @access  public
		 * @since   1.9
		 */
		public function load() {
			// Set email preview header status.
			$this->has_preview_header = $this->has_preview && $this->has_preview_header ? true : false;

			// setup filters.
			$this->setup_filters();
		}


		/**
		 * Set key value.
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param $key
		 * @param $value
		 */
		public function __set( $key, $value ) {
			$this->$key = $value;
		}


		/**
		 * Setup filters.
		 *
		 * @since  1.9
		 * @access public
		 */
		private function setup_filters() {
			// Apply filter only for current email notification section.
			if ( give_get_current_setting_section() === $this->id ) {
				// Initialize email context for email notification.
				$this->email_tag_context = apply_filters(
					"give_{$this->id}_email_tag_context",
					$this->email_tag_context,
					$this
				);
			}

			// Setup setting fields.
			add_filter( 'give_get_settings_emails', array( $this, 'add_setting_fields' ), 10, 2 );

			if( $this->form_metabox_setting ) {
				add_filter(
						'give_email_notification_options_metabox_fields',
					array( $this, 'add_metabox_setting_field' ),
					10,
					2
				);
			}
		}

		/**
		 * Register email settings.
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param   array $settings
		 *
		 * @return  array
		 */
		public function add_setting_fields( $settings ) {
			if ( $this->id === give_get_current_setting_section() ) {
				$settings = $this->get_setting_fields();
			}

			return $settings;
		}


		/**
		 * Get setting fields
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param int $form_id
		 *
		 * @return array
		 */
		public function get_setting_fields( $form_id = 0 ) {
			return Give_Email_Setting_Field::get_setting_fields( $this, $form_id );
		}


		/**
		 * Register email settings to form metabox.
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param array $settings
		 * @param int   $post_id
		 *
		 * @return array
		 */
		public function add_metabox_setting_field( $settings, $post_id ) {

			$settings[] = array(
				'id'     => $this->id,
				'title'  => $this->label,
				'fields' => $this->get_setting_fields( $post_id )
			);

			return $settings;
		}


		/**
		 * Get extra setting field.
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param int $form_id
		 *
		 * @return array
		 */
		public function get_extra_setting_fields( $form_id = 0 ) {

The parameter $form_id is not used and could be removed.

			return array();
		}

		/**
		 * Get id.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function get_id() {
			return $this->id;
		}

		/**
		 * Get label.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function get_label() {
			return $this->label;
		}

		/**
		 * Get description.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function get_description() {
			return $this->description;
		}

		/**
		 * Get recipient(s).
		 *
		 * Note: in case of admin notification this fx will return array of emails otherwise empty string or email of donor.
		 *
		 * @since  1.9
		 * @access public
		 * @return string|array
		 */
		public function get_recipient() {
			$recipient = $this->recipient_email;

			if ( ! $recipient && $this->has_recipient_field ) {
				$recipient = give_get_option( "{$this->id}_recipient" );
			}

			/**
			 * Filter the recipients
			 *
			 * @since 1.9
			 */
			return apply_filters( "give_{$this->id}_get_recipients", give_check_variable( $recipient, 'empty', Give()->emails->get_from_address() ), $this );
		}

		/**
		 * Get recipient(s) group name.
		 **
		 * @since  1.9
		 * @access public
		 * @return string|array
		 */
		public function get_recipient_group_name() {
			return $this->recipient_group_name;
		}

		/**
		 * Get notification status.
		 *
		 * @since  1.9
		 * @access public
		 * @return bool
		 */
		public function get_notification_status() {

			/**
			 * Filter the notification status.
			 *
			 * @since 1.8
			 */
			return apply_filters( "give_{$this->id}_get_notification_status", give_get_option( "{$this->id}_notification", $this->notification_status ), $this );
		}

		/**
		 * Get email subject.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		function get_email_subject() {

It is generally recommended to explicitly declare the visibility for methods.

			$subject = wp_strip_all_tags( give_get_option( "{$this->id}_email_subject", $this->get_default_email_subject() ) );

			/**
			 * Filter the subject.
			 *
			 * @since 1.9
			 */
			return apply_filters( "give_{$this->id}_get_email_subject", $subject, $this );
		}

		/**
		 * Get email message.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function get_email_message() {
			$message = give_get_option( "{$this->id}_email_message", $this->get_default_email_message() );

			/**
			 * Filter the message.
			 *
			 * @since 1.9
			 */
			return apply_filters( "give_{$this->id}_get_email_message", $message, $this );
		}


		/**
		 * Get email message field description
		 *
		 * @since 1.9
		 * @acess public
		 * @return string
		 */
		public function get_email_message_field_description() {
			$desc = esc_html__( 'Enter the email message.', 'give' );

			if ( $email_tag_list = $this->get_emails_tags_list_html() ) {
				$desc = sprintf(
					esc_html__( 'Enter the email that is sent to users after completing a successful donation. HTML is accepted. Available template tags: %s', 'give' ),
					$email_tag_list
				);

			}

			return $desc;
		}

		/**
		 * Get a formatted HTML list of all available email tags
		 *
		 * @since 1.0
		 *
		 * @return string
		 */
		function get_emails_tags_list_html() {

It is generally recommended to explicitly declare the visibility for methods.

			// Get all email tags.
			$email_tags = $this->get_allowed_email_tags();

			ob_start();
			if ( count( $email_tags ) > 0 ) : ?>
				<div class="give-email-tags-wrap">
					<?php foreach ( $email_tags as $email_tag ) : ?>
						<span class="give_<?php echo $email_tag['tag']; ?>_tag">
					<code>{<?php echo $email_tag['tag']; ?>}</code> - <?php echo $email_tag['description']; ?>
				</span>
					<?php endforeach; ?>
				</div>
			<?php endif;

			// Return the list.
			return ob_get_clean();
		}


		/**
		 * Get allowed email tags for current email notification.
		 *
		 * @since  1.9
		 * @access private
		 * @return array
		 */
		private function get_allowed_email_tags() {
			// Get all email tags.
			$email_tags = Give()->email_tags->get_tags();

			// Skip if all email template tags context setup exit.
			if ( $this->email_tag_context && 'all' !== $this->email_tag_context ) {
				if ( is_array( $this->email_tag_context ) ) {
					foreach ( $email_tags as $index => $email_tag ) {
						if ( in_array( $email_tag['context'], $this->email_tag_context ) ) {
							continue;
						}

						unset( $email_tags[ $index ] );
					}

				} else {
					foreach ( $email_tags as $index => $email_tag ) {
						if ( $this->email_tag_context === $email_tag['context'] ) {
							continue;
						}

						unset( $email_tags[ $index ] );
					}
				}
			}

			return $email_tags;
		}

		/**
		 * Get default email subject.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		function get_default_email_subject() {

It is generally recommended to explicitly declare the visibility for methods.

			return apply_filters( "give_{$this->id}give_get_default_email_subject", '', $this );
		}

		/**
		 * Get default email message.
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @return string
		 */
		function get_default_email_message() {

It is generally recommended to explicitly declare the visibility for methods.

			return apply_filters( "give_{$this->id}give_get_default_email_message", '', $this );
		}


		/**
		 * Get preview email recipients.
		 *
		 * @since  1.9
		 * @access public
		 * @return array|string
		 */
		public function get_preview_email_recipient() {
			$recipients = $this->get_recipient();

			/**
			 * Filter the preview email recipients.
			 *
			 * @since 1.9
			 *
			 * @param string|array            $recipients List of recipients.
			 * @param Give_Email_Notification $this
			 */
			$recipients = apply_filters( 'give_get_preview_email_recipient', $recipients, $this );

			return $recipients;
		}

		/**
		 * Get the recipient attachments.
		 *
		 * @since  1.9
		 * @access public
		 * @return array
		 */
		public function get_email_attachments() {
			/**
			 * Filter the attachment.
			 *
			 * @since 1.9
			 */
			return apply_filters( "give_{$this->id}_get_email_attachments", array(), $this );
		}


		/**
		 * Get email content type
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function get_email_type() {
			return Give()->emails->get_content_type();
		}

		/**
		 * Check email active or not.
		 *
		 * @since  1.9
		 * @access public
		 * @return string
		 */
		public function is_email_notification_active() {
			return give_is_setting_enabled( $this->get_notification_status() );
		}

		/**
		 * Check email preview header active or not.
		 *
		 * @since  1.9
		 * @access public
		 * @return bool
		 */
		public function is_email_preview() {
			return $this->has_preview;
		}

		/**
		 * Check email preview header active or not.
		 *
		 * @since  1.9
		 * @access public
		 * @return bool
		 */
		public function is_email_preview_has_header() {
			return $this->has_preview_header;
		}

		/**
		 * Check if notification has recipient field or not.
		 *
		 * @since  1.9
		 * @access public
		 * @return bool
		 */
		public function has_recipient_field() {
			return $this->has_recipient_field;
		}

		/**
		 * Check if notification has preview field or not.
		 *
		 * @since  1.9
		 * @access public
		 * @return bool
		 */
		public function has_preview() {
			return $this->has_preview;
		}

		/**
		 * Send preview email.
		 *
		 * @since  1.9
		 * @access public
		 */
		public function send_preview_email() {
			// setup email data.
			$this->setup_email_data();

			$attachments = $this->get_email_attachments();
			$message     = $this->preview_email_template_tags( $this->get_email_message() );
			$subject     = $this->preview_email_template_tags( $this->get_email_subject() );

			Give()->emails->send( $this->get_preview_email_recipient(), $subject, $message, $attachments );
		}

		/**
		 * Send email notification
		 *
		 * @since  1.9
		 * @access public
		 *
		 * @param array $email_tag_args Arguments which helps to decode email template tags.
		 * 
		 * @return bool
		 */
		public function send_email_notification( $email_tag_args = array() ) {
			// Do not send email if notification is disable.
			if ( ! give_is_setting_enabled( $this->get_notification_status() ) ) {
				return false;
			}

			/**
			 * Fire action after before email send.
			 *
			 * @since 1.9
			 */
			do_action( "give_{$this->id}_email_send_before", $this );


			$attachments = $this->get_email_attachments();
			$message     = give_do_email_tags( $this->get_email_message(), $email_tag_args );
			$subject     = give_do_email_tags( $this->get_email_subject(), $email_tag_args );

			// Send email.
			$email_status = Give()->emails->send( $this->get_recipient(), $subject, $message, $attachments );

			/**
			 * Fire action after after email send.
			 *
			 * @since 1.9
			 */
			do_action( "give_{$this->id}_email_send_after", $email_status, $this );

			return $email_status;
		}


		/**
		 * Decode preview email template tags.
		 *
		 * @since 1.9
		 *
		 * @param string $message
		 *
		 * @return string
		 */
		public function preview_email_template_tags( $message ) {
			$user_id    = give_check_variable( give_clean( $_GET ), 'isset_empty', 0, 'user_id' );
			$user       = ! empty( $user_id ) ? get_user_by( 'id', $user_id ) : wp_get_current_user();
			$receipt_id = strtolower( md5( uniqid() ) );

			$receipt_link_url = esc_url( add_query_arg( array(
				'payment_key' => $receipt_id,
				'give_action' => 'view_receipt',
			), home_url() ) );

			$receipt_link = sprintf(
				'<a href="%1$s">%2$s</a>',
				$receipt_link_url,
				esc_html__( 'View the receipt in your browser &raquo;', 'give' )
			);


			$this->preview_email_tags_values = wp_parse_args(
				$this->preview_email_tags_values,
				array(
					'payment_total'    => give_currency_filter( give_format_amount( 10.50 ) ),
					'payment_method'   => 'Paypal',
					'receipt_id'       => $receipt_id,
					'payment_id' => give_check_variable( give_clean( $_GET ), 'isset_empty', rand( 2000, 2050 ), 'preview_id' ),
					'receipt_link_url' => $receipt_link_url,
					'receipt_link'     => $receipt_link,
					'user'             => $user,
					'date'             => date( give_date_format(), current_time( 'timestamp' ) ),
					'donation'         => esc_html__( 'Sample Donation Form Title', 'give' ),
					'form_title'       => esc_html__( 'Sample Donation Form Title - Sample Donation Level', 'give' ),
					'sitename'         => get_bloginfo( 'name' ),
					'pdf_receipt'      => '<a href="#">Download Receipt</a>',
					'billing_address'  => '',
				)
			);


			$message = str_replace( '{name}', $this->preview_email_tags_values['user']->display_name, $message );
			$message = str_replace( '{fullname}', $this->preview_email_tags_values['user']->display_name, $message );
			$message = str_replace( '{username}', $this->preview_email_tags_values['user']->user_login, $message );
			$message = str_replace( '{user_email}', $this->preview_email_tags_values['user']->user_email, $message );
			$message = str_replace( '{date}', $this->preview_email_tags_values['date'], $message );
			$message = str_replace( '{amount}', $this->preview_email_tags_values['payment_total'], $message );
			$message = str_replace( '{price}', $this->preview_email_tags_values['payment_total'], $message );
			$message = str_replace( '{payment_total}', $this->preview_email_tags_values['payment_total'], $message );
			$message = str_replace( '{donation}', $this->preview_email_tags_values['donation'], $message );
			$message = str_replace( '{form_title}', $this->preview_email_tags_values['form_title'], $message );
			$message = str_replace( '{receipt_id}', $this->preview_email_tags_values['receipt_id'], $message );
			$message = str_replace( '{payment_method}', $this->preview_email_tags_values['payment_method'], $message );
			$message = str_replace( '{sitename}', $this->preview_email_tags_values['sitename'], $message );
			$message = str_replace( '{payment_id}', $this->preview_email_tags_values['payment_id'], $message );
			$message = str_replace( '{receipt_link}', $this->preview_email_tags_values['receipt_link'], $message );
			$message = str_replace( '{receipt_link_url}', $this->preview_email_tags_values['receipt_link_url'], $message );
			$message = str_replace( '{pdf_receipt}', $this->preview_email_tags_values['pdf_receipt'], $message );

			return apply_filters( 'give_email_preview_template_tags', $message );
		}

		/**
		 * Setup email data
		 *
		 * @since 1.9
		 */
		public function setup_email_data() {
		}
	}

endif; // End class_exists check