eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Generator.lib.php

Indentation +978 added lines, -978 removed lines

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

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

Indentation +227 added lines, -227 removed lines

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

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Indentation +1137 added lines, -1137 removed lines

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

Spacing +57 added lines, -57 removed lines

@@ -193,8 +193,8 @@ 
     public function get_active_messenger($messenger)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ])
-            ? $this->_active_messengers[ $messenger ]
+        return ! empty($this->_active_messengers[$messenger])
+            ? $this->_active_messengers[$messenger]
             : null;
     }
 
@@ -208,7 +208,7 @@ 
             $this->_installed_messengers = [];
             $this->messenger_collection()->rewind();
             while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] =
+                $this->_installed_messengers[$this->messenger_collection()->current()->name] =
                     $this->messenger_collection()->current();
                 $this->messenger_collection()->next();
             }
@@ -292,7 +292,7 @@ 
     public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
     }
 
 
@@ -305,7 +305,7 @@ 
     public function is_messenger_active($messenger_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]);
     }
 
 
@@ -321,8 +321,8 @@ 
         $settings = [];
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
             $settings =
-                isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
-                    ? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
+                isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'])
+                    ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings']
                     : [];
         }
         return $settings;
@@ -340,8 +340,8 @@ 
     {
         $this->_initialize_collections();
         return
-            ! empty($this->_active_message_types[ $messenger_name ])
-            && ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
+            ! empty($this->_active_message_types[$messenger_name])
+            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types']);
     }
 
 
@@ -356,13 +356,13 @@ 
     public function get_active_message_types_for_messenger($messenger_name)
     {
         $message_types = [];
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
+        if ( ! $this->messenger_has_active_message_types($messenger_name)) {
             return $message_types;
         }
         $installed_message_types = $this->installed_message_types();
         foreach ($installed_message_types as $message_type_name => $message_type) {
             if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[ $message_type_name ] = $message_type;
+                $message_types[$message_type_name] = $message_type;
             }
         }
         return $message_types;
@@ -381,11 +381,11 @@ 
         $active_message_type_names = [];
         $this->_initialize_collections();
         foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
+            if ( ! isset($messenger_settings['settings'][$messenger.'-message_types'])) {
                 continue;
             }
-            foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
+            foreach ($messenger_settings['settings'][$messenger.'-message_types'] as $message_type_name => $message_type_config) {
+                if ( ! in_array($message_type_name, $active_message_type_names)) {
                     $active_message_type_names[] = $message_type_name;
                 }
             }
@@ -406,9 +406,9 @@ 
         $installed_message_types   = $this->installed_message_types();
         $active_message_type_names = $this->list_of_active_message_types();
         foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[ $active_message_type_name ])) {
-                $active_message_types[ $active_message_type_name ] =
-                    $installed_message_types[ $active_message_type_name ];
+            if (isset($installed_message_types[$active_message_type_name])) {
+                $active_message_types[$active_message_type_name] =
+                    $installed_message_types[$active_message_type_name];
             }
         }
         return $active_message_types;
@@ -423,7 +423,7 @@ 
         if (empty($this->_installed_message_types)) {
             $this->message_type_collection()->rewind();
             while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[ $this->message_type_collection()->current()->name ] =
+                $this->_installed_message_types[$this->message_type_collection()->current()->name] =
                     $this->message_type_collection()->current();
                 $this->message_type_collection()->next();
             }
