eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Factory.lib.php

Indentation +136 added lines, -136 removed lines

@@ -12,140 +12,140 @@
  */
 class EE_Message_Factory
 {
-    protected static ?EE_Message_Factory  $_instance = null;
-
-    protected EE_Message_Resource_Manager $_message_resource_manager;
-
-
-    /**
-     * EE_Message_Factory constructor.
-     *
-     * @param EE_Message_Resource_Manager $Message_Resource_Manager
-     */
-    protected function __construct(EE_Message_Resource_Manager $Message_Resource_Manager)
-    {
-        $this->_message_resource_manager = $Message_Resource_Manager;
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Message_Resource_Manager $Message_Resource_Manager
-     * @return EE_Message_Factory instance
-     */
-    public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager): ?EE_Message_Factory
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
-            self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Message
-     */
-    public static function create(array $props_n_values = []): EE_Message
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
-        return $Message_Factory->_create($props_n_values);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return EE_Message
-     */
-    public static function set_messenger_and_message_type(EE_Message $message): EE_Message
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
-        return $Message_Factory->_set_messenger_and_message_type($message);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return EE_Message
-     */
-    public static function set_messenger(EE_Message $message): EE_Message
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
-        return $Message_Factory->_set_messenger($message);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return EE_Message
-     */
-    public static function set_message_type(EE_Message $message): EE_Message
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
-        return $Message_Factory->_set_message_type($message);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Message
-     */
-    protected function _create(array $props_n_values = []): EE_Message
-    {
-        $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
-            $message = EE_Message::new_instance_from_db($props_n_values);
-        } else {
-            $message      = EE_Message::new_instance($props_n_values);
-            $new_instance = true;
-        }
-        return $this->_set_messenger_and_message_type($message, $new_instance);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @param bool       $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return EE_Message
-     */
-    protected function _set_messenger_and_message_type(EE_Message $message, bool $new_instance = false): EE_Message
-    {
-        $message = $this->_set_messenger($message);
-        return $this->_set_message_type($message, $new_instance);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return EE_Message
-     */
-    protected function _set_messenger(EE_Message $message): EE_Message
-    {
-        $messenger = $this->_message_resource_manager->get_messenger($message->messenger());
-        if ($messenger instanceof EE_messenger) {
-            $message->set_messenger_object($messenger);
-        }
-        return $message;
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @param bool       $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return EE_Message
-     */
-    protected function _set_message_type(EE_Message $message, bool $new_instance = false): EE_Message
-    {
-        $message_type = $this->_message_resource_manager->get_message_type($message->message_type());
-        if ($message_type instanceof EE_message_type) {
-            $message->set_message_type_object($message_type, $new_instance);
-        }
-        return $message;
-    }
+	protected static ?EE_Message_Factory  $_instance = null;
+
+	protected EE_Message_Resource_Manager $_message_resource_manager;
+
+
+	/**
+	 * EE_Message_Factory constructor.
+	 *
+	 * @param EE_Message_Resource_Manager $Message_Resource_Manager
+	 */
+	protected function __construct(EE_Message_Resource_Manager $Message_Resource_Manager)
+	{
+		$this->_message_resource_manager = $Message_Resource_Manager;
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Message_Resource_Manager $Message_Resource_Manager
+	 * @return EE_Message_Factory instance
+	 */
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager): ?EE_Message_Factory
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Message
+	 */
+	public static function create(array $props_n_values = []): EE_Message
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
+		return $Message_Factory->_create($props_n_values);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return EE_Message
+	 */
+	public static function set_messenger_and_message_type(EE_Message $message): EE_Message
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return EE_Message
+	 */
+	public static function set_messenger(EE_Message $message): EE_Message
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
+		return $Message_Factory->_set_messenger($message);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return EE_Message
+	 */
+	public static function set_message_type(EE_Message $message): EE_Message
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = LoaderFactory::getShared('EE_Message_Factory');
+		return $Message_Factory->_set_message_type($message);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Message
+	 */
+	protected function _create(array $props_n_values = []): EE_Message
+	{
+		$new_instance = false;
+		if (! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
+		} else {
+			$message      = EE_Message::new_instance($props_n_values);
+			$new_instance = true;
+		}
+		return $this->_set_messenger_and_message_type($message, $new_instance);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @param bool       $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return EE_Message
+	 */
+	protected function _set_messenger_and_message_type(EE_Message $message, bool $new_instance = false): EE_Message
+	{
+		$message = $this->_set_messenger($message);
+		return $this->_set_message_type($message, $new_instance);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return EE_Message
+	 */
+	protected function _set_messenger(EE_Message $message): EE_Message
+	{
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @param bool       $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return EE_Message
+	 */
+	protected function _set_message_type(EE_Message $message, bool $new_instance = false): EE_Message
+	{
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
+		}
+		return $message;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
     public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager): ?EE_Message_Factory
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
+        if ( ! self::$_instance instanceof EE_Message_Factory) {
             self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
         }
         return self::$_instance;
@@ -99,7 +99,7 @@ 
     protected function _create(array $props_n_values = []): EE_Message
     {
         $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
+        if ( ! empty($props_n_values['MSG_ID'])) {
             $message = EE_Message::new_instance_from_db($props_n_values);
         } else {
             $message      = EE_Message::new_instance($props_n_values);

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Indentation +1135 added lines, -1135 removed lines

@@ -11,1139 +11,1139 @@
  */
 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 = [];
-
-    /**
-     * @type EE_message_type[]
-     */
-    protected $_installed_message_types = [];
-
-    /**
-     * Array of active messengers.
-     * Format is this:
-     * array(
-     *      'messenger_name' => EE_messenger
-     * )
-     *
-     * @type EE_messenger[]
-     */
-    protected $_active_messengers = [];
-
-    /**
-     * 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 = [];
-
-
-    /**
-     * 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 = [];
-
-    /**
-     * 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 = [];
-
-
-    /**
-     * 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 = [];
-            $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 = [];
-        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']
-                    : [];
-        }
-        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.
-     *
-     * @param string $messenger_name The messenger being checked
-     * @return EE_message_type[]|array    (empty array if no active_message_types)
-     * @since 4.9.0
-     */
-    public function get_active_message_types_for_messenger($messenger_name)
-    {
-        $message_types = [];
-        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 = [];
-        $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
-     *
-     * @return \EE_message_type[]
-     * @since 4.9.0
-     */
-    public function get_active_message_type_objects()
-    {
-        $active_message_types      = [];
-        $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', []);
-        }
-        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 = [])
-    {
-        $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.
-     *
-     * @param bool $reset Used to indicate that any cached value should be ignored.
-     * @return array
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *                    details.
-     */
-    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, []);
-        }
-        return $this->_has_activated_messengers_and_message_types;
-    }
-
-
-    /**
-     * Used to update the has activated option in the db.
-     *
-     * @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.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *                                        details.
-     */
-    public function update_has_activated_messengers_option($has_activated_messengers = [])
-    {
-        // 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([], 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, [], $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 = [], $update_option = true, $verify = false)
-    {
-        $messenger_names = empty($messenger_names)
-            ? array_keys($this->_active_message_types)
-            : $messenger_names;
-
-        $not_installed = [];
-        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, [$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 = [],
-        $update_active_messengers_option = true
-    ) {
-        $templates = [];
-        // 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([$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 = [])
-    {
-        // 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'] = [];
-        }
-
-        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 = [])
-    {
-        // 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.
-     *
-     * @param \EE_messenger $messenger
-     * @param string        $message_type_name
-     * @see    phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *         details.
-     * @access protected
-     */
-    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 ] = [];
-        }
-        // 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 = [])
-    {
-        $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(
-            [$messenger_name],
-            [$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.
-     *
-     * @param bool $slugs_only   Whether to return an array of just slugs and labels (true)
-     *                           or all contexts indexed by message type.
-     * @return array
-     * @since 4.9.0
-     */
-    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 ]
-            : [];
-    }
-
-
-    /**
-     * 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.
-     *
-     * @param $message_type_name
-     * @param $messenger_name
-     * @return bool
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *      details.
-     */
-    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.
-     *
-     * @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.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *                                        details.
-     */
-    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.
-     *
-     * @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.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
-     *                                      details.
-     */
-    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 = [];
+
+	/**
+	 * @type EE_message_type[]
+	 */
+	protected $_installed_message_types = [];
+
+	/**
+	 * Array of active messengers.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => EE_messenger
+	 * )
+	 *
+	 * @type EE_messenger[]
+	 */
+	protected $_active_messengers = [];
+
+	/**
+	 * 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 = [];
+
+
+	/**
+	 * 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 = [];
+
+	/**
+	 * 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 = [];
+
+
+	/**
+	 * 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 = [];
+			$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 = [];
+		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']
+					: [];
+		}
+		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.
+	 *
+	 * @param string $messenger_name The messenger being checked
+	 * @return EE_message_type[]|array    (empty array if no active_message_types)
+	 * @since 4.9.0
+	 */
+	public function get_active_message_types_for_messenger($messenger_name)
+	{
+		$message_types = [];
+		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 = [];
+		$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
+	 *
+	 * @return \EE_message_type[]
+	 * @since 4.9.0
+	 */
+	public function get_active_message_type_objects()
+	{
+		$active_message_types      = [];
+		$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', []);
+		}
+		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 = [])
+	{
+		$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.
+	 *
+	 * @param bool $reset Used to indicate that any cached value should be ignored.
+	 * @return array
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *                    details.
+	 */
+	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, []);
+		}
+		return $this->_has_activated_messengers_and_message_types;
+	}
+
+
+	/**
+	 * Used to update the has activated option in the db.
+	 *
+	 * @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.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *                                        details.
+	 */
+	public function update_has_activated_messengers_option($has_activated_messengers = [])
+	{
+		// 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([], 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, [], $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 = [], $update_option = true, $verify = false)
+	{
+		$messenger_names = empty($messenger_names)
+			? array_keys($this->_active_message_types)
+			: $messenger_names;
+
+		$not_installed = [];
+		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, [$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 = [],
+		$update_active_messengers_option = true
+	) {
+		$templates = [];
+		// 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([$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 = [])
+	{
+		// 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'] = [];
+		}
+
+		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 = [])
+	{
+		// 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.
+	 *
+	 * @param \EE_messenger $messenger
+	 * @param string        $message_type_name
+	 * @see    phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *         details.
+	 * @access protected
+	 */
+	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 ] = [];
+		}
+		// 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 = [])
+	{
+		$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(
+			[$messenger_name],
+			[$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.
+	 *
+	 * @param bool $slugs_only   Whether to return an array of just slugs and labels (true)
+	 *                           or all contexts indexed by message type.
+	 * @return array
+	 * @since 4.9.0
+	 */
+	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 ]
+			: [];
+	}
+
+
+	/**
+	 * 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.
+	 *
+	 * @param $message_type_name
+	 * @param $messenger_name
+	 * @return bool
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *      details.
+	 */
+	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.
+	 *
+	 * @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.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *                                        details.
+	 */
+	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.
+	 *
+	 * @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.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more
+	 *                                      details.
+	 */
+	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 +57 added lines, -57 removed lines

@@ -193,8 +193,8 @@ 
     public function get_active_messenger($messenger)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ])
-            ? $this->_active_messengers[ $messenger ]
+        return ! empty($this->_active_messengers[$messenger])
+            ? $this->_active_messengers[$messenger]
             : null;
     }
 
@@ -208,7 +208,7 @@ 
             $this->_installed_messengers = [];
             $this->messenger_collection()->rewind();
             while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] =
+                $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]);
     }
 
 
