eventespresso / event-espresso-core

core/libraries/messages/validators/email/EE_Messages_Email_Pending_Approval_Validator.class.php

Indentation +23 added lines, -23 removed lines

@@ -15,31 +15,31 @@
 {
 
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'pending_approval';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'pending_approval';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger)
-     */
-    protected function _modify_validator()
-    {
-        $new_config = $this->_messenger->get_validator_config();
-        // modify just event_list
-        $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'),
-            'required' => array('[EVENT_LIST]')
-            );
-        $this->_messenger->set_validator_config($new_config);
+	/**
+	 * custom validator (restricting what was originally set by the messenger)
+	 */
+	protected function _modify_validator()
+	{
+		$new_config = $this->_messenger->get_validator_config();
+		// modify just event_list
+		$new_config['event_list'] = array(
+			'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'),
+			'required' => array('[EVENT_LIST]')
+			);
+		$this->_messenger->set_validator_config($new_config);
 
-        if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
-        }
+		if ($this->_context != 'admin') {
+			$this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+		}
 
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
-    }
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
         $this->_messenger->set_validator_config($new_config);
 
         if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+            $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
         }
 
         $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');

core/libraries/messages/validators/email/EE_Messages_Email_Payment_Validator.class.php

Indentation +33 added lines, -33 removed lines

@@ -15,37 +15,37 @@
 {
 
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'payment';
-
-        parent::__construct($fields, $context);
-    }
-
-    /**
-     * at this point no custom validation needed for this messenger/message_type combo.
-     */
-    protected function _modify_validator()
-    {
-        $new_config = $this->_messenger->get_validator_config();
-
-        // modify just event_list
-        $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
-            );
-        $new_config['ticket_list'] = array(
-            'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
-            );
-        $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
-            );
-        $this->_messenger->set_validator_config($new_config);
-
-        if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
-        }
-
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
-    }
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'payment';
+
+		parent::__construct($fields, $context);
+	}
+
+	/**
+	 * at this point no custom validation needed for this messenger/message_type combo.
+	 */
+	protected function _modify_validator()
+	{
+		$new_config = $this->_messenger->get_validator_config();
+
+		// modify just event_list
+		$new_config['event_list'] = array(
+			'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+			);
+		$new_config['ticket_list'] = array(
+			'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
+			);
+		$new_config['content'] = array(
+			'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+			);
+		$this->_messenger->set_validator_config($new_config);
+
+		if ($this->_context != 'admin') {
+			$this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+		}
+
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -32,18 +32,18 @@
 
         // modify just event_list
         $new_config['event_list'] = array(
-            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
+            'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list')
             );
         $new_config['ticket_list'] = array(
             'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction')
             );
         $new_config['content'] = array(
-            'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
+            'shortcodes' => array('event_list', 'attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger')
             );
         $this->_messenger->set_validator_config($new_config);
 
         if ($this->_context != 'admin') {
-            $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
+            $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list');
         }
 
         $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]');

core/libraries/messages/validators/html/EE_Messages_Html_Invoice_Validator.class.php

Indentation +15 added lines, -15 removed lines

@@ -16,21 +16,21 @@
 class EE_Messages_Html_Invoice_Validator extends EE_Messages_Validator
 {
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'html';
-        $this->_mt_name = 'invoice';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'html';
+		$this->_mt_name = 'invoice';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger).
-     * Note nothing is currently done for this messenger and message type.
-     */
-    protected function _modify_validator()
-    {
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
-        return;
-    }
+	/**
+	 * custom validator (restricting what was originally set by the messenger).
+	 * Note nothing is currently done for this messenger and message type.
+	 */
+	protected function _modify_validator()
+	{
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
+		return;
+	}
 }

core/libraries/messages/validators/html/EE_Messages_Html_Receipt_Validator.class.php

Indentation +15 added lines, -15 removed lines

@@ -16,21 +16,21 @@
 class EE_Messages_Html_Receipt_Validator extends EE_Messages_Validator
 {
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'html';
-        $this->_mt_name = 'receipt';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'html';
+		$this->_mt_name = 'receipt';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger).
-     * Note nothing is currently done for this messenger and message type.
-     */
-    protected function _modify_validator()
-    {
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
-        return;
-    }
+	/**
+	 * custom validator (restricting what was originally set by the messenger).
+	 * Note nothing is currently done for this messenger and message type.
+	 */
+	protected function _modify_validator()
+	{
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
+		return;
+	}
 }

core/libraries/messages/EE_Messages_Base.lib.php

Indentation +264 added lines, -264 removed lines

