EED_Messages - Code Metrics - Inspection of "Daily Inspection: reorder constructor params so th..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — BUG-9647-cpt-queries (303307)

unknown
created 2016-05-17 21:28 UTC
EED_Messages F

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	974
Duplicated Lines	5.44 %
Coupling/Cohesion

Components	1
Dependencies	21
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
wmc	88
c	1
b	0
f	0
lcom	1
cbo	21
dl	53
loc	974
rs	1.263
31 Methods

Rating	Name	Duplication	Size	Complexity
B	run_cron()	0	30	3
A	instance()	0	3	1
A	set_hooks()	0	10	1
A	set_hooks_admin()	0	13	1
A	_register_routes()	0	7	1
A	browser_trigger()	0	14	2
B	browser_error_trigger()	0	37	4
A	run()	0	15	2
A	get_template_pack()	0	4	1
A	get_template_packs()	0	13	2
A	set_autoloaders()	0	11	3
A	_set_messages_paths()	0	18	2
A	_load_controller()	0	9	2
A	payment_reminder()	0	5	1
A	payment()	0	9	2
A	cancelled_registration()	0	5	1
B	maybe_registration()	0	35	4
C	_verify_registration_notification_send()	0	41	13
A	_get_reg_status_array()	0	6	2
A	_get_payment_message_type()	0	6	2
B	process_resend()	0	30	5
B	resend_message()	0	24	2
B	process_admin_payment()	0	45	6
A	send_newsletter_message()	0	6	1
C	registration_message_trigger_url()	0	59	9
A	preview_message()	0	16	2
A	send_message_with_messenger_only()	0	14	1
A	generate_now()	0	21	2
B	send_now()	20	44	3
B	queue_for_resending()	18	26	2
B	log()	15	15	5
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like EED_Messages often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use EED_Messages, and based on these observations, apply Extract Interface, too.
<?php
/**
 * This file contains the module for the messages system
 *
 * @since 4.5.0
 * @package  Event Espresso
 * @subpackage modules, messages
 */
if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
/**
 *
 * Messages module.  Takes care of registering all the triggers for messages.
 *
 * @since 4.5.0
 *
 * @package		Event Espresso
 * @subpackage	modules, messages
 * @author 		Darren Ethier
 *
 * ------------------------------------------------------------------------
 */
class EED_Messages  extends EED_Module {

	/**
	 * This holds the EE_messages controller
	 * @deprecated 4.9.0
	 * @var EE_messages $_EEMSG
	 */
	protected  static $_EEMSG;

	/**
	 * @type EE_Message_Resource_Manager $_message_resource_manager
	 */
	protected  static $_message_resource_manager;

	/**
	 * This holds the EE_Messages_Processor business class.
	 *
	 * @type EE_Messages_Processor
	 */
	protected static $_MSG_PROCESSOR;

	/**
	 * holds all the paths for various messages components.
	 * Utilized by autoloader registry
	 *
	 * @var array
	 */
	protected static $_MSG_PATHS;



	/**
	 * This will hold an array of messages template packs that are registered in the messages system.
	 * Format is:
	 * array(
	 * 	'template_pack_dbref' => EE_Messages_Template_Pack (instance)
	 * )
	 *
	 * @var EE_Messages_Template_Pack[]
	 */
	protected static $_TMP_PACKS = array();





	/**
	 * @return EED_Module
	 */
	public static function instance() {
		return parent::get_instance( __CLASS__ );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}