@@ -321,8 +321,8 @@ 
         $settings = [];
         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']
+                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']
                     : [];
         }
         return $settings;
@@ -340,8 +340,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']);
     }
 
 
@@ -356,13 +356,13 @@ 
     public function get_active_message_types_for_messenger($messenger_name)
     {
         $message_types = [];
-        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;
@@ -381,11 +381,11 @@ 
         $active_message_type_names = [];
         $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;
                 }
             }
@@ -406,9 +406,9 @@ 
         $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;
@@ -423,7 +423,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->_installed_message_types[$this->message_type_collection()->current()->name] =
                     $this->message_type_collection()->current();
                 $this->message_type_collection()->next();
             }
@@ -463,7 +463,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__(
@@ -593,7 +593,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, [], $update_option);
             } catch (EE_Error $e) {
@@ -640,7 +640,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',
@@ -674,7 +674,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, [$message_type_name], $update_option);
                 }
@@ -738,7 +738,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.
@@ -750,7 +750,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([$messenger->name], $message_type_names);
             }
@@ -774,13 +774,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'] = [];
+        if ( ! isset($this->_active_message_types[$messenger->name])) {
+            $this->_active_message_types[$messenger->name]['settings'] = [];
         }
 
         if ($message_type_names) {
@@ -821,16 +821,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'] =
+        $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'] =
             $existing_settings;
     }
 
@@ -853,12 +853,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 ] = [];
+        if ( ! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name] = [];
         }
         // 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;
         }
     }
 
@@ -876,17 +876,17 @@ 
         $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;
                     }
                 }
             }
@@ -906,8 +906,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();
     }
@@ -930,7 +930,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
@@ -956,7 +956,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(
             [$messenger_name],
@@ -1019,23 +1019,23 @@ 
             ? '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 ]
+        return ! empty($this->_contexts[$key])
+            ? $this->_contexts[$key]
             : [];
     }
 
@@ -1056,7 +1056,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
@@ -1083,8 +1083,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]);
     }
 
 
@@ -1113,11 +1113,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);

core/libraries/messages/EE_Messages_Generator.lib.php

Indentation +979 added lines, -979 removed lines

