eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Type_Collection.lib.php

Indentation +164 added lines, -164 removed lines

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

Spacing +1 added lines, -1 removed lines

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

core/libraries/messages/defaults/default/html_receipt_ticket_line_item_no_pms.template.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 <tr class="item">
     <td>[LINE_ITEM_NAME][LINE_ITEM_TAXABLE_*]</td>
     <td colspan="2">[LINE_ITEM_DESCRIPTION]
-        <p class="ticket-note"><?php echo sprintf(__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema=' . __('any', 'event_espresso') . ']'); ?></p>
+        <p class="ticket-note"><?php echo sprintf(__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema='.__('any', 'event_espresso').']'); ?></p>
     </td>
     <td class="item_c">[LINE_ITEM_QUANTITY]</td>
     <td class="item_c">[LINE_ITEM_AMOUNT]</td>

core/libraries/messages/defaults/default/html_receipt_ticket_list.template.php

Spacing +3 added lines, -3 removed lines

@@ -22,13 +22,13 @@ 
         <div class="ticket-time-and-place-details">
             <div class="ticket-time-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo EE_IMAGES_URL . 'clock-16x16.png'; ?>"><?php _e('Date/Time:', 'event_espresso'); ?>
+                    <img class="icon" src="<?php echo EE_IMAGES_URL.'clock-16x16.png'; ?>"><?php _e('Date/Time:', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-dates">[DATETIME_LIST]</ul>
             </div>
             <div class="ticket-place-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo EE_IMAGES_URL . 'location-pin-16x16.png'; ?>"><?php _e('Venue', 'event_espresso'); ?>
+                    <img class="icon" src="<?php echo EE_IMAGES_URL.'location-pin-16x16.png'; ?>"><?php _e('Venue', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-venues">
                     <li>[VENUE_TITLE]
@@ -39,7 +39,7 @@ 
         </div>
         <div class="ticket-registrations-area">
             <h4 class="sub-section-title">
-                <img class="icon" src="<?php echo EE_IMAGES_URL . 'users-16x16.png'; ?>"><?php _e("Registration Details", "event_espresso"); ?>
+                <img class="icon" src="<?php echo EE_IMAGES_URL.'users-16x16.png'; ?>"><?php _e("Registration Details", "event_espresso"); ?>
                 <span class="small-text link">( <a class="print_button noPrint" href="[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]"><?php _e('edit', 'event_espresso'); ?></a> )</span>
             </h4>
             <ul class="ticket-registrations-list">[ATTENDEE_LIST]</ul>

core/libraries/messages/defaults/default/html_receipt_attendee_list.template.php

Spacing +2 added lines, -2 removed lines

@@ -6,11 +6,11 @@
 <li class="ticket-registration">
     <table class="registration-details">
         <tr class="odd">
-            <th><?php	_e('Attendee', 'event_espresso');?></th>
+            <th><?php	_e('Attendee', 'event_espresso'); ?></th>
             <td>[FNAME] [LNAME] ([ATTENDEE_EMAIL])</td>
         </tr>
         <tr>
-            <th><?php _e("Registration Code:", "event_espresso");?></th>
+            <th><?php _e("Registration Code:", "event_espresso"); ?></th>
             <td>[REGISTRATION_CODE] - <span class="[REGISTRATION_STATUS_ID]">[REGISTRATION_STATUS_LABEL]</span></td>
         </tr>
     </table>

core/libraries/messages/defaults/EE_Messages_Template_Defaults.lib.php

Spacing +6 added lines, -6 removed lines

@@ -113,9 +113,9 @@ 
         // get the corresponding template pack object (if present.  If not then we just load the default and add a
         // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
         // the incoming template pack reference.
-        $class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+        $class_name = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
 
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -160,7 +160,7 @@ 
     {
         $template_pack = 'default';
         // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
+        if ( ! empty($this->_GRP_ID)) {
             $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
             $template_pack = $message_template_group instanceof EE_Message_Template_Group
                 ? $message_template_group->get_template_pack_name()
@@ -206,17 +206,17 @@ 
             $this->_GRP_ID = $grp_id;
         }
 
-        $template_data = array( 'GRP_ID' => $this->_GRP_ID );
+        $template_data = array('GRP_ID' => $this->_GRP_ID);
 
         foreach ($this->_contexts as $context => $details) {
             foreach ($this->_fields as $field => $field_type) {
                 if ($field != 'extra') {
                     $template_data['MTP_context'] = $context;
                     $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
+                    $template_data['MTP_content'] = $this->_templates[$context][$field];
 
                     $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
+                    if ( ! $MTP) {
                         EE_Error::add_error(
                             sprintf(
                                 __(

Indentation +228 added lines, -228 removed lines

@@ -15,232 +15,232 @@
 {
 
 
-    /**
-     * Used for holding the EE_Message_Template GRP_ID field value.
-     * @var [type]
-     */
-    protected $_GRP_ID;
-
-    /**
-     * holds the messenger object
-     *
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-    /**
-     * holds the message type object
-     *
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-    /**
-     * holds the fields used (this is retrieved from the messenger)
-     *
-     * @var array
-     */
-    protected $_fields;
-
-    /**
-     * holds the assembled template (with defaults) for creation in the database
-     *
-     * @var array
-     */
-    protected $_templates;
-
-    /**
-     * holds the contexts used (this is retrieved from the message type)
-     *
-     * @var array
-     */
-    protected $_contexts;
-
-
-    /**
-     *  @var EEM_Message_Template_Group
-     */
-    protected $_message_template_group_model;
-
-
-    /**
-     * @var EEM_Message_Template
-     */
-    protected $_message_template_model;
-
-
-    /**
-     * EE_Messages_Template_Defaults constructor.
-     *
-     * @param EE_messenger               $messenger
-     * @param EE_message_type            $message_type
-     * @param int                        $GRP_ID                      Optional.  If included then we're just regenerating
-     *                                                                the template fields for the given group not the
-     *                                                                message template group itself
-     * @param EEM_Message_Template_Group $message_template_group_model
-     * @param EEM_Message_Template       $message_template_model
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $GRP_ID = 0,
-        EEM_Message_Template_Group $message_template_group_model,
-        EEM_Message_Template $message_template_model
-    ) {
-        $this->_messenger = $messenger;
-        $this->_message_type = $message_type;
-        $this->_GRP_ID = $GRP_ID;
-        // set the model object
-        $this->_message_template_group_model = $message_template_group_model;
-        $this->_message_template_model = $message_template_model;
-        $this->_fields = $this->_messenger->get_template_fields();
-        $this->_contexts = $this->_message_type->get_contexts();
-    }
-
-
-    /**
-     * Setup the _template_data property.
-     * This method sets the _templates property array before templates are created.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference which will contain information
-     *                              about where to obtain the templates.
-     *
-     */
-    final private function _set_templates($template_pack)
-    {
-
-        // get the corresponding template pack object (if present.  If not then we just load the default and add a
-        // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
-        // the incoming template pack reference.
-        $class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
-
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
-                        'event_espresso'
-                    ),
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = 'EE_Messages_Template_Pack_Default';
-        }
-        /** @type EE_Messages_Template_Pack $template_pack */
-        $template_pack = new $class_name();
-
-        // get all the templates from the template pack.
-        $this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
-    }
-
-
-    /**
-     * Return the contexts for the message type as cached on this instance.
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-
-
-
-    /**
-     * public facing create new templates method
-     *
-     * @return mixed (array|bool)            success array or false.
-     */
-    public function create_new_templates()
-    {
-        $template_pack = 'default';
-        // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
-            $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
-            $template_pack = $message_template_group instanceof EE_Message_Template_Group
-                ? $message_template_group->get_template_pack_name()
-                : 'default';
-            // we also need to reset the template variation to default
-            $message_template_group->set_template_pack_variation('default');
-        }
-        return $this->_create_new_templates($template_pack);
-    }
-
-
-
-
-
-    /**
-     *  Handles creating new default templates.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference
-     *                              which will contain information about where to obtain the templates.
-     * @return mixed (array|bool)   success array or false.
-     */
-    protected function _create_new_templates($template_pack)
-    {
-
-        $this->_set_templates($template_pack);
-
-        // necessary properties are set, let's save the default templates
-        if (empty($this->_GRP_ID)) {
-            $main_template_data = array(
-                'MTP_messenger'    => $this->_messenger->name,
-                'MTP_message_type' => $this->_message_type->name,
-                'MTP_is_override'  => 0,
-                'MTP_deleted'      => 0,
-                'MTP_is_global'    => 1,
-                'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
-                'MTP_is_active'    => 1,
-            );
-            // let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
-            $grp_id = $this->_message_template_group_model->insert($main_template_data);
-            if (empty($grp_id)) {
-                return $grp_id;
-            }
-            $this->_GRP_ID = $grp_id;
-        }
-
-        $template_data = array( 'GRP_ID' => $this->_GRP_ID );
-
-        foreach ($this->_contexts as $context => $details) {
-            foreach ($this->_fields as $field => $field_type) {
-                if ($field != 'extra') {
-                    $template_data['MTP_context'] = $context;
-                    $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
-
-                    $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
-                                    'event_espresso'
-                                ),
-                                $this->_messenger->name,
-                                $this->_message_type->name,
-                                $context,
-                                $field
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                }
-            }
-        }
-
-        return array(
-            'GRP_ID'      => $this->_GRP_ID,
-            'MTP_context' => key($this->_contexts)
-        );
-    }
+	/**
+	 * Used for holding the EE_Message_Template GRP_ID field value.
+	 * @var [type]
+	 */
+	protected $_GRP_ID;
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+	/**
+	 * holds the fields used (this is retrieved from the messenger)
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+	/**
+	 * holds the assembled template (with defaults) for creation in the database
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+	/**
+	 * holds the contexts used (this is retrieved from the message type)
+	 *
+	 * @var array
+	 */
+	protected $_contexts;
+
+
+	/**
+	 *  @var EEM_Message_Template_Group
+	 */
+	protected $_message_template_group_model;
+
+
+	/**
+	 * @var EEM_Message_Template
+	 */
+	protected $_message_template_model;
+
+
+	/**
+	 * EE_Messages_Template_Defaults constructor.
+	 *
+	 * @param EE_messenger               $messenger
+	 * @param EE_message_type            $message_type
+	 * @param int                        $GRP_ID                      Optional.  If included then we're just regenerating
+	 *                                                                the template fields for the given group not the
+	 *                                                                message template group itself
+	 * @param EEM_Message_Template_Group $message_template_group_model
+	 * @param EEM_Message_Template       $message_template_model
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$GRP_ID = 0,
+		EEM_Message_Template_Group $message_template_group_model,
+		EEM_Message_Template $message_template_model
+	) {
+		$this->_messenger = $messenger;
+		$this->_message_type = $message_type;
+		$this->_GRP_ID = $GRP_ID;
+		// set the model object
+		$this->_message_template_group_model = $message_template_group_model;
+		$this->_message_template_model = $message_template_model;
+		$this->_fields = $this->_messenger->get_template_fields();
+		$this->_contexts = $this->_message_type->get_contexts();
+	}
+
+
+	/**
+	 * Setup the _template_data property.
+	 * This method sets the _templates property array before templates are created.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference which will contain information
+	 *                              about where to obtain the templates.
+	 *
+	 */
+	final private function _set_templates($template_pack)
+	{
+
+		// get the corresponding template pack object (if present.  If not then we just load the default and add a
+		// notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
+		// the incoming template pack reference.
+		$class_name = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
+						'event_espresso'
+					),
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = 'EE_Messages_Template_Pack_Default';
+		}
+		/** @type EE_Messages_Template_Pack $template_pack */
+		$template_pack = new $class_name();
+
+		// get all the templates from the template pack.
+		$this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
+	}
+
+
+	/**
+	 * Return the contexts for the message type as cached on this instance.
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+
+
+
+	/**
+	 * public facing create new templates method
+	 *
+	 * @return mixed (array|bool)            success array or false.
+	 */
+	public function create_new_templates()
+	{
+		$template_pack = 'default';
+		// if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
+		if (! empty($this->_GRP_ID)) {
+			$message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
+			$template_pack = $message_template_group instanceof EE_Message_Template_Group
+				? $message_template_group->get_template_pack_name()
+				: 'default';
+			// we also need to reset the template variation to default
+			$message_template_group->set_template_pack_variation('default');
+		}
+		return $this->_create_new_templates($template_pack);
+	}
+
+
+
+
+
+	/**
+	 *  Handles creating new default templates.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference
+	 *                              which will contain information about where to obtain the templates.
+	 * @return mixed (array|bool)   success array or false.
+	 */
+	protected function _create_new_templates($template_pack)
+	{
+
+		$this->_set_templates($template_pack);
+
+		// necessary properties are set, let's save the default templates
+		if (empty($this->_GRP_ID)) {
+			$main_template_data = array(
+				'MTP_messenger'    => $this->_messenger->name,
+				'MTP_message_type' => $this->_message_type->name,
+				'MTP_is_override'  => 0,
+				'MTP_deleted'      => 0,
+				'MTP_is_global'    => 1,
+				'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
+				'MTP_is_active'    => 1,
+			);
+			// let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
+			$grp_id = $this->_message_template_group_model->insert($main_template_data);
+			if (empty($grp_id)) {
+				return $grp_id;
+			}
+			$this->_GRP_ID = $grp_id;
+		}
+
+		$template_data = array( 'GRP_ID' => $this->_GRP_ID );
+
+		foreach ($this->_contexts as $context => $details) {
+			foreach ($this->_fields as $field => $field_type) {
+				if ($field != 'extra') {
+					$template_data['MTP_context'] = $context;
+					$template_data['MTP_template_field'] = $field;
+					$template_data['MTP_content'] = $this->_templates[ $context ][ $field ];
+
+					$MTP = $this->_message_template_model->insert($template_data);
+					if (! $MTP) {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
+									'event_espresso'
+								),
+								$this->_messenger->name,
+								$this->_message_type->name,
+								$context,
+								$field
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				}
+			}
+		}
+
+		return array(
+			'GRP_ID'      => $this->_GRP_ID,
+			'MTP_context' => key($this->_contexts)
+		);
+	}
 }

core/libraries/messages/EE_Messages_Template_Pack_Collection.lib.php

Indentation +14 added lines, -14 removed lines

@@ -11,19 +11,19 @@
 {
 
 
-    public function __construct()
-    {
-        $this->interface = 'EE_Messages_Template_Pack';
-    }
+	public function __construct()
+	{
+		$this->interface = 'EE_Messages_Template_Pack';
+	}
 
-    public function get_by_name($template_pack_name)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->dbref == $template_pack_name) {
-                return $this->current();
-            }
-            $this->next();
-        }
-    }
+	public function get_by_name($template_pack_name)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->dbref == $template_pack_name) {
+				return $this->current();
+			}
+			$this->next();
+		}
+	}
 }