@@ -14,44 +14,44 @@ 
 abstract class EE_Messages_Base extends EE_Base
 {
 
-    /** DETAILS PROPERTIES **/
-    /**
-     * The following are used to hold details on the type for reference (i.e. on admin screens)
-     * and also used by the EE_message_type object to figure out where to get template data.
-     */
-    public $name;
-    public $description;
-    protected $_messages_item_type; // messenger OR message_type?
-
-
-    /**
-     * This is an array describing the ui facing labels
-     * that will be used whenever the messenger is referenced in the ui
-     *
-     * array(
-     *  'singular' => __('something'),
-     *  'plural' => __('somethings')
-     * )
-     *
-     * @var array
-     */
-    public $label;
-
-
-
-
-    /**
-     * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
-     * (and used to determine which callback method to call from the child class)
-     *
-     * structure should be
-     * array(
-     * 'page_action' => true
-     * )
-     *
+	/** DETAILS PROPERTIES **/
+	/**
+	 * The following are used to hold details on the type for reference (i.e. on admin screens)
+	 * and also used by the EE_message_type object to figure out where to get template data.
+	 */
+	public $name;
+	public $description;
+	protected $_messages_item_type; // messenger OR message_type?
+
+
+	/**
+	 * This is an array describing the ui facing labels
+	 * that will be used whenever the messenger is referenced in the ui
+	 *
+	 * array(
+	 *  'singular' => __('something'),
+	 *  'plural' => __('somethings')
+	 * )
+	 *
+	 * @var array
+	 */
+	public $label;
+
+
+
+
+	/**
+	 * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
+	 * (and used to determine which callback method to call from the child class)
+	 *
+	 * structure should be
+	 * array(
+	 * 'page_action' => true
+	 * )
+	 *
 *@var array
-     */
-    public $admin_registered_pages = array();
+	 */
+	public $admin_registered_pages = array();
 
 
 
@@ -60,264 +60,264 @@ 
 
 
 
-    /**
-     * this property holds any specific fields for holding any settings related to a messenger (if any needed)
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
+	/**
+	 * this property holds any specific fields for holding any settings related to a messenger (if any needed)
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
 
 
 
 
 
-    /**
-     * this property will hold any existing settings that may have been set in the admin.
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
+	/**
+	 * this property will hold any existing settings that may have been set in the admin.
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
 
 
 
 
 
-    /**
-     * this property will hold an array of valid shortcodes for this message type and messengers.
-     * #For Message Types:
-     * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
-     * For example:
-     * array( 'admin' => array('transaction', 'event', 'attendee') )
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the admin context;
-     *
-     *
-     * #For Messengers:
-     * For example:
-     * array('subject' => array('transaction', 'event', 'attendee'))
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the 'subject' field;
-     * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
-     * that field will inherit whatever are set as valid shortcodes by message_type.
-     * This is so messenger can set specific valid codes for fields and leave other
-     * valid shortcodes up to the message type matched with the messenger.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_valid_shortcodes = array();
+	/**
+	 * this property will hold an array of valid shortcodes for this message type and messengers.
+	 * #For Message Types:
+	 * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
+	 * For example:
+	 * array( 'admin' => array('transaction', 'event', 'attendee') )
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the admin context;
+	 *
+	 *
+	 * #For Messengers:
+	 * For example:
+	 * array('subject' => array('transaction', 'event', 'attendee'))
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the 'subject' field;
+	 * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
+	 * that field will inherit whatever are set as valid shortcodes by message_type.
+	 * This is so messenger can set specific valid codes for fields and leave other
+	 * valid shortcodes up to the message type matched with the messenger.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_valid_shortcodes = array();
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_set_admin_settings_fields();
-        $this->_set_valid_shortcodes();
-        $this->_set_admin_pages();
-    }
+	public function __construct()
+	{
+		$this->_set_admin_settings_fields();
+		$this->_set_valid_shortcodes();
+		$this->_set_admin_pages();
+	}
 
 
 
 
 
-    /**
-     * sets the _admin_settings_fields property which needs to be defined by child classes.
-     * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
-     * array(
-     *      {field_name - also used for setting index} => array(
-     *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
-     *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
-     *          'required' => {bool, required or not},
-     *          'validation' => {bool, true if we want validation, false if not},
-     *          'format' => {%d, or %s},
-     *          'label' => {label for the field, make sure it's localized},
-     *          'default' => {default value for the setting}
-     *      ),
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_settings_fields();
+	/**
+	 * sets the _admin_settings_fields property which needs to be defined by child classes.
+	 * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
+	 * array(
+	 *      {field_name - also used for setting index} => array(
+	 *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
+	 *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
+	 *          'required' => {bool, required or not},
+	 *          'validation' => {bool, true if we want validation, false if not},
+	 *          'format' => {%d, or %s},
+	 *          'label' => {label for the field, make sure it's localized},
+	 *          'default' => {default value for the setting}
+	 *      ),
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_settings_fields();
 
 
 
 
 
-    /**
-     * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
-     * Child classes have to define this method but don't necessarily have to set the flags
-     * as they will be set to false by default.
-     *
-     * Child classes use this method to set the `_admin_registered_page` property.
-     * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
-     * so Message Type/messenger fields/content is included on that admin page.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_pages();
+	/**
+	 * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
+	 * Child classes have to define this method but don't necessarily have to set the flags
+	 * as they will be set to false by default.
+	 *
+	 * Child classes use this method to set the `_admin_registered_page` property.
+	 * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
+	 * so Message Type/messenger fields/content is included on that admin page.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_pages();
 
 
 
 
 
-    /**
-     * Child classes must declare the $_valid_shortcodes property using this method.
-     * See comments for $_valid_shortcodes property for details on what it is used for.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_valid_shortcodes();
+	/**
+	 * Child classes must declare the $_valid_shortcodes property using this method.
+	 * See comments for $_valid_shortcodes property for details on what it is used for.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_valid_shortcodes();
 
 
 
-    /**
-     * sets the _existing_admin_settings property can be overridden by child classes.
-     * We do this so we only do database calls if needed.
-     *
-     * @access protected
-     * @param string $messenger
-     */
-    protected function _set_existing_admin_settings($messenger = '')
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $Message_Resource_Manager->get_active_messengers_option();
-        $settings_to_use = $active_messengers;
-
-        /**
-         * This determines what will be used for the getting the settings.
-         */
-        if (! empty($messenger)
-            && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
-        ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
-        }
-
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * get_existing_admin_settings
-     * (if needed) sets and returns the _existing_admin_settings property.
-     *
-     * @access public
-     * @param string $messenger
-     * @return array          settings
-     */
-    public function get_existing_admin_settings($messenger = '')
-    {
-        // if admin_settings property empty lets try setting it.
-        if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
-            $this->_set_existing_admin_settings($messenger);
-        }
-        return property_exists($this, '_existing_admin_settings')
-            ? $this->_existing_admin_settings
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
-     * @return array   an array of valid shortcodes.
-     */
-    public function get_valid_shortcodes()
-    {
-        $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
-            $this->_valid_shortcodes,
-            $this
-        );
-        // The below filter applies to ALL messengers and message types so use with care!
-        $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
-        return $valid_shortcodes;
-    }
-
-
-
-
-    /**
-     * getter that returns the protected admin_settings_fields property
-     *
-     * @access public
-     * @return array admin settings fields
-     */
-    public function get_admin_settings_fields()
-    {
-        return $this->_admin_settings_fields;
-    }
-
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page)
-     * and will return the response from the child class callback function
-     * if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $actives an array of active message type (or messenger) objects.
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra This is just an extra argument that can be used
-     *                     to pass additional data for setting up page content.
-     * @access protected
-     * @return string $content for page.
-     */
-    protected function _get_admin_page_content($page, $action, $extra, $actives)
-    {
-        // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
-        }
-
-        if (!isset($this->admin_registered_pages[ $page ])) {
-            // todo: a place to throw an exception?
-            // We need to indicate there is no registered page so this function is not being called correctly.
-            return false;
-        }
-        // k made it here so let's call the method
-        $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
-        );
-        if ($content === false) {
-            // todo this needs to be an exception once we've got exceptions in place.
-            return false;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	/**
+	 * sets the _existing_admin_settings property can be overridden by child classes.
+	 * We do this so we only do database calls if needed.
+	 *
+	 * @access protected
+	 * @param string $messenger
+	 */
+	protected function _set_existing_admin_settings($messenger = '')
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
+		$settings_to_use = $active_messengers;
+
+		/**
+		 * This determines what will be used for the getting the settings.
+		 */
+		if (! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
+		) {
+			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+		}
+
+		$this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
+			? $settings_to_use[ $this->name ]['settings']
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * get_existing_admin_settings
+	 * (if needed) sets and returns the _existing_admin_settings property.
+	 *
+	 * @access public
+	 * @param string $messenger
+	 * @return array          settings
+	 */
+	public function get_existing_admin_settings($messenger = '')
+	{
+		// if admin_settings property empty lets try setting it.
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
+		}
+		return property_exists($this, '_existing_admin_settings')
+			? $this->_existing_admin_settings
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
+	 * @return array   an array of valid shortcodes.
+	 */
+	public function get_valid_shortcodes()
+	{
+		$valid_shortcodes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+			$this->_valid_shortcodes,
+			$this
+		);
+		// The below filter applies to ALL messengers and message types so use with care!
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
+		return $valid_shortcodes;
+	}
+
+
+
+
+	/**
+	 * getter that returns the protected admin_settings_fields property
+	 *
+	 * @access public
+	 * @return array admin settings fields
+	 */
+	public function get_admin_settings_fields()
+	{
+		return $this->_admin_settings_fields;
+	}
+
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page)
+	 * and will return the response from the child class callback function
+	 * if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $actives an array of active message type (or messenger) objects.
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra This is just an extra argument that can be used
+	 *                     to pass additional data for setting up page content.
+	 * @access protected
+	 * @return string $content for page.
+	 */
+	protected function _get_admin_page_content($page, $action, $extra, $actives)
+	{
+		// we can also further refine the context by action (if present).
+		if (!empty($action)) {
+			$page = $page . '_' . $action;
+		}
+
+		if (!isset($this->admin_registered_pages[ $page ])) {
+			// todo: a place to throw an exception?
+			// We need to indicate there is no registered page so this function is not being called correctly.
+			return false;
+		}
+		// k made it here so let's call the method
+		$content = call_user_func_array(
+			array( $this, '_get_admin_content_' . $page ),
+			array( $actives, $extra )
+		);
+		if ($content === false) {
+			// todo this needs to be an exception once we've got exceptions in place.
+			return false;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -192,14 +192,14 @@ 
         /**
          * This determines what will be used for the getting the settings.
          */
-        if (! empty($messenger)
+        if ( ! empty($messenger)
             && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
         ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+            $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
         }
 
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
+        $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+            ? $settings_to_use[$this->name]['settings']
             : null;
     }
 
@@ -239,7 +239,7 @@ 
     public function get_valid_shortcodes()
     {
         $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+            'FHEE__'.get_class($this).'__get_valid_shortcodes',
             $this->_valid_shortcodes,
             $this
         );
@@ -282,19 +282,19 @@ 
     protected function _get_admin_page_content($page, $action, $extra, $actives)
     {
         // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
+        if ( ! empty($action)) {
+            $page = $page.'_'.$action;
         }
 
-        if (!isset($this->admin_registered_pages[ $page ])) {
+        if ( ! isset($this->admin_registered_pages[$page])) {
             // todo: a place to throw an exception?
             // We need to indicate there is no registered page so this function is not being called correctly.
             return false;
         }
         // k made it here so let's call the method
         $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
+            array($this, '_get_admin_content_'.$page),
+            array($actives, $extra)
         );
         if ($content === false) {
             // todo this needs to be an exception once we've got exceptions in place.

core/libraries/messages/EE_Messenger_Collection.lib.php

Indentation +179 added lines, -179 removed lines

@@ -14,183 +14,183 @@
 class EE_Messenger_Collection extends EE_Object_Collection
 {
 
-    /**
-     * EE_Messenger_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_messenger';
-    }
-
-
-
-    /**
-     * add
-     *
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::add($object, $info);
-    }
-
-
-
-    /**
-     * set_info
-     *
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::set_info($object, $info);
-    }
-
-
-
-    /**
-     * get_by_info
-     *
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info)
-    {
-        return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
-    }
-
-
-
-    /**
-     * has
-     *
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param object $object
-     * @return bool
-     */
-    public function has($object)
-    {
-        return parent::has($object);
-    }
-
-
-
-    /**
-     * has_by_name
-     *
-     * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection
-     *
-     * @access public
-     * @param string $messenger_name
-     * @return bool
-     */
-    public function has_by_name($messenger_name)
-    {
-        return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false;
-    }
-
-
-
-    /**
-     * remove
-     *
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        return parent::remove($object);
-    }
-
-
-
-    /**
-     * current
-     *
-     * current object from the Collection
-     *
-     * @access public
-     * @return EE_messenger
-     */
-    public function current()
-    {
-        return parent::current();
-    }
-
-
-
-    /**
-     * set_current
-     *
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        parent::set_current($object);
-    }
-
-
-
-    /**
-     * set_current_by_info
-     *
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @access public
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        parent::set_current_by_info($info);
-    }
-
-
-
-    /**
-     * show_collection_classes
-     *
-     * displays list of collection classes if WP_DEBUG is on
-     *
-     * @access public
-     * @return void
-     */
-    public function show_collection_classes()
-    {
-        if (WP_DEBUG) {
-            $this->rewind();
-            while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
-                $this->next();
-            }
-        }
-    }
+	/**
+	 * EE_Messenger_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_messenger';
+	}
+
+
+
+	/**
+	 * add
+	 *
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::add($object, $info);
+	}
+
+
+
+	/**
+	 * set_info
+	 *
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::set_info($object, $info);
+	}
+
+
+
+	/**
+	 * get_by_info
+	 *
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info)
+	{
+		return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
+	}
+
+
+
+	/**
+	 * has
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object)
+	{
+		return parent::has($object);
+	}
+
+
+
+	/**
+	 * has_by_name
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection
+	 *
+	 * @access public
+	 * @param string $messenger_name
+	 * @return bool
+	 */
+	public function has_by_name($messenger_name)
+	{
+		return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false;
+	}
+
+
+
+	/**
+	 * remove
+	 *
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		return parent::remove($object);
+	}
+
+
+
+	/**
+	 * current
+	 *
+	 * current object from the Collection
+	 *
+	 * @access public
+	 * @return EE_messenger
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
+
+
+
+	/**
+	 * set_current
+	 *
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		parent::set_current($object);
+	}
+
+
+
+	/**
+	 * set_current_by_info
+	 *
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @access public
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		parent::set_current_by_info($info);
+	}
+
+
+
+	/**
+	 * show_collection_classes
+	 *
+	 * displays list of collection classes if WP_DEBUG is on
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function show_collection_classes()
+	{
+		if (WP_DEBUG) {
+			$this->rewind();
+			while ($this->valid()) {
+				echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+				$this->next();
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
         if (WP_DEBUG) {
             $this->rewind();
             while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+                echo '<h5 style="color:#2EA2CC;">'.__CLASS__.' class : . <span style="color:#E76700">'.$this->getInfo().'</span></h5>';
                 $this->next();
             }
         }

core/libraries/messages/messenger/EE_Html_messenger.class.php

Spacing +2 added lines, -2 removed lines

@@ -313,7 +313,7 @@ 
                     ),
                     'ticket_line_item_no_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                             'Ticket Line Item List with no Price Modifiers',
                             'event_espresso'
                         ),
@@ -327,7 +327,7 @@ 
                     ),
                     'ticket_line_item_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                             'Ticket Line Item List with Price Modifiers',
                             'event_espresso'
                         ),

Indentation +544 added lines, -544 removed lines

@@ -12,548 +12,548 @@
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name = 'html';
-        $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('html', 'event_espresso'),
-            'plural' => __('html', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @see    parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @see    parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => true);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
-            ),
-            'content' => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ),
-            ),
-            'event_list' => array(
-                'shortcodes' => array(
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ),
-                'required' => array('[EVENT_LIST]'),
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array(
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ),
-                'required' => array('[TICKET_LIST]'),
-            ),
-            'ticket_line_item_no_pms' => array(
-                'shortcodes' => array('line_item', 'ticket'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'ticket_line_item_pms' => array(
-                'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'price_modifier_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]'),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee'),
-                'required' => array('[ATTENDEE_LIST]'),
-            ),
-            'tax_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[TAX_LINE_ITEM_LIST]'),
-            ),
-            'additional_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-            ),
-            'payment_list' => array(
-                'shortcodes' => array('payment'),
-                'required' => array('[PAYMENT_LIST_*]'),
-            ),
-        );
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @since 4.5.0
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param \EE_Messages_Template_Pack $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    ) {
-        $variation = $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-        return $variation;
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => __('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => true,
-                'validation' => true,
-                'css_class' => 'large-text',
-                'format' => '%s',
-            ),
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => __('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'ticket_line_item_no_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                            'Ticket Line Item List with no Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'ticket_line_item_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                            'Ticket Line Item List with Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'price_modifier_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'tax_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TAX_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
-                    ),
-                    'additional_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-                    ),
-                    'payment_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PAYMENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PAYMENT_LIST_*]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @since 4.5.0
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => $this->_subject,
-            'base_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body' => wpautop(
-                apply_filters(
-                    'FHEE__EE_Html_messenger___send_message__main_body',
-                    $this->_content,
-                    $this->_content,
-                    $this->_incoming_message_type
-                )
-            )
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        echo $this->_get_main_template();
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @since  4.5.0
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
-        // include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string $content
-     * @param string $content_again
-     * @param \EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        $content = '',
-        $content_again = '',
-        EE_message_type $incoming_message_type
-    ) {
-        if (($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= \EEH_Template::powered_by_event_espresso(
-                'aln-cntr',
-                '',
-                array('utm_content' => 'messages_system')
-            )
-                . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name = 'html';
+		$this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('html', 'event_espresso'),
+			'plural' => __('html', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @see    parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @see    parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => true);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
+			),
+			'content' => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				),
+			),
+			'event_list' => array(
+				'shortcodes' => array(
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				),
+				'required' => array('[EVENT_LIST]'),
+			),
+			'ticket_list' => array(
+				'shortcodes' => array(
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				),
+				'required' => array('[TICKET_LIST]'),
+			),
+			'ticket_line_item_no_pms' => array(
+				'shortcodes' => array('line_item', 'ticket'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'ticket_line_item_pms' => array(
+				'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'price_modifier_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]'),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee'),
+				'required' => array('[ATTENDEE_LIST]'),
+			),
+			'tax_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[TAX_LINE_ITEM_LIST]'),
+			),
+			'additional_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+			),
+			'payment_list' => array(
+				'shortcodes' => array('payment'),
+				'required' => array('[PAYMENT_LIST_*]'),
+			),
+		);
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @since 4.5.0
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param \EE_Messages_Template_Pack $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	) {
+		$variation = $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+		return $variation;
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => __('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => true,
+				'validation' => true,
+				'css_class' => 'large-text',
+				'format' => '%s',
+			),
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => __('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'ticket_line_item_no_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+							'Ticket Line Item List with no Price Modifiers',
+							'event_espresso'
+						),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'ticket_line_item_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+							'Ticket Line Item List with Price Modifiers',
+							'event_espresso'
+						),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'price_modifier_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'tax_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[TAX_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
+					),
+					'additional_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+					),
+					'payment_list' => array(
+						'input' => 'textarea',
+						'label' => '[PAYMENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PAYMENT_LIST_*]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @since 4.5.0
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => $this->_subject,
+			'base_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body' => wpautop(
+				apply_filters(
+					'FHEE__EE_Html_messenger___send_message__main_body',
+					$this->_content,
+					$this->_content,
+					$this->_incoming_message_type
+				)
+			)
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		echo $this->_get_main_template();
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @since  4.5.0
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
+		// include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string $content
+	 * @param string $content_again
+	 * @param \EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		$content = '',
+		$content_again = '',
+		EE_message_type $incoming_message_type
+	) {
+		if (($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= \EEH_Template::powered_by_event_espresso(
+				'aln-cntr',
+				'',
+				array('utm_content' => 'messages_system')
+			)
+				. EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 }

core/libraries/messages/EE_Messages_Data_Handler_Collection.lib.php

Indentation +52 added lines, -52 removed lines

@@ -11,69 +11,69 @@
 {
 
 
-    public function __construct()
-    {
-        $this->interface = 'EE_Messages_incoming_data';
-    }
+	public function __construct()
+	{
+		$this->interface = 'EE_Messages_incoming_data';
+	}
 
 
-    /**
-     * This adds the EE_Messages_incoming_data data handler object to the collection.
-     *
-     * @param EE_Messages_incoming_data  $data_handler
-     * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
-     *                                                   classname to create an alternative index for retrieving data_handlers.
-     * @return bool
-     */
-    public function add($data_handler, $data = null)
-    {
-        $data = $data === null ? array() : (array) $data;
-        $info['key'] = $this->get_key(get_class($data_handler), $data);
-        return parent::add($data_handler, $info);
-    }
+	/**
+	 * This adds the EE_Messages_incoming_data data handler object to the collection.
+	 *
+	 * @param EE_Messages_incoming_data  $data_handler
+	 * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
+	 *                                                   classname to create an alternative index for retrieving data_handlers.
+	 * @return bool
+	 */
+	public function add($data_handler, $data = null)
+	{
+		$data = $data === null ? array() : (array) $data;
+		$info['key'] = $this->get_key(get_class($data_handler), $data);
+		return parent::add($data_handler, $info);
+	}
     
 
 
 
 
-    /**
-     * This returns a key for retrieving data for the given references used to generate the key.
-     * Data handlers are cached to the repository along with a md5() generated key using known references.
-     * @param string    $classname      The classname of the datahandler being checked for.
-     * @param mixed     $data           The data that was used to instantiate the data_handler.
-     *
-     * @return  string      md5 hash using provided info.
-     */
-    public function get_key($classname, $data)
-    {
-        return md5($classname . serialize($data));
-    }
+	/**
+	 * This returns a key for retrieving data for the given references used to generate the key.
+	 * Data handlers are cached to the repository along with a md5() generated key using known references.
+	 * @param string    $classname      The classname of the datahandler being checked for.
+	 * @param mixed     $data           The data that was used to instantiate the data_handler.
+	 *
+	 * @return  string      md5 hash using provided info.
+	 */
+	public function get_key($classname, $data)
+	{
+		return md5($classname . serialize($data));
+	}
 
 
 
 
 
 
-    /**
-     * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
-     *
-     * @return null|EE_Messages_incoming_data
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                $handler = $this->current();
-                $this->rewind();
-                return $handler;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
+	 *
+	 * @return null|EE_Messages_incoming_data
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				$handler = $this->current();
+				$this->rewind();
+				return $handler;
+			}
+			$this->next();
+		}
+		return null;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      */
     public function get_key($classname, $data)
     {
-        return md5($classname . serialize($data));
+        return md5($classname.serialize($data));
     }
 
 

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Indentation +1113 added lines, -1113 removed lines

@@ -12,1117 +12,1117 @@
 class EE_Message_Resource_Manager
 {
 
-    /**
-     * This option in the database is used to keep a record of message types that have been activated for a messenger
-     * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
-     * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
-     * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
-     * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
-     * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
-     * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
-     * automated process (when an add-on registering the message type deactivates, or when some other code calls the
-     * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
-     * the "force" flag is respected if that message type is later re-registered.
-     *
-     * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
-     *
-     * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
-     * option that got superseded by later behaviour requirements.
-     */
-    const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
-
-    /**
-     * @type boolean $_initialized
-     */
-    protected $_initialized = false;
-
-    /**
-     * @type EE_Messenger_Collection $_messenger_collection_loader
-     */
-    protected $_messenger_collection_loader;
-
-    /**
-     * @type EE_Message_Type_Collection $_message_type_collection_loader
-     */
-    protected $_message_type_collection_loader;
-
-    /**
-     * @type EEM_Message_Template_Group $_message_template_group_model
-     */
-    protected $_message_template_group_model;
-
-    /**
-     * @type EE_messenger[]
-     */
-    protected $_installed_messengers = array();
-
-    /**
-     * @type EE_message_type[]
-     */
-    protected $_installed_message_types = array();
-
-    /**
-     * Array of active messengers.
-     * Format is this:
-     * array(
-     *      'messenger_name' => EE_messenger
-     * )
-     *
-     * @type EE_messenger[]
-     */
-    protected $_active_messengers = array();
-
-    /**
-     * Formatted array of active message types grouped per messenger.
-     * Format is this:
-     * array(
-     *      'messenger_name' => array(
-     *          'settings' => array(
-     *              '{messenger_name}-message_types' => array(
-     *                  'message_type_name' => array() //variable array of settings corresponding to message type.
-     *              )
-     *          )
-     *      )
-     * )
-     *
-     * @type array
-     */
-    protected $_active_message_types = array();
-
-
-    /**
-     * This holds the array of messengers and their corresponding message types that have
-     * been activated on a site at some point.  This is an important record that helps the messages system
-     * not accidentally reactivate something that was intentionally deactivated by a user.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @type array
-     */
-    protected $_has_activated_messengers_and_message_types = array();
-
-    /**
-     * An array of unique message type contexts across all active message types.
-     * The array will be indexed by either 'slugs' or 'all'.
-     * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
-     * slug. array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * The all index returns an array in this format:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     *
-     * @type array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * EE_Message_Resource_Manager constructor.
-     *
-     * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
-     * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
-     * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
-     */
-    public function __construct(
-        EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
-        EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
-        EEM_Message_Template_Group $Message_Template_Group_Model
-    ) {
-        $this->_messenger_collection_loader    = $Messenger_Collection_Loader;
-        $this->_message_type_collection_loader = $Message_Type_Collection_Loader;
-        $this->_message_template_group_model   = $Message_Template_Group_Model;
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _initialize_collections()
-    {
-        if ($this->_initialized) {
-            return;
-        }
-        $this->_initialized = true;
-        $this->_messenger_collection_loader->load_messengers_from_folder();
-        $this->_message_type_collection_loader->load_message_types_from_folder();
-        $this->get_has_activated_messengers_option(true);
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * @return EE_Messenger_Collection
-     */
-    public function messenger_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_messenger_collection_loader->messenger_collection();
-    }
-
-
-    /**
-     * @return EE_messenger[]
-     */
-    public function active_messengers()
-    {
-        $this->_initialize_collections();
-        return $this->_active_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     */
-    public function get_messenger($messenger_name)
-    {
-        return $this->messenger_collection()->get_by_info($messenger_name);
-    }
-
-
-    /**
-     * This returns the corresponding EE_messenger object for the given string if it is active.
-     *
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_active_messenger($messenger)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
-    }
-
-
-    /**
-     * @return \EE_messenger[]
-     */
-    public function installed_messengers()
-    {
-        if (empty($this->_installed_messengers)) {
-            $this->_installed_messengers = array();
-            $this->messenger_collection()->rewind();
-            while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
-                $this->messenger_collection()->next();
-            }
-        }
-        return $this->_installed_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     * @throws \EE_Error
-     */
-    public function valid_messenger($messenger_name)
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            return $messenger;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
-                $messenger_name
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Message_Type_Collection
-     */
-    public function message_type_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_message_type_collection_loader->message_type_collection();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function active_message_types()
-    {
-        $this->_initialize_collections();
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     */
-    public function get_message_type($message_type_name)
-    {
-        return $this->message_type_collection()->get_by_info($message_type_name);
-    }
-
-
-    /**
-     * This returns the EE_message_type from the active message types array ( if present );
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return \EE_message_type|null
-     */
-    public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-            ? $this->get_message_type($message_type_name)
-            : null;
-    }
-
-
-    /**
-     * Returns whether the given message type is active for the given messenger.
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
-    }
-
-
-    /**
-     * Returns whether the given messenger is active.
-     *
-     * @param string $messenger_name the name of the messenger to check if active.
-     * @return bool
-     */
-    public function is_messenger_active($messenger_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]);
-    }
-
-
-    /**
-     * This returns any settings that might be on a message type for a messenger
-     *
-     * @param string $messenger_name    The slug of the messenger
-     * @param string $message_type_name The slug of the message type getting the settings for.
-     * @return array
-     */
-    public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
-    {
-        $settings = array();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
-                ? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
-                : array();
-        }
-        return $settings;
-    }
-
-
-    /**
-     * Returns whether the given messenger name has active message types on it.
-     * Infers whether the messenger is active or not as well.
-     *
-     * @param string $messenger_name
-     * @return bool
-     */
-    public function messenger_has_active_message_types($messenger_name)
-    {
-        $this->_initialize_collections();
-        return
-            ! empty($this->_active_message_types[ $messenger_name ])
-            && ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
-    }
-
-
-    /**
-     * This checks the _active_message_types property for any active message types
-     * that are present for the given messenger and returns them.
-     *
-     * @since 4.9.0
-     * @param string $messenger_name The messenger being checked
-     * @return EE_message_type[]|array    (empty array if no active_message_types)
-     */
-    public function get_active_message_types_for_messenger($messenger_name)
-    {
-        $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
-            return $message_types;
-        }
-        $installed_message_types = $this->installed_message_types();
-        foreach ($installed_message_types as $message_type_name => $message_type) {
-            if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[ $message_type_name ] = $message_type;
-            }
-        }
-        return $message_types;
-    }
-
-
-    /**
-     * This does NOT return the _active_message_types property but
-     * simply returns an array of active message type names from that property.
-     * (The _active_message_types property is indexed by messenger and active message_types per messenger).
-     *
-     * @return array message_type references (string)
-     */
-    public function list_of_active_message_types()
-    {
-        $active_message_type_names = array();
-        $this->_initialize_collections();
-        foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
-                continue;
-            }
-            foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
-                    $active_message_type_names[] = $message_type_name;
-                }
-            }
-        }
-        return $active_message_type_names;
-    }
-
-
-    /**
-     * Same as list_of_active_message_types() except this returns actual EE_message_type objects
-     *
-     * @since 4.9.0
-     * @return \EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        $active_message_types      = array();
-        $installed_message_types   = $this->installed_message_types();
-        $active_message_type_names = $this->list_of_active_message_types();
-        foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[ $active_message_type_name ])) {
-                $active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
-            }
-        }
-        return $active_message_types;
-    }
-
-
-    /**
-     * @return \EE_message_type[]
-     */
-    public function installed_message_types()
-    {
-        if (empty($this->_installed_message_types)) {
-            $this->message_type_collection()->rewind();
-            while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
-                $this->message_type_collection()->next();
-            }
-        }
-        return $this->_installed_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     * @throws \EE_Error
-     */
-    public function valid_message_type($message_type_name)
-    {
-        $message_type = $this->get_message_type($message_type_name);
-        if ($message_type instanceof EE_message_type) {
-            return $message_type;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
-                $message_type_name
-            )
-        );
-    }
-
-
-    /**
-     * valid_message_type_for_messenger
-     *
-     * @param EE_messenger $messenger
-     * @param string       $message_type_name
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
-    {
-        $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
-                        'event_espresso'
-                    ),
-                    $message_type_name,
-                    __METHOD__,
-                    $messenger->name
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
-     *                          property and pull directly from the db.  Otherwise whatever is currently on the
-     *                          $_active_message_types property is pulled.
-     * @return array
-     */
-    public function get_active_messengers_option($reset = false)
-    {
-        if ($reset) {
-            $this->_active_message_types = get_option('ee_active_messengers', array());
-        }
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
-     *                                         representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_active_messengers_option($active_messenger_settings = array())
-    {
-        $active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
-        // make sure _active_message_types is updated (this is the internal cache for the settings).
-        $this->_active_message_types = $active_messenger_settings;
-        return update_option('ee_active_messengers', $active_messenger_settings);
-    }
-
-
-    /**
-     * Used to return has activated message types for messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param   bool $reset Used to indicate that any cached value should be ignored.
-     * @return array
-     */
-    public function get_has_activated_messengers_option($reset = false)
-    {
-        if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
-            $this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
-        }
-        return $this->_has_activated_messengers_and_message_types;
-    }
-
-
-    /**
-     * Used to update the has activated option in the db.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
-     *                                        representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_has_activated_messengers_option($has_activated_messengers = array())
-    {
-        // make sure the option has been retrieved from first so we don't overwrite it accidentally.
-        if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-        $has_activated_messengers = empty($has_activated_messengers)
-            ? $this->_has_activated_messengers_and_message_types
-            : $has_activated_messengers;
-        return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
-    }
-
-
-    /**
-     * wrapper for _set_active_messengers_and_message_types()
-     */
-    public function reset_active_messengers_and_message_types()
-    {
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * Generate list of active messengers and message types from collection.
-     * This sets up the active messengers from what is present in the database.
-     */
-    protected function _set_active_messengers_and_message_types()
-    {
-        // echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
-        // list of activated messengers as set via the admin
-        // note calling `get_active_messengers_options` also initializes the _active_message_types property.
-        $this->get_active_messengers_option(true);
-        $this->ensure_messengers_are_active(array(), false, true);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Ensures that the specified messenger is currently active.
-     * If not, activates it and its default message types.
-     *
-     * @param string $messenger_name
-     * @param bool   $update_option Whether to update the option in the db or not.
-     * @return boolean true if either already active or successfully activated.
-     */
-    public function ensure_messenger_is_active($messenger_name, $update_option = true)
-    {
-        if (! isset($this->_active_messengers[ $messenger_name ])) {
-            try {
-                $this->activate_messenger($messenger_name, array(), $update_option);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This ensures the given array of messenger names is active in the system.
-     * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
-     * it will automatically activate the default message types for the messenger if its not active.
-     *
-     * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
-     *                                (default) then will attempt to set the active messengers from the
-     *                                activated_messengers option
-     *                                (stored in $_active_message_types property).
-     * @param bool  $update_option    Whether to update the related active messengers option.
-     * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
-     *                                set to true and a messenger is indicated as active, but is NOT installed, then it
-     *                                will automatically be deactivated.
-     */
-    public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
-    {
-        $messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
-
-        $not_installed = array();
-        foreach ($messenger_names as $messenger_name) {
-            if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
-                $not_installed[] = $messenger_name;
-                $this->deactivate_messenger($messenger_name);
-                continue;
-            }
-            $this->ensure_messenger_is_active($messenger_name, $update_option);
-        }
-
-        if (! empty($not_installed)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
-                    '<br />',
-                    implode(', ', $not_installed)
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * Ensures that the specified message type for the given messenger is currently active, if not activates it.
-     * This ALSO ensures that the given messenger is active as well!
-     *
-     * @param string $message_type_name message type name.
-     * @param        $messenger_name
-     * @param bool   $update_option     Whether to update the option in the db or not.
-     * @return bool  Returns true if already is active or if was activated successfully.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
-    {
-        // grab the messenger to work with.
-        $messenger = $this->valid_messenger($messenger_name);
-        if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
-            // ensure messenger is active (that's an inherent coupling between active message types and the
-            // messenger they are being activated for.
-            try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                    // all is good so let's just get it active
-                    $this->activate_messenger($messenger_name, array($message_type_name), $update_option);
-                }
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
-     * messenger are active in one go.
-     *
-     * @param array  $message_type_names Array of message type names to ensure are active.
-     * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
-     * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
-     */
-    public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
-    {
-        $message_type_names = (array) $message_type_names;
-        foreach ($message_type_names as $message_type_name) {
-            // note, intentionally not updating option here because we're in a loop.
-            // We'll follow the instructions of the incoming $update_option argument after the loop.
-            $this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
-        }
-        if ($update_option) {
-            $this->update_active_messengers_option();
-            $this->update_has_activated_messengers_option();
-        }
-    }
-
-
-    /**
-     * Activates the specified messenger.
-     *
-     * @param string $messenger_name
-     * @param array  $message_type_names        An array of message type names to activate with this messenger.
-     *                                          If included we do NOT setup the default message types
-     *                                          (assuming they are already setup.)
-     * @param bool   $update_active_messengers_option
-     * @return array of generated templates
-     * @throws \EE_Error
-     */
-    public function activate_messenger(
-        $messenger_name,
-        $message_type_names = array(),
-        $update_active_messengers_option = true
-    ) {
-        $templates = array();
-        // grab the messenger to work with.
-        $messenger = $this->messenger_collection()->get_by_info($messenger_name);
-        // it's inactive. Activate it.
-        if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[ $messenger->name ] = $messenger;
-            // activate incoming message types set to be activated with messenger.
-            $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
-            // setup any initial settings for the messenger if necessary.
-            $this->add_settings_for_messenger($messenger->name);
-            if ($update_active_messengers_option) {
-                $this->update_active_messengers_option();
-                $this->update_has_activated_messengers_option();
-            }
-            // generate new templates if necessary and ensure all related templates that are already in the database are
-            // marked active.  Note, this will also deactivate a message type for a messenger if the template
-            // cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
-                $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
-                EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Activates given message types for the given EE_messenger object.
-     * Note: (very important) This method does not persist the activation to the database.
-     * See code implementing this method in this class for examples of how to persist.
-     *
-     * @param \EE_messenger $messenger
-     * @param  array        $message_type_names
-     * @return array
-     */
-    protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
-    {
-        // If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
-        // things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
-        // So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
-        // only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
-            ? $messenger->get_default_message_types()
-            : (array) $message_type_names;
-
-        // now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[ $messenger->name ])) {
-            $this->_active_message_types[ $messenger->name ]['settings'] = array();
-        }
-
-        if ($message_type_names) {
-            // cycle thru message types
-            foreach ($message_type_names as $message_type_name) {
-                // only register the message type as active IF it isn't already active
-                // and if its actually installed.
-                if (! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
-                ) {
-                    $this->add_settings_for_message_type($messenger->name, $message_type_name);
-                    $this->_set_messenger_has_activated_message_type(
-                        $messenger,
-                        $message_type_name
-                    );
-                }
-            }
-        }
-        return $message_type_names;
-    }
-
-
-    /**
-     * add_settings_for_message_type
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param  string $messenger_name    The name of the messenger adding the settings for
-     * @param  string $message_type_name The name of the message type adding the settings for
-     * @param  array  $new_settings      Any new settings being set for the message type and messenger
-     */
-    public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
-    {
-        // get installed message type from collection
-        $message_type      = $this->message_type_collection()->get_by_info($message_type_name);
-        $existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
-        // we need to setup any initial settings for message types
-        if ($message_type instanceof EE_message_type) {
-            $default_settings = $message_type->get_admin_settings_fields();
-            foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[ $field ])) {
-                    $existing_settings[ $field ] = $new_settings[ $field ];
-                    continue;
-                }
-                if (! isset($existing_settings[ $field ])) {
-                    $existing_settings[ $field ] = $values['default'];
-                }
-            }
-        }
-        $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
-    }
-
-
-    /**
-     * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
-     * and message type.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @access protected
-     * @param \EE_messenger $messenger
-     * @param string        $message_type_name
-     */
-    protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
-    {
-
-        // if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
-        if (empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-
-        // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
-        }
-        // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
-        }
-    }
-
-
-    /**
-     * add_settings_for_messenger
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param string $messenger_name The name of the messenger the settings is being added for.
-     * @param array  $new_settings   An array of settings to update the existing settings.
-     */
-    public function add_settings_for_messenger($messenger_name, $new_settings = array())
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
-                foreach ($msgr_settings as $field => $value) {
-                    // is there a new setting for this?
-                    if (isset($new_settings[ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
-                        continue;
-                    }
-                    // only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * deactivate_messenger
-     *
-     * @param  string|EE_messenger $messenger_name name of messenger
-     * @return void
-     */
-    public function deactivate_messenger($messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($messenger_name instanceof EE_messenger) {
-            $messenger_name = $messenger_name->name;
-        }
-        unset($this->_active_messengers[ $messenger_name ]);
-        unset($this->_active_message_types[ $messenger_name ]);
-        $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type (note this will deactivate across all messenger's it is active on.
-     *
-     * @param  string $message_type_name     name of message type being deactivated
-     * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
-     *                                       type.  However, this can be overridden if we don't want this set (usually when
-     *                                       this is called as a part of deregistration of a custom message type)
-     */
-    public function deactivate_message_type($message_type_name, $set_has_active_record = true)
-    {
-        $this->_initialize_collections();
-        if ($message_type_name instanceof EE_message_type) {
-            $message_type_name = $message_type_name->name;
-        }
-        foreach ($this->_active_message_types as $messenger_name => $settings) {
-            unset(
-                $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
-            );
-
-            // we always record (even on deactivation) that a message type has been activated because there should at
-            // least be a record in the "has_activated" option that it WAS active at one point.
-            if ($set_has_active_record) {
-                $messenger = $this->get_messenger($messenger_name);
-                $this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
-            }
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type for a specific messenger as opposed to all messengers.
-     *
-     * @param string $message_type_name Name of message type being deactivated.
-     * @param string $messenger_name    Name of messenger the message type is being deactivated for.
-     */
-    public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for(
-            array($messenger_name),
-            array($message_type_name)
-        );
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Used to verify if a message can be sent for the given messenger and message type
-     * and that it is a generating messenger (used for generating message templates).
-     *
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // get the $messengers the message type says it can be used with.
-        foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
-            if ($messenger->name === $generating_messenger
-                && $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns all the contexts that are registered by all message types.
-     * If $slugs_only is true,
-     * then just an array indexed by unique context slugs with the latest label representation for that slug.
-     * array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * If $slugs_only is false, then the format is:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     * Keep in mind that although different message types may share the same context slugs,
-     * it is possible that the context is described differently by the message type.
-     *
-     * @since 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
-     *                           or all contexts indexed by message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        $key = $slugs_only ? 'slugs' : 'all';
-        // check if contexts has been setup yet.
-        if (empty($this->_contexts[ $key ])) {
-            // So let's get all active message type objects and loop through to get all unique contexts
-            foreach ($this->get_active_message_type_objects() as $message_type) {
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    if ($slugs_only) {
-                        foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[ $key ][ $context ] = $context_details['label'];
-                        }
-                    } else {
-                        $this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
-                    }
-                }
-            }
-        }
-        return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
-    }
-
-
-    /**
-     * This checks the internal record of what message types are considered "active" and verifies that
-     * there is an installed class definition for that message type.  If the active message type does not have a
-     * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
-     * any related message templates will be inactivated as well.
-     *
-     * @return bool   true means all active message types are valid, false means at least one message type was
-     *                deactivated.
-     */
-    public function validate_active_message_types_are_installed()
-    {
-        $list_of_active_message_type_names = $this->list_of_active_message_types();
-        $installed_message_types           = $this->installed_message_types();
-        $all_message_types_valid           = true;
-        // loop through list of active message types and verify they are installed.
-        foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[ $message_type_name ])) {
-                $this->remove_message_type_has_been_activated_from_all_messengers(
-                    $message_type_name,
-                    true
-                );
-                $this->deactivate_message_type($message_type_name, false);
-                $all_message_types_valid = false;
-            }
-        }
-        return $all_message_types_valid;
-    }
-
-
-    /**
-     * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
-     * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
-     * to attempt automatically reactivating message types that should be activated by default or not.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param $message_type_name
-     * @param $messenger_name
-     * @return bool
-     */
-    public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
-    {
-        $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[ $messenger_name ])
-               && in_array($message_type_name, $has_activated[ $messenger_name ]);
-    }
-
-
-    /**
-     * This method unsets a message type from the given messenger has activated option.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param string $message_type_name
-     * @param string $messenger_name
-     * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                        If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_for_messenger(
-        $message_type_name,
-        $messenger_name,
-        $consider_current_state = false
-    ) {
-        if ($consider_current_state
-            && ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-        ) {
-            // when consider current state is true, this means we don't want to change anything on the "has_activated"
-            // record if the message type is currently active for this messenger.  This is used when we want to retain
-            // the record for user initiated inactivations of the message type.
-            return;
-        }
-        $has_activated = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[ $messenger_name ])
-            ? array_search($message_type_name, $has_activated[ $messenger_name ], true)
-            : false;
-        if ($key_for_message_type !== false) {
-            unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
-            $this->update_has_activated_messengers_option($has_activated);
-            // reset the internal cached property
-            $this->get_has_activated_messengers_option(true);
-        }
-    }
-
-
-    /**
-     * Removes a message type active record from all messengers it is attached to.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param      $message_type_name
-     * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                      If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_from_all_messengers(
-        $message_type_name,
-        $consider_current_state = false
-    ) {
-        foreach (array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
-            $this->remove_message_type_has_been_activated_for_messenger(
-                $message_type_name,
-                $messenger_name,
-                $consider_current_state
-            );
-        }
-    }
+	/**
+	 * This option in the database is used to keep a record of message types that have been activated for a messenger
+	 * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
+	 * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
+	 * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
+	 * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
+	 * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
+	 * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
+	 * automated process (when an add-on registering the message type deactivates, or when some other code calls the
+	 * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
+	 * the "force" flag is respected if that message type is later re-registered.
+	 *
+	 * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
+	 *
+	 * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
+	 * option that got superseded by later behaviour requirements.
+	 */
+	const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
+
+	/**
+	 * @type boolean $_initialized
+	 */
+	protected $_initialized = false;
+
+	/**
+	 * @type EE_Messenger_Collection $_messenger_collection_loader
+	 */
+	protected $_messenger_collection_loader;
+
+	/**
+	 * @type EE_Message_Type_Collection $_message_type_collection_loader
+	 */
+	protected $_message_type_collection_loader;
+
+	/**
+	 * @type EEM_Message_Template_Group $_message_template_group_model
+	 */
+	protected $_message_template_group_model;
+
+	/**
+	 * @type EE_messenger[]
+	 */
+	protected $_installed_messengers = array();
+
+	/**
+	 * @type EE_message_type[]
+	 */
+	protected $_installed_message_types = array();
+
+	/**
+	 * Array of active messengers.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => EE_messenger
+	 * )
+	 *
+	 * @type EE_messenger[]
+	 */
+	protected $_active_messengers = array();
+
+	/**
+	 * Formatted array of active message types grouped per messenger.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => array(
+	 *          'settings' => array(
+	 *              '{messenger_name}-message_types' => array(
+	 *                  'message_type_name' => array() //variable array of settings corresponding to message type.
+	 *              )
+	 *          )
+	 *      )
+	 * )
+	 *
+	 * @type array
+	 */
+	protected $_active_message_types = array();
+
+
+	/**
+	 * This holds the array of messengers and their corresponding message types that have
+	 * been activated on a site at some point.  This is an important record that helps the messages system
+	 * not accidentally reactivate something that was intentionally deactivated by a user.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @type array
+	 */
+	protected $_has_activated_messengers_and_message_types = array();
+
+	/**
+	 * An array of unique message type contexts across all active message types.
+	 * The array will be indexed by either 'slugs' or 'all'.
+	 * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
+	 * slug. array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * The all index returns an array in this format:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 *
+	 * @type array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * EE_Message_Resource_Manager constructor.
+	 *
+	 * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
+	 * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
+	 * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
+	 */
+	public function __construct(
+		EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
+		EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
+		EEM_Message_Template_Group $Message_Template_Group_Model
+	) {
+		$this->_messenger_collection_loader    = $Messenger_Collection_Loader;
+		$this->_message_type_collection_loader = $Message_Type_Collection_Loader;
+		$this->_message_template_group_model   = $Message_Template_Group_Model;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _initialize_collections()
+	{
+		if ($this->_initialized) {
+			return;
+		}
+		$this->_initialized = true;
+		$this->_messenger_collection_loader->load_messengers_from_folder();
+		$this->_message_type_collection_loader->load_message_types_from_folder();
+		$this->get_has_activated_messengers_option(true);
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * @return EE_Messenger_Collection
+	 */
+	public function messenger_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_messenger_collection_loader->messenger_collection();
+	}
+
+
+	/**
+	 * @return EE_messenger[]
+	 */
+	public function active_messengers()
+	{
+		$this->_initialize_collections();
+		return $this->_active_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 */
+	public function get_messenger($messenger_name)
+	{
+		return $this->messenger_collection()->get_by_info($messenger_name);
+	}
+
+
+	/**
+	 * This returns the corresponding EE_messenger object for the given string if it is active.
+	 *
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_active_messenger($messenger)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
+	}
+
+
+	/**
+	 * @return \EE_messenger[]
+	 */
+	public function installed_messengers()
+	{
+		if (empty($this->_installed_messengers)) {
+			$this->_installed_messengers = array();
+			$this->messenger_collection()->rewind();
+			while ($this->messenger_collection()->valid()) {
+				$this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
+				$this->messenger_collection()->next();
+			}
+		}
+		return $this->_installed_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($messenger_name)
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			return $messenger;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
+				$messenger_name
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Message_Type_Collection
+	 */
+	public function message_type_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_message_type_collection_loader->message_type_collection();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function active_message_types()
+	{
+		$this->_initialize_collections();
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 */
+	public function get_message_type($message_type_name)
+	{
+		return $this->message_type_collection()->get_by_info($message_type_name);
+	}
+
+
+	/**
+	 * This returns the EE_message_type from the active message types array ( if present );
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return \EE_message_type|null
+	 */
+	public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+			? $this->get_message_type($message_type_name)
+			: null;
+	}
+
+
+	/**
+	 * Returns whether the given message type is active for the given messenger.
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+	}
+
+
+	/**
+	 * Returns whether the given messenger is active.
+	 *
+	 * @param string $messenger_name the name of the messenger to check if active.
+	 * @return bool
+	 */
+	public function is_messenger_active($messenger_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[ $messenger_name ]);
+	}
+
+
+	/**
+	 * This returns any settings that might be on a message type for a messenger
+	 *
+	 * @param string $messenger_name    The slug of the messenger
+	 * @param string $message_type_name The slug of the message type getting the settings for.
+	 * @return array
+	 */
+	public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
+	{
+		$settings = array();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			$settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
+				? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
+				: array();
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * Returns whether the given messenger name has active message types on it.
+	 * Infers whether the messenger is active or not as well.
+	 *
+	 * @param string $messenger_name
+	 * @return bool
+	 */
+	public function messenger_has_active_message_types($messenger_name)
+	{
+		$this->_initialize_collections();
+		return
+			! empty($this->_active_message_types[ $messenger_name ])
+			&& ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
+	}
+
+
+	/**
+	 * This checks the _active_message_types property for any active message types
+	 * that are present for the given messenger and returns them.
+	 *
+	 * @since 4.9.0
+	 * @param string $messenger_name The messenger being checked
+	 * @return EE_message_type[]|array    (empty array if no active_message_types)
+	 */
+	public function get_active_message_types_for_messenger($messenger_name)
+	{
+		$message_types = array();
+		if (! $this->messenger_has_active_message_types($messenger_name)) {
+			return $message_types;
+		}
+		$installed_message_types = $this->installed_message_types();
+		foreach ($installed_message_types as $message_type_name => $message_type) {
+			if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+				$message_types[ $message_type_name ] = $message_type;
+			}
+		}
+		return $message_types;
+	}
+
+
+	/**
+	 * This does NOT return the _active_message_types property but
+	 * simply returns an array of active message type names from that property.
+	 * (The _active_message_types property is indexed by messenger and active message_types per messenger).
+	 *
+	 * @return array message_type references (string)
+	 */
+	public function list_of_active_message_types()
+	{
+		$active_message_type_names = array();
+		$this->_initialize_collections();
+		foreach ($this->_active_message_types as $messenger => $messenger_settings) {
+			if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
+				continue;
+			}
+			foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
+				if (! in_array($message_type_name, $active_message_type_names)) {
+					$active_message_type_names[] = $message_type_name;
+				}
+			}
+		}
+		return $active_message_type_names;
+	}
+
+
+	/**
+	 * Same as list_of_active_message_types() except this returns actual EE_message_type objects
+	 *
+	 * @since 4.9.0
+	 * @return \EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		$active_message_types      = array();
+		$installed_message_types   = $this->installed_message_types();
+		$active_message_type_names = $this->list_of_active_message_types();
+		foreach ($active_message_type_names as $active_message_type_name) {
+			if (isset($installed_message_types[ $active_message_type_name ])) {
+				$active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
+			}
+		}
+		return $active_message_types;
+	}
+
+
+	/**
+	 * @return \EE_message_type[]
+	 */
+	public function installed_message_types()
+	{
+		if (empty($this->_installed_message_types)) {
+			$this->message_type_collection()->rewind();
+			while ($this->message_type_collection()->valid()) {
+				$this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
+				$this->message_type_collection()->next();
+			}
+		}
+		return $this->_installed_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($message_type_name)
+	{
+		$message_type = $this->get_message_type($message_type_name);
+		if ($message_type instanceof EE_message_type) {
+			return $message_type;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
+				$message_type_name
+			)
+		);
+	}
+
+
+	/**
+	 * valid_message_type_for_messenger
+	 *
+	 * @param EE_messenger $messenger
+	 * @param string       $message_type_name
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
+	{
+		$valid_message_types = $messenger->get_valid_message_types();
+		if (! in_array($message_type_name, $valid_message_types)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
+						'event_espresso'
+					),
+					$message_type_name,
+					__METHOD__,
+					$messenger->name
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
+	 *                          property and pull directly from the db.  Otherwise whatever is currently on the
+	 *                          $_active_message_types property is pulled.
+	 * @return array
+	 */
+	public function get_active_messengers_option($reset = false)
+	{
+		if ($reset) {
+			$this->_active_message_types = get_option('ee_active_messengers', array());
+		}
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
+	 *                                         representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_active_messengers_option($active_messenger_settings = array())
+	{
+		$active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
+		// make sure _active_message_types is updated (this is the internal cache for the settings).
+		$this->_active_message_types = $active_messenger_settings;
+		return update_option('ee_active_messengers', $active_messenger_settings);
+	}
+
+
+	/**
+	 * Used to return has activated message types for messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param   bool $reset Used to indicate that any cached value should be ignored.
+	 * @return array
+	 */
+	public function get_has_activated_messengers_option($reset = false)
+	{
+		if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
+			$this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
+		}
+		return $this->_has_activated_messengers_and_message_types;
+	}
+
+
+	/**
+	 * Used to update the has activated option in the db.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
+	 *                                        representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_has_activated_messengers_option($has_activated_messengers = array())
+	{
+		// make sure the option has been retrieved from first so we don't overwrite it accidentally.
+		if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+		$has_activated_messengers = empty($has_activated_messengers)
+			? $this->_has_activated_messengers_and_message_types
+			: $has_activated_messengers;
+		return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
+	}
+
+
+	/**
+	 * wrapper for _set_active_messengers_and_message_types()
+	 */
+	public function reset_active_messengers_and_message_types()
+	{
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * Generate list of active messengers and message types from collection.
+	 * This sets up the active messengers from what is present in the database.
+	 */
+	protected function _set_active_messengers_and_message_types()
+	{
+		// echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
+		// list of activated messengers as set via the admin
+		// note calling `get_active_messengers_options` also initializes the _active_message_types property.
+		$this->get_active_messengers_option(true);
+		$this->ensure_messengers_are_active(array(), false, true);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Ensures that the specified messenger is currently active.
+	 * If not, activates it and its default message types.
+	 *
+	 * @param string $messenger_name
+	 * @param bool   $update_option Whether to update the option in the db or not.
+	 * @return boolean true if either already active or successfully activated.
+	 */
+	public function ensure_messenger_is_active($messenger_name, $update_option = true)
+	{
+		if (! isset($this->_active_messengers[ $messenger_name ])) {
+			try {
+				$this->activate_messenger($messenger_name, array(), $update_option);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This ensures the given array of messenger names is active in the system.
+	 * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
+	 * it will automatically activate the default message types for the messenger if its not active.
+	 *
+	 * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
+	 *                                (default) then will attempt to set the active messengers from the
+	 *                                activated_messengers option
+	 *                                (stored in $_active_message_types property).
+	 * @param bool  $update_option    Whether to update the related active messengers option.
+	 * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
+	 *                                set to true and a messenger is indicated as active, but is NOT installed, then it
+	 *                                will automatically be deactivated.
+	 */
+	public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
+	{
+		$messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
+
+		$not_installed = array();
+		foreach ($messenger_names as $messenger_name) {
+			if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
+				$not_installed[] = $messenger_name;
+				$this->deactivate_messenger($messenger_name);
+				continue;
+			}
+			$this->ensure_messenger_is_active($messenger_name, $update_option);
+		}
+
+		if (! empty($not_installed)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
+					'<br />',
+					implode(', ', $not_installed)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * Ensures that the specified message type for the given messenger is currently active, if not activates it.
+	 * This ALSO ensures that the given messenger is active as well!
+	 *
+	 * @param string $message_type_name message type name.
+	 * @param        $messenger_name
+	 * @param bool   $update_option     Whether to update the option in the db or not.
+	 * @return bool  Returns true if already is active or if was activated successfully.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
+	{
+		// grab the messenger to work with.
+		$messenger = $this->valid_messenger($messenger_name);
+		if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
+			// ensure messenger is active (that's an inherent coupling between active message types and the
+			// messenger they are being activated for.
+			try {
+				if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+					// all is good so let's just get it active
+					$this->activate_messenger($messenger_name, array($message_type_name), $update_option);
+				}
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
+	 * messenger are active in one go.
+	 *
+	 * @param array  $message_type_names Array of message type names to ensure are active.
+	 * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
+	 * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
+	 */
+	public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
+	{
+		$message_type_names = (array) $message_type_names;
+		foreach ($message_type_names as $message_type_name) {
+			// note, intentionally not updating option here because we're in a loop.
+			// We'll follow the instructions of the incoming $update_option argument after the loop.
+			$this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
+		}
+		if ($update_option) {
+			$this->update_active_messengers_option();
+			$this->update_has_activated_messengers_option();
+		}
+	}
+
+
+	/**
+	 * Activates the specified messenger.
+	 *
+	 * @param string $messenger_name
+	 * @param array  $message_type_names        An array of message type names to activate with this messenger.
+	 *                                          If included we do NOT setup the default message types
+	 *                                          (assuming they are already setup.)
+	 * @param bool   $update_active_messengers_option
+	 * @return array of generated templates
+	 * @throws \EE_Error
+	 */
+	public function activate_messenger(
+		$messenger_name,
+		$message_type_names = array(),
+		$update_active_messengers_option = true
+	) {
+		$templates = array();
+		// grab the messenger to work with.
+		$messenger = $this->messenger_collection()->get_by_info($messenger_name);
+		// it's inactive. Activate it.
+		if ($messenger instanceof EE_messenger) {
+			$this->_active_messengers[ $messenger->name ] = $messenger;
+			// activate incoming message types set to be activated with messenger.
+			$message_type_names = $this->_activate_message_types($messenger, $message_type_names);
+			// setup any initial settings for the messenger if necessary.
+			$this->add_settings_for_messenger($messenger->name);
+			if ($update_active_messengers_option) {
+				$this->update_active_messengers_option();
+				$this->update_has_activated_messengers_option();
+			}
+			// generate new templates if necessary and ensure all related templates that are already in the database are
+			// marked active.  Note, this will also deactivate a message type for a messenger if the template
+			// cannot be successfully created during its attempt (only happens for global template attempts).
+			if (! empty($message_type_names)) {
+				$templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
+				EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Activates given message types for the given EE_messenger object.
+	 * Note: (very important) This method does not persist the activation to the database.
+	 * See code implementing this method in this class for examples of how to persist.
+	 *
+	 * @param \EE_messenger $messenger
+	 * @param  array        $message_type_names
+	 * @return array
+	 */
+	protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
+	{
+		// If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
+		// things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
+		// So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
+		// only override _active_message_types when an explicit array of $message_type_names has been provided.
+		$message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
+			? $messenger->get_default_message_types()
+			: (array) $message_type_names;
+
+		// now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
+		if (! isset($this->_active_message_types[ $messenger->name ])) {
+			$this->_active_message_types[ $messenger->name ]['settings'] = array();
+		}
+
+		if ($message_type_names) {
+			// cycle thru message types
+			foreach ($message_type_names as $message_type_name) {
+				// only register the message type as active IF it isn't already active
+				// and if its actually installed.
+				if (! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
+				) {
+					$this->add_settings_for_message_type($messenger->name, $message_type_name);
+					$this->_set_messenger_has_activated_message_type(
+						$messenger,
+						$message_type_name
+					);
+				}
+			}
+		}
+		return $message_type_names;
+	}
+
+
+	/**
+	 * add_settings_for_message_type
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param  string $messenger_name    The name of the messenger adding the settings for
+	 * @param  string $message_type_name The name of the message type adding the settings for
+	 * @param  array  $new_settings      Any new settings being set for the message type and messenger
+	 */
+	public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
+	{
+		// get installed message type from collection
+		$message_type      = $this->message_type_collection()->get_by_info($message_type_name);
+		$existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
+		// we need to setup any initial settings for message types
+		if ($message_type instanceof EE_message_type) {
+			$default_settings = $message_type->get_admin_settings_fields();
+			foreach ($default_settings as $field => $values) {
+				if (isset($new_settings[ $field ])) {
+					$existing_settings[ $field ] = $new_settings[ $field ];
+					continue;
+				}
+				if (! isset($existing_settings[ $field ])) {
+					$existing_settings[ $field ] = $values['default'];
+				}
+			}
+		}
+		$this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
+	}
+
+
+	/**
+	 * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
+	 * and message type.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @access protected
+	 * @param \EE_messenger $messenger
+	 * @param string        $message_type_name
+	 */
+	protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
+	{
+
+		// if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
+		if (empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+
+		// make sure this messenger has a record in the has_activated array
+		if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
+			$this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
+		}
+		// check if message type has already been added
+		if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
+			$this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
+		}
+	}
+
+
+	/**
+	 * add_settings_for_messenger
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param string $messenger_name The name of the messenger the settings is being added for.
+	 * @param array  $new_settings   An array of settings to update the existing settings.
+	 */
+	public function add_settings_for_messenger($messenger_name, $new_settings = array())
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			$msgr_settings = $messenger->get_admin_settings_fields();
+			if (! empty($msgr_settings)) {
+				foreach ($msgr_settings as $field => $value) {
+					// is there a new setting for this?
+					if (isset($new_settings[ $field ])) {
+						$this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
+						continue;
+					}
+					// only set the default if it isn't already set.
+					if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
+						$this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * deactivate_messenger
+	 *
+	 * @param  string|EE_messenger $messenger_name name of messenger
+	 * @return void
+	 */
+	public function deactivate_messenger($messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($messenger_name instanceof EE_messenger) {
+			$messenger_name = $messenger_name->name;
+		}
+		unset($this->_active_messengers[ $messenger_name ]);
+		unset($this->_active_message_types[ $messenger_name ]);
+		$this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type (note this will deactivate across all messenger's it is active on.
+	 *
+	 * @param  string $message_type_name     name of message type being deactivated
+	 * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
+	 *                                       type.  However, this can be overridden if we don't want this set (usually when
+	 *                                       this is called as a part of deregistration of a custom message type)
+	 */
+	public function deactivate_message_type($message_type_name, $set_has_active_record = true)
+	{
+		$this->_initialize_collections();
+		if ($message_type_name instanceof EE_message_type) {
+			$message_type_name = $message_type_name->name;
+		}
+		foreach ($this->_active_message_types as $messenger_name => $settings) {
+			unset(
+				$this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
+			);
+
+			// we always record (even on deactivation) that a message type has been activated because there should at
+			// least be a record in the "has_activated" option that it WAS active at one point.
+			if ($set_has_active_record) {
+				$messenger = $this->get_messenger($messenger_name);
+				$this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
+			}
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type for a specific messenger as opposed to all messengers.
+	 *
+	 * @param string $message_type_name Name of message type being deactivated.
+	 * @param string $messenger_name    Name of messenger the message type is being deactivated for.
+	 */
+	public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for(
+			array($messenger_name),
+			array($message_type_name)
+		);
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to verify if a message can be sent for the given messenger and message type
+	 * and that it is a generating messenger (used for generating message templates).
+	 *
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// get the $messengers the message type says it can be used with.
+		foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
+			if ($messenger->name === $generating_messenger
+				&& $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns all the contexts that are registered by all message types.
+	 * If $slugs_only is true,
+	 * then just an array indexed by unique context slugs with the latest label representation for that slug.
+	 * array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * If $slugs_only is false, then the format is:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 * Keep in mind that although different message types may share the same context slugs,
+	 * it is possible that the context is described differently by the message type.
+	 *
+	 * @since 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
+	 *                           or all contexts indexed by message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		$key = $slugs_only ? 'slugs' : 'all';
+		// check if contexts has been setup yet.
+		if (empty($this->_contexts[ $key ])) {
+			// So let's get all active message type objects and loop through to get all unique contexts
+			foreach ($this->get_active_message_type_objects() as $message_type) {
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					if ($slugs_only) {
+						foreach ($message_type_contexts as $context => $context_details) {
+							$this->_contexts[ $key ][ $context ] = $context_details['label'];
+						}
+					} else {
+						$this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
+					}
+				}
+			}
+		}
+		return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
+	}
+
+
+	/**
+	 * This checks the internal record of what message types are considered "active" and verifies that
+	 * there is an installed class definition for that message type.  If the active message type does not have a
+	 * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
+	 * any related message templates will be inactivated as well.
+	 *
+	 * @return bool   true means all active message types are valid, false means at least one message type was
+	 *                deactivated.
+	 */
+	public function validate_active_message_types_are_installed()
+	{
+		$list_of_active_message_type_names = $this->list_of_active_message_types();
+		$installed_message_types           = $this->installed_message_types();
+		$all_message_types_valid           = true;
+		// loop through list of active message types and verify they are installed.
+		foreach ($list_of_active_message_type_names as $message_type_name) {
+			if (! isset($installed_message_types[ $message_type_name ])) {
+				$this->remove_message_type_has_been_activated_from_all_messengers(
+					$message_type_name,
+					true
+				);
+				$this->deactivate_message_type($message_type_name, false);
+				$all_message_types_valid = false;
+			}
+		}
+		return $all_message_types_valid;
+	}
+
+
+	/**
+	 * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
+	 * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
+	 * to attempt automatically reactivating message types that should be activated by default or not.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param $message_type_name
+	 * @param $messenger_name
+	 * @return bool
+	 */
+	public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
+	{
+		$has_activated = $this->get_has_activated_messengers_option();
+		return isset($has_activated[ $messenger_name ])
+			   && in_array($message_type_name, $has_activated[ $messenger_name ]);
+	}
+
+
+	/**
+	 * This method unsets a message type from the given messenger has activated option.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param string $message_type_name
+	 * @param string $messenger_name
+	 * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                        If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_for_messenger(
+		$message_type_name,
+		$messenger_name,
+		$consider_current_state = false
+	) {
+		if ($consider_current_state
+			&& ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+		) {
+			// when consider current state is true, this means we don't want to change anything on the "has_activated"
+			// record if the message type is currently active for this messenger.  This is used when we want to retain
+			// the record for user initiated inactivations of the message type.
+			return;
+		}
+		$has_activated = $this->get_has_activated_messengers_option();
+		$key_for_message_type = isset($has_activated[ $messenger_name ])
+			? array_search($message_type_name, $has_activated[ $messenger_name ], true)
+			: false;
+		if ($key_for_message_type !== false) {
+			unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
+			$this->update_has_activated_messengers_option($has_activated);
+			// reset the internal cached property
+			$this->get_has_activated_messengers_option(true);
+		}
+	}
+
+
+	/**
+	 * Removes a message type active record from all messengers it is attached to.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param      $message_type_name
+	 * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                      If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_from_all_messengers(
+		$message_type_name,
+		$consider_current_state = false
+	) {
+		foreach (array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
+			$this->remove_message_type_has_been_activated_for_messenger(
+				$message_type_name,
+				$messenger_name,
+				$consider_current_state
+			);
+		}
+	}
 }

Spacing +54 added lines, -54 removed lines

@@ -196,7 +196,7 @@ 
     public function get_active_messenger($messenger)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
+        return ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : null;
     }
 
 
@@ -209,7 +209,7 @@ 
             $this->_installed_messengers = array();
             $this->messenger_collection()->rewind();
             while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
+                $this->_installed_messengers[$this->messenger_collection()->current()->name] = $this->messenger_collection()->current();
                 $this->messenger_collection()->next();
             }
         }
@@ -292,7 +292,7 @@ 
     public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
     }
 
 
@@ -305,7 +305,7 @@ 
     public function is_messenger_active($messenger_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]);
     }
 
 
@@ -320,8 +320,8 @@ 
     {
         $settings = array();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
-                ? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
+            $settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'])
+                ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings']
                 : array();
         }
         return $settings;
@@ -339,8 +339,8 @@ 
     {
         $this->_initialize_collections();
         return
-            ! empty($this->_active_message_types[ $messenger_name ])
-            && ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
+            ! empty($this->_active_message_types[$messenger_name])
+            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types']);
     }
 
 
@@ -355,13 +355,13 @@ 
     public function get_active_message_types_for_messenger($messenger_name)
     {
         $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
+        if ( ! $this->messenger_has_active_message_types($messenger_name)) {
             return $message_types;
         }
         $installed_message_types = $this->installed_message_types();
         foreach ($installed_message_types as $message_type_name => $message_type) {
             if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[ $message_type_name ] = $message_type;
+                $message_types[$message_type_name] = $message_type;
             }
         }
         return $message_types;
@@ -380,11 +380,11 @@ 
         $active_message_type_names = array();
         $this->_initialize_collections();
         foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
+            if ( ! isset($messenger_settings['settings'][$messenger.'-message_types'])) {
                 continue;
             }
-            foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
+            foreach ($messenger_settings['settings'][$messenger.'-message_types'] as $message_type_name => $message_type_config) {
+                if ( ! in_array($message_type_name, $active_message_type_names)) {
                     $active_message_type_names[] = $message_type_name;
                 }
             }
@@ -405,8 +405,8 @@ 
         $installed_message_types   = $this->installed_message_types();
         $active_message_type_names = $this->list_of_active_message_types();
         foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[ $active_message_type_name ])) {
-                $active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
+            if (isset($installed_message_types[$active_message_type_name])) {
+                $active_message_types[$active_message_type_name] = $installed_message_types[$active_message_type_name];
             }
         }
         return $active_message_types;
@@ -421,7 +421,7 @@ 
         if (empty($this->_installed_message_types)) {
             $this->message_type_collection()->rewind();
             while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
+                $this->_installed_message_types[$this->message_type_collection()->current()->name] = $this->message_type_collection()->current();
                 $this->message_type_collection()->next();
             }
         }
@@ -460,7 +460,7 @@ 
     public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
     {
         $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
+        if ( ! in_array($message_type_name, $valid_message_types)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -586,7 +586,7 @@ 
      */
     public function ensure_messenger_is_active($messenger_name, $update_option = true)
     {
-        if (! isset($this->_active_messengers[ $messenger_name ])) {
+        if ( ! isset($this->_active_messengers[$messenger_name])) {
             try {
                 $this->activate_messenger($messenger_name, array(), $update_option);
             } catch (EE_Error $e) {
@@ -631,7 +631,7 @@ 
             $this->ensure_messenger_is_active($messenger_name, $update_option);
         }
 
-        if (! empty($not_installed)) {
+        if ( ! empty($not_installed)) {
             EE_Error::add_error(
                 sprintf(
                     __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
@@ -664,7 +664,7 @@ 
             // ensure messenger is active (that's an inherent coupling between active message types and the
             // messenger they are being activated for.
             try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+                if ( ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
                     // all is good so let's just get it active
                     $this->activate_messenger($messenger_name, array($message_type_name), $update_option);
                 }
@@ -726,7 +726,7 @@ 
         $messenger = $this->messenger_collection()->get_by_info($messenger_name);
         // it's inactive. Activate it.
         if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[ $messenger->name ] = $messenger;
+            $this->_active_messengers[$messenger->name] = $messenger;
             // activate incoming message types set to be activated with messenger.
             $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
             // setup any initial settings for the messenger if necessary.
@@ -738,7 +738,7 @@ 
             // generate new templates if necessary and ensure all related templates that are already in the database are
             // marked active.  Note, this will also deactivate a message type for a messenger if the template
             // cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
+            if ( ! empty($message_type_names)) {
                 $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
                 EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
             }
@@ -762,13 +762,13 @@ 
         // things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
         // So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
         // only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
+        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
             ? $messenger->get_default_message_types()
             : (array) $message_type_names;
 
         // now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[ $messenger->name ])) {
-            $this->_active_message_types[ $messenger->name ]['settings'] = array();
+        if ( ! isset($this->_active_message_types[$messenger->name])) {
+            $this->_active_message_types[$messenger->name]['settings'] = array();
         }
 
         if ($message_type_names) {
@@ -776,7 +776,7 @@ 
             foreach ($message_type_names as $message_type_name) {
                 // only register the message type as active IF it isn't already active
                 // and if its actually installed.
-                if (! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
+                if ( ! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
                 ) {
                     $this->add_settings_for_message_type($messenger->name, $message_type_name);
                     $this->_set_messenger_has_activated_message_type(
@@ -808,16 +808,16 @@ 
         if ($message_type instanceof EE_message_type) {
             $default_settings = $message_type->get_admin_settings_fields();
             foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[ $field ])) {
-                    $existing_settings[ $field ] = $new_settings[ $field ];
+                if (isset($new_settings[$field])) {
+                    $existing_settings[$field] = $new_settings[$field];
                     continue;
                 }
-                if (! isset($existing_settings[ $field ])) {
-                    $existing_settings[ $field ] = $values['default'];
+                if ( ! isset($existing_settings[$field])) {
+                    $existing_settings[$field] = $values['default'];
                 }
             }
         }
-        $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
+        $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'] = $existing_settings;
     }
 
 
@@ -840,12 +840,12 @@ 
         }
 
         // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
+        if ( ! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name] = array();
         }
         // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
+        if ( ! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
         }
     }
 
@@ -863,16 +863,16 @@ 
         $messenger = $this->get_messenger($messenger_name);
         if ($messenger instanceof EE_messenger) {
             $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
+            if ( ! empty($msgr_settings)) {
                 foreach ($msgr_settings as $field => $value) {
                     // is there a new setting for this?
-                    if (isset($new_settings[ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
+                    if (isset($new_settings[$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] = $new_settings[$field];
                         continue;
                     }
                     // only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
+                    if ( ! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] = $value;
                     }
                 }
             }
@@ -892,8 +892,8 @@ 
         if ($messenger_name instanceof EE_messenger) {
             $messenger_name = $messenger_name->name;
         }
-        unset($this->_active_messengers[ $messenger_name ]);
-        unset($this->_active_message_types[ $messenger_name ]);
+        unset($this->_active_messengers[$messenger_name]);
+        unset($this->_active_message_types[$messenger_name]);
         $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
         $this->update_active_messengers_option();
     }
@@ -915,7 +915,7 @@ 
         }
         foreach ($this->_active_message_types as $messenger_name => $settings) {
             unset(
-                $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
+                $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]
             );
 
             // we always record (even on deactivation) that a message type has been activated because there should at
@@ -941,7 +941,7 @@ 
     {
         $this->_initialize_collections();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
         }
         $this->_message_template_group_model->deactivate_message_template_groups_for(
             array($messenger_name),
@@ -1001,22 +1001,22 @@ 
     {
         $key = $slugs_only ? 'slugs' : 'all';
         // check if contexts has been setup yet.
-        if (empty($this->_contexts[ $key ])) {
+        if (empty($this->_contexts[$key])) {
             // So let's get all active message type objects and loop through to get all unique contexts
             foreach ($this->get_active_message_type_objects() as $message_type) {
                 if ($message_type instanceof EE_message_type) {
                     $message_type_contexts = $message_type->get_contexts();
                     if ($slugs_only) {
                         foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[ $key ][ $context ] = $context_details['label'];
+                            $this->_contexts[$key][$context] = $context_details['label'];
                         }
                     } else {
-                        $this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
+                        $this->_contexts[$key][$message_type->name] = $message_type_contexts;
                     }
                 }
             }
         }
-        return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
+        return ! empty($this->_contexts[$key]) ? $this->_contexts[$key] : array();
     }
 
 
@@ -1036,7 +1036,7 @@ 
         $all_message_types_valid           = true;
         // loop through list of active message types and verify they are installed.
         foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[ $message_type_name ])) {
+            if ( ! isset($installed_message_types[$message_type_name])) {
                 $this->remove_message_type_has_been_activated_from_all_messengers(
                     $message_type_name,
                     true
@@ -1063,8 +1063,8 @@ 
     public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
     {
         $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[ $messenger_name ])
-               && in_array($message_type_name, $has_activated[ $messenger_name ]);
+        return isset($has_activated[$messenger_name])
+               && in_array($message_type_name, $has_activated[$messenger_name]);
     }
 
 
@@ -1092,11 +1092,11 @@ 
             return;
         }
         $has_activated = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[ $messenger_name ])
-            ? array_search($message_type_name, $has_activated[ $messenger_name ], true)
+        $key_for_message_type = isset($has_activated[$messenger_name])
+            ? array_search($message_type_name, $has_activated[$messenger_name], true)
             : false;
         if ($key_for_message_type !== false) {
-            unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
+            unset($has_activated[$messenger_name][$key_for_message_type]);
             $this->update_has_activated_messengers_option($has_activated);
             // reset the internal cached property
             $this->get_has_activated_messengers_option(true);