	/**
	 *  set_hooks - for hooking into EE Core, other modules, etc
	 *
	 *  @since 4.5.0
	 *
	 *  @return 	void
	 */
	public static function set_hooks() {
		//actions
		add_action( 'AHEE__EE_Payment_Processor__update_txn_based_on_payment', array( 'EED_Messages', 'payment' ), 10, 2 );
		add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array( 'EED_Messages', 'maybe_registration' ), 10, 2 );
		//filters
		add_filter( 'FHEE__EE_Registration__receipt_url__receipt_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
		add_filter( 'FHEE__EE_Registration__invoice_url__invoice_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
		//register routes
		self::_register_routes();
	}

	/**
	 * 	set_hooks_admin - for hooking into EE Admin Core, other modules, etc
	 *
	 *  @access 	public
	 *  @return 	void
	 */
	public static function set_hooks_admin() {
		//actions
		add_action( 'AHEE__EE_Payment_Processor__update_txn_based_on_payment', array( 'EED_Messages', 'payment' ), 10, 2 );
		add_action( 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', array( 'EED_Messages', 'payment_reminder' ), 10 );
		add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', array( 'EED_Messages', 'maybe_registration' ), 10, 3 );
		add_action( 'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations', array( 'EED_Messages', 'send_newsletter_message' ), 10, 2 );
		add_action( 'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', array( 'EED_Messages', 'cancelled_registration' ), 10 );
		add_action( 'AHEE__EE_Admin_Page___process_admin_payment_notification', array( 'EED_Messages', 'process_admin_payment' ), 10, 1 );
		//filters
		add_filter( 'FHEE__EE_Admin_Page___process_resend_registration__success', array( 'EED_Messages', 'process_resend' ), 10, 2 );
		add_filter( 'FHEE__EE_Registration__receipt_url__receipt_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
		add_filter( 'FHEE__EE_Registration__invoice_url__invoice_url', array( 'EED_Messages', 'registration_message_trigger_url' ), 10, 4 );
	}




	/**
	 * All the message triggers done by route go in here.
	 *
	 * @since 4.5.0
	 *
	 * @return void
	 */
	protected static function _register_routes() {
		EE_Config::register_route( 'msg_url_trigger', 'Messages', 'run' );
		EE_Config::register_route( 'msg_cron_trigger', 'Messages', 'run_cron' );
		EE_Config::register_route( 'msg_browser_trigger', 'Messages', 'browser_trigger' );
		EE_Config::register_route( 'msg_browser_error_trigger', 'Messages', 'browser_error_trigger' );
		do_action( 'AHEE__EED_Messages___register_routes' );
	}



	/**
	 * This is called when a browser display trigger is executed.
	 * The browser display trigger is typically used when a already generated message is displayed directly in the browser.
	 * @since 4.9.0
	 * @param WP $WP
	 */
	public function browser_trigger( $WP ) {

		//ensure controller is loaded
		self::_load_controller();
		$token = EE_Registry::instance()->REQ->get( 'token' );
		try {
			$mtg = new EE_Message_Generated_From_Token( $token, 'html', self::$_message_resource_manager );
			self::$_MSG_PROCESSOR->generate_and_send_now( $mtg );
		} catch( EE_Error $e ) {
			$error_msg = __( 'Please note that a system message failed to send due to a technical issue.', 'event_espresso' );
			// add specific message for developers if WP_DEBUG in on
			$error_msg .= '||' . $e->getMessage();
			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
		}
	}





	/**
	 * This is called when a browser error trigger is executed.
	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error message
	 * and display it.
	 *
	 * @since 4.9.0
	 * @param $WP
	 */
	public function browser_error_trigger( $WP ) {

		$token = EE_Registry::instance()->REQ->get( 'token' );
		if ( $token ) {
			$message = EEM_Message::instance()->get_one_by_token( $token );
			if ( $message instanceof EE_Message ) {
				header( 'HTTP/1.1 200 OK' );
				$error_msg = nl2br( $message->error_message() );
				?>
				<!DOCTYPE html>
				<html>
					<head></head>
					<body>
						<?php echo empty( $error_msg )
						? esc_html__( 'Unfortunately, we were unable to capture the error message for this message.', 'event_espresso' )
						: wp_kses(
							$error_msg,
							array(
								'a' => array(
									'href' => array(),
									'title' => array()
								),
								'span' => array(),
								'div' => array(),
								'p' => array(),
								'strong' => array(),
								'em' => array(),
								'br' => array()
							)
						); ?>
					</body>
				</html>
				<?php
				exit;
			}
		}
		return;
	}



	/**
	 *  This runs when the msg_url_trigger route has initiated.
	 *
	 * @since 4.5.0
	 * @param WP $WP
	 * @throws EE_Error
	 * @return    void
	 */
	public function run( $WP ) {
		//ensure controller is loaded
		self::_load_controller();
		// attempt to process message
		try {
			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
			$message_to_generate = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' );
			self::$_MSG_PROCESSOR->generate_and_send_now( $message_to_generate );
		} catch ( EE_Error $e ) {
			$error_msg = __( 'Please note that a system message failed to send due to a technical issue.', 'event_espresso' );
			// add specific message for developers if WP_DEBUG in on
			$error_msg .= '||' . $e->getMessage();
			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
		}
	}


	/**
	 * This is triggered by the 'msg_cron_trigger' route.
	 * @param WP $WP
	 */
	public function run_cron( $WP ) {

		self::_load_controller();
		//get required vars
		$cron_type = EE_Registry::instance()->REQ->get( 'type' );
		$transient_key = EE_Registry::instance()->REQ->get( 'key' );
		header( 'HTTP/1.1 200 OK' );

		//now let's verify transient, if not valid exit immediately
		if ( ! get_transient( $transient_key ) ) {
			/**
			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user request.
			 */
			trigger_error( esc_attr__( 'Invalid Request (Transient does not exist)', 'event_espresso' ) );
		}

		//if made it here, lets' delete the transient to keep the db clean
		delete_transient( $transient_key );

		$method = 'batch_' . $cron_type . '_from_queue';
		if ( method_exists( self::$_MSG_PROCESSOR, $method ) ) {
			self::$_MSG_PROCESSOR->$method();
		} else {
			//no matching task
			/**
			 * trigger error so this gets in the error logs.  This is important because it happens on a non user request.
			 */
			trigger_error( esc_attr( sprintf( __( 'There is no task corresponding to this route %s', 'event_espresso' ), $cron_type ) ) );
		}
		exit();
	}




	/**
	 * This is used to retrieve the template pack for the given name.
	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then the default template pack is returned.
	 *
	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
	 *
	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used in generating the Pack class name).
	 *
	 * @return EE_Messages_Template_Pack
	 */
	public static function get_template_pack( $template_pack_name ) {
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		return EEH_MSG_Template::get_template_pack( $template_pack_name );
	}




	/**
	 * Retrieves an array of all template packs.
	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
	 *
	 * @return EE_Messages_Template_Pack[]
	 */
	public static function get_template_packs() {
		EE_Registry::instance()->load_helper( 'MSG_Template' );

		//for backward compat, let's make sure this returns in the same format as originally.
		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
		$template_pack_collection->rewind();
		$template_packs = array();
		while ( $template_pack_collection->valid() ) {
			$template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
			$template_pack_collection->next();
		}
		return $template_packs;
	}



	/**
	 * This simply makes sure the autoloaders are registered for the EE_messages system.
	 *
	 * @since 4.5.0
	 *
	 * @return void
	 */
	public static function set_autoloaders() {
		if ( empty( self::$_MSG_PATHS ) ) {
			self::_set_messages_paths();
			foreach ( self::$_MSG_PATHS as $path ) {
				EEH_Autoloader::register_autoloaders_for_each_file_in_folder( $path );
			}
			// add aliases
			EEH_Autoloader::add_alias( 'EE_messages', 'EE_messages' );
			EEH_Autoloader::add_alias( 'EE_messenger', 'EE_messenger' );
		}
	}




	/**
	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
	 * for use by the Messages Autoloaders
	 *
	 * @since 4.5.0
	 *
	 * @return void.

	 */
	protected static function _set_messages_paths() {
		$dir_ref = array(
			'messages/message_type',
			'messages/messenger',
			'messages/defaults',
			'messages/defaults/email',
			'messages/data_class',
			'messages/validators',
			'messages/validators/email',
			'messages/validators/html',
			'shortcodes',
			);
		$paths = array();
		foreach ( $dir_ref as $index => $dir ) {
			$paths[ $index ] = EE_LIBRARIES . $dir;
		}
		self::$_MSG_PATHS = apply_filters( 'FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths );
	}


	/**
	 * Takes care of loading dependencies
	 *
	 * @since 4.5.0
	 * @return void
	 */
	protected static function _load_controller() {
		if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor ) {
			EE_Registry::instance()->load_core( 'Request_Handler' );
			self::set_autoloaders();
			self::$_EEMSG = EE_Registry::instance()->load_lib( 'messages' );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib( 'Messages_Processor' );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
			self::$_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		}
	}



	/**
	 * @param EE_Transaction $transaction
	 */
	public static function payment_reminder( EE_Transaction $transaction ) {
		self::_load_controller();
		$data = array( $transaction, null );
		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'payment_reminder', $data );
	}



	/**
	 * Any messages triggers for after successful gateway payments should go in here.
	 * @param  EE_Transaction object
	 * @param  EE_Payment object
	 * @return void
	 */
	public static function payment( EE_Transaction $transaction, EE_Payment $payment ) {
		self::_load_controller();
		$data = array( $transaction, $payment );
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type( $payment->STS_ID() );
		//if payment amount is less than 0 then switch to payment_refund message type.
		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( $message_type, $data );
	}



	/**
	 * @param EE_Transaction $transaction
	 */
	public static function cancelled_registration( EE_Transaction $transaction ) {
		self::_load_controller();
		$data = array( $transaction, null );
		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'cancelled_registration', $data );
	}



	/**
	 * Trigger for Registration messages
	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the incoming transaction.
	 *
	 * @param EE_Registration $registration
	 * @param array $extra_details
	 * @return void
	 */
	public static function maybe_registration( EE_Registration $registration, $extra_details = array() ) {

		if ( ! self::_verify_registration_notification_send( $registration, $extra_details ) ) {
			//no messages please
			return;
		}


		//get all registrations so we make sure we send messages for the right status.
		$all_registrations = $registration->transaction()->registrations();

		//cached array of statuses so we only trigger messages once per status.
		$statuses_sent = array();
		self::_load_controller();
		$mtgs = array();

		//loop through registrations and trigger messages once per status.
		foreach ( $all_registrations as $reg ) {

			//already triggered?
			if ( in_array( $reg->status_ID(), $statuses_sent ) ) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
				continue;
			}

			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type( $reg->status_ID() );
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers( $message_type, array( $registration->transaction(), null, $reg->status_ID() ) );
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			$statuses_sent[] = $reg->status_ID();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		}

		$mtgs = $mtgs + self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers( 'registration_summary', array( $registration->transaction(), null ) );

		//batch queue and initiate request
		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist( $mtgs );
		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
	}