core/libraries/messages/EE_Message_Factory.lib.php

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
     public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
     {
         // 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;
@@ -127,7 +127,7 @@ 
     protected function _create($props_n_values = array())
     {
         $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);

Indentation +171 added lines, -171 removed lines

@@ -15,175 +15,175 @@
 {
 
 
-    /**
-     * @type EE_Message_Factory $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-
-
-    /**
-     * EE_Message_Factory constructor.
-     *
-     * @access protected
-     * @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)
-    {
-        // 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;
-    }
-
-
-
-    /**
-     * @access public
-     * @param  array $props_n_values
-     * @return EE_Message
-     */
-    public static function create($props_n_values = array())
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_create($props_n_values);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger_and_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger_and_message_type($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_message_type($message);
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  array $props_n_values
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _create($props_n_values = array())
-    {
-        $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);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message = $this->_set_messenger($message);
-        $message = $this->_set_message_type($message, $new_instance);
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger(EE_Message $message)
-    {
-        $messenger = $this->_message_resource_manager->get_messenger($message->messenger());
-        if ($messenger instanceof EE_messenger) {
-            $message->set_messenger_object($messenger);
-        }
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_message_type(EE_Message $message, $new_instance = false)
-    {
-        $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;
-    }
+	/**
+	 * @type EE_Message_Factory $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+
+
+	/**
+	 * EE_Message_Factory constructor.
+	 *
+	 * @access protected
+	 * @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)
+	{
+		// 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;
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  array $props_n_values
+	 * @return EE_Message
+	 */
+	public static function create($props_n_values = array())
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger_and_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  array $props_n_values
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _create($props_n_values = array())
+	{
+		$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);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger(EE_Message $message)
+	{
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
+		}
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_message_type(EE_Message $message, $new_instance = false)
+	{
+		$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;
+	}
 }

core/libraries/messages/EE_Messages_Processor.lib.php

Indentation +582 added lines, -582 removed lines

@@ -12,590 +12,590 @@
 {
 
 
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @type EE_Messages_Queue
-     */
-    protected $_queue;
-
-    /**
-     * @type  EE_Messages_Generator
-     */
-    protected $_generator;
-
-
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct(EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->_message_resource_manager = $message_resource_manager;
-        $this->_init_queue_and_generator();
-    }
-
-
-
-
-    /**
-     * This method sets (or resets) the various properties for use.
-     *
-     * - $_queue = holds the messages queue
-     * - $_generator = holds the messages generator
-     */
-    protected function _init_queue_and_generator()
-    {
-        $this->_generator = EE_Registry::factory('EE_Messages_Generator');
-        $this->_queue = $this->_generator->generation_queue();
-    }
-
-
-
-
-    /**
-     * This returns the current set queue.
-     * @return EE_Messages_Queue
-     */
-    public function get_queue()
-    {
-        return $this->_queue;
-    }
-
-
-
-    /**
-     * This method can be utilized to process messages from a queue and they will be processed immediately on the same request.
-     * Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes client code
-     * has already filtered those if necessary).
-     *
-     * @param EE_Messages_Queue $queue_to_process
-     * @return bool  true for success false for error.
-     */
-    public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
-    {
-        $success = false;
-        $messages_to_send = array();
-        $messages_to_generate = array();
-        // loop through and setup the various messages from the queue so we know what is being processed
-        $queue_to_process->get_message_repository()->rewind();
-        foreach ($queue_to_process->get_message_repository() as $message) {
-            if ($message->STS_ID() === EEM_Message::status_incomplete) {
-                $messages_to_generate[] = $message;
-                continue;
-            }
-
-            if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $messages_to_send[] = $message;
-                continue;
-            }
-        }
-
-        // do generation/sends
-        if ($messages_to_generate) {
-            $success = $this->batch_generate_from_queue($messages_to_generate, true);
-        }
-
-        if ($messages_to_send) {
-            $sent = $this->batch_send_from_queue($messages_to_send, true);
-            // if there was messages to generate and it failed, then we override any success value for the sending process
-            // otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
-            // Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
-            // all messages processing on the same request.
-            $success = $messages_to_generate && ! $success ? false : $sent;
-        }
-        return $success;
-    }
-
-
-    /**
-     * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
-     *
-     * @param  EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
-     * @param  bool         $clear_queue Whether to ensure a fresh queue or not.
-     *
-     * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
-     *                                   generated messages.
-     */
-    public function batch_generate_from_queue($messages = array(), $clear_queue = false)
-    {
-        if ($this->_build_queue_for_generation($messages, $clear_queue)) {
-            $new_queue = $this->_generator->generate();
-            if ($new_queue instanceof EE_Messages_Queue) {
-                // unlock queue
-                $this->_queue->unlock_queue();
-                $new_queue->initiate_request_by_priority('send');
-                return $new_queue;
-            }
-        }
-        $this->_queue->unlock_queue();
-        return false;
-    }
-
-
-
-    /**
-     * This method preps a queue for generation.
-     *
-     * @since    4.9.0
-     *
-     * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
-     *
-     * @param   bool       $clear_queue This indicates whether the existing queue should be dumped or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no generation please.
-     */
-    protected function _build_queue_for_generation($messages = array(), $clear_queue = false)
-    {
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        if ($messages) {
-            // if generation is locked then get out now because that means processing is already happening.
-            if ($this->_queue->is_locked()) {
-                return false;
-            }
-
-            $this->_queue->lock_queue();
-            $messages = is_array($messages) ? $messages : array( $messages );
-            foreach ($messages as $message) {
-                if ($message instanceof EE_Message) {
-                    $data = $message->all_extra_meta_array();
-                    $this->_queue->add($message, $data);
-                }
-            }
-            return true;
-        } else {
-            return $this->_queue->get_batch_to_generate();
-        }
-    }
-
-
-    /**
-     * This method preps a queue for sending.
-     *
-     * @param EE_Message[] $messages
-     * @param bool  $clear_queue Used to indicate whether to start with a fresh queue or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no queue prepped.
-     */
-    protected function _build_queue_for_sending($messages, $clear_queue = false)
-    {
-        // if sending is locked then get out now because that means processing is already happening.
-        if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->_queue->lock_queue(EE_Messages_Queue::action_sending);
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        $messages = is_array($messages) ? $messages : array( $messages );
-
-        foreach ($messages as $message) {
-            $this->_queue->add($message);
-        }
-        return true;
-    }
-
-
-    /**
-     * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls EE_Message_Queue::execute()
-     * to iterate and send unsent messages.
-     *
-     * @param EE_Message[] $messages    If an array of messages is sent in then use it.
-     *
-     * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
-     *
-     * @return EE_Messages_Queue
-     */
-    public function batch_send_from_queue($messages = array(), $clear_queue = false)
-    {
-
-        if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
-            $this->_queue->execute();
-            $this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
-        } else {
-            // get messages to send and execute.
-            $this->_queue->get_to_send_batch_and_send();
-        }
-        // note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
-        // messages in the queue and decide how to handle at that point.
-        return $this->_queue;
-    }
-
-
-
-
-
-
-    /**
-     * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
-     * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
-     * messages in the queue, leaving it up to the caller to do so.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     * @return EE_Messages_Queue
-     */
-    public function generate_and_return($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate(false);
-    }
-
-
-
-
-    /**
-     * Executes the generator generate method on the current internal queue, and returns the generated queue.
-     * @param  bool     $persist    Indicate whether to instruct the generator to persist the generated queue (true) or not (false).
-     * @return EE_Messages_Queue
-     */
-    public function generate_queue($persist = true)
-    {
-        return $this->_generator->generate($persist);
-    }
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @type EE_Messages_Queue
+	 */
+	protected $_queue;
+
+	/**
+	 * @type  EE_Messages_Generator
+	 */
+	protected $_generator;
+
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct(EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->_message_resource_manager = $message_resource_manager;
+		$this->_init_queue_and_generator();
+	}
+
+
+
+
+	/**
+	 * This method sets (or resets) the various properties for use.
+	 *
+	 * - $_queue = holds the messages queue
+	 * - $_generator = holds the messages generator
+	 */
+	protected function _init_queue_and_generator()
+	{
+		$this->_generator = EE_Registry::factory('EE_Messages_Generator');
+		$this->_queue = $this->_generator->generation_queue();
+	}
+
+
+
+
+	/**
+	 * This returns the current set queue.
+	 * @return EE_Messages_Queue
+	 */
+	public function get_queue()
+	{
+		return $this->_queue;
+	}
+
+
+
+	/**
+	 * This method can be utilized to process messages from a queue and they will be processed immediately on the same request.
+	 * Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes client code
+	 * has already filtered those if necessary).
+	 *
+	 * @param EE_Messages_Queue $queue_to_process
+	 * @return bool  true for success false for error.
+	 */
+	public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
+	{
+		$success = false;
+		$messages_to_send = array();
+		$messages_to_generate = array();
+		// loop through and setup the various messages from the queue so we know what is being processed
+		$queue_to_process->get_message_repository()->rewind();
+		foreach ($queue_to_process->get_message_repository() as $message) {
+			if ($message->STS_ID() === EEM_Message::status_incomplete) {
+				$messages_to_generate[] = $message;
+				continue;
+			}
+
+			if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$messages_to_send[] = $message;
+				continue;
+			}
+		}
+
+		// do generation/sends
+		if ($messages_to_generate) {
+			$success = $this->batch_generate_from_queue($messages_to_generate, true);
+		}
+
+		if ($messages_to_send) {
+			$sent = $this->batch_send_from_queue($messages_to_send, true);
+			// if there was messages to generate and it failed, then we override any success value for the sending process
+			// otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
+			// Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
+			// all messages processing on the same request.
+			$success = $messages_to_generate && ! $success ? false : $sent;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
+	 *
+	 * @param  EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
+	 * @param  bool         $clear_queue Whether to ensure a fresh queue or not.
+	 *
+	 * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
+	 *                                   generated messages.
+	 */
+	public function batch_generate_from_queue($messages = array(), $clear_queue = false)
+	{
+		if ($this->_build_queue_for_generation($messages, $clear_queue)) {
+			$new_queue = $this->_generator->generate();
+			if ($new_queue instanceof EE_Messages_Queue) {
+				// unlock queue
+				$this->_queue->unlock_queue();
+				$new_queue->initiate_request_by_priority('send');
+				return $new_queue;
+			}
+		}
+		$this->_queue->unlock_queue();
+		return false;
+	}
+
+
+
+	/**
+	 * This method preps a queue for generation.
+	 *
+	 * @since    4.9.0
+	 *
+	 * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
+	 *
+	 * @param   bool       $clear_queue This indicates whether the existing queue should be dumped or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no generation please.
+	 */
+	protected function _build_queue_for_generation($messages = array(), $clear_queue = false)
+	{
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		if ($messages) {
+			// if generation is locked then get out now because that means processing is already happening.
+			if ($this->_queue->is_locked()) {
+				return false;
+			}
+
+			$this->_queue->lock_queue();
+			$messages = is_array($messages) ? $messages : array( $messages );
+			foreach ($messages as $message) {
+				if ($message instanceof EE_Message) {
+					$data = $message->all_extra_meta_array();
+					$this->_queue->add($message, $data);
+				}
+			}
+			return true;
+		} else {
+			return $this->_queue->get_batch_to_generate();
+		}
+	}
+
+
+	/**
+	 * This method preps a queue for sending.
+	 *
+	 * @param EE_Message[] $messages
+	 * @param bool  $clear_queue Used to indicate whether to start with a fresh queue or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no queue prepped.
+	 */
+	protected function _build_queue_for_sending($messages, $clear_queue = false)
+	{
+		// if sending is locked then get out now because that means processing is already happening.
+		if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->_queue->lock_queue(EE_Messages_Queue::action_sending);
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		$messages = is_array($messages) ? $messages : array( $messages );
+
+		foreach ($messages as $message) {
+			$this->_queue->add($message);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls EE_Message_Queue::execute()
+	 * to iterate and send unsent messages.
+	 *
+	 * @param EE_Message[] $messages    If an array of messages is sent in then use it.
+	 *
+	 * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
+	 *
+	 * @return EE_Messages_Queue
+	 */
+	public function batch_send_from_queue($messages = array(), $clear_queue = false)
+	{
+
+		if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
+			$this->_queue->execute();
+			$this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
+		} else {
+			// get messages to send and execute.
+			$this->_queue->get_to_send_batch_and_send();
+		}
+		// note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
+		// messages in the queue and decide how to handle at that point.
+		return $this->_queue;
+	}
+
+
+
+
+
+
+	/**
+	 * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
+	 * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
+	 * messages in the queue, leaving it up to the caller to do so.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_and_return($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(false);
+	}
+
+
+
+
+	/**
+	 * Executes the generator generate method on the current internal queue, and returns the generated queue.
+	 * @param  bool     $persist    Indicate whether to instruct the generator to persist the generated queue (true) or not (false).
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_queue($persist = true)
+	{
+		return $this->_generator->generate($persist);
+	}
 
 
 
 
-    /**
-     * Queue for generation.  Note this does NOT persist to the db.  Client code should call get_message_repository()->save() if desire
-     * to persist.  This method is provided to client code to decide what it wants to do with queued messages for generation.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send             Whether this item is for a test send or not.
-     * @return  EE_Messages_Queue
-     */
-    public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if ($message_to_generate->valid()) {
-            $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send);
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the generation queue
-     * and then persists to storage.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    public function batch_queue_for_generation_and_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        $this->_queue->save();
-    }
-
-
-
-
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the generation
-     * queue.  Does NOT persist to storage (unless there is an error.
-     * Client code can retrieve the generated queue by calling EEM_Messages_Processor::get_queue()
-     *
-     * @param EE_Message_To_Generate[]  $messages_to_generate
-     */
-    public function batch_queue_for_generation_no_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-    }
-
-
-
-
-    /**
-     * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
-     * objects.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    protected function _queue_for_generation_loop($messages_to_generate)
-    {
-        // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
-            $messages_to_generate = array( $messages_to_generate );
-        }
-
-        foreach ($messages_to_generate as $message_to_generate) {
-            if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
-                $this->queue_for_generation($message_to_generate);
-            }
-        }
-    }
-
-
-
-
-
-    /**
-     * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
-     * queued for sending).
-     * @param  EE_Message_To_Generate[]
-     * @return EE_Messages_Queue
-     */
-    public function generate_and_queue_for_sending($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate(true);
-    }
-
-
-
-
-
-    /**
-     * Generate for preview and execute right away.
-     *
-     * @param   EE_Message_To_Generate $message_to_generate
-     * @param   bool                   $test_send                Whether this is a test send or not.
-     * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
-     */
-    public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if (! $message_to_generate->valid()) {
-            EE_Error::add_error(
-                __('Unable to generate preview because of invalid data', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // just make sure preview is set on the $message_to_generate (in case client forgot)
-        $message_to_generate->set_preview(true);
-        $this->_init_queue_and_generator();
-        $this->queue_for_generation($message_to_generate, $test_send);
-        $generated_queue = $this->_generator->generate(false);
-        if ($generated_queue->execute(false)) {
-            // the first queue item should be the preview
-            $generated_queue->get_message_repository()->rewind();
-            if (! $generated_queue->get_message_repository()->valid()) {
-                return $generated_queue;
-            }
-            return $generated_queue;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * This queues for sending.
-     * The messenger send now method is also verified to see if sending immediately is requested.
-     * otherwise its just saved to the queue.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return bool true or false for success.
-     */
-    public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return false;
-        }
-        $this->_init_queue_and_generator();
-        $message = $message_to_generate->get_EE_Message();
-        $this->_queue->add($message);
-        if ($message->send_now()) {
-            $this->_queue->execute(false);
-        } else {
-            $this->_queue->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * This generates and sends from the given EE_Message_To_Generate class immediately.
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return EE_Messages_Queue | null
-     */
-    public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return null;
-        }
-        // is there supposed to be a sending messenger for this message?
-        if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
-            // make sure it's valid, but if it's not,
-            // then set the value of $sending_messenger to an EE_Error object
-            // so that downstream code can easily see that things went wrong.
-            $sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
-                ? $message_to_generate->sending_messenger()
-                : new EE_Error(
-                    __(
-                        'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
-                        'event_espresso'
-                    )
-                );
-        } else {
-            $sending_messenger = null;
-        }
-
-        if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
-            $this->_init_queue_and_generator();
-            $this->_queue->add($message_to_generate->get_EE_Message());
-            $this->_queue->execute(false, $sending_messenger);
-            return $this->_queue;
-        } elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
-            $generated_queue = $this->generate_and_return(array( $message_to_generate ));
-            $generated_queue->execute(false, $sending_messenger);
-            return $generated_queue;
-        }
-        return null;
-    }
-
-
-
-
-    /**
-     * Creates mtg objects for all active messengers and queues for generation.
-     * This method also calls the execute by priority method on the queue which will optionally kick off a new non-blocking
-     * request to complete the action if the priority for the message requires immediate action.
-     * @param string $message_type
-     * @param mixed  $data   The data being used for generation.
-     * @param bool   $persist   Whether to persist the queued messages to the db or not.
-     */
-    public function generate_for_all_active_messengers($message_type, $data, $persist = true)
-    {
-        $messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
-        if ($persist) {
-            $this->batch_queue_for_generation_and_persist($messages_to_generate);
-            $this->_queue->initiate_request_by_priority();
-        } else {
-            $this->batch_queue_for_generation_no_persist($messages_to_generate);
-        }
-    }
-
-
-
-
-    /**
-     * This simply loops through all active messengers and takes care of setting up the
-     * EE_Message_To_Generate objects.
-     * @param $message_type
-     * @param $data
-     *
-     * @return EE_Message_To_Generate[]
-     */
-    public function setup_mtgs_for_all_active_messengers($message_type, $data)
-    {
-        $messages_to_generate = array();
-        foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
-            $message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
-            if ($message_to_generate->valid()) {
-                $messages_to_generate[] = $message_to_generate;
-            }
-        }
-        return $messages_to_generate;
-    }
-
-
-
-
-    /**
-     * This accepts an array of EE_Message::MSG_ID values and will use that to retrieve the objects from the database
-     * and send.
-     * @param array $message_ids
-     */
-    public function setup_messages_from_ids_and_send($message_ids)
-    {
-        $this->_init_queue_and_generator();
-        $messages = EEM_Message::instance()->get_all(array(
-            array(
-                'MSG_ID' => array( 'IN', $message_ids ),
-                'STS_ID' => array(
-                    'IN',
-                    array_merge(
-                        EEM_Message::instance()->stati_indicating_sent(),
-                        array( EEM_Message::status_retry )
-                    ),
-                ),
-            ),
-        ));
-        // set the Messages to resend.
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $message->set_STS_ID(EEM_Message::status_resend);
-                $this->_queue->add($message);
-            }
-        }
-
-        $this->_queue->initiate_request_by_priority('send');
-    }
-
-
-
-    /**
-     * This method checks for registration IDs in the request via the given key and creates the messages to generate
-     * objects from them, then returns the array of messages to generate objects.
-     * Note, this sets up registrations for the registration family of message types.
-     *
-     * @param string $registration_ids_key  This is used to indicate what represents the registration ids in the request.
-     *
-     * @return EE_Message_To_Generate[]
-     */
-    public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $regs_to_send = array();
-        $regIDs = EE_Registry::instance()->REQ->get($registration_ids_key);
-        if (empty($regIDs)) {
-            EE_Error::add_error(__('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // make sure is an array
-        $regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
-
-        foreach ($regIDs as $regID) {
-            $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
-                EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
-                return false;
-            }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
-        }
-
-        $messages_to_generate = array();
-
-        foreach ($regs_to_send as $status_group) {
-            foreach ($status_group as $status_id => $registrations) {
-                $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
-                    continue;
-                }
-                $messages_to_generate = array_merge(
-                    $messages_to_generate,
-                    $this->setup_mtgs_for_all_active_messengers(
-                        $message_type,
-                        array( $registrations, $status_id )
-                    )
-                );
-            }
-        }
-
-        return $messages_to_generate;
-    }
+	/**
+	 * Queue for generation.  Note this does NOT persist to the db.  Client code should call get_message_repository()->save() if desire
+	 * to persist.  This method is provided to client code to decide what it wants to do with queued messages for generation.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send             Whether this item is for a test send or not.
+	 * @return  EE_Messages_Queue
+	 */
+	public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if ($message_to_generate->valid()) {
+			$this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send);
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the generation queue
+	 * and then persists to storage.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	public function batch_queue_for_generation_and_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		$this->_queue->save();
+	}
+
+
+
+
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the generation
+	 * queue.  Does NOT persist to storage (unless there is an error.
+	 * Client code can retrieve the generated queue by calling EEM_Messages_Processor::get_queue()
+	 *
+	 * @param EE_Message_To_Generate[]  $messages_to_generate
+	 */
+	public function batch_queue_for_generation_no_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+	}
+
+
+
+
+	/**
+	 * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
+	 * objects.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	protected function _queue_for_generation_loop($messages_to_generate)
+	{
+		// make sure is in an array.
+		if (! is_array($messages_to_generate)) {
+			$messages_to_generate = array( $messages_to_generate );
+		}
+
+		foreach ($messages_to_generate as $message_to_generate) {
+			if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
+				$this->queue_for_generation($message_to_generate);
+			}
+		}
+	}
+
+
+
+
+
+	/**
+	 * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
+	 * queued for sending).
+	 * @param  EE_Message_To_Generate[]
+	 * @return EE_Messages_Queue
+	 */
+	public function generate_and_queue_for_sending($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(true);
+	}
+
+
+
+
+
+	/**
+	 * Generate for preview and execute right away.
+	 *
+	 * @param   EE_Message_To_Generate $message_to_generate
+	 * @param   bool                   $test_send                Whether this is a test send or not.
+	 * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
+	 */
+	public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if (! $message_to_generate->valid()) {
+			EE_Error::add_error(
+				__('Unable to generate preview because of invalid data', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// just make sure preview is set on the $message_to_generate (in case client forgot)
+		$message_to_generate->set_preview(true);
+		$this->_init_queue_and_generator();
+		$this->queue_for_generation($message_to_generate, $test_send);
+		$generated_queue = $this->_generator->generate(false);
+		if ($generated_queue->execute(false)) {
+			// the first queue item should be the preview
+			$generated_queue->get_message_repository()->rewind();
+			if (! $generated_queue->get_message_repository()->valid()) {
+				return $generated_queue;
+			}
+			return $generated_queue;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * This queues for sending.
+	 * The messenger send now method is also verified to see if sending immediately is requested.
+	 * otherwise its just saved to the queue.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return bool true or false for success.
+	 */
+	public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return false;
+		}
+		$this->_init_queue_and_generator();
+		$message = $message_to_generate->get_EE_Message();
+		$this->_queue->add($message);
+		if ($message->send_now()) {
+			$this->_queue->execute(false);
+		} else {
+			$this->_queue->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * This generates and sends from the given EE_Message_To_Generate class immediately.
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return EE_Messages_Queue | null
+	 */
+	public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return null;
+		}
+		// is there supposed to be a sending messenger for this message?
+		if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
+			// make sure it's valid, but if it's not,
+			// then set the value of $sending_messenger to an EE_Error object
+			// so that downstream code can easily see that things went wrong.
+			$sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
+				? $message_to_generate->sending_messenger()
+				: new EE_Error(
+					__(
+						'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
+						'event_espresso'
+					)
+				);
+		} else {
+			$sending_messenger = null;
+		}
+
+		if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
+			$this->_init_queue_and_generator();
+			$this->_queue->add($message_to_generate->get_EE_Message());
+			$this->_queue->execute(false, $sending_messenger);
+			return $this->_queue;
+		} elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
+			$generated_queue = $this->generate_and_return(array( $message_to_generate ));
+			$generated_queue->execute(false, $sending_messenger);
+			return $generated_queue;
+		}
+		return null;
+	}
+
+
+
+
+	/**
+	 * Creates mtg objects for all active messengers and queues for generation.
+	 * This method also calls the execute by priority method on the queue which will optionally kick off a new non-blocking
+	 * request to complete the action if the priority for the message requires immediate action.
+	 * @param string $message_type
+	 * @param mixed  $data   The data being used for generation.
+	 * @param bool   $persist   Whether to persist the queued messages to the db or not.
+	 */
+	public function generate_for_all_active_messengers($message_type, $data, $persist = true)
+	{
+		$messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
+		if ($persist) {
+			$this->batch_queue_for_generation_and_persist($messages_to_generate);
+			$this->_queue->initiate_request_by_priority();
+		} else {
+			$this->batch_queue_for_generation_no_persist($messages_to_generate);
+		}
+	}
+
+
+
+
+	/**
+	 * This simply loops through all active messengers and takes care of setting up the
+	 * EE_Message_To_Generate objects.
+	 * @param $message_type
+	 * @param $data
+	 *
+	 * @return EE_Message_To_Generate[]
+	 */
+	public function setup_mtgs_for_all_active_messengers($message_type, $data)
+	{
+		$messages_to_generate = array();
+		foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
+			$message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
+			if ($message_to_generate->valid()) {
+				$messages_to_generate[] = $message_to_generate;
+			}
+		}
+		return $messages_to_generate;
+	}
+
+
+
+
+	/**
+	 * This accepts an array of EE_Message::MSG_ID values and will use that to retrieve the objects from the database
+	 * and send.
+	 * @param array $message_ids
+	 */
+	public function setup_messages_from_ids_and_send($message_ids)
+	{
+		$this->_init_queue_and_generator();
+		$messages = EEM_Message::instance()->get_all(array(
+			array(
+				'MSG_ID' => array( 'IN', $message_ids ),
+				'STS_ID' => array(
+					'IN',
+					array_merge(
+						EEM_Message::instance()->stati_indicating_sent(),
+						array( EEM_Message::status_retry )
+					),
+				),
+			),
+		));
+		// set the Messages to resend.
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$message->set_STS_ID(EEM_Message::status_resend);
+				$this->_queue->add($message);
+			}
+		}
+
+		$this->_queue->initiate_request_by_priority('send');
+	}
+
+
+
+	/**
+	 * This method checks for registration IDs in the request via the given key and creates the messages to generate
+	 * objects from them, then returns the array of messages to generate objects.
+	 * Note, this sets up registrations for the registration family of message types.
+	 *
+	 * @param string $registration_ids_key  This is used to indicate what represents the registration ids in the request.
+	 *
+	 * @return EE_Message_To_Generate[]
+	 */
+	public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$regs_to_send = array();
+		$regIDs = EE_Registry::instance()->REQ->get($registration_ids_key);
+		if (empty($regIDs)) {
+			EE_Error::add_error(__('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// make sure is an array
+		$regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
+
+		foreach ($regIDs as $regID) {
+			$reg = EEM_Registration::instance()->get_one_by_ID($regID);
+			if (! $reg instanceof EE_Registration) {
+				EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
+				return false;
+			}
+			$regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+		}
+
+		$messages_to_generate = array();
+
+		foreach ($regs_to_send as $status_group) {
+			foreach ($status_group as $status_id => $registrations) {
+				$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
+				if (! $message_type) {
+					continue;
+				}
+				$messages_to_generate = array_merge(
+					$messages_to_generate,
+					$this->setup_mtgs_for_all_active_messengers(
+						$message_type,
+						array( $registrations, $status_id )
+					)
+				);
+			}
+		}
+
+		return $messages_to_generate;
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -165,7 +165,7 @@ 
             }
 
             $this->_queue->lock_queue();
-            $messages = is_array($messages) ? $messages : array( $messages );
+            $messages = is_array($messages) ? $messages : array($messages);
             foreach ($messages as $message) {
                 if ($message instanceof EE_Message) {
                     $data = $message->all_extra_meta_array();
@@ -200,7 +200,7 @@ 
             $this->_init_queue_and_generator();
         }
 
-        $messages = is_array($messages) ? $messages : array( $messages );
+        $messages = is_array($messages) ? $messages : array($messages);
 
         foreach ($messages as $message) {
             $this->_queue->add($message);
@@ -333,8 +333,8 @@ 
     protected function _queue_for_generation_loop($messages_to_generate)
     {
         // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
-            $messages_to_generate = array( $messages_to_generate );
+        if ( ! is_array($messages_to_generate)) {
+            $messages_to_generate = array($messages_to_generate);
         }
 
         foreach ($messages_to_generate as $message_to_generate) {
@@ -374,7 +374,7 @@ 
      */
     public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             EE_Error::add_error(
                 __('Unable to generate preview because of invalid data', 'event_espresso'),
                 __FILE__,
@@ -391,7 +391,7 @@ 
         if ($generated_queue->execute(false)) {
             // the first queue item should be the preview
             $generated_queue->get_message_repository()->rewind();
-            if (! $generated_queue->get_message_repository()->valid()) {
+            if ( ! $generated_queue->get_message_repository()->valid()) {
                 return $generated_queue;
             }
             return $generated_queue;
@@ -410,7 +410,7 @@ 
      */
     public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false;
         }
         $this->_init_queue_and_generator();
@@ -432,7 +432,7 @@ 
      */
     public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return null;
         }
         // is there supposed to be a sending messenger for this message?
@@ -458,7 +458,7 @@ 
             $this->_queue->execute(false, $sending_messenger);
             return $this->_queue;
         } elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
-            $generated_queue = $this->generate_and_return(array( $message_to_generate ));
+            $generated_queue = $this->generate_and_return(array($message_to_generate));
             $generated_queue->execute(false, $sending_messenger);
             return $generated_queue;
         }
@@ -523,12 +523,12 @@ 
         $this->_init_queue_and_generator();
         $messages = EEM_Message::instance()->get_all(array(
             array(
-                'MSG_ID' => array( 'IN', $message_ids ),
+                'MSG_ID' => array('IN', $message_ids),
                 'STS_ID' => array(
                     'IN',
                     array_merge(
                         EEM_Message::instance()->stati_indicating_sent(),
-                        array( EEM_Message::status_retry )
+                        array(EEM_Message::status_retry)
                     ),
                 ),
             ),
@@ -567,15 +567,15 @@ 
         }
 
         // make sure is an array
-        $regIDs = is_array($regIDs) ? $regIDs : array( $regIDs );
+        $regIDs = is_array($regIDs) ? $regIDs : array($regIDs);
 
         foreach ($regIDs as $regID) {
             $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
                 return false;
             }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+            $regs_to_send[$reg->transaction_ID()][$reg->status_ID()][] = $reg;
         }
 
         $messages_to_generate = array();
@@ -583,14 +583,14 @@ 
         foreach ($regs_to_send as $status_group) {
             foreach ($status_group as $status_id => $registrations) {
                 $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
+                if ( ! $message_type) {
                     continue;
                 }
                 $messages_to_generate = array_merge(
                     $messages_to_generate,
                     $this->setup_mtgs_for_all_active_messengers(
                         $message_type,
-                        array( $registrations, $status_id )
+                        array($registrations, $status_id)
                     )
                 );
             }

core/libraries/messages/data_class/EE_Messages_Addressee.class.php

Indentation +295 added lines, -295 removed lines

@@ -15,299 +15,299 @@
 {
 
 
-    /**
-     * Identifier properties for the recipient
-     */
-
-    /**
-     * if available we'll use this to set the fname and lname (admin)
-     *
-     * @var int
-     */
-    public $user_id;
-
-    /**
-     * this will always be the admin fname (set later via incoming user_id)
-     *
-     * @var string
-     */
-    public $fname;
-
-    /**
-     * this will always be the admin lname (set later via incoming user_id)
-     *
-     * @var string
-     */
-    public $lname;
-
-    /**
-     * @var int
-     */
-    public $primary_registration_id;
-
-    /**
-     * @var int
-     */
-    public $attendee_registration_id;
-
-    /**
-     * This is should represent the data object that can be used to regenerate this addressee if needed.
-     * It is saved to the MSG_recipient_ID column in the generated EE_Message using this data.
-     *
-     * @var int
-     */
-    public $recipient_id;
-
-    /**
-     * This represents the reference to the EE_Base_Class child that the $recipient_ID is for (eg. 'Registration',
-     * 'Attendee') It is saved to the MSG_recipient_type column in the generated EE_Message using this data.
-     *
-     * @var string
-     */
-    public $recipient_type;
-
-    /**
-     * communication related
-     */
-    /**
-     * @var string
-     */
-    public $attendee_email;
-
-    /**
-     * @var string
-     */
-    public $primary_attendee_email;
-
-    /**
-     * @var string
-     */
-    public $admin_email;
-
-
-
-    /**
-     * Attendee related
-     */
-
-    /**
-     * holds the attendee object for the primary attendee
-     *
-     * @var EE_Attendee
-     */
-    public $primary_att_obj;
-
-    /**
-     * holds the registration object for the primary attendee
-     *
-     * @var EE_Registration
-     */
-    public $primary_reg_obj;
-
-    /**
-     * holds the attendee object for an attendee
-     *
-     * @var EE_Attendee
-     */
-    public $att_obj;
-
-    /**
-     * holds the registration object for an attendee
-     *
-     * @var EE_Registration
-     */
-    public $reg_obj;
-
-    /**
-     * array of EE_Question objects (indexed by EE_Answer->ID())
-     *
-     * @var EE_Question[]
-     */
-    public $questions;
-
-    /**
-     * array of EE_Answer objects
-     *
-     * @var EE_Answer[]
-     */
-    public $answers;
-
-
-
-    /**
-     * event related
-     */
-
-    /**
-     * This will hold all event info/
-     * @var EE_Event[]
-     */
-    public $events;
-
-    /**
-     * holds all the attendees for an event.
-     *
-     * @var EE_Attendee[]
-     */
-    public $attendees;
-
-    /**
-     * holds all the purchased tickets for an event
-     *
-     * @var EE_Ticket[]
-     */
-    public $tickets;
-
-    /**
-     * holds an array of line items indexed by parent ticket line item ids and values are array of children of that
-     * line item
-     *
-     * @var EE_Line_Item[]
-     */
-    public $line_items_with_children;
-
-    /**
-     * holds all the datetimes accessed via the tickets purchased for the event
-     *
-     * @var EE_Datetime[]
-     */
-    public $datetimes;
-
-    /**
-     * holds all registrations for a transaction (with cached relations on that registration)
-     *
-     * @var EE_Registration[]
-     */
-    public $registrations;
-
-
-
-    /**
-     * txn related
-     */
-
-    /**
-     * @var array
-     */
-    public $billing;
-
-    /**
-     *total taxes
-     *
-     * @var array
-     */
-    public $taxes;
-
-    /**
-     * @var EE_Line_Item[]
-     */
-    public $tax_line_items;
-
-    /**
-     * @var EE_Line_Item[]
-     */
-    public $additional_line_items;
-
-    /**
-     * @var EE_Line_Item
-     */
-    public $grand_total_line_item;
-
-    /**
-     * @var EE_Transaction
-     */
-    public $txn;
-
-    /**
-     * @var EE_Payment
-     */
-    public $payment;
-
-    /**
-     * @var EE_Payment[]
-     */
-    public $payments;
-
-    /**
-     * @var EE_Transaction[]
-     */
-    public $txn_objs;
-
-    /**
-     * @var EE_Registration[]
-     */
-    public $reg_objs;
-
-    /**
-     * total number of ALL tickets purchased for the txn.
-     *
-     * @var int
-     */
-    public $total_ticket_count;
-
-
-
-    /**
-     * things that get set later by parsers
-     */
-
-    /**
-     * @var string $event_list
-     */
-    public $event_list;
-
-    /**
-     * @var string
-     */
-    public $attendee_list;
-
-
-
-    /**
-     * This just holds the incoming data
-     *
-     * @var array
-     */
-    protected $_data;
-
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @param array $addressee_data We're expecting an incoming array of data that will be used to fill the properties
-     *                              for the object.
-     */
-    public function __construct($addressee_data)
-    {
-        $this->_data = $addressee_data;
-        $this->_set_properties();
-    }
-
-
-
-    /**
-     * This simply loops through the data and makes sure that each item is present in the incoming data.  If it is then
-     * it is assigned to the property.
-     *
-     * @access protected
-     * @return void.
-     */
-    protected function _set_properties()
-    {
-        foreach ($this->_data as $prop => $value) {
-            if (property_exists($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-        // if user_id present we'll use this to set the fname and lname and admin_email.
-        if (! empty($this->user_id)) {
-            $this->user_id = (int) $this->user_id;
-            $user = get_userdata($this->user_id);
-            $this->fname = $user->user_firstname;
-            $this->lname = $user->user_lastname;
-            $this->admin_email = $user->user_email;
-        }
-    }
+	/**
+	 * Identifier properties for the recipient
+	 */
+
+	/**
+	 * if available we'll use this to set the fname and lname (admin)
+	 *
+	 * @var int
+	 */
+	public $user_id;
+
+	/**
+	 * this will always be the admin fname (set later via incoming user_id)
+	 *
+	 * @var string
+	 */
+	public $fname;
+
+	/**
+	 * this will always be the admin lname (set later via incoming user_id)
+	 *
+	 * @var string
+	 */
+	public $lname;
+
+	/**
+	 * @var int
+	 */
+	public $primary_registration_id;
+
+	/**
+	 * @var int
+	 */
+	public $attendee_registration_id;
+
+	/**
+	 * This is should represent the data object that can be used to regenerate this addressee if needed.
+	 * It is saved to the MSG_recipient_ID column in the generated EE_Message using this data.
+	 *
+	 * @var int
+	 */
+	public $recipient_id;
+
+	/**
+	 * This represents the reference to the EE_Base_Class child that the $recipient_ID is for (eg. 'Registration',
+	 * 'Attendee') It is saved to the MSG_recipient_type column in the generated EE_Message using this data.
+	 *
+	 * @var string
+	 */
+	public $recipient_type;
+
+	/**
+	 * communication related
+	 */
+	/**
+	 * @var string
+	 */
+	public $attendee_email;
+
+	/**
+	 * @var string
+	 */
+	public $primary_attendee_email;
+
+	/**
+	 * @var string
+	 */
+	public $admin_email;
+
+
+
+	/**
+	 * Attendee related
+	 */
+
+	/**
+	 * holds the attendee object for the primary attendee
+	 *
+	 * @var EE_Attendee
+	 */
+	public $primary_att_obj;
+
+	/**
+	 * holds the registration object for the primary attendee
+	 *
+	 * @var EE_Registration
+	 */
+	public $primary_reg_obj;
+
+	/**
+	 * holds the attendee object for an attendee
+	 *
+	 * @var EE_Attendee
+	 */
+	public $att_obj;
+
+	/**
+	 * holds the registration object for an attendee
+	 *
+	 * @var EE_Registration
+	 */
+	public $reg_obj;
+
+	/**
+	 * array of EE_Question objects (indexed by EE_Answer->ID())
+	 *
+	 * @var EE_Question[]
+	 */
+	public $questions;
+
+	/**
+	 * array of EE_Answer objects
+	 *
+	 * @var EE_Answer[]
+	 */
+	public $answers;
+
+
+
+	/**
+	 * event related
+	 */
+
+	/**
+	 * This will hold all event info/
+	 * @var EE_Event[]
+	 */
+	public $events;
+
+	/**
+	 * holds all the attendees for an event.
+	 *
+	 * @var EE_Attendee[]
+	 */
+	public $attendees;
+
+	/**
+	 * holds all the purchased tickets for an event
+	 *
+	 * @var EE_Ticket[]
+	 */
+	public $tickets;
+
+	/**
+	 * holds an array of line items indexed by parent ticket line item ids and values are array of children of that
+	 * line item
+	 *
+	 * @var EE_Line_Item[]
+	 */
+	public $line_items_with_children;
+
+	/**
+	 * holds all the datetimes accessed via the tickets purchased for the event
+	 *
+	 * @var EE_Datetime[]
+	 */
+	public $datetimes;
+
+	/**
+	 * holds all registrations for a transaction (with cached relations on that registration)
+	 *
+	 * @var EE_Registration[]
+	 */
+	public $registrations;
+
+
+
+	/**
+	 * txn related
+	 */
+
+	/**
+	 * @var array
+	 */
+	public $billing;
+
+	/**
+	 *total taxes
+	 *
+	 * @var array
+	 */
+	public $taxes;
+
+	/**
+	 * @var EE_Line_Item[]
+	 */
+	public $tax_line_items;
+
+	/**
+	 * @var EE_Line_Item[]
+	 */
+	public $additional_line_items;
+
+	/**
+	 * @var EE_Line_Item
+	 */
+	public $grand_total_line_item;
+
+	/**
+	 * @var EE_Transaction
+	 */
+	public $txn;
+
+	/**
+	 * @var EE_Payment
+	 */
+	public $payment;
+
+	/**
+	 * @var EE_Payment[]
+	 */
+	public $payments;
+
+	/**
+	 * @var EE_Transaction[]
+	 */
+	public $txn_objs;
+
+	/**
+	 * @var EE_Registration[]
+	 */
+	public $reg_objs;
+
+	/**
+	 * total number of ALL tickets purchased for the txn.
+	 *
+	 * @var int
+	 */
+	public $total_ticket_count;
+
+
+
+	/**
+	 * things that get set later by parsers
+	 */
+
+	/**
+	 * @var string $event_list
+	 */
+	public $event_list;
+
+	/**
+	 * @var string
+	 */
+	public $attendee_list;
+
+
+
+	/**
+	 * This just holds the incoming data
+	 *
+	 * @var array
+	 */
+	protected $_data;
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @param array $addressee_data We're expecting an incoming array of data that will be used to fill the properties
+	 *                              for the object.
+	 */
+	public function __construct($addressee_data)
+	{
+		$this->_data = $addressee_data;
+		$this->_set_properties();
+	}
+
+
+
+	/**
+	 * This simply loops through the data and makes sure that each item is present in the incoming data.  If it is then
+	 * it is assigned to the property.
+	 *
+	 * @access protected
+	 * @return void.
+	 */
+	protected function _set_properties()
+	{
+		foreach ($this->_data as $prop => $value) {
+			if (property_exists($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+		// if user_id present we'll use this to set the fname and lname and admin_email.
+		if (! empty($this->user_id)) {
+			$this->user_id = (int) $this->user_id;
+			$user = get_userdata($this->user_id);
+			$this->fname = $user->user_firstname;
+			$this->lname = $user->user_lastname;
+			$this->admin_email = $user->user_email;
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -302,7 +302,7 @@
             }
         }
         // if user_id present we'll use this to set the fname and lname and admin_email.
-        if (! empty($this->user_id)) {
+        if ( ! empty($this->user_id)) {
             $this->user_id = (int) $this->user_id;
             $user = get_userdata($this->user_id);
             $this->fname = $user->user_firstname;