eventespresso / event-espresso-core

core/libraries/messages/EE_messenger.lib.php

Indentation +735 added lines, -735 removed lines

@@ -19,182 +19,182 @@ 
 
 
 
-    /**
-     * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
-     * This property gets set by the _set_default_message_types() method.
-     *
-     * @var array
-     */
-    protected $_default_message_types = array();
+	/**
+	 * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
+	 * This property gets set by the _set_default_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_default_message_types = array();
 
 
 
 
-    /**
-     * This property holds the message types that are valid for use with this messenger.
-     * It gets set by the _set_valid_message_types() method.
-     *
-     * @var array
-     */
-    protected $_valid_message_types = array();
+	/**
+	 * This property holds the message types that are valid for use with this messenger.
+	 * It gets set by the _set_valid_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_message_types = array();
 
 
 
-    /**
-     * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
-     *
-     * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
-     *
-     * Array should be in this format:
-     *
-     * array(
-     *  'field_name(i.e.to)' => array(
-     *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
-     *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
-     *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
-     *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
-     *  )
-     * )
-     *
-     * @var array
-     */
-    protected $_validator_config = array();
+	/**
+	 * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
+	 *
+	 * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
+	 *
+	 * Array should be in this format:
+	 *
+	 * array(
+	 *  'field_name(i.e.to)' => array(
+	 *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
+	 *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
+	 *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
+	 *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_validator_config = array();
 
 
 
-    /**
-     * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
-     * @var object
-     */
-    protected $_EEM_data;
+	/**
+	 * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
+	 * @var object
+	 */
+	protected $_EEM_data;
 
 
 
-    /**
-     * this property just holds an array of the various template refs.
-     * @var array
-     */
-    protected $_template_fields = array();
+	/**
+	 * this property just holds an array of the various template refs.
+	 * @var array
+	 */
+	protected $_template_fields = array();
 
 
 
 
-    /**
-     * This holds an array of the arguments used in parsing a template for the sender.
-     * @var array
-     */
-    protected $_template_args = array();
+	/**
+	 * This holds an array of the arguments used in parsing a template for the sender.
+	 * @var array
+	 */
+	protected $_template_args = array();
 
 
 
 
 
 
-    /**
-     * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
-     *
-     * @protected
-     * @var array
-     */
-    protected $_test_settings_fields = array();
+	/**
+	 * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
+	 *
+	 * @protected
+	 * @var array
+	 */
+	protected $_test_settings_fields = array();
 
 
 
 
 
 
-    /**
-     * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_tmp_pack;
+	/**
+	 * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_tmp_pack;
 
 
 
 
-    /**
-     * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
+	/**
+	 * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
 
 
 
 
 
-    /**
-     * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
-     *
-     *  - template pack
-     *  - template variation
-     *
-     * @since 4.5.0
-     *
-     * @var stdClass
-     */
-    protected $_supports_labels;
+	/**
+	 * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
+	 *
+	 *  - template pack
+	 *  - template variation
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var stdClass
+	 */
+	protected $_supports_labels;
 
 
 
 
 
-    /**
-     * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
-     *
-     * @var EE_message_type
-     */
-    protected $_incoming_message_type;
+	/**
+	 * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_incoming_message_type;
 
 
 
-    /**
-     * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
-     *
-     * @var bool
-     */
-    public $activate_on_install = false;
+	/**
+	 * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
+	 *
+	 * @var bool
+	 */
+	public $activate_on_install = false;
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_EEM_data = EEM_Message_Template_Group::instance();
-        $this->_messages_item_type = 'messenger';
+	public function __construct()
+	{
+		$this->_EEM_data = EEM_Message_Template_Group::instance();
+		$this->_messages_item_type = 'messenger';
 
-        parent::__construct();
+		parent::__construct();
 
-        $this->_set_test_settings_fields();
-        $this->_set_template_fields();
-        $this->_set_default_message_types();
-        $this->_set_valid_message_types();
-        $this->_set_validator_config();
+		$this->_set_test_settings_fields();
+		$this->_set_template_fields();
+		$this->_set_default_message_types();
+		$this->_set_valid_message_types();
+		$this->_set_validator_config();
 
 
-        $this->_supports_labels = new stdClass();
-        $this->_set_supports_labels();
-    }
+		$this->_supports_labels = new stdClass();
+		$this->_set_supports_labels();
+	}
 
 
 
 
 
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @abstract
-     * @access  protected
-     * @return void
-     */
-    abstract protected function _set_template_fields();
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return void
+	 */
+	abstract protected function _set_template_fields();
 
 
 
@@ -204,14 +204,14 @@ 
 
 
 