	/**
	 * This is a helper method used to very whether a registration notification should be sent or
	 * not.  Prevents duplicate notifications going out for registration context notifications.
	 *
	 * @param EE_Registration $registration  [description]
	 * @param array           $extra_details [description]
	 *
	 * @return bool          true = send away, false = nope halt the presses.
	 */
	protected static function _verify_registration_notification_send( EE_Registration $registration, $extra_details = array() ) {
		 //self::log(
		 //	__CLASS__, __FUNCTION__, __LINE__,
		 //	$registration->transaction(),
		 //	array( '$extra_details' => $extra_details )
		 //);
		// currently only using this to send messages for the primary registrant
		if ( ! $registration->is_primary_registrant() ) {
			return false;
		}
		// first we check if we're in admin and not doing front ajax
		if ( is_admin() && ! EE_FRONT_AJAX ) {
			//make sure appropriate admin params are set for sending messages
			if ( empty( $_REQUEST['txn_reg_status_change']['send_notifications'] ) || ! absint( $_REQUEST['txn_reg_status_change']['send_notifications'] ) ) {
				//no messages sent please.
				return false;
			}
		} else {
			// frontend request (either regular or via AJAX)
			// TXN is NOT finalized ?
			if ( ! isset( $extra_details['finalized'] ) || $extra_details['finalized'] === false ) {
				return false;
			}
			// return visit but nothing changed ???
			if (
				isset( $extra_details['revisit'], $extra_details['status_updates'] ) &&
				$extra_details['revisit'] && ! $extra_details['status_updates']
			) {
				return false;
			}
			// NOT sending messages && reg status is something other than "Not-Approved"
			if (
				! apply_filters( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', false ) &&
				$registration->status_ID() !== EEM_Registration::status_id_not_approved
			) {
				return false;
			}
		}
		// release the kraken
		return true;
	}



	/**
	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that status id.
	 *
	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
	 *
	 * @param string $reg_status
	 *
	 * @return array
	 */
	protected static function _get_reg_status_array( $reg_status = '' ) {
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		return EEH_MSG_Template::convert_reg_status_to_message_type( $reg_status )
			? EEH_MSG_Template::convert_reg_status_to_message_type( $reg_status )
			: EEH_MSG_Template::reg_status_to_message_type_array();
	}



	/**
	 * Simply returns the payment message type for the given payment status.
	 *
	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
	 *
	 * @param string  $payment_status The payment status being matched.
	 *
	 * @return string|bool The payment message type slug matching the status or false if no match.
	 */
	protected static function _get_payment_message_type( $payment_status ) {
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		return EEH_MSG_Template::convert_payment_status_to_message_type( $payment_status )
			? EEH_MSG_Template::convert_payment_status_to_message_type( $payment_status )
			: false;
	}




	/**
	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
	 *
	 * @access public
	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
	 * @return bool          success/fail
	 */
	public static function process_resend( $req_data ) {
		self::_load_controller();

		//if $msgID in this request then skip to the new resend_message
		if ( EE_Registry::instance()->REQ->get( 'MSG_ID' ) ) {
			return self::resend_message();
		}

		//make sure any incoming request data is set on the REQ so that it gets picked up later.
		$req_data = (array) $req_data;
		foreach( $req_data as $request_key => $request_value ) {
			EE_Registry::instance()->REQ->set( $request_key, $request_value );
		}

		if ( ! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request() ) {
			return false;
		}

		try {
			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist( $messages_to_send );
			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
		} catch( EE_Error $e ) {
			EE_Error::add_error( $e->getMessage(), __FILE__, __FUNCTION__, __LINE__ );
			return false;
		}
		EE_Error::add_success(
			__( 'Messages have been successfully queued for generation and sending.', 'event_espresso' )
		);
		return true; //everything got queued.
	}


	/**
	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
	 * @return bool
	 */
	public static function resend_message() {
		self::_load_controller();

		$msgID = EE_Registry::instance()->REQ->get( 'MSG_ID' );
		if ( ! $msgID ) {
			EE_Error::add_error( __( 'Something went wrong because there is no "MSG_ID" value in the request', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
			return false;
		}

		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send( (array) $msgID );

		//setup success message.
		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::status_resend );
		EE_Error::add_success( sprintf(
			_n(
				'There was %d message queued for resending.',
				'There were %d messages queued for resending.',
				$count_ready_for_resend,
				'event_espresso'
			),
			$count_ready_for_resend
		) );
		return true;
	}





	/**
	 * Message triggers for manual payment applied by admin
	 * @param  EE_Payment $payment EE_payment object
	 * @return bool              success/fail
	 */
	public static function process_admin_payment( EE_Payment $payment ) {
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		//we need to get the transaction object
		$transaction = $payment->transaction();
		if ( $transaction instanceof EE_Transaction ) {
			$data = array( $transaction, $payment );
			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type( $payment->STS_ID() );

			//if payment amount is less than 0 then switch to payment_refund message type.
			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;

			//if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved ? false : $message_type;

			self::_load_controller();

			self::$_MSG_PROCESSOR->generate_for_all_active_messengers( $message_type, $data );

			//get count of queued for generation
			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::status_incomplete );

			if ( $count_to_generate > 0 ) {
				add_filter( 'FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true' );
				return true;
			} else {
				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::instance()->stati_indicating_failed_sending() );
				EE_Error::add_error( sprintf(
					_n(
						'The payment notification generation failed.',
						'%d payment notifications failed being sent.',
						$count_failed,
						'event_espresso'
					),
					$count_failed
				), __FILE__, __FUNCTION__, __LINE__ );
				return false;
			}
		} else {
			EE_Error::add_error(
				'Unable to generate the payment notification because the given value for the transaction is invalid.',
				'event_espresso'
			);
			return false;
		}
	}



