eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Generator.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -459,7 +459,7 @@ 
      * there's a single shared message template group among all the events.  Otherwise it returns null.
      *
      * @param array $event_ids
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -495,7 +495,7 @@ 
     /**
      * Retrieves the global message template group for the current messenger and message type.
      *
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -641,7 +641,7 @@ 
      * @param EE_Messages_Addressee     $recipient
      * @param array                     $templates formatted array of templates used for parsing data.
      * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
+     * @return EE_Message
      * @throws EE_Error
      */
     protected function _setup_message_object(

Indentation +969 added lines, -969 removed lines

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

Spacing +23 added lines, -23 removed lines

@@ -258,7 +258,7 @@ 
     {
         // double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; // get out because we don't have a valid setup to work with.
         }
 
@@ -275,7 +275,7 @@ 
 
 
         // if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -297,7 +297,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         // in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -407,7 +407,7 @@ 
             // attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  // got it!
+                return $message_template_group; // got it!
             }
 
             // nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -436,7 +436,7 @@ 
     protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
     {
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
             array(
@@ -512,7 +512,7 @@ 
         );
 
         // if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -544,7 +544,7 @@ 
     {
         $event_ids = array();
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         return $event_ids;
     }
@@ -569,10 +569,10 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
-                $templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
+                $templates[$template_field][$context] = $template_obj->get('MTP_content');
             }
         }
         return $templates;
