eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Queue.lib.php

Spacing +12 added lines, -12 removed lines

@@ -171,9 +171,9 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         );
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
-        if (! $messages) {
+        if ( ! $messages) {
             return false; // nothing to generate
         }
 
@@ -227,7 +227,7 @@ 
 
 
         // any to send?
-        if (! $messages_to_send) {
+        if ( ! $messages_to_send) {
             $this->unlock_queue(EE_Messages_Queue::action_sending);
             return false;
         }
@@ -283,7 +283,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -355,7 +355,7 @@ 
      */
     public function is_locked($type = EE_Messages_Queue::action_generating)
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return true;
         }
         $lock = (int) get_option($this->_get_lock_key($type), 0);
@@ -505,7 +505,7 @@ 
             /** @type EE_Message $message */
             $message = $this->_message_repository->current();
             // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -515,13 +515,13 @@ 
                 continue;
             }
             // error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     __('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     __('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -582,9 +582,9 @@ 
         // send using messenger, but double check objects
         if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
             // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
+            if ( ! isset($this->_did_hook[$message_type->name])) {
                 $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
+                $this->_did_hook[$message_type->name] = 1;
             }
             // if preview then use preview method
             return $this->_message_repository->is_preview()
@@ -635,7 +635,7 @@ 
         $test_send
     ) {
         if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
+            if ( ! $test_send) {
                 $message->set_content($preview);
             }
             $message->set_STS_ID(EEM_Message::status_sent);
@@ -700,7 +700,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }

Indentation +695 added lines, -695 removed lines