@@ -463,7 +463,7 @@ 
     public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
     {
         $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
+        if ( ! in_array($message_type_name, $valid_message_types)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -593,7 +593,7 @@ 
      */
     public function ensure_messenger_is_active($messenger_name, $update_option = true)
     {
-        if (! isset($this->_active_messengers[ $messenger_name ])) {
+        if ( ! isset($this->_active_messengers[$messenger_name])) {
             try {
                 $this->activate_messenger($messenger_name, [], $update_option);
             } catch (EE_Error $e) {
@@ -640,7 +640,7 @@ 
             $this->ensure_messenger_is_active($messenger_name, $update_option);
         }
 
-        if (! empty($not_installed)) {
+        if ( ! empty($not_installed)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -676,7 +676,7 @@ 
             // ensure messenger is active (that's an inherent coupling between active message types and the
             // messenger they are being activated for.
             try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+                if ( ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
                     // all is good so let's just get it active
                     $this->activate_messenger($messenger, [$message_type_name], $update_option);
                 }
@@ -740,7 +740,7 @@ 
             : $this->messenger_collection()->get_by_info($messenger);
         // it's inactive. Activate it.
         if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[ $messenger->name ] = $messenger;
+            $this->_active_messengers[$messenger->name] = $messenger;
             // activate incoming message types set to be activated with messenger.
             $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
             // setup any initial settings for the messenger if necessary.
@@ -752,7 +752,7 @@ 
             // generate new templates if necessary and ensure all related templates that are already in the database are
             // marked active.  Note, this will also deactivate a message type for a messenger if the template
             // cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
+            if ( ! empty($message_type_names)) {
                 $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
                 EEH_MSG_Template::update_to_active([$messenger->name], $message_type_names);
             }
@@ -776,13 +776,13 @@ 
         // things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
         // So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
         // only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
+        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
             ? $messenger->get_default_message_types()
             : (array) $message_type_names;
 
         // now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[ $messenger->name ])) {
-            $this->_active_message_types[ $messenger->name ]['settings'] = [];
+        if ( ! isset($this->_active_message_types[$messenger->name])) {
+            $this->_active_message_types[$messenger->name]['settings'] = [];
         }
 
         if ($message_type_names) {
@@ -823,16 +823,16 @@ 
         if ($message_type instanceof EE_message_type) {
             $default_settings = $message_type->get_admin_settings_fields();
             foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[ $field ])) {
-                    $existing_settings[ $field ] = $new_settings[ $field ];
+                if (isset($new_settings[$field])) {
+                    $existing_settings[$field] = $new_settings[$field];
                     continue;
                 }
-                if (! isset($existing_settings[ $field ])) {
-                    $existing_settings[ $field ] = $values['default'];
+                if ( ! isset($existing_settings[$field])) {
+                    $existing_settings[$field] = $values['default'];
                 }
             }
         }
-        $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] =
+        $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'] =
             $existing_settings;
     }
 
@@ -855,12 +855,12 @@ 
         }
 
         // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ] = [];
+        if ( ! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name] = [];
         }
         // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
+        if ( ! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
         }
     }
 
@@ -878,17 +878,17 @@ 
         $messenger = $this->get_messenger($messenger_name);
         if ($messenger instanceof EE_messenger) {
             $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
+            if ( ! empty($msgr_settings)) {
                 foreach ($msgr_settings as $field => $value) {
                     // is there a new setting for this?
-                    if (isset($new_settings[ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] =
-                            $new_settings[ $field ];
+                    if (isset($new_settings[$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] =
+                            $new_settings[$field];
                         continue;
                     }
                     // only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
+                    if ( ! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] = $value;
                     }
                 }
             }
@@ -908,8 +908,8 @@ 
         if ($messenger_name instanceof EE_messenger) {
             $messenger_name = $messenger_name->name;
         }
-        unset($this->_active_messengers[ $messenger_name ]);
-        unset($this->_active_message_types[ $messenger_name ]);
+        unset($this->_active_messengers[$messenger_name]);
+        unset($this->_active_message_types[$messenger_name]);
         $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
         $this->update_active_messengers_option();
     }
@@ -932,7 +932,7 @@ 
         }
         foreach ($this->_active_message_types as $messenger_name => $settings) {
             unset(
-                $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
+                $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]
             );
 
             // we always record (even on deactivation) that a message type has been activated because there should at
@@ -958,7 +958,7 @@ 
     {
         $this->_initialize_collections();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
         }
         $this->_message_template_group_model->deactivate_message_template_groups_for(
             [$messenger_name],
@@ -1021,23 +1021,23 @@ 
             ? 'slugs'
             : 'all';
         // check if contexts has been setup yet.
-        if (empty($this->_contexts[ $key ])) {
+        if (empty($this->_contexts[$key])) {
             // So let's get all active message type objects and loop through to get all unique contexts
             foreach ($this->get_active_message_type_objects() as $message_type) {
                 if ($message_type instanceof EE_message_type) {
                     $message_type_contexts = $message_type->get_contexts();
                     if ($slugs_only) {
                         foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[ $key ][ $context ] = $context_details['label'];
+                            $this->_contexts[$key][$context] = $context_details['label'];
                         }
                     } else {
-                        $this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
+                        $this->_contexts[$key][$message_type->name] = $message_type_contexts;
                     }
                 }
             }
         }
-        return ! empty($this->_contexts[ $key ])
-            ? $this->_contexts[ $key ]
+        return ! empty($this->_contexts[$key])
+            ? $this->_contexts[$key]
             : [];
     }
 
@@ -1058,7 +1058,7 @@ 
         $all_message_types_valid           = true;
         // loop through list of active message types and verify they are installed.
         foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[ $message_type_name ])) {
+            if ( ! isset($installed_message_types[$message_type_name])) {
                 $this->remove_message_type_has_been_activated_from_all_messengers(
                     $message_type_name,
                     true
@@ -1085,8 +1085,8 @@ 
     public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
     {
         $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[ $messenger_name ])
-               && in_array($message_type_name, $has_activated[ $messenger_name ]);
+        return isset($has_activated[$messenger_name])
+               && in_array($message_type_name, $has_activated[$messenger_name]);
     }
 
 
@@ -1115,11 +1115,11 @@ 
             return;
         }
         $has_activated        = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[ $messenger_name ])
-            ? array_search($message_type_name, $has_activated[ $messenger_name ], true)
+        $key_for_message_type = isset($has_activated[$messenger_name])
+            ? array_search($message_type_name, $has_activated[$messenger_name], true)
             : false;
         if ($key_for_message_type !== false) {
-            unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
+            unset($has_activated[$messenger_name][$key_for_message_type]);
             $this->update_has_activated_messengers_option($has_activated);
             // reset the internal cached property
             $this->get_has_activated_messengers_option(true);

core/libraries/messages/EE_Message_Factory.lib.php

Indentation +136 added lines, -136 removed lines

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

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +640 added lines, -640 removed lines

@@ -47,644 +47,644 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to set up the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
-        $DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(
-                esc_html__('You do not have permission to view registrations', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename()
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
-        } else {
-            $query_params = [
-                [ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
-                'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
-                'force_join' => ['Transaction', 'Ticket', 'Attendee'],
-                'caps'       => EEM_Base::caps_read_admin,
-            ];
-            if ($event_id) {
-                $query_params[0]['EVT_ID'] = $event_id;
-            } else {
-                $query_params['force_join'][] = 'Event';
-            }
-        }
-        // unless the query params already include a status,
-        // we want to exclude registrations from failed or abandoned transactions
-        if (! isset($query_params[0]['Transaction.STS_ID'])) {
-            $query_params[0]['OR'] = [
-                // don't include registrations from failed or abandoned transactions...
-                'Transaction.STS_ID' => [
-                    'NOT IN',
-                    [
-                        EEM_Transaction::failed_status_code,
-                        EEM_Transaction::abandoned_status_code,
-                    ],
-                ],
-                // unless the registration is approved,
-                // in which case include it regardless of transaction status
-                'STS_ID' => RegStatus::APPROVED,
-            ];
-        }
-
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
-        }
-
-        $return_url_args = [];
-        parse_str(
-            parse_url(
-                $job_parameters->request_datum('return_url'),
-                PHP_URL_QUERY
-            ),
-            $return_url_args
-        );
-
-        if (
-            isset($return_url_args['orderby'], $return_url_args['order'])
-            && $return_url_args['orderby'] === 'ATT_lname'
-        ) {
-            $query_params['order_by'] = [
-                'Attendee.ATT_lname' => $return_url_args['order'],
-                'Attendee.ATT_fname' => $return_url_args['order'],
-                'REG_ID' => $return_url_args['order']
-            ];
-        }
-
-        $query_params = apply_filters(
-            'FHEE__EE_Export__report_registration_for_event',
-            $query_params,
-            $event_id
-        );
-
-        $utc_timezone = new DateTimeZone('UTC');
-        $site_timezone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-        $query_params = $this->convertDateStringsToObjects($query_params, $site_timezone, $utc_timezone);
-
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size($this->count_units_to_process($query_params));
-        // we need to set the header columns
-        // but to do that we need to process one row so that we can extract ALL the column headers
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $question_labels,
-            $query_params,
-            $DTT_ID
-        );
-        // but we don't want to write any actual data yet...
-        // so let's blank out all the values for that first row
-        array_walk(
-            $csv_data_for_row[0],
-            function (&$value) {
-                $value = null;
-            }
-        );
-
-        EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
-        $this->updateTextHeader(
-            esc_html__('Registrations report started successfully...', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
-
-
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename(): string
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
-            sprintf(
-                'event-espresso-registrations-%s.csv',
-                str_replace([':', ' '], '-', current_time('mysql'))
-            )
-        );
-    }
-
-
-    /**
-     * Gets the questions which are to be used for this report,
-     * so they can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_labels(array $registration_query_params): array
-    {
-        $where                 = $registration_query_params[0] ?? null;
-        $question_query_params = [];
-        if ($where !== null) {
-            $question_query_params = [
-                $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
-            ];
-        }
-        // Make sure it's not a system question
-        $question_query_params[0]['OR*not-system-questions'] = [
-            'QST_system'      => '',
-            'QST_system*null' => ['IS_NULL']
-        ];
-        if (
-            apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
-                false,
-                $registration_query_params
-            )
-        ) {
-            $question_query_params[0]['Answer.ANS_ID'] = ['IS_NOT_NULL'];
-        }
-        $question_query_params['order_by'] = [
-            'Question_Group_Question.QGQ_order' => 'ASC',
-            'QST_order' => 'ASC',
-            'QST_admin_label' => 'ASC'
-        ];
-        $question_query_params['group_by'] = ['QST_ID'];
-        return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
-
-
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
-    {
-        $question_where_params = [];
-        foreach ($reg_where_params as $key => $val) {
-            if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] =
-                    $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                (int) $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params'),
-                (int) $job_parameters->request_datum('DTT_ID', '0')
-            );
-            EEH_Export::write_data_array_to_csv(
-                $job_parameters->extra_datum('filepath'),
-                $csv_data,
-                false
-            );
-            $units_processed = count($csv_data);
-            if ($units_processed) {
-                $job_parameters->mark_processed($units_processed);
-                $this->updateText(
-                    sprintf(
-                        esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
-                        $units_processed
-                    )
-                );
-            }
-        }
-        $extra_response_data = ['file_url' => ''];
-        if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-            $this->displayJobFinalResults($job_parameters);
-        } else {
-            $job_parameters->set_status(JobParameters::status_continue);
-        }
-        return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
-    }
-
-
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int      $offset
-     * @param int      $limit
-     * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array    $query_params    for using where querying the model
-     * @param int      $DTT_ID
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_csv_data_for(
-        ?int $event_id,
-        int $offset,
-        int $limit,
-        array $question_labels,
-        array $query_params,
-        int $DTT_ID = 0
-    ): array {
-        $reg_fields_to_include = [
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        ];
-        $att_fields_to_include = [
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        ];
-
-        // get models
-        $event_model   = EEM_Event::instance();
-        $date_model    = EEM_Datetime::instance();
-        $ticket_model  = EEM_Ticket::instance();
-        $txn_model     = EEM_Transaction::instance();
-        $reg_model     = EEM_Registration::instance();
-        $pay_model     = EEM_Payment::instance();
-        $status_model  = EEM_Status::instance();
-
-        $registrations_csv_ready_array = [];
-        $query_params['limit']         = [$offset, $limit];
-        $registration_rows             = $reg_model->get_all_wpdb_results($query_params);
-
-        foreach ($registration_rows as $reg_row) {
-            if (! is_array($reg_row)) {
-                continue;
-            }
-            $reg_csv_array = [];
-            // registration ID
-            $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
-                EEH_Export::prepare_value_from_db_for_display(
-                    $reg_model,
-                    'REG_ID',
-                    $reg_row[ $reg_id_field->get_qualified_column() ]
-                );
-            // ALL registrations, or is list filtered to just one?
-            if (! $event_id) {
-                // ALL registrations, so get each event's name and ID
-                $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
-                    /* translators: 1: event name, 2: event ID */
-                    esc_html__('%1$s (%2$s)', 'event_espresso'),
-                    EEH_Export::prepare_value_from_db_for_display(
-                        $event_model,
-                        'EVT_name',
-                        $reg_row['Event_CPT.post_title']
-                    ),
-                    $reg_row['Event_CPT.ID']
-                );
-            }
-            // add attendee columns
-            $reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
-            // add registration columns
-            $reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
-            // get pretty status
-            $stati = $status_model->localized_status(
-                [
-                    $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                    $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                ],
-                false,
-                'sentence'
-            );
-            $is_primary_reg = $reg_row['Registration.REG_count'] == '1';
-
-            $reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
-                $stati[ $reg_row['Registration.STS_ID'] ];
-            // get pretty transaction status
-            $reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
-                $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_total',
-                    $reg_row['TransactionTable.TXN_total'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_paid',
-                    $reg_row['TransactionTable.TXN_paid'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $payment_methods                                                                  = [];
-            $gateway_txn_ids_etc                                                              = [];
-            $payment_times                                                                    = [];
-            if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                $payments_info = $pay_model->get_all_wpdb_results(
-                    [
-                        [
-                            'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                            'STS_ID' => EEM_Payment::status_id_approved,
-                        ],
-                        'force_join' => ['Payment_Method'],
-                    ],
-                    ARRAY_A,
-                    'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                );
-                [$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
-                    $payments_info
-                );
-            }
-
-            $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_times
-            );
-
-            $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_methods
-            );
-
-            $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                ',',
-                $gateway_txn_ids_etc
-            );
-
-            $ticket_name      = esc_html__('Unknown', 'event_espresso');
-            $datetime_strings = [esc_html__('Unknown', 'event_espresso')];
-            if ($reg_row['Ticket.TKT_ID']) {
-                $ticket_name       = EEH_Export::prepare_value_from_db_for_display(
-                    $ticket_model,
-                    'TKT_name',
-                    $reg_row['Ticket.TKT_name']
-                );
-                $datetime_strings = [];
-                $datetimes        = $date_model->get_all_wpdb_results(
-                    [
-                        ['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    $datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
-                        $date_model,
-                        'DTT_EVT_start',
-                        $datetime['Datetime.DTT_EVT_start']
-                    );
-                }
-            }
-
-            $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-
-
-            $reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
-                ', ',
-                $datetime_strings
-            );
-
-            // add answer columns
-            $reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
-            // Include check-in data
-            if ($event_id && $DTT_ID) {
-                // get whether the user has checked in
-                $reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin',
-                        [
-                            [
-                                'DTT_ID' => $DTT_ID
-                            ]
-                        ]
-                    );
-                $datetime     = $date_model->get_one_by_ID($DTT_ID);
-                $checkin_rows = EEM_Checkin::instance()->get_all(
-                    [
-                        [
-                            'REG_ID' => $reg_row['Registration.REG_ID'],
-                            'DTT_ID' => $datetime->get('DTT_ID'),
-                        ],
-                    ]
-                );
-                $checkins     = [];
-                foreach ($checkin_rows as $checkin_row) {
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    if ($checkin_value) {
-                        $checkins[] = $checkin_value;
-                    }
-                }
-                $datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
-                $reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
-            } elseif ($event_id) {
-                // get whether the user has checked in
-                $reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin'
-                    );
-
-                $datetimes = $date_model->get_all(
-                    [
-                        [
-                            'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
-                        ],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    if (! $datetime instanceof EE_Datetime) {
-                        continue;
-                    }
-
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_row = EEM_Checkin::instance()->get_one(
-                        [
-                            [
-                                'REG_ID' => $reg_row['Registration.REG_ID'],
-                                'DTT_ID' => $datetime->get('DTT_ID'),
-                            ],
-                            'limit'    => 1,
-                            'order_by' => [
-                                'CHK_ID' => 'DESC'
-                            ]
-                        ]
-                    );
-
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    $datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
-
-                    $reg_csv_array[ $datetime_name ] = $checkin_value;
-                }
-            }
-            /**
-             * Filter to change the contents of each row of the registrations report CSV file.
-             * This can be used to add or remote columns from the CSV file, or change their values.
-             * Note when using: all rows in the CSV should have the same columns.
-             *
-             * @param array $reg_csv_array keys are the column names, values are their cell values
-             * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
-             */
-            $registrations_csv_ready_array[] = apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-                $reg_csv_array,
-                $reg_row
-            );
-        }
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array               = [];
-            $model_and_fields_to_include = [
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            ];
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field                                                          =
-                        $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
-
-
-    /**
-     * recursively convert MySQL format date strings in query params array to Datetime objects
-     *
-     * @param array        $query_params
-     * @param DateTimeZone $site_timezone
-     * @param DateTimeZone $utc_timezone
-     * @return array
-     * @throws Exception
-     * @since 5.0.19.p
-     */
-    private function convertDateStringsToObjects(
-        array $query_params,
-        DateTimeZone $site_timezone,
-        DateTimeZone $utc_timezone
-    ): array {
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $query_params[ $key ] = $this->convertDateStringsToObjects($value, $site_timezone, $utc_timezone);
-                continue;
-            }
-            if (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/', $value)) {
-                $query_params[ $key ] = DbSafeDateTime::createFromFormat('Y-m-d H:i:s', $value, $site_timezone);
-                $query_params[ $key ] = $query_params[ $key ]->setTimezone($utc_timezone);
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Counts total unit to process
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_units_to_process(array $query_params): int
-    {
-        return EEM_Registration::instance()->count(
-            array_diff_key(
-                $query_params,
-                array_flip(
-                    ['limit']
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
-
-        $this->_file_helper->delete(
-            EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        $this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to set up the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
+		$DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
+		if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(
+				esc_html__('You do not have permission to view registrations', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename()
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
+		} else {
+			$query_params = [
+				[ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
+				'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
+				'force_join' => ['Transaction', 'Ticket', 'Attendee'],
+				'caps'       => EEM_Base::caps_read_admin,
+			];
+			if ($event_id) {
+				$query_params[0]['EVT_ID'] = $event_id;
+			} else {
+				$query_params['force_join'][] = 'Event';
+			}
+		}
+		// unless the query params already include a status,
+		// we want to exclude registrations from failed or abandoned transactions
+		if (! isset($query_params[0]['Transaction.STS_ID'])) {
+			$query_params[0]['OR'] = [
+				// don't include registrations from failed or abandoned transactions...
+				'Transaction.STS_ID' => [
+					'NOT IN',
+					[
+						EEM_Transaction::failed_status_code,
+						EEM_Transaction::abandoned_status_code,
+					],
+				],
+				// unless the registration is approved,
+				// in which case include it regardless of transaction status
+				'STS_ID' => RegStatus::APPROVED,
+			];
+		}
+
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
+		}
+
+		$return_url_args = [];
+		parse_str(
+			parse_url(
+				$job_parameters->request_datum('return_url'),
+				PHP_URL_QUERY
+			),
+			$return_url_args
+		);
+
+		if (
+			isset($return_url_args['orderby'], $return_url_args['order'])
+			&& $return_url_args['orderby'] === 'ATT_lname'
+		) {
+			$query_params['order_by'] = [
+				'Attendee.ATT_lname' => $return_url_args['order'],
+				'Attendee.ATT_fname' => $return_url_args['order'],
+				'REG_ID' => $return_url_args['order']
+			];
+		}
+
+		$query_params = apply_filters(
+			'FHEE__EE_Export__report_registration_for_event',
+			$query_params,
+			$event_id
+		);
+
+		$utc_timezone = new DateTimeZone('UTC');
+		$site_timezone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+		$query_params = $this->convertDateStringsToObjects($query_params, $site_timezone, $utc_timezone);
+
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size($this->count_units_to_process($query_params));
+		// we need to set the header columns
+		// but to do that we need to process one row so that we can extract ALL the column headers
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$question_labels,
+			$query_params,
+			$DTT_ID
+		);
+		// but we don't want to write any actual data yet...
+		// so let's blank out all the values for that first row
+		array_walk(
+			$csv_data_for_row[0],
+			function (&$value) {
+				$value = null;
+			}
+		);
+
+		EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
+		$this->updateTextHeader(
+			esc_html__('Registrations report started successfully...', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
+
+
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename(): string
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
+			sprintf(
+				'event-espresso-registrations-%s.csv',
+				str_replace([':', ' '], '-', current_time('mysql'))
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the questions which are to be used for this report,
+	 * so they can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_labels(array $registration_query_params): array
+	{
+		$where                 = $registration_query_params[0] ?? null;
+		$question_query_params = [];
+		if ($where !== null) {
+			$question_query_params = [
+				$this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
+			];
+		}
+		// Make sure it's not a system question
+		$question_query_params[0]['OR*not-system-questions'] = [
+			'QST_system'      => '',
+			'QST_system*null' => ['IS_NULL']
+		];
+		if (
+			apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
+				false,
+				$registration_query_params
+			)
+		) {
+			$question_query_params[0]['Answer.ANS_ID'] = ['IS_NOT_NULL'];
+		}
+		$question_query_params['order_by'] = [
+			'Question_Group_Question.QGQ_order' => 'ASC',
+			'QST_order' => 'ASC',
+			'QST_admin_label' => 'ASC'
+		];
+		$question_query_params['group_by'] = ['QST_ID'];
+		return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
+
+
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
+	{
+		$question_where_params = [];
+		foreach ($reg_where_params as $key => $val) {
+			if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] =
+					$this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				(int) $job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params'),
+				(int) $job_parameters->request_datum('DTT_ID', '0')
+			);
+			EEH_Export::write_data_array_to_csv(
+				$job_parameters->extra_datum('filepath'),
+				$csv_data,
+				false
+			);
+			$units_processed = count($csv_data);
+			if ($units_processed) {
+				$job_parameters->mark_processed($units_processed);
+				$this->updateText(
+					sprintf(
+						esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+						$units_processed
+					)
+				);
+			}
+		}
+		$extra_response_data = ['file_url' => ''];
+		if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+			$this->displayJobFinalResults($job_parameters);
+		} else {
+			$job_parameters->set_status(JobParameters::status_continue);
+		}
+		return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
+	}
+
+
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int      $offset
+	 * @param int      $limit
+	 * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array    $query_params    for using where querying the model
+	 * @param int      $DTT_ID
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_csv_data_for(
+		?int $event_id,
+		int $offset,
+		int $limit,
+		array $question_labels,
+		array $query_params,
+		int $DTT_ID = 0
+	): array {
+		$reg_fields_to_include = [
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		];
+		$att_fields_to_include = [
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		];
+
+		// get models
+		$event_model   = EEM_Event::instance();
+		$date_model    = EEM_Datetime::instance();
+		$ticket_model  = EEM_Ticket::instance();
+		$txn_model     = EEM_Transaction::instance();
+		$reg_model     = EEM_Registration::instance();
+		$pay_model     = EEM_Payment::instance();
+		$status_model  = EEM_Status::instance();
+
+		$registrations_csv_ready_array = [];
+		$query_params['limit']         = [$offset, $limit];
+		$registration_rows             = $reg_model->get_all_wpdb_results($query_params);
+
+		foreach ($registration_rows as $reg_row) {
+			if (! is_array($reg_row)) {
+				continue;
+			}
+			$reg_csv_array = [];
+			// registration ID
+			$reg_id_field = $reg_model->field_settings_for('REG_ID');
+			$reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
+				EEH_Export::prepare_value_from_db_for_display(
+					$reg_model,
+					'REG_ID',
+					$reg_row[ $reg_id_field->get_qualified_column() ]
+				);
+			// ALL registrations, or is list filtered to just one?
+			if (! $event_id) {
+				// ALL registrations, so get each event's name and ID
+				$reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+					/* translators: 1: event name, 2: event ID */
+					esc_html__('%1$s (%2$s)', 'event_espresso'),
+					EEH_Export::prepare_value_from_db_for_display(
+						$event_model,
+						'EVT_name',
+						$reg_row['Event_CPT.post_title']
+					),
+					$reg_row['Event_CPT.ID']
+				);
+			}
+			// add attendee columns
+			$reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
+			// add registration columns
+			$reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
+			// get pretty status
+			$stati = $status_model->localized_status(
+				[
+					$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+				],
+				false,
+				'sentence'
+			);
+			$is_primary_reg = $reg_row['Registration.REG_count'] == '1';
+
+			$reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
+				$stati[ $reg_row['Registration.STS_ID'] ];
+			// get pretty transaction status
+			$reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
+				$stati[ $reg_row['TransactionTable.STS_ID'] ];
+			$reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_total',
+					$reg_row['TransactionTable.TXN_total'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_paid',
+					$reg_row['TransactionTable.TXN_paid'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$payment_methods                                                                  = [];
+			$gateway_txn_ids_etc                                                              = [];
+			$payment_times                                                                    = [];
+			if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+				$payments_info = $pay_model->get_all_wpdb_results(
+					[
+						[
+							'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+							'STS_ID' => EEM_Payment::status_id_approved,
+						],
+						'force_join' => ['Payment_Method'],
+					],
+					ARRAY_A,
+					'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+				);
+				[$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
+					$payments_info
+				);
+			}
+
+			$reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_times
+			);
+
+			$reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_methods
+			);
+
+			$reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+				',',
+				$gateway_txn_ids_etc
+			);
+
+			$ticket_name      = esc_html__('Unknown', 'event_espresso');
+			$datetime_strings = [esc_html__('Unknown', 'event_espresso')];
+			if ($reg_row['Ticket.TKT_ID']) {
+				$ticket_name       = EEH_Export::prepare_value_from_db_for_display(
+					$ticket_model,
+					'TKT_name',
+					$reg_row['Ticket.TKT_name']
+				);
+				$datetime_strings = [];
+				$datetimes        = $date_model->get_all_wpdb_results(
+					[
+						['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					$datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
+						$date_model,
+						'DTT_EVT_start',
+						$datetime['Datetime.DTT_EVT_start']
+					);
+				}
+			}
+
+			$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+
+
+			$reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
+				', ',
+				$datetime_strings
+			);
+
+			// add answer columns
+			$reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
+			// Include check-in data
+			if ($event_id && $DTT_ID) {
+				// get whether the user has checked in
+				$reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin',
+						[
+							[
+								'DTT_ID' => $DTT_ID
+							]
+						]
+					);
+				$datetime     = $date_model->get_one_by_ID($DTT_ID);
+				$checkin_rows = EEM_Checkin::instance()->get_all(
+					[
+						[
+							'REG_ID' => $reg_row['Registration.REG_ID'],
+							'DTT_ID' => $datetime->get('DTT_ID'),
+						],
+					]
+				);
+				$checkins     = [];
+				foreach ($checkin_rows as $checkin_row) {
+					/** @var EE_Checkin $checkin_row */
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					if ($checkin_value) {
+						$checkins[] = $checkin_value;
+					}
+				}
+				$datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
+				$reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
+			} elseif ($event_id) {
+				// get whether the user has checked in
+				$reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin'
+					);
+
+				$datetimes = $date_model->get_all(
+					[
+						[
+							'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
+						],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					if (! $datetime instanceof EE_Datetime) {
+						continue;
+					}
+
+					/** @var EE_Checkin $checkin_row */
+					$checkin_row = EEM_Checkin::instance()->get_one(
+						[
+							[
+								'REG_ID' => $reg_row['Registration.REG_ID'],
+								'DTT_ID' => $datetime->get('DTT_ID'),
+							],
+							'limit'    => 1,
+							'order_by' => [
+								'CHK_ID' => 'DESC'
+							]
+						]
+					);
+
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					$datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
+
+					$reg_csv_array[ $datetime_name ] = $checkin_value;
+				}
+			}
+			/**
+			 * Filter to change the contents of each row of the registrations report CSV file.
+			 * This can be used to add or remote columns from the CSV file, or change their values.
+			 * Note when using: all rows in the CSV should have the same columns.
+			 *
+			 * @param array $reg_csv_array keys are the column names, values are their cell values
+			 * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
+			 */
+			$registrations_csv_ready_array[] = apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+				$reg_csv_array,
+				$reg_row
+			);
+		}
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array               = [];
+			$model_and_fields_to_include = [
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			];
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field                                                          =
+						$model->field_settings_for($field_name);
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
+
+
+	/**
+	 * recursively convert MySQL format date strings in query params array to Datetime objects
+	 *
+	 * @param array        $query_params
+	 * @param DateTimeZone $site_timezone
+	 * @param DateTimeZone $utc_timezone
+	 * @return array
+	 * @throws Exception
+	 * @since 5.0.19.p
+	 */
+	private function convertDateStringsToObjects(
+		array $query_params,
+		DateTimeZone $site_timezone,
+		DateTimeZone $utc_timezone
+	): array {
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$query_params[ $key ] = $this->convertDateStringsToObjects($value, $site_timezone, $utc_timezone);
+				continue;
+			}
+			if (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/', $value)) {
+				$query_params[ $key ] = DbSafeDateTime::createFromFormat('Y-m-d H:i:s', $value, $site_timezone);
+				$query_params[ $key ] = $query_params[ $key ]->setTimezone($utc_timezone);
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Counts total unit to process
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_units_to_process(array $query_params): int
+	{
+		return EEM_Registration::instance()->count(
+			array_diff_key(
+				$query_params,
+				array_flip(
+					['limit']
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
+
+		$this->_file_helper->delete(
+			EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		$this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }

Spacing +35 added lines, -35 removed lines

@@ -65,7 +65,7 @@ 
     {
         $event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
         $DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
             throw new BatchRequestException(
                 esc_html__('You do not have permission to view registrations', 'event_espresso')
             );
@@ -80,7 +80,7 @@ 
             $query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
         } else {
             $query_params = [
-                [ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
+                ['Ticket.TKT_deleted' => ['IN', [true, false]]],
                 'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
                 'force_join' => ['Transaction', 'Ticket', 'Attendee'],
                 'caps'       => EEM_Base::caps_read_admin,
@@ -93,7 +93,7 @@ 
         }
         // unless the query params already include a status,
         // we want to exclude registrations from failed or abandoned transactions
-        if (! isset($query_params[0]['Transaction.STS_ID'])) {
+        if ( ! isset($query_params[0]['Transaction.STS_ID'])) {
             $query_params[0]['OR'] = [
                 // don't include registrations from failed or abandoned transactions...
                 'Transaction.STS_ID' => [
@@ -109,7 +109,7 @@ 
             ];
         }
 
-        if (! isset($query_params['force_join'])) {
+        if ( ! isset($query_params['force_join'])) {
             $query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
         }
 
@@ -161,7 +161,7 @@ 
         // so let's blank out all the values for that first row
         array_walk(
             $csv_data_for_row[0],
-            function (&$value) {
+            function(&$value) {
                 $value = null;
             }
         );
@@ -246,11 +246,11 @@ 
         $question_where_params = [];
         foreach ($reg_where_params as $key => $val) {
             if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] =
+                $question_where_params[$key] =
                     $this->_change_registration_where_params_to_question_where_params($val);
             } else {
                 // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+                $question_where_params['Question_Group.Event.Registration.'.$key] = $val;
             }
         }
         return $question_where_params;
@@ -362,22 +362,22 @@ 
         $registration_rows             = $reg_model->get_all_wpdb_results($query_params);
 
         foreach ($registration_rows as $reg_row) {
-            if (! is_array($reg_row)) {
+            if ( ! is_array($reg_row)) {
                 continue;
             }
             $reg_csv_array = [];
             // registration ID
             $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
+            $reg_csv_array[EEH_Export::get_column_name_for_field($reg_id_field)] =
                 EEH_Export::prepare_value_from_db_for_display(
                     $reg_model,
                     'REG_ID',
-                    $reg_row[ $reg_id_field->get_qualified_column() ]
+                    $reg_row[$reg_id_field->get_qualified_column()]
                 );
             // ALL registrations, or is list filtered to just one?
-            if (! $event_id) {
+            if ( ! $event_id) {
                 // ALL registrations, so get each event's name and ID
-                $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+                $reg_csv_array[esc_html__('Event', 'event_espresso')] = sprintf(
                     /* translators: 1: event name, 2: event ID */
                     esc_html__('%1$s (%2$s)', 'event_espresso'),
                     EEH_Export::prepare_value_from_db_for_display(
@@ -403,12 +403,12 @@ 
             );
             $is_primary_reg = $reg_row['Registration.REG_count'] == '1';
 
-            $reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
-                $stati[ $reg_row['Registration.STS_ID'] ];
+            $reg_csv_array[esc_html__('Registration Status', 'event_espresso')] =
+                $stati[$reg_row['Registration.STS_ID']];
             // get pretty transaction status
-            $reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
-                $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+            $reg_csv_array[esc_html__('Transaction Status', 'event_espresso')]     =
+                $stati[$reg_row['TransactionTable.STS_ID']];
+            $reg_csv_array[esc_html__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
                 ? EEH_Export::prepare_value_from_db_for_display(
                     $txn_model,
                     'TXN_total',
@@ -417,7 +417,7 @@ 
                 )
                 : '0.00';
 
-            $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
+            $reg_csv_array[esc_html__('Amount Paid', 'event_espresso')] = $is_primary_reg
                 ? EEH_Export::prepare_value_from_db_for_display(
                     $txn_model,
                     'TXN_paid',
@@ -446,17 +446,17 @@ 
                 );
             }
 
-            $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Payment Date(s)', 'event_espresso')] = implode(
                 ',',
                 $payment_times
             );
 
-            $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Payment Method(s)', 'event_espresso')] = implode(
                 ',',
                 $payment_methods
             );
 
-            $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                 ',',
                 $gateway_txn_ids_etc
             );
@@ -464,7 +464,7 @@ 
             $ticket_name      = esc_html__('Unknown', 'event_espresso');
             $datetime_strings = [esc_html__('Unknown', 'event_espresso')];
             if ($reg_row['Ticket.TKT_ID']) {
-                $ticket_name       = EEH_Export::prepare_value_from_db_for_display(
+                $ticket_name = EEH_Export::prepare_value_from_db_for_display(
                     $ticket_model,
                     'TKT_name',
                     $reg_row['Ticket.TKT_name']
@@ -486,10 +486,10 @@ 
                 }
             }
 
-            $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+            $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
 
 
-            $reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Ticket Datetimes', 'event_espresso')] = implode(
                 ', ',
                 $datetime_strings
             );
@@ -499,7 +499,7 @@ 
             // Include check-in data
             if ($event_id && $DTT_ID) {
                 // get whether the user has checked in
-                $reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
+                $reg_csv_array[esc_html__('Datetime Check-ins #', 'event_espresso')] =
                     $reg_model->count_related(
                         $reg_row['Registration.REG_ID'],
                         'Checkin',
@@ -518,7 +518,7 @@ 
                         ],
                     ]
                 );
-                $checkins     = [];
+                $checkins = [];
                 foreach ($checkin_rows as $checkin_row) {
                     /** @var EE_Checkin $checkin_row */
                     $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
@@ -527,10 +527,10 @@ 
                     }
                 }
                 $datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
-                $reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
+                $reg_csv_array[$datetime_name] = implode(' --- ', $checkins);
             } elseif ($event_id) {
                 // get whether the user has checked in
-                $reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
+                $reg_csv_array[esc_html__('Event Check-ins #', 'event_espresso')] =
                     $reg_model->count_related(
                         $reg_row['Registration.REG_ID'],
                         'Checkin'
@@ -546,7 +546,7 @@ 
                     ]
                 );
                 foreach ($datetimes as $datetime) {
-                    if (! $datetime instanceof EE_Datetime) {
+                    if ( ! $datetime instanceof EE_Datetime) {
                         continue;
                     }
 
@@ -567,7 +567,7 @@ 
                     $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
                     $datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
 
-                    $reg_csv_array[ $datetime_name ] = $checkin_value;
+                    $reg_csv_array[$datetime_name] = $checkin_value;
                 }
             }
             /**
@@ -596,7 +596,7 @@ 
                 foreach ($field_list as $field_name) {
                     $field                                                          =
                         $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = null;
                 }
             }
             $registrations_csv_ready_array[] = $reg_csv_array;
@@ -622,12 +622,12 @@ 
     ): array {
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $query_params[ $key ] = $this->convertDateStringsToObjects($value, $site_timezone, $utc_timezone);
+                $query_params[$key] = $this->convertDateStringsToObjects($value, $site_timezone, $utc_timezone);
                 continue;
             }
             if (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/', $value)) {
-                $query_params[ $key ] = DbSafeDateTime::createFromFormat('Y-m-d H:i:s', $value, $site_timezone);
-                $query_params[ $key ] = $query_params[ $key ]->setTimezone($utc_timezone);
+                $query_params[$key] = DbSafeDateTime::createFromFormat('Y-m-d H:i:s', $value, $site_timezone);
+                $query_params[$key] = $query_params[$key]->setTimezone($utc_timezone);
             }
         }
         return $query_params;
@@ -680,7 +680,7 @@ 
                         'event_espresso'
                     ),
                     '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
+                    '<a href="'.$job_parameters->request_datum('return_url').'">',
                     '</a>'
                 )
             )

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +834 added lines, -834 removed lines

@@ -16,838 +16,838 @@
  */
 abstract class EE_PMT_Base
 {
-    const onsite  = 'on-site';
-
-    const offsite = 'off-site';
-
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = false;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = null;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = null;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = true;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string|null
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string|null
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string|null
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_button_url = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_description = null;
-
-    /**
-     *  @var string|null
-     */
-    protected $_template_path = null;
-
-    /**
-     * @param EE_Payment_Method|null $pm_instance
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                esc_html__(
-                    'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
-                    'event_espresso'
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form(bool $has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector          = new ReflectionClass(get_class($this));
-        $fn                 = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', '/', $this->file_folder());
-        $file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url   = set_url_scheme($file_path);
-    }
-
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description(): ?string
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder(): ?string
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url(): ?string
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_instance(EE_Payment_Method $payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they set up the payment method
-     *
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function settings_form(): EE_Payment_Method_Form
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure it's reflected in the form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form(EE_Payment_Method_Form $form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form(): bool
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param EE_Transaction|null $transaction
-     * @param array               $extra_args
-     * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                (
-                    $this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                    && $transaction instanceof EE_Transaction
-                    && $transaction->primary_registration() instanceof EE_Registration
-                    && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-                ),
-                $this->_billing_form,
-                $transaction
-            )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param EE_Transaction|null $transaction
-     * @return EE_Billing_Info_Form|null
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * applies debug data to the form
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return EE_Billing_Info_Form|null
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form(EE_Payment_Method $form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https(): bool
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     * @param EE_Transaction            $transaction
-     * @param float|null                $amount
-     * @param EE_Billing_Info_Form|null $billing_info
-     * @param string|null               $return_url
-     * @param string                    $fail_url
-     * @param string                    $method
-     * @param bool                      $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_info = null,
-        $return_url = null,
-        $fail_url = '',
-        $method = 'CART',
-        $by_admin = false
-    ) {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            // there is a gateway, so we're going to make a payment object
-            // but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = [
-                'STS_ID'               => EEM_Payment::status_id_failed,
-                'TXN_ID'               => $transaction->ID(),
-                'PMD_ID'               => $this->_pm_instance->ID(),
-                'PAY_source'           => $method,
-                'PAY_amount'           => $amount !== null
-                    ? $amount
-                    : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            ];
-            $payment              = EEM_Payment::instance()->get_one([$duplicate_properties]);
-            // if we didn't already have a payment in progress for the same thing,
-            // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        [
-                            'PAY_timestamp'       => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number'       => null,
-                            'PAY_extra_accntng'   => null,
-                            'PAY_details'         => null,
-                        ]
-                    )
-                );
-            }
-            // make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        [
-                            'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug(),
-                        ]
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                [
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                ]
-            );
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form|null $billing_form
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        return $billing_form instanceof EE_Form_Section_Proper
-            ? $billing_form->input_pretty_values(true)
-            : [];
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        return $this->_gateway->handle_payment_update($req_data, $transaction);
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction|null           $transaction
-     * @return boolean success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _save_billing_info_to_attendee(
-        EE_Billing_Attendee_Info_Form $billing_form,
-        ?EE_Transaction $transaction
-    ): bool {
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction has no primary registration",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds(): bool
-    {
-        return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs(): string
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        }
-        if ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        }
-        if ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                    "event_espresso"
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
-            ['payment_method' => $this->_pm_instance, 'payment' => $payment],
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                             Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return [];
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     *
-     * @return string|null
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string|null
-     */
-    public function pretty_name(): ?string
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string|null
-     */
-    public function default_button_url(): ?string
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway(): ?EE_Gateway
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link(): string
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name(): string
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name(): string
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html(): string
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
-            ['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
-        );
-    }
+	const onsite  = 'on-site';
+
+	const offsite = 'off-site';
+
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = false;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = null;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = null;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = true;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string|null
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string|null
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string|null
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_description = null;
+
+	/**
+	 *  @var string|null
+	 */
+	protected $_template_path = null;
+
+	/**
+	 * @param EE_Payment_Method|null $pm_instance
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				esc_html__(
+					'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
+					'event_espresso'
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form(bool $has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector          = new ReflectionClass(get_class($this));
+		$fn                 = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . '/';
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', '/', $this->file_folder());
+		$file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url   = set_url_scheme($file_path);
+	}
+
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description(): ?string
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder(): ?string
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url(): ?string
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_instance(EE_Payment_Method $payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they set up the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function settings_form(): EE_Payment_Method_Form
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure it's reflected in the form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form(EE_Payment_Method_Form $form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form(): bool
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @param array               $extra_args
+	 * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				(
+					$this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+					&& $transaction instanceof EE_Transaction
+					&& $transaction->primary_registration() instanceof EE_Registration
+					&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+				),
+				$this->_billing_form,
+				$transaction
+			)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Billing_Info_Form|null
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * applies debug data to the form
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return EE_Billing_Info_Form|null
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form(EE_Payment_Method $form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https(): bool
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 * @param EE_Transaction            $transaction
+	 * @param float|null                $amount
+	 * @param EE_Billing_Info_Form|null $billing_info
+	 * @param string|null               $return_url
+	 * @param string                    $fail_url
+	 * @param string                    $method
+	 * @param bool                      $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_info = null,
+		$return_url = null,
+		$fail_url = '',
+		$method = 'CART',
+		$by_admin = false
+	) {
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			// there is a gateway, so we're going to make a payment object
+			// but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = [
+				'STS_ID'               => EEM_Payment::status_id_failed,
+				'TXN_ID'               => $transaction->ID(),
+				'PMD_ID'               => $this->_pm_instance->ID(),
+				'PAY_source'           => $method,
+				'PAY_amount'           => $amount !== null
+					? $amount
+					: $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			];
+			$payment              = EEM_Payment::instance()->get_one([$duplicate_properties]);
+			// if we didn't already have a payment in progress for the same thing,
+			// then we actually want to make a new payment
+			if (! $payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						[
+							'PAY_timestamp'       => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number'       => null,
+							'PAY_extra_accntng'   => null,
+							'PAY_details'         => null,
+						]
+					)
+				);
+			}
+			// make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						[
+							'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug(),
+						]
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+							'event_espresso'
+						),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				[
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				]
+			);
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form|null $billing_form
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		return $billing_form instanceof EE_Form_Section_Proper
+			? $billing_form->input_pretty_values(true)
+			: [];
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		return $this->_gateway->handle_payment_update($req_data, $transaction);
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction|null           $transaction
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _save_billing_info_to_attendee(
+		EE_Billing_Attendee_Info_Form $billing_form,
+		?EE_Transaction $transaction
+	): bool {
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction has no primary registration",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds(): bool
+	{
+		return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs(): string
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		}
+		if ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		}
+		if ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+					"event_espresso"
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+			['payment_method' => $this->_pm_instance, 'payment' => $payment],
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                             Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return [];
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 *
+	 * @return string|null
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string|null
+	 */
+	public function pretty_name(): ?string
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string|null
+	 */
+	public function default_button_url(): ?string
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway(): ?EE_Gateway
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link(): string
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name(): string
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name(): string
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html(): string
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+			['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
+		);
+	}
 }

core/services/routing/Router.php

Indentation +219 added lines, -219 removed lines

@@ -29,243 +29,243 @@
  */
 class Router
 {
-    protected EE_Dependency_Map $dependency_map;
+	protected EE_Dependency_Map $dependency_map;
 
-    protected LoaderInterface $loader;
+	protected LoaderInterface $loader;
 
-    protected RouteHandler $route_handler;
+	protected RouteHandler $route_handler;
 
-    protected string $route_request_type;
+	protected string $route_request_type;
 
-    protected array $routes_loaded;
+	protected array $routes_loaded;
 
 
-    /**
-     * RoutingSwitch constructor.
-     *
-     * @param EE_Dependency_Map $dependency_map
-     * @param LoaderInterface   $loader
-     * @param RouteHandler      $router
-     */
-    public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader, RouteHandler $router)
-    {
-        $this->dependency_map = $dependency_map;
-        $this->loader         = $loader;
-        $this->route_handler  = $router;
-    }
+	/**
+	 * RoutingSwitch constructor.
+	 *
+	 * @param EE_Dependency_Map $dependency_map
+	 * @param LoaderInterface   $loader
+	 * @param RouteHandler      $router
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader, RouteHandler $router)
+	{
+		$this->dependency_map = $dependency_map;
+		$this->loader         = $loader;
+		$this->route_handler  = $router;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function loadPrimaryRoutes()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests',
-            Route::getFullDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests',
-            Route::getFullDependencies()
-        );
-        // now load and prep all primary Routes
-        $this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests');
-        $this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests');
-        $this->route_request_type = $this->route_handler->getRouteRequestType();
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__loadPrimaryRoutes',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function loadPrimaryRoutes()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests',
+			Route::getFullDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests',
+			Route::getFullDependencies()
+		);
+		// now load and prep all primary Routes
+		$this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests');
+		$this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests');
+		$this->route_request_type = $this->route_handler->getRouteRequestType();
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__loadPrimaryRoutes',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function registerShortcodesModulesAndWidgets()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__registerShortcodesModulesAndWidgets',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
+	/**
+	 * @throws Exception
+	 */
+	public function registerShortcodesModulesAndWidgets()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__registerShortcodesModulesAndWidgets',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
 
-        /** @var LegacyModulesManager $legacy_modules_manager */
-        $legacy_modules_manager = $this->loader->getShared(LegacyModulesManager::class);
-        $legacy_modules_manager->setHooks();
+		/** @var LegacyModulesManager $legacy_modules_manager */
+		$legacy_modules_manager = $this->loader->getShared(LegacyModulesManager::class);
+		$legacy_modules_manager->setHooks();
 
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\frontend\ShortcodeRequests'
-                );
-                /** @var LegacyWidgetsManager $legacy_widgets_manager */
-                $legacy_widgets_manager = $this->loader->getShared(LegacyWidgetsManager::class);
-                $legacy_widgets_manager->setHooks();
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\frontend\ShortcodeRequests'
+				);
+				/** @var LegacyWidgetsManager $legacy_widgets_manager */
+				$legacy_widgets_manager = $this->loader->getShared(LegacyWidgetsManager::class);
+				$legacy_widgets_manager->setHooks();
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function brewEspresso()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__brewEspresso',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\GQLRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\RestApiRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function brewEspresso()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__brewEspresso',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\GQLRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\RestApiRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function loadControllers()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__loadControllers',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        $this->route_handler->addRoute(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute'
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
-                );
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\frontend\FrontendRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoLegacyAdmin'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventsAdmin'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventEditor'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\GutenbergEditor'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\NonEspressoAdminAjax'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressProfilePage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPostsPage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\WordPressHeartbeat'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoBatchJob'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function loadControllers()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__loadControllers',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		$this->route_handler->addRoute(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute'
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
+				);
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\frontend\FrontendRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoLegacyAdmin'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventsAdmin'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventEditor'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\GutenbergEditor'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\NonEspressoAdminAjax'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressProfilePage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPostsPage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\WordPressHeartbeat'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoBatchJob'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function coreLoadedAndReady()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__coreLoadedAndReady',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\AssetRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\SessionRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function coreLoadedAndReady()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__coreLoadedAndReady',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\AssetRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\SessionRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function initializeLast()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__initializeLast',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\PersonalDataRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function initializeLast()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__initializeLast',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\PersonalDataRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 }

core/services/encryption/openssl/CipherMethod.php

Indentation +190 added lines, -190 removed lines

@@ -14,194 +14,194 @@
  */
 class CipherMethod
 {
-    protected string $cipher_method_option_name = '';
-
-    /**
-     * list of cipher methods that we consider usable,
-     * essentially all of the installed_cipher_methods minus weak_algorithms
-     */
-    protected array $cipher_methods        = [];
-
-    protected string $default_cipher_method = '';
-
-    /**
-     * list of ALL cipher methods available on the server
-     */
-    protected array $installed_cipher_methods = [];
-
-    /**
-     * the OpenSSL cipher method to use. default: AES-128-CBC
-     */
-    protected ?string $validated_cipher_method = null;
-
-    /**
-     * as early as Aug 2016, Openssl declared the following weak: RC2, RC4, DES, 3DES, MD5 based
-     * and ECB mode should be avoided
-     */
-    protected array $weak_algorithms = ['des', 'ecb', 'md5', 'rc2', 'rc4'];
-
-
-    /**
-     * @param string $default_cipher_method
-     * @param string $cipher_method_option_name
-     */
-    public function __construct(string $default_cipher_method, string $cipher_method_option_name)
-    {
-        $this->default_cipher_method     = $default_cipher_method;
-        $this->cipher_method_option_name = $cipher_method_option_name;
-        $this->installed_cipher_methods  = openssl_get_cipher_methods();
-    }
-
-
-    /**
-     * Returns a cipher method that has been verified to work.
-     * First checks if the cached cipher has been set already and if so, returns that.
-     * Then tests the incoming default and returns that if it's good.
-     * If not, then it retrieves the previously tested and saved cipher method.
-     * But if that doesn't exist, then calls getAvailableCipherMethod()
-     * to see what is available on the server, and returns the results.
-     *
-     * @param string $cipher_method
-     * @param bool   $load_alternate [optional] if TRUE, will load the default cipher method (or any strong algorithm)
-     *                               if the requested cipher method is not installed or invalid.
-     *                               if FALSE, will throw an exception if the requested cipher method is not valid.
-     * @return string
-     * @throws RuntimeException
-     */
-    public function getCipherMethod(string $cipher_method = '', bool $load_alternate = true): ?string
-    {
-        if (empty($cipher_method) && $this->validated_cipher_method !== null) {
-            return $this->validated_cipher_method;
-        }
-        // if nothing specific was requested and it's ok to load an alternate, then grab the system default
-        if (empty($cipher_method) && $load_alternate) {
-            $cipher_method = $this->default_cipher_method;
-        }
-        // verify that the cipher method can produce an initialization vector.
-        // but if the requested is invalid and we don't want to load an alternate, then throw an exception
-        $throw_exception = ! $load_alternate;
-        if ($this->validateCipherMethod($cipher_method, $throw_exception) === false) {
-            // nope? ... ok let's see what we can find
-            $cipher_method = $this->getAvailableCipherMethod();
-        }
-        // if nothing has been previously validated, then save the currently requested cipher which appears to be good
-        if ($this->validated_cipher_method === null) {
-            $this->validated_cipher_method = $cipher_method;
-        }
-        return $cipher_method;
-    }
-
-
-    /**
-     * returns true if the selected cipher method either uses Galois/Counter Mode (GCM)
-     * or Counter with CBC-MAC (CCM) authenticated encryption modes
-     * (also need to be using PHP 7.1 or greater to actually use authenticated encryption modes)
-     *
-     * @return bool
-     */
-    public function usesAuthenticatedEncryptionMode(): bool
-    {
-        return PHP_VERSION_ID >= 70100
-               && (
-                   stripos($this->validated_cipher_method, 'gcm') !== false
-                   || stripos($this->validated_cipher_method, 'ccm') !== false
-               );
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getAvailableCipherMethod(string $cipher_method = ''): ?string
-    {
-        // if nothing was supplied, the get what we found in the past to work
-        $cipher_method_to_test = $cipher_method
-            ?: get_option($this->cipher_method_option_name, '');
-        // verify that the incoming cipher method exists and can produce an initialization vector
-        if ($this->validateCipherMethod($cipher_method_to_test) === false) {
-            // what? there's no list?
-            if (empty($this->cipher_methods)) {
-                // generate that list and cache it
-                $this->cipher_methods = $this->getAvailableStrongCipherMethods();
-            }
-            // then grab the first item from the list (we'll add it back later if it is good)
-            $cipher_method_to_test = array_shift($this->cipher_methods);
-            if ($cipher_method_to_test === null) {
-                throw new RuntimeException(
-                    esc_html__(
-                        'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
-                        'event_espresso'
-                    )
-                );
-            }
-            // verify that the next cipher method works
-            return $this->getAvailableCipherMethod($cipher_method_to_test);
-        }
-        // if we've gotten this far, then we found an available cipher method that works
-        // so save that for next time, if it's not the same as what's there already
-        if ($cipher_method_to_test !== $cipher_method) {
-            update_option($this->cipher_method_option_name, $cipher_method_to_test);
-        }
-        // if we previously removed this cipher method from the list of valid ones, then let's put it back
-        if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
-            array_unshift($this->cipher_methods, $cipher_method_to_test);
-        }
-        return $cipher_method_to_test;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getAvailableStrongCipherMethods(): array
-    {
-        return array_filter($this->installed_cipher_methods, [$this, 'weakAlgorithmFilter']);
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @param bool   $throw_exception
-     * @return bool
-     */
-    protected function validateCipherMethod(string $cipher_method, bool $throw_exception = false): bool
-    {
-        // verify that the requested cipher method is actually installed and can produce an initialization vector
-        if (
-            in_array($cipher_method, $this->installed_cipher_methods, true)
-            && openssl_cipher_iv_length($cipher_method) !== false
-        ) {
-            return true;
-        }
-        if (! $throw_exception) {
-            return false;
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'The requested OpenSSL cipher method "%1$s" is invalid or not installed on the server. Please contact the server administrator.',
-                    'event_espresso'
-                ),
-                $cipher_method
-            )
-        );
-    }
-
-
-    /**
-     * @see https://www.php.net/manual/en/function.openssl-get-cipher-methods.php#example-890
-     * @param string $cipher_method
-     * @return bool
-     */
-    protected function weakAlgorithmFilter(string $cipher_method): bool
-    {
-        foreach ($this->weak_algorithms as $weak_algorithm) {
-            if (stripos($cipher_method, $weak_algorithm) !== false) {
-                return false;
-            }
-        }
-        return true;
-    }
+	protected string $cipher_method_option_name = '';
+
+	/**
+	 * list of cipher methods that we consider usable,
+	 * essentially all of the installed_cipher_methods minus weak_algorithms
+	 */
+	protected array $cipher_methods        = [];
+
+	protected string $default_cipher_method = '';
+
+	/**
+	 * list of ALL cipher methods available on the server
+	 */
+	protected array $installed_cipher_methods = [];
+
+	/**
+	 * the OpenSSL cipher method to use. default: AES-128-CBC
+	 */
+	protected ?string $validated_cipher_method = null;
+
+	/**
+	 * as early as Aug 2016, Openssl declared the following weak: RC2, RC4, DES, 3DES, MD5 based
+	 * and ECB mode should be avoided
+	 */
+	protected array $weak_algorithms = ['des', 'ecb', 'md5', 'rc2', 'rc4'];
+
+
+	/**
+	 * @param string $default_cipher_method
+	 * @param string $cipher_method_option_name
+	 */
+	public function __construct(string $default_cipher_method, string $cipher_method_option_name)
+	{
+		$this->default_cipher_method     = $default_cipher_method;
+		$this->cipher_method_option_name = $cipher_method_option_name;
+		$this->installed_cipher_methods  = openssl_get_cipher_methods();
+	}
+
+
+	/**
+	 * Returns a cipher method that has been verified to work.
+	 * First checks if the cached cipher has been set already and if so, returns that.
+	 * Then tests the incoming default and returns that if it's good.
+	 * If not, then it retrieves the previously tested and saved cipher method.
+	 * But if that doesn't exist, then calls getAvailableCipherMethod()
+	 * to see what is available on the server, and returns the results.
+	 *
+	 * @param string $cipher_method
+	 * @param bool   $load_alternate [optional] if TRUE, will load the default cipher method (or any strong algorithm)
+	 *                               if the requested cipher method is not installed or invalid.
+	 *                               if FALSE, will throw an exception if the requested cipher method is not valid.
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function getCipherMethod(string $cipher_method = '', bool $load_alternate = true): ?string
+	{
+		if (empty($cipher_method) && $this->validated_cipher_method !== null) {
+			return $this->validated_cipher_method;
+		}
+		// if nothing specific was requested and it's ok to load an alternate, then grab the system default
+		if (empty($cipher_method) && $load_alternate) {
+			$cipher_method = $this->default_cipher_method;
+		}
+		// verify that the cipher method can produce an initialization vector.
+		// but if the requested is invalid and we don't want to load an alternate, then throw an exception
+		$throw_exception = ! $load_alternate;
+		if ($this->validateCipherMethod($cipher_method, $throw_exception) === false) {
+			// nope? ... ok let's see what we can find
+			$cipher_method = $this->getAvailableCipherMethod();
+		}
+		// if nothing has been previously validated, then save the currently requested cipher which appears to be good
+		if ($this->validated_cipher_method === null) {
+			$this->validated_cipher_method = $cipher_method;
+		}
+		return $cipher_method;
+	}
+
+
+	/**
+	 * returns true if the selected cipher method either uses Galois/Counter Mode (GCM)
+	 * or Counter with CBC-MAC (CCM) authenticated encryption modes
+	 * (also need to be using PHP 7.1 or greater to actually use authenticated encryption modes)
+	 *
+	 * @return bool
+	 */
+	public function usesAuthenticatedEncryptionMode(): bool
+	{
+		return PHP_VERSION_ID >= 70100
+			   && (
+				   stripos($this->validated_cipher_method, 'gcm') !== false
+				   || stripos($this->validated_cipher_method, 'ccm') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getAvailableCipherMethod(string $cipher_method = ''): ?string
+	{
+		// if nothing was supplied, the get what we found in the past to work
+		$cipher_method_to_test = $cipher_method
+			?: get_option($this->cipher_method_option_name, '');
+		// verify that the incoming cipher method exists and can produce an initialization vector
+		if ($this->validateCipherMethod($cipher_method_to_test) === false) {
+			// what? there's no list?
+			if (empty($this->cipher_methods)) {
+				// generate that list and cache it
+				$this->cipher_methods = $this->getAvailableStrongCipherMethods();
+			}
+			// then grab the first item from the list (we'll add it back later if it is good)
+			$cipher_method_to_test = array_shift($this->cipher_methods);
+			if ($cipher_method_to_test === null) {
+				throw new RuntimeException(
+					esc_html__(
+						'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
+						'event_espresso'
+					)
+				);
+			}
+			// verify that the next cipher method works
+			return $this->getAvailableCipherMethod($cipher_method_to_test);
+		}
+		// if we've gotten this far, then we found an available cipher method that works
+		// so save that for next time, if it's not the same as what's there already
+		if ($cipher_method_to_test !== $cipher_method) {
+			update_option($this->cipher_method_option_name, $cipher_method_to_test);
+		}
+		// if we previously removed this cipher method from the list of valid ones, then let's put it back
+		if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
+			array_unshift($this->cipher_methods, $cipher_method_to_test);
+		}
+		return $cipher_method_to_test;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getAvailableStrongCipherMethods(): array
+	{
+		return array_filter($this->installed_cipher_methods, [$this, 'weakAlgorithmFilter']);
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @param bool   $throw_exception
+	 * @return bool
+	 */
+	protected function validateCipherMethod(string $cipher_method, bool $throw_exception = false): bool
+	{
+		// verify that the requested cipher method is actually installed and can produce an initialization vector
+		if (
+			in_array($cipher_method, $this->installed_cipher_methods, true)
+			&& openssl_cipher_iv_length($cipher_method) !== false
+		) {
+			return true;
+		}
+		if (! $throw_exception) {
+			return false;
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'The requested OpenSSL cipher method "%1$s" is invalid or not installed on the server. Please contact the server administrator.',
+					'event_espresso'
+				),
+				$cipher_method
+			)
+		);
+	}
+
+
+	/**
+	 * @see https://www.php.net/manual/en/function.openssl-get-cipher-methods.php#example-890
+	 * @param string $cipher_method
+	 * @return bool
+	 */
+	protected function weakAlgorithmFilter(string $cipher_method): bool
+	{
+		foreach ($this->weak_algorithms as $weak_algorithm) {
+			if (stripos($cipher_method, $weak_algorithm) !== false) {
+				return false;
+			}
+		}
+		return true;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -20,7 +20,7 @@ 
      * list of cipher methods that we consider usable,
      * essentially all of the installed_cipher_methods minus weak_algorithms
      */
-    protected array $cipher_methods        = [];
+    protected array $cipher_methods = [];
 
     protected string $default_cipher_method = '';
 
@@ -145,7 +145,7 @@ 
             update_option($this->cipher_method_option_name, $cipher_method_to_test);
         }
         // if we previously removed this cipher method from the list of valid ones, then let's put it back
-        if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
+        if ( ! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
             array_unshift($this->cipher_methods, $cipher_method_to_test);
         }
         return $cipher_method_to_test;
@@ -175,7 +175,7 @@ 
         ) {
             return true;
         }
-        if (! $throw_exception) {
+        if ( ! $throw_exception) {
             return false;
         }
         throw new RuntimeException(

core/services/graphql/GraphQLEndpoint.php

Indentation +73 added lines, -73 removed lines

@@ -18,88 +18,88 @@
  */
 class GraphQLEndpoint extends WordPressOption
 {
-    const DEFAULT_ENDPOINT = 'graphql';
+	const DEFAULT_ENDPOINT = 'graphql';
 
-    const OPTION_NAME      = 'ee-graphql-endpoint';
+	const OPTION_NAME      = 'ee-graphql-endpoint';
 
-    private bool $is_gql_request;
+	private bool $is_gql_request;
 
 
-    /**
-     * GraphQLEndpoint constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
-        add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
-        if (! $this->graphqlDebug()) {
-            // disable WPGraphQL admin by default.
-            add_filter('graphql_show_admin', '__return_false');
-            add_filter('graphql_enable_graphiql', '__return_false');
-        }
-    }
+	/**
+	 * GraphQLEndpoint constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
+		add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
+		if (! $this->graphqlDebug()) {
+			// disable WPGraphQL admin by default.
+			add_filter('graphql_show_admin', '__return_false');
+			add_filter('graphql_enable_graphiql', '__return_false');
+		}
+	}
 
-    /**
-     * Determine the value of global constant GRAPHQL_DEBUG
-     * @return bool
-     */
-    private function graphqlDebug(): bool
-    {
-        return defined('GRAPHQL_DEBUG') && GRAPHQL_DEBUG;
-    }
+	/**
+	 * Determine the value of global constant GRAPHQL_DEBUG
+	 * @return bool
+	 */
+	private function graphqlDebug(): bool
+	{
+		return defined('GRAPHQL_DEBUG') && GRAPHQL_DEBUG;
+	}
 
 
-    /**
-     * @return false|mixed|void
-     */
-    public function getEndpoint()
-    {
-        return $this->loadOption();
-    }
+	/**
+	 * @return false|mixed|void
+	 */
+	public function getEndpoint()
+	{
+		return $this->loadOption();
+	}
 
 
-    /**
-     * @return mixed|void|bool
-     */
-    public function isGraphqlRequest()
-    {
-        if (! isset($this->is_gql_request)) {
-            // grab the GQL endpoint that we saved in the future... wait... wut?
-            $endpoint = $this->getEndpoint();
-            // set our saved endpoint on the WP GQL Pouter class
-            // don't worry, this is a static property that they overwrite when they initialize things,
-            // and we are essentially getting the value from them anyways, so it should be ok (fingers crossed)
-            Router::$route = $endpoint;
-            // now call their function for checking if this is a GQL request
-            // because they use a bunch of filters and stuff we don't want to duplicate here
-            $this->is_gql_request = Router::is_graphql_http_request();
-        }
-        return $this->is_gql_request;
-    }
+	/**
+	 * @return mixed|void|bool
+	 */
+	public function isGraphqlRequest()
+	{
+		if (! isset($this->is_gql_request)) {
+			// grab the GQL endpoint that we saved in the future... wait... wut?
+			$endpoint = $this->getEndpoint();
+			// set our saved endpoint on the WP GQL Pouter class
+			// don't worry, this is a static property that they overwrite when they initialize things,
+			// and we are essentially getting the value from them anyways, so it should be ok (fingers crossed)
+			Router::$route = $endpoint;
+			// now call their function for checking if this is a GQL request
+			// because they use a bunch of filters and stuff we don't want to duplicate here
+			$this->is_gql_request = Router::is_graphql_http_request();
+		}
+		return $this->is_gql_request;
+	}
 
 
-    /**
-     * callback hooked into the graphql_register_settings action
-     * basically grabs the value for the 'graphql_endpoint' setting and saves it to our own WP option.
-     * i know, i know, i know...
-     * WHY are we saving the graphql_endpoint to a WP option if WP GraphQL is already doing the same ?!?!
-     * Because we perform our request type detection during `plugins_loaded`,
-     * but they don't settle on their endpoint until `after_setup_theme` has run,
-     * which is too late for us, so we are just going to save this separately so that we have it.
-     * Oh, and this will essentially recheck this value on EVERY request
-     * but will only update our saved value if it has actually changed
-     */
-    public function verifyAndSetEndpoint()
-    {
-        try {
-            $this->updateOption(
-                get_graphql_setting(
-                    'graphql_endpoint',
-                    apply_filters('graphql_endpoint', GraphQLEndpoint::DEFAULT_ENDPOINT)
-                )
-            );
-        } catch (Throwable $t) {
-            // eat it
-        }
-    }
+	/**
+	 * callback hooked into the graphql_register_settings action
+	 * basically grabs the value for the 'graphql_endpoint' setting and saves it to our own WP option.
+	 * i know, i know, i know...
+	 * WHY are we saving the graphql_endpoint to a WP option if WP GraphQL is already doing the same ?!?!
+	 * Because we perform our request type detection during `plugins_loaded`,
+	 * but they don't settle on their endpoint until `after_setup_theme` has run,
+	 * which is too late for us, so we are just going to save this separately so that we have it.
+	 * Oh, and this will essentially recheck this value on EVERY request
+	 * but will only update our saved value if it has actually changed
+	 */
+	public function verifyAndSetEndpoint()
+	{
+		try {
+			$this->updateOption(
+				get_graphql_setting(
+					'graphql_endpoint',
+					apply_filters('graphql_endpoint', GraphQLEndpoint::DEFAULT_ENDPOINT)
+				)
+			);
+		} catch (Throwable $t) {
+			// eat it
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     {
         parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
         add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
-        if (! $this->graphqlDebug()) {
+        if ( ! $this->graphqlDebug()) {
             // disable WPGraphQL admin by default.
             add_filter('graphql_show_admin', '__return_false');
             add_filter('graphql_enable_graphiql', '__return_false');
@@ -63,7 +63,7 @@ 
      */
     public function isGraphqlRequest()
     {
-        if (! isset($this->is_gql_request)) {
+        if ( ! isset($this->is_gql_request)) {
             // grab the GQL endpoint that we saved in the future... wait... wut?
             $endpoint = $this->getEndpoint();
             // set our saved endpoint on the WP GQL Pouter class