-    /**
-     * This method sets the _default_message_type property (see definition in docs attached to property)
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_default_message_types();
+	/**
+	 * This method sets the _default_message_type property (see definition in docs attached to property)
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_default_message_types();
 
 
 
@@ -219,15 +219,15 @@ 
 
 
 
-    /**
-     * Sets the _valid_message_types property (see definition in cods attached to property)
-     *
-     * @since 4.5.0
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_valid_message_types();
+	/**
+	 * Sets the _valid_message_types property (see definition in cods attached to property)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_valid_message_types();
 
 
 
@@ -235,171 +235,171 @@ 
 
 
 
-    /**
-     * Child classes must declare the $_validator_config property using this method.
-     * See comments for $_validator_config for details on what it is used for.
-     *
-     * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_validator_config();
+	/**
+	 * Child classes must declare the $_validator_config property using this method.
+	 * See comments for $_validator_config for details on what it is used for.
+	 *
+	 * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_validator_config();
 
 
 
 
 
 
-    /**
-     * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
-     *
-     * @return bool|WP_Error
-     * @throw \Exception
-     */
-    abstract protected function _send_message();
+	/**
+	 * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
+	 *
+	 * @return bool|WP_Error
+	 * @throw \Exception
+	 */
+	abstract protected function _send_message();
 
 
 
 
-    /**
-     * We give you pretty previews of the messages!
-     * @return string html body for message content.
-     */
-    abstract protected function _preview();
+	/**
+	 * We give you pretty previews of the messages!
+	 * @return string html body for message content.
+	 */
+	abstract protected function _preview();
 
 
 
 
-    /**
-     * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-        do_action('AHEE__EE_messenger__enqueue_scripts_styles');
-    }
+	/**
+	 * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
+	}
 
 
 
 
 
-    /**
-     * This is used to indicate whether a messenger must be sent immediately or not.
-     * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
-     * away.  The PDF messenger is similar.
-     *
-     * This flag thus overrides any priorities that may be set on the message type used to generate the message.
-     *
-     * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
-     *
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return false;
-    }
+	/**
+	 * This is used to indicate whether a messenger must be sent immediately or not.
+	 * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
+	 * away.  The PDF messenger is similar.
+	 *
+	 * This flag thus overrides any priorities that may be set on the message type used to generate the message.
+	 *
+	 * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
+	 *
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * This is a way for a messenger to indicate whether it allows an empty to field or not.
-     * Note: If the generated message is a for a preview, this value is ignored.
-     * @since 4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return false;
-    }
+	/**
+	 * This is a way for a messenger to indicate whether it allows an empty to field or not.
+	 * Note: If the generated message is a for a preview, this value is ignored.
+	 * @since 4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
-     * @see property definition for info on how its formatted.
-     *
-     * @since 4.5.0;
-     * @return void
-     */
-    protected function _set_supports_labels()
-    {
-        $this->_set_supports_labels_defaults();
-    }
+	/**
+	 * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
+	 * @see property definition for info on how its formatted.
+	 *
+	 * @since 4.5.0;
+	 * @return void
+	 */
+	protected function _set_supports_labels()
+	{
+		$this->_set_supports_labels_defaults();
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_supports_labels_defaults()
-    {
-        $this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
-        $this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
-        $this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
+	/**
+	 * Sets the defaults for the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_supports_labels_defaults()
+	{
+		$this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
+		$this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
+		$this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
 
-        $this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
+		$this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
 
-        $this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
-    }
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
 
-    /**
-     * This returns the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return stdClass
-     */
-    public function get_supports_labels()
-    {
-        if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
-            $this->_set_supports_labels_defaults();
-        }
-        return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
-    }
+	/**
+	 * This returns the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return stdClass
+	 */
+	public function get_supports_labels()
+	{
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
+			$this->_set_supports_labels_defaults();
+		}
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
-    /**
-     * Used to retrieve a variation (typically the path/url to a css file)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
-     * @param string                    $message_type_name The name property of the message type that we need the variation for.
-     * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
-     * @param string                    $type What variation type to return. Default is 'main'.
-     * @param string               $variation What variation for the template pack
-     * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
-     *
-     * @return string                    path or url for the requested variation.
-     */
-    public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
-    {
-        $this->_tmp_pack = $pack;
-        $variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
-        $variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
-        return $variation_path;
-    }
+	/**
+	 * Used to retrieve a variation (typically the path/url to a css file)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
+	 * @param string                    $message_type_name The name property of the message type that we need the variation for.
+	 * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
+	 * @param string                    $type What variation type to return. Default is 'main'.
+	 * @param string               $variation What variation for the template pack
+	 * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
+	 *
+	 * @return string                    path or url for the requested variation.
+	 */
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
+	{
+		$this->_tmp_pack = $pack;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
+		return $variation_path;
+	}
 
 
 
@@ -407,492 +407,492 @@ 
 
 
 
-    /**
-     * This just returns the default message types associated with this messenger when it is first activated.
-     *
-     * @access public
-     * @return array
-     */
-    public function get_default_message_types()
-    {
-        $class = get_class($this);
+	/**
+	 * This just returns the default message types associated with this messenger when it is first activated.
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_default_message_types()
+	{
+		$class = get_class($this);
 
-        // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+		// messenger specific filter
+		$default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
 
-        // all messengers filter
-        $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
-        return $default_types;
-    }
+		// all messengers filter
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
+		return $default_types;
+	}
 
 
 
 
-    /**
-     * Returns the valid message types associated with this messenger.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_valid_message_types()
-    {
-        $class = get_class($this);
-
-        // messenger specific filter
-        // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
-
-        // all messengers filter
-        $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
-        return $valid_types;
-    }
-
-
-
-
-
-    /**
-     * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
-     *
-     * @access public
-     * @param array $new_config Whatever is put in here will reset the _validator_config property
-     */
-    public function set_validator_config($new_config)
-    {
-        $this->_validator_config = $new_config;
-    }
-
-
-
-
-    /**
-     * This returns the _validator_config property
-     *
-     * @access public
-     * @return array
-     */
-    public function get_validator_config()
-    {
-        $class = get_class($this);
-
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
-        $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
-        return $config;
-    }
-
-
-
-
-    /**
-     * 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 $message_types an array of active message type 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 public
-     * @return string content for page
-     */
-    public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
-    {
-        return $this->_get_admin_page_content($page, $action, $extra, $message_types);
-    }
-
-
-
-    /**
-     * @param $message_types
-     * @param array $extra
-     * @return mixed|string
-     */
-    protected function _get_admin_content_events_edit($message_types, $extra)
-    {
-        // defaults
-        $template_args = array();
-        $selector_rows = '';
-
-        // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-        $event_id = isset($extra['event']) ? $extra['event'] : null;
-
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
-
-        // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
-        $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
-        );
-        $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
-            $event_id,
-            array(
-                'MTP_messenger' => $this->name,
-                'MTP_is_active' => true
-            )
-        );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
-
-        // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-        foreach ($global_templates as $mtpgID => $mtpg) {
-            if ($mtpg instanceof EE_Message_Template_Group) {
-                // verify this message type is supposed to show on this page
-                $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
-                    continue;
-                }
-                $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
-                    continue;
-                }
-                $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
-                $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
-                // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
-                    // any custom templates for this message type?
-                    $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
-                    foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
-                        $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
-                    }
-                }
-                // if there is no $default_value then we set it as the global
-                $default_value = empty($default_value) ? $mtpgID : $default_value;
-                $edit_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'edit_message_template',
-                    'id' => $default_value,
-                    'evt_id' => $event_id
-                ];
-                $edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
-                $create_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'add_new_message_template',
-                    'GRP_ID' => $default_value
-                ];
-                $create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
-                $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
-                $st_args['mt_slug'] = $mtpg->message_type();
-                $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
-                // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
-                $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
-                $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
-            }
-        }
-
-        // if no selectors present then get out.
-        if (empty($selector_rows)) {
-            return '';
-        }
-
-        $template_args['selector_rows'] = $selector_rows;
-        return EEH_Template::display_template($template_wrapper_path, $template_args, true);
-    }
-
-
-
-
-
-
-    /**
-     * get_template_fields
-     *
-     * @access public
-     * @return array $this->_template_fields
-     */
-    public function get_template_fields()
-    {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
-        $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
-        return $template_fields;
-    }
-
-
-
-
-    /** SETUP METHODS **/
-    /**
-     * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
-     * @param string $item
-     * @param mixed $value
-     */
-    protected function _set_template_value($item, $value)
-    {
-        if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
-            $this->{$prop} = $value;
-        }
-    }
-
-    /**
-     * Sets up the message for sending.
-     *
-     * @param  EE_message $message the message object that contains details about the message.
-     * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
-     *
-     * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
-     *              added to EE_Error.
-     *              true = message sent successfully
-     *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
-     *              Throwing a SendMessageException means the message failed sending and cannot be retried.
-     *
-     * @throws SendMessageException
-     */
-    final public function send_message($message, EE_message_type $message_type)
-    {
-        try {
-            $this->_validate_and_setup($message);
-            $this->_incoming_message_type = $message_type;
-            $response = $this->_send_message();
-            if ($response instanceof WP_Error) {
-                EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                $response = false;
-            }
-        } catch (\Exception $e) {
-            // convert to an instance of SendMessageException
-            throw new SendMessageException($e->getMessage());
-        }
-        return $response;
-    }
-
-
-
-    /**
-     * Sets up and returns message preview
-     * @param  EE_Message $message incoming message object
-     * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
-     * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
-     * @return string          return the message html content
-     */
-    public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
-    {
-        $this->_validate_and_setup($message);
-
-        $this->_incoming_message_type = $message_type;
-
-        if ($send) {
-            // are we overriding any existing template fields?
-            $settings = apply_filters(
-                'FHEE__EE_messenger__get_preview__messenger_test_settings',
-                $this->get_existing_test_settings(),
-                $this,
-                $send,
-                $message,
-                $message_type
-            );
-            if (! empty($settings)) {
-                foreach ($settings as $field => $value) {
-                    $this->_set_template_value($field, $value);
-                }
-            }
-        }
-
-        // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
-            // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
-            // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
-        }
-
-        return $send ? $this->_send_message() : $this->_preview();
-    }
-
-
-
-
-    /**
-     * Callback for enqueue_scripts so that we setup the preview script for all previews.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function add_preview_script()
-    {
-        // error message
-        EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
-            __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
-        );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
-        wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
-        wp_enqueue_script('ee-messages-preview-js');
-    }
-
-
-
-
-    /**
-     * simply validates the incoming message object and then sets up the properties for the messenger
-     * @param  EE_Message $message
-     * @throws EE_Error
-     */
-    protected function _validate_and_setup(EE_Message $message)
-    {
-        $template_pack = $message->get_template_pack();
-        $variation = $message->get_template_pack_variation();
-
-        // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
-            throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
-        }
-
-        $this->_tmp_pack = $template_pack;
-
-        $this->_variation = $variation ? $variation : 'default';
-
-        $template_fields = $this->get_template_fields();
-
-        foreach ($template_fields as $template => $value) {
-            if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
-                $message_template_value = $column_value ? $column_value : null;
-                $this->_set_template_value($template, $message_template_value);
-            }
-        }
-    }
-
-
-
-    /**
-     * Utility method for child classes to get the contents of a template file and return
-     *
-     * We're assuming the child messenger class has already setup template args!
-     * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $type = $preview ? 'preview' : 'main';
-
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
-
-        // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
-            throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
-        }
-
-        // add message type to template args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * set the _test_settings_fields property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array();
-    }
-
-
-
-    /**
-     * return the _test_settings_fields property
-     * @return array
-     */
-    public function get_test_settings_fields()
-    {
-        return $this->_test_settings_fields;
-    }
-
-
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
-    }
-
-
-
-    /**
-     * All this does is set the existing test settings (in the db) for the messenger
-     *
-     * @access public
-     * @param $settings
-     * @return bool success/fail
-     */
-    public function set_existing_test_settings($settings)
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
-        return $Message_Resource_Manager->update_active_messengers_option($existing);
-    }
-
-
-
-    /**
-     * This just returns the field label for a given field setup in the _template_fields property.
-     *
-     * @since   4.3.0
-     *
-     * @param string $field The field to retrieve the label for
-     * @return string             The label
-     */
-    public function get_field_label($field)
-    {
-        // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
-        }
-
-        // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
-        }
-
-        // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
-            foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
-                    continue;
-                }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
-                }
-            }
-        }
-
-        // if we made it here then there's no label set so let's just return the $field.
-        return $field;
-    }
-
-
-
-
-    /**
-     * 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)
-    {
-        return;
-    }
+	/**
+	 * Returns the valid message types associated with this messenger.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_valid_message_types()
+	{
+		$class = get_class($this);
+
+		// messenger specific filter
+		// messenger specific filter
+		$valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+
+		// all messengers filter
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
+		return $valid_types;
+	}
+
+
+
+
+
+	/**
+	 * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
+	 *
+	 * @access public
+	 * @param array $new_config Whatever is put in here will reset the _validator_config property
+	 */
+	public function set_validator_config($new_config)
+	{
+		$this->_validator_config = $new_config;
+	}
+
+
+
+
+	/**
+	 * This returns the _validator_config property
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_validator_config()
+	{
+		$class = get_class($this);
+
+		$config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
+		return $config;
+	}
+
+
+
+
+	/**
+	 * 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 $message_types an array of active message type 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 public
+	 * @return string content for page
+	 */
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
+	{
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
+	}
+
+
+
+	/**
+	 * @param $message_types
+	 * @param array $extra
+	 * @return mixed|string
+	 */
+	protected function _get_admin_content_events_edit($message_types, $extra)
+	{
+		// defaults
+		$template_args = array();
+		$selector_rows = '';
+
+		// we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
+		$event_id = isset($extra['event']) ? $extra['event'] : null;
+
+		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+
+		// array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
+		$global_templates = EEM_Message_Template_Group::instance()->get_all(
+			array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+		);
+		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
+			$event_id,
+			array(
+				'MTP_messenger' => $this->name,
+				'MTP_is_active' => true
+			)
+		);
+		$templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+
+		// so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
+		foreach ($global_templates as $mtpgID => $mtpg) {
+			if ($mtpg instanceof EE_Message_Template_Group) {
+				// verify this message type is supposed to show on this page
+				$mtp_obj = $mtpg->message_type_obj();
+				if (! $mtp_obj instanceof EE_message_type) {
+					continue;
+				}
+				$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
+				if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+					continue;
+				}
+				$select_values = array();
+				$select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+				$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
+				// if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
+				if (! $mtpg->get('MTP_is_override')) {
+					// any custom templates for this message type?
+					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
+					foreach ($custom_templates as $cmtpgID => $cmtpg) {
+						$select_values[ $cmtpgID ] = $cmtpg->name();
+						$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
+					}
+				}
+				// if there is no $default_value then we set it as the global
+				$default_value = empty($default_value) ? $mtpgID : $default_value;
+				$edit_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'edit_message_template',
+					'id' => $default_value,
+					'evt_id' => $event_id
+				];
+				$edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
+				$create_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'add_new_message_template',
+					'GRP_ID' => $default_value
+				];
+				$create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
+				$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
+				$st_args['mt_slug'] = $mtpg->message_type();
+				$st_args['messenger_slug'] = $this->name;
+				$st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+				// note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
+				$st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
+				$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
+				$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
+				$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
+			}
+		}
+
+		// if no selectors present then get out.
+		if (empty($selector_rows)) {
+			return '';
+		}
+
+		$template_args['selector_rows'] = $selector_rows;
+		return EEH_Template::display_template($template_wrapper_path, $template_args, true);
+	}
+
+
+
+
+
+
+	/**
+	 * get_template_fields
+	 *
+	 * @access public
+	 * @return array $this->_template_fields
+	 */
+	public function get_template_fields()
+	{
+		$template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
+		return $template_fields;
+	}
+
+
+
+
+	/** SETUP METHODS **/
+	/**
+	 * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
+	 * @param string $item
+	 * @param mixed $value
+	 */
+	protected function _set_template_value($item, $value)
+	{
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_' . $item;
+			$this->{$prop} = $value;
+		}
+	}
+
+	/**
+	 * Sets up the message for sending.
+	 *
+	 * @param  EE_message $message the message object that contains details about the message.
+	 * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
+	 *
+	 * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
+	 *              added to EE_Error.
+	 *              true = message sent successfully
+	 *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
+	 *              Throwing a SendMessageException means the message failed sending and cannot be retried.
+	 *
+	 * @throws SendMessageException
+	 */
+	final public function send_message($message, EE_message_type $message_type)
+	{
+		try {
+			$this->_validate_and_setup($message);
+			$this->_incoming_message_type = $message_type;
+			$response = $this->_send_message();
+			if ($response instanceof WP_Error) {
+				EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
+				$response = false;
+			}
+		} catch (\Exception $e) {
+			// convert to an instance of SendMessageException
+			throw new SendMessageException($e->getMessage());
+		}
+		return $response;
+	}
+
+
+
+	/**
+	 * Sets up and returns message preview
+	 * @param  EE_Message $message incoming message object
+	 * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
+	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
+	 * @return string          return the message html content
+	 */
+	public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
+	{
+		$this->_validate_and_setup($message);
+
+		$this->_incoming_message_type = $message_type;
+
+		if ($send) {
+			// are we overriding any existing template fields?
+			$settings = apply_filters(
+				'FHEE__EE_messenger__get_preview__messenger_test_settings',
+				$this->get_existing_test_settings(),
+				$this,
+				$send,
+				$message,
+				$message_type
+			);
+			if (! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
+				}
+			}
+		}
+
+		// enqueue preview js so that any links/buttons on the page are disabled.
+		if (! $send) {
+			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
+			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
+			add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+		}
+
+		return $send ? $this->_send_message() : $this->_preview();
+	}
+
+
+
+
+	/**
+	 * Callback for enqueue_scripts so that we setup the preview script for all previews.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function add_preview_script()
+	{
+		// error message
+		EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
+			__('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
+		);
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
+	}
+
+
+
+
+	/**
+	 * simply validates the incoming message object and then sets up the properties for the messenger
+	 * @param  EE_Message $message
+	 * @throws EE_Error
+	 */
+	protected function _validate_and_setup(EE_Message $message)
+	{
+		$template_pack = $message->get_template_pack();
+		$variation = $message->get_template_pack_variation();
+
+		// verify we have the required template pack value on the $message object.
+		if (! $template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
+		}
+
+		$this->_tmp_pack = $template_pack;
+
+		$this->_variation = $variation ? $variation : 'default';
+
+		$template_fields = $this->get_template_fields();
+
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra') {
+				$column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+				$message_template_value = $column_value ? $column_value : null;
+				$this->_set_template_value($template, $message_template_value);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Utility method for child classes to get the contents of a template file and return
+	 *
+	 * We're assuming the child messenger class has already setup template args!
+	 * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$type = $preview ? 'preview' : 'main';
+
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
+
+		// check file exists and is readable
+		if (!is_readable($wrapper_template)) {
+			throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
+		}
+
+		// add message type to template args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * set the _test_settings_fields property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array();
+	}
+
+
+
+	/**
+	 * return the _test_settings_fields property
+	 * @return array
+	 */
+	public function get_test_settings_fields()
+	{
+		return $this->_test_settings_fields;
+	}
+
+
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$settings = $Message_Resource_Manager->get_active_messengers_option();
+		return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+	}
+
+
+
+	/**
+	 * All this does is set the existing test settings (in the db) for the messenger
+	 *
+	 * @access public
+	 * @param $settings
+	 * @return bool success/fail
+	 */
+	public function set_existing_test_settings($settings)
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$existing = $Message_Resource_Manager->get_active_messengers_option();
+		$existing[ $this->name ]['test_settings'] = $settings;
+		return $Message_Resource_Manager->update_active_messengers_option($existing);
+	}
+
+
+
+	/**
+	 * This just returns the field label for a given field setup in the _template_fields property.
+	 *
+	 * @since   4.3.0
+	 *
+	 * @param string $field The field to retrieve the label for
+	 * @return string             The label
+	 */
+	public function get_field_label($field)
+	{
+		// first let's see if the field requests is in the top level array.
+		if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
+			return $this->_template[ $field ]['label'];
+		}
+
+		// nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
+		if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
+			return $this->_template_fields['extra'][ $field ]['main']['label'];
+		}
+
+		// now it's possible this field may just be existing in any of the extra array items.
+		if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if (!is_array($subfields)) {
+					continue;
+				}
+				if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
+					return $subfields[ $field ]['label'];
+				}
+			}
+		}
+
+		// if we made it here then there's no label set so let's just return the $field.
+		return $field;
+	}
+
+
+
+
+	/**
+	 * 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)
+	{
+		return;
+	}
 }

Spacing +36 added lines, -36 removed lines

@@ -418,7 +418,7 @@ 
         $class = get_class($this);
 
         // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+        $default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
         // all messengers filter
         $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
@@ -441,7 +441,7 @@ 
 
         // messenger specific filter
         // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+        $valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
         // all messengers filter
         $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
@@ -476,7 +476,7 @@ 
     {
         $class = get_class($this);
 
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+        $config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
         $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
         return $config;
     }
@@ -515,12 +515,12 @@ 
         // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
         $event_id = isset($extra['event']) ? $extra['event'] : null;
 
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+        $template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+        $template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
         // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
         $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+            array(array('MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true))
         );
         $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
             $event_id,
@@ -529,29 +529,29 @@ 
                 'MTP_is_active' => true
             )
         );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+        $templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
         // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
         foreach ($global_templates as $mtpgID => $mtpg) {
             if ($mtpg instanceof EE_Message_Template_Group) {
                 // verify this message type is supposed to show on this page
                 $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
+                if ( ! $mtp_obj instanceof EE_message_type) {
                     continue;
                 }
                 $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+                if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
                     continue;
                 }
                 $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+                $select_values[$mtpgID] = esc_html__('Global', 'event_espresso');
                 $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
                 // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
+                if ( ! $mtpg->get('MTP_is_override')) {
                     // any custom templates for this message type?
                     $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
                     foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
+                        $select_values[$cmtpgID] = $cmtpg->name();
                         $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
                     }
                 }
@@ -573,11 +573,11 @@ 
                 $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
                 $st_args['mt_slug'] = $mtpg->message_type();
                 $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation['.$mtpgID.']', $select_values, $default_value, 'data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'"', 'message-template-selector');
                 // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
+                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$create_url.'" class="button button-small create-mtpg-button">'.esc_html__('Create New Custom', 'event_espresso').'</a>';
                 $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
+                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$edit_url.'" class="button button-small edit-mtpg-button">'.esc_html__('Edit', 'event_espresso').'</a>' : '';
                 $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
             }
         }
@@ -604,7 +604,7 @@ 
      */
     public function get_template_fields()
     {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+        $template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
         $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
         return $template_fields;
     }