@@ -15,699 +15,699 @@
 {
 
 
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = array();
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param \EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param  bool      $preview      Whether this EE_Message represents a preview or not.
-     * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            // get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_generating)) {
-            return false;
-        }
-
-        // lock batch generation to prevent race conditions.
-        $this->lock_queue(EE_Messages_Queue::action_generating);
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => EEM_Message::status_incomplete),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        );
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if (! $messages) {
-            return false; // nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     */
-    public function get_to_send_batch_and_send()
-    {
-        $rate_limit = $this->get_rate_limit();
-        if (
-            $rate_limit < 1
-            || $this->is_locked(EE_Messages_Queue::action_sending)
-        ) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        );
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        // any to send?
-        if (! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        $queue_count = 0;
-
-        // add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $queue_count++;
-                $this->add($message);
-            }
-        }
-
-        // send messages  (this also updates the rate limit)
-        $this->execute();
-
-        // release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        // update rate limit
-        $this->set_rate_limit($queue_count);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param   string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param   string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_option($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return array(
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        );
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
-     * Return true when batch methods should not be used; returns false when they can be.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return true;
-        }
-        $lock = (int) get_option($this->_get_lock_key($type), 0);
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                $lock > time(),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
-     * @return int
-     */
-    protected function get_rate_limit($return_expiry = false)
-    {
-        $stored_rate_info = get_option($this->_get_rate_limit_key(), array());
-        $rate_limit = isset($stored_rate_info[0])
-            ? (int) $stored_rate_info[0]
-            : 0;
-        $expiry = isset($stored_rate_info[1])
-            ? (int) $stored_rate_info[1]
-            : 0;
-        // set the default for tracking?
-        if (empty($stored_rate_info) || time() > $expiry) {
-            $expiry = $this->_get_rate_limit_expiry();
-            $rate_limit = $this->_default_rate_limit();
-            update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
-        }
-        return $return_expiry ? $expiry : $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    protected function set_rate_limit($batch_completed)
-    {
-        // first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $expiry = $this->get_rate_limit(true);
-        $new_limit  = $rate_limit - $batch_completed;
-        // updating the transient option directly to avoid resetting the expiry.
-
-        update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        // determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            // if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            // queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param   bool     $save                    Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param   bool|int $by_priority             When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = array();
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = array();
-            /** @type EE_Message $message */
-            $message = $this->_message_repository->current();
-            // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    __('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    __('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            // add modified time
-            $message->set_modified(time());
-            // we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            // out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        // do actions for sending messenger if it differs from generating messenger and swap values.
-        if (
-            $sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
-            }
-            // if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array|string $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : array($status);
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array) $error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = __(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = array();
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param \EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param  bool      $preview      Whether this EE_Message represents a preview or not.
+	 * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			// get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
+			return false;
+		}
+
+		// lock batch generation to prevent race conditions.
+		$this->lock_queue(EE_Messages_Queue::action_generating);
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => EEM_Message::status_incomplete),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		);
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if (! $messages) {
+			return false; // nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		$rate_limit = $this->get_rate_limit();
+		if (
+			$rate_limit < 1
+			|| $this->is_locked(EE_Messages_Queue::action_sending)
+		) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		);
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		// any to send?
+		if (! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		$queue_count = 0;
+
+		// add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$queue_count++;
+				$this->add($message);
+			}
+		}
+
+		// send messages  (this also updates the rate limit)
+		$this->execute();
+
+		// release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		// update rate limit
+		$this->set_rate_limit($queue_count);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param   string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param   string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_option($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return array(
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		);
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
+	 * Return true when batch methods should not be used; returns false when they can be.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return true;
+		}
+		$lock = (int) get_option($this->_get_lock_key($type), 0);
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				$lock > time(),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
+	 * @return int
+	 */
+	protected function get_rate_limit($return_expiry = false)
+	{
+		$stored_rate_info = get_option($this->_get_rate_limit_key(), array());
+		$rate_limit = isset($stored_rate_info[0])
+			? (int) $stored_rate_info[0]
+			: 0;
+		$expiry = isset($stored_rate_info[1])
+			? (int) $stored_rate_info[1]
+			: 0;
+		// set the default for tracking?
+		if (empty($stored_rate_info) || time() > $expiry) {
+			$expiry = $this->_get_rate_limit_expiry();
+			$rate_limit = $this->_default_rate_limit();
+			update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
+		}
+		return $return_expiry ? $expiry : $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	protected function set_rate_limit($batch_completed)
+	{
+		// first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$expiry = $this->get_rate_limit(true);
+		$new_limit  = $rate_limit - $batch_completed;
+		// updating the transient option directly to avoid resetting the expiry.
+
+		update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		// determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			// if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			// queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param   bool     $save                    Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param   bool|int $by_priority             When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = array();
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = array();
+			/** @type EE_Message $message */
+			$message = $this->_message_repository->current();
+			// only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			// add modified time
+			$message->set_modified(time());
+			// we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			// out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		// do actions for sending messenger if it differs from generating messenger and swap values.
+		if (
+			$sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			// set hook for message type (but only if not using another messenger to send).
+			if (! isset($this->_did_hook[ $message_type->name ])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[ $message_type->name ] = 1;
+			}
+			// if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array|string $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : array($status);
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if (! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array) $error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = __(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 }

core/exceptions/InvalidAliasException.php

Indentation +23 added lines, -23 removed lines

@@ -16,27 +16,27 @@
 class InvalidAliasException extends DomainException
 {
 
-    /**
-     * InvalidClassException constructor.
-     *
-     * @param string    $fqcn
-     * @param string    $alias
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($fqcn, $alias, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" can not be used as an alias because the "%2$s"  class does not extend or implement it.',
-                    'event_espresso'
-                ),
-                $alias,
-                $fqcn
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidClassException constructor.
+	 *
+	 * @param string    $fqcn
+	 * @param string    $alias
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($fqcn, $alias, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" can not be used as an alias because the "%2$s"  class does not extend or implement it.',
+					'event_espresso'
+				),
+				$alias,
+				$fqcn
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/dependencies/ClassAlias.php

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      */
     public function __construct($alias, $fqcn)
     {
-        if (! is_subclass_of($fqcn, $alias)) {
+        if ( ! is_subclass_of($fqcn, $alias)) {
             throw new InvalidAliasException($fqcn, $alias);
         }
         $this->alias = $alias;

Indentation +42 added lines, -42 removed lines

@@ -17,46 +17,46 @@
 class ClassAlias
 {
 
-    /**
-     * @var string $alias   an interface or base class representing what object
-     *                      can be utilized by another object and/or function
-     */
-    private $alias;
-
-    /**
-     * @var string $fqcn the actual class that should be substituted for the alias above
-     */
-    private $fqcn;
-
-    /**
-     * ClassAlias constructor.
-     *
-     * @param string $alias Interface specified by implementing class
-     * @param string $fqcn  Concrete class that satisfies interface
-     * @throws InvalidAliasException
-     */
-    public function __construct($alias, $fqcn)
-    {
-        if (! is_subclass_of($fqcn, $alias)) {
-            throw new InvalidAliasException($fqcn, $alias);
-        }
-        $this->alias = $alias;
-        $this->fqcn = $fqcn;
-    }
-
-    /**
-     * @return string
-     */
-    public function alias()
-    {
-        return $this->alias;
-    }
-
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
+	/**
+	 * @var string $alias   an interface or base class representing what object
+	 *                      can be utilized by another object and/or function
+	 */
+	private $alias;
+
+	/**
+	 * @var string $fqcn the actual class that should be substituted for the alias above
+	 */
+	private $fqcn;
+
+	/**
+	 * ClassAlias constructor.
+	 *
+	 * @param string $alias Interface specified by implementing class
+	 * @param string $fqcn  Concrete class that satisfies interface
+	 * @throws InvalidAliasException
+	 */
+	public function __construct($alias, $fqcn)
+	{
+		if (! is_subclass_of($fqcn, $alias)) {
+			throw new InvalidAliasException($fqcn, $alias);
+		}
+		$this->alias = $alias;
+		$this->fqcn = $fqcn;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function alias()
+	{
+		return $this->alias;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
 }

core/services/factory/FactoryWithDependencyResolver.php

Indentation +33 added lines, -33 removed lines

@@ -18,41 +18,41 @@
  */
 abstract class FactoryWithDependencyResolver implements FactoryInterface
 {
-    /**
-     * @var DependencyResolverInterface $dependency_resolver
-     */
-    private $dependency_resolver;
+	/**
+	 * @var DependencyResolverInterface $dependency_resolver
+	 */
+	private $dependency_resolver;
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
 
-    /**
-     * FactoryWithDependencyResolver constructor.
-     *
-     * @param DependencyResolverInterface $dependency_resolver
-     * @param LoaderInterface             $loader
-     */
-    public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
-    {
-        $this->dependency_resolver = $dependency_resolver;
-        $this->loader = $loader;
-    }
+	/**
+	 * FactoryWithDependencyResolver constructor.
+	 *
+	 * @param DependencyResolverInterface $dependency_resolver
+	 * @param LoaderInterface             $loader
+	 */
+	public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
+	{
+		$this->dependency_resolver = $dependency_resolver;
+		$this->loader = $loader;
+	}
 
-    /**
-     * @return DependencyResolverInterface
-     */
-    public function dependencyResolver()
-    {
-        return $this->dependency_resolver;
-    }
+	/**
+	 * @return DependencyResolverInterface
+	 */
+	public function dependencyResolver()
+	{
+		return $this->dependency_resolver;
+	}
 
-    /**
-     * @return LoaderInterface
-     */
-    public function loader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @return LoaderInterface
+	 */
+	public function loader()
+	{
+		return $this->loader;
+	}
 }

core/domain/services/factories/FactoryInterface.php

Indentation +6 added lines, -6 removed lines

@@ -11,10 +11,10 @@
 interface FactoryInterface
 {
 
-    /**
-     * @param mixed $arguments Either a Fully Qualified Class Name
-     *                         or array of data required for construction
-     * @return mixed
-     */
-    public static function create($arguments);
+	/**
+	 * @param mixed $arguments Either a Fully Qualified Class Name
+	 *                         or array of data required for construction
+	 * @return mixed
+	 */
+	public static function create($arguments);
 }

core/services/editor/BlockRegistrationManager.php

Spacing +7 added lines, -7 removed lines

@@ -145,7 +145,7 @@ 
             foreach ($this->blocks as $block) {
                 $block->initialize();
                 $this->trackAssetManagersForBlocks($block);
-                if (! $this->block_asset_manager_collection->has($block->assetManager())) {
+                if ( ! $this->block_asset_manager_collection->has($block->assetManager())) {
                     $this->block_asset_manager_collection->add($block->assetManager());
                     $block->assetManager()->setAssetHandles();
                 }
@@ -167,7 +167,7 @@ 
         $supported_routes = $block->supportedRoutes();
         foreach ($supported_routes as $supported_route) {
             if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
-                $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
+                $this->block_asset_managers[$block->blockType()] = $block->assetManager()->assetNamespace();
             }
         }
     }
@@ -183,10 +183,10 @@ 
      */
     public function matchesRoute(BlockInterface $block)
     {
-        if (isset($this->block_asset_managers[ $block->blockType() ])) {
+        if (isset($this->block_asset_managers[$block->blockType()])) {
             return true;
         }
-        unset($this->block_asset_managers[ $block->blockType() ]);
+        unset($this->block_asset_managers[$block->blockType()]);
         return false;
     }
 
@@ -202,12 +202,12 @@ 
         try {
             // cycle thru block loader folders
             foreach ($this->blocks as $block) {
-                if (! $this->matchesRoute($block)) {
+                if ( ! $this->matchesRoute($block)) {
                     continue;
                 }
                 // perform any setup required for the block
                 $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
+                if ( ! $block_type instanceof WP_Block_Type) {
                     throw new InvalidEntityException($block_type, 'WP_Block_Type');
                 }
                 do_action(
@@ -226,7 +226,7 @@ 
         $assets = array_flip($this->block_asset_managers);
         foreach ($this->block_asset_manager_collection as $asset_manager) {
             // if there are no longer any blocks that require these assets,
-            if (! isset($assets[ $asset_manager->assetNamespace() ])) {
+            if ( ! isset($assets[$asset_manager->assetNamespace()])) {
                 // then unset asset enqueueing and bail
                 remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
                 remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);

Indentation +219 added lines, -219 removed lines

@@ -32,223 +32,223 @@
 class BlockRegistrationManager extends BlockManager
 {
 
-    /**
-     * @var BlockAssetManagerCollection $block_asset_manager_collection
-     */
-    protected $block_asset_manager_collection;
-
-    /**
-     * @var RouteMatchSpecificationManager $route_manager
-     */
-    protected $route_manager;
-
-    /**
-     * array for tracking asset managers required by blocks for the current route
-     *
-     * @var array $block_asset_managers
-     */
-    protected $block_asset_managers = array();
-
-
-    /**
-     * BlockRegistrationManager constructor.
-     *
-     * @param BlockAssetManagerCollection    $block_asset_manager_collection
-     * @param BlockCollection                $blocks
-     * @param RouteMatchSpecificationManager $route_manager
-     * @param RequestInterface               $request
-     */
-    public function __construct(
-        BlockAssetManagerCollection $block_asset_manager_collection,
-        BlockCollection $blocks,
-        RouteMatchSpecificationManager $route_manager,
-        RequestInterface $request
-    ) {
-        $this->block_asset_manager_collection = $block_asset_manager_collection;
-        $this->route_manager = $route_manager;
-        parent::__construct($blocks, $request);
-    }
-
-
-    /**
-     *  Returns the name of a hook point to be used to call initialize()
-     *
-     * @return string
-     */
-    public function initHook()
-    {
-        return 'AHEE__EE_System__initialize';
-    }
-
-
-    /**
-     * Perform any early setup required for block editors to functions
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function initialize()
-    {
-        $this->initializeBlocks();
-        add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks'));
-        add_action('wp_loaded', array($this, 'unloadAssets'));
-        add_filter('block_categories', array($this, 'addEspressoBlockCategories'));
-    }
-
-
-    /**
-     * @param array $categories
-     * @since 4.9.71.p
-     * @return array
-     */
-    public function addEspressoBlockCategories(array $categories)
-    {
-        return array_merge(
-            $categories,
-            array(
-                array(
-                    'slug' => 'event-espresso',
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return CollectionInterface|BlockInterface[]
-     * @throws CollectionLoaderException
-     * @throws CollectionDetailsException
-     */
-    protected function populateBlockCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-                // collection name
-                'editor_blocks',
-                // collection interface
-                'EventEspresso\core\domain\entities\editor\BlockInterface',
-                // FQCNs for classes to add (all classes within each namespace will be loaded)
-                apply_filters(
-                    'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs',
-                    array('EventEspresso\core\domain\entities\editor\blocks')
-                ),
-                // file paths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            ),
-            $this->blocks
-        );
-        return $loader->getCollection();
-    }
-
-
-    /**
-     * populates the BlockCollection and calls initialize() on all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function initializeBlocks()
-    {
-        try {
-            $this->populateBlockCollection();
-            // cycle thru block loaders and initialize each loader
-            foreach ($this->blocks as $block) {
-                $block->initialize();
-                $this->trackAssetManagersForBlocks($block);
-                if (! $this->block_asset_manager_collection->has($block->assetManager())) {
-                    $this->block_asset_manager_collection->add($block->assetManager());
-                    $block->assetManager()->setAssetHandles();
-                }
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * track blocks with routes that match the current request
-     *
-     * @param BlockInterface $block
-     * @throws InvalidClassException
-     */
-    private function trackAssetManagersForBlocks(BlockInterface $block)
-    {
-        $supported_routes = $block->supportedRoutes();
-        foreach ($supported_routes as $supported_route) {
-            if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
-                $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
-            }
-        }
-    }
-
-
-    /**
-     * returns true if the block should be registered for the current request
-     * else removes block from block_routes array and returns false
-     *
-     * @param BlockInterface $block
-     * @return boolean
-     * @throws InvalidClassException
-     */
-    public function matchesRoute(BlockInterface $block)
-    {
-        if (isset($this->block_asset_managers[ $block->blockType() ])) {
-            return true;
-        }
-        unset($this->block_asset_managers[ $block->blockType() ]);
-        return false;
-    }
-
-
-    /**
-     * calls registerBlock() and load assets for all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function registerBlocks()
-    {
-        try {
-            // cycle thru block loader folders
-            foreach ($this->blocks as $block) {
-                if (! $this->matchesRoute($block)) {
-                    continue;
-                }
-                // perform any setup required for the block
-                $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
-                    throw new InvalidEntityException($block_type, 'WP_Block_Type');
-                }
-                do_action(
-                    'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered',
-                    $block,
-                    $block_type
-                );
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-    public function unloadAssets()
-    {
-        $assets = array_flip($this->block_asset_managers);
-        foreach ($this->block_asset_manager_collection as $asset_manager) {
-            // if there are no longer any blocks that require these assets,
-            if (! isset($assets[ $asset_manager->assetNamespace() ])) {
-                // then unset asset enqueueing and bail
-                remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
-                remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
-                remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
-                remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
-            }
-        }
-    }
+	/**
+	 * @var BlockAssetManagerCollection $block_asset_manager_collection
+	 */
+	protected $block_asset_manager_collection;
+
+	/**
+	 * @var RouteMatchSpecificationManager $route_manager
+	 */
+	protected $route_manager;
+
+	/**
+	 * array for tracking asset managers required by blocks for the current route
+	 *
+	 * @var array $block_asset_managers
+	 */
+	protected $block_asset_managers = array();
+
+
+	/**
+	 * BlockRegistrationManager constructor.
+	 *
+	 * @param BlockAssetManagerCollection    $block_asset_manager_collection
+	 * @param BlockCollection                $blocks
+	 * @param RouteMatchSpecificationManager $route_manager
+	 * @param RequestInterface               $request
+	 */
+	public function __construct(
+		BlockAssetManagerCollection $block_asset_manager_collection,
+		BlockCollection $blocks,
+		RouteMatchSpecificationManager $route_manager,
+		RequestInterface $request
+	) {
+		$this->block_asset_manager_collection = $block_asset_manager_collection;
+		$this->route_manager = $route_manager;
+		parent::__construct($blocks, $request);
+	}
+
+
+	/**
+	 *  Returns the name of a hook point to be used to call initialize()
+	 *
+	 * @return string
+	 */
+	public function initHook()
+	{
+		return 'AHEE__EE_System__initialize';
+	}
+
+
+	/**
+	 * Perform any early setup required for block editors to functions
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize()
+	{
+		$this->initializeBlocks();
+		add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks'));
+		add_action('wp_loaded', array($this, 'unloadAssets'));
+		add_filter('block_categories', array($this, 'addEspressoBlockCategories'));
+	}
+
+
+	/**
+	 * @param array $categories
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	public function addEspressoBlockCategories(array $categories)
+	{
+		return array_merge(
+			$categories,
+			array(
+				array(
+					'slug' => 'event-espresso',
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return CollectionInterface|BlockInterface[]
+	 * @throws CollectionLoaderException
+	 * @throws CollectionDetailsException
+	 */
+	protected function populateBlockCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+				// collection name
+				'editor_blocks',
+				// collection interface
+				'EventEspresso\core\domain\entities\editor\BlockInterface',
+				// FQCNs for classes to add (all classes within each namespace will be loaded)
+				apply_filters(
+					'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs',
+					array('EventEspresso\core\domain\entities\editor\blocks')
+				),
+				// file paths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			),
+			$this->blocks
+		);
+		return $loader->getCollection();
+	}
+
+
+	/**
+	 * populates the BlockCollection and calls initialize() on all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initializeBlocks()
+	{
+		try {
+			$this->populateBlockCollection();
+			// cycle thru block loaders and initialize each loader
+			foreach ($this->blocks as $block) {
+				$block->initialize();
+				$this->trackAssetManagersForBlocks($block);
+				if (! $this->block_asset_manager_collection->has($block->assetManager())) {
+					$this->block_asset_manager_collection->add($block->assetManager());
+					$block->assetManager()->setAssetHandles();
+				}
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * track blocks with routes that match the current request
+	 *
+	 * @param BlockInterface $block
+	 * @throws InvalidClassException
+	 */
+	private function trackAssetManagersForBlocks(BlockInterface $block)
+	{
+		$supported_routes = $block->supportedRoutes();
+		foreach ($supported_routes as $supported_route) {
+			if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
+				$this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if the block should be registered for the current request
+	 * else removes block from block_routes array and returns false
+	 *
+	 * @param BlockInterface $block
+	 * @return boolean
+	 * @throws InvalidClassException
+	 */
+	public function matchesRoute(BlockInterface $block)
+	{
+		if (isset($this->block_asset_managers[ $block->blockType() ])) {
+			return true;
+		}
+		unset($this->block_asset_managers[ $block->blockType() ]);
+		return false;
+	}
+
+
+	/**
+	 * calls registerBlock() and load assets for all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function registerBlocks()
+	{
+		try {
+			// cycle thru block loader folders
+			foreach ($this->blocks as $block) {
+				if (! $this->matchesRoute($block)) {
+					continue;
+				}
+				// perform any setup required for the block
+				$block_type = $block->registerBlock();
+				if (! $block_type instanceof WP_Block_Type) {
+					throw new InvalidEntityException($block_type, 'WP_Block_Type');
+				}
+				do_action(
+					'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered',
+					$block,
+					$block_type
+				);
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+	public function unloadAssets()
+	{
+		$assets = array_flip($this->block_asset_managers);
+		foreach ($this->block_asset_manager_collection as $asset_manager) {
+			// if there are no longer any blocks that require these assets,
+			if (! isset($assets[ $asset_manager->assetNamespace() ])) {
+				// then unset asset enqueueing and bail
+				remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
+				remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
+				remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
+				remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
+			}
+		}
+	}
 }

core/domain/services/pue/Config.php

Indentation +127 added lines, -127 removed lines

@@ -16,131 +16,131 @@
  */
 class Config
 {
-    /**
-     * @var EE_Network_Config
-     */
-    private $network_config;
-
-
-    /**
-     * @var EE_Config
-     */
-    private $ee_config;
-
-
-    public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
-    {
-        $this->network_config = $network_config;
-        $this->ee_config = $ee_config;
-    }
-
-
-    /**
-     * Get the site license key for the site.
-     */
-    public function siteLicenseKey()
-    {
-        return $this->network_config->core->site_license_key;
-    }
-
-
-    public function i18nDomain()
-    {
-        return 'event_espresso';
-    }
-
-
-    public function checkPeriod()
-    {
-        return 24;
-    }
-
-
-    public function optionKey()
-    {
-        return 'ee_site_license_key';
-    }
-
-
-    public function optionsPageSlug()
-    {
-        return 'espresso_general_settings';
-    }
-
-
-    public function hostServerUrl()
-    {
-        return defined('PUE_UPDATES_ENDPOINT')
-            ? PUE_UPDATES_ENDPOINT
-            : 'https://eventespresso.com';
-    }
-
-
-    public function pluginSlug()
-    {
-        // Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
-        //  So it's important that you use a key for the version type that is unique and not found in another key.
-        // For example:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
-        // The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
-        // so doing something like:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
-        // ..WOULD work!
-        return array(
-            'free'       => array('decaf' => 'event-espresso-core-decaf'),
-            'premium'    => array('p' => 'event-espresso-core-reg'),
-            'prerelease' => array('beta' => 'event-espresso-core-pr'),
-        );
-    }
-
-
-    /**
-     * Return whether the site is opted in for UXIP or not.
-     *
-     * @return bool
-     */
-    public function isOptedInForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Return whether the site has been notified about UXIP or not.
-     *
-     * @return bool
-     */
-    public function hasNotifiedForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Set the site opted in for UXIP.
-     */
-    public function setHasOptedInForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    /**
-     * Set the site opted out for UXIP
-     */
-    public function setHasOptedOutForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = false;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    public function setHasNotifiedAboutUxip()
-    {
-        $this->ee_config->core->ee_ueip_has_notified = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
+	/**
+	 * @var EE_Network_Config
+	 */
+	private $network_config;
+
+
+	/**
+	 * @var EE_Config
+	 */
+	private $ee_config;
+
+
+	public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
+	{
+		$this->network_config = $network_config;
+		$this->ee_config = $ee_config;
+	}
+
+
+	/**
+	 * Get the site license key for the site.
+	 */
+	public function siteLicenseKey()
+	{
+		return $this->network_config->core->site_license_key;
+	}
+
+
+	public function i18nDomain()
+	{
+		return 'event_espresso';
+	}
+
+
+	public function checkPeriod()
+	{
+		return 24;
+	}
+
+
+	public function optionKey()
+	{
+		return 'ee_site_license_key';
+	}
+
+
+	public function optionsPageSlug()
+	{
+		return 'espresso_general_settings';
+	}
+
+
+	public function hostServerUrl()
+	{
+		return defined('PUE_UPDATES_ENDPOINT')
+			? PUE_UPDATES_ENDPOINT
+			: 'https://eventespresso.com';
+	}
+
+
+	public function pluginSlug()
+	{
+		// Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
+		//  So it's important that you use a key for the version type that is unique and not found in another key.
+		// For example:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
+		// The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
+		// so doing something like:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
+		// ..WOULD work!
+		return array(
+			'free'       => array('decaf' => 'event-espresso-core-decaf'),
+			'premium'    => array('p' => 'event-espresso-core-reg'),
+			'prerelease' => array('beta' => 'event-espresso-core-pr'),
+		);
+	}
+
+
+	/**
+	 * Return whether the site is opted in for UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function isOptedInForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Return whether the site has been notified about UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function hasNotifiedForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Set the site opted in for UXIP.
+	 */
+	public function setHasOptedInForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	/**
+	 * Set the site opted out for UXIP
+	 */
+	public function setHasOptedOutForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = false;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	public function setHasNotifiedAboutUxip()
+	{
+		$this->ee_config->core->ee_ueip_has_notified = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
 }

core/domain/entities/custom_post_types/CustomTaxonomyDefinitions.php

Indentation +131 added lines, -131 removed lines

@@ -15,145 +15,145 @@
 class CustomTaxonomyDefinitions
 {
 
-    /**
-     * @var array $taxonomies
-     */
-    private $taxonomies;
+	/**
+	 * @var array $taxonomies
+	 */
+	private $taxonomies;
 
 
-    /**
-     * EspressoCustomPostTypeDefinitions constructor.
-     */
-    public function __construct()
-    {
-        $this->setTaxonomies();
-        add_filter('pre_term_description', array($this, 'filterCustomTermDescription'), 1, 2);
-    }
+	/**
+	 * EspressoCustomPostTypeDefinitions constructor.
+	 */
+	public function __construct()
+	{
+		$this->setTaxonomies();
+		add_filter('pre_term_description', array($this, 'filterCustomTermDescription'), 1, 2);
+	}
 
 
-    private function setTaxonomies()
-    {
-        $this->taxonomies = array(
-            'espresso_event_categories' => array(
-                'singular_name' => esc_html__('Event Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => true,
-                    'show_in_rest'      => true,
-                    'capabilities'      => array(
-                        'manage_terms' => 'ee_manage_event_categories',
-                        'edit_terms'   => 'ee_edit_event_category',
-                        'delete_terms' => 'ee_delete_event_category',
-                        'assign_terms' => 'ee_assign_event_category',
-                    ),
-                    'rewrite'           => array(
-                        'slug' => EEH_URL::slugify(
-                            __('event-category', 'event_espresso'),
-                            'event-category'
-                        )
-                    ),
-                ),
-            ),
-            'espresso_venue_categories' => array(
-                'singular_name' => esc_html__('Venue Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => false, // by default this doesn't show for decaf
-                    'show_in_rest'      => true,
-                    'capabilities'      => array(
-                        'manage_terms' => 'ee_manage_venue_categories',
-                        'edit_terms'   => 'ee_edit_venue_category',
-                        'delete_terms' => 'ee_delete_venue_category',
-                        'assign_terms' => 'ee_assign_venue_category',
-                    ),
-                    'rewrite'           => array(
-                        'slug' => EEH_URL::slugify(
-                            __('venue-category', 'event_espresso'),
-                            'venue-category'
-                        )
-                    ),
-                ),
-            ),
-            'espresso_event_type'       => array(
-                'singular_name' => esc_html__('Event Type', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Types', 'event_espresso'),
-                'args'          => array(
-                    'public'       => true,
-                    'show_ui'      => false,
-                    'show_in_rest' => true,
-                    'capabilities' => array(
-                        'manage_terms' => 'ee_read_event_type',
-                        'edit_terms'   => 'ee_edit_event_type',
-                        'delete_terms' => 'ee_delete_event_type',
-                        'assign_terms' => 'ee_assign_event_type',
-                    ),
-                    'rewrite'      => array(
-                        'slug' => EEH_URL::slugify(
-                            __('event-type', 'event_espresso'),
-                            'event-type'
-                        )
-                    ),
-                    'hierarchical' => true,
-                ),
-            ),
-        );
-    }
+	private function setTaxonomies()
+	{
+		$this->taxonomies = array(
+			'espresso_event_categories' => array(
+				'singular_name' => esc_html__('Event Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => true,
+					'show_in_rest'      => true,
+					'capabilities'      => array(
+						'manage_terms' => 'ee_manage_event_categories',
+						'edit_terms'   => 'ee_edit_event_category',
+						'delete_terms' => 'ee_delete_event_category',
+						'assign_terms' => 'ee_assign_event_category',
+					),
+					'rewrite'           => array(
+						'slug' => EEH_URL::slugify(
+							__('event-category', 'event_espresso'),
+							'event-category'
+						)
+					),
+				),
+			),
+			'espresso_venue_categories' => array(
+				'singular_name' => esc_html__('Venue Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => false, // by default this doesn't show for decaf
+					'show_in_rest'      => true,
+					'capabilities'      => array(
+						'manage_terms' => 'ee_manage_venue_categories',
+						'edit_terms'   => 'ee_edit_venue_category',
+						'delete_terms' => 'ee_delete_venue_category',
+						'assign_terms' => 'ee_assign_venue_category',
+					),
+					'rewrite'           => array(
+						'slug' => EEH_URL::slugify(
+							__('venue-category', 'event_espresso'),
+							'venue-category'
+						)
+					),
+				),
+			),
+			'espresso_event_type'       => array(
+				'singular_name' => esc_html__('Event Type', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Types', 'event_espresso'),
+				'args'          => array(
+					'public'       => true,
+					'show_ui'      => false,
+					'show_in_rest' => true,
+					'capabilities' => array(
+						'manage_terms' => 'ee_read_event_type',
+						'edit_terms'   => 'ee_edit_event_type',
+						'delete_terms' => 'ee_delete_event_type',
+						'assign_terms' => 'ee_assign_event_type',
+					),
+					'rewrite'      => array(
+						'slug' => EEH_URL::slugify(
+							__('event-type', 'event_espresso'),
+							'event-type'
+						)
+					),
+					'hierarchical' => true,
+				),
+			),
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getCustomTaxonomyDefinitions()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            // legacy filter applied for now,
-            // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-            apply_filters(
-                'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
-                $this->taxonomies
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function getCustomTaxonomyDefinitions()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			// legacy filter applied for now,
+			// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+			apply_filters(
+				'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
+				$this->taxonomies
+			)
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getCustomTaxonomySlugs()
-    {
-        return array_keys($this->getCustomTaxonomyDefinitions());
-    }
+	/**
+	 * @return array
+	 */
+	public function getCustomTaxonomySlugs()
+	{
+		return array_keys($this->getCustomTaxonomyDefinitions());
+	}
 
 
-    /**
-     * By default, WordPress strips all html from term taxonomy description content.
-     * The purpose of this method is to remove that restriction
-     * and ensure that we still run ee term taxonomy descriptions
-     * through some full html sanitization equivalent to the post content field.
-     * So first we remove default filter for term description
-     * but we have to do this earlier before wp sets their own filter
-     * because they just set a global filter on all term descriptions
-     * before the custom term description filter.
-     * Really sux.
-     *
-     * @param string $description The description content.
-     * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
-     * @return string
-     */
-    public function filterCustomTermDescription($description, $taxonomy)
-    {
-        // get a list of EE taxonomies
-        $custom_taxonomies = $this->getCustomTaxonomySlugs();
-        // only do our own thing if the taxonomy listed is an ee taxonomy.
-        if (in_array($taxonomy, $custom_taxonomies, true)) {
-            // remove default wp filter
-            remove_filter('pre_term_description', 'wp_filter_kses');
-            // sanitize THIS content.
-            $description = wp_kses($description, wp_kses_allowed_html('post'));
-        }
-        return $description;
-    }
+	/**
+	 * By default, WordPress strips all html from term taxonomy description content.
+	 * The purpose of this method is to remove that restriction
+	 * and ensure that we still run ee term taxonomy descriptions
+	 * through some full html sanitization equivalent to the post content field.
+	 * So first we remove default filter for term description
+	 * but we have to do this earlier before wp sets their own filter
+	 * because they just set a global filter on all term descriptions
+	 * before the custom term description filter.
+	 * Really sux.
+	 *
+	 * @param string $description The description content.
+	 * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
+	 * @return string
+	 */
+	public function filterCustomTermDescription($description, $taxonomy)
+	{
+		// get a list of EE taxonomies
+		$custom_taxonomies = $this->getCustomTaxonomySlugs();
+		// only do our own thing if the taxonomy listed is an ee taxonomy.
+		if (in_array($taxonomy, $custom_taxonomies, true)) {
+			// remove default wp filter
+			remove_filter('pre_term_description', 'wp_filter_kses');
+			// sanitize THIS content.
+			$description = wp_kses($description, wp_kses_allowed_html('post'));
+		}
+		return $description;
+	}
 }

core/db_models/fields/EE_Money_Field.php

Indentation +78 added lines, -78 removed lines

@@ -7,92 +7,92 @@
 class EE_Money_Field extends EE_Float_Field
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * Schemas:
-     *    'localized_float': "3,023.00"
-     *    'no_currency_code': "$3,023.00"
-     *    null: "$3,023.00<span>USD</span>"
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	/**
+	 * Schemas:
+	 *    'localized_float': "3,023.00"
+	 *    'no_currency_code': "$3,023.00"
+	 *    null: "$3,023.00<span>USD</span>"
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
 
-        if ($schema == 'localized_float') {
-            return $pretty_float;
-        }
-        if ($schema == 'no_currency_code') {
+		if ($schema == 'localized_float') {
+			return $pretty_float;
+		}
+		if ($schema == 'no_currency_code') {
 //          echo "schema no currency!";
-            $display_code = false;
-        } else {
-            $display_code = true;
-        }
-        // we don't use the $pretty_float because format_currency will take care of it.
-        return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
-    }
+			$display_code = false;
+		} else {
+			$display_code = true;
+		}
+		// we don't use the $pretty_float because format_currency will take care of it.
+		return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
+	}
 
-    /**
-     * If provided with a string, strips out money-related formatting to turn it into a proper float.
-     * Rounds the float to the correct number of decimal places for this country's currency.
-     * Also, interprets periods and commas according to the country's currency settings.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        // remove any currencies etc.
+	/**
+	 * If provided with a string, strips out money-related formatting to turn it into a proper float.
+	 * Rounds the float to the correct number of decimal places for this country's currency.
+	 * Also, interprets periods and commas according to the country's currency settings.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		// remove any currencies etc.
 //      if(is_string($value_inputted_for_field_on_model_object)){
 //          $value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "", $value_inputted_for_field_on_model_object);
 //      }
-        // now it's a float-style string or number
-        $float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        // round to the correctly number of decimal places for this  currency
-        $rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
-        return $rounded_value;
-    }
+		// now it's a float-style string or number
+		$float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		// round to the correctly number of decimal places for this  currency
+		$rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
+		return $rounded_value;
+	}
 
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        $c = EE_Registry::instance()->CFG->currency;
-        return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
-    }
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		$c = EE_Registry::instance()->CFG->currency;
+		return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
+	}
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'number',
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    __('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'format' => 'money'
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'number',
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					__('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'format' => 'money'
+			)
+		);
+	}
 }