@@ -15,984 +15,984 @@
  */
 class EE_Messages_Generator
 {
-    protected EE_Messages_Data_Handler_Collection  $_data_handler_collection;
-
-    protected EE_Message_Template_Group_Collection $_template_collection;
-
-    /**
-     * This will hold the data handler for the current EE_Message being generated.
-     */
-    protected ?EE_Messages_incoming_data $_current_data_handler = null;
-
-    /**
-     * This holds the EE_Messages_Queue that contains the messages to generate.
-     */
-    protected EE_Messages_Queue $_generation_queue;
-
-    /**
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
-     */
-    protected EE_Messages_Queue $_ready_queue;
-
-    /**
-     * This is a container for any error messages that get created through the generation
-     * process.
-     */
-    protected array $_error_msg = [];
-
-    /**
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
-     */
-    protected bool $_verified = false;
-
-    /**
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
-     */
-    protected ?EE_messenger $_current_messenger = null;
-
-    /**
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
-     */
-    protected ?EE_message_type     $_current_message_type = null;
-
-    protected EEH_Parse_Shortcodes $_shortcode_parser;
-
-
-    /**
-     * @param EE_Messages_Queue                    $generation_queue
-     * @param EE_Messages_Queue                    $ready_queue
-     * @param EE_Messages_Data_Handler_Collection  $data_handler_collection
-     * @param EE_Message_Template_Group_Collection $template_collection
-     * @param EEH_Parse_Shortcodes                 $shortcode_parser
-     */
-    public function __construct(
-        EE_Messages_Queue $generation_queue,
-        EE_Messages_Queue $ready_queue,
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
-        EE_Message_Template_Group_Collection $template_collection,
-        EEH_Parse_Shortcodes $shortcode_parser
-    ) {
-        $this->_generation_queue        = $generation_queue;
-        $this->_ready_queue             = $ready_queue;
-        $this->_data_handler_collection = $data_handler_collection;
-        $this->_template_collection     = $template_collection;
-        $this->_shortcode_parser        = $shortcode_parser;
-    }
-
-
-    /**
-     * @return EE_Messages_Queue
-     */
-    public function generation_queue(): EE_Messages_Queue
-    {
-        return $this->_generation_queue;
-    }
-
-
-    /**
-     *  This iterates through the provided queue and generates the EE_Message objects.
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
-     *  for the caller to decide what to do with it.
-     *
-     * @param bool $save Whether to save the EE_Message objects in the new queue or just return.
-     * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function generate(bool $save = true): EE_Messages_Queue
-    {
-        // iterate through the messages in the queue, generate, and add to new queue.
-        $this->_generation_queue->get_message_repository()->rewind();
-
-        while ($this->_generation_queue->get_message_repository()->valid()) {
-            // reset "current" properties
-            $this->_reset_current_properties();
-
-            $msg = $this->_generation_queue->get_message_repository()->current();
-
-            /**
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
-             * an object is removed from the repo then valid for the next object will fail.
-             */
-            $this->_generation_queue->get_message_repository()->next();
-            $next_msg = $this->_generation_queue->get_message_repository()->valid()
-                ? $this->_generation_queue->get_message_repository()->current()
-                : null;
-            // restore pointer to current item
-            $this->_generation_queue->get_message_repository()->set_current($msg);
-
-            // skip and delete if the current $msg is NOT incomplete (queued for generation)
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
-                // we keep this item in the db just remove from the repo.
-                $this->_generation_queue->get_message_repository()->remove($msg);
-                // next item
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            if ($this->_verify()) {
-                // let's get generating!
-                $this->_generate();
-            }
-
-            // don't persist debug_only messages if the messages system is not in debug mode.
-            if (
-                $msg->STS_ID() === EEM_Message::status_debug_only
-                && ! EEM_Message::debug()
-            ) {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $this->_generation_queue->get_message_repository()->delete();
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            // if there are error messages then let's set the status and the error message.
-            if ($this->_error_msg) {
-                // if the status is already debug only, then let's leave it at that.
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
-                    $msg->set_STS_ID(EEM_Message::status_failed);
-                }
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $msg->set_error_message(
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
-                    . "\n"
-                    . implode("\n", $this->_error_msg)
-                );
-                $msg->set_modified(time());
-            } else {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                // remove from db
-                $this->_generation_queue->get_message_repository()->delete();
-            }
-            // next item
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
-        }
-
-        // generation queue is ALWAYS saved to record any errors in the generation process.
-        $this->_generation_queue->save();
-
-        /**
-         * save _ready_queue if flag set.
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
-         * irrelevant.
-         */
-        if ($save) {
-            $this->_ready_queue->save();
-        }
-
-        // final reset of properties
-        $this->_reset_current_properties();
-
-        return $this->_ready_queue;
-    }
-
-
-    /**
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
-     * in the generation queue.
-     */
-    protected function _reset_current_properties()
-    {
-        $this->_verified = false;
-        // make sure any _data value in the current message type is reset
-        if ($this->_current_message_type instanceof EE_message_type) {
-            $this->_current_message_type->reset_data();
-        }
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
-    }
-
-
-    /**
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
-     * _generating_queue.
-     *
-     * @return bool Whether the message was successfully generated or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _generate(): bool
-    {
-        // double check verification has run and that everything is ready to work with (saves us having to validate
-        // everything again).
-        if (! $this->_verified) {
-            return false; // get out because we don't have a valid setup to work with.
-        }
-
-
-        try {
-            $addressees = $this->_current_message_type->get_addressees(
-                $this->_current_data_handler,
-                $this->_generation_queue->get_message_repository()->current()->context()
-            );
-        } catch (EE_Error $e) {
-            $this->_error_msg[] = $e->getMessage();
-            return false;
-        }
-
-
-        // if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
-            do_action(
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
-                $this->_generation_queue->get_message_repository()->current(),
-                $addressees,
-                $this->_current_messenger,
-                $this->_current_message_type,
-                $this->_current_data_handler
-            );
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
-                EEM_Message::status_debug_only
-            );
-            $this->_error_msg[] = esc_html__(
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        $message_template_group = $this->_get_message_template_group();
-
-        // in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        // get formatted templates for using to parse and setup EE_Message objects.
-        $templates = $this->_get_templates($message_template_group);
-
-
-        // setup new EE_Message objects (and add to _ready_queue)
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
-    }
-
-
-    /**
-     * Retrieves the message template group being used for generating messages.
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_message_template_group(): ?EE_Message_Template_Group
-    {
-        // first see if there is a specific message template group requested
-        // (current message in the queue has a specific GRP_ID)
-        $message_template_group = $this->_specific_message_template_group_from_queue();
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // get event_ids from the data handler so we can check to see
-        // if there's already a message template group for them in the collection.
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
-        $message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                $event_ids
-            )
-        );
-
-        // if we have a message template group then no need to hit the database, just return it.
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // get the global group first for this messenger and message type
-        // to ensure there is no override set.
-        $global_message_template_group =
-            $this->_get_global_message_template_group_for_current_messenger_and_message_type();
-
-        if (
-            $global_message_template_group instanceof EE_Message_Template_Group
-            && $global_message_template_group->get('MTP_is_override')
-        ) {
-            return $global_message_template_group;
-        }
-
-        // if we're still here, that means there was no message template group for the events in the collection and
-        // the global message template group for the messenger and message type is not set for override.  So next step
-        // is to see if there is a common shared custom message template group for this set of events.
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // STILL here?  Okay that means the fallback is to just use the global message template group for this event
-        // set. So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this
-        // request) and return it.
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
-            $this->_template_collection->add(
-                $global_message_template_group,
-                $event_ids
-            );
-            return $global_message_template_group;
-        }
-
-        // if we land here that means there's NO active message template group for this set.
-        // TODO this will be a good target for some optimization down the road.  Whenever there is no active message
-        // template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
-        // this should likely bit hit rarely enough that it's not a significant issue.
-        return null;
-    }
-
-
-    /**
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
-     * requested for that message.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _specific_message_template_group_from_queue(): ?EE_Message_Template_Group
-    {
-        // is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
-        // so let's use that.
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
-
-        if ($GRP_ID) {
-            // attempt to retrieve from repo first
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  // got it!
-            }
-
-            // nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
-            // is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add($message_template_group);
-                return $message_template_group;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether the event ids passed in all share the same message template group for the current message type
-     * and messenger.
-     *
-     * @param array $event_ids
-     * @return bool true means they DO share the same message template group, false means they don't.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids): bool
-    {
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
-        }
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
-            [
-                [
-                    'Event.EVT_ID'     => ['IN', $event_ids],
-                    'MTP_messenger'    => $this->_current_messenger->name,
-                    'MTP_message_type' => $this->_current_message_type->name,
-                ],
-            ],
-            'GRP_ID',
-            true
-        );
-        return $count_of_message_template_groups === 1;
-    }
-
-
-    /**
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
-     *
-     * @param array $event_ids
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_shared_message_template_for_events(array $event_ids): ?EE_Message_Template_Group
-    {
-        $message_template_group = null;
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                [
-                    [
-                        'Event.EVT_ID'     => ['IN', $event_ids],
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                    ],
-                    'group_by' => 'GRP_ID',
-                ]
-            );
-            // store this in the collection if its valid
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $message_template_group,
-                    $event_ids
-                );
-            }
-        }
-        return $message_template_group;
-    }
-
-
-    /**
-     * Retrieves the global message template group for the current messenger and message type.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type(
-    ): ?EE_Message_Template_Group
-    {
-        // first check the collection (we use an array with 0 in it to represent global groups).
-        $global_message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                [0]
-            )
-        );
-
-        // if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                [
-                    [
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                        'MTP_is_global'    => true,
-                    ],
-                ]
-            );
-            // if we have a group, add it to the collection.
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $global_message_template_group,
-                    [0]
-                );
-            }
-        }
-        return $global_message_template_group;
-    }
-
-
-    /**
-     * Returns an array of event ids for all the events within the current data handler.
-     *
-     * @return array
-     */
-    protected function _get_event_ids_from_current_data_handler(): array
-    {
-        $event_ids = [];
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
-        }
-        return $event_ids;
-    }
-
-
-    /**
-     *  Retrieves formatted array of template information for each context specific to the given
-     *  EE_Message_Template_Group
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @return array The returned array is in this structure:
-     *                          array(
-     *                          'field_name' => array(
-     *                          'context' => 'content'
-     *                          )
-     *                          )
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_templates(EE_Message_Template_Group $message_template_group): array
-    {
-        $templates         = [];
-        $context_templates = $message_template_group->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
-                    continue;
-                }
-                $templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
-     *
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
-     *                                               context.
-     * @param array                     $templates   formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
-     *                                               method will attempt to generate ALL EE_Message objects and add to
-     *                                               the _ready_queue.  Successfully generated messages get added to the
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
-     *                                               Very rarely should "false" be returned from this method.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _assemble_messages(
-        array $addressees,
-        array $templates,
-        EE_Message_Template_Group $message_template_group
-    ): bool {
-        // if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        // We use this as the counter for generated messages because don't forget we may be executing this inside of a
-        // generation_queue.  So _ready_queue may have generated EE_Message objects already.
-        $generated_count = 0;
-        foreach ($addressees as $context => $recipients) {
-            foreach ($recipients as $recipient) {
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
-                if ($message instanceof EE_Message) {
-                    $this->_ready_queue->add(
-                        $message,
-                        [],
-                        $this->_generation_queue->get_message_repository()->is_preview(),
-                        $this->_generation_queue->get_message_repository()->is_test_send()
-                    );
-                    $generated_count++;
-                }
-
-                // if the current MSG being generated is for a test send then we'll only use ONE message in the
-                // generation.
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
-                    break 2;
-                }
-            }
-        }
-
-        // if there are no generated messages then something else fatal went wrong.
-        return $generated_count > 0;
-    }
-
-
-    /**
-     * @param string                    $context   The context for the generated message.
-     * @param EE_Messages_Addressee     $recipient
-     * @param array                     $templates formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws InvalidIdentifierException
-     */
-    protected function _setup_message_object(
-        string $context,
-        EE_Messages_Addressee $recipient,
-        array $templates,
-        EE_Message_Template_Group $message_template_group
-    ) {
-        // stuff we already know
-        $transaction_id = $recipient->txn instanceof EE_Transaction
-            ? $recipient->txn->ID()
-            : 0;
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
-            ? $this->_current_data_handler->txn->ID()
-            : $transaction_id;
-        $message_fields = [
-            'GRP_ID'           => $message_template_group->ID(),
-            'TXN_ID'           => $transaction_id,
-            'MSG_messenger'    => $this->_current_messenger->name,
-            'MSG_message_type' => $this->_current_message_type->name,
-            'MSG_context'      => $context,
-        ];
-
-        // recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
-        // the info from the att_obj found in the EE_Messages_Addressee object.
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
-                ? $recipient->att_obj->ID()
-                : 0;
-            $message_fields['MSG_recipient_type'] = 'Attendee';
-        } else {
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
-        }
-        $message = EE_Message_Factory::create($message_fields);
-
-        // grab valid shortcodes for shortcode parser
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
-
-        // if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
-        if (
-            ! $this->_generation_queue->get_message_repository()->is_preview()
-            && (
-                (empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
-                || ! $message_template_group->is_context_active($context)
-            )
-        ) {
-            // we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
-            // field.
-            return false;
-        }
-        $error_msg = [];
-        foreach ($templates as $field => $field_context) {
-            $error_msg = [];
-            // let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[ $context ];
-            // merge in valid shortcodes for the field.
-            $shortcodes = $m_shortcodes[ $field ] ?? $valid_shortcodes;
-            if (isset($field_context[ $context ])) {
-                // prefix field.
-                $column_name = 'MSG_' . $field;
-                try {
-                    $content = $this->_shortcode_parser->parse_message_template(
-                        $field_context[ $context ],
-                        $recipient,
-                        $shortcodes,
-                        $this->_current_message_type,
-                        $this->_current_messenger,
-                        $message
-                    );
-                    // the model field removes slashes when setting (usually necessary when the input is from the
-                    // request) but this value is from another model and has no slashes. So add them so it matches
-                    // what the field expected (otherwise slashes will have been stripped from this an extra time)
-                    $message->set_field_or_extra_meta($column_name, addslashes($content));
-                } catch (EE_Error $e) {
-                    $error_msg[] = sprintf(
-                    /* Translators: First place holder is message model field name.
+	protected EE_Messages_Data_Handler_Collection  $_data_handler_collection;
+
+	protected EE_Message_Template_Group_Collection $_template_collection;
+
+	/**
+	 * This will hold the data handler for the current EE_Message being generated.
+	 */
+	protected ?EE_Messages_incoming_data $_current_data_handler = null;
+
+	/**
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
+	 */
+	protected EE_Messages_Queue $_generation_queue;
+
+	/**
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
+	 */
+	protected EE_Messages_Queue $_ready_queue;
+
+	/**
+	 * This is a container for any error messages that get created through the generation
+	 * process.
+	 */
+	protected array $_error_msg = [];
+
+	/**
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
+	 */
+	protected bool $_verified = false;
+
+	/**
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
+	 */
+	protected ?EE_messenger $_current_messenger = null;
+
+	/**
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
+	 */
+	protected ?EE_message_type     $_current_message_type = null;
+
+	protected EEH_Parse_Shortcodes $_shortcode_parser;
+
+
+	/**
+	 * @param EE_Messages_Queue                    $generation_queue
+	 * @param EE_Messages_Queue                    $ready_queue
+	 * @param EE_Messages_Data_Handler_Collection  $data_handler_collection
+	 * @param EE_Message_Template_Group_Collection $template_collection
+	 * @param EEH_Parse_Shortcodes                 $shortcode_parser
+	 */
+	public function __construct(
+		EE_Messages_Queue $generation_queue,
+		EE_Messages_Queue $ready_queue,
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
+		EE_Message_Template_Group_Collection $template_collection,
+		EEH_Parse_Shortcodes $shortcode_parser
+	) {
+		$this->_generation_queue        = $generation_queue;
+		$this->_ready_queue             = $ready_queue;
+		$this->_data_handler_collection = $data_handler_collection;
+		$this->_template_collection     = $template_collection;
+		$this->_shortcode_parser        = $shortcode_parser;
+	}
+
+
+	/**
+	 * @return EE_Messages_Queue
+	 */
+	public function generation_queue(): EE_Messages_Queue
+	{
+		return $this->_generation_queue;
+	}
+
+
+	/**
+	 *  This iterates through the provided queue and generates the EE_Message objects.
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
+	 *  for the caller to decide what to do with it.
+	 *
+	 * @param bool $save Whether to save the EE_Message objects in the new queue or just return.
+	 * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function generate(bool $save = true): EE_Messages_Queue
+	{
+		// iterate through the messages in the queue, generate, and add to new queue.
+		$this->_generation_queue->get_message_repository()->rewind();
+
+		while ($this->_generation_queue->get_message_repository()->valid()) {
+			// reset "current" properties
+			$this->_reset_current_properties();
+
+			$msg = $this->_generation_queue->get_message_repository()->current();
+
+			/**
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
+			 * an object is removed from the repo then valid for the next object will fail.
+			 */
+			$this->_generation_queue->get_message_repository()->next();
+			$next_msg = $this->_generation_queue->get_message_repository()->valid()
+				? $this->_generation_queue->get_message_repository()->current()
+				: null;
+			// restore pointer to current item
+			$this->_generation_queue->get_message_repository()->set_current($msg);
+
+			// skip and delete if the current $msg is NOT incomplete (queued for generation)
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
+				// we keep this item in the db just remove from the repo.
+				$this->_generation_queue->get_message_repository()->remove($msg);
+				// next item
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			if ($this->_verify()) {
+				// let's get generating!
+				$this->_generate();
+			}
+
+			// don't persist debug_only messages if the messages system is not in debug mode.
+			if (
+				$msg->STS_ID() === EEM_Message::status_debug_only
+				&& ! EEM_Message::debug()
+			) {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$this->_generation_queue->get_message_repository()->delete();
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			// if there are error messages then let's set the status and the error message.
+			if ($this->_error_msg) {
+				// if the status is already debug only, then let's leave it at that.
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
+				}
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$msg->set_error_message(
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
+					. "\n"
+					. implode("\n", $this->_error_msg)
+				);
+				$msg->set_modified(time());
+			} else {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				// remove from db
+				$this->_generation_queue->get_message_repository()->delete();
+			}
+			// next item
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
+		}
+
+		// generation queue is ALWAYS saved to record any errors in the generation process.
+		$this->_generation_queue->save();
+
+		/**
+		 * save _ready_queue if flag set.
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
+		 * irrelevant.
+		 */
+		if ($save) {
+			$this->_ready_queue->save();
+		}
+
+		// final reset of properties
+		$this->_reset_current_properties();
+
+		return $this->_ready_queue;
+	}
+
+
+	/**
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
+	 * in the generation queue.
+	 */
+	protected function _reset_current_properties()
+	{
+		$this->_verified = false;
+		// make sure any _data value in the current message type is reset
+		if ($this->_current_message_type instanceof EE_message_type) {
+			$this->_current_message_type->reset_data();
+		}
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
+	}
+
+
+	/**
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
+	 * _generating_queue.
+	 *
+	 * @return bool Whether the message was successfully generated or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _generate(): bool
+	{
+		// double check verification has run and that everything is ready to work with (saves us having to validate
+		// everything again).
+		if (! $this->_verified) {
+			return false; // get out because we don't have a valid setup to work with.
+		}
+
+
+		try {
+			$addressees = $this->_current_message_type->get_addressees(
+				$this->_current_data_handler,
+				$this->_generation_queue->get_message_repository()->current()->context()
+			);
+		} catch (EE_Error $e) {
+			$this->_error_msg[] = $e->getMessage();
+			return false;
+		}
+
+
+		// if no addressees then get out because there is nothing to generation (possible bad data).
+		if (! $this->_valid_addressees($addressees)) {
+			do_action(
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
+				$this->_generation_queue->get_message_repository()->current(),
+				$addressees,
+				$this->_current_messenger,
+				$this->_current_message_type,
+				$this->_current_data_handler
+			);
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
+				EEM_Message::status_debug_only
+			);
+			$this->_error_msg[] = esc_html__(
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		$message_template_group = $this->_get_message_template_group();
+
+		// in the unlikely event there is no EE_Message_Template_Group available, get out!
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		// get formatted templates for using to parse and setup EE_Message objects.
+		$templates = $this->_get_templates($message_template_group);
+
+
+		// setup new EE_Message objects (and add to _ready_queue)
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
+	}
+
+
+	/**
+	 * Retrieves the message template group being used for generating messages.
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_message_template_group(): ?EE_Message_Template_Group
+	{
+		// first see if there is a specific message template group requested
+		// (current message in the queue has a specific GRP_ID)
+		$message_template_group = $this->_specific_message_template_group_from_queue();
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// get event_ids from the data handler so we can check to see
+		// if there's already a message template group for them in the collection.
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
+		$message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				$event_ids
+			)
+		);
+
+		// if we have a message template group then no need to hit the database, just return it.
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// get the global group first for this messenger and message type
+		// to ensure there is no override set.
+		$global_message_template_group =
+			$this->_get_global_message_template_group_for_current_messenger_and_message_type();
+
+		if (
+			$global_message_template_group instanceof EE_Message_Template_Group
+			&& $global_message_template_group->get('MTP_is_override')
+		) {
+			return $global_message_template_group;
+		}
+
+		// if we're still here, that means there was no message template group for the events in the collection and
+		// the global message template group for the messenger and message type is not set for override.  So next step
+		// is to see if there is a common shared custom message template group for this set of events.
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// STILL here?  Okay that means the fallback is to just use the global message template group for this event
+		// set. So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this
+		// request) and return it.
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add(
+				$global_message_template_group,
+				$event_ids
+			);
+			return $global_message_template_group;
+		}
+
+		// if we land here that means there's NO active message template group for this set.
+		// TODO this will be a good target for some optimization down the road.  Whenever there is no active message
+		// template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
+		// this should likely bit hit rarely enough that it's not a significant issue.
+		return null;
+	}
+
+
+	/**
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
+	 * requested for that message.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _specific_message_template_group_from_queue(): ?EE_Message_Template_Group
+	{
+		// is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
+		// so let's use that.
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
+
+		if ($GRP_ID) {
+			// attempt to retrieve from repo first
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				return $message_template_group;  // got it!
+			}
+
+			// nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
+			// is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($message_template_group);
+				return $message_template_group;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
+	 * and messenger.
+	 *
+	 * @param array $event_ids
+	 * @return bool true means they DO share the same message template group, false means they don't.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids): bool
+	{
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[ $event['ID'] ] = $event['ID'];
+		}
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
+			[
+				[
+					'Event.EVT_ID'     => ['IN', $event_ids],
+					'MTP_messenger'    => $this->_current_messenger->name,
+					'MTP_message_type' => $this->_current_message_type->name,
+				],
+			],
+			'GRP_ID',
+			true
+		);
+		return $count_of_message_template_groups === 1;
+	}
+
+
+	/**
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
+	 *
+	 * @param array $event_ids
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_shared_message_template_for_events(array $event_ids): ?EE_Message_Template_Group
+	{
+		$message_template_group = null;
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				[
+					[
+						'Event.EVT_ID'     => ['IN', $event_ids],
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+					],
+					'group_by' => 'GRP_ID',
+				]
+			);
+			// store this in the collection if its valid
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$message_template_group,
+					$event_ids
+				);
+			}
+		}
+		return $message_template_group;
+	}
+
+
+	/**
+	 * Retrieves the global message template group for the current messenger and message type.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type(
+	): ?EE_Message_Template_Group
+	{
+		// first check the collection (we use an array with 0 in it to represent global groups).
+		$global_message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				[0]
+			)
+		);
+
+		// if we don't have a group lets hit the db.
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				[
+					[
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+						'MTP_is_global'    => true,
+					],
+				]
+			);
+			// if we have a group, add it to the collection.
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$global_message_template_group,
+					[0]
+				);
+			}
+		}
+		return $global_message_template_group;
+	}
+
+
+	/**
+	 * Returns an array of event ids for all the events within the current data handler.
+	 *
+	 * @return array
+	 */
+	protected function _get_event_ids_from_current_data_handler(): array
+	{
+		$event_ids = [];
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[ $event['ID'] ] = $event['ID'];
+		}
+		return $event_ids;
+	}
+
+
+	/**
+	 *  Retrieves formatted array of template information for each context specific to the given
+	 *  EE_Message_Template_Group
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return array The returned array is in this structure:
+	 *                          array(
+	 *                          'field_name' => array(
+	 *                          'context' => 'content'
+	 *                          )
+	 *                          )
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_templates(EE_Message_Template_Group $message_template_group): array
+	{
+		$templates         = [];
+		$context_templates = $message_template_group->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if (! $template_obj instanceof EE_Message_Template) {
+					continue;
+				}
+				$templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
+	 *
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
+	 *                                               context.
+	 * @param array                     $templates   formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
+	 *                                               Very rarely should "false" be returned from this method.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _assemble_messages(
+		array $addressees,
+		array $templates,
+		EE_Message_Template_Group $message_template_group
+	): bool {
+		// if templates are empty then get out because we can't generate anything.
+		if (! $templates) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		// We use this as the counter for generated messages because don't forget we may be executing this inside of a
+		// generation_queue.  So _ready_queue may have generated EE_Message objects already.
+		$generated_count = 0;
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
+					$this->_ready_queue->add(
+						$message,
+						[],
+						$this->_generation_queue->get_message_repository()->is_preview(),
+						$this->_generation_queue->get_message_repository()->is_test_send()
+					);
+					$generated_count++;
+				}
+
+				// if the current MSG being generated is for a test send then we'll only use ONE message in the
+				// generation.
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
+					break 2;
+				}
+			}
+		}
+
+		// if there are no generated messages then something else fatal went wrong.
+		return $generated_count > 0;
+	}
+
+
+	/**
+	 * @param string                    $context   The context for the generated message.
+	 * @param EE_Messages_Addressee     $recipient
+	 * @param array                     $templates formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool|EE_Message
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws InvalidIdentifierException
+	 */
+	protected function _setup_message_object(
+		string $context,
+		EE_Messages_Addressee $recipient,
+		array $templates,
+		EE_Message_Template_Group $message_template_group
+	) {
+		// stuff we already know
+		$transaction_id = $recipient->txn instanceof EE_Transaction
+			? $recipient->txn->ID()
+			: 0;
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
+			? $this->_current_data_handler->txn->ID()
+			: $transaction_id;
+		$message_fields = [
+			'GRP_ID'           => $message_template_group->ID(),
+			'TXN_ID'           => $transaction_id,
+			'MSG_messenger'    => $this->_current_messenger->name,
+			'MSG_message_type' => $this->_current_message_type->name,
+			'MSG_context'      => $context,
+		];
+
+		// recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
+		// the info from the att_obj found in the EE_Messages_Addressee object.
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
+				? $recipient->att_obj->ID()
+				: 0;
+			$message_fields['MSG_recipient_type'] = 'Attendee';
+		} else {
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
+		}
+		$message = EE_Message_Factory::create($message_fields);
+
+		// grab valid shortcodes for shortcode parser
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
+
+		// if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
+		if (
+			! $this->_generation_queue->get_message_repository()->is_preview()
+			&& (
+				(empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
+				|| ! $message_template_group->is_context_active($context)
+			)
+		) {
+			// we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
+			// field.
+			return false;
+		}
+		$error_msg = [];
+		foreach ($templates as $field => $field_context) {
+			$error_msg = [];
+			// let's setup the valid shortcodes for the incoming context.
+			$valid_shortcodes = $mt_shortcodes[ $context ];
+			// merge in valid shortcodes for the field.
+			$shortcodes = $m_shortcodes[ $field ] ?? $valid_shortcodes;
+			if (isset($field_context[ $context ])) {
+				// prefix field.
+				$column_name = 'MSG_' . $field;
+				try {
+					$content = $this->_shortcode_parser->parse_message_template(
+						$field_context[ $context ],
+						$recipient,
+						$shortcodes,
+						$this->_current_message_type,
+						$this->_current_messenger,
+						$message
+					);
+					// the model field removes slashes when setting (usually necessary when the input is from the
+					// request) but this value is from another model and has no slashes. So add them so it matches
+					// what the field expected (otherwise slashes will have been stripped from this an extra time)
+					$message->set_field_or_extra_meta($column_name, addslashes($content));
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(
+					/* Translators: First place holder is message model field name.
                      * Second placeholder is exception error message */
-                        esc_html__(
-                            'There was a problem generating the content for the field %s: %s',
-                            'event_espresso'
-                        ),
-                        $field,
-                        $e->getMessage()
-                    );
-                    $message->set_STS_ID(EEM_Message::status_failed);
-                }
-            }
-        }
-
-        if ($message->STS_ID() === EEM_Message::status_failed) {
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
-                         . "\n"
-                         . implode("\n", $error_msg);
-            $message->set_error_message($error_msg);
-        } else {
-            $message->set_STS_ID(EEM_Message::status_idle);
-        }
-        return $message;
-    }
-
-
-    /**
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
-     * error message if either is missing.
-     *
-     * @return bool true means there were no errors, false means there were errors.
-     */
-    protected function _verify(): bool
-    {
-        // reset error message to an empty array.
-        $this->_error_msg = [];
-        // set the verified flag so we know everything has been validated.
-        $this->_verified = $this->_validate_messenger_and_message_type() && $this->_validate_and_setup_data();
-        return $this->_verified;
-    }
-
-
-    /**
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param array|null $addressees Keys correspond to contexts for the message type and values are
-     *                               EE_Messages_Addressee[]
-     * @return bool
-     */
-    protected function _valid_addressees(?array $addressees): bool
-    {
-        if (! $addressees || ! is_array($addressees)) {
-            return false;
-        }
-
-        foreach ($addressees as $addressee_array) {
-            foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
-     * queue. This process sets error messages if something is wrong.
-     *
-     * @return bool   true is if there are no errors.  false is if there is.
-     */
-    protected function _validate_messenger_and_message_type(): bool
-    {
-        // first are there any existing error messages?  If so then return.
-        if ($this->_error_msg) {
-            return false;
-        }
-        $message = $this->_generation_queue->get_message_repository()->current();
-        try {
-            $this->_current_messenger = $message->valid_messenger(true)
-                ? $message->messenger_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-        try {
-            $this->_current_message_type = $message->valid_message_type(true)
-                ? $message->message_type_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-
-        /**
-         * Check if there is any generation data, but only if this is not for a preview.
-         */
-        if (
-            ! $this->_generation_queue->get_message_repository()->get_generation_data()
-            && (
-                ! $this->_generation_queue->get_message_repository()->is_preview()
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
-                   !== 'EE_Messages_Preview_incoming_data'
-            )
-        ) {
-            $this->_error_msg[] = esc_html__(
-                'There is no generation data for this message. Unable to generate.',
-                'event_espresso'
-            );
-        }
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
-     * data handler.
-     *
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
-     */
-    protected function _validate_and_setup_data(): bool
-    {
-        // First, are there any existing error messages?  If so, return because if there were errors elsewhere this
-        // can't be used anyways.
-        if ($this->_error_msg) {
-            return false;
-        }
-
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
-
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
-
-        // If this EE_Message is for a preview, then let's switch out to the preview data handler.
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
-        }
-
-        // First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
-            $this->_error_msg[] = sprintf(
-            /* Translators: Both placeholders are the names of php classes. */
-                esc_html__(
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
-                    'event_espresso'
-                ),
-                'EE_Messages_incoming_data',
-                $data_handler_class_name
-            );
-            return false;
-        }
-
-        // convert generation_data for data_handler_instantiation.
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
-
-        // note, this may set error messages as well.
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
-     * adds it to the _data repository.
-     *
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
-     *                                          instantiated.
-     */
-    protected function _set_data_handler($generating_data, string $data_handler_class_name)
-    {
-        // valid classname for the data handler.  Now let's setup the key for the data handler repository to see if
-        // there is already a ready data handler in the repository.
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
-            $this->_data_handler_collection->get_key(
-                $data_handler_class_name,
-                $generating_data
-            )
-        );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
-            // no saved data_handler in the repo so let's set one up and add it to the repo.
-            try {
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
-            } catch (Exception $e) {
-                $this->_error_msg[] = $e->getMessage();
-            }
-        }
-    }
-
-
-    /**
-     * The queued EE_Message for generation does not save the data used for generation as objects
-     * because serialization of those objects could be problematic if the data is saved to the db.
-     * So this method calls the static method on the associated data_handler for the given message_type
-     * and that preps the data for later instantiation when generating.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
-     */
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, bool $preview)
-    {
-        if (! $message_to_generate->valid()) {
-            return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
-        }
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
-    }
-
-
-    /**
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_and_add_message_to_queue(
-        EE_Message_To_Generate $message_to_generate,
-        bool $test_send = false
-    ): bool {
-        // prep data
-        $data    = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-
-        $message = $message_to_generate->get_EE_Message();
-        $GRP_ID  = $request->getRequestParam('GRP_ID', 0, 'int');
-
-        $GRP_ID = apply_filters(
-            'FHEE__EE_Messages_Generator__create_and_add_message_to_queue_GRP_ID',
-            $GRP_ID > 0
-                ? $GRP_ID
-                : $message->GRP_ID(),
-            $message,
-            $message_to_generate,
-            $test_send
-        );
-
-        if ($GRP_ID > 0) {
-            $message->set_GRP_ID($GRP_ID);
-        }
-
-        if ($data === false) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                esc_html__(
-                    'Unable to prepare data for persistence to the database.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            // make sure that the data handler is cached on the message as well
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
-        }
-
-        return $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
-    }
+						esc_html__(
+							'There was a problem generating the content for the field %s: %s',
+							'event_espresso'
+						),
+						$field,
+						$e->getMessage()
+					);
+					$message->set_STS_ID(EEM_Message::status_failed);
+				}
+			}
+		}
+
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
+						 . "\n"
+						 . implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
+		} else {
+			$message->set_STS_ID(EEM_Message::status_idle);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
+	 * error message if either is missing.
+	 *
+	 * @return bool true means there were no errors, false means there were errors.
+	 */
+	protected function _verify(): bool
+	{
+		// reset error message to an empty array.
+		$this->_error_msg = [];
+		// set the verified flag so we know everything has been validated.
+		$this->_verified = $this->_validate_messenger_and_message_type() && $this->_validate_and_setup_data();
+		return $this->_verified;
+	}
+
+
+	/**
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param array|null $addressees Keys correspond to contexts for the message type and values are
+	 *                               EE_Messages_Addressee[]
+	 * @return bool
+	 */
+	protected function _valid_addressees(?array $addressees): bool
+	{
+		if (! $addressees || ! is_array($addressees)) {
+			return false;
+		}
+
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if (! $addressee instanceof EE_Messages_Addressee) {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
+	 * queue. This process sets error messages if something is wrong.
+	 *
+	 * @return bool   true is if there are no errors.  false is if there is.
+	 */
+	protected function _validate_messenger_and_message_type(): bool
+	{
+		// first are there any existing error messages?  If so then return.
+		if ($this->_error_msg) {
+			return false;
+		}
+		$message = $this->_generation_queue->get_message_repository()->current();
+		try {
+			$this->_current_messenger = $message->valid_messenger(true)
+				? $message->messenger_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+		try {
+			$this->_current_message_type = $message->valid_message_type(true)
+				? $message->message_type_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+
+		/**
+		 * Check if there is any generation data, but only if this is not for a preview.
+		 */
+		if (
+			! $this->_generation_queue->get_message_repository()->get_generation_data()
+			&& (
+				! $this->_generation_queue->get_message_repository()->is_preview()
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
+				   !== 'EE_Messages_Preview_incoming_data'
+			)
+		) {
+			$this->_error_msg[] = esc_html__(
+				'There is no generation data for this message. Unable to generate.',
+				'event_espresso'
+			);
+		}
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
+	 * data handler.
+	 *
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
+	 */
+	protected function _validate_and_setup_data(): bool
+	{
+		// First, are there any existing error messages?  If so, return because if there were errors elsewhere this
+		// can't be used anyways.
+		if ($this->_error_msg) {
+			return false;
+		}
+
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
+
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+
+		// If this EE_Message is for a preview, then let's switch out to the preview data handler.
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
+		}
+
+		// First get the class name for the data handler (and also verifies it exists.
+		if (! class_exists($data_handler_class_name)) {
+			$this->_error_msg[] = sprintf(
+			/* Translators: Both placeholders are the names of php classes. */
+				esc_html__(
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
+					'event_espresso'
+				),
+				'EE_Messages_incoming_data',
+				$data_handler_class_name
+			);
+			return false;
+		}
+
+		// convert generation_data for data_handler_instantiation.
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
+
+		// note, this may set error messages as well.
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
+	 * adds it to the _data repository.
+	 *
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
+	 *                                          instantiated.
+	 */
+	protected function _set_data_handler($generating_data, string $data_handler_class_name)
+	{
+		// valid classname for the data handler.  Now let's setup the key for the data handler repository to see if
+		// there is already a ready data handler in the repository.
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
+			$this->_data_handler_collection->get_key(
+				$data_handler_class_name,
+				$generating_data
+			)
+		);
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+			// no saved data_handler in the repo so let's set one up and add it to the repo.
+			try {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (Exception $e) {
+				$this->_error_msg[] = $e->getMessage();
+			}
+		}
+	}
+
+
+	/**
+	 * The queued EE_Message for generation does not save the data used for generation as objects
+	 * because serialization of those objects could be problematic if the data is saved to the db.
+	 * So this method calls the static method on the associated data_handler for the given message_type
+	 * and that preps the data for later instantiation when generating.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
+	 */
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, bool $preview)
+	{
+		if (! $message_to_generate->valid()) {
+			return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
+		}
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
+	}
+
+
+	/**
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_and_add_message_to_queue(
+		EE_Message_To_Generate $message_to_generate,
+		bool $test_send = false
+	): bool {
+		// prep data
+		$data    = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+
+		$message = $message_to_generate->get_EE_Message();
+		$GRP_ID  = $request->getRequestParam('GRP_ID', 0, 'int');
+
+		$GRP_ID = apply_filters(
+			'FHEE__EE_Messages_Generator__create_and_add_message_to_queue_GRP_ID',
+			$GRP_ID > 0
+				? $GRP_ID
+				: $message->GRP_ID(),
+			$message,
+			$message_to_generate,
+			$test_send
+		);
+
+		if ($GRP_ID > 0) {
+			$message->set_GRP_ID($GRP_ID);
+		}
+
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				esc_html__(
+					'Unable to prepare data for persistence to the database.',
+					'event_espresso'
+				)
+			);
+		} else {
+			// make sure that the data handler is cached on the message as well
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
+		}
+
+		return $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -245,7 +245,7 @@ 
     {
         // double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; // get out because we don't have a valid setup to work with.
         }
 
@@ -262,7 +262,7 @@ 
 
 
         // if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -284,7 +284,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         // in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -397,7 +397,7 @@ 
             // attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  // got it!
+                return $message_template_group; // got it!
             }
 
             // nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -427,7 +427,7 @@ 
     protected function _queue_shares_same_message_template_group_for_events(array $event_ids): bool
     {
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
             [
@@ -506,7 +506,7 @@ 
         );
 
         // if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 [
                     [
@@ -538,7 +538,7 @@ 
     {
         $event_ids = [];
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         return $event_ids;
     }
@@ -567,10 +567,10 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
-                $templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
+                $templates[$template_field][$context] = $template_obj->get('MTP_content');
             }
         }
         return $templates;
@@ -603,7 +603,7 @@ 
         EE_Message_Template_Group $message_template_group
     ): bool {
         // if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -695,7 +695,7 @@ 
         if (
             ! $this->_generation_queue->get_message_repository()->is_preview()
             && (
-                (empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
+                (empty($templates['to'][$context]) && ! $this->_current_messenger->allow_empty_to_field())
                 || ! $message_template_group->is_context_active($context)
             )
         ) {
@@ -707,15 +707,15 @@ 
         foreach ($templates as $field => $field_context) {
             $error_msg = [];
             // let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[ $context ];
+            $valid_shortcodes = $mt_shortcodes[$context];
             // merge in valid shortcodes for the field.
-            $shortcodes = $m_shortcodes[ $field ] ?? $valid_shortcodes;
-            if (isset($field_context[ $context ])) {
+            $shortcodes = $m_shortcodes[$field] ?? $valid_shortcodes;
+            if (isset($field_context[$context])) {
                 // prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
-                        $field_context[ $context ],
+                        $field_context[$context],
                         $recipient,
                         $shortcodes,
                         $this->_current_message_type,
@@ -780,13 +780,13 @@ 
      */
     protected function _valid_addressees(?array $addressees): bool
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -863,7 +863,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         // If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -871,7 +871,7 @@ 
         }
 
         // First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
             /* Translators: Both placeholders are the names of php classes. */
                 esc_html__(
@@ -912,7 +912,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             // no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -936,7 +936,7 @@ 
      */
     protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, bool $preview)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */

core/libraries/rest_api/controllers/Base.php

Indentation +334 added lines, -334 removed lines

@@ -20,338 +20,338 @@
  */
 class Base
 {
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = array();
-
-
-    public function __construct()
-    {
-        $this->debug_mode = EED_Core_Rest_Api::debugMode();
-        // we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo($key, $info)
-    {
-        $this->debug_info[ $key ] = $info;
-    }
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
-        }
-    }
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response): WP_REST_Response
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers['X-EE4-Debug-' . ucwords(str_replace("\x20", '-', $debug_key))] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array) $wp_error->errors as $code => $messages) {
-            foreach ((array) $messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices()
-    {
-        $headers = array();
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
-                          . EEH_Inflector::humanize($notice_type)
-                          . '['
-                          . $notice_code
-                          . ']' ] = strip_tags((string) $sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string $route
-     * @return string
-     */
-    public function getRequestedVersion($route = null)
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            // skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param \WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(\WP_REST_Request $request)
-    {
-        // $request->get_params();
-        return array_merge(
-            (array) $request->get_body_params(),
-            (array) $request->get_json_params()
-        );
-        // return array_diff_key(
-        //    $request->get_params(),
-        //     $request->get_url_params(),
-        //     $request->get_query_params()
-        // );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = array();
+
+
+	public function __construct()
+	{
+		$this->debug_mode = EED_Core_Rest_Api::debugMode();
+		// we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo($key, $info)
+	{
+		$this->debug_info[ $key ] = $info;
+	}
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[ $prefix . $header_key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response): WP_REST_Response
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers['X-EE4-Debug-' . ucwords(str_replace("\x20", '-', $debug_key))] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array) $wp_error->errors as $code => $messages) {
+			foreach ((array) $messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices()
+	{
+		$headers = array();
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers[ 'X-EE4-Notices-'
+						  . EEH_Inflector::humanize($notice_type)
+						  . '['
+						  . $notice_code
+						  . ']' ] = strip_tags((string) $sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function getRequestedVersion($route = null)
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			// skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[ $i ])) {
+					$success = false;
+				} else {
+					$indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(\WP_REST_Request $request)
+	{
+		// $request->get_params();
+		return array_merge(
+			(array) $request->get_body_params(),
+			(array) $request->get_json_params()
+		);
+		// return array_diff_key(
+		//    $request->get_params(),
+		//     $request->get_url_params(),
+		//     $request->get_query_params()
+		// );
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -94,7 +94,7 @@ 
      */
     protected function setDebugInfo($key, $info)
     {
-        $this->debug_info[ $key ] = $info;
+        $this->debug_info[$key] = $info;
     }
 
 
@@ -111,11 +111,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -145,7 +145,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response)
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -188,7 +188,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers['X-EE4-Debug-' . ucwords(str_replace("\x20", '-', $debug_key))] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords(str_replace("\x20", '-', $debug_key))] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -247,15 +247,15 @@ 
         $headers = array();
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
+                $headers['X-EE4-Notices-'
                           . EEH_Inflector::humanize($notice_type)
                           . '['
                           . $notice_code
-                          . ']' ] = strip_tags((string) $sub_notice);
+                          . ']'] = strip_tags((string) $sub_notice);
             }
         }
         return apply_filters(
@@ -284,7 +284,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -318,14 +318,14 @@ 
         if (is_array($matches)) {
             // skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

core/libraries/plugin_api/db/EEE_Base_Class.lib.php

Indentation +117 added lines, -117 removed lines

@@ -29,133 +29,133 @@
  */
 class EEE_Base_Class
 {
-    const extending_method_prefix        = 'ext_';
+	const extending_method_prefix        = 'ext_';
 
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
 
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string|null
-     */
-    protected ?string $_model_name_extended = null;
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_model_name_extended = null;
 
-    /**
-     * The model this extends
-     *
-     * @var EE_Base_Class|null
-     */
-    protected $_ = null;
+	/**
+	 * The model this extends
+	 *
+	 * @var EE_Base_Class|null
+	 */
+	protected $_ = null;
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function __construct()
-    {
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                esc_html__(
-                    "When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-                    "event_espresso"
-                )
+	/**
+	 * @throws EE_Error
+	 */
+	public function __construct()
+	{
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				esc_html__(
+					"When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+					"event_espresso"
+				)
 
-            );
-        }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Hooked in model object extension '%s' too late! The model object %s has already been used!",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->_model_name_extended
-                )
-            );
-        }
-        $this->_register_extending_methods();
-    }
+			);
+		}
+		if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Hooked in model object extension '%s' too late! The model object %s has already been used!",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->_model_name_extended
+				)
+			);
+		}
+		$this->_register_extending_methods();
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
-                    10,
-                    10
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+					10,
+					10
+				);
+			}
+		}
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+				);
+			}
+		}
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            $model_called           = $args[1];
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $args_provided_to_method_on_model = $args[2];
-            $extending_method                 = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                        "event_espresso"
-                    ),
-                    $this->_model_name_extended,
-                    get_class($this),
-                    $extending_method,
-                    $extending_method
-                )
-            );
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                $callback_method_name,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			$model_called           = $args[1];
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$args_provided_to_method_on_model = $args[2];
+			$extending_method                 = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+						"event_espresso"
+					),
+					$this->_model_name_extended,
+					get_class($this),
+					$extending_method,
+					$extending_method
+				)
+			);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+				$callback_method_name,
+				get_class($this)
+			)
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -53,7 +53,7 @@ 
      */
     public function __construct()
     {
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 esc_html__(
                     "When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
@@ -62,7 +62,7 @@ 
 
             );
         }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+        if (did_action('AHEE__EE_'.$this->_model_name_extended.'__construct__end')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -91,7 +91,7 @@ 
                 $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model],
                     10,
                     10
                 );