@@ -598,7 +598,7 @@ 
     {
 
         // if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -682,7 +682,7 @@ 
         // if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
         if ((
                 (
-                    empty($templates['to'][ $context ])
+                    empty($templates['to'][$context])
                     && ! $this->_current_messenger->allow_empty_to_field()
                 )
                 || ! $message_template_group->is_context_active($context)
@@ -697,15 +697,15 @@ 
         foreach ($templates as $field => $field_context) {
             $error_msg = array();
             // let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[ $context ];
+            $valid_shortcodes = $mt_shortcodes[$context];
             // merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[ $field ]) ? $m_shortcodes[ $field ] : $valid_shortcodes;
-            if (isset($templates[ $field ][ $context ])) {
+            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+            if (isset($templates[$field][$context])) {
                 // prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
-                        $templates[ $field ][ $context ],
+                        $templates[$field][$context],
                         $recipient,
                         $shortcodes,
                         $this->_current_message_type,
@@ -774,13 +774,13 @@ 
      */
     protected function _valid_addressees($addressees)
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -822,7 +822,7 @@ 
         /**
          * Check if there is any generation data, but only if this is not for a preview.
          */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+        if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
             && (
                 ! $this->_generation_queue->get_message_repository()->is_preview()
                 && $this->_generation_queue->get_message_repository()->get_data_handler()
@@ -861,7 +861,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         // If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -869,7 +869,7 @@ 
         }
 
         // First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
                 esc_html__(
                     'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
@@ -912,7 +912,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             // no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -938,7 +938,7 @@ 
     {
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
         $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());

admin_pages/messages/templates/ee_msg_editor_active_context_element.template.php

Indentation +18 added lines, -18 removed lines

@@ -10,22 +10,22 @@ 
  * @var int    $message_template_group_id The ID for the message template group this context belongs to.
  */
 $active_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 $inactive_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sinactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sinactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 ?>
 <div class="context-active-control-container">
@@ -34,8 +34,8 @@ 
         <span id="on-off-nonce-<?php echo $context; ?>" class="hidden"><?php echo $nonce; ?></span>
         <span class="ee-on-off-toggle-label">
             <?php
-            echo $is_active ? $active_message : $inactive_message;
-            ?>
+			echo $is_active ? $active_message : $inactive_message;
+			?>
         </span>
         <div class="hidden js-data">
             <span class="ee-active-message"><?php echo $active_message; ?></span>
@@ -43,8 +43,8 @@ 
         </div>
         <div class="switch">
             <?php
-            $checked = $is_active ? ' checked="checked"' : '';
-            ?>
+			$checked = $is_active ? ' checked="checked"' : '';
+			?>
             <input data-grpid="<?php echo $message_template_group_id; ?>" id="ee-on-off-toggle-<?php echo $context; ?>" type="checkbox" class="ee-on-off-toggle ee-toggle-round-flat"<?php echo $checked; ?> value="<?php echo $on_off_action; ?>">
             <label for="ee-on-off-toggle-<?php echo $context; ?>"></label>
         </div>

acceptance_tests/tests/e-TestContextActivationToggleCept.php

Indentation +62 added lines, -62 removed lines

@@ -8,8 +8,8 @@ 
 $event_label = 'Testing Context Deactivation';
 
 $I->wantTo(
-    'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
-    . ' expected'
+	'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
+	. ' expected'
 );
 
 $I->loginAsAdmin();
@@ -34,7 +34,7 @@ 
 $I->see('The template for Primary Registrant Recipient is currently inactive.');
 
 $I->amGoingTo(
-    'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
+	'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
 );
 $I->amOnDefaultEventsListTablePage();
 $I->click(EventsAdmin::ADD_NEW_EVENT_BUTTON_SELECTOR);
@@ -44,9 +44,9 @@ 
 $event_link = $I->observeLinkUrlAt(EventsAdmin::EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR);
 $event_id = $I->observeValueFromInputAt(EventsAdmin::EVENT_EDITOR_EVT_ID_SELECTOR);
 $test_registration_details = array(
-    'fname' => 'ContextTestGuy',
-    'lname' => 'ContextTestDude',
-    'email' => 'contexttestguy@example.org',
+	'fname' => 'ContextTestGuy',
+	'lname' => 'ContextTestDude',
+	'email' => 'contexttestguy@example.org',
 );
 $I->logOut();
 $I->amOnUrl($event_link);
@@ -63,48 +63,48 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 
 $I->amGoingTo(
-    'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
-    . ' field to an empty string to verify the message does not send for that context.'
+	'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
+	. ' field to an empty string to verify the message does not send for that context.'
 );
 $I->amOnDefaultMessageTemplateListTablePage();
 $I->clickToEditMessageTemplateByMessageType('registration', 'primary_attendee');
@@ -128,41 +128,41 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
\ No newline at end of file

public/Espresso_Arabica_2014/functions.php

Spacing +7 added lines, -7 removed lines

@@ -9,9 +9,9 @@ 
  * @ link			http://www.eventespresso.com
  * @ version		4+
  */
-define( 'EE_THEME_FUNCTIONS_LOADED', TRUE );
+define('EE_THEME_FUNCTIONS_LOADED', TRUE);
 
-if ( ! function_exists( 'espresso_pagination' ) ) {
+if ( ! function_exists('espresso_pagination')) {
 	/**
 	 *    espresso_pagination
 	 *
@@ -23,21 +23,21 @@ 
 		$big = 999999999; // need an unlikely integer
 		$pagination = paginate_links(
 			array(
-				'base'         => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 				'format'       => '?paged=%#%',
-				'current'      => max( 1, get_query_var( 'paged' ) ),
+				'current'      => max(1, get_query_var('paged')),
 				'total'        => $wp_query->max_num_pages,
 				'show_all'     => true,
 				'end_size'     => 10,
 				'mid_size'     => 6,
 				'prev_next'    => true,
-				'prev_text'    => __( '‹ PREV', 'event_espresso' ),
-				'next_text'    => __( 'NEXT ›', 'event_espresso' ),
+				'prev_text'    => __('‹ PREV', 'event_espresso'),
+				'next_text'    => __('NEXT ›', 'event_espresso'),
 				'type'         => 'plain',
 				'add_args'     => false,
 				'add_fragment' => ''
 			)
 		);
-		echo ! empty( $pagination ) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
 	}
 }
\ No newline at end of file

admin_pages/messages/help_tabs/messages_settings_messengers.help_tab.php

Indentation +50 added lines, -50 removed lines

@@ -3,79 +3,79 @@
 </p>
 <p>
     <?php esc_html_e(
-        'You can select Messengers via the tabs across the top of the settings page. The available messengers you see depends on what version of Event Espresso you have and what addons are installed. Every install include an "Email" messenger tab.  When you click one of those tabs it will display that messenger.',
-        'event_espresso'
-    ); ?>
+		'You can select Messengers via the tabs across the top of the settings page. The available messengers you see depends on what version of Event Espresso you have and what addons are installed. Every install include an "Email" messenger tab.  When you click one of those tabs it will display that messenger.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'There are two ways to determine whether a messenger is active or not.  The first way is via the messenger tab itself.',
-        'event_espresso'
-    ); ?>
+		'There are two ways to determine whether a messenger is active or not.  The first way is via the messenger tab itself.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php printf(
-        esc_html__(
-            'The green colored gear %s indicates that this messenger is currently active.',
-            'event_espresso'
-        ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
-        . ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
-    );
-    printf(
-        esc_html__(
-            ' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
-            'event_espresso'
-        ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
-    ); ?>
+		esc_html__(
+			'The green colored gear %s indicates that this messenger is currently active.',
+			'event_espresso'
+		),
+		'<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
+		. ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
+	);
+	printf(
+		esc_html__(
+			' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
+			'event_espresso'
+		),
+		'<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
+		. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'The second way to determine whether a messenger is active or not is via the "on/off" button in the top right corner of the active messenger displayed content:',
-        'event_espresso'
-    ); ?>
+		'The second way to determine whether a messenger is active or not is via the "on/off" button in the top right corner of the active messenger displayed content:',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php printf(
-        esc_html__(
-            '%1$s means of course that the messenger is active and %2$s means the messenger is inactive.',
-            'event_espresso'
-        ),
-        '<div class="switch">'
-            . '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked" disabled>'
-            . '<label for="ee-on-off-toggle-on"></label>'
-        . '</div>',
-        '<div class="switch">'
-            . '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" disabled>'
-            . '<label for="ee-on-off-toggle-on"></label>'
-        . '</div>'
-    ); ?>
+		esc_html__(
+			'%1$s means of course that the messenger is active and %2$s means the messenger is inactive.',
+			'event_espresso'
+		),
+		'<div class="switch">'
+			. '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked" disabled>'
+			. '<label for="ee-on-off-toggle-on"></label>'
+		. '</div>',
+		'<div class="switch">'
+			. '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" disabled>'
+			. '<label for="ee-on-off-toggle-on"></label>'
+		. '</div>'
+	); ?>
 </p>
 <p>
     <?php
-        esc_html_e(
-            'The on/off toggle is also what you use to activate or deactivate a messenger.',
-            'event_espresso'
-        ); ?>
+		esc_html_e(
+			'The on/off toggle is also what you use to activate or deactivate a messenger.',
+			'event_espresso'
+		); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'What happens when you click the toggle to activate is the messenger is activated and the system determines what default message types are activated with the messenger.  Then, if there are any default settings for either the messenger or message types those settings are saved.  Next, the system will generate any default templates (if none have been generated before, if there are previously generated templates then they are reactivated).  Finally, you will see the display change to reflect that the messenger is active. If the messenger has settings you can modify them then. Any message types that have settings will also automatically expand so you can see the default settings and make any changes as necessary to fit your needs. Usually the defaults are sufficient however.',
-        'event_espresso'
-    ); ?>
+		'What happens when you click the toggle to activate is the messenger is activated and the system determines what default message types are activated with the messenger.  Then, if there are any default settings for either the messenger or message types those settings are saved.  Next, the system will generate any default templates (if none have been generated before, if there are previously generated templates then they are reactivated).  Finally, you will see the display change to reflect that the messenger is active. If the messenger has settings you can modify them then. Any message types that have settings will also automatically expand so you can see the default settings and make any changes as necessary to fit your needs. Usually the defaults are sufficient however.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'When you deactivate a messenger, the system will first check if there are any custom event templates for that messenger. If there are you will be unable to deactivate the messenger. This is a fail safe to make sure you know that no messages will go out for those specific events so you don\'t accidentally deactivate.  If this check passes, then the system will deactivate any global templates for that messenger (note the templates are not erased, they just become inactive, so if you decide to reactivate the messenger later all your customizations are preserved). Then the display will change to reflect the deactivation.',
-        'event_espresso'
-    ); ?>
+		'When you deactivate a messenger, the system will first check if there are any custom event templates for that messenger. If there are you will be unable to deactivate the messenger. This is a fail safe to make sure you know that no messages will go out for those specific events so you don\'t accidentally deactivate.  If this check passes, then the system will deactivate any global templates for that messenger (note the templates are not erased, they just become inactive, so if you decide to reactivate the messenger later all your customizations are preserved). Then the display will change to reflect the deactivation.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <strong><?php esc_html_e('Important', 'event_espresso'); ?></strong><br/>
     <?php esc_html_e(
-        'Although customizations made to global templates are preserved when a messenger is deactivated, any settings for that messenger (or the message types that were attached to it) are lost on deactivation.  Also, once you deactivate a messenger, no more messages will be delivered using that messenger for any of your events.',
-        'event_espresso'
-    ); ?>
+		'Although customizations made to global templates are preserved when a messenger is deactivated, any settings for that messenger (or the message types that were attached to it) are lost on deactivation.  Also, once you deactivate a messenger, no more messages will be delivered using that messenger for any of your events.',
+		'event_espresso'
+	); ?>
 </p>

Spacing +4 added lines, -4 removed lines

@@ -19,16 +19,16 @@
             'The green colored gear %s indicates that this messenger is currently active.',
             'event_espresso'
         ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
-        . ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
+        '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'.'"'
+        . ' alt="'.esc_attr__('Active Email Tab', 'event_espresso').'" />'
     );
     printf(
         esc_html__(
             ' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
             'event_espresso'
         ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
+        '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'
+        . '" alt="'.esc_attr__('Inactive Email Tab', 'event_espresso').'" />'
     ); ?>
 </p>
 <p>

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
     /**
      * This retrieves the EE_Venue from the available data object.
      *
-     * @return EE_Venue|null
+     * @return EE_Base_Class|null
      * @throws EE_Error
      * @throws EntityNotFoundException
      */

Indentation +311 added lines, -311 removed lines

@@ -17,315 +17,315 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-    /**
-     * Will hold the EE_Venue if available
-     *
-     * @var EE_Venue
-     */
-    protected $_venue;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_DETAILS_URL]'       => sprintf(
-                esc_html__(
-                    'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
-                    'event_espresso'
-                ),
-                '[VENUE_URL]'
-            ),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[VENUE_META_*]'            => esc_html__(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     *
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_venue = $this->_get_venue();
-        // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-                break;
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-                break;
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-                break;
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-                break;
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-                break;
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-                break;
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-                break;
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-                break;
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-                break;
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-                break;
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-                break;
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-                break;
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-                break;
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-                break;
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-                break;
-
-            case '[VENUE_DETAILS_URL]':
-                return $this->_venue('permalink');
-                break;
-        }
-
-        if (strpos($shortcode, '[VENUE_META_*') !== false) {
-            $shortcode = str_replace('[VENUE_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-            // pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta($shortcode, true);
-
-            return ! empty($venue_meta) ? $venue_meta : '';
-        }
-    }
-
-    /**
-     * This retrieves the EE_Venue from the available data object.
-     *
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _get_venue()
-    {
-
-        // we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
-        // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event()
-                : null;
-
-            // if still empty do we have a ticket data item?
-            $this->_event = ! $this->_event instanceof EE_Event
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
-                : $this->_event;
-
-            // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
-            // and use that.
-            $this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
-                ? reset($aee->events)
-                : $this->_event;
-        }
-
-        // If we have an event object use it to pull the venue.
-        if ($this->_event instanceof EE_Event) {
-            return $this->_event->get_first_related('Venue');
-        }
-
-        return null;
-    }
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $this->_venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $this->_venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $this->_venue->get('VNU_url');
-                return empty($url) ? $this->_venue->get_permalink() : $url;
-                break;
-
-            case 'permalink':
-                return $this->_venue->get_permalink();
-                break;
-
-            case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $this->_venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $this->_venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $this->_venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $this->_venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $this->_venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $this->_venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $this->_venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $this->_venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($this->_venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($this->_venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     *
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+	/**
+	 * Will hold the EE_Venue if available
+	 *
+	 * @var EE_Venue
+	 */
+	protected $_venue;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_DETAILS_URL]'       => sprintf(
+				esc_html__(
+					'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
+					'event_espresso'
+				),
+				'[VENUE_URL]'
+			),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[VENUE_META_*]'            => esc_html__(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_venue = $this->_get_venue();
+		// If there is no venue object by now then get out.
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+				break;
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+				break;
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+				break;
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+				break;
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+				break;
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+				break;
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+				break;
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+				break;
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+				break;
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+				break;
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+				break;
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+				break;
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+				break;
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+				break;
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+				break;
+
+			case '[VENUE_DETAILS_URL]':
+				return $this->_venue('permalink');
+				break;
+		}
+
+		if (strpos($shortcode, '[VENUE_META_*') !== false) {
+			$shortcode = str_replace('[VENUE_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+			// pull the meta value from the venue post
+			$venue_meta = $this->_venue->get_post_meta($shortcode, true);
+
+			return ! empty($venue_meta) ? $venue_meta : '';
+		}
+	}
+
+	/**
+	 * This retrieves the EE_Venue from the available data object.
+	 *
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _get_venue()
+	{
+
+		// we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
+		// reg_obj instead.
+		if (! $this->_event instanceof EE_Event) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event()
+				: null;
+
+			// if still empty do we have a ticket data item?
+			$this->_event = ! $this->_event instanceof EE_Event
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+				: $this->_event;
+
+			// if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
+			// and use that.
+			$this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
+				? reset($aee->events)
+				: $this->_event;
+		}
+
+		// If we have an event object use it to pull the venue.
+		if ($this->_event instanceof EE_Event) {
+			return $this->_event->get_first_related('Venue');
+		}
+
+		return null;
+	}
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $this->_venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $this->_venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $this->_venue->get('VNU_url');
+				return empty($url) ? $this->_venue->get_permalink() : $url;
+				break;
+
+			case 'permalink':
+				return $this->_venue->get_permalink();
+				break;
+
+			case 'image':
+				return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $this->_venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $this->_venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $this->_venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $this->_venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $this->_venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $this->_venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $this->_venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $this->_venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($this->_venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($this->_venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 *
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -88,7 +88,7 @@ 
     {
         $this->_venue = $this->_get_venue();
         // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         }
 
@@ -184,7 +184,7 @@ 
 
         // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
         // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
             $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
 
@@ -196,7 +196,7 @@ 
             $this->_event = ! $this->_event instanceof EE_Event
                             && $this->_data instanceof EE_Ticket
                             && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
                 : $this->_event;
 
             // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
@@ -225,7 +225,7 @@ 
     private function _venue($field)
     {
 
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         } //no venue so get out.
 
@@ -248,11 +248,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$this->_venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $this->_venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

core/libraries/form_sections/inputs/EE_Radio_Button_Input.input.php

Indentation +17 added lines, -17 removed lines

@@ -15,22 +15,22 @@
 class EE_Radio_Button_Input extends EE_Form_Input_With_Options_Base
 {
 
-    /**
-     * @param array $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
-        $this->_add_validation_strategy(
-            new EE_Enum_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        $this->_multiple_selections = false;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
+		$this->_add_validation_strategy(
+			new EE_Enum_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		$this->_multiple_selections = false;
+		parent::__construct($answer_options, $input_settings);
+	}
 
 }

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
             )
         );
         parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' datepicker');
+        $this->set_html_class($this->html_class().' datepicker');
         // add some style and make it dance
         add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
         add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
@@ -48,7 +48,7 @@ 
         // load css
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );

Indentation +38 added lines, -38 removed lines

@@ -10,45 +10,45 @@
 class EE_Datepicker_Input extends EE_Form_Input_Base
 {
 
-    /**
-     * @param array $input_settings
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        // we could do better for validation, but at least verify its plaintext
-        $this->_add_validation_strategy(
-            new EE_Plaintext_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' datepicker');
-        // add some style and make it dance
-        add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
-        add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
-    }
+	/**
+	 * @param array $input_settings
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		// we could do better for validation, but at least verify its plaintext
+		$this->_add_validation_strategy(
+			new EE_Plaintext_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class() . ' datepicker');
+		// add some style and make it dance
+		add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+		add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+	}
 
 
 
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-    }
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+	}
 }

public/Espresso_Arabica_2014/loop-espresso_event_attendees.php

Indentation +18 added lines, -18 removed lines

@@ -22,15 +22,15 @@ 
 
 <div class="event-attendees">
     <?php do_action_ref_array(
-        'AHEE__loop-espresso_event_attendees__before',
-        array(
-            $contacts,
-            $event,
-            $datetime,
-            $ticket,
-            $show_gravatar,
-        )
-    ); ?>
+		'AHEE__loop-espresso_event_attendees__before',
+		array(
+			$contacts,
+			$event,
+			$datetime,
+			$ticket,
+			$show_gravatar,
+		)
+	); ?>
 	<?php if ( $contacts ) : ?>
 		<ul class="event-attendees-list">
 			<?php foreach( $contacts as $contact ) :
@@ -47,13 +47,13 @@ 
 		<p><?php echo $no_attendees_message; ?></p>
 	<?php endif; ?>
     <?php do_action_ref_array(
-        'AHEE__loop-espresso_event_attendees__after',
-        array(
-            $contacts,
-            $event,
-            $datetime,
-            $ticket,
-            $show_gravatar,
-        )
-    ); ?>
+		'AHEE__loop-espresso_event_attendees__after',
+		array(
+			$contacts,
+			$event,
+			$datetime,
+			$ticket,
+			$show_gravatar,
+		)
+	); ?>
 </div>
\ No newline at end of file

Spacing +5 added lines, -5 removed lines

@@ -15,7 +15,7 @@ 
  * @type bool       $show_gravatar  whether to show gravatar or not.
  */
 
-$no_attendees_message =  apply_filters( 'FHEE__loop-espresso_attendees-shortcode__template__no_attendees_message', __('No Attendees Yet', 'event_espresso' ) );
+$no_attendees_message = apply_filters('FHEE__loop-espresso_attendees-shortcode__template__no_attendees_message', __('No Attendees Yet', 'event_espresso'));
 
 
 ?>
@@ -31,16 +31,16 @@ 
             $show_gravatar,
         )
     ); ?>
-	<?php if ( $contacts ) : ?>
+	<?php if ($contacts) : ?>
 		<ul class="event-attendees-list">
-			<?php foreach( $contacts as $contact ) :
-				EEH_Template::get_template_part( 'content', 'espresso_event_attendees', array( 
+			<?php foreach ($contacts as $contact) :
+				EEH_Template::get_template_part('content', 'espresso_event_attendees', array( 
 					'contact'       => $contact, 
 					'event'         => $event,
 					'datetime'      => $datetime,
 					'ticket'        => $ticket,
 					'show_gravatar' => $show_gravatar 
-				) );
+				));
 				endforeach; ?>
 		</ul>
 	<?php else : ?>

Braces +5 added lines, -2 removed lines

@@ -43,8 +43,11 @@
 				) );
 				endforeach; ?>
 		</ul>
-	<?php else : ?>
-		<p><?php echo $no_attendees_message; ?></p>
+	<?php else {
+	: ?>
+		<p><?php echo $no_attendees_message;
+}
+?></p>
 	<?php endif; ?>
     <?php do_action_ref_array(
         'AHEE__loop-espresso_event_attendees__after',