	/**
	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
	 *
	 * @since   4.3.0
	 *
	 * @param  EE_Registration[]  $registrations   an array of EE_Registration objects
	 * @param  int      	      $grp_id     a specific message template group id.
	 * @return void
	 */
	public static function send_newsletter_message( $registrations, $grp_id ) {
		//make sure mtp is id and set it in the EE_Request Handler later messages setup.
		EE_Registry::instance()->REQ->set( 'GRP_ID', (int) $grp_id );
		self::_load_controller();
		self::$_MSG_PROCESSOR->generate_for_all_active_messengers( 'newsletter', $registrations );
	}


	/**
	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
	 *
	 * @since   4.3.0
	 *
	 * @param 	string 	$registration_message_trigger_url
	 * @param 	EE_Registration $registration
	 * @param string 	$messenger
	 * @param string 	$message_type
	 * @return 	string
	 */
	public static function registration_message_trigger_url( $registration_message_trigger_url, EE_Registration $registration, $messenger = 'html', $message_type = 'invoice' ) {
		// whitelist $messenger
		switch ( $messenger ) {
			case 'pdf' :
				$sending_messenger = 'pdf';
				$generating_messenger = 'html';
				break;
			case 'html' :
			default :
				$sending_messenger = 'html';
				$generating_messenger = 'html';
				break;
		}
		// whitelist $message_type
		switch ( $message_type ) {
			case 'receipt' :
				$message_type = 'receipt';
				break;
			case 'invoice' :
			default :
				$message_type = 'invoice';
				break;
		}
		// verify that both the messenger AND the message type are active
		if ( EEH_MSG_Template::is_messenger_active( $sending_messenger ) && EEH_MSG_Template::is_mt_active( $message_type ) ) {
			//need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
			$template_query_params = array(
				'MTP_is_active' => true,
				'MTP_messenger' => $generating_messenger,
				'MTP_message_type' => $message_type,
				'Event.EVT_ID' => $registration->event_ID()
			);
			//get the message template group.
			$msg_template_group = EEM_Message_Template_Group::instance()->get_one( array( $template_query_params ) );
			//if we don't have an EE_Message_Template_Group then return
			if ( ! $msg_template_group instanceof EE_Message_Template_Group ) {
				// remove EVT_ID from query params so that global templates get picked up
				unset( $template_query_params['Event.EVT_ID'] );
				//get global template as the fallback
				$msg_template_group = EEM_Message_Template_Group::instance()->get_one( array( $template_query_params ) );
			}
			//if we don't have an EE_Message_Template_Group then return
			if ( ! $msg_template_group instanceof EE_Message_Template_Group ) {
				return '';
			}
			// generate the URL
			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
				$sending_messenger,
				$generating_messenger,
				'purchaser',
				$message_type,
				$registration,
				$msg_template_group->ID(),
				$registration->transaction_ID()
			);

		}
		return $registration_message_trigger_url;
	}




	/**
	 * Use to generate and return a message preview!
	 * @param  string $type    This should correspond with a valid message type
	 * @param  string $context This should correspond with a valid context for the message type
	 * @param  string $messenger This should correspond with a valid messenger.
	 * @param bool 	  $send true we will do a test send using the messenger delivery, false we just do a regular preview
	 * @return string          The body of the message.
	 */
	public static function preview_message( $type, $context, $messenger, $send = false ) {

		self::_load_controller();
		$mtg = new EE_Message_To_Generate(
			$messenger,
			$type,
			array(),
			$context,
			true
		);
		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview( $mtg );
		if ( $generated_preview_queue instanceof EE_Messages_Queue ) {
			return $generated_preview_queue->get_queue()->current()->content();
		} else {
			return $generated_preview_queue;
		}
	}




	/**
	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the content
	 * found in the EE_Message objects in the queue.
	 *
	 * @since 4.9.0
	 *
	 * @param string               $messenger a string matching a valid active messenger in the system
	 * @param string $message_type Although it seems contrary to the name of the method, a message type name is
	 *                             still required to send along the message type to the messenger because this is used
	 *                             for determining what specific variations might be loaded for the generated message.
	 * @param EE_Messages_Queue     $queue
	 * @param string                $custom_subject   Can be used to set what the custom subject string will be on the aggregate
	 *                                                EE_Message object.
	 *
	 * @return bool          success or fail.
	 */
	public static function send_message_with_messenger_only( $messenger, $message_type, EE_Messages_Queue $queue, $custom_subject = '' ) {
		self::_load_controller();
		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
		$message_to_generate = EE_Registry::instance()->load_lib(
			'Message_To_Generate_From_Queue',
			array(
				$messenger,
				$message_type,
				$queue,
				$custom_subject,
			)
		);
		return self::$_MSG_PROCESSOR->queue_for_sending( $message_to_generate );
	}




	/**
	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
	 *
	 * @since 4.9.0
	 * @param array     $message_ids An array of message ids
	 * @return bool | EE_Messages_Queue     false if nothing was generated, EE_Messages_Queue containing generated messages.
	 */
	public static function generate_now( $message_ids ) {
		self::_load_controller();
		$messages = EEM_Message::instance()->get_all(
			array(
				0 => array(
					'MSG_ID' => array( 'IN', $message_ids ),
					'STS_ID' => EEM_Message::status_incomplete,
				)
			)
		);

		$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue( $messages );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		if ( ! $generated_queue instanceof EE_Messages_Queue ) {
			EE_Error::add_error(
				__( 'The messages were not generated.  This is usually because there is already a batch being generated on a separate request.  You can wait a minute or two and try again.', 'event_espresso' ),
				__FILE__, __FUNCTION__, __LINE__
			);
		}
		return $generated_queue;
	}




	/**
	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
	 * EEM_Message::status_idle
	 *
	 * @since 4.9.0
	 * @param $message_ids
	 *
	 * @return bool | EE_Messages_Queue  false if no messages sent.
	 */
	public static function send_now( $message_ids ) {
		self::_load_controller();
		$messages = EEM_Message::instance()->get_all(
			array(
				0 => array(
					'MSG_ID' => array( 'IN', $message_ids ),
					'STS_ID' => array( 'IN', array( EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry ) )
				)
			)
		);

		$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue( $messages );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		if ( ! $sent_queue instanceof EE_Messages_Queue ) {
			EE_Error::add_error(
				__( 'The messages were not sent.  This is usually because there is already a batch being sent on a separate request.  You can wait a minute or two and try again.', 'event_espresso' ),
				__FILE__, __FUNCTION__, __LINE__
			);
		} else {
			//can count how many sent by using the messages in the queue
			$sent_count = $sent_queue->count_STS_in_queue( EEM_Message::instance()->stati_indicating_sent() );
			if ( $sent_count > 0 ) {
				EE_Error::add_success(
					sprintf(
						_n(
							'There was %d message successfully sent.',
							'There were %d messages successfully sent.',
							$sent_count,
							'event_espresso'
						),
						$sent_count
					)
				);
			} else {
				EE_Error::overwrite_errors();
				EE_Error::add_error(
					__( 'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
					If there was an error, you can look at the messages in the message activity list table for any error messages.', 'event_espresso' ),
					__FILE__, __FUNCTION__, __LINE__
				);
			}
		}
		return $sent_queue;
	}





	/**
	 * This will queue the incoming message ids for resending.
	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
	 *
	 * @since 4.9.0
	 * @param array $message_ids  An array of EE_Message IDs
	 *
	 * @return bool  true means messages were successfully queued for resending, false means none were queued for resending.
	 */
	public static function queue_for_resending( $message_ids ) {
		self::_load_controller();
		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send( $message_ids );

		//get queue and count
		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue( EEM_Message::status_resend );
		if ( $queue_count > 0 ) {
			EE_Error::add_success(
				sprintf(
					_n(
						'%d message successfully queued for resending.',
				        '%d messages successfully queued for resending.',
				        $queue_count,
				        'event_espresso'
				    ),
				    $queue_count
				)
			);
		} else {
			EE_Error::add_error(
				__( 'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.', 'event_espresso' ),
				__FILE__, __FUNCTION__, __LINE__
			);
		}
		return (bool) $queue_count;
	}






	/**
	 * debug
	 *
	 * @param string $class
	 * @param string $func
	 * @param string $line
	 * @param \EE_Transaction $transaction
	 * @param array $info
	 * @param bool $display_request
	 */
	protected static function log( $class = '', $func = '', $line = '', EE_Transaction $transaction, $info = array(), $display_request = false ) {

		if ( WP_DEBUG && false ) {
			if ( $transaction instanceof EE_Transaction ) {
				// don't serialize objects
				$info = EEH_Debug_Tools::strip_objects( $info );
				$info['TXN_status'] = $transaction->status_ID();
				$info['TXN_reg_steps'] = $transaction->reg_steps();
				if ( $transaction->ID() ) {
					$index = 'EE_Transaction: ' . $transaction->ID();
					EEH_Debug_Tools::log( $class, $func, $line, $info, $display_request, $index );
				}
			}
		}

	}

}
// End of file EED_Messages.module.php
// Location: /modules/messages/EED_Messages.module.php

eventespresso / event-espresso-core