@@ -113,7 +113,7 @@ 
                 $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model]
                 );
             }
         }
@@ -133,7 +133,7 @@ 
             $this->_ = $model_called;
             // phpcs:enable
             $args_provided_to_method_on_model = $args[2];
-            $extending_method                 = self::extending_method_prefix . $method_called_on_model;
+            $extending_method                 = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
             }

core/libraries/plugin_api/EE_Register_Admin_Page.lib.php

Indentation +112 added lines, -112 removed lines

@@ -10,131 +10,131 @@
  */
 class EE_Register_Admin_Page implements EEI_Plugin_API
 {
-    /**
-     * Holds registered EE_Admin_Pages
-     *
-     * @var array
-     */
-    protected static $_ee_admin_page_registry = [];
+	/**
+	 * Holds registered EE_Admin_Pages
+	 *
+	 * @var array
+	 */
+	protected static $_ee_admin_page_registry = [];
 
 
-    /**
-     * The purpose of this method is to provide an easy way for addons to register their admin pages (using the EE
-     * Admin Page loader system).
-     *
-     * @param string $addon_name                                      This string represents the basename of the Admin
-     *                                                                Page init. The init file must use this basename
-     *                                                                in its name and class (i.e.
-     *                                                                {page_basename}_Admin_Page_Init.core.php).
-     * @param array  $setup_args                                      {              An array of configuration options
-     *                                                                that will be used in different circumstances
-     *
-     * @type  string $page_path                                       This is the path where the registered admin pages
-     *        reside ( used to setup autoloaders).
-     *
-     *    }
-     * @return bool
-     * @throws EE_Error
-     * @since 4.3.0
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 * The purpose of this method is to provide an easy way for addons to register their admin pages (using the EE
+	 * Admin Page loader system).
+	 *
+	 * @param string $addon_name                                      This string represents the basename of the Admin
+	 *                                                                Page init. The init file must use this basename
+	 *                                                                in its name and class (i.e.
+	 *                                                                {page_basename}_Admin_Page_Init.core.php).
+	 * @param array  $setup_args                                      {              An array of configuration options
+	 *                                                                that will be used in different circumstances
+	 *
+	 * @type  string $page_path                                       This is the path where the registered admin pages
+	 *        reside ( used to setup autoloaders).
+	 *
+	 *    }
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        // check that an admin_page has not already been registered with that name
-        if (isset(self::$_ee_admin_page_registry[ $addon_name ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'An Admin Page located at %1$s has already been registered and each Admin Page requires a unique name.
+		// check that an admin_page has not already been registered with that name
+		if (isset(self::$_ee_admin_page_registry[ $addon_name ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'An Admin Page located at %1$s has already been registered and each Admin Page requires a unique name.
                         Error thrown while registering an Admin Page of the same name for the %2$s addon with the admin page path: %3$s."',
-                        'event_espresso'
-                    ),
-                    '<pre>' . (self::$_ee_admin_page_registry[ $addon_name ]['page_path']) . '</pre>',
-                    $addon_name,
-                    '<pre>' . ($setup_args['page_path'] ?? '') . '</pre>'
-                )
-            );
-        }
+						'event_espresso'
+					),
+					'<pre>' . (self::$_ee_admin_page_registry[ $addon_name ]['page_path']) . '</pre>',
+					$addon_name,
+					'<pre>' . ($setup_args['page_path'] ?? '') . '</pre>'
+				)
+			);
+		}
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['page_path'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register an Admin Page with EE_Register_Admin_Page::register(), you must include the "page_basename" (the class name of the page), and an array containing the following keys: "page_path" (the path where the registered admin pages reside)',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['page_path'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register an Admin Page with EE_Register_Admin_Page::register(), you must include the "page_basename" (the class name of the page), and an array containing the following keys: "page_path" (the path where the registered admin pages reside)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_admin_page_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_admin_page_registry[ $addon_name ])) {
+			return true;
+		}
 
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%s" as an EE Admin page has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_controllers__load_admin_controllers" hook to register Admin pages.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3'
-            );
-        }
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%s" as an EE Admin page has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_controllers__load_admin_controllers" hook to register Admin pages.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3'
+			);
+		}
 
-        // add incoming stuff to our registry property
-        self::$_ee_admin_page_registry[ $addon_name ] = [
-            'page_path' => $setup_args['page_path'],
-            'config'    => $setup_args,
-        ];
+		// add incoming stuff to our registry property
+		self::$_ee_admin_page_registry[ $addon_name ] = [
+			'page_path' => $setup_args['page_path'],
+			'config'    => $setup_args,
+		];
 
-        // add filters
-        add_filter(
-            'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
-            ['EE_Register_Admin_Page', 'set_page_path']
-        );
+		// add filters
+		add_filter(
+			'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
+			['EE_Register_Admin_Page', 'set_page_path']
+		);
 
-        return true;
-    }
+		return true;
+	}
 
 
-    /**
-     * This deregisters a EE_Admin page that is already registered.  Note, this MUST be loaded after the
-     * page being deregistered is loaded.
-     *
-     * @param string $addon_name Use whatever string was used to register the admin page.
-     * @return  void
-     * @since    4.3.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_admin_page_registry[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a EE_Admin page that is already registered.  Note, this MUST be loaded after the
+	 * page being deregistered is loaded.
+	 *
+	 * @param string $addon_name Use whatever string was used to register the admin page.
+	 * @return  void
+	 * @since    4.3.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_admin_page_registry[ $addon_name ]);
+	}
 
 
-    /**
-     * set_page_path
-     *
-     * @param array $paths
-     * @return mixed
-     * @throws EE_Error
-     */
-    public static function set_page_path(array $paths): array
-    {
-        foreach (self::$_ee_admin_page_registry as $basename => $args) {
-            EEH_Autoloader::register_autoloaders_for_each_file_in_folder($args['page_path']);
-            $paths[ $basename ] = $args['page_path'];
-        }
-        return $paths;
-    }
+	/**
+	 * set_page_path
+	 *
+	 * @param array $paths
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public static function set_page_path(array $paths): array
+	{
+		foreach (self::$_ee_admin_page_registry as $basename => $args) {
+			EEH_Autoloader::register_autoloaders_for_each_file_in_folder($args['page_path']);
+			$paths[ $basename ] = $args['page_path'];
+		}
+		return $paths;
+	}
 
-    public static function reset(): void
-    {
-        self::$_ee_admin_page_registry = [];
-    }
+	public static function reset(): void
+	{
+		self::$_ee_admin_page_registry = [];
+	}
 }

core/libraries/plugin_api/EE_Register_Messages_Template_Variations.lib.php

Indentation +311 added lines, -311 removed lines

@@ -10,339 +10,339 @@
  */
 class EE_Register_Messages_Template_Variations implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered variations
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = [];
+	/**
+	 * Holds values for registered variations
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
 
 
-    /**
-     * Used to register new variations
-     *
-     * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
-     * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
-     * style of existing structure.
-     *
-     * It's important to remember that when variation files are loaded, the file structure looked for is:
-     * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
-     *
-     *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
-     *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
-     *    you can have the correct variation loaded.
-     *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
-     *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
-     *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
-     *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
-     *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
-     *    you want it to be accurately represented in various template contexts you need to have that relevant
-     *    variation file available.
-     *    - $variation_slug  is simply the variation slug for that variation.
-     *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
-     *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
-     *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
-     *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
-     *    variation (so the template pack would be unstyled)
-     *
-     * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
-     *      messengers.
-     *
-     * @param string $addon_name                      unique reference used to describe this variation registry. If
-     *                                                this ISN'T unique then this method will make it unique (and it
-     *                                                becomes harder to deregister).
-     * @param array  $setup_args                      {
-     *                                                an array of required values for registering the variations.
-     * @type array   $variations                      {
-     *                                                An array indexed by template_pack->dbref. and values are an array
-     *                                                indexed by messenger name and values are an array indexed by
-     *                                                message_type and values are an array indexed by variation_slug
-     *                                                and value  is the localized label for the variation.  Note this
-     *                                                api reserves the "default" variation name for the default
-     *                                                template pack so you can't register a default variation.  Also,
-     *                                                try to use unique variation slugs to reference your variations
-     *                                                because this api checks if any existing variations are in place
-     *                                                with that name.  If there are then subsequent variations for that
-     *                                                template pack with that same name will fail to register with a
-     *                                                persistent notice put up for the user. Required.
-     *                                                'default' => array(
-     *                                                'email' => array(
-     *                                                'registration_approved' => array(
-     *                                                my_ee_addon_blue_lagoon' => esc_html__('Blue Lagoon',
-     *                                                'text_domain'),
-     *                                                'my_ee_addon_red_sunset' => esc_html__('Red Sunset',
-     *                                                'text_domain')
-     *                                                )
-     *                                                )
-     *                                                )
-     *                                                }
-     * @type string  $base_path                       The base path for where all your variations are found.  Although
-     *                                                the full path to your variation files should include
-     *                                                '/variations/' in it, do not include the
-     *                                                'variations/' in this. Required.
-     * @type string  $base_url                        The base url for where all your variations are found. See note
-     *                                                above about the 'variations/' string. Required.
-     *                                                }
-     *                                                }
-     *
-     * @throws EE_Error
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 * Used to register new variations
+	 *
+	 * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
+	 * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
+	 * style of existing structure.
+	 *
+	 * It's important to remember that when variation files are loaded, the file structure looked for is:
+	 * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
+	 *
+	 *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
+	 *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
+	 *    you can have the correct variation loaded.
+	 *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
+	 *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
+	 *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
+	 *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
+	 *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
+	 *    you want it to be accurately represented in various template contexts you need to have that relevant
+	 *    variation file available.
+	 *    - $variation_slug  is simply the variation slug for that variation.
+	 *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
+	 *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
+	 *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
+	 *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
+	 *    variation (so the template pack would be unstyled)
+	 *
+	 * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
+	 *      messengers.
+	 *
+	 * @param string $addon_name                      unique reference used to describe this variation registry. If
+	 *                                                this ISN'T unique then this method will make it unique (and it
+	 *                                                becomes harder to deregister).
+	 * @param array  $setup_args                      {
+	 *                                                an array of required values for registering the variations.
+	 * @type array   $variations                      {
+	 *                                                An array indexed by template_pack->dbref. and values are an array
+	 *                                                indexed by messenger name and values are an array indexed by
+	 *                                                message_type and values are an array indexed by variation_slug
+	 *                                                and value  is the localized label for the variation.  Note this
+	 *                                                api reserves the "default" variation name for the default
+	 *                                                template pack so you can't register a default variation.  Also,
+	 *                                                try to use unique variation slugs to reference your variations
+	 *                                                because this api checks if any existing variations are in place
+	 *                                                with that name.  If there are then subsequent variations for that
+	 *                                                template pack with that same name will fail to register with a
+	 *                                                persistent notice put up for the user. Required.
+	 *                                                'default' => array(
+	 *                                                'email' => array(
+	 *                                                'registration_approved' => array(
+	 *                                                my_ee_addon_blue_lagoon' => esc_html__('Blue Lagoon',
+	 *                                                'text_domain'),
+	 *                                                'my_ee_addon_red_sunset' => esc_html__('Red Sunset',
+	 *                                                'text_domain')
+	 *                                                )
+	 *                                                )
+	 *                                                )
+	 *                                                }
+	 * @type string  $base_path                       The base path for where all your variations are found.  Although
+	 *                                                the full path to your variation files should include
+	 *                                                '/variations/' in it, do not include the
+	 *                                                'variations/' in this. Required.
+	 * @type string  $base_url                        The base url for where all your variations are found. See note
+	 *                                                above about the 'variations/' string. Required.
+	 *                                                }
+	 *                                                }
+	 *
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        // check for required params
-        if (empty($addon_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($addon_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (
-            ! is_array($setup_args)
-            || empty($setup_args['variations'])
-            || empty($setup_args['base_path'])
-            || empty($setup_args['base_url'])
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
-                    'event_espresso'
-                )
-            );
-        }
+		if (
+			! is_array($setup_args)
+			|| empty($setup_args['variations'])
+			|| empty($setup_args['base_path'])
+			|| empty($setup_args['base_url'])
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
 
-        // make sure variation ref is unique.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
-        }
+		// make sure variation ref is unique.
+		if (isset(self::$_registry[ $addon_name ])) {
+			$addon_name = uniqid() . '_' . $addon_name;
+		}
 
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.5.0'
-            );
-        }
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.5.0'
+			);
+		}
 
-        // validate/sanitize incoming args.
-        $validated = [
-            'variations' => (array) $setup_args['variations'],
-            'base_path'  => (string) $setup_args['base_path'],
-            'base_url'   => (string) $setup_args['base_url'],
-        ];
+		// validate/sanitize incoming args.
+		$validated = [
+			'variations' => (array) $setup_args['variations'],
+			'base_path'  => (string) $setup_args['base_path'],
+			'base_url'   => (string) $setup_args['base_url'],
+		];
 
 
-        // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
-        $validated                      = self::_verify_variations($addon_name, $validated);
-        self::$_registry[ $addon_name ] = $validated;
+		// check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
+		$validated                      = self::_verify_variations($addon_name, $validated);
+		self::$_registry[ $addon_name ] = $validated;
 
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variations',
-            ['EE_Register_Messages_Template_Variations', 'get_variations'],
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variation',
-            ['EE_Register_Messages_Template_Variations', 'get_variation'],
-            10,
-            8
-        );
-        return true;
-    }
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variations',
+			['EE_Register_Messages_Template_Variations', 'get_variations'],
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variation',
+			['EE_Register_Messages_Template_Variations', 'get_variation'],
+			10,
+			8
+		);
+		return true;
+	}
 
 
-    /**
-     * Cycles through the variations registered and makes sure there are no reserved variations being registered which
-     * throws an error.  Also checks if there is already a
-     *
-     * @param string $addon_name           the reference for the variations being registered
-     * @param array  $validated_variations The variations setup array that's being registered (and verified).
-     * @return array
-     * @throws EE_Error
-     * @since  4.5.0
-     *
-     */
-    private static function _verify_variations(string $addon_name, array $validated_variations): array
-    {
-        foreach (self::$_registry as $settings) {
-            foreach ($settings['variations'] as $messenger) {
-                foreach ($messenger as $all_variations) {
-                    if (isset($all_variations['default'])) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
-                                    'event_espresso'
-                                ),
-                                $addon_name
-                            )
-                        );
-                    }
-                }
-            }
-        }
+	/**
+	 * Cycles through the variations registered and makes sure there are no reserved variations being registered which
+	 * throws an error.  Also checks if there is already a
+	 *
+	 * @param string $addon_name           the reference for the variations being registered
+	 * @param array  $validated_variations The variations setup array that's being registered (and verified).
+	 * @return array
+	 * @throws EE_Error
+	 * @since  4.5.0
+	 *
+	 */
+	private static function _verify_variations(string $addon_name, array $validated_variations): array
+	{
+		foreach (self::$_registry as $settings) {
+			foreach ($settings['variations'] as $messenger) {
+				foreach ($messenger as $all_variations) {
+					if (isset($all_variations['default'])) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
+									'event_espresso'
+								),
+								$addon_name
+							)
+						);
+					}
+				}
+			}
+		}
 
