eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Processor.lib.php

Spacing +8 added lines, -8 removed lines

@@ -284,7 +284,7 @@ 
     public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
         if ($message_to_generate->valid()) {
-            if (! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
+            if ( ! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
                 throw new RuntimeException(
                     esc_html__('Message failed to generate', 'event_espresso')
                 );
@@ -330,7 +330,7 @@ 
     protected function _queue_for_generation_loop($messages_to_generate)
     {
         // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
+        if ( ! is_array($messages_to_generate)) {
             $messages_to_generate = [$messages_to_generate];
         }
 
@@ -370,7 +370,7 @@ 
      */
     public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             EE_Error::add_error(
                 esc_html__('Unable to generate preview because of invalid data', 'event_espresso'),
                 __FILE__,
@@ -407,7 +407,7 @@ 
      */
     public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false;
         }
         $this->_init_queue_and_generator();
@@ -432,7 +432,7 @@ 
      */
     public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return null;
         }
         // is there supposed to be a sending messenger for this message?
@@ -579,7 +579,7 @@ 
 
         foreach ($regIDs as $regID) {
             $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -591,7 +591,7 @@ 
                 );
                 return false;
             }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+            $regs_to_send[$reg->transaction_ID()][$reg->status_ID()][] = $reg;
         }
 
         $messages_to_generate = [];
@@ -599,7 +599,7 @@ 
         foreach ($regs_to_send as $status_group) {
             foreach ($status_group as $status_id => $registrations) {
                 $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
+                if ( ! $message_type) {
                     continue;
                 }
                 $messages_to_generate = array_merge(

Indentation +598 added lines, -598 removed lines

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

core/libraries/messages/EE_Message_To_Generate.php

Spacing +2 added lines, -2 removed lines

@@ -297,8 +297,8 @@
      */
     public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
     {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
+        $class_name = 'EE_Messages_'.$data_handler_reference.'_incoming_data';
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(

Indentation +304 added lines, -304 removed lines

@@ -11,308 +11,308 @@
  */
 class EE_Message_To_Generate
 {
-    /**
-     * @var string
-     */
-    protected $_messenger_name;
-
-    /**
-     * @var string
-     */
-    protected $_message_type_name;
-
-    /**
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-    /**
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-    /**
-     * Identifier for the context the message is to be generated for.
-     *
-     * @var string
-     */
-    protected $_context = '';
-
-    /**
-     * Data that will be used to generate message.
-     *
-     * @var array
-     */
-    protected $_data = [];
-
-    /**
-     * Whether this message is for a preview or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-    /**
-     * @var EE_Message
-     */
-    protected $_message;
-
-    /**
-     * This is set by the constructor to indicate whether the incoming messenger
-     * and message type are valid.  This can then be checked by callers to determine whether
-     * to generate this message or not.
-     *
-     * @var bool
-     */
-    protected $_valid = false;
-
-    /**
-     * If there are any errors (non exception errors) they get added to this array for callers to decide
-     * how to handle.
-     *
-     * @var array
-     */
-    protected $_error_msg = [];
-
-    /**
-     * Can be accessed via the send_now() method, this is set in the validation
-     * routine via the EE_messenger::send_now() method.
-     *
-     * @var bool
-     */
-    protected $_send_now = false;
-
-    /**
-     * Holds the classname for the data handler used by the current message type.
-     * This is set on the first call to the public `get_data_handler_class_name()` method.
-     *
-     * @var string
-     */
-    protected $_data_handler_class_name = '';
-
-    /**
-     * one of the message status constants on EEM_Message
-     *
-     * @var string
-     * @since 4.10.29.p
-     */
-    protected $_status = '';
-
-    /**
-     * use $_status var above
-     *
-     * @var string
-     * @deprecated 4.10.29.p
-     */
-    protected $_message_status = '';
-
-
-    /**
-     * Constructor
-     *
-     * @param string $messenger_name    Slug representing messenger
-     * @param string $message_type_name Slug representing message type.
-     * @param mixed  $data              Data used for generating message.
-     * @param string $context           Optional context to restrict message generated for.
-     * @param bool   $preview           Whether this is being used to generate a preview or not.
-     * @param string $status
-     */
-    public function __construct(
-        $messenger_name,
-        $message_type_name,
-        $data = [],
-        $context = '',
-        $preview = false,
-        $status = EEM_Message::status_incomplete
-    ) {
-        $this->_messenger_name    = $messenger_name;
-        $this->_message_type_name = $message_type_name;
-        $this->_data              = is_array($data) ? $data : [$data];
-        $this->_context           = $context;
-        $this->_preview           = $preview;
-        $this->_status            = $status;
-        // attempt to generate message immediately
-        $this->_message = $this->_generate_message();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function context()
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * @return EE_message_type
-     */
-    public function message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function preview()
-    {
-        return $this->_preview;
-    }
-
-
-    /**
-     * @param boolean $preview
-     */
-    public function set_preview($preview)
-    {
-        $this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function send_now()
-    {
-        return $this->_send_now;
-    }
-
-
-    /**
-     * Simply returns the state of the $_valid property.
-     *
-     * @return bool
-     */
-    public function valid()
-    {
-        return $this->_valid;
-    }
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return EE_Message
-     */
-    protected function _generate_message($properties = [])
-    {
-        $message = EE_Message_Factory::create(
-            array_merge(
-                [
-                    'MSG_messenger'    => $this->_messenger_name,
-                    'MSG_message_type' => $this->_message_type_name,
-                    'MSG_context'      => $this->_context,
-                    'STS_ID'           => $this->_status,
-                ],
-                $properties
-            )
-        );
-        // validate the message, and if it's good, set some properties
-        try {
-            $message->is_valid_for_sending_or_generation(true);
-            $this->_valid        = true;
-            $this->_messenger    = $message->messenger_object();
-            $this->_message_type = $message->message_type_object();
-            $this->_send_now     = $message->send_now();
-        } catch (Exception $e) {
-            $this->_valid       = false;
-            $this->_error_msg[] = $e->getMessage();
-        }
-        return $message;
-    }
-
-
-    /**
-     *  Returns an instantiated EE_Message object from the internal data.
-     *
-     * @return EE_Message
-     */
-    public function get_EE_Message()
-    {
-        // already set ?
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        // no? then let's create one
-        $this->_message = $this->_generate_message();
-        return $this->_message;
-    }
-
-
-    /**
-     * This returns the data_handler class name for the internal message type set.
-     * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
-     * and the data_handler_class name is set to an empty string.
-     *
-     * @param bool $preview Used to indicate that the preview data handler is to be returned.
-     * @return  string
-     */
-    public function get_data_handler_class_name($preview = false)
-    {
-        if ($this->_data_handler_class_name === '' && $this->valid()) {
-            $ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
-            // make sure internal data is updated.
-            $this->_data = $this->_message_type->get_data();
-
-            // verify
-            $this->_data_handler_class_name =
-                EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
-            if ($this->_data_handler_class_name === '') {
-                $this->_valid = false;
-            }
-        }
-        return $this->_data_handler_class_name;
-    }
-
-
-    /**
-     * Validates the given string as a reference for an existing, accessible data handler and returns the class name
-     * For the handler the reference matches.
-     *
-     * @param string $data_handler_reference
-     * @return string
-     */
-    public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
-    {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
-                        'event_espresso'
-                    ),
-                    $data_handler_reference,
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = ''; // clear out class_name so caller knows this isn't valid.
-        }
-        return $class_name;
-    }
+	/**
+	 * @var string
+	 */
+	protected $_messenger_name;
+
+	/**
+	 * @var string
+	 */
+	protected $_message_type_name;
+
+	/**
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+	/**
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+	/**
+	 * Identifier for the context the message is to be generated for.
+	 *
+	 * @var string
+	 */
+	protected $_context = '';
+
+	/**
+	 * Data that will be used to generate message.
+	 *
+	 * @var array
+	 */
+	protected $_data = [];
+
+	/**
+	 * Whether this message is for a preview or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+	/**
+	 * @var EE_Message
+	 */
+	protected $_message;
+
+	/**
+	 * This is set by the constructor to indicate whether the incoming messenger
+	 * and message type are valid.  This can then be checked by callers to determine whether
+	 * to generate this message or not.
+	 *
+	 * @var bool
+	 */
+	protected $_valid = false;
+
+	/**
+	 * If there are any errors (non exception errors) they get added to this array for callers to decide
+	 * how to handle.
+	 *
+	 * @var array
+	 */
+	protected $_error_msg = [];
+
+	/**
+	 * Can be accessed via the send_now() method, this is set in the validation
+	 * routine via the EE_messenger::send_now() method.
+	 *
+	 * @var bool
+	 */
+	protected $_send_now = false;
+
+	/**
+	 * Holds the classname for the data handler used by the current message type.
+	 * This is set on the first call to the public `get_data_handler_class_name()` method.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler_class_name = '';
+
+	/**
+	 * one of the message status constants on EEM_Message
+	 *
+	 * @var string
+	 * @since 4.10.29.p
+	 */
+	protected $_status = '';
+
+	/**
+	 * use $_status var above
+	 *
+	 * @var string
+	 * @deprecated 4.10.29.p
+	 */
+	protected $_message_status = '';
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $messenger_name    Slug representing messenger
+	 * @param string $message_type_name Slug representing message type.
+	 * @param mixed  $data              Data used for generating message.
+	 * @param string $context           Optional context to restrict message generated for.
+	 * @param bool   $preview           Whether this is being used to generate a preview or not.
+	 * @param string $status
+	 */
+	public function __construct(
+		$messenger_name,
+		$message_type_name,
+		$data = [],
+		$context = '',
+		$preview = false,
+		$status = EEM_Message::status_incomplete
+	) {
+		$this->_messenger_name    = $messenger_name;
+		$this->_message_type_name = $message_type_name;
+		$this->_data              = is_array($data) ? $data : [$data];
+		$this->_context           = $context;
+		$this->_preview           = $preview;
+		$this->_status            = $status;
+		// attempt to generate message immediately
+		$this->_message = $this->_generate_message();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * @return EE_message_type
+	 */
+	public function message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function preview()
+	{
+		return $this->_preview;
+	}
+
+
+	/**
+	 * @param boolean $preview
+	 */
+	public function set_preview($preview)
+	{
+		$this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return $this->_send_now;
+	}
+
+
+	/**
+	 * Simply returns the state of the $_valid property.
+	 *
+	 * @return bool
+	 */
+	public function valid()
+	{
+		return $this->_valid;
+	}
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return EE_Message
+	 */
+	protected function _generate_message($properties = [])
+	{
+		$message = EE_Message_Factory::create(
+			array_merge(
+				[
+					'MSG_messenger'    => $this->_messenger_name,
+					'MSG_message_type' => $this->_message_type_name,
+					'MSG_context'      => $this->_context,
+					'STS_ID'           => $this->_status,
+				],
+				$properties
+			)
+		);
+		// validate the message, and if it's good, set some properties
+		try {
+			$message->is_valid_for_sending_or_generation(true);
+			$this->_valid        = true;
+			$this->_messenger    = $message->messenger_object();
+			$this->_message_type = $message->message_type_object();
+			$this->_send_now     = $message->send_now();
+		} catch (Exception $e) {
+			$this->_valid       = false;
+			$this->_error_msg[] = $e->getMessage();
+		}
+		return $message;
+	}
+
+
+	/**
+	 *  Returns an instantiated EE_Message object from the internal data.
+	 *
+	 * @return EE_Message
+	 */
+	public function get_EE_Message()
+	{
+		// already set ?
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		// no? then let's create one
+		$this->_message = $this->_generate_message();
+		return $this->_message;
+	}
+
+
+	/**
+	 * This returns the data_handler class name for the internal message type set.
+	 * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
+	 * and the data_handler_class name is set to an empty string.
+	 *
+	 * @param bool $preview Used to indicate that the preview data handler is to be returned.
+	 * @return  string
+	 */
+	public function get_data_handler_class_name($preview = false)
+	{
+		if ($this->_data_handler_class_name === '' && $this->valid()) {
+			$ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
+			// make sure internal data is updated.
+			$this->_data = $this->_message_type->get_data();
+
+			// verify
+			$this->_data_handler_class_name =
+				EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
+			if ($this->_data_handler_class_name === '') {
+				$this->_valid = false;
+			}
+		}
+		return $this->_data_handler_class_name;
+	}
+
+
+	/**
+	 * Validates the given string as a reference for an existing, accessible data handler and returns the class name
+	 * For the handler the reference matches.
+	 *
+	 * @param string $data_handler_reference
+	 * @return string
+	 */
+	public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
+	{
+		$class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
+						'event_espresso'
+					),
+					$data_handler_reference,
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = ''; // clear out class_name so caller knows this isn't valid.
+		}
+		return $class_name;
+	}
 }

caffeinated/payment_methods/Aim/help_tabs/payment_methods_overview_aim.help_tab.php

Indentation +52 added lines, -52 removed lines

@@ -6,15 +6,15 @@ 
 </p>
 <p>
     <?php
-    printf(
-        esc_html__(
-            'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
-            'event_espresso'
-        ),
-        "<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    );
-    ?>
+	printf(
+		esc_html__(
+			'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
+			'event_espresso'
+		),
+		"<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	);
+	?>
 </p>
 <p>
     <strong><?php esc_html_e('Authorize.net AIM Settings', 'event_espresso'); ?></strong>
@@ -24,70 +24,70 @@ 
         <strong><?php esc_html_e('Authorize.net API Login ID', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Authorize.net Transaction Key', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong>
             <?php esc_html_e(
-                'Is this an account on the Authorize.net development server?',
-                'event_espresso'
-            ); ?>
+				'Is this an account on the Authorize.net development server?',
+				'event_espresso'
+			); ?>
         </strong>
         <br/>
         <?php esc_html_e(
-            'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
-            'event_espresso'
-        ); ?>
+			'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Do you want to submit a test transaction?', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Excluded and Required Payment Form Fields', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
-            'event_espresso'
-        ); ?>
+			'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
+			'event_espresso'
+		); ?>
         <br>
         <?php printf(
-            esc_html__(
-                'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
-                'event_espresso'
-            ),
-            '<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
-            '</a>',
-            '<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
-        ); ?>
+			esc_html__(
+				'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
+				'event_espresso'
+			),
+			'<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
+			'</a>',
+			'<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong>
@@ -97,8 +97,8 @@ 
     <li>
         <strong><?php esc_html_e('Note About Special Characters', 'event_espresso'); ?></strong>
         <?php esc_html_e(
-            'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
-            'event_espresso'
-        ); ?>
+			'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
+			'event_espresso'
+		); ?>
     </li>
 </ul>

modules/ticket_selector/TicketSelectorRowStandard.php

Spacing +3 added lines, -3 removed lines

@@ -175,7 +175,7 @@ 
             '',
             'tckt-slctr-tbl-td-qty cntr',
             '',
-            'headers="quantity-' . $this->EVT_ID . '"'
+            'headers="quantity-'.$this->EVT_ID.'"'
         );
         $this->setTicketStatusDisplay($remaining);
         if (empty($this->ticket_status_display)) {
@@ -242,7 +242,7 @@ 
             '',
             'tckt-slctr-tbl-td-name',
             '',
-            'headers="details-' . $this->EVT_ID . '"'
+            'headers="details-'.$this->EVT_ID.'"'
         );
         $html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
         $html .= $this->ticket_details->getShowHideLinks();
@@ -276,7 +276,7 @@ 
                 '',
                 'tckt-slctr-tbl-td-price jst-rght',
                 '',
-                'headers="price-' . $this->EVT_ID . '"'
+                'headers="price-'.$this->EVT_ID.'"'
             );
             $html .= EEH_HTML::span(
                 EEH_Template::format_currency($this->ticket_price),

Indentation +382 added lines, -382 removed lines

@@ -19,390 +19,390 @@
  */
 class TicketSelectorRowStandard extends TicketSelectorRow
 {
-    /**
-     * @var TicketDetails
-     */
-    protected $ticket_details;
-
-    /**
-     * @var EE_Ticket_Selector_Config
-     */
-    protected $template_settings;
-
-    /**
-     * @var EE_Tax_Config
-     */
-    protected $tax_settings;
-
-    /**
-     * @var boolean
-     */
-    protected $prices_displayed_including_taxes;
-
-    /**
-     * @var int
-     */
-    protected $row;
-
-    /**
-     * @var int
-     */
-    protected $cols;
-
-    /**
-     * @var boolean
-     */
-    protected $hidden_input_qty = false;
-
-    /**
-     * @var string
-     */
-    protected $ticket_datetime_classes;
-
-    private bool $use_new_checkbox_selector;
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param TicketDetails $ticket_details
-     * @param EE_Tax_Config $tax_settings
-     * @param int           $total_tickets
-     * @param int           $max_attendees
-     * @param int           $row
-     * @param int           $cols
-     * @param boolean       $required_ticket_sold_out
-     * @param string        $event_status
-     * @param string        $ticket_datetime_classes
-     * @param bool          $use_new_checkbox_selector
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        TicketDetails $ticket_details,
-        EE_Tax_Config $tax_settings,
-        $total_tickets,
-        $max_attendees,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes,
-        bool $use_new_checkbox_selector = false
-    ) {
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        $this->use_new_checkbox_selector = $use_new_checkbox_selector;
-        parent::__construct(
-            $ticket_details->getTicket(),
-            $max_attendees,
-            $ticket_details->getDateFormat(),
-            $event_status,
-            $required_ticket_sold_out,
-            $total_tickets
-        );
-    }
-
-
-    /**
-     * other ticket rows will need to know if a required ticket is sold out,
-     * so that they are not offered for sale
-     *
-     * @return boolean
-     */
-    public function getRequiredTicketSoldOut()
-    {
-        return $this->required_ticket_sold_out;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getCols()
-    {
-        return $this->cols;
-    }
-
-
-    /**
-     * getHtml
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getHtml()
-    {
-        $this->min = 0;
-        $this->max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        $this->setTicketMinAndMax($remaining);
-        // set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
-        $this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
-            ? $this->ticket->start_date()
-            : $this->required_ticket_sold_out;
-        $this->setTicketPriceDetails();
-        $this->setTicketStatusClasses($remaining);
-        $filtered_row_html = $this->getFilteredRowHtml();
-        if ($filtered_row_html !== false) {
-            return $filtered_row_html;
-        }
-        $ticket_selector_row_html = EEH_HTML::tr(
-            '',
-            '',
-            "tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
-            . espresso_get_object_css_class($this->ticket)
-        );
-        $filtered_row_content = $this->getFilteredRowContents();
-        if ($filtered_row_content !== false) {
-            if ($this->max_attendees === 1) {
-                return $ticket_selector_row_html
-                       . $filtered_row_content
-                       . $this->ticketQtyAndIdHiddenInputs()
-                       . EEH_HTML::trx();
-            }
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_attendees > 1;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell();
-        $ticket_selector_row_html .= EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-qty cntr',
-            '',
-            'headers="quantity-' . $this->EVT_ID . '"'
-        );
-        $this->setTicketStatusDisplay($remaining);
-        if (empty($this->ticket_status_display)) {
-            $this->hidden_input_qty = false;
-            // display submit button since we have tickets available
-            add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-            if ($this->max_attendees === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } else {
-                $ticket_selector_row_html .= $this->max === 1 && $this->use_new_checkbox_selector
-                    ? $this->ticketCheckboxSelector()
-                    : $this->ticketQuantitySelector();
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display(
-            $this->ticket_price,
-            $remaining,
-            $this->cols
-        );
-        $ticket_selector_row_html .= EEH_HTML::tdx();
-        $ticket_selector_row_html .= EEH_HTML::trx();
-
-
-        $this->row++;
-        return $ticket_selector_row_html;
-    }
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function setTicketPriceDetails()
-    {
-        $this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $this->ticket_bundle = false;
-        $ticket_min = $this->ticket->min();
-        // for ticket bundles, set min and max qty the same
-        if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
-            $this->ticket_price *= $ticket_min;
-            $this->ticket_bundle = true;
-        }
-        $this->ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $this->ticket_price,
-            $this->ticket
-        );
-    }
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-name',
-            '',
-            'headers="details-' . $this->EVT_ID . '"'
-        );
-        $html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
-        $html .= $this->ticket_details->getShowHideLinks();
-        if ($this->ticket->required()) {
-            $html .= EEH_HTML::p(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_required_message',
-                    esc_html__('This ticket is required and must be purchased.', 'event_espresso')
-                ),
-                '',
-                'ticket-required-pg'
-            );
-        }
-        $html .= EEH_HTML::tdx();
-        return $html;
-    }
-
-
-    /**
-     * ticketPriceTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketPriceTableCell()
-    {
-        $html = '';
-        if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
-            $html .= EEH_HTML::td(
-                '',
-                '',
-                'tckt-slctr-tbl-td-price jst-rght',
-                '',
-                'headers="price-' . $this->EVT_ID . '"'
-            );
-            $html .= EEH_HTML::span(
-                EEH_Template::format_currency($this->ticket_price),
-                '',
-                'tckt-price--nowrap'
-            );
-            $html .= $this->ticket->taxable()
-                ? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
-                : '';
-            $html .= ' ';
-            // phpcs:disable WordPress.WP.I18n.NoEmptyStrings
-            $html .= EEH_HTML::span(
-                $this->ticket_bundle
-                    ? apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
-                        esc_html__(' / bundle', 'event_espresso')
-                    )
-                    : apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_text',
-                        esc_html__('', 'event_espresso')
-                    ),
-                '',
-                'smaller-text no-bold'
-            );
-            $html .= ' ';
-            $html .= EEH_HTML::tdx();
-            $this->cols++;
-        }
-        return $html;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function onlyOneAttendeeCanRegister(): string
-    {
-        $TKT   = $this->ticket->ID();
-        $label = esc_html__('Select this ticket', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID";
-        $class = "ticket-selector-tbl-qty-slct";
-        $id    = "$class-$this->EVT_ID-$this->row";
-        $checked = $this->total_tickets === 1 ? ' checked' : '';
-
-        return "
+	/**
+	 * @var TicketDetails
+	 */
+	protected $ticket_details;
+
+	/**
+	 * @var EE_Ticket_Selector_Config
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var EE_Tax_Config
+	 */
+	protected $tax_settings;
+
+	/**
+	 * @var boolean
+	 */
+	protected $prices_displayed_including_taxes;
+
+	/**
+	 * @var int
+	 */
+	protected $row;
+
+	/**
+	 * @var int
+	 */
+	protected $cols;
+
+	/**
+	 * @var boolean
+	 */
+	protected $hidden_input_qty = false;
+
+	/**
+	 * @var string
+	 */
+	protected $ticket_datetime_classes;
+
+	private bool $use_new_checkbox_selector;
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param TicketDetails $ticket_details
+	 * @param EE_Tax_Config $tax_settings
+	 * @param int           $total_tickets
+	 * @param int           $max_attendees
+	 * @param int           $row
+	 * @param int           $cols
+	 * @param boolean       $required_ticket_sold_out
+	 * @param string        $event_status
+	 * @param string        $ticket_datetime_classes
+	 * @param bool          $use_new_checkbox_selector
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		TicketDetails $ticket_details,
+		EE_Tax_Config $tax_settings,
+		$total_tickets,
+		$max_attendees,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes,
+		bool $use_new_checkbox_selector = false
+	) {
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		$this->use_new_checkbox_selector = $use_new_checkbox_selector;
+		parent::__construct(
+			$ticket_details->getTicket(),
+			$max_attendees,
+			$ticket_details->getDateFormat(),
+			$event_status,
+			$required_ticket_sold_out,
+			$total_tickets
+		);
+	}
+
+
+	/**
+	 * other ticket rows will need to know if a required ticket is sold out,
+	 * so that they are not offered for sale
+	 *
+	 * @return boolean
+	 */
+	public function getRequiredTicketSoldOut()
+	{
+		return $this->required_ticket_sold_out;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getCols()
+	{
+		return $this->cols;
+	}
+
+
+	/**
+	 * getHtml
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getHtml()
+	{
+		$this->min = 0;
+		$this->max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		$this->setTicketMinAndMax($remaining);
+		// set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
+		$this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
+			? $this->ticket->start_date()
+			: $this->required_ticket_sold_out;
+		$this->setTicketPriceDetails();
+		$this->setTicketStatusClasses($remaining);
+		$filtered_row_html = $this->getFilteredRowHtml();
+		if ($filtered_row_html !== false) {
+			return $filtered_row_html;
+		}
+		$ticket_selector_row_html = EEH_HTML::tr(
+			'',
+			'',
+			"tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
+			. espresso_get_object_css_class($this->ticket)
+		);
+		$filtered_row_content = $this->getFilteredRowContents();
+		if ($filtered_row_content !== false) {
+			if ($this->max_attendees === 1) {
+				return $ticket_selector_row_html
+					   . $filtered_row_content
+					   . $this->ticketQtyAndIdHiddenInputs()
+					   . EEH_HTML::trx();
+			}
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_attendees > 1;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell();
+		$ticket_selector_row_html .= EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-qty cntr',
+			'',
+			'headers="quantity-' . $this->EVT_ID . '"'
+		);
+		$this->setTicketStatusDisplay($remaining);
+		if (empty($this->ticket_status_display)) {
+			$this->hidden_input_qty = false;
+			// display submit button since we have tickets available
+			add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+			if ($this->max_attendees === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} else {
+				$ticket_selector_row_html .= $this->max === 1 && $this->use_new_checkbox_selector
+					? $this->ticketCheckboxSelector()
+					: $this->ticketQuantitySelector();
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display(
+			$this->ticket_price,
+			$remaining,
+			$this->cols
+		);
+		$ticket_selector_row_html .= EEH_HTML::tdx();
+		$ticket_selector_row_html .= EEH_HTML::trx();
+
+
+		$this->row++;
+		return $ticket_selector_row_html;
+	}
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function setTicketPriceDetails()
+	{
+		$this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$this->ticket_bundle = false;
+		$ticket_min = $this->ticket->min();
+		// for ticket bundles, set min and max qty the same
+		if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
+			$this->ticket_price *= $ticket_min;
+			$this->ticket_bundle = true;
+		}
+		$this->ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$this->ticket_price,
+			$this->ticket
+		);
+	}
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-name',
+			'',
+			'headers="details-' . $this->EVT_ID . '"'
+		);
+		$html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
+		$html .= $this->ticket_details->getShowHideLinks();
+		if ($this->ticket->required()) {
+			$html .= EEH_HTML::p(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_required_message',
+					esc_html__('This ticket is required and must be purchased.', 'event_espresso')
+				),
+				'',
+				'ticket-required-pg'
+			);
+		}
+		$html .= EEH_HTML::tdx();
+		return $html;
+	}
+
+
+	/**
+	 * ticketPriceTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketPriceTableCell()
+	{
+		$html = '';
+		if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+			$html .= EEH_HTML::td(
+				'',
+				'',
+				'tckt-slctr-tbl-td-price jst-rght',
+				'',
+				'headers="price-' . $this->EVT_ID . '"'
+			);
+			$html .= EEH_HTML::span(
+				EEH_Template::format_currency($this->ticket_price),
+				'',
+				'tckt-price--nowrap'
+			);
+			$html .= $this->ticket->taxable()
+				? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
+				: '';
+			$html .= ' ';
+			// phpcs:disable WordPress.WP.I18n.NoEmptyStrings
+			$html .= EEH_HTML::span(
+				$this->ticket_bundle
+					? apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
+						esc_html__(' / bundle', 'event_espresso')
+					)
+					: apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_text',
+						esc_html__('', 'event_espresso')
+					),
+				'',
+				'smaller-text no-bold'
+			);
+			$html .= ' ';
+			$html .= EEH_HTML::tdx();
+			$this->cols++;
+		}
+		return $html;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function onlyOneAttendeeCanRegister(): string
+	{
+		$TKT   = $this->ticket->ID();
+		$label = esc_html__('Select this ticket', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID";
+		$class = "ticket-selector-tbl-qty-slct";
+		$id    = "$class-$this->EVT_ID-$this->row";
+		$checked = $this->total_tickets === 1 ? ' checked' : '';
+
+		return "
         <label class='ee-a11y-screen-reader-text' for='$id' >$label</label>
         <input type='radio'$checked name='$name' id='$id' class='$class' value='$TKT-1' />";
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketCheckboxSelector(): string
-    {
-        $TKT = $this->ticket->ID();
-        $label = esc_html__('Select this ticket', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
-        $class = 'ticket-selector-tbl-qty-slct';
-        $id    = "$class-$this->EVT_ID-$this->row";
-        $title = esc_html__('only one of this ticket can be purchased at a time', 'event_espresso');
-
-        return "
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketCheckboxSelector(): string
+	{
+		$TKT = $this->ticket->ID();
+		$label = esc_html__('Select this ticket', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
+		$class = 'ticket-selector-tbl-qty-slct';
+		$id    = "$class-$this->EVT_ID-$this->row";
+		$title = esc_html__('only one of this ticket can be purchased at a time', 'event_espresso');
+
+		return "
         <label class='ee-a11y-screen-reader-text' for='$id' >$label</label>
         <input type='checkbox' name='$name' id='$id' class='$class' value='1' title='$title'/>";
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketQuantitySelector(): string
-    {
-        $TKT = $this->ticket->ID();
-        $label = esc_html__('Quantity', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
-        $class = 'ticket-selector-tbl-qty-slct';
-        $id = "$class-{$this->EVT_ID}-{$this->row}";
-
-        $html = "<label class='ee-a11y-screen-reader-text' for='$id' >$label</label>";
-        $html .= "<select name='$name' id='$id' class='$class'>";
-        // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
-        if ($this->min !== 0 && ! $this->ticket->required()) {
-            $html .= "<option value='0'>&nbsp;0&nbsp;</option>";
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $this->min; $i <= $this->max; $i++) {
-            $html .= "<option value='$i'>&nbsp;$i&nbsp;</option>";
-        }
-        $html .= "</select>";
-        return $html;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketQtyAndIdHiddenInputs(): string
-    {
-        $html = '';
-        $EVT = $this->EVT_ID;
-        $TKT = $this->ticket->ID();
-        // depending on group reg we need to change the format for qty
-        if ($this->hidden_input_qty) {
-            $html .= "<input type='hidden' name='tkt-slctr-qty-{$EVT}[]' value='0' />";
-        }
-        $html .= "<input type='hidden' name='tkt-slctr-ticket-id-{$EVT}[]' value='{$TKT}' />";
-        return $html;
-    }
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketQuantitySelector(): string
+	{
+		$TKT = $this->ticket->ID();
+		$label = esc_html__('Quantity', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
+		$class = 'ticket-selector-tbl-qty-slct';
+		$id = "$class-{$this->EVT_ID}-{$this->row}";
+
+		$html = "<label class='ee-a11y-screen-reader-text' for='$id' >$label</label>";
+		$html .= "<select name='$name' id='$id' class='$class'>";
+		// this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
+		if ($this->min !== 0 && ! $this->ticket->required()) {
+			$html .= "<option value='0'>&nbsp;0&nbsp;</option>";
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $this->min; $i <= $this->max; $i++) {
+			$html .= "<option value='$i'>&nbsp;$i&nbsp;</option>";
+		}
+		$html .= "</select>";
+		return $html;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketQtyAndIdHiddenInputs(): string
+	{
+		$html = '';
+		$EVT = $this->EVT_ID;
+		$TKT = $this->ticket->ID();
+		// depending on group reg we need to change the format for qty
+		if ($this->hidden_input_qty) {
+			$html .= "<input type='hidden' name='tkt-slctr-qty-{$EVT}[]' value='0' />";
+		}
+		$html .= "<input type='hidden' name='tkt-slctr-ticket-id-{$EVT}[]' value='{$TKT}' />";
+		return $html;
+	}
 }

admin_pages/about/templates/reviews.template.php

Spacing +2 added lines, -2 removed lines

@@ -451,7 +451,7 @@ 
 
 function espressoUpgradeNow()
 {
-    if (! defined('EE_CAF_URL')) {
+    if ( ! defined('EE_CAF_URL')) {
         return '
     <div class="ee-card ee-card__buy-now ee-grid-col-span-3 ee-card--blank">
         <a href="https://eventespresso.com/pricing/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=reviews+tab"
@@ -459,7 +459,7 @@ 
            class="button button--primary button-hero"
         >
             <span class="dashicons dashicons-cart"></span>
-            ' . esc_html__('Upgrade Now!', 'event_espresso') . '
+            ' . esc_html__('Upgrade Now!', 'event_espresso').'
         </a>
     </div>';
     }

Indentation +17 added lines, -17 removed lines

@@ -1,19 +1,19 @@ 
 <h2 style="text-align: left;"><?php esc_html_e('Who uses Event Espresso?', 'event_espresso'); ?></h2>
 <p>
     <?php printf(
-        esc_html__(
-            'Event Espresso is used by over 40,000 event organizers across the world. They host %sconferences%s, %sart classes%s, training courses, concerts, fundraisers, workshops, %sfilm festivals%s, %spaint and wine%s, and more.',
-            'event_espresso'
-        ),
-        '<a href="https://eventespresso.com/use-cases/conferences/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/art-classes/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/film-festival-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>',
-        '<a href="https://eventespresso.com/use-cases/paint-wine-party-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
-        '</a>'
-    ); ?>
+		esc_html__(
+			'Event Espresso is used by over 40,000 event organizers across the world. They host %sconferences%s, %sart classes%s, training courses, concerts, fundraisers, workshops, %sfilm festivals%s, %spaint and wine%s, and more.',
+			'event_espresso'
+		),
+		'<a href="https://eventespresso.com/use-cases/conferences/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/art-classes/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/film-festival-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>',
+		'<a href="https://eventespresso.com/use-cases/paint-wine-party-ticketing-software/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=Decaf+vs+Regular">',
+		'</a>'
+	); ?>
 </p>
 
 <h2 class="about-headline-callout">
@@ -451,8 +451,8 @@ 
 
 function espressoUpgradeNow()
 {
-    if (! defined('EE_CAF_URL')) {
-        return '
+	if (! defined('EE_CAF_URL')) {
+		return '
     <div class="ee-card ee-card__buy-now ee-grid-col-span-3 ee-card--blank">
         <a href="https://eventespresso.com/pricing/?utm_source=wordpress_org&amp;utm_medium=link&amp;utm_campaign=decaf_about_page&amp;utm_content=reviews+tab"
            target="_blank"
@@ -462,13 +462,13 @@ 
             ' . esc_html__('Upgrade Now!', 'event_espresso') . '
         </a>
     </div>';
-    }
+	}
 }
 
 
 function espressoFiveStars()
 {
-    return '
+	return '
         <div class="wporg-ratings" aria-label="5 out of 5 stars">
             <span class="dashicons dashicons-star-filled"></span>
             <span class="dashicons dashicons-star-filled"></span>

admin_pages/support/templates/support_admin_details_contact_support.template.php

Indentation +66 added lines, -66 removed lines

@@ -3,100 +3,100 @@
 
     <h4>
         <?php
-        esc_html_e(
-            'You may be able to find an answer for your question or concern here:',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'You may be able to find an answer for your question or concern here:',
+			'event_espresso'
+		);
+		?>
     </h4>
     <ol>
         <li>
             <strong><em><?php esc_html_e('A known issue.', 'event_espresso'); ?></em></strong>
             <?php
-            printf(
-                esc_html__(
-                    'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
-                '</a>',
-                '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
-                '<a href="https://eventespresso.com/support/forums/" target="_blank">'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
+				'</a>',
+				'<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
+				'<a href="https://eventespresso.com/support/forums/" target="_blank">'
+			);
+			?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A plugin conflict.', 'event_espresso'); ?></em></strong>
             <?php esc_html_e(
-                'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
-                'event_espresso'
-            ); ?>
+				'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
+				'event_espresso'
+			); ?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A theme conflict.', 'event_espresso'); ?></em></strong>
             <?php
-            $default_theme = wp_get_theme(WP_DEFAULT_THEME);
+			$default_theme = wp_get_theme(WP_DEFAULT_THEME);
 
-            if ($default_theme->exists()) {
-                printf(
-                    esc_html__(
-                        'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
-                        'event_espresso'
-                    ),
-                    $default_theme->get('Name')
-                );
-            } else {
-                esc_html_e(
-                    'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
-                    'event_espresso'
-                );
-            }
-            ?>
+			if ($default_theme->exists()) {
+				printf(
+					esc_html__(
+						'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
+						'event_espresso'
+					),
+					$default_theme->get('Name')
+				);
+			} else {
+				esc_html_e(
+					'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
+					'event_espresso'
+				);
+			}
+			?>
             <?php
-            esc_html_e(
-                'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
-                'event_espresso'
-            );
-            ?>
+			esc_html_e(
+				'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
+				'event_espresso'
+			);
+			?>
         </li>
     </ol>
 
     <p>
         <?php
-        esc_html_e(
-            'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
+			'event_espresso'
+		);
+		?>
     </p>
     <p>
         <?php
-        printf(
-            esc_html__(
-                'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/support/forums/" target="_blank">',
-            '</a>',
-            '<strong>',
-            '</strong>',
-            '<a href="#espresso_important_information_settings">'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/support/forums/" target="_blank">',
+			'</a>',
+			'<strong>',
+			'</strong>',
+			'<a href="#espresso_important_information_settings">'
+		);
+		?>
     </p>
 
     <h4><?php esc_html_e('Have an emergency?', 'event_espresso'); ?></h4>
 
     <p>
         <?php
-        printf(
-            esc_html__(
-                'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
+			'</a>'
+		);
+		?>
     </p>
 </div>

admin_pages/support/templates/support_admin_details_shortcodes_event_listings.template.php

Indentation +27 added lines, -27 removed lines

@@ -1,19 +1,19 @@ 
 <div class="padding">
     <p>
         <?php
-        esc_html_e(
-            'Displays a list of events based on a set of criteria on a WordPress page or post. Unless otherwise specified, events are sorted by start date.',
-            'event_espresso'
-        );
-        printf(
-            esc_html__(
-                'For a full list of available shortcodes, please view the %sshortcode documentation%s on our website.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/wiki/ee4-shortcodes-template-variables/">',
-            '</a>'
-        );
-        ?>
+		esc_html_e(
+			'Displays a list of events based on a set of criteria on a WordPress page or post. Unless otherwise specified, events are sorted by start date.',
+			'event_espresso'
+		);
+		printf(
+			esc_html__(
+				'For a full list of available shortcodes, please view the %sshortcode documentation%s on our website.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/wiki/ee4-shortcodes-template-variables/">',
+			'</a>'
+		);
+		?>
     </p>
     <ul>
         <li>
@@ -36,9 +36,9 @@ 
         <li>
             <strong>
                 <?php esc_html_e(
-                    'Limit (paginate) the number of events that are shown in the event list on a page or post',
-                    'event_espresso'
-                ); ?>
+					'Limit (paginate) the number of events that are shown in the event list on a page or post',
+					'event_espresso'
+				); ?>
             </strong>
             <br />
             [ESPRESSO_EVENTS limit=5]
@@ -81,9 +81,9 @@ 
         <li>
             <strong>
                 <?php esc_html_e(
-                    'Order the event list by a specific set of parameters (refer to available options below)',
-                    'event_espresso'
-                ); ?>
+					'Order the event list by a specific set of parameters (refer to available options below)',
+					'event_espresso'
+				); ?>
             </strong>
             <br />
             [ESPRESSO_EVENTS order_by=start_date,id]
@@ -91,14 +91,14 @@ 
     </ul>
     <p>
         <?php
-        printf(
-            esc_html__(
-                'These parameters (options) are available for the %s shortcode parameter above. Multiple parameters should be separated by a comma.',
-                'event_espresso'
-            ),
-            'order_by'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'These parameters (options) are available for the %s shortcode parameter above. Multiple parameters should be separated by a comma.',
+				'event_espresso'
+			),
+			'order_by'
+		);
+		?>
     </p>
     <p>
         id<br />

admin_pages/support/Support_Admin_Page.core.php

Spacing +6 added lines, -6 removed lines

@@ -117,7 +117,7 @@ 
 
     protected function _installation()
     {
-        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
+        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH.'support_admin_details_installation.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             '',
@@ -138,7 +138,7 @@ 
         $this->addMetaBox(
             "espresso_{$box}_settings",
             $label,
-            function ($post, $metabox) {
+            function($post, $metabox) {
                 EEH_Template::display_template(
                     $metabox['args']['template_path'],
                     $metabox['args']['template_args']
@@ -173,7 +173,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -205,7 +205,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -233,7 +233,7 @@ 
                 $box,
                 $label,
                 array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH."support_admin_details_{$box}.template.php",
                     'template_args' => $this->_template_args,
                 )
             );
@@ -244,7 +244,7 @@ 
     protected function _developers()
     {
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
+            EE_SUPPORT_ADMIN_TEMPLATE_PATH.'developers_admin_details.template.php',
             array(),
             true
         );

Indentation +240 added lines, -240 removed lines

@@ -11,244 +11,244 @@
  */
 class Support_Admin_Page extends EE_Admin_Page
 {
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_SUPPORT_PG_SLUG;
-        $this->page_label = esc_html__('Help & Support', 'event_espresso');
-        $this->_admin_base_url = EE_SUPPORT_ADMIN_URL;
-        $this->_admin_base_path = EE_SUPPORT_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_labels = array();
-        $this->_admin_page_title = $this->page_label;
-    }
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default'    => array(
-                'func'       => [$this, '_contact_support'],
-                'capability' => 'ee_read_ee',
-            ),
-            'developers' => array(
-                'func'       => [$this, '_developers'],
-                'capability' => 'ee_read_ee',
-            ),
-            'shortcodes' => array(
-                'func'       => [$this, '_shortcodes'],
-                'capability' => 'ee_read_ee',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'    => array(
-                'nav'           => array(
-                    'label' => esc_html__('Support', 'event_espresso'),
-                    'icon' => 'dashicons-sos',
-                    'order' => 30,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_support_boxes')),
-                'require_nonce' => false,
-            ),
-            'developers' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Developers', 'event_espresso'),
-                    'icon' => 'dashicons-coffee',
-                    'order' => 50,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-            'shortcodes' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Shortcodes', 'event_espresso'),
-                    'icon' => 'dashicons-shortcode',
-                    'order' => 60,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_shortcodes_boxes')),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    // none of the below group are currently used for Support pages
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-    }
-
-
-    protected function _installation()
-    {
-        $template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            '',
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _resources()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _add_settings_metabox($box, $label, array $args)
-    {
-        $this->addMetaBox(
-            "espresso_{$box}_settings",
-            $label,
-            function ($post, $metabox) {
-                EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args']
-                );
-            },
-            $this->_current_screen->id,
-            'normal',
-            'high',
-            apply_filters(
-                "FHEE__Support_Admin_Page___add_settings_metabox__{$box}_args_array",
-                $args
-            )
-        );
-    }
-
-
-    protected function _resources_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___resources_boxes__boxes_array',
-            array(
-                'favorite_theme_developers' => esc_html__('Favorite Theme Developers', 'event_espresso'),
-                'highly_recommended_themes' => esc_html__('Highly Recommended Themes', 'event_espresso'),
-                'hire_developer'            => esc_html__('Hire a Developer', 'event_espresso'),
-                'partners'                  => esc_html__('Partners', 'event_espresso'),
-                'recommended_plugins'       => esc_html__('Recommended Plugins', 'event_espresso'),
-                'other_resources'           => esc_html__('Other Resources', 'event_espresso'),
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-    protected function _shortcodes()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _shortcodes_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___shortcodes_boxes__boxes_array',
-            array(
-                'shortcodes_event_listings'  => esc_html__('Event Listings', 'event_espresso'),
-                'shortcodes_ticket_selector' => esc_html__('Event Ticket Selector', 'event_espresso'),
-                'shortcodes_category'        => esc_html__('Event Categories', 'event_espresso'),
-                'shortcodes_attendee'        => esc_html__('Event Attendees', 'event_espresso')
-                /*'shortcodes_single_events' => esc_html__('Single Events', 'event_espresso'),*/
-                /*'shortcodes_attendee_listings' => esc_html__('Attendee Listings', 'event_espresso'),*/
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-    protected function _contact_support()
-    {
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _support_boxes()
-    {
-        $boxes = apply_filters(
-            'FHEE__Support_Admin_Page___support_boxes__boxes_array',
-            array(
-                'contact_support'       => esc_html__('Contact Support', 'event_espresso'),
-                'important_information' => esc_html__('Important Information', 'event_espresso'),
-            )
-        );
-        foreach ($boxes as $box => $label) {
-            $this->_add_settings_metabox(
-                $box,
-                $label,
-                array(
-                    'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
-                    'template_args' => $this->_template_args,
-                )
-            );
-        }
-    }
-
-
-    protected function _developers()
-    {
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
-            array(),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_SUPPORT_PG_SLUG;
+		$this->page_label = esc_html__('Help & Support', 'event_espresso');
+		$this->_admin_base_url = EE_SUPPORT_ADMIN_URL;
+		$this->_admin_base_path = EE_SUPPORT_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_labels = array();
+		$this->_admin_page_title = $this->page_label;
+	}
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default'    => array(
+				'func'       => [$this, '_contact_support'],
+				'capability' => 'ee_read_ee',
+			),
+			'developers' => array(
+				'func'       => [$this, '_developers'],
+				'capability' => 'ee_read_ee',
+			),
+			'shortcodes' => array(
+				'func'       => [$this, '_shortcodes'],
+				'capability' => 'ee_read_ee',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'    => array(
+				'nav'           => array(
+					'label' => esc_html__('Support', 'event_espresso'),
+					'icon' => 'dashicons-sos',
+					'order' => 30,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_support_boxes')),
+				'require_nonce' => false,
+			),
+			'developers' => array(
+				'nav'           => array(
+					'label' => esc_html__('Developers', 'event_espresso'),
+					'icon' => 'dashicons-coffee',
+					'order' => 50,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+			'shortcodes' => array(
+				'nav'           => array(
+					'label' => esc_html__('Shortcodes', 'event_espresso'),
+					'icon' => 'dashicons-shortcode',
+					'order' => 60,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_shortcodes_boxes')),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	// none of the below group are currently used for Support pages
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+	}
+
+
+	protected function _installation()
+	{
+		$template_path = EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'support_admin_details_installation.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			'',
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _resources()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _add_settings_metabox($box, $label, array $args)
+	{
+		$this->addMetaBox(
+			"espresso_{$box}_settings",
+			$label,
+			function ($post, $metabox) {
+				EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args']
+				);
+			},
+			$this->_current_screen->id,
+			'normal',
+			'high',
+			apply_filters(
+				"FHEE__Support_Admin_Page___add_settings_metabox__{$box}_args_array",
+				$args
+			)
+		);
+	}
+
+
+	protected function _resources_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___resources_boxes__boxes_array',
+			array(
+				'favorite_theme_developers' => esc_html__('Favorite Theme Developers', 'event_espresso'),
+				'highly_recommended_themes' => esc_html__('Highly Recommended Themes', 'event_espresso'),
+				'hire_developer'            => esc_html__('Hire a Developer', 'event_espresso'),
+				'partners'                  => esc_html__('Partners', 'event_espresso'),
+				'recommended_plugins'       => esc_html__('Recommended Plugins', 'event_espresso'),
+				'other_resources'           => esc_html__('Other Resources', 'event_espresso'),
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+	protected function _shortcodes()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _shortcodes_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___shortcodes_boxes__boxes_array',
+			array(
+				'shortcodes_event_listings'  => esc_html__('Event Listings', 'event_espresso'),
+				'shortcodes_ticket_selector' => esc_html__('Event Ticket Selector', 'event_espresso'),
+				'shortcodes_category'        => esc_html__('Event Categories', 'event_espresso'),
+				'shortcodes_attendee'        => esc_html__('Event Attendees', 'event_espresso')
+				/*'shortcodes_single_events' => esc_html__('Single Events', 'event_espresso'),*/
+				/*'shortcodes_attendee_listings' => esc_html__('Attendee Listings', 'event_espresso'),*/
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+	protected function _contact_support()
+	{
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _support_boxes()
+	{
+		$boxes = apply_filters(
+			'FHEE__Support_Admin_Page___support_boxes__boxes_array',
+			array(
+				'contact_support'       => esc_html__('Contact Support', 'event_espresso'),
+				'important_information' => esc_html__('Important Information', 'event_espresso'),
+			)
+		);
+		foreach ($boxes as $box => $label) {
+			$this->_add_settings_metabox(
+				$box,
+				$label,
+				array(
+					'template_path' => EE_SUPPORT_ADMIN_TEMPLATE_PATH . "support_admin_details_{$box}.template.php",
+					'template_args' => $this->_template_args,
+				)
+			);
+		}
+	}
+
+
+	protected function _developers()
+	{
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_SUPPORT_ADMIN_TEMPLATE_PATH . 'developers_admin_details.template.php',
+			array(),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 }

admin_pages/transactions/help_tabs/transactions_overview_views_filters_search.help_tab.php

Indentation +21 added lines, -21 removed lines

@@ -3,9 +3,9 @@ 
 </p>
 <p>
     <?php esc_html_e(
-        'Views allow you to restrict what you see in the Transactions Overview table. The following views are available: View All. The number in parentheses next to each view represents the number of transactions that will be displayed with that view.',
-        'event_espresso'
-    ); ?>
+		'Views allow you to restrict what you see in the Transactions Overview table. The following views are available: View All. The number in parentheses next to each view represents the number of transactions that will be displayed with that view.',
+		'event_espresso'
+	); ?>
     <br />
 </p>
 <ul>
@@ -13,31 +13,31 @@ 
         <strong><?php esc_html_e('View All Transactions', 'event_espresso'); ?></strong>
         <br />
         <?php printf(
-            esc_html__(
-                'Shows transactions where the registrant has completed the full registration process. Transactions in this view will either have a status of: %1$s%2$s"Incomplete" meaning there are monies owing%3$s%2$s"Complete" meaning there are NO monies owing%3$s%2$s"Overpaid" meaning that monies should be refunded to the registrant.%3$s%4$s',
-                'event_espresso'
-            ),
-            '<ul>',
-            '<li>',
-            '</li>',
-            '</ul>'
-        ); ?>
+			esc_html__(
+				'Shows transactions where the registrant has completed the full registration process. Transactions in this view will either have a status of: %1$s%2$s"Incomplete" meaning there are monies owing%3$s%2$s"Complete" meaning there are NO monies owing%3$s%2$s"Overpaid" meaning that monies should be refunded to the registrant.%3$s%4$s',
+				'event_espresso'
+			),
+			'<ul>',
+			'<li>',
+			'</li>',
+			'</ul>'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Abandoned Transactions', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'Shows transactions that have been abandoned, either due to a technical reason (server or computer crash during registration), or due to an abandoned cart where the registrant chose not to complete the registration process. Please note that Abandoned Transactions were able to capture contact information for at least one registrant. This can be helpful for following up with the contact to determine if they still wish to attend the event or not.',
-            'event_espresso'
-        ); ?>
+			'Shows transactions that have been abandoned, either due to a technical reason (server or computer crash during registration), or due to an abandoned cart where the registrant chose not to complete the registration process. Please note that Abandoned Transactions were able to capture contact information for at least one registrant. This can be helpful for following up with the contact to determine if they still wish to attend the event or not.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Failed Transactions', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'Shows transactions that have failed, either due to a technical reason (server or computer crash during registration), or some other reason that prevented the collection of any useful contact information from any of the registrants. This could mean the registrant abandoned the registration process before submitting any data whatsoever or may even indicate attempts by spam bots to submit the registration form.',
-            'event_espresso'
-        ); ?>
+			'Shows transactions that have failed, either due to a technical reason (server or computer crash during registration), or some other reason that prevented the collection of any useful contact information from any of the registrants. This could mean the registrant abandoned the registration process before submitting any data whatsoever or may even indicate attempts by spam bots to submit the registration form.',
+			'event_espresso'
+		); ?>
     </li>
 </ul>
 <p>
@@ -58,7 +58,7 @@ 
 </p>
 <p>
     <?php esc_html_e(
-        'You can perform a search to find specific transactions. The following sources will be searched: Event Name (title), Event Description, First Name, Last Name, Bio, Email, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, Ticket Description, Payment Method, Payment Gateway, Transaction Details, and Transaction Session Data. To use the search feature, enter a value into the search box and click on the Search Transactions button.',
-        'event_espresso'
-    ); ?>
+		'You can perform a search to find specific transactions. The following sources will be searched: Event Name (title), Event Description, First Name, Last Name, Bio, Email, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, Ticket Description, Payment Method, Payment Gateway, Transaction Details, and Transaction Session Data. To use the search feature, enter a value into the search box and click on the Search Transactions button.',
+		'event_espresso'
+	); ?>
 </p>