@@ -621,7 +621,7 @@ 
     protected function _set_template_value($item, $value)
     {
         if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
+            $prop = '_'.$item;
             $this->{$prop} = $value;
         }
     }
@@ -682,7 +682,7 @@ 
                 $message,
                 $message_type
             );
-            if (! empty($settings)) {
+            if ( ! empty($settings)) {
                 foreach ($settings as $field => $value) {
                     $this->_set_template_value($field, $value);
                 }
@@ -690,12 +690,12 @@ 
         }
 
         // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
+        if ( ! $send) {
             // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
             // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+            add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
         }
 
         return $send ? $this->_send_message() : $this->_preview();
@@ -717,7 +717,7 @@ 
         EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
             __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
         );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
         wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
         wp_enqueue_script('ee-messages-preview-js');
     }
@@ -736,7 +736,7 @@ 
         $variation = $message->get_template_pack_variation();
 
         // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack) {
             throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
         }
 
@@ -748,7 +748,7 @@ 
 
         foreach ($template_fields as $template => $value) {
             if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+                $column_value = $message->get_field_or_extra_meta('MSG_'.$template);
                 $message_template_value = $column_value ? $column_value : null;
                 $this->_set_template_value($template, $message_template_value);
             }
@@ -772,7 +772,7 @@ 
         $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
         // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
+        if ( ! is_readable($wrapper_template)) {
             throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
         }
 
@@ -820,7 +820,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+        return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
     }
 
 
@@ -837,7 +837,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
+        $existing[$this->name]['test_settings'] = $settings;
         return $Message_Resource_Manager->update_active_messengers_option($existing);
     }
 
@@ -854,23 +854,23 @@ 
     public function get_field_label($field)
     {
         // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
+        if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label'])) {
+            return $this->_template[$field]['label'];
         }
 
         // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
+        if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label'])) {
+            return $this->_template_fields['extra'][$field]['main']['label'];
         }
 
         // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+        if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
             foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
+                if ( ! is_array($subfields)) {
                     continue;
                 }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
+                if (isset($subfields[$field]) && ! empty($subfields[$field]['label'])) {
+                    return $subfields[$field]['label'];
                 }
             }
         }

core/libraries/messages/EE_Payment_Base_message_type.lib.php

Indentation +44 added lines, -44 removed lines

@@ -15,67 +15,67 @@
 
 
 
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_high;
-    }
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_high;
+	}
 
 
 
 
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true
-            );
-    }
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true
+			);
+	}
 
 
 
-    protected function _set_data_handler()
-    {
-        $this->_data_handler = 'Gateways';
-    }
+	protected function _set_data_handler()
+	{
+		$this->_data_handler = 'Gateways';
+	}
 
 
 
 
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
 