-        // is there already a variation registered with a given variation slug?
-        foreach ($validated_variations['variations'] as $template_pack => $messenger) {
-            foreach ($messenger as $message_type => $variations) {
-                foreach ($variations as $slug => $label) {
-                    foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
-                            EE_Error::add_error(
-                                sprintf(
-                                    esc_html__(
-                                        'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
-                                        'event_espresso'
-                                    ),
-                                    $label,
-                                    $template_pack,
-                                    $messenger,
-                                    $message_type,
-                                    $registered_var
-                                )
-                            );
-                        }
-                    }
-                }
-            }
-        }
-        return $validated_variations;
-    }
+		// is there already a variation registered with a given variation slug?
+		foreach ($validated_variations['variations'] as $template_pack => $messenger) {
+			foreach ($messenger as $message_type => $variations) {
+				foreach ($variations as $slug => $label) {
+					foreach (self::$_registry as $registered_var => $reg_settings) {
+						if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
+							unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+							EE_Error::add_error(
+								sprintf(
+									esc_html__(
+										'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
+										'event_espresso'
+									),
+									$label,
+									$template_pack,
+									$messenger,
+									$message_type,
+									$registered_var
+								)
+							);
+						}
+					}
+				}
+			}
+		}
+		return $validated_variations;
+	}
 
 
-    /**
-     * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
-     *
-     * @param string                    $variation_path The path generated for the current variation
-     * @param string                    $messenger      The messenger the variation is for
-     * @param string                    $message_type   EE_message_type->name
-     * @param string                    $type           The type of variation being requested
-     * @param string                    $variation      The slug for the variation being requested
-     * @param string                    $file_extension What the file extension is for the variation
-     * @param bool                      $url            Whether url or path is being returned.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string                    The path to the requested variation.
-     * @since 4.5.0
-     *
-     */
-    public static function get_variation(
-        string $variation_path,
-        string $messenger,
-        string $message_type,
-        string $type,
-        string $variation,
-        string $file_extension,
-        bool $url,
-        EE_Messages_Template_Pack $template_pack
-    ): string {
-        // so let's loop through our registered variations and then pull any details matching the request.
-        foreach (self::$_registry as $registry_settings) {
-            $base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
-            // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
-            }
-        }
+	/**
+	 * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
+	 *
+	 * @param string                    $variation_path The path generated for the current variation
+	 * @param string                    $messenger      The messenger the variation is for
+	 * @param string                    $message_type   EE_message_type->name
+	 * @param string                    $type           The type of variation being requested
+	 * @param string                    $variation      The slug for the variation being requested
+	 * @param string                    $file_extension What the file extension is for the variation
+	 * @param bool                      $url            Whether url or path is being returned.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string                    The path to the requested variation.
+	 * @since 4.5.0
+	 *
+	 */
+	public static function get_variation(
+		string $variation_path,
+		string $messenger,
+		string $message_type,
+		string $type,
+		string $variation,
+		string $file_extension,
+		bool $url,
+		EE_Messages_Template_Pack $template_pack
+	): string {
+		// so let's loop through our registered variations and then pull any details matching the request.
+		foreach (self::$_registry as $registry_settings) {
+			$base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
+			$file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+			// see if this file exists
+			if (is_readable($registry_settings['base_path'] . $file_string)) {
+				return $base . $file_string;
+			}
+		}
 
-        // no match
-        return $variation_path;
-    }
+		// no match
+		return $variation_path;
+	}
 
 
-    /**
-     * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
-     *
-     *
-     * @param array                     $variations The original contents for the template pack variations property.
-     * @param string                    $messenger  The messenger requesting the variations.
-     * @param string                    $message_type
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return array                   new variations array (or existing one if nothing registered)
-     * @since 4.5.0
-     *
-     * @see   $_variation property definition in EE_Messages_Template_Pack
-     */
-    public static function get_variations(
-        array $variations,
-        string $messenger,
-        string $message_type,
-        EE_Messages_Template_Pack $template_pack
-    ): array {
-        // first let's check if we even have registered variations and get out early.
-        if (empty(self::$_registry)) {
-            return $variations;
-        }
-        $template_variations = [];
-        // do we have any new variations for the given messenger, $message_type, and template packs
-        foreach (self::$_registry as $registry_settings) {
-            // allow for different conditions.
-            if (empty($messenger)) {
-                return array_merge($registry_settings['variations'], $variations);
-            }
-            if (empty($message_type)) {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
-                    return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
-                        $variations
-                    );
-                }
-            } else {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
-                    return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
-                        $variations
-                    );
-                }
-            }
-        }
-        return array_merge($variations, ...$template_variations);
-    }
+	/**
+	 * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
+	 *
+	 *
+	 * @param array                     $variations The original contents for the template pack variations property.
+	 * @param string                    $messenger  The messenger requesting the variations.
+	 * @param string                    $message_type
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return array                   new variations array (or existing one if nothing registered)
+	 * @since 4.5.0
+	 *
+	 * @see   $_variation property definition in EE_Messages_Template_Pack
+	 */
+	public static function get_variations(
+		array $variations,
+		string $messenger,
+		string $message_type,
+		EE_Messages_Template_Pack $template_pack
+	): array {
+		// first let's check if we even have registered variations and get out early.
+		if (empty(self::$_registry)) {
+			return $variations;
+		}
+		$template_variations = [];
+		// do we have any new variations for the given messenger, $message_type, and template packs
+		foreach (self::$_registry as $registry_settings) {
+			// allow for different conditions.
+			if (empty($messenger)) {
+				return array_merge($registry_settings['variations'], $variations);
+			}
+			if (empty($message_type)) {
+				if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+					return array_merge(
+						$registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+						$variations
+					);
+				}
+			} else {
+				if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+					return array_merge(
+						$registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+						$variations
+					);
+				}
+			}
+		}
+		return array_merge($variations, ...$template_variations);
+	}
 
 
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @param string $addon_name The name for the variation set that was previously registered.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_registry[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @param string $addon_name The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_registry[ $addon_name ]);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_registry = [];
-    }
+	public static function reset(): void
+	{
+		self::$_registry = [];
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -118,13 +118,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
 
         // make sure variation ref is unique.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
+        if (isset(self::$_registry[$addon_name])) {
+            $addon_name = uniqid().'_'.$addon_name;
         }
 
 
@@ -156,7 +156,7 @@ 
 
         // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
         $validated                      = self::_verify_variations($addon_name, $validated);
-        self::$_registry[ $addon_name ] = $validated;
+        self::$_registry[$addon_name] = $validated;
 
         add_filter(
             'FHEE__EE_Messages_Template_Pack__get_variations',
@@ -210,8 +210,8 @@ 
             foreach ($messenger as $message_type => $variations) {
                 foreach ($variations as $slug => $label) {
                     foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+                        if (isset($reg_settings['variations'][$template_pack][$messenger][$message_type][$slug])) {
+                            unset($validated_variations['variations'][$template_pack][$messenger][$message_type][$slug]);
                             EE_Error::add_error(
                                 sprintf(
                                     esc_html__(
@@ -263,10 +263,10 @@ 
         // so let's loop through our registered variations and then pull any details matching the request.
         foreach (self::$_registry as $registry_settings) {
             $base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+            $file_string = $messenger.'_'.$type.'_'.$variation.$file_extension;
             // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
+            if (is_readable($registry_settings['base_path'].$file_string)) {
+                return $base.$file_string;
             }
         }
 
@@ -307,16 +307,16 @@ 
                 return array_merge($registry_settings['variations'], $variations);
             }
             if (empty($message_type)) {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+                if ( ! empty($registry_settings['variations'][$template_pack->dbref][$messenger])) {
                     return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+                        $registry_settings['variations'][$template_pack->dbref][$messenger],
                         $variations
                     );
                 }
             } else {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+                if ( ! empty($registry_settings['variations'][$template_pack->dbref][$messenger][$message_type])) {
                     return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+                        $registry_settings['variations'][$template_pack->dbref][$messenger][$message_type],
                         $variations
                     );
                 }
@@ -337,7 +337,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_registry[ $addon_name ]);
+        unset(self::$_registry[$addon_name]);
     }
 
 

core/libraries/plugin_api/EE_Register_Module.lib.php

Indentation +90 added lines, -90 removed lines

@@ -14,104 +14,104 @@
  */
 class EE_Register_Module implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered modules
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered modules
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EED_Modules
-     *
-     * @param string $addon_name a unique identifier for this set of modules Required.
-     * @param array  $setup_args an array of full server paths to folders containing any EED_Modules, or to the
-     *                           EED_Module files themselves Required.
-     * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
-     *                           EED_Module files themselves
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EED_Modules
+	 *
+	 * @param string $addon_name a unique identifier for this set of modules Required.
+	 * @param array  $setup_args an array of full server paths to folders containing any EED_Modules, or to the
+	 *                           EED_Module files themselves Required.
+	 * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
+	 *                           EED_Module files themselves
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // array of full server paths to any EED_Modules used by the module
-            'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            ['EE_Register_Module', 'add_modules']
-        );
-        return true;
-    }
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// array of full server paths to any EED_Modules used by the module
+			'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			['EE_Register_Module', 'add_modules']
+		);
+		return true;
+	}
 
 
-    /**
-     * Filters the list of modules to add ours.
-     * and they're just full filepaths to FOLDERS containing a module class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
-     *
-     * @param array $modules_to_register array of paths to all modules that require registering
-     * @return array
-     */
-    public static function add_modules(array $modules_to_register): array
-    {
-        $module_paths = [];
-        foreach (self::$_settings as $settings) {
-            $module_paths[] = $settings['module_paths'];
-        }
-        return array_merge($modules_to_register, ...$module_paths);
-    }
+	/**
+	 * Filters the list of modules to add ours.
+	 * and they're just full filepaths to FOLDERS containing a module class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
+	 *
+	 * @param array $modules_to_register array of paths to all modules that require registering
+	 * @return array
+	 */
+	public static function add_modules(array $modules_to_register): array
+	{
+		$module_paths = [];
+		foreach (self::$_settings as $settings) {
+			$module_paths[] = $settings['module_paths'];
+		}
+		return array_merge($modules_to_register, ...$module_paths);
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the module that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the module that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -66,7 +66,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // array of full server paths to any EED_Modules used by the module
             'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
         ];