-        // use the registration to get the transaction.
-        $transaction = $registration->transaction();
+		// use the registration to get the transaction.
+		$transaction = $registration->transaction();
 
-        // bail early if no transaction
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
-        }
+		// bail early if no transaction
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
+		}
 
-        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+		$payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
 
-        return array( $transaction, $payment );
-    }
+		return array( $transaction, $payment );
+	}
 
 
 
-    protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
-    {
-        // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
-    }
+	protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
+	{
+		// this is just a test
+		return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+	}
 
-    /**
-     * This message type doesn't need any settings so we are just setting to empty array.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
+	/**
+	 * This message type doesn't need any settings so we are just setting to empty array.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -54,13 +54,13 @@ 
         $transaction = $registration->transaction();
 
         // bail early if no transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
         }
 
-        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array(array('PAY_ID' => $id, 'TXN_ID' => $transaction->ID()))) : 0;
 
-        return array( $transaction, $payment );
+        return array($transaction, $payment);
     }
 
 
@@ -68,7 +68,7 @@ 
     protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
     {
         // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+        return $this->name.' Message Type for '.$messenger->name.' Messenger ';
     }
 
     /**

core/libraries/messages/message_type/EE_Payment_Refund_message_type.class.php

Indentation +39 added lines, -39 removed lines

@@ -15,50 +15,50 @@
 class EE_Payment_Refund_message_type extends EE_Payment_Base_message_type
 {
 
-    public function __construct()
-    {
+	public function __construct()
+	{
 
-        // setup type details for reference
-        $this->name = 'payment_refund';
-        $this->description = esc_html__('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('refund issued', 'event_espresso'),
-            'plural' => esc_html__('refunds issued', 'event_espresso')
-            );
+		// setup type details for reference
+		$this->name = 'payment_refund';
+		$this->description = esc_html__('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('refund issued', 'event_espresso'),
+			'plural' => esc_html__('refunds issued', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'payment'
-            );
+		$this->_master_templates = array(
+			'email' => 'payment'
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive on a successful refund.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful refund.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive on a successful refund.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful refund.', 'event_espresso')
+				)
+			);
+	}
 }

core/libraries/messages/message_type/EE_Registration_message_type.class.php

Indentation +39 added lines, -39 removed lines

@@ -14,48 +14,48 @@
 class EE_Registration_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'registration';
-        $this->description = esc_html__('This message type is for messages sent to attendees when their registration is approved.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('registration approved', 'event_espresso'),
-            'plural' => esc_html__('registrations approved', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'registration';
+		$this->description = esc_html__('This message type is for messages sent to attendees when their registration is approved.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('registration approved', 'event_espresso'),
+			'plural' => esc_html__('registrations approved', 'event_espresso')
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration details sent out depending on who the recipient is', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive with an approved registration', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive with approved registration', 'event_espresso')
-                ),
-            'attendee' => array(
-                'label' => esc_html__('Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what each registrant for the event will receive when their registration is approved.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive with an approved registration', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive with approved registration', 'event_espresso')
+				),
+			'attendee' => array(
+				'label' => esc_html__('Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what each registrant for the event will receive when their registration is approved.', 'event_espresso')
+				)
+			);
+	}
 }

core/libraries/messages/message_type/EE_Pending_Approval_message_type.class.php

Indentation +46 added lines, -46 removed lines

@@ -14,59 +14,59 @@
 class EE_Pending_Approval_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'pending_approval';
-        $this->description = esc_html__('This message type is used for recipients who have Pending Payment registration status.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('registration pending payment', 'event_espresso'),
-            'plural' => esc_html__('registrations pending payment', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'pending_approval';
+		$this->description = esc_html__('This message type is used for recipients who have Pending Payment registration status.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('registration pending payment', 'event_espresso'),
+			'plural' => esc_html__('registrations pending payment', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'registration'
-            );
+		$this->_master_templates = array(
+			'email' => 'registration'
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different pending approval details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different pending approval details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive when a message is sent to registrants with the pending payment registration status.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive on when their registration status is pending payment.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive when a message is sent to registrants with the pending payment registration status.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive on when their registration status is pending payment.', 'event_espresso')
+				)
+			);
+	}
 
 
 
-    protected function _primary_attendee_addressees()
-    {
-        $cached = $this->_single_message;
-        $this->_single_message = false;
-        $addressees = parent::_primary_attendee_addressees();
-        $this->_single_message = $cached;
-        return $addressees;
-    }
+	protected function _primary_attendee_addressees()
+	{
+		$cached = $this->_single_message;
+		$this->_single_message = false;
+		$addressees = parent::_primary_attendee_addressees();
+		$this->_single_message = $cached;
+		return $addressees;
+	}
 }

core/libraries/messages/message_type/EE_Registration_Summary_message_type.class.php

Indentation +46 added lines, -46 removed lines

@@ -16,59 +16,59 @@
 class EE_Registration_Summary_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'registration_summary';
-        $this->description = esc_html__('This message type provides a summary notification to Primary Registrants and Admin recipients when there are multiple registrations in a transaction with different statuses.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('registration multi-status summary', 'event_espresso'),
-            'plural' => esc_html__('registrations multi-status summary', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'registration_summary';
+		$this->description = esc_html__('This message type provides a summary notification to Primary Registrants and Admin recipients when there are multiple registrations in a transaction with different statuses.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('registration multi-status summary', 'event_espresso'),
+			'plural' => esc_html__('registrations multi-status summary', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'registration'
-            );
+		$this->_master_templates = array(
+			'email' => 'registration'
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive when a transaction is finalized that has registrations with multiple different statuses.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive when the transaction completed has registrations with different statuses.  By default it is a summary email of all registrations for all events on the transaction and their status.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive when a transaction is finalized that has registrations with multiple different statuses.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive when the transaction completed has registrations with different statuses.  By default it is a summary email of all registrations for all events on the transaction and their status.', 'event_espresso')
+				)
+			);
+	}
 
 
 
-    protected function _primary_attendee_addressees()
-    {
-        $cached = $this->_single_message;
-        $this->_single_message = false;
-        $addressees = parent::_primary_attendee_addressees();
-        $this->_single_message = $cached;
-        return $addressees;
-    }
+	protected function _primary_attendee_addressees()
+	{
+		$cached = $this->_single_message;
+		$this->_single_message = false;
+		$addressees = parent::_primary_attendee_addressees();
+		$this->_single_message = $cached;
+		return $addressees;
+	}
 }

core/libraries/messages/message_type/EE_Payment_message_type.class.php

Indentation +36 added lines, -36 removed lines

@@ -14,44 +14,44 @@
 class EE_Payment_message_type extends EE_Payment_Base_message_type
 {
 
-    public function __construct()
-    {
+	public function __construct()
+	{
 
-        // setup type details for reference
-        $this->name = 'payment';
-        $this->description = esc_html__('This message type is used for all payment notification messages that go out including any manual payments entered by an event administrator.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('payment received', 'event_espresso'),
-            'plural' => esc_html__('payments received', 'event_espresso')
-            );
+		// setup type details for reference
+		$this->name = 'payment';
+		$this->description = esc_html__('This message type is used for all payment notification messages that go out including any manual payments entered by an event administrator.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('payment received', 'event_espresso'),
+			'plural' => esc_html__('payments received', 'event_espresso')
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive on a successful payment', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful payment', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive on a successful payment', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful payment', 'event_espresso')
+				)
+			);
+	}
 }

core/libraries/messages/message_type/EE_Not_Approved_Registration_message_type.class.php

Indentation +46 added lines, -46 removed lines

@@ -14,60 +14,60 @@
 class EE_Not_Approved_Registration_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'not_approved_registration';
-        $this->description = esc_html__('This message type is for messages sent to registrants when their registration is set to the not approved status.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('not approved registration', 'event_espresso'),
-            'plural' => esc_html__('not approved registrations', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'not_approved_registration';
+		$this->description = esc_html__('This message type is for messages sent to registrants when their registration is set to the not approved status.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('not approved registration', 'event_espresso'),
+			'plural' => esc_html__('not approved registrations', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'registration'
-            );
+		$this->_master_templates = array(
+			'email' => 'registration'
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration details sent out depending on who the recipient is', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive when registration status is set to not approved.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive when the registration status is not approved.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive when registration status is set to not approved.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive when the registration status is not approved.', 'event_espresso')
+				)
+			);
+	}
 
 
 
-    protected function _primary_attendee_addressees()
-    {
-        $cached = $this->_single_message;
-        $this->_single_message = false;
-        $addressees = parent::_primary_attendee_addressees();
-        $this->_single_message = $cached;
-        return $addressees;
-    }
+	protected function _primary_attendee_addressees()
+	{
+		$cached = $this->_single_message;
+		$this->_single_message = false;
+		$addressees = parent::_primary_attendee_addressees();
+		$this->_single_message = $cached;
+		return $addressees;
+	}
 }

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Indentation +1118 added lines, -1118 removed lines

@@ -12,1122 +12,1122 @@
 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(
-                esc_html__('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(
-                esc_html__('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(
-                    esc_html__(
-                        '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(
-                    esc_html__('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, 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 EE_messenger|string $messenger    Instantiated EE_messenger OR messenger name if not already loaded!
-     * @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,
-        $message_type_names = array(),
-        $update_active_messengers_option = true
-    ) {
-        $templates = array();
-        // grab the messenger to work with.
-        $messenger = $messenger instanceof EE_messenger
-            ? $messenger
-            : $this->messenger_collection()->get_by_info($messenger);
-        // 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(
+				esc_html__('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(
+				esc_html__('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(
+					esc_html__(
+						'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(
+					esc_html__('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, 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 EE_messenger|string $messenger    Instantiated EE_messenger OR messenger name if not already loaded!
+	 * @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,
+		$message_type_names = array(),
+		$update_active_messengers_option = true
+	) {
+		$templates = array();
+		// grab the messenger to work with.
+		$messenger = $messenger instanceof EE_messenger
+			? $messenger
+			: $this->messenger_collection()->get_by_info($messenger);
+		// 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 +53 added lines, -53 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(
                     esc_html__(
@@ -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(
                     esc_html__('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, array($message_type_name), $update_option);
                 }
@@ -728,7 +728,7 @@ 
             : $this->messenger_collection()->get_by_info($messenger);
         // 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.
@@ -740,7 +740,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);
             }
@@ -764,13 +764,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) {
@@ -811,16 +811,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;
     }
 
 
@@ -843,12 +843,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;
         }
     }
 
@@ -866,16 +866,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;
                     }
                 }
             }
@@ -895,8 +895,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();
     }
@@ -918,7 +918,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
@@ -944,7 +944,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),
@@ -1005,22 +1005,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();
     }
 
 
@@ -1040,7 +1040,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
@@ -1067,8 +1067,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]);
     }
 
 
@@ -1097,11 +1097,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);