@@ -106,7 +106,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 
 

core/libraries/plugin_api/EE_Register_Data_Migration_Scripts.lib.php

Indentation +99 added lines, -99 removed lines

@@ -14,111 +14,111 @@
  */
 class EE_Register_Data_Migration_Scripts implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered DMSs
-     *
-     * @var array[][]
-     */
-    protected static array $_settings = [];
+	/**
+	 * Holds values for registered DMSs
+	 *
+	 * @var array[][]
+	 */
+	protected static array $_settings = [];
 
 
-    /**
-     * Method for registering new Data Migration Scripts
-     *
-     * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
-     *                           If EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-     * @param array  $setup_args {
-     * @type string  $dms_paths  an array of full server paths to folders that contain data migration scripts
-     *                           }
-     * @return bool
-     * @throws EE_Error
-     * @since 4.3.0
-     * @since 4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include the EE_Addon class name (used as a unique identifier for this set of data migration scripts), and an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = ['dms_paths' => (array) $setup_args['dms_paths']];
-        // setup DMS
-        $filters_set = has_filter(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
-        );
-        if (! $filters_set) {
-            add_filter(
-                'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-                ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
-            );
-        }
-        return true;
-    }
+	/**
+	 * Method for registering new Data Migration Scripts
+	 *
+	 * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
+	 *                           If EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+	 * @param array  $setup_args {
+	 * @type string  $dms_paths  an array of full server paths to folders that contain data migration scripts
+	 *                           }
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 * @since 4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include the EE_Addon class name (used as a unique identifier for this set of data migration scripts), and an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = ['dms_paths' => (array) $setup_args['dms_paths']];
+		// setup DMS
+		$filters_set = has_filter(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
+		);
+		if (! $filters_set) {
+			add_filter(
+				'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+				['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * @param array $dms_paths
-     * @return array
-     */
-    public static function add_data_migration_script_folders(array $dms_paths = []): array
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            $wildcards = 0;
-            foreach ($settings['dms_paths'] as $dms_path) {
-                // since we are using the addon name for the array key
-                // we need to ensure that the key is unique,
-                // so if for some reason an addon has multiple dms paths,
-                // we append one or more * to the classname
-                // which will get stripped out later on
-                $dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
-                $wildcards++;
-            }
-        }
-        return $dms_paths;
-    }
+	/**
+	 * @param array $dms_paths
+	 * @return array
+	 */
+	public static function add_data_migration_script_folders(array $dms_paths = []): array
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			$wildcards = 0;
+			foreach ($settings['dms_paths'] as $dms_path) {
+				// since we are using the addon name for the array key
+				// we need to ensure that the key is unique,
+				// so if for some reason an addon has multiple dms paths,
+				// we append one or more * to the classname
+				// which will get stripped out later on
+				$dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
+				$wildcards++;
+			}
+		}
+		return $dms_paths;
+	}
 
 
-    /**
-     * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
-     *
-     * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
-     * @return void
-     * @since 4.3.0
-     * @since 4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
+	 *
+	 * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
+	 * @return void
+	 * @since 4.3.0
+	 * @since 4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -47,7 +47,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
         // make sure this was called in the right place!
@@ -65,13 +65,13 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = ['dms_paths' => (array) $setup_args['dms_paths']];
+        self::$_settings[$addon_name] = ['dms_paths' => (array) $setup_args['dms_paths']];
         // setup DMS
         $filters_set = has_filter(
             'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
             ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
         );
-        if (! $filters_set) {
+        if ( ! $filters_set) {
             add_filter(
                 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
                 ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
@@ -95,7 +95,7 @@ 
                 // so if for some reason an addon has multiple dms paths,
                 // we append one or more * to the classname
                 // which will get stripped out later on
-                $dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
+                $dms_paths[$addon_name.str_repeat('*', $wildcards)] = $dms_path;
                 $wildcards++;
             }
         }
@@ -113,7 +113,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }