eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Queue.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -603,7 +603,7 @@
      * @param EE_Message      $message
      * @param EE_messenger    $messenger
      * @param EE_message_type $message_type
-     * @param                 $test_send
+     * @param                 boolean $test_send
      * @return bool   true means all went well, false means, not so much.
      */
     protected function _do_preview(

Indentation +677 added lines, -677 removed lines

@@ -2,7 +2,7 @@ 
 use \EventEspresso\core\exceptions\SendMessageException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -18,681 +18,681 @@ 
 {
 
 
-    /**
-     * @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;
-
-    /**
-     * Sets the limit of how many messages can be sent per hour.
-     *
-     * @type int
-     */
-    protected $_rate_limit;
-
-    /**
-     * 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->_rate_limit         = $this->get_rate_limit();
-        $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()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_sending) || $this->_rate_limit < 1) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $this->_rate_limit ? $this->_batch_count : $this->_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;
-        }
-
-        //add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $this->add($message);
-            }
-        }
-
-        //send messages  (this also updates the rate limit)
-        $this->execute();
-
-        //release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        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)
-    {
-        set_transient($this->_get_lock_key($type), 1, $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_transient($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 (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 (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.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                get_transient($this->_get_lock_key($type)),
-                $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.
-     *
-     * @return int
-     */
-    public function get_rate_limit()
-    {
-        if ( ! $rate_limit = get_transient($this->_get_rate_limit_key())) {
-            $rate_limit = $this->_default_rate_limit();
-            set_transient($this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key());
-        }
-        return $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.
-     */
-    public 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();
-        $new_limit  = $rate_limit - $batch_completed;
-        //updating the transient option directly to avoid resetting the expiry.
-        update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
-    }
-
-
-    /**
-     * 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 $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;
+
+	/**
+	 * Sets the limit of how many messages can be sent per hour.
+	 *
+	 * @type int
+	 */
+	protected $_rate_limit;
+
+	/**
+	 * 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->_rate_limit         = $this->get_rate_limit();
+		$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()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_sending) || $this->_rate_limit < 1) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $this->_rate_limit ? $this->_batch_count : $this->_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;
+		}
+
+		//add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$this->add($message);
+			}
+		}
+
+		//send messages  (this also updates the rate limit)
+		$this->execute();
+
+		//release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		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)
+	{
+		set_transient($this->_get_lock_key($type), 1, $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_transient($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 (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 (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.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				get_transient($this->_get_lock_key($type)),
+				$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.
+	 *
+	 * @return int
+	 */
+	public function get_rate_limit()
+	{
+		if ( ! $rate_limit = get_transient($this->_get_rate_limit_key())) {
+			$rate_limit = $this->_default_rate_limit();
+			set_transient($this->_get_rate_limit_key(), $rate_limit, $this->_get_rate_limit_key());
+		}
+		return $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.
+	 */
+	public 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();
+		$new_limit  = $rate_limit - $batch_completed;
+		//updating the transient option directly to avoid resetting the expiry.
+		update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
+	}
+
+
+	/**
+	 * 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 $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);
+		}
+	}
 
 } //end EE_Messages_Queue class
\ No newline at end of file

Spacing +12 added lines, -12 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use \EventEspresso\core\exceptions\SendMessageException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -182,7 +182,7 @@ 
             '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) {
             return false; //nothing to generate
@@ -287,7 +287,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -299,7 +299,7 @@ 
      */
     protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+        return (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
     }
 
 
@@ -321,7 +321,7 @@ 
      */
     protected function _get_rate_limit_expiry()
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+        return (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
     }
 
 
@@ -332,7 +332,7 @@ 
      */
     protected function _default_rate_limit()
     {
-        return (int)apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
     }
 
 
@@ -413,7 +413,7 @@ 
         $rate_limit = $this->get_rate_limit();
         $new_limit  = $rate_limit - $batch_completed;
         //updating the transient option directly to avoid resetting the expiry.
-        update_option('_transient_' . $this->_get_rate_limit_key(), $new_limit);
+        update_option('_transient_'.$this->_get_rate_limit_key(), $new_limit);
     }
 
 
@@ -494,7 +494,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;
             }
@@ -504,13 +504,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()
@@ -675,7 +675,7 @@ 
      */
     protected function _set_error_message(EE_Message $message, $error_messages)
     {
-        $error_messages = (array)$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[] = __(
@@ -690,7 +690,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);
         }
     }

core/db_models/EEM_Status.model.php

Spacing +3 added lines, -3 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 /**
@@ -12,7 +12,7 @@ 
  * @ version            4.0
  * ------------------------------------------------------------------------
  */
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 /**
  * Class EEM_Status
@@ -49,7 +49,7 @@ 
                     false,
                     'event',
                     array(
-                        'event'        => __("Event", "event_espresso"),//deprecated
+                        'event'        => __("Event", "event_espresso"), //deprecated
                         'registration' => __("Registration", "event_espresso"),
                         'transaction'  => __("Transaction", "event_espresso"),
                         'payment'      => __("Payment", "event_espresso"),

Indentation +275 added lines, -275 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -25,291 +25,291 @@ 
 class EEM_Status extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = __('Status', 'event_espresso');
-        $this->plural_item      = __('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    __("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => __("Event", "event_espresso"),//deprecated
-                        'registration' => __("Registration", "event_espresso"),
-                        'transaction'  => __("Transaction", "event_espresso"),
-                        'payment'      => __("Payment", "event_espresso"),
-                        'email'        => __("Email", "event_espresso"),
-                        'message'      => __("Message", "event_espresso"),
-                    )),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = __('Status', 'event_espresso');
+		$this->plural_item      = __('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => __("Event", "event_espresso"),//deprecated
+						'registration' => __("Registration", "event_espresso"),
+						'transaction'  => __("Transaction", "event_espresso"),
+						'payment'      => __("Payment", "event_espresso"),
+						'email'        => __("Email", "event_espresso"),
+						'message'      => __("Message", "event_espresso"),
+					)),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        //note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                __('pending payment', 'event_espresso'), //singular
-                __('pending payments', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                __('approved', 'event_espresso'), //singular
-                __('approved', 'event_espresso') //plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                __('not approved', 'event_espresso'),
-                __('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                __('wait list', 'event_espresso'),
-                __('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                __('overpaid', 'event_espresso'),
-                __('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                __('complete', 'event_espresso'),
-                __('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                __('abandoned', 'event_espresso'),
-                __('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                __('accepted', 'event_espresso'),
-                __('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            //following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                __('postponed', 'event_espresso'),
-                __('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                __('archived', 'event_espresso'),
-                __('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                __('on sale', 'event_espresso'),
-                __('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                __('inactive', 'event_espresso'),
-                __('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                __('active', 'event_espresso'),
-                __('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                __('postponed', 'event_espresso'),
-                __('postponed', 'event_espresso'),
-            ),
-            //messages related
-            EEM_Message::status_sent                    => array(
-                __('sent', 'event_espresso'),
-                __('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                __('queued for sending', 'event_espresso'),
-                __('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                __('debug only', 'event_espresso'),
-                __('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                __('messenger is executing', 'event_espresso'),
-                __('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                __('queued for resending', 'event_espresso'),
-                __('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                __('queued for generating', 'event_espresso'),
-                __('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                __('failed sending, can be retried', 'event_espresso'),
-                __('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                __('published', 'event_espresso'),
-                __('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                __('scheduled', 'event_espresso'),
-                __('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                __('draft', 'event_espresso'),
-                __('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                __('private', 'event_espresso'),
-                __('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                __('trashed', 'event_espresso'),
-                __('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		//note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				__('pending payment', 'event_espresso'), //singular
+				__('pending payments', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				__('approved', 'event_espresso'), //singular
+				__('approved', 'event_espresso') //plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				__('not approved', 'event_espresso'),
+				__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				__('wait list', 'event_espresso'),
+				__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				__('overpaid', 'event_espresso'),
+				__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				__('complete', 'event_espresso'),
+				__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				__('abandoned', 'event_espresso'),
+				__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				__('accepted', 'event_espresso'),
+				__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			//following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				__('postponed', 'event_espresso'),
+				__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				__('archived', 'event_espresso'),
+				__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				__('on sale', 'event_espresso'),
+				__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				__('inactive', 'event_espresso'),
+				__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				__('active', 'event_espresso'),
+				__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				__('postponed', 'event_espresso'),
+				__('postponed', 'event_espresso'),
+			),
+			//messages related
+			EEM_Message::status_sent                    => array(
+				__('sent', 'event_espresso'),
+				__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				__('queued for sending', 'event_espresso'),
+				__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				__('debug only', 'event_espresso'),
+				__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				__('messenger is executing', 'event_espresso'),
+				__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				__('queued for resending', 'event_espresso'),
+				__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				__('queued for generating', 'event_espresso'),
+				__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				__('failed sending, can be retried', 'event_espresso'),
+				__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				__('published', 'event_espresso'),
+				__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				__('scheduled', 'event_espresso'),
+				__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				__('draft', 'event_espresso'),
+				__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				__('private', 'event_espresso'),
+				__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				__('trashed', 'event_espresso'),
+				__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if ( ! is_array($statuses)) {
-            throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'));
-        }
+		if ( ! is_array($statuses)) {
+			throw new EE_Error(__('The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[$id])) {
-                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
-            } else {
-                $translation[$id] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[$id])) {
+				$translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
+			} else {
+				$translation[$id] = $code;
+			}
 
-            //schema
-            switch ($schema) {
-                case 'lower' :
-                    $translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence' :
-                    $translation[$id] = ucwords($translation[$id]);
-                    break;
-                case 'upper' :
-                    $translation[$id] = strtoupper($translation[$id]);
-                    break;
-            }
-        }
+			//schema
+			switch ($schema) {
+				case 'lower' :
+					$translation[$id] = strtolower($translation[$id]); //even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence' :
+					$translation[$id] = ucwords($translation[$id]);
+					break;
+				case 'upper' :
+					$translation[$id] = strtoupper($translation[$id]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 
 
 }

core/db_models/EEM_Message.model.php

Spacing +3 added lines, -3 removed lines

@@ -119,7 +119,7 @@ 
             self::priority_low    => __('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field('MSG_token',
@@ -347,7 +347,7 @@ 
                         );
                         break;
                     default :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_' . $request_key][$model_name . '.' . $request_key] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -410,7 +410,7 @@ 
             //prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
                 $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[$label_parts_index_to_prepend] = 'and' . $label_parts[$label_parts_index_to_prepend];
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(

Indentation +472 added lines, -472 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,481 +12,481 @@ 
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
 
-    // private instance of the Message object
-    protected static $_instance = null;
+	// private instance of the Message object
+	protected static $_instance = null;
 
 
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
 
 
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @return EEM_Message
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message', 'event_espresso');
-        $this->plural_item   = __('Messages', 'event_espresso');
-
-        //used for token generator
-        EE_Registry::instance()->load_helper('URL');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => __('high', 'event_espresso'),
-            self::priority_medium => __('medium', 'event_espresso'),
-            self::priority_low    => __('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field('MSG_token',
-                    __('Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'), false, EEH_URL::generate_unique_token()),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field('GRP_ID',
-                    __('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'), true, 0,
-                    'Message_Template_Group'),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field('TXN_ID',
-                    __('Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'), true, 0, 'Transaction'),
-                'MSG_messenger'      => new EE_Plain_Text_Field('MSG_messenger',
-                    __('Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'), false, 'email'),
-                'MSG_message_type'   => new EE_Plain_Text_Field('MSG_message_type',
-                    __('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false, 'receipt'),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field('MSG_recipient_ID',
-                    __('Recipient ID', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field('MSG_recipient_type',
-                    __('Recipient Type', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field('MSG_content',
-                    __('Content', 'event_espresso'), true, ''),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field('MSG_to', __('Address To', 'event_espresso'),
-                    true),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field('MSG_from',
-                    __('Address From', 'event_espresso'), true),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field('MSG_subject',
-                    __('Subject', 'event_espresso'), true, ''),
-                'MSG_priority'       => new EE_Enum_Integer_Field('MSG_priority', __('Priority', 'event_espresso'),
-                    false, self::priority_low, $allowed_priority),
-                'STS_ID'             => new EE_Foreign_Key_String_Field('STS_ID', __('Status', 'event_espresso'), false,
-                    self::status_incomplete, 'Status'),
-                'MSG_created'        => new EE_Datetime_Field('MSG_created', __('Created', 'event_espresso'), false,
-                    EE_Datetime_Field::now),
-                'MSG_modified'       => new EE_Datetime_Field('MSG_modified', __('Modified', 'event_espresso'), true,
-                    EE_Datetime_Field::now),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return \EE_Message
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return \EE_Message
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend));
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        //if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = EE_Registry::instance()->REQ->get($request_key);
-            if ($request_value) {
-                //special case
-                switch ($request_key) {
-                    case '_REG_ID' :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID' :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default :
-                        $query_params[0]['AND**filter_by']['OR**filter_by_' . $request_key][$model_name . '.' . $request_key] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_pretty_label_for_results()
-    {
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model = EE_Registry::instance()->load_model($model_name);
-            if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
-                switch ($request_key) {
-                    case '_REG_ID' :
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID' :
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID' :
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID' :
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID' :
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-
-            //prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[$label_parts_index_to_prepend] = 'and' . $label_parts[$label_parts_index_to_prepend];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        //initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if ( ! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        //return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @return EEM_Message
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message', 'event_espresso');
+		$this->plural_item   = __('Messages', 'event_espresso');
+
+		//used for token generator
+		EE_Registry::instance()->load_helper('URL');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => __('high', 'event_espresso'),
+			self::priority_medium => __('medium', 'event_espresso'),
+			self::priority_low    => __('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field('MSG_token',
+					__('Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'), false, EEH_URL::generate_unique_token()),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field('GRP_ID',
+					__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'), true, 0,
+					'Message_Template_Group'),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field('TXN_ID',
+					__('Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'), true, 0, 'Transaction'),
+				'MSG_messenger'      => new EE_Plain_Text_Field('MSG_messenger',
+					__('Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'), false, 'email'),
+				'MSG_message_type'   => new EE_Plain_Text_Field('MSG_message_type',
+					__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false, 'receipt'),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field('MSG_recipient_ID',
+					__('Recipient ID', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field('MSG_recipient_type',
+					__('Recipient Type', 'event_espresso'), true, null, array('Registration', 'Attendee', 'WP_User')),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field('MSG_content',
+					__('Content', 'event_espresso'), true, ''),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field('MSG_to', __('Address To', 'event_espresso'),
+					true),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field('MSG_from',
+					__('Address From', 'event_espresso'), true),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field('MSG_subject',
+					__('Subject', 'event_espresso'), true, ''),
+				'MSG_priority'       => new EE_Enum_Integer_Field('MSG_priority', __('Priority', 'event_espresso'),
+					false, self::priority_low, $allowed_priority),
+				'STS_ID'             => new EE_Foreign_Key_String_Field('STS_ID', __('Status', 'event_espresso'), false,
+					self::status_incomplete, 'Status'),
+				'MSG_created'        => new EE_Datetime_Field('MSG_created', __('Created', 'event_espresso'), false,
+					EE_Datetime_Field::now),
+				'MSG_modified'       => new EE_Datetime_Field('MSG_modified', __('Modified', 'event_espresso'), true,
+					EE_Datetime_Field::now),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return \EE_Message
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return \EE_Message
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		//if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = EE_Registry::instance()->REQ->get($request_key);
+			if ($request_value) {
+				//special case
+				switch ($request_key) {
+					case '_REG_ID' :
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID' :
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default :
+						$query_params[0]['AND**filter_by']['OR**filter_by_' . $request_key][$model_name . '.' . $request_key] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_pretty_label_for_results()
+	{
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model = EE_Registry::instance()->load_model($model_name);
+			if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
+				switch ($request_key) {
+					case '_REG_ID' :
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID' :
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID' :
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID' :
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID' :
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+
+			//prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[$label_parts_index_to_prepend] = 'and' . $label_parts[$label_parts_index_to_prepend];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		//initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if ( ! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		//return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
 
 
 }

admin_pages/messages/EE_Message_List_Table.class.php

Indentation +427 added lines, -427 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -15,430 +15,430 @@ 
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_get_messages($this->_per_page, $this->_view);
-        $this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('Message', 'event_espresso'),
-            'plural'   => __('Messages', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'           => '<input type="checkbox" />',
-            'to'           => __('To', 'event_espresso'),
-            'from'         => __('From', 'event_espresso'),
-            'messenger'    => __('Messenger', 'event_espresso'),
-            'message_type' => __('Message Type', 'event_espresso'),
-            'context'      => __('Context', 'event_espresso'),
-            'modified'     => __('Modified', 'event_espresso'),
-            'action'       => __('Actions', 'event_espresso'),
-            'msg_id'       => __('ID', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'modified'     => array('MSG_modified' => true),
-            'message_type' => array('MSG_message_type' => false),
-            'messenger'    => array('MSG_messenger' => false),
-            'to'           => array('MSG_to' => false),
-            'from'         => array('MSG_from' => false),
-            'context'      => array('MSG_context' => false),
-            'msg_id'       => array('MSG_ID', false),
-        );
-
-        $this->_primary_column = 'to';
-
-        $this->_hidden_columns = array(
-            'msg_id',
-        );
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        //get select_inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-            $this->_get_contexts_for_message_types_dropdown_filter(),
-        );
-
-        //set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
-        }
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   checkbox
-     * @throws \EE_Error
-     */
-    public function column_cb($message)
-    {
-        return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_msg_id(EE_Message $message)
-    {
-        return $message->ID();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The recipient of the message
-     * @throws \EE_Error
-     */
-    public function column_to(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('URL');
-        $actions           = array();
-        $actions['delete'] = '<a href="'
-                             . EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_messages',
-                    'action' => 'delete_ee_message',
-                    'MSG_ID' => $message->ID(),
-                ),
-                admin_url('admin.php')
-            )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   The sender of the message
-     */
-    public function column_from(EE_Message $message)
-    {
-        return esc_html($message->from());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The messenger used to send the message.
-     */
-    public function column_messenger(EE_Message $message)
-    {
-        return ucwords($message->messenger_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The message type used to generate the message.
-     */
-    public function column_message_type(EE_Message $message)
-    {
-        return ucwords($message->message_type_label());
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string  The context the message was generated for.
-     */
-    public function column_context(EE_Message $message)
-    {
-        return $message->context_label();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string    The timestamp when this message was last modified.
-     */
-    public function column_modified(EE_Message $message)
-    {
-        return $message->modified();
-    }
-
-
-    /**
-     * @param EE_Message $message
-     * @return string   Actions that can be done on the current message.
-     */
-    public function column_action(EE_Message $message)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $action_links = array(
-            'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
-            'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
-            'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
-            'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
-            'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
-            'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
-        );
-        $content      = '';
-        switch ($message->STS_ID()) {
-            case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
-                break;
-            case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
-                break;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Retrieve the EE_Message objects for the list table.
-     *
-     * @param int    $perpage The number of items per page
-     * @param string $view    The view items are being retrieved for
-     * @param bool   $count   Whether to just return a count or not.
-     * @param bool   $all     Disregard any paging info (no limit on data returned).
-     * @return int|EE_Message[]
-     * @throws \EE_Error
-     */
-    protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
-    {
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $perpage;
-
-        $offset       = ($current_page - 1) * $per_page;
-        $limit        = $all || $count ? null : array($offset, $per_page);
-        $query_params = array(
-            'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
-            'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
-            'limit'    => $limit,
-        );
-
-        /**
-         * Any filters coming in from other routes?
-         */
-        if (isset($this->_req_data['filterby'])) {
-            $query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
-            if ( ! $count) {
-                $query_params['group_by'] = 'MSG_ID';
-            }
-        }
-
-        //view conditionals
-        if ($view !== 'all' && $count && $all) {
-            $query_params[0]['AND*view_conditional'] = array(
-                'STS_ID' => strtoupper($view),
-            );
-        }
-
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
-            $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
-                ? array(
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
-                    )
-                )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
-        }
-
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
-            $query_params[0]['OR'] = array(
-                'MSG_to'      => array('LIKE', $search_string),
-                'MSG_from'    => array('LIKE', $search_string),
-                'MSG_subject' => array('LIKE', $search_string),
-                'MSG_content' => array('LIKE', $search_string),
-            );
-        }
-
-        //account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
-        //the messages system is in debug mode.
-        //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
-        //messages in the database.
-        if (! EEM_Message::debug()) {
-            $query_params[0]['AND*debug_only_conditional'] = array(
-                'STS_ID' => array('!=', EEM_Message::status_debug_only),
-            );
-        }
-
-        //account for filters
-        if (! $all
-            && isset($this->_req_data['ee_messenger_filter_by'])
-            && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*messenger_filter'] = array(
-                'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
-            );
-        }
-        if (! $all
-            && ! empty($this->_req_data['ee_message_type_filter_by'])
-            && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*message_type_filter'] = array(
-                'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
-            );
-        }
-
-        if (! $all
-            && ! empty($this->_req_data['ee_context_filter_by'])
-            && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
-        ) {
-            $query_params[0]['AND*context_filter'] = array(
-                'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
-            );
-        }
-
-        return $count
-            /** @type int */
-            ? EEM_Message::instance()->count($query_params, null, true)
-            /** @type EE_Message[] */
-            : EEM_Message::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers.
-     *
-     * @return string
-     */
-    protected function _get_messengers_dropdown_filter()
-    {
-        $messenger_options                    = array();
-        $active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-
-        //setup array of messenger options
-        foreach ($active_messages_grouped_by_messenger as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @return string
-     */
-    protected function _get_message_types_dropdown_filter()
-    {
-        $message_type_options                    = array();
-        $active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-
-        //setup array of message type options
-        foreach ($active_messages_grouped_by_message_type as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message type contexts
-     *
-     * @return string
-     */
-    protected function _get_contexts_for_message_types_dropdown_filter()
-    {
-        $context_options                    = array();
-        $active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-
-        //setup array of context options
-        foreach ($active_messages_grouped_by_context as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    foreach ($message_type->get_contexts() as $context => $context_details) {
-                        if (isset($context_details['label'])) {
-                            $context_options[$context] = $context_details['label'];
-                        }
-                    }
-                }
-            }
-        }
-        return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_get_messages($this->_per_page, $this->_view);
+		$this->_all_data_count = $this->_get_messages($this->_per_page, $this->_view, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('Message', 'event_espresso'),
+			'plural'   => __('Messages', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'           => '<input type="checkbox" />',
+			'to'           => __('To', 'event_espresso'),
+			'from'         => __('From', 'event_espresso'),
+			'messenger'    => __('Messenger', 'event_espresso'),
+			'message_type' => __('Message Type', 'event_espresso'),
+			'context'      => __('Context', 'event_espresso'),
+			'modified'     => __('Modified', 'event_espresso'),
+			'action'       => __('Actions', 'event_espresso'),
+			'msg_id'       => __('ID', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'modified'     => array('MSG_modified' => true),
+			'message_type' => array('MSG_message_type' => false),
+			'messenger'    => array('MSG_messenger' => false),
+			'to'           => array('MSG_to' => false),
+			'from'         => array('MSG_from' => false),
+			'context'      => array('MSG_context' => false),
+			'msg_id'       => array('MSG_ID', false),
+		);
+
+		$this->_primary_column = 'to';
+
+		$this->_hidden_columns = array(
+			'msg_id',
+		);
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		//get select_inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+			$this->_get_contexts_for_message_types_dropdown_filter(),
+		);
+
+		//set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[$view]['count'] = $this->_get_messages($this->_per_page, $view, true, true);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   checkbox
+	 * @throws \EE_Error
+	 */
+	public function column_cb($message)
+	{
+		return sprintf('<input type="checkbox" name="MSG_ID[%s]" value="1" />', $message->ID());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_msg_id(EE_Message $message)
+	{
+		return $message->ID();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The recipient of the message
+	 * @throws \EE_Error
+	 */
+	public function column_to(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('URL');
+		$actions           = array();
+		$actions['delete'] = '<a href="'
+							 . EEH_URL::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_messages',
+					'action' => 'delete_ee_message',
+					'MSG_ID' => $message->ID(),
+				),
+				admin_url('admin.php')
+			)
+							 . '">' . __('Delete', 'event_espresso') . '</a>';
+		return esc_html($message->to()) . $this->row_actions($actions);
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   The sender of the message
+	 */
+	public function column_from(EE_Message $message)
+	{
+		return esc_html($message->from());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The messenger used to send the message.
+	 */
+	public function column_messenger(EE_Message $message)
+	{
+		return ucwords($message->messenger_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The message type used to generate the message.
+	 */
+	public function column_message_type(EE_Message $message)
+	{
+		return ucwords($message->message_type_label());
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string  The context the message was generated for.
+	 */
+	public function column_context(EE_Message $message)
+	{
+		return $message->context_label();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string    The timestamp when this message was last modified.
+	 */
+	public function column_modified(EE_Message $message)
+	{
+		return $message->modified();
+	}
+
+
+	/**
+	 * @param EE_Message $message
+	 * @return string   Actions that can be done on the current message.
+	 */
+	public function column_action(EE_Message $message)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$action_links = array(
+			'view'                => EEH_MSG_Template::get_message_action_link('view', $message),
+			'error'               => EEH_MSG_Template::get_message_action_link('error', $message),
+			'generate_now'        => EEH_MSG_Template::get_message_action_link('generate_now', $message),
+			'send_now'            => EEH_MSG_Template::get_message_action_link('send_now', $message),
+			'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
+			'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
+		);
+		$content      = '';
+		switch ($message->STS_ID()) {
+			case EEM_Message::status_sent :
+				$content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_resend :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_retry :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				$content = $action_links['error'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_idle :
+				$content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+				break;
+			case EEM_Message::status_incomplete;
+				$content = $action_links['generate_now'] . $action_links['view_transaction'];
+				break;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Retrieve the EE_Message objects for the list table.
+	 *
+	 * @param int    $perpage The number of items per page
+	 * @param string $view    The view items are being retrieved for
+	 * @param bool   $count   Whether to just return a count or not.
+	 * @param bool   $all     Disregard any paging info (no limit on data returned).
+	 * @return int|EE_Message[]
+	 * @throws \EE_Error
+	 */
+	protected function _get_messages($perpage = 10, $view = 'all', $count = false, $all = false)
+	{
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $perpage;
+
+		$offset       = ($current_page - 1) * $per_page;
+		$limit        = $all || $count ? null : array($offset, $per_page);
+		$query_params = array(
+			'order_by' => empty($this->_req_data['orderby']) ? 'MSG_modified' : $this->_req_data['orderby'],
+			'order'    => empty($this->_req_data['order']) ? 'DESC' : $this->_req_data['order'],
+			'limit'    => $limit,
+		);
+
+		/**
+		 * Any filters coming in from other routes?
+		 */
+		if (isset($this->_req_data['filterby'])) {
+			$query_params = array_merge($query_params, EEM_Message::instance()->filter_by_query_params());
+			if ( ! $count) {
+				$query_params['group_by'] = 'MSG_ID';
+			}
+		}
+
+		//view conditionals
+		if ($view !== 'all' && $count && $all) {
+			$query_params[0]['AND*view_conditional'] = array(
+				'STS_ID' => strtoupper($view),
+			);
+		}
+
+		if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+			$query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
+				? array(
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
+					)
+				)
+				: array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+		}
+
+		if (! $all && ! empty($this->_req_data['s'])) {
+			$search_string         = '%' . $this->_req_data['s'] . '%';
+			$query_params[0]['OR'] = array(
+				'MSG_to'      => array('LIKE', $search_string),
+				'MSG_from'    => array('LIKE', $search_string),
+				'MSG_subject' => array('LIKE', $search_string),
+				'MSG_content' => array('LIKE', $search_string),
+			);
+		}
+
+		//account for debug only status.  We don't show Messages with the EEM_Message::status_debug_only to clients when
+		//the messages system is in debug mode.
+		//Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
+		//messages in the database.
+		if (! EEM_Message::debug()) {
+			$query_params[0]['AND*debug_only_conditional'] = array(
+				'STS_ID' => array('!=', EEM_Message::status_debug_only),
+			);
+		}
+
+		//account for filters
+		if (! $all
+			&& isset($this->_req_data['ee_messenger_filter_by'])
+			&& $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*messenger_filter'] = array(
+				'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
+			);
+		}
+		if (! $all
+			&& ! empty($this->_req_data['ee_message_type_filter_by'])
+			&& $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*message_type_filter'] = array(
+				'MSG_message_type' => $this->_req_data['ee_message_type_filter_by'],
+			);
+		}
+
+		if (! $all
+			&& ! empty($this->_req_data['ee_context_filter_by'])
+			&& $this->_req_data['ee_context_filter_by'] !== 'none_selected'
+		) {
+			$query_params[0]['AND*context_filter'] = array(
+				'MSG_context' => array('IN', explode(',', $this->_req_data['ee_context_filter_by'])),
+			);
+		}
+
+		return $count
+			/** @type int */
+			? EEM_Message::instance()->count($query_params, null, true)
+			/** @type EE_Message[] */
+			: EEM_Message::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers.
+	 *
+	 * @return string
+	 */
+	protected function _get_messengers_dropdown_filter()
+	{
+		$messenger_options                    = array();
+		$active_messages_grouped_by_messenger = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+
+		//setup array of messenger options
+		foreach ($active_messages_grouped_by_messenger as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$messenger_options[$active_message->messenger()] = ucwords($active_message->messenger_label());
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @return string
+	 */
+	protected function _get_message_types_dropdown_filter()
+	{
+		$message_type_options                    = array();
+		$active_messages_grouped_by_message_type = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+
+		//setup array of message type options
+		foreach ($active_messages_grouped_by_message_type as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type_options[$active_message->message_type()] = ucwords($active_message->message_type_label());
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message type contexts
+	 *
+	 * @return string
+	 */
+	protected function _get_contexts_for_message_types_dropdown_filter()
+	{
+		$context_options                    = array();
+		$active_messages_grouped_by_context = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+
+		//setup array of context options
+		foreach ($active_messages_grouped_by_context as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					foreach ($message_type->get_contexts() as $context => $context_details) {
+						if (isset($context_details['label'])) {
+							$context_options[$context] = $context_details['label'];
+						}
+					}
+				}
+			}
+		}
+		return $this->get_admin_page()->get_contexts_for_message_types_select_input($context_options);
+	}
 } //end EE_Message_List_Table class
\ No newline at end of file

Spacing +19 added lines, -19 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -81,7 +81,7 @@ 
     {
         $class = parent::_get_row_class($item);
         //add status class
-        $class .= ' ee-status-strip msg-status-' . $item->STS_ID();
+        $class .= ' ee-status-strip msg-status-'.$item->STS_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -168,8 +168,8 @@ 
                 ),
                 admin_url('admin.php')
             )
-                             . '">' . __('Delete', 'event_espresso') . '</a>';
-        return esc_html($message->to()) . $this->row_actions($actions);
+                             . '">'.__('Delete', 'event_espresso').'</a>';
+        return esc_html($message->to()).$this->row_actions($actions);
     }
 
 
@@ -238,26 +238,26 @@ 
             'queue_for_resending' => EEH_MSG_Template::get_message_action_link('queue_for_resending', $message),
             'view_transaction'    => EEH_MSG_Template::get_message_action_link('view_transaction', $message),
         );
-        $content      = '';
+        $content = '';
         switch ($message->STS_ID()) {
             case EEM_Message::status_sent :
-                $content = $action_links['view'] . $action_links['queue_for_resending'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['queue_for_resending'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_resend :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_retry :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_failed :
             case EEM_Message::status_debug_only :
-                $content = $action_links['error'] . $action_links['view_transaction'];
+                $content = $action_links['error'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_idle :
-                $content = $action_links['view'] . $action_links['send_now'] . $action_links['view_transaction'];
+                $content = $action_links['view'].$action_links['send_now'].$action_links['view_transaction'];
                 break;
             case EEM_Message::status_incomplete;
-                $content = $action_links['generate_now'] . $action_links['view_transaction'];
+                $content = $action_links['generate_now'].$action_links['view_transaction'];
                 break;
         }
         return $content;
@@ -310,7 +310,7 @@ 
             );
         }
 
-        if (! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
+        if ( ! $all && ! empty($this->_req_data['status']) && $this->_req_data['status'] !== 'all') {
             $query_params[0]['AND*view_conditional'] = $this->_req_data === EEM_Message::status_failed
                 ? array(
                     'STS_ID' => array(
@@ -318,11 +318,11 @@ 
                         array(EEM_Message::status_failed, EEM_Message::status_messenger_executing)
                     )
                 )
-                : array( 'STS_ID' => strtoupper($this->_req_data['status']) );
+                : array('STS_ID' => strtoupper($this->_req_data['status']));
         }
 
-        if (! $all && ! empty($this->_req_data['s'])) {
-            $search_string         = '%' . $this->_req_data['s'] . '%';
+        if ( ! $all && ! empty($this->_req_data['s'])) {
+            $search_string         = '%'.$this->_req_data['s'].'%';
             $query_params[0]['OR'] = array(
                 'MSG_to'      => array('LIKE', $search_string),
                 'MSG_from'    => array('LIKE', $search_string),
@@ -335,14 +335,14 @@ 
         //the messages system is in debug mode.
         //Note: for backward compat with previous iterations, this is necessary because there may be EEM_Message::status_debug_only
         //messages in the database.
-        if (! EEM_Message::debug()) {
+        if ( ! EEM_Message::debug()) {
             $query_params[0]['AND*debug_only_conditional'] = array(
                 'STS_ID' => array('!=', EEM_Message::status_debug_only),
             );
         }
 
         //account for filters
-        if (! $all
+        if ( ! $all
             && isset($this->_req_data['ee_messenger_filter_by'])
             && $this->_req_data['ee_messenger_filter_by'] !== 'none_selected'
         ) {
@@ -350,7 +350,7 @@ 
                 'MSG_messenger' => $this->_req_data['ee_messenger_filter_by'],
             );
         }
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_message_type_filter_by'])
             && $this->_req_data['ee_message_type_filter_by'] !== 'none_selected'
         ) {
@@ -359,7 +359,7 @@ 
             );
         }
 
-        if (! $all
+        if ( ! $all
             && ! empty($this->_req_data['ee_context_filter_by'])
             && $this->_req_data['ee_context_filter_by'] !== 'none_selected'
         ) {

core/libraries/messages/EE_Message_Repository.lib.php

Spacing +4 added lines, -4 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -38,7 +38,7 @@ 
     {
         $attached = parent::add($message);
         //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
+        $info = $info === null ? $info = array() : (array) $info;
         $data = $this->_init_data($info, $attached, $message);
         if ($attached) {
             $this->set_info($message, $data);
@@ -103,10 +103,10 @@ 
     {
         $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
 
-        if (! $do_hooks_only) {
+        if ( ! $do_hooks_only) {
             $this->rewind();
             //exit early if there is nothing to save.
-            if (! $this->count() > 0) {
+            if ( ! $this->count() > 0) {
                 return $save_tracking;
             }
 

Indentation +251 added lines, -251 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,256 +16,256 @@ 
 {
 
 
-    /**
-     *    EE_Message_Repository constructor
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message';
-        parent::__construct();
-    }
-
-
-    /**
-     * Add the EE_Message to the repository.
-     * This also ensures that the MSG_token is saves as a part of the info for retrieval.
-     *
-     * @param EE_Message $message
-     * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
-     * @return bool
-     */
-    public function add($message, $info = null)
-    {
-        $attached = parent::add($message);
-        //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
-        $data = $this->_init_data($info, $attached, $message);
-        if ($attached) {
-            $this->set_info($message, $data);
-        }
-        return $attached;
-    }
-
-
-    /**
-     * Initializes the data from the incoming info.
-     *
-     * @param array      $info     incoming data.
-     * @param bool       $attached Indicates whether the object was attached successfully.
-     * @param EE_Message $message
-     * @return array
-     */
-    protected function _init_data($info, $attached, $message)
-    {
-        $data = array(
-            'test_send'               => false,
-            'preview'                 => false,
-            'data_handler_class_name' => '',
-            'data'                    => array(
-                'MSG_generation_data' => array(),
-            ),
-        );
-        if (isset($info['preview'])) {
-            $data['preview'] = $info['preview'];
-            unset($info['preview']);
-        }
-        if (isset($info['test_send'])) {
-            $data['test_send'] = $info['test_send'];
-            unset($info['test_send']);
-        }
-        if (isset($info['data_handler_class_name'])) {
-            $data['data_handler_class_name'] = $info['data_handler_class_name'];
-            unset($info['data_handler_class_name']);
-        }
-        if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
-            $generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
-            //if data isn't in $info...let's see if its available via the message object
-            $generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
-            //still empty then let's just use info
-            $generation_data                     = ! $generation_data ? $info : $generation_data;
-            $data['data']['MSG_generation_data'] = $generation_data;
-        }
-        return $data;
-    }
-
-
-    /**
-     * Save all EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
-     * @return array array(
-     *                  'updated' => 0, //count of how many messages updated
-     *                  'notupdated' => 0, //count of how many messages not updated.
-     *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
-     *                  )
-     */
-    public function saveAll($do_hooks_only = false)
-    {
-        $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
-
-        if (! $do_hooks_only) {
-            $this->rewind();
-            //exit early if there is nothing to save.
-            if (! $this->count() > 0) {
-                return $save_tracking;
-            }
-
-            while ($this->valid()) {
-                $saved = $this->current()->save();
-                if ($saved === false) {
-                    $save_tracking['errors'][] = $this->current()->MSG_token();
-                } elseif ($saved) {
-                    $save_tracking['updated']++;
-                } else {
-                    $save_tracking['notupdated']++;
-                }
-                //maybe persist generation data if this is an incomplete EE_Message.
-                $this->_maybe_persist_attached_data();
-
-                $this->next();
-            }
-        }
-        do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
-        return $save_tracking;
-    }
-
-
-    /**
-     * Retrieves a EE_Message from the repository that matches the given token.
-     *
-     * @param string $token Token.
-     * @return EE_Message | null
-     */
-    public function getMessageByToken($token)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->MSG_token() === $token) {
-                $message = $this->current();
-                $this->rewind();
-                return $message;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
-     *
-     * @return array();
-     */
-    public function get_generation_data()
-    {
-        //first verify we're at a valid iterator point.
-        if ( ! $this->valid()) {
-            return array();
-        }
-        $info = $this->getInfo();
-        return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-    }
-
-
-    /**
-     * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
-     *
-     * @return string
-     */
-    public function get_data_handler()
-    {
-        if ( ! $this->valid()) {
-            return '';
-        }
-        $info = $this->getInfo();
-        return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-    }
-
-
-    /**
-     * Returns whether this EE_Message is for a preview or not.
-     *
-     * @return bool
-     */
-    public function is_preview()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['preview'];
-    }
-
-
-    /**
-     * Returns whether the current message pointed to is for a test send.
-     *
-     * @return bool
-     */
-    public function is_test_send()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['test_send'];
-    }
-
-
-    /**
-     *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
-     *  data is attached for later retrieval (batch generation).
-     */
-    protected function _maybe_persist_attached_data()
-    {
-        if ( ! $this->valid()) {
-            return;
-        }
-
-        $info                    = $this->getInfo();
-        $data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-        $data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-        if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
-            $this->current()->set_generation_data($data);
-            $this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
-        }
-    }
-
-
-    /**
-     * This method returns a count of messages in the repository that have a given priority.
-     *
-     * @param int   $priority the priority that is being filtered for the count.
-     * @param array $status   the optional status(es) that will also be filtered by when priority matches.
-     * @return int  count of messages in the queue matching the conditions.
-     */
-    public function count_by_priority_and_status($priority, $status = array())
-    {
-        if ( ! empty($status)) {
-            $status = is_array($status) ? $status : array($status);
-        }
-
-        $count = 0;
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
-                            $status)) || ! $status)
-            ) {
-                $count++;
-            }
-            $this->next();
-        }
-        return $count;
-    }
-
-
-    /**
-     * @return EE_Message
-     */
-    public function current()
-    {
-        return parent::current();
-    }
+	/**
+	 *    EE_Message_Repository constructor
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message';
+		parent::__construct();
+	}
+
+
+	/**
+	 * Add the EE_Message to the repository.
+	 * This also ensures that the MSG_token is saves as a part of the info for retrieval.
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
+	 * @return bool
+	 */
+	public function add($message, $info = null)
+	{
+		$attached = parent::add($message);
+		//ensure $info is an array if not already
+		$info = $info === null ? $info = array() : (array)$info;
+		$data = $this->_init_data($info, $attached, $message);
+		if ($attached) {
+			$this->set_info($message, $data);
+		}
+		return $attached;
+	}
+
+
+	/**
+	 * Initializes the data from the incoming info.
+	 *
+	 * @param array      $info     incoming data.
+	 * @param bool       $attached Indicates whether the object was attached successfully.
+	 * @param EE_Message $message
+	 * @return array
+	 */
+	protected function _init_data($info, $attached, $message)
+	{
+		$data = array(
+			'test_send'               => false,
+			'preview'                 => false,
+			'data_handler_class_name' => '',
+			'data'                    => array(
+				'MSG_generation_data' => array(),
+			),
+		);
+		if (isset($info['preview'])) {
+			$data['preview'] = $info['preview'];
+			unset($info['preview']);
+		}
+		if (isset($info['test_send'])) {
+			$data['test_send'] = $info['test_send'];
+			unset($info['test_send']);
+		}
+		if (isset($info['data_handler_class_name'])) {
+			$data['data_handler_class_name'] = $info['data_handler_class_name'];
+			unset($info['data_handler_class_name']);
+		}
+		if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
+			$generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
+			//if data isn't in $info...let's see if its available via the message object
+			$generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
+			//still empty then let's just use info
+			$generation_data                     = ! $generation_data ? $info : $generation_data;
+			$data['data']['MSG_generation_data'] = $generation_data;
+		}
+		return $data;
+	}
+
+
+	/**
+	 * Save all EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
+	 * @return array array(
+	 *                  'updated' => 0, //count of how many messages updated
+	 *                  'notupdated' => 0, //count of how many messages not updated.
+	 *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
+	 *                  )
+	 */
+	public function saveAll($do_hooks_only = false)
+	{
+		$save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
+
+		if (! $do_hooks_only) {
+			$this->rewind();
+			//exit early if there is nothing to save.
+			if (! $this->count() > 0) {
+				return $save_tracking;
+			}
+
+			while ($this->valid()) {
+				$saved = $this->current()->save();
+				if ($saved === false) {
+					$save_tracking['errors'][] = $this->current()->MSG_token();
+				} elseif ($saved) {
+					$save_tracking['updated']++;
+				} else {
+					$save_tracking['notupdated']++;
+				}
+				//maybe persist generation data if this is an incomplete EE_Message.
+				$this->_maybe_persist_attached_data();
+
+				$this->next();
+			}
+		}
+		do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
+		return $save_tracking;
+	}
+
+
+	/**
+	 * Retrieves a EE_Message from the repository that matches the given token.
+	 *
+	 * @param string $token Token.
+	 * @return EE_Message | null
+	 */
+	public function getMessageByToken($token)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->MSG_token() === $token) {
+				$message = $this->current();
+				$this->rewind();
+				return $message;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
+	 *
+	 * @return array();
+	 */
+	public function get_generation_data()
+	{
+		//first verify we're at a valid iterator point.
+		if ( ! $this->valid()) {
+			return array();
+		}
+		$info = $this->getInfo();
+		return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+	}
+
+
+	/**
+	 * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
+	 *
+	 * @return string
+	 */
+	public function get_data_handler()
+	{
+		if ( ! $this->valid()) {
+			return '';
+		}
+		$info = $this->getInfo();
+		return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+	}
+
+
+	/**
+	 * Returns whether this EE_Message is for a preview or not.
+	 *
+	 * @return bool
+	 */
+	public function is_preview()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['preview'];
+	}
+
+
+	/**
+	 * Returns whether the current message pointed to is for a test send.
+	 *
+	 * @return bool
+	 */
+	public function is_test_send()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['test_send'];
+	}
+
+
+	/**
+	 *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
+	 *  data is attached for later retrieval (batch generation).
+	 */
+	protected function _maybe_persist_attached_data()
+	{
+		if ( ! $this->valid()) {
+			return;
+		}
+
+		$info                    = $this->getInfo();
+		$data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+		$data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+		if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
+			$this->current()->set_generation_data($data);
+			$this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
+		}
+	}
+
+
+	/**
+	 * This method returns a count of messages in the repository that have a given priority.
+	 *
+	 * @param int   $priority the priority that is being filtered for the count.
+	 * @param array $status   the optional status(es) that will also be filtered by when priority matches.
+	 * @return int  count of messages in the queue matching the conditions.
+	 */
+	public function count_by_priority_and_status($priority, $status = array())
+	{
+		if ( ! empty($status)) {
+			$status = is_array($status) ? $status : array($status);
+		}
+
+		$count = 0;
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
+							$status)) || ! $status)
+			) {
+				$count++;
+			}
+			$this->next();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * @return EE_Message
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
 
 
 }
\ No newline at end of file

caffeinated/admin/new/pricing/espresso_events_Pricing_Hooks.class.php

Spacing +56 added lines, -56 removed lines

@@ -73,7 +73,7 @@ 
                 'context'    => 'normal'
             ),
         
-        );/**/
+        ); /**/
         
         $this->_remove_metaboxes = array(
             0 => array(
@@ -103,16 +103,16 @@ 
         $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) ? $this->_date_format_strings['time'] : null;
         
         //validate format strings
-        $format_validation = EEH_DTT_Helper::validate_format_string($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+        $format_validation = EEH_DTT_Helper::validate_format_string($this->_date_format_strings['date'].' '.$this->_date_format_strings['time']);
         if (is_array($format_validation)) {
-            $msg = '<p>' . sprintf(__('The format "%s" was likely added via a filter and is invalid for the following reasons:',
+            $msg = '<p>'.sprintf(__('The format "%s" was likely added via a filter and is invalid for the following reasons:',
                     'event_espresso'),
-                    $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']) . '</p><ul>';
+                    $this->_date_format_strings['date'].' '.$this->_date_format_strings['time']).'</p><ul>';
             foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
+                $msg .= '<li>'.$error.'</li>';
             }
-            $msg .= '</ul></p><p>' . sprintf(__('%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
-                    'event_espresso'), '<span style="color:#D54E21;">', '</span>') . '</p>';
+            $msg .= '</ul></p><p>'.sprintf(__('%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
+                    'event_espresso'), '<span style="color:#D54E21;">', '</span>').'</p>';
             EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
             $this->_date_format_strings = array(
                 'date' => 'Y-m-d',
@@ -124,11 +124,11 @@ 
         $this->_scripts_styles = array(
             'registers'   => array(
                 'ee-tickets-datetimes-css' => array(
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+                    'url'  => PRICING_ASSETS_URL.'event-tickets-datetimes.css',
                     'type' => 'css'
                 ),
                 'ee-dtt-ticket-metabox'    => array(
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+                    'url'     => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js',
                     'depends' => array('ee-datepicker', 'ee-dialog', 'underscore')
                 )
             ),
@@ -147,21 +147,21 @@ 
                             'event_espresso'),
                         'after_warning'           => __('In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
                             'event_espresso'),
-                        'cancel_button'           => '<button class="button-secondary ee-modal-cancel">' . __('Cancel',
-                                'event_espresso') . '</button>',
-                        'close_button'            => '<button class="button-secondary ee-modal-cancel">' . __('Close',
-                                'event_espresso') . '</button>',
+                        'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'.__('Cancel',
+                                'event_espresso').'</button>',
+                        'close_button'            => '<button class="button-secondary ee-modal-cancel">'.__('Close',
+                                'event_espresso').'</button>',
                         'single_warning_from_tkt' => __('The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
                             'event_espresso'),
                         'single_warning_from_dtt' => __('The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
                             'event_espresso'),
-                        'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">' . __('Dismiss',
-                                'event_espresso') . '</button>'
+                        'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'.__('Dismiss',
+                                'event_espresso').'</button>'
                     ),
                     'DTT_ERROR_MSG'         => array(
                         'no_ticket_name' => __('General Admission', 'event_espresso'),
-                        'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' . __('Dismiss',
-                                'event_espresso') . '</button></div>'
+                        'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">'.__('Dismiss',
+                                'event_espresso').'</button></div>'
                     ),
                     'DTT_OVERSELL_WARNING'  => array(
                         'datetime_ticket' => __('You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
@@ -171,7 +171,7 @@ 
                     ),
                     'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats($this->_date_format_strings['date'],
                         $this->_date_format_strings['time']),
-                    'DTT_START_OF_WEEK'     => array('dayValue' => (int)get_option('start_of_week'))
+                    'DTT_START_OF_WEEK'     => array('dayValue' => (int) get_option('start_of_week'))
                 )
             )
         );
@@ -231,8 +231,8 @@ 
         
         foreach ($data['edit_event_datetimes'] as $row => $dtt) {
             //trim all values to ensure any excess whitespace is removed.
-            $dtt                = array_map(
-                function ($datetime_data) {
+            $dtt = array_map(
+                function($datetime_data) {
                     return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
                 },
                 $dtt
@@ -368,7 +368,7 @@ 
             
             // trim inputs to ensure any excess whitespace is removed.
             $tkt = array_map(
-                function ($ticket_data) {
+                function($ticket_data) {
                     return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
                 },
                 $tkt
@@ -376,7 +376,7 @@ 
             
             //note we are doing conversions to floats here instead of allowing EE_Money_Field to handle because we're doing calcs prior to using the models.
             //note incoming ['TKT_price'] value is already in standard notation (via js).
-            $ticket_price = isset($tkt['TKT_price']) ? round((float)$tkt['TKT_price'], 3) : 0;
+            $ticket_price = isset($tkt['TKT_price']) ? round((float) $tkt['TKT_price'], 3) : 0;
             
             //note incoming base price needs converted from localized value.
             $base_price = isset($tkt['TKT_base_price']) ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) : 0;
@@ -390,7 +390,7 @@ 
             if (empty($tkt['TKT_start_date'])) {
                 //lets' use now in the set timezone.
                 $now                   = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+                $tkt['TKT_start_date'] = $now->format($this->_date_format_strings['date'].' '.$this->_date_format_strings['time']);
             }
             
             if (empty($tkt['TKT_end_date'])) {
@@ -398,7 +398,7 @@ 
                  * set the TKT_end_date to the first datetime attached to the ticket.
                  */
                 $first_dtt           = $saved_dtts[reset($tkt_dtt_rows)];
-                $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_format_strings['date'] . ' ' . $this->_date_format_string['time']);
+                $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_format_strings['date'].' '.$this->_date_format_string['time']);
             }
             
             $TKT_values = array(
@@ -628,7 +628,7 @@ 
         // first let's add datetimes
         if ( ! empty($added_datetimes) && is_array($added_datetimes)) {
             foreach ($added_datetimes as $row_id) {
-                $row_id = (int)$row_id;
+                $row_id = (int) $row_id;
                 if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
                     $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
                     // Is this an existing ticket (has an ID) and does it have any sold?
@@ -643,7 +643,7 @@ 
         // then remove datetimes
         if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) {
             foreach ($removed_datetimes as $row_id) {
-                $row_id = (int)$row_id;
+                $row_id = (int) $row_id;
                 // its entirely possible that a datetime got deleted (instead of just removed from relationship.
                 // So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
                 if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
@@ -948,9 +948,9 @@ 
         $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
         
         //sort $all_tickets by order
-        usort($all_tickets, function ($a, $b) {
-            $a_order = (int)$a->get('TKT_order');
-            $b_order = (int)$b->get('TKT_order');
+        usort($all_tickets, function($a, $b) {
+            $a_order = (int) $a->get('TKT_order');
+            $b_order = (int) $b->get('TKT_order');
             if ($a_order == $b_order) {
                 return 0;
             }
@@ -975,7 +975,7 @@ 
         }
         
         $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($times, $all_tickets);
-        $template                                  = PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php';
+        $template                                  = PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php';
         EEH_Template::display_template($template, $main_template_args);
         
         return;
@@ -997,7 +997,7 @@ 
                 $all_tickets, $default),
             'dtt_row'                  => $default ? 'DTTNUM' : $dttrow
         );
-        $template                  = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php';
         
         return EEH_Template::display_template($template, $dtt_display_template_args, true);
     }
@@ -1031,8 +1031,8 @@ 
             'DTT_ID'               => $default ? '' : $dtt->ID(),
             'DTT_name'             => $default ? '' : $dtt->name(),
             'DTT_description'      => $default ? '' : $dtt->description(),
-            'DTT_EVT_start'        => $default ? '' : $dtt->start_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
-            'DTT_EVT_end'          => $default ? '' : $dtt->end_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+            'DTT_EVT_start'        => $default ? '' : $dtt->start_date($this->_date_format_strings['date'].' '.$this->_date_format_strings['time']),
+            'DTT_EVT_end'          => $default ? '' : $dtt->end_date($this->_date_format_strings['date'].' '.$this->_date_format_strings['time']),
             'DTT_reg_limit'        => $default ? '' : $dtt->get_pretty('DTT_reg_limit', 'input'),
             'DTT_order'            => $default ? 'DTTNUM' : $dttrow,
             'dtt_sold'             => $default ? '0' : $dtt->get('DTT_sold'),
@@ -1052,7 +1052,7 @@ 
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
             $template_args, $dttrow, $dtt, $default, $all_dtts, $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1088,7 +1088,7 @@ 
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
             $template_args, $dttrow, $dtt, $datetime_tickets, $all_tickets, $default, $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1106,14 +1106,14 @@ 
             'datetime_ticket_checked' => in_array($displayrow, $dtt_tkts) ? ' checked="checked"' : '',
             'ticket_selected'         => in_array($displayrow, $dtt_tkts) ? ' ticket-selected' : '',
             'TKT_name'                => $default && empty($ticket) ? 'TKTNAME' : $ticket->get('TKT_name'),
-            'tkt_status_class'        => ($default && empty($ticket)) || $this->_is_creating_event ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status(),
+            'tkt_status_class'        => ($default && empty($ticket)) || $this->_is_creating_event ? ' tkt-status-'.EE_Ticket::onsale : ' tkt-status-'.$ticket->ticket_status(),
         );
         
         //filter template args
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
             $template_args, $dttrow, $tktrow, $dtt, $ticket, $datetime_tickets, $default, $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1168,9 +1168,9 @@ 
         
         //breaking out complicated condition for ticket_status
         if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+            $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale;
         } else {
-            $ticket_status_class = $ticket->is_default() ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status();
+            $ticket_status_class = $ticket->is_default() ? ' tkt-status-'.EE_Ticket::onsale : ' tkt-status-'.$ticket->ticket_status();
         }
         
         //breaking out complicated condition for TKT_taxable
@@ -1191,9 +1191,9 @@ 
             'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
             'TKT_name'                      => $default ? '' : $ticket->get('TKT_name'),
             'TKT_start_date'                => $default ? '' : $ticket->get_date('TKT_start_date',
-                $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+                $this->_date_format_strings['date'].' '.$this->_date_format_strings['time']),
             'TKT_end_date'                  => $default ? '' : $ticket->get_date('TKT_end_date',
-                $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+                $this->_date_format_strings['date'].' '.$this->_date_format_strings['time']),
             'TKT_status'                    => $default ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
                 'sentence') : $ticket->is_default() ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
                 'sentence') : $ticket->ticket_status(true),
@@ -1249,9 +1249,9 @@ 
         //handle rows that should NOT be empty
         if (empty($template_args['TKT_start_date'])) {
             //if empty then the start date will be now.
-            $template_args['TKT_start_date']   = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
+            $template_args['TKT_start_date']   = date($this->_date_format_strings['date'].' '.$this->_date_format_strings['time'],
                 current_time('timestamp'));
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         
         if (empty($template_args['TKT_end_date'])) {
@@ -1262,13 +1262,13 @@ 
             
             if ( ! empty($earliest_dtt)) {
                 $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start',
-                    $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+                    $this->_date_format_strings['date'].' '.$this->_date_format_strings['time']);
             } else {
                 //default so let's just use what's been set for the default date-time which is 30 days from now.
-                $template_args['TKT_end_date'] = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
+                $template_args['TKT_end_date'] = date($this->_date_format_strings['date'].' '.$this->_date_format_strings['time'],
                     mktime(24, 0, 0, date("m"), date("d") + 29, date("Y")));
             }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         
         //generate ticket_datetime items
@@ -1299,7 +1299,7 @@ 
             $template_args, $tktrow, $ticket, $ticket_datetimes, $all_dtts, $default, $all_tickets,
             $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1308,7 +1308,7 @@ 
     protected function _get_tax_rows($tktrow, $ticket)
     {
         $tax_rows      = '';
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php';
+        $template      = PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php';
         $template_args = array();
         $taxes         = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
         foreach ($taxes as $tax) {
@@ -1377,7 +1377,7 @@ 
             $template_args, $tktrow, $prcrow, $price, $default, $ticket, $show_trash, $show_create,
             $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1404,7 +1404,7 @@ 
             'price_selected_operator'   => '+',
             'price_selected_is_percent' => 0
         );
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php';
+        $template      = PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php';
         
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
             $template_args, $tktrow, $prcrow, $price, $default, $this->_is_creating_event);
@@ -1415,7 +1415,7 @@ 
     
     protected function _get_price_modifier_template($tktrow, $prcrow, $price, $default, $disabled = false)
     {
-        $select_name                = $default && empty($price) ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' : 'edit_prices[' . $tktrow . '][' . $prcrow . '][PRT_ID]';
+        $select_name                = $default && empty($price) ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' : 'edit_prices['.$tktrow.']['.$prcrow.'][PRT_ID]';
         $price_types                = EE_Registry::instance()->load_model('Price_Type')->get_all(array(
             array(
                 'OR' => array(
@@ -1424,7 +1424,7 @@ 
                 )
             )
         ));
-        $price_option_span_template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php';
+        $price_option_span_template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php';
         $all_price_types            = $default && empty($price) ? array(
             array(
                 'id'   => 0,
@@ -1451,7 +1451,7 @@ 
         
         $select_params = $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"';
         $main_name     = $select_name;
-        $select_name   = $disabled ? 'archive_price[' . $tktrow . '][' . $prcrow . '][PRT_ID]' : $main_name;
+        $select_name   = $disabled ? 'archive_price['.$tktrow.']['.$prcrow.'][PRT_ID]' : $main_name;
         
         $template_args = array(
             'tkt_row'                   => $default ? 'TICKETNUM' : $tktrow,
@@ -1469,7 +1469,7 @@ 
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
             $template_args, $tktrow, $prcrow, $price, $default, $disabled, $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1489,7 +1489,7 @@ 
         
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
             $template_args, $dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default, $this->_is_creating_event);
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php';
+        $template      = PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }
@@ -1554,7 +1554,7 @@ 
         $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
             $template_args, $all_dtts, $all_tickets, $this->_is_creating_event);
         
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php';
+        $template = PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php';
         
         return EEH_Template::display_template($template, $template_args, true);
     }

Doc Comments +18 added lines, -1 removed lines

@@ -204,7 +204,7 @@ 
      * @param  EE_Event $evtobj The Event object we're attaching data to
      * @param  array    $data   The request data from the form
      *
-     * @return bool             success or fail
+     * @return boolean|null             success or fail
      */
     public function dtt_and_tickets_caf_update($evtobj, $data)
     {
@@ -982,6 +982,9 @@ 
     }
     
     
+    /**
+     * @param integer $dttrow
+     */
     protected function _get_datetime_row(
         $dttrow,
         EE_Datetime $dtt,
@@ -1014,6 +1017,7 @@ 
      *                                                                       object.
      * @param bool          $default                        Whether a default row is being generated or not.
      * @param EE_Datetime[] $all_dtts                       This is the array of all datetimes used in the editor.
+     * @param EE_Datetime|null $dtt
      *
      * @return string Generated edit row.
      */
@@ -1058,6 +1062,10 @@ 
     }
     
     
+    /**
+     * @param EE_Datetime|null $dtt
+     * @param boolean $default
+     */
     protected function _get_dtt_attached_tickets_row($dttrow, $dtt, $datetime_tickets, $all_tickets, $default)
     {
         
@@ -1305,6 +1313,9 @@ 
     }
     
     
+    /**
+     * @param integer $tktrow
+     */
     protected function _get_tax_rows($tktrow, $ticket)
     {
         $tax_rows      = '';
@@ -1340,6 +1351,9 @@ 
     }
     
     
+    /**
+     * @param boolean $default
+     */
     protected function _get_ticket_price_row(
         $tktrow,
         $prcrow,
@@ -1475,6 +1489,9 @@ 
     }
     
     
+    /**
+     * @param boolean $default
+     */
     protected function _get_ticket_datetime_list_item($dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default)
     {
         $tkt_dtts      = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) ? $ticket_datetimes[$ticket->ID()] : array();

Indentation +1406 added lines, -1406 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -31,1533 +31,1533 @@ 
 class espresso_events_Pricing_Hooks extends EE_Admin_Hooks
 {
     
-    /**
-     * This property is just used to hold the status of whether an event is currently being
-     * created (true) or edited (false)
-     * @access protected
-     * @var bool
-     */
-    protected $_is_creating_event;
+	/**
+	 * This property is just used to hold the status of whether an event is currently being
+	 * created (true) or edited (false)
+	 * @access protected
+	 * @var bool
+	 */
+	protected $_is_creating_event;
     
     
-    /**
-     * Used to contain the format strings for date and time that will be used for php date and
-     * time.
-     *
-     * Is set in the _set_hooks_properties() method.
-     *
-     * @var array
-     */
-    protected $_date_format_strings;
+	/**
+	 * Used to contain the format strings for date and time that will be used for php date and
+	 * time.
+	 *
+	 * Is set in the _set_hooks_properties() method.
+	 *
+	 * @var array
+	 */
+	protected $_date_format_strings;
     
     
-    protected function _set_hooks_properties()
-    {
-        $this->_name = 'pricing';
-        
-        //capability check
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_default_prices',
-            'advanced_ticket_datetime_metabox')
-        ) {
-            return;
-        }
-        
-        
-        //if we were going to add our own metaboxes we'd use the below.
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'pricing_metabox',
-                'label'      => __('Event Tickets & Datetimes', 'event_espresso'),
-                'priority'   => 'high',
-                'context'    => 'normal'
-            ),
-        
-        );/**/
-        
-        $this->_remove_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'id'         => 'espresso_event_editor_tickets',
-                'context'    => 'normal'
-            )
-        );
-        
-        /**
-         * Format strings for date and time.  Defaults are existing behaviour from 4.1.
-         * Note, that if you return null as the value for 'date', and 'time' in the array, then
-         * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
-         *
-         * @since 4.6.7
-         *
-         * @var array  Expected an array returned with 'date' and 'time' keys.
-         */
-        $this->_date_format_strings = apply_filters('FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
-            array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a'
-            ));
-        
-        //validate
-        $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) ? $this->_date_format_strings['date'] : null;
-        $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) ? $this->_date_format_strings['time'] : null;
-        
-        //validate format strings
-        $format_validation = EEH_DTT_Helper::validate_format_string($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
-        if (is_array($format_validation)) {
-            $msg = '<p>' . sprintf(__('The format "%s" was likely added via a filter and is invalid for the following reasons:',
-                    'event_espresso'),
-                    $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']) . '</p><ul>';
-            foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
-            }
-            $msg .= '</ul></p><p>' . sprintf(__('%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
-                    'event_espresso'), '<span style="color:#D54E21;">', '</span>') . '</p>';
-            EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_date_format_strings = array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a'
-            );
-        }
-        
-        
-        $this->_scripts_styles = array(
-            'registers'   => array(
-                'ee-tickets-datetimes-css' => array(
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
-                    'type' => 'css'
-                ),
-                'ee-dtt-ticket-metabox'    => array(
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
-                    'depends' => array('ee-datepicker', 'ee-dialog', 'underscore')
-                )
-            ),
-            'deregisters' => array(
-                'event-editor-css'       => array('type' => 'css'),
-                'event-datetime-metabox' => array('type' => 'js')
-            ),
-            'enqueues'    => array(
-                'ee-tickets-datetimes-css' => array('edit', 'create_new'),
-                'ee-dtt-ticket-metabox'    => array('edit', 'create_new')
-            ),
-            'localize'    => array(
-                'ee-dtt-ticket-metabox' => array(
-                    'DTT_TRASH_BLOCK'       => array(
-                        'main_warning'            => __('The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
-                            'event_espresso'),
-                        'after_warning'           => __('In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
-                            'event_espresso'),
-                        'cancel_button'           => '<button class="button-secondary ee-modal-cancel">' . __('Cancel',
-                                'event_espresso') . '</button>',
-                        'close_button'            => '<button class="button-secondary ee-modal-cancel">' . __('Close',
-                                'event_espresso') . '</button>',
-                        'single_warning_from_tkt' => __('The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'),
-                        'single_warning_from_dtt' => __('The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'),
-                        'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">' . __('Dismiss',
-                                'event_espresso') . '</button>'
-                    ),
-                    'DTT_ERROR_MSG'         => array(
-                        'no_ticket_name' => __('General Admission', 'event_espresso'),
-                        'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' . __('Dismiss',
-                                'event_espresso') . '</button></div>'
-                    ),
-                    'DTT_OVERSELL_WARNING'  => array(
-                        'datetime_ticket' => __('You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
-                            'event_espresso'),
-                        'ticket_datetime' => __('You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
-                            'event_espresso')
-                    ),
-                    'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats($this->_date_format_strings['date'],
-                        $this->_date_format_strings['time']),
-                    'DTT_START_OF_WEEK'     => array('dayValue' => (int)get_option('start_of_week'))
-                )
-            )
-        );
-        
-        
-        add_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
-            array($this, 'autosave_handling'), 10);
-        add_filter('FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'caf_updates'), 10);
-    }
+	protected function _set_hooks_properties()
+	{
+		$this->_name = 'pricing';
+        
+		//capability check
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_default_prices',
+			'advanced_ticket_datetime_metabox')
+		) {
+			return;
+		}
+        
+        
+		//if we were going to add our own metaboxes we'd use the below.
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'pricing_metabox',
+				'label'      => __('Event Tickets & Datetimes', 'event_espresso'),
+				'priority'   => 'high',
+				'context'    => 'normal'
+			),
+        
+		);/**/
+        
+		$this->_remove_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'id'         => 'espresso_event_editor_tickets',
+				'context'    => 'normal'
+			)
+		);
+        
+		/**
+		 * Format strings for date and time.  Defaults are existing behaviour from 4.1.
+		 * Note, that if you return null as the value for 'date', and 'time' in the array, then
+		 * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
+		 *
+		 * @since 4.6.7
+		 *
+		 * @var array  Expected an array returned with 'date' and 'time' keys.
+		 */
+		$this->_date_format_strings = apply_filters('FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
+			array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a'
+			));
+        
+		//validate
+		$this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) ? $this->_date_format_strings['date'] : null;
+		$this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) ? $this->_date_format_strings['time'] : null;
+        
+		//validate format strings
+		$format_validation = EEH_DTT_Helper::validate_format_string($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+		if (is_array($format_validation)) {
+			$msg = '<p>' . sprintf(__('The format "%s" was likely added via a filter and is invalid for the following reasons:',
+					'event_espresso'),
+					$this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']) . '</p><ul>';
+			foreach ($format_validation as $error) {
+				$msg .= '<li>' . $error . '</li>';
+			}
+			$msg .= '</ul></p><p>' . sprintf(__('%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
+					'event_espresso'), '<span style="color:#D54E21;">', '</span>') . '</p>';
+			EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_date_format_strings = array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a'
+			);
+		}
+        
+        
+		$this->_scripts_styles = array(
+			'registers'   => array(
+				'ee-tickets-datetimes-css' => array(
+					'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+					'type' => 'css'
+				),
+				'ee-dtt-ticket-metabox'    => array(
+					'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+					'depends' => array('ee-datepicker', 'ee-dialog', 'underscore')
+				)
+			),
+			'deregisters' => array(
+				'event-editor-css'       => array('type' => 'css'),
+				'event-datetime-metabox' => array('type' => 'js')
+			),
+			'enqueues'    => array(
+				'ee-tickets-datetimes-css' => array('edit', 'create_new'),
+				'ee-dtt-ticket-metabox'    => array('edit', 'create_new')
+			),
+			'localize'    => array(
+				'ee-dtt-ticket-metabox' => array(
+					'DTT_TRASH_BLOCK'       => array(
+						'main_warning'            => __('The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
+							'event_espresso'),
+						'after_warning'           => __('In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
+							'event_espresso'),
+						'cancel_button'           => '<button class="button-secondary ee-modal-cancel">' . __('Cancel',
+								'event_espresso') . '</button>',
+						'close_button'            => '<button class="button-secondary ee-modal-cancel">' . __('Close',
+								'event_espresso') . '</button>',
+						'single_warning_from_tkt' => __('The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'),
+						'single_warning_from_dtt' => __('The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'),
+						'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">' . __('Dismiss',
+								'event_espresso') . '</button>'
+					),
+					'DTT_ERROR_MSG'         => array(
+						'no_ticket_name' => __('General Admission', 'event_espresso'),
+						'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' . __('Dismiss',
+								'event_espresso') . '</button></div>'
+					),
+					'DTT_OVERSELL_WARNING'  => array(
+						'datetime_ticket' => __('You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
+							'event_espresso'),
+						'ticket_datetime' => __('You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
+							'event_espresso')
+					),
+					'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats($this->_date_format_strings['date'],
+						$this->_date_format_strings['time']),
+					'DTT_START_OF_WEEK'     => array('dayValue' => (int)get_option('start_of_week'))
+				)
+			)
+		);
+        
+        
+		add_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
+			array($this, 'autosave_handling'), 10);
+		add_filter('FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'caf_updates'), 10);
+	}
     
     
-    public function caf_updates($update_callbacks)
-    {
-        foreach ($update_callbacks as $key => $callback) {
-            if ($callback[1] == '_default_tickets_update') {
-                unset($update_callbacks[$key]);
-            }
-        }
-        
-        $update_callbacks[] = array($this, 'dtt_and_tickets_caf_update');
-        
-        return $update_callbacks;
-    }
+	public function caf_updates($update_callbacks)
+	{
+		foreach ($update_callbacks as $key => $callback) {
+			if ($callback[1] == '_default_tickets_update') {
+				unset($update_callbacks[$key]);
+			}
+		}
+        
+		$update_callbacks[] = array($this, 'dtt_and_tickets_caf_update');
+        
+		return $update_callbacks;
+	}
     
     
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $evtobj The Event object we're attaching data to
-     * @param  array    $data   The request data from the form
-     *
-     * @return bool             success or fail
-     */
-    public function dtt_and_tickets_caf_update($evtobj, $data)
-    {
-        //first we need to start with datetimes cause they are the "root" items attached to events.
-        $saved_dtts = $this->_update_dtts($evtobj, $data);
-        //next tackle the tickets (and prices?)
-        $this->_update_tkts($evtobj, $saved_dtts, $data);
-    }
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $evtobj The Event object we're attaching data to
+	 * @param  array    $data   The request data from the form
+	 *
+	 * @return bool             success or fail
+	 */
+	public function dtt_and_tickets_caf_update($evtobj, $data)
+	{
+		//first we need to start with datetimes cause they are the "root" items attached to events.
+		$saved_dtts = $this->_update_dtts($evtobj, $data);
+		//next tackle the tickets (and prices?)
+		$this->_update_tkts($evtobj, $saved_dtts, $data);
+	}
     
     
-    /**
-     * update event_datetimes
-     *
-     * @param  EE_Event $evt_obj Event being updated
-     * @param  array    $data    the request data from the form
-     *
-     * @return EE_Datetime[]
-     */
-    protected function _update_dtts($evt_obj, $data)
-    {
-        $timezone       = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_dtt_ids  = array();
-        $saved_dtt_objs = array();
-        
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
-            //trim all values to ensure any excess whitespace is removed.
-            $dtt                = array_map(
-                function ($datetime_data) {
-                    return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
-                },
-                $dtt
-            );
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end'] : $dtt['DTT_EVT_start'];
-            $datetime_values    = array(
-                'DTT_ID'          => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
-                'DTT_name'        => ! empty($dtt['DTT_name']) ? $dtt['DTT_name'] : '',
-                'DTT_description' => ! empty($dtt['DTT_description']) ? $dtt['DTT_description'] : '',
-                'DTT_EVT_start'   => $dtt['DTT_EVT_start'],
-                'DTT_EVT_end'     => $dtt['DTT_EVT_end'],
-                'DTT_reg_limit'   => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
-                'DTT_order'       => ! isset($dtt['DTT_order']) ? $row : $dtt['DTT_order'],
-            );
+	/**
+	 * update event_datetimes
+	 *
+	 * @param  EE_Event $evt_obj Event being updated
+	 * @param  array    $data    the request data from the form
+	 *
+	 * @return EE_Datetime[]
+	 */
+	protected function _update_dtts($evt_obj, $data)
+	{
+		$timezone       = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_dtt_ids  = array();
+		$saved_dtt_objs = array();
+        
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
+			//trim all values to ensure any excess whitespace is removed.
+			$dtt                = array_map(
+				function ($datetime_data) {
+					return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
+				},
+				$dtt
+			);
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end'] : $dtt['DTT_EVT_start'];
+			$datetime_values    = array(
+				'DTT_ID'          => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
+				'DTT_name'        => ! empty($dtt['DTT_name']) ? $dtt['DTT_name'] : '',
+				'DTT_description' => ! empty($dtt['DTT_description']) ? $dtt['DTT_description'] : '',
+				'DTT_EVT_start'   => $dtt['DTT_EVT_start'],
+				'DTT_EVT_end'     => $dtt['DTT_EVT_end'],
+				'DTT_reg_limit'   => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
+				'DTT_order'       => ! isset($dtt['DTT_order']) ? $row : $dtt['DTT_order'],
+			);
             
-            //if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
+			//if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
             
-            if ( ! empty($dtt['DTT_ID'])) {
-                $DTM = EE_Registry::instance()->load_model('Datetime', array($timezone))->get_one_by_ID($dtt['DTT_ID']);
+			if ( ! empty($dtt['DTT_ID'])) {
+				$DTM = EE_Registry::instance()->load_model('Datetime', array($timezone))->get_one_by_ID($dtt['DTT_ID']);
                 
-                //set date and time format according to what is set in this class.
-                $DTM->set_date_format($this->_date_format_strings['date']);
-                $DTM->set_time_format($this->_date_format_strings['time']);
+				//set date and time format according to what is set in this class.
+				$DTM->set_date_format($this->_date_format_strings['date']);
+				$DTM->set_time_format($this->_date_format_strings['time']);
                 
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
                 
-                // make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.
-                // We need to do this so we dont' TRASH the parent DTT.(save the ID for both key and value to avoid duplications)
-                $saved_dtt_ids[$DTM->ID()] = $DTM->ID();
+				// make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.
+				// We need to do this so we dont' TRASH the parent DTT.(save the ID for both key and value to avoid duplications)
+				$saved_dtt_ids[$DTM->ID()] = $DTM->ID();
                 
-            } else {
-                $DTM = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array(
-                        $datetime_values,
-                        $timezone,
-                        array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
-                    ),
-                    false,
-                    false
-                );
+			} else {
+				$DTM = EE_Registry::instance()->load_class(
+					'Datetime',
+					array(
+						$datetime_values,
+						$timezone,
+						array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
+					),
+					false,
+					false
+				);
                 
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-            }
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+			}
             
             
-            $DTM->save();
-            $DTM = $evt_obj->_add_relation_to($DTM, 'Datetime');
-            $evt_obj->save();
+			$DTM->save();
+			$DTM = $evt_obj->_add_relation_to($DTM, 'Datetime');
+			$evt_obj->save();
             
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($DTM->get_raw('DTT_EVT_start') > $DTM->get_raw('DTT_EVT_end')) {
-                $DTM->set('DTT_EVT_end', $DTM->get('DTT_EVT_start'));
-                $DTM = EEH_DTT_Helper::date_time_add($DTM, 'DTT_EVT_end', 'days');
-                $DTM->save();
-            }
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($DTM->get_raw('DTT_EVT_start') > $DTM->get_raw('DTT_EVT_end')) {
+				$DTM->set('DTT_EVT_end', $DTM->get('DTT_EVT_start'));
+				$DTM = EEH_DTT_Helper::date_time_add($DTM, 'DTT_EVT_end', 'days');
+				$DTM->save();
+			}
             
-            //	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
-            // because it is possible there was a new one created for the autosave.
-            // (save the ID for both key and value to avoid duplications)
-            $saved_dtt_ids[$DTM->ID()] = $DTM->ID();
-            $saved_dtt_objs[$row]      = $DTM;
+			//	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
+			// because it is possible there was a new one created for the autosave.
+			// (save the ID for both key and value to avoid duplications)
+			$saved_dtt_ids[$DTM->ID()] = $DTM->ID();
+			$saved_dtt_objs[$row]      = $DTM;
             
-            //todo if ANY of these updates fail then we want the appropriate global error message.
-        }
-        
-        //now we need to REMOVE any dtts that got deleted.  Keep in mind that this process will only kick in for DTT's that don't have any DTT_sold on them. So its safe to permanently delete at this point.
-        $old_datetimes = explode(',', $data['datetime_IDs']);
-        $old_datetimes = $old_datetimes[0] == '' ? array() : $old_datetimes;
-        
-        if (is_array($old_datetimes)) {
-            $dtts_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
-            foreach ($dtts_to_delete as $id) {
-                $id = absint($id);
-                if (empty($id)) {
-                    continue;
-                }
+			//todo if ANY of these updates fail then we want the appropriate global error message.
+		}
+        
+		//now we need to REMOVE any dtts that got deleted.  Keep in mind that this process will only kick in for DTT's that don't have any DTT_sold on them. So its safe to permanently delete at this point.
+		$old_datetimes = explode(',', $data['datetime_IDs']);
+		$old_datetimes = $old_datetimes[0] == '' ? array() : $old_datetimes;
+        
+		if (is_array($old_datetimes)) {
+			$dtts_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
+			foreach ($dtts_to_delete as $id) {
+				$id = absint($id);
+				if (empty($id)) {
+					continue;
+				}
                 
-                $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
+				$dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
                 
-                //remove tkt relationships.
-                $related_tickets = $dtt_to_remove->get_many_related('Ticket');
-                foreach ($related_tickets as $tkt) {
-                    $dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
-                }
+				//remove tkt relationships.
+				$related_tickets = $dtt_to_remove->get_many_related('Ticket');
+				foreach ($related_tickets as $tkt) {
+					$dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
+				}
                 
-                $evt_obj->_remove_relation_to($id, 'Datetime');
-                $dtt_to_remove->refresh_cache_of_related_objects();
+				$evt_obj->_remove_relation_to($id, 'Datetime');
+				$dtt_to_remove->refresh_cache_of_related_objects();
                 
-            }
-        }
+			}
+		}
         
-        return $saved_dtt_objs;
-    }
+		return $saved_dtt_objs;
+	}
     
     
-    /**
-     * update tickets
-     *
-     * @param  EE_Event      $evtobj     Event object being updated
-     * @param  EE_Datetime[] $saved_dtts an array of datetime ids being updated
-     * @param  array         $data       incoming request data
-     *
-     * @return EE_Ticket[]
-     */
-    protected function _update_tkts($evtobj, $saved_dtts, $data)
-    {
-        
-        $new_tkt     = null;
-        $new_default = null;
-        //stripslashes because WP filtered the $_POST ($data) array to add slashes
-        $data          = stripslashes_deep($data);
-        $timezone      = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_tickets = $dtts_on_existing = array();
-        $old_tickets   = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        
-        //load money helper
-        
-        foreach ($data['edit_tickets'] as $row => $tkt) {
+	/**
+	 * update tickets
+	 *
+	 * @param  EE_Event      $evtobj     Event object being updated
+	 * @param  EE_Datetime[] $saved_dtts an array of datetime ids being updated
+	 * @param  array         $data       incoming request data
+	 *
+	 * @return EE_Ticket[]
+	 */
+	protected function _update_tkts($evtobj, $saved_dtts, $data)
+	{
+        
+		$new_tkt     = null;
+		$new_default = null;
+		//stripslashes because WP filtered the $_POST ($data) array to add slashes
+		$data          = stripslashes_deep($data);
+		$timezone      = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_tickets = $dtts_on_existing = array();
+		$old_tickets   = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+        
+		//load money helper
+        
+		foreach ($data['edit_tickets'] as $row => $tkt) {
             
-            $update_prices = $create_new_TKT = false;
+			$update_prices = $create_new_TKT = false;
             
-            //figure out what dtts were added to the ticket and what dtts were removed from the ticket in the session.
+			//figure out what dtts were added to the ticket and what dtts were removed from the ticket in the session.
             
-            $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
-            $tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][$row]);
-            $dtts_added            = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
-            $dtts_removed          = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
+			$starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
+			$tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][$row]);
+			$dtts_added            = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
+			$dtts_removed          = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
             
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map(
-                function ($ticket_data) {
-                    return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
-                },
-                $tkt
-            );
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map(
+				function ($ticket_data) {
+					return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
+				},
+				$tkt
+			);
             
-            //note we are doing conversions to floats here instead of allowing EE_Money_Field to handle because we're doing calcs prior to using the models.
-            //note incoming ['TKT_price'] value is already in standard notation (via js).
-            $ticket_price = isset($tkt['TKT_price']) ? round((float)$tkt['TKT_price'], 3) : 0;
+			//note we are doing conversions to floats here instead of allowing EE_Money_Field to handle because we're doing calcs prior to using the models.
+			//note incoming ['TKT_price'] value is already in standard notation (via js).
+			$ticket_price = isset($tkt['TKT_price']) ? round((float)$tkt['TKT_price'], 3) : 0;
             
-            //note incoming base price needs converted from localized value.
-            $base_price = isset($tkt['TKT_base_price']) ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) : 0;
-            //if ticket price == 0 and $base_price != 0 then ticket price == base_price
-            $ticket_price  = $ticket_price === 0 && $base_price !== 0 ? $base_price : $ticket_price;
-            $base_price_id = isset($tkt['TKT_base_price_ID']) ? $tkt['TKT_base_price_ID'] : 0;
+			//note incoming base price needs converted from localized value.
+			$base_price = isset($tkt['TKT_base_price']) ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) : 0;
+			//if ticket price == 0 and $base_price != 0 then ticket price == base_price
+			$ticket_price  = $ticket_price === 0 && $base_price !== 0 ? $base_price : $ticket_price;
+			$base_price_id = isset($tkt['TKT_base_price_ID']) ? $tkt['TKT_base_price_ID'] : 0;
             
-            $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) ? $data['edit_prices'][$row] : array();
+			$price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) ? $data['edit_prices'][$row] : array();
             
-            $now = null;
-            if (empty($tkt['TKT_start_date'])) {
-                //lets' use now in the set timezone.
-                $now                   = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
-            }
+			$now = null;
+			if (empty($tkt['TKT_start_date'])) {
+				//lets' use now in the set timezone.
+				$now                   = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+			}
             
-            if (empty($tkt['TKT_end_date'])) {
-                /**
-                 * set the TKT_end_date to the first datetime attached to the ticket.
-                 */
-                $first_dtt           = $saved_dtts[reset($tkt_dtt_rows)];
-                $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_format_strings['date'] . ' ' . $this->_date_format_string['time']);
-            }
+			if (empty($tkt['TKT_end_date'])) {
+				/**
+				 * set the TKT_end_date to the first datetime attached to the ticket.
+				 */
+				$first_dtt           = $saved_dtts[reset($tkt_dtt_rows)];
+				$tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_format_strings['date'] . ' ' . $this->_date_format_string['time']);
+			}
             
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description']) && $tkt['TKT_description'] != __('You can modify this description',
-                    'event_espresso') ? $tkt['TKT_description'] : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
-                'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
-                'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
-                'TKT_price'       => $ticket_price
-            );
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description']) && $tkt['TKT_description'] != __('You can modify this description',
+					'event_espresso') ? $tkt['TKT_description'] : '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
+				'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
+				'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
+				'TKT_price'       => $ticket_price
+			);
             
             
-            //if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID']         = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $update_prices                = true;
-            }
+			//if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID']         = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$update_prices                = true;
+			}
             
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of doing any add_relations to
-            // because its entirely possible that this ticket wasn't removed or added to any datetime in the session
-            // but DID have it's items modified.
-            // keep in mind that if the TKT has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (absint($TKT_values['TKT_ID'])) {
-                $TKT = EE_Registry::instance()->load_model('Ticket', array($timezone))->get_one_by_ID($tkt['TKT_ID']);
-                if ($TKT instanceof EE_Ticket) {
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of doing any add_relations to
+			// because its entirely possible that this ticket wasn't removed or added to any datetime in the session
+			// but DID have it's items modified.
+			// keep in mind that if the TKT has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (absint($TKT_values['TKT_ID'])) {
+				$TKT = EE_Registry::instance()->load_model('Ticket', array($timezone))->get_one_by_ID($tkt['TKT_ID']);
+				if ($TKT instanceof EE_Ticket) {
                     
-                    $TKT = $this->_update_ticket_datetimes($TKT, $saved_dtts, $dtts_added, $dtts_removed);
-                    // are there any registrations using this ticket ?
-                    $tickets_sold = $TKT->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete))
-                            )
-                        )
-                    );
-                    //set ticket formats
-                    $TKT->set_date_format($this->_date_format_strings['date']);
-                    $TKT->set_time_format($this->_date_format_strings['time']);
+					$TKT = $this->_update_ticket_datetimes($TKT, $saved_dtts, $dtts_added, $dtts_removed);
+					// are there any registrations using this ticket ?
+					$tickets_sold = $TKT->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete))
+							)
+						)
+					);
+					//set ticket formats
+					$TKT->set_date_format($this->_date_format_strings['date']);
+					$TKT->set_time_format($this->_date_format_strings['time']);
                     
-                    // let's just check the total price for the existing ticket
-                    // and determine if it matches the new total price.
-                    // if they are different then we create a new ticket (if tkts sold)
-                    // if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $tickets_sold > 0 && $ticket_price != $TKT->price() && ! $TKT->deleted()
-                        ? true : false;
+					// let's just check the total price for the existing ticket
+					// and determine if it matches the new total price.
+					// if they are different then we create a new ticket (if tkts sold)
+					// if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $tickets_sold > 0 && $ticket_price != $TKT->price() && ! $TKT->deleted()
+						? true : false;
                     
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field === 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field === 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
                     
-                    //if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        $new_tkt = $this->_duplicate_ticket($TKT, $price_rows, $ticket_price, $base_price,
-                            $base_price_id);
-                    }
-                }
+					//if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						$new_tkt = $this->_duplicate_ticket($TKT, $price_rows, $ticket_price, $base_price,
+							$base_price_id);
+					}
+				}
                 
-            } else {
-                // no TKT_id so a new TKT
-                $TKT = EE_Ticket::new_instance(
-                    $TKT_values,
-                    $timezone,
-                    array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
-                );
-                if ($TKT instanceof EE_Ticket) {
-                    // make sure ticket has an ID of setting relations won't work
-                    $TKT->save();
-                    $TKT           = $this->_update_ticket_datetimes($TKT, $saved_dtts, $dtts_added, $dtts_removed);
-                    $update_prices = true;
-                }
-            }
-            //make sure any current values have been saved.
-            //$TKT->save();
+			} else {
+				// no TKT_id so a new TKT
+				$TKT = EE_Ticket::new_instance(
+					$TKT_values,
+					$timezone,
+					array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
+				);
+				if ($TKT instanceof EE_Ticket) {
+					// make sure ticket has an ID of setting relations won't work
+					$TKT->save();
+					$TKT           = $this->_update_ticket_datetimes($TKT, $saved_dtts, $dtts_added, $dtts_removed);
+					$update_prices = true;
+				}
+			}
+			//make sure any current values have been saved.
+			//$TKT->save();
             
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
-            }
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
+			}
             
-            //let's make sure the base price is handled
-            $TKT = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $TKT, $update_prices, $base_price,
-                $base_price_id) : $TKT;
+			//let's make sure the base price is handled
+			$TKT = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $TKT, $update_prices, $base_price,
+				$base_price_id) : $TKT;
             
-            //add/update price_modifiers
-            $TKT = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $TKT, $update_prices) : $TKT;
+			//add/update price_modifiers
+			$TKT = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $TKT, $update_prices) : $TKT;
             
-            //need to make sue that the TKT_price is accurate after saving the prices.
-            $TKT->ensure_TKT_Price_correct();
+			//need to make sue that the TKT_price is accurate after saving the prices.
+			$TKT->ensure_TKT_Price_correct();
             
-            //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
-            if ( ! defined('DOING_AUTOSAVE')) {
-                if ( ! empty($tkt['TKT_is_default_selector'])) {
-                    $update_prices = true;
-                    $new_default   = clone $TKT;
-                    $new_default->set('TKT_ID', 0);
-                    $new_default->set('TKT_is_default', 1);
-                    $new_default->set('TKT_row', 1);
-                    $new_default->set('TKT_price', $ticket_price);
-                    //remove any dtt relations cause we DON'T want dtt relations attached (note this is just removing the cached relations in the object)
-                    $new_default->_remove_relations('Datetime');
-                    //todo we need to add the current attached prices as new prices to the new default ticket.
-                    $new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices);
-                    //don't forget the base price!
-                    $new_default = $this->_add_prices_to_ticket(array(), $new_default, $update_prices, $base_price,
-                        $base_price_id);
-                    $new_default->save();
-                    do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', $new_default,
-                        $row, $TKT, $data);
-                }
-            }
+			//handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
+			if ( ! defined('DOING_AUTOSAVE')) {
+				if ( ! empty($tkt['TKT_is_default_selector'])) {
+					$update_prices = true;
+					$new_default   = clone $TKT;
+					$new_default->set('TKT_ID', 0);
+					$new_default->set('TKT_is_default', 1);
+					$new_default->set('TKT_row', 1);
+					$new_default->set('TKT_price', $ticket_price);
+					//remove any dtt relations cause we DON'T want dtt relations attached (note this is just removing the cached relations in the object)
+					$new_default->_remove_relations('Datetime');
+					//todo we need to add the current attached prices as new prices to the new default ticket.
+					$new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices);
+					//don't forget the base price!
+					$new_default = $this->_add_prices_to_ticket(array(), $new_default, $update_prices, $base_price,
+						$base_price_id);
+					$new_default->save();
+					do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', $new_default,
+						$row, $TKT, $data);
+				}
+			}
             
             
-            //DO ALL dtt relationships for both current tickets and any archived tickets for the given dtt that are related to the current ticket. TODO... not sure exactly how we're going to do this considering we don't know what current ticket the archived tickets are related to (and TKT_parent is used for autosaves so that's not a field we can reliably use).
+			//DO ALL dtt relationships for both current tickets and any archived tickets for the given dtt that are related to the current ticket. TODO... not sure exactly how we're going to do this considering we don't know what current ticket the archived tickets are related to (and TKT_parent is used for autosaves so that's not a field we can reliably use).
             
             
-            //let's assign any tickets that have been setup to the saved_tickets tracker
-            //save existing TKT
-            $TKT->save();
-            if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
-                //save new TKT
-                $new_tkt->save();
-                //add new ticket to array
-                $saved_tickets[$new_tkt->ID()] = $new_tkt;
+			//let's assign any tickets that have been setup to the saved_tickets tracker
+			//save existing TKT
+			$TKT->save();
+			if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
+				//save new TKT
+				$new_tkt->save();
+				//add new ticket to array
+				$saved_tickets[$new_tkt->ID()] = $new_tkt;
                 
-                do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', $new_tkt, $row, $tkt, $data);
+				do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', $new_tkt, $row, $tkt, $data);
                 
-            } else {
-                //add tkt to saved tkts
-                $saved_tickets[$TKT->ID()] = $TKT;
+			} else {
+				//add tkt to saved tkts
+				$saved_tickets[$TKT->ID()] = $TKT;
                 
-                do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', $TKT, $row, $tkt, $data);
-            }
+				do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', $TKT, $row, $tkt, $data);
+			}
             
-        }
-        
-        // now we need to handle tickets actually "deleted permanently".
-        // There are cases where we'd want this to happen
-        // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
-        // Or a draft event was saved and in the process of editing a ticket is trashed.
-        // No sense in keeping all the related data in the db!
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
+		}
+        
+		// now we need to handle tickets actually "deleted permanently".
+		// There are cases where we'd want this to happen
+		// (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
+		// Or a draft event was saved and in the process of editing a ticket is trashed.
+		// No sense in keeping all the related data in the db!
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+        
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
             
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
             
-            //if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
-            if ($tkt_to_remove->get('TKT_is_default')) {
-                continue;
-            }
+			//if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
+			if ($tkt_to_remove->get('TKT_is_default')) {
+				continue;
+			}
             
-            // if this tkt has any registrations attached so then we just ARCHIVE
-            // because we don't actually permanently delete these tickets.
-            if ($tkt_to_remove->count_related('Registration') > 0) {
-                $tkt_to_remove->delete();
-                continue;
-            }
+			// if this tkt has any registrations attached so then we just ARCHIVE
+			// because we don't actually permanently delete these tickets.
+			if ($tkt_to_remove->count_related('Registration') > 0) {
+				$tkt_to_remove->delete();
+				continue;
+			}
             
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tkts_sold)
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tkts_sold)
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
             
-            foreach ($dtts as $dtt) {
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
-            }
+			foreach ($dtts as $dtt) {
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
+			}
             
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
             
-            do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
+			do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
             
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
         
-        return $saved_tickets;
-    }
+		return $saved_tickets;
+	}
     
     
-    /**
-     *
-     * @access  protected
-     *
-     * @param \EE_Ticket     $ticket
-     * @param \EE_Datetime[] $saved_datetimes
-     * @param \EE_Datetime[] $added_datetimes
-     * @param \EE_Datetime[] $removed_datetimes
-     *
-     * @return \EE_Ticket
-     * @throws \EE_Error
-     */
-    protected function _update_ticket_datetimes(
-        EE_Ticket $ticket,
-        $saved_datetimes = array(),
-        $added_datetimes = array(),
-        $removed_datetimes = array()
-    ) {
-        
-        // to start we have to add the ticket to all the datetimes its supposed to be with,
-        // and removing the ticket from datetimes it got removed from.
-        
-        // first let's add datetimes
-        if ( ! empty($added_datetimes) && is_array($added_datetimes)) {
-            foreach ($added_datetimes as $row_id) {
-                $row_id = (int)$row_id;
-                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
-                    $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to add that to the DTT sold because this DTT is getting added.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[$row_id]->increase_sold($ticket->sold());
-                        $saved_datetimes[$row_id]->save();
-                    }
-                }
-            }
-        }
-        // then remove datetimes
-        if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) {
-            foreach ($removed_datetimes as $row_id) {
-                $row_id = (int)$row_id;
-                // its entirely possible that a datetime got deleted (instead of just removed from relationship.
-                // So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
-                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
-                    $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to remove it's sold from the DTT_sold.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[$row_id]->decrease_sold($ticket->sold());
-                        $saved_datetimes[$row_id]->save();
-                    }
-                }
-            }
-        }
-        // cap ticket qty by datetime reg limits
-        $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-        
-        return $ticket;
-    }
+	/**
+	 *
+	 * @access  protected
+	 *
+	 * @param \EE_Ticket     $ticket
+	 * @param \EE_Datetime[] $saved_datetimes
+	 * @param \EE_Datetime[] $added_datetimes
+	 * @param \EE_Datetime[] $removed_datetimes
+	 *
+	 * @return \EE_Ticket
+	 * @throws \EE_Error
+	 */
+	protected function _update_ticket_datetimes(
+		EE_Ticket $ticket,
+		$saved_datetimes = array(),
+		$added_datetimes = array(),
+		$removed_datetimes = array()
+	) {
+        
+		// to start we have to add the ticket to all the datetimes its supposed to be with,
+		// and removing the ticket from datetimes it got removed from.
+        
+		// first let's add datetimes
+		if ( ! empty($added_datetimes) && is_array($added_datetimes)) {
+			foreach ($added_datetimes as $row_id) {
+				$row_id = (int)$row_id;
+				if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+					$ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to add that to the DTT sold because this DTT is getting added.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[$row_id]->increase_sold($ticket->sold());
+						$saved_datetimes[$row_id]->save();
+					}
+				}
+			}
+		}
+		// then remove datetimes
+		if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) {
+			foreach ($removed_datetimes as $row_id) {
+				$row_id = (int)$row_id;
+				// its entirely possible that a datetime got deleted (instead of just removed from relationship.
+				// So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
+				if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+					$ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to remove it's sold from the DTT_sold.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[$row_id]->decrease_sold($ticket->sold());
+						$saved_datetimes[$row_id]->save();
+					}
+				}
+			}
+		}
+		// cap ticket qty by datetime reg limits
+		$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+        
+		return $ticket;
+	}
     
     
-    /**
-     *
-     * @access  protected
-     *
-     * @param \EE_Ticket $ticket
-     * @param array      $price_rows
-     * @param int        $ticket_price
-     * @param int        $base_price
-     * @param int        $base_price_id
-     *
-     * @return \EE_Ticket
-     * @throws \EE_Error
-     */
-    protected function _duplicate_ticket(
-        EE_Ticket $ticket,
-        $price_rows = array(),
-        $ticket_price = 0,
-        $base_price = 0,
-        $base_price_id = 0
-    ) {
-        
-        // create new ticket that's a copy of the existing
-        // except a new id of course (and not archived)
-        // AND has the new TKT_price associated with it.
-        $new_ticket = clone $ticket;
-        $new_ticket->set('TKT_ID', 0);
-        $new_ticket->set('TKT_deleted', 0);
-        $new_ticket->set('TKT_price', $ticket_price);
-        $new_ticket->set('TKT_sold', 0);
-        // let's get a new ID for this ticket
-        $new_ticket->save();
-        // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
-        $datetimes_on_existing = $ticket->get_many_related('Datetime');
-        $new_ticket            = $this->_update_ticket_datetimes(
-            $new_ticket,
-            $datetimes_on_existing,
-            array_keys($datetimes_on_existing)
-        );
-        
-        // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
-        // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
-        // available.
-        if ($ticket->sold() > 0) {
-            $new_qty = $ticket->qty() - $ticket->sold();
-            $new_ticket->set_qty($new_qty);
-        }
-        //now we update the prices just for this ticket
-        $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
-        //and we update the base price
-        $new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id);
-        
-        return $new_ticket;
-    }
+	/**
+	 *
+	 * @access  protected
+	 *
+	 * @param \EE_Ticket $ticket
+	 * @param array      $price_rows
+	 * @param int        $ticket_price
+	 * @param int        $base_price
+	 * @param int        $base_price_id
+	 *
+	 * @return \EE_Ticket
+	 * @throws \EE_Error
+	 */
+	protected function _duplicate_ticket(
+		EE_Ticket $ticket,
+		$price_rows = array(),
+		$ticket_price = 0,
+		$base_price = 0,
+		$base_price_id = 0
+	) {
+        
+		// create new ticket that's a copy of the existing
+		// except a new id of course (and not archived)
+		// AND has the new TKT_price associated with it.
+		$new_ticket = clone $ticket;
+		$new_ticket->set('TKT_ID', 0);
+		$new_ticket->set('TKT_deleted', 0);
+		$new_ticket->set('TKT_price', $ticket_price);
+		$new_ticket->set('TKT_sold', 0);
+		// let's get a new ID for this ticket
+		$new_ticket->save();
+		// we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
+		$datetimes_on_existing = $ticket->get_many_related('Datetime');
+		$new_ticket            = $this->_update_ticket_datetimes(
+			$new_ticket,
+			$datetimes_on_existing,
+			array_keys($datetimes_on_existing)
+		);
+        
+		// $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
+		// if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
+		// available.
+		if ($ticket->sold() > 0) {
+			$new_qty = $ticket->qty() - $ticket->sold();
+			$new_ticket->set_qty($new_qty);
+		}
+		//now we update the prices just for this ticket
+		$new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
+		//and we update the base price
+		$new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id);
+        
+		return $new_ticket;
+	}
     
     
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     *
-     * @param array     $prices        Array of prices from the form.
-     * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
-     * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
-     * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
-     *
-     * @return EE_Ticket
-     */
-    protected function _add_prices_to_ticket(
-        $prices = array(),
-        EE_Ticket $ticket,
-        $new_prices = false,
-        $base_price = false,
-        $base_price_id = false
-    ) {
-        
-        //let's just get any current prices that may exist on the given ticket so we can remove any prices that got trashed in this session.
-        $current_prices_on_ticket = $base_price !== false ? $ticket->base_price(true) : $ticket->price_modifiers();
-        
-        $updated_prices = array();
-        
-        // if $base_price ! FALSE then updating a base price.
-        if ($base_price !== false) {
-            $prices[1] = array(
-                'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
-                'PRT_ID'     => 1,
-                'PRC_amount' => $base_price,
-                'PRC_name'   => $ticket->get('TKT_name'),
-                'PRC_desc'   => $ticket->get('TKT_description')
-            );
-        }
-        
-        //possibly need to save tkt
-        if ( ! $ticket->ID()) {
-            $ticket->save();
-        }
-        
-        foreach ($prices as $row => $prc) {
-            $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
-            if (empty($prt_id)) {
-                continue;
-            } //prices MUST have a price type id.
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => $prt_id,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => false,
-                //make sure we set PRC_is_default to false for all ticket saves from event_editor
-                'PRC_order'      => $row
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $PRC                  = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
-            } else {
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $newprc) {
-                    $PRC->set($field, $newprc);
-                }
-            }
-            $PRC->save();
-            $prcid                  = $PRC->ID();
-            $updated_prices[$prcid] = $PRC;
-            $ticket->_add_relation_to($PRC, 'Price');
-        }
-        
-        //now let's remove any prices that got removed from the ticket
-        if ( ! empty ($current_prices_on_ticket)) {
-            $current          = array_keys($current_prices_on_ticket);
-            $updated          = array_keys($updated_prices);
-            $prices_to_remove = array_diff($current, $updated);
-            if ( ! empty($prices_to_remove)) {
-                foreach ($prices_to_remove as $prc_id) {
-                    $p = $current_prices_on_ticket[$prc_id];
-                    $ticket->_remove_relation_to($p, 'Price');
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 *
+	 * @param array     $prices        Array of prices from the form.
+	 * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
+	 * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
+	 * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
+	 *
+	 * @return EE_Ticket
+	 */
+	protected function _add_prices_to_ticket(
+		$prices = array(),
+		EE_Ticket $ticket,
+		$new_prices = false,
+		$base_price = false,
+		$base_price_id = false
+	) {
+        
+		//let's just get any current prices that may exist on the given ticket so we can remove any prices that got trashed in this session.
+		$current_prices_on_ticket = $base_price !== false ? $ticket->base_price(true) : $ticket->price_modifiers();
+        
+		$updated_prices = array();
+        
+		// if $base_price ! FALSE then updating a base price.
+		if ($base_price !== false) {
+			$prices[1] = array(
+				'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
+				'PRT_ID'     => 1,
+				'PRC_amount' => $base_price,
+				'PRC_name'   => $ticket->get('TKT_name'),
+				'PRC_desc'   => $ticket->get('TKT_description')
+			);
+		}
+        
+		//possibly need to save tkt
+		if ( ! $ticket->ID()) {
+			$ticket->save();
+		}
+        
+		foreach ($prices as $row => $prc) {
+			$prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
+			if (empty($prt_id)) {
+				continue;
+			} //prices MUST have a price type id.
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => $prt_id,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => false,
+				//make sure we set PRC_is_default to false for all ticket saves from event_editor
+				'PRC_order'      => $row
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$PRC                  = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
+			} else {
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $newprc) {
+					$PRC->set($field, $newprc);
+				}
+			}
+			$PRC->save();
+			$prcid                  = $PRC->ID();
+			$updated_prices[$prcid] = $PRC;
+			$ticket->_add_relation_to($PRC, 'Price');
+		}
+        
+		//now let's remove any prices that got removed from the ticket
+		if ( ! empty ($current_prices_on_ticket)) {
+			$current          = array_keys($current_prices_on_ticket);
+			$updated          = array_keys($updated_prices);
+			$prices_to_remove = array_diff($current, $updated);
+			if ( ! empty($prices_to_remove)) {
+				foreach ($prices_to_remove as $prc_id) {
+					$p = $current_prices_on_ticket[$prc_id];
+					$ticket->_remove_relation_to($p, 'Price');
                     
-                    //delete permanently the price
-                    $p->delete_permanently();
-                }
-            }
-        }
-        
-        return $ticket;
-    }
+					//delete permanently the price
+					$p->delete_permanently();
+				}
+			}
+		}
+        
+		return $ticket;
+	}
     
     
-    public function autosave_handling($event_admin_obj)
-    {
-        return $event_admin_obj; //doing nothing for the moment.
-        //todo when I get to this remember that I need to set the template args on the $event_admin_obj (use the set_template_args() method)
-        
-        /**
-         * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
-         *
-         * 1. TKT_is_default_selector (visible)
-         * 2. TKT_is_default (hidden)
-         *
-         * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want this ticket to be saved as a default.
-         *
-         * The tricky part is, on an initial display on create or edit (or after manually updating), the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true if this is a create.  However, after an autosave, users will want some sort of indicator that the TKT HAS been saved as a default.. in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
-         * On Autosave:
-         * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, then set the TKT_is_default to false.
-         * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
-         * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
-         */
-    }
+	public function autosave_handling($event_admin_obj)
+	{
+		return $event_admin_obj; //doing nothing for the moment.
+		//todo when I get to this remember that I need to set the template args on the $event_admin_obj (use the set_template_args() method)
+        
+		/**
+		 * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
+		 *
+		 * 1. TKT_is_default_selector (visible)
+		 * 2. TKT_is_default (hidden)
+		 *
+		 * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want this ticket to be saved as a default.
+		 *
+		 * The tricky part is, on an initial display on create or edit (or after manually updating), the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true if this is a create.  However, after an autosave, users will want some sort of indicator that the TKT HAS been saved as a default.. in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
+		 * On Autosave:
+		 * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, then set the TKT_is_default to false.
+		 * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
+		 * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
+		 */
+	}
     
     
-    public function pricing_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
-        
-        $evtobj = $this->_adminpage_obj->get_cpt_model_obj();
-        
-        //set is_creating_event property.
-        $evtID                    = $evtobj->ID();
-        $this->_is_creating_event = absint($evtID) != 0 ? false : true;
-        
-        //default main template args
-        $main_template_args = array(
-            'event_datetime_help_link' => EEH_Template::get_help_tab_link('event_editor_event_datetimes_help_tab',
-                $this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
-            //todo need to add a filter to the template for the help text in the Events_Admin_Page core file so we can add further help
-            'existing_datetime_ids'    => '',
-            'total_dtt_rows'           => 1,
-            'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link('add_new_dtt_info',
-                $this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'datetime_rows'            => '',
-            'show_tickets_container'   => '',
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'ee_collapsible_status'    => ' ee-collapsible-open'
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
-        );
-        
-        $timezone = $evtobj instanceof EE_Event ? $evtobj->timezone_string() : null;
-        
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. For each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        
-        $DTM   = EE_Registry::instance()->load_model('Datetime', array($timezone));
-        $times = $DTM->get_all_event_dates($evtID);
-        
-        
-        $main_template_args['total_dtt_rows'] = count($times);
-        
-        /** @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 for why we are counting $dttrow and then setting that on the Datetime object */
-        $dttrow = 1;
-        foreach ($times as $time) {
-            $dttid = $time->get('DTT_ID');
-            $time->set('DTT_order', $dttrow);
-            $existing_datetime_ids[] = $dttid;
+	public function pricing_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
+        
+		$evtobj = $this->_adminpage_obj->get_cpt_model_obj();
+        
+		//set is_creating_event property.
+		$evtID                    = $evtobj->ID();
+		$this->_is_creating_event = absint($evtID) != 0 ? false : true;
+        
+		//default main template args
+		$main_template_args = array(
+			'event_datetime_help_link' => EEH_Template::get_help_tab_link('event_editor_event_datetimes_help_tab',
+				$this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
+			//todo need to add a filter to the template for the help text in the Events_Admin_Page core file so we can add further help
+			'existing_datetime_ids'    => '',
+			'total_dtt_rows'           => 1,
+			'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link('add_new_dtt_info',
+				$this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'datetime_rows'            => '',
+			'show_tickets_container'   => '',
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'ee_collapsible_status'    => ' ee-collapsible-open'
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
+		);
+        
+		$timezone = $evtobj instanceof EE_Event ? $evtobj->timezone_string() : null;
+        
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+        
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. For each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+        
+		$DTM   = EE_Registry::instance()->load_model('Datetime', array($timezone));
+		$times = $DTM->get_all_event_dates($evtID);
+        
+        
+		$main_template_args['total_dtt_rows'] = count($times);
+        
+		/** @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 for why we are counting $dttrow and then setting that on the Datetime object */
+		$dttrow = 1;
+		foreach ($times as $time) {
+			$dttid = $time->get('DTT_ID');
+			$time->set('DTT_order', $dttrow);
+			$existing_datetime_ids[] = $dttid;
             
-            //tickets attached
-            $related_tickets = $time->ID() > 0 ? $time->get_many_related('Ticket', array(
-                array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
-                'default_where_conditions' => 'none',
-                'order_by'                 => array('TKT_order' => 'ASC')
-            )) : array();
+			//tickets attached
+			$related_tickets = $time->ID() > 0 ? $time->get_many_related('Ticket', array(
+				array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
+				'default_where_conditions' => 'none',
+				'order_by'                 => array('TKT_order' => 'ASC')
+			)) : array();
             
-            //if there are no related tickets this is likely a new event OR autodraft
-            // event so we need to generate the default tickets because dtts
-            // ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
-            // datetime on the event.
-            if (empty ($related_tickets) && count($times) < 2) {
-                $related_tickets = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
+			//if there are no related tickets this is likely a new event OR autodraft
+			// event so we need to generate the default tickets because dtts
+			// ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
+			// datetime on the event.
+			if (empty ($related_tickets) && count($times) < 2) {
+				$related_tickets = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
                 
-                //this should be ordered by TKT_ID, so let's grab the first default ticket (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
-                $default_prices = EEM_Price::instance()->get_all_default_prices();
+				//this should be ordered by TKT_ID, so let's grab the first default ticket (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
+				$default_prices = EEM_Price::instance()->get_all_default_prices();
                 
-                $main_default_ticket = reset($related_tickets);
-                if ($main_default_ticket instanceof EE_Ticket) {
-                    foreach ($default_prices as $default_price) {
-                        if ($default_price->is_base_price()) {
-                            continue;
-                        }
-                        $main_default_ticket->cache('Price', $default_price);
-                    }
-                }
-            }
+				$main_default_ticket = reset($related_tickets);
+				if ($main_default_ticket instanceof EE_Ticket) {
+					foreach ($default_prices as $default_price) {
+						if ($default_price->is_base_price()) {
+							continue;
+						}
+						$main_default_ticket->cache('Price', $default_price);
+					}
+				}
+			}
             
             
-            //we can't actually setup rows in this loop yet cause we don't know all the unique tickets for this event yet (tickets are linked through all datetimes). So we're going to temporarily cache some of that information.
+			//we can't actually setup rows in this loop yet cause we don't know all the unique tickets for this event yet (tickets are linked through all datetimes). So we're going to temporarily cache some of that information.
             
-            //loop through and setup the ticket rows and make sure the order is set.
-            foreach ($related_tickets as $ticket) {
-                $tktid  = $ticket->get('TKT_ID');
-                $tktrow = $ticket->get('TKT_row');
-                //we only want unique tickets in our final display!!
-                if ( ! in_array($tktid, $existing_ticket_ids)) {
-                    $existing_ticket_ids[] = $tktid;
-                    $all_tickets[]         = $ticket;
-                }
+			//loop through and setup the ticket rows and make sure the order is set.
+			foreach ($related_tickets as $ticket) {
+				$tktid  = $ticket->get('TKT_ID');
+				$tktrow = $ticket->get('TKT_row');
+				//we only want unique tickets in our final display!!
+				if ( ! in_array($tktid, $existing_ticket_ids)) {
+					$existing_ticket_ids[] = $tktid;
+					$all_tickets[]         = $ticket;
+				}
                 
-                //temporary cache of this ticket info for this datetime for later processing of datetime rows.
-                $datetime_tickets[$dttid][] = $tktrow;
+				//temporary cache of this ticket info for this datetime for later processing of datetime rows.
+				$datetime_tickets[$dttid][] = $tktrow;
                 
-                //temporary cache of this datetime info for this ticket for later processing of ticket rows.
-                if ( ! isset($ticket_datetimes[$tktid]) || ! in_array($dttrow, $ticket_datetimes[$tktid])) {
-                    $ticket_datetimes[$tktid][] = $dttrow;
-                }
-            }
-            $dttrow++;
-        }
-        
-        $main_template_args['total_ticket_rows']     = count($existing_ticket_ids);
-        $main_template_args['existing_ticket_ids']   = implode(',', $existing_ticket_ids);
-        $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        
-        //sort $all_tickets by order
-        usort($all_tickets, function ($a, $b) {
-            $a_order = (int)$a->get('TKT_order');
-            $b_order = (int)$b->get('TKT_order');
-            if ($a_order == $b_order) {
-                return 0;
-            }
+				//temporary cache of this datetime info for this ticket for later processing of ticket rows.
+				if ( ! isset($ticket_datetimes[$tktid]) || ! in_array($dttrow, $ticket_datetimes[$tktid])) {
+					$ticket_datetimes[$tktid][] = $dttrow;
+				}
+			}
+			$dttrow++;
+		}
+        
+		$main_template_args['total_ticket_rows']     = count($existing_ticket_ids);
+		$main_template_args['existing_ticket_ids']   = implode(',', $existing_ticket_ids);
+		$main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+        
+		//sort $all_tickets by order
+		usort($all_tickets, function ($a, $b) {
+			$a_order = (int)$a->get('TKT_order');
+			$b_order = (int)$b->get('TKT_order');
+			if ($a_order == $b_order) {
+				return 0;
+			}
             
-            return ($a_order < $b_order) ? -1 : 1;
-        });
-        
-        //k NOW we have all the data we need for setting up the dtt rows and ticket rows so we start our dtt loop again.
-        $dttrow = 1;
-        foreach ($times as $time) {
-            $main_template_args['datetime_rows'] .= $this->_get_datetime_row($dttrow, $time, $datetime_tickets,
-                $all_tickets, false, $times);
-            $dttrow++;
-        }
-        
-        //then loop through all tickets for the ticket rows.
-        $tktrow = 1;
-        foreach ($all_tickets as $ticket) {
-            $main_template_args['ticket_rows'] .= $this->_get_ticket_row($tktrow, $ticket, $ticket_datetimes, $times,
-                false, $all_tickets);
-            $tktrow++;
-        }
-        
-        $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($times, $all_tickets);
-        $template                                  = PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php';
-        EEH_Template::display_template($template, $main_template_args);
-        
-        return;
-    }
+			return ($a_order < $b_order) ? -1 : 1;
+		});
+        
+		//k NOW we have all the data we need for setting up the dtt rows and ticket rows so we start our dtt loop again.
+		$dttrow = 1;
+		foreach ($times as $time) {
+			$main_template_args['datetime_rows'] .= $this->_get_datetime_row($dttrow, $time, $datetime_tickets,
+				$all_tickets, false, $times);
+			$dttrow++;
+		}
+        
+		//then loop through all tickets for the ticket rows.
+		$tktrow = 1;
+		foreach ($all_tickets as $ticket) {
+			$main_template_args['ticket_rows'] .= $this->_get_ticket_row($tktrow, $ticket, $ticket_datetimes, $times,
+				false, $all_tickets);
+			$tktrow++;
+		}
+        
+		$main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($times, $all_tickets);
+		$template                                  = PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php';
+		EEH_Template::display_template($template, $main_template_args);
+        
+		return;
+	}
     
     
-    protected function _get_datetime_row(
-        $dttrow,
-        EE_Datetime $dtt,
-        $datetime_tickets,
-        $all_tickets,
-        $default = false,
-        $all_dtts = array()
-    ) {
-        
-        $dtt_display_template_args = array(
-            'dtt_edit_row'             => $this->_get_dtt_edit_row($dttrow, $dtt, $default, $all_dtts),
-            'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row($dttrow, $dtt, $datetime_tickets,
-                $all_tickets, $default),
-            'dtt_row'                  => $default ? 'DTTNUM' : $dttrow
-        );
-        $template                  = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php';
-        
-        return EEH_Template::display_template($template, $dtt_display_template_args, true);
-    }
+	protected function _get_datetime_row(
+		$dttrow,
+		EE_Datetime $dtt,
+		$datetime_tickets,
+		$all_tickets,
+		$default = false,
+		$all_dtts = array()
+	) {
+        
+		$dtt_display_template_args = array(
+			'dtt_edit_row'             => $this->_get_dtt_edit_row($dttrow, $dtt, $default, $all_dtts),
+			'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row($dttrow, $dtt, $datetime_tickets,
+				$all_tickets, $default),
+			'dtt_row'                  => $default ? 'DTTNUM' : $dttrow
+		);
+		$template                  = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php';
+        
+		return EEH_Template::display_template($template, $dtt_display_template_args, true);
+	}
     
     
-    /**
-     * This method is used to generate a dtt fields  edit row.
-     * The same row is used to generate a row with valid DTT objects and the default row that is used as the
-     * skeleton by the js.
-     *
-     * @param int           $dttrow                         The row number for the row being generated.
-     * @param               mixed                           EE_Datetime|null $dtt      If not default row being
-     *                                                                       generated, this must be a EE_Datetime
-     *                                                                       object.
-     * @param bool          $default                        Whether a default row is being generated or not.
-     * @param EE_Datetime[] $all_dtts                       This is the array of all datetimes used in the editor.
-     *
-     * @return string Generated edit row.
-     */
-    protected function _get_dtt_edit_row($dttrow, $dtt, $default, $all_dtts)
-    {
-        
-        // if the incoming $dtt object is NOT an instance of EE_Datetime then force default to true.
-        $default = ! $dtt instanceof EE_Datetime ? true : false;
-        
-        $template_args = array(
-            'dtt_row'              => $default ? 'DTTNUM' : $dttrow,
-            'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'edit_dtt_expanded'    => '',
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? '' : ' ee-edit-editing',
-            'DTT_ID'               => $default ? '' : $dtt->ID(),
-            'DTT_name'             => $default ? '' : $dtt->name(),
-            'DTT_description'      => $default ? '' : $dtt->description(),
-            'DTT_EVT_start'        => $default ? '' : $dtt->start_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
-            'DTT_EVT_end'          => $default ? '' : $dtt->end_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
-            'DTT_reg_limit'        => $default ? '' : $dtt->get_pretty('DTT_reg_limit', 'input'),
-            'DTT_order'            => $default ? 'DTTNUM' : $dttrow,
-            'dtt_sold'             => $default ? '0' : $dtt->get('DTT_sold'),
-            'clone_icon'           => ! empty($dtt) && $dtt->get('DTT_sold') > 0 ? '' : 'clone-icon ee-icon ee-icon-clone clickable',
-            'trash_icon'           => ! empty($dtt) && $dtt->get('DTT_sold') > 0 ? 'ee-lock-icon' : 'trash-icon dashicons dashicons-post-trash clickable',
-            'reg_list_url'         => $default || ! $dtt->event() instanceof \EE_Event
-                ? ''
-                : EE_Admin_Page::add_query_args_and_nonce(
-                    array('event_id' => $dtt->event()->ID(), 'datetime_id' => $dtt->ID()),
-                    REG_ADMIN_URL
-                )
-        );
-        
-        $template_args['show_trash'] = count($all_dtts) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' ? ' style="display:none"' : '';
-        
-        //allow filtering of template args at this point.
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
-            $template_args, $dttrow, $dtt, $default, $all_dtts, $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	/**
+	 * This method is used to generate a dtt fields  edit row.
+	 * The same row is used to generate a row with valid DTT objects and the default row that is used as the
+	 * skeleton by the js.
+	 *
+	 * @param int           $dttrow                         The row number for the row being generated.
+	 * @param               mixed                           EE_Datetime|null $dtt      If not default row being
+	 *                                                                       generated, this must be a EE_Datetime
+	 *                                                                       object.
+	 * @param bool          $default                        Whether a default row is being generated or not.
+	 * @param EE_Datetime[] $all_dtts                       This is the array of all datetimes used in the editor.
+	 *
+	 * @return string Generated edit row.
+	 */
+	protected function _get_dtt_edit_row($dttrow, $dtt, $default, $all_dtts)
+	{
+        
+		// if the incoming $dtt object is NOT an instance of EE_Datetime then force default to true.
+		$default = ! $dtt instanceof EE_Datetime ? true : false;
+        
+		$template_args = array(
+			'dtt_row'              => $default ? 'DTTNUM' : $dttrow,
+			'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'edit_dtt_expanded'    => '',
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? '' : ' ee-edit-editing',
+			'DTT_ID'               => $default ? '' : $dtt->ID(),
+			'DTT_name'             => $default ? '' : $dtt->name(),
+			'DTT_description'      => $default ? '' : $dtt->description(),
+			'DTT_EVT_start'        => $default ? '' : $dtt->start_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+			'DTT_EVT_end'          => $default ? '' : $dtt->end_date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+			'DTT_reg_limit'        => $default ? '' : $dtt->get_pretty('DTT_reg_limit', 'input'),
+			'DTT_order'            => $default ? 'DTTNUM' : $dttrow,
+			'dtt_sold'             => $default ? '0' : $dtt->get('DTT_sold'),
+			'clone_icon'           => ! empty($dtt) && $dtt->get('DTT_sold') > 0 ? '' : 'clone-icon ee-icon ee-icon-clone clickable',
+			'trash_icon'           => ! empty($dtt) && $dtt->get('DTT_sold') > 0 ? 'ee-lock-icon' : 'trash-icon dashicons dashicons-post-trash clickable',
+			'reg_list_url'         => $default || ! $dtt->event() instanceof \EE_Event
+				? ''
+				: EE_Admin_Page::add_query_args_and_nonce(
+					array('event_id' => $dtt->event()->ID(), 'datetime_id' => $dtt->ID()),
+					REG_ADMIN_URL
+				)
+		);
+        
+		$template_args['show_trash'] = count($all_dtts) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' ? ' style="display:none"' : '';
+        
+		//allow filtering of template args at this point.
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
+			$template_args, $dttrow, $dtt, $default, $all_dtts, $this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_dtt_attached_tickets_row($dttrow, $dtt, $datetime_tickets, $all_tickets, $default)
-    {
-        
-        $template_args = array(
-            'dtt_row'                           => $default ? 'DTTNUM' : $dttrow,
-            'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'DTT_description'                   => $default ? '' : $dtt->description(),
-            'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
-            'show_tickets_row'                  => ' style="display:none;"',
-            //$default || $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' style="display:none;"' : '',
-            'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link('add_new_ticket_via_datetime',
-                $this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'DTT_ID'                            => $default ? '' : $dtt->ID()
-        );
-        
-        //need to setup the list items (but only if this isnt' a default skeleton setup)
-        if ( ! $default) {
-            $tktrow = 1;
-            foreach ($all_tickets as $ticket) {
-                $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item($dttrow, $tktrow,
-                    $dtt, $ticket, $datetime_tickets, $default);
-                $tktrow++;
-            }
-        }
-        
-        //filter template args at this point
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
-            $template_args, $dttrow, $dtt, $datetime_tickets, $all_tickets, $default, $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_dtt_attached_tickets_row($dttrow, $dtt, $datetime_tickets, $all_tickets, $default)
+	{
+        
+		$template_args = array(
+			'dtt_row'                           => $default ? 'DTTNUM' : $dttrow,
+			'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'DTT_description'                   => $default ? '' : $dtt->description(),
+			'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
+			'show_tickets_row'                  => ' style="display:none;"',
+			//$default || $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' style="display:none;"' : '',
+			'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link('add_new_ticket_via_datetime',
+				$this->_adminpage_obj->page_slug, $this->_adminpage_obj->get_req_action(), false, false),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'DTT_ID'                            => $default ? '' : $dtt->ID()
+		);
+        
+		//need to setup the list items (but only if this isnt' a default skeleton setup)
+		if ( ! $default) {
+			$tktrow = 1;
+			foreach ($all_tickets as $ticket) {
+				$template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item($dttrow, $tktrow,
+					$dtt, $ticket, $datetime_tickets, $default);
+				$tktrow++;
+			}
+		}
+        
+		//filter template args at this point
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
+			$template_args, $dttrow, $dtt, $datetime_tickets, $all_tickets, $default, $this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_datetime_tickets_list_item($dttrow, $tktrow, $dtt, $ticket, $datetime_tickets, $default)
-    {
-        $tktid    = ! empty($ticket) ? $ticket->ID() : 0;
-        $dtt_tkts = $dtt instanceof EE_Datetime && isset($datetime_tickets[$dtt->ID()]) ? $datetime_tickets[$dtt->ID()] : array();
-        
-        $displayrow    = ! empty($ticket) ? $ticket->get('TKT_row') : 0;
-        $template_args = array(
-            'dtt_row'                 => $default ? 'DTTNUM' : $dttrow,
-            'tkt_row'                 => $default && empty($ticket) ? 'TICKETNUM' : $tktrow,
-            'datetime_ticket_checked' => in_array($displayrow, $dtt_tkts) ? ' checked="checked"' : '',
-            'ticket_selected'         => in_array($displayrow, $dtt_tkts) ? ' ticket-selected' : '',
-            'TKT_name'                => $default && empty($ticket) ? 'TKTNAME' : $ticket->get('TKT_name'),
-            'tkt_status_class'        => ($default && empty($ticket)) || $this->_is_creating_event ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status(),
-        );
-        
-        //filter template args
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
-            $template_args, $dttrow, $tktrow, $dtt, $ticket, $datetime_tickets, $default, $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_datetime_tickets_list_item($dttrow, $tktrow, $dtt, $ticket, $datetime_tickets, $default)
+	{
+		$tktid    = ! empty($ticket) ? $ticket->ID() : 0;
+		$dtt_tkts = $dtt instanceof EE_Datetime && isset($datetime_tickets[$dtt->ID()]) ? $datetime_tickets[$dtt->ID()] : array();
+        
+		$displayrow    = ! empty($ticket) ? $ticket->get('TKT_row') : 0;
+		$template_args = array(
+			'dtt_row'                 => $default ? 'DTTNUM' : $dttrow,
+			'tkt_row'                 => $default && empty($ticket) ? 'TICKETNUM' : $tktrow,
+			'datetime_ticket_checked' => in_array($displayrow, $dtt_tkts) ? ' checked="checked"' : '',
+			'ticket_selected'         => in_array($displayrow, $dtt_tkts) ? ' ticket-selected' : '',
+			'TKT_name'                => $default && empty($ticket) ? 'TKTNAME' : $ticket->get('TKT_name'),
+			'tkt_status_class'        => ($default && empty($ticket)) || $this->_is_creating_event ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status(),
+		);
+        
+		//filter template args
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
+			$template_args, $dttrow, $tktrow, $dtt, $ticket, $datetime_tickets, $default, $this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    /**
-     * This generates the ticket row for tickets.
-     * This same method is used to generate both the actual rows and the js skeleton row (when default ==
-     * true)
-     *
-     * @param int           $tktrow                          Represents the row number being generated.
-     * @param               mixed                            null|EE_Ticket $ticket           If default then this will
-     *                                                                      be null.
-     * @param EE_Datetime[] $ticket_datetimes                Either an array of all datetimes on all tickets indexed by
-     *                                                       each ticket or empty for  default
-     * @param EE_Datetime[] $all_dtts                        All Datetimes on the event or empty for default.
-     * @param bool          $default                         Whether default row being generated or not.
-     * @param EE_Ticket[]   $all_tickets                     This is an array of all tickets attached to the event (or
-     *                                                       empty in the case of defaults)
-     *
-     * @return [type] [description]
-     */
-    protected function _get_ticket_row(
-        $tktrow,
-        $ticket,
-        $ticket_datetimes,
-        $all_dtts,
-        $default = false,
-        $all_tickets = array()
-    ) {
-        
-        //if $ticket is not an instance of EE_Ticket then force default to true.
-        $default = ! $ticket instanceof EE_Ticket ? true : false;
-        
-        $prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
-            array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
-        
-        //if there is only one price (which would be the base price) or NO prices and this ticket is a default ticket, let's just make sure there are no cached default prices on
-        //the object.  This is done by not including any query_params.
-        if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
-            $prices = $ticket->get_many_related('Price');
-        }
-        
-        // check if we're dealing with a default ticket in which case we don't want any starting_ticket_datetime_row values set (otherwise there won't be any new relationships created for tickets based off of the default ticket).  This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
-        $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->get('TKT_is_default')) ? true : false;
-        
-        $tkt_dtts = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) ? $ticket_datetimes[$ticket->ID()] : array();
-        
-        $ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
-        $base_price       = $default ? null : $ticket->base_price();
-        $count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
-        
-        //breaking out complicated condition for ticket_status
-        if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
-        } else {
-            $ticket_status_class = $ticket->is_default() ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status();
-        }
-        
-        //breaking out complicated condition for TKT_taxable
-        if ($default) {
-            $TKT_taxable = '';
-        } else {
-            $TKT_taxable = $ticket->get('TKT_taxable') ? ' checked="checked"' : '';
-        }
+	/**
+	 * This generates the ticket row for tickets.
+	 * This same method is used to generate both the actual rows and the js skeleton row (when default ==
+	 * true)
+	 *
+	 * @param int           $tktrow                          Represents the row number being generated.
+	 * @param               mixed                            null|EE_Ticket $ticket           If default then this will
+	 *                                                                      be null.
+	 * @param EE_Datetime[] $ticket_datetimes                Either an array of all datetimes on all tickets indexed by
+	 *                                                       each ticket or empty for  default
+	 * @param EE_Datetime[] $all_dtts                        All Datetimes on the event or empty for default.
+	 * @param bool          $default                         Whether default row being generated or not.
+	 * @param EE_Ticket[]   $all_tickets                     This is an array of all tickets attached to the event (or
+	 *                                                       empty in the case of defaults)
+	 *
+	 * @return [type] [description]
+	 */
+	protected function _get_ticket_row(
+		$tktrow,
+		$ticket,
+		$ticket_datetimes,
+		$all_dtts,
+		$default = false,
+		$all_tickets = array()
+	) {
+        
+		//if $ticket is not an instance of EE_Ticket then force default to true.
+		$default = ! $ticket instanceof EE_Ticket ? true : false;
+        
+		$prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
+			array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
+        
+		//if there is only one price (which would be the base price) or NO prices and this ticket is a default ticket, let's just make sure there are no cached default prices on
+		//the object.  This is done by not including any query_params.
+		if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
+			$prices = $ticket->get_many_related('Price');
+		}
+        
+		// check if we're dealing with a default ticket in which case we don't want any starting_ticket_datetime_row values set (otherwise there won't be any new relationships created for tickets based off of the default ticket).  This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
+		$default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->get('TKT_is_default')) ? true : false;
+        
+		$tkt_dtts = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) ? $ticket_datetimes[$ticket->ID()] : array();
+        
+		$ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
+		$base_price       = $default ? null : $ticket->base_price();
+		$count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
+        
+		//breaking out complicated condition for ticket_status
+		if ($default) {
+			$ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+		} else {
+			$ticket_status_class = $ticket->is_default() ? ' tkt-status-' . EE_Ticket::onsale : ' tkt-status-' . $ticket->ticket_status();
+		}
+        
+		//breaking out complicated condition for TKT_taxable
+		if ($default) {
+			$TKT_taxable = '';
+		} else {
+			$TKT_taxable = $ticket->get('TKT_taxable') ? ' checked="checked"' : '';
+		}
 
         
-        $template_args = array(
-            'tkt_row'                       => $default ? 'TICKETNUM' : $tktrow,
-            'TKT_order'                     => $default ? 'TICKETNUM' : $tktrow,
-            //on initial page load this will always be the correct order.
-            'tkt_status_class'              => $ticket_status_class,
-            'display_edit_tkt_row'          => ' style="display:none;"',
-            'edit_tkt_expanded'             => '',
-            'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_name'                      => $default ? '' : $ticket->get('TKT_name'),
-            'TKT_start_date'                => $default ? '' : $ticket->get_date('TKT_start_date',
-                $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
-            'TKT_end_date'                  => $default ? '' : $ticket->get_date('TKT_end_date',
-                $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
-            'TKT_status'                    => $default ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
-                'sentence') : $ticket->is_default() ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
-                'sentence') : $ticket->ticket_status(true),
-            'TKT_price'                     => $default ? '' : EEH_Template::format_currency($ticket->get_ticket_total_with_taxes(),
-                false, false),
-            'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
-            'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
-            'TKT_qty'                       => $default ? '' : $ticket->get_pretty('TKT_qty', 'symbol'),
-            'TKT_qty_for_input'             => $default ? '' : $ticket->get_pretty('TKT_qty', 'input'),
-            'TKT_uses'                      => $default ? '' : $ticket->get_pretty('TKT_uses', 'input'),
-            'TKT_min'                       => $default ? '' : ($ticket->get('TKT_min') === -1 || $ticket->get('TKT_min') === 0 ? '' : $ticket->get('TKT_min')),
-            'TKT_max'                       => $default ? '' : $ticket->get_pretty('TKT_max', 'input'),
-            'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
-            'TKT_registrations'             => $default ? 0 : $ticket->count_registrations(array(
-                array(
-                    'STS_ID' => array(
-                        '!=',
-                        EEM_Registration::status_id_incomplete
-                    )
-                )
-            )),
-            'TKT_ID'                        => $default ? 0 : $ticket->get('TKT_ID'),
-            'TKT_description'               => $default ? '' : $ticket->get('TKT_description'),
-            'TKT_is_default'                => $default ? 0 : $ticket->get('TKT_is_default'),
-            'TKT_required'                  => $default ? 0 : $ticket->required(),
-            'TKT_is_default_selector'       => '',
-            'ticket_price_rows'             => '',
-            'TKT_base_price'                => $default || ! $base_price instanceof EE_Price ? '' : $base_price->get_pretty('PRC_amount',
-                'localized_float'),
-            'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
-            'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0) ? '' : ' style="display:none;"',
-            'show_price_mod_button'         => count($prices) > 1 || ($default && $count_price_mods > 0) || ( ! $default && $ticket->get('TKT_deleted')) ? ' style="display:none;"' : '',
-            'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
-            'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
-            'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_dtts),
-            'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_dtts),
-            'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
-            'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
-            'TKT_taxable'                   => $TKT_taxable,
-            'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->get('TKT_taxable') ? '' : ' style="display:none"',
-            'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
-            'TKT_subtotal_amount_display'   => EEH_Template::format_currency($ticket_subtotal, false, false),
-            'TKT_subtotal_amount'           => $ticket_subtotal,
-            'tax_rows'                      => $this->_get_tax_rows($tktrow, $ticket),
-            'disabled'                      => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? true : false,
-            'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? ' ticket-archived' : '',
-            'trash_icon'                    => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? 'ee-lock-icon ' : 'trash-icon dashicons dashicons-post-trash clickable',
-            'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? '' : 'clone-icon ee-icon ee-icon-clone clickable'
-        );
-        
-        $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] != 'ee-lock-icon' ? ' style="display:none"' : '';
-        
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date']   = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
-                current_time('timestamp'));
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        
-        if (empty($template_args['TKT_end_date'])) {
+		$template_args = array(
+			'tkt_row'                       => $default ? 'TICKETNUM' : $tktrow,
+			'TKT_order'                     => $default ? 'TICKETNUM' : $tktrow,
+			//on initial page load this will always be the correct order.
+			'tkt_status_class'              => $ticket_status_class,
+			'display_edit_tkt_row'          => ' style="display:none;"',
+			'edit_tkt_expanded'             => '',
+			'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_name'                      => $default ? '' : $ticket->get('TKT_name'),
+			'TKT_start_date'                => $default ? '' : $ticket->get_date('TKT_start_date',
+				$this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+			'TKT_end_date'                  => $default ? '' : $ticket->get_date('TKT_end_date',
+				$this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']),
+			'TKT_status'                    => $default ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
+				'sentence') : $ticket->is_default() ? EEH_Template::pretty_status(EE_Ticket::onsale, false,
+				'sentence') : $ticket->ticket_status(true),
+			'TKT_price'                     => $default ? '' : EEH_Template::format_currency($ticket->get_ticket_total_with_taxes(),
+				false, false),
+			'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
+			'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
+			'TKT_qty'                       => $default ? '' : $ticket->get_pretty('TKT_qty', 'symbol'),
+			'TKT_qty_for_input'             => $default ? '' : $ticket->get_pretty('TKT_qty', 'input'),
+			'TKT_uses'                      => $default ? '' : $ticket->get_pretty('TKT_uses', 'input'),
+			'TKT_min'                       => $default ? '' : ($ticket->get('TKT_min') === -1 || $ticket->get('TKT_min') === 0 ? '' : $ticket->get('TKT_min')),
+			'TKT_max'                       => $default ? '' : $ticket->get_pretty('TKT_max', 'input'),
+			'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
+			'TKT_registrations'             => $default ? 0 : $ticket->count_registrations(array(
+				array(
+					'STS_ID' => array(
+						'!=',
+						EEM_Registration::status_id_incomplete
+					)
+				)
+			)),
+			'TKT_ID'                        => $default ? 0 : $ticket->get('TKT_ID'),
+			'TKT_description'               => $default ? '' : $ticket->get('TKT_description'),
+			'TKT_is_default'                => $default ? 0 : $ticket->get('TKT_is_default'),
+			'TKT_required'                  => $default ? 0 : $ticket->required(),
+			'TKT_is_default_selector'       => '',
+			'ticket_price_rows'             => '',
+			'TKT_base_price'                => $default || ! $base_price instanceof EE_Price ? '' : $base_price->get_pretty('PRC_amount',
+				'localized_float'),
+			'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
+			'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0) ? '' : ' style="display:none;"',
+			'show_price_mod_button'         => count($prices) > 1 || ($default && $count_price_mods > 0) || ( ! $default && $ticket->get('TKT_deleted')) ? ' style="display:none;"' : '',
+			'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
+			'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
+			'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_dtts),
+			'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_dtts),
+			'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
+			'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
+			'TKT_taxable'                   => $TKT_taxable,
+			'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->get('TKT_taxable') ? '' : ' style="display:none"',
+			'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
+			'TKT_subtotal_amount_display'   => EEH_Template::format_currency($ticket_subtotal, false, false),
+			'TKT_subtotal_amount'           => $ticket_subtotal,
+			'tax_rows'                      => $this->_get_tax_rows($tktrow, $ticket),
+			'disabled'                      => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? true : false,
+			'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? ' ticket-archived' : '',
+			'trash_icon'                    => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? 'ee-lock-icon ' : 'trash-icon dashicons dashicons-post-trash clickable',
+			'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->get('TKT_deleted') ? '' : 'clone-icon ee-icon ee-icon-clone clickable'
+		);
+        
+		$template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] != 'ee-lock-icon' ? ' style="display:none"' : '';
+        
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date']   = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
+				current_time('timestamp'));
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+        
+		if (empty($template_args['TKT_end_date'])) {
             
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related('Datetime',
-                array('order_by' => array('DTT_EVT_start' => 'ASC'))) : null;
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related('Datetime',
+				array('order_by' => array('DTT_EVT_start' => 'ASC'))) : null;
             
-            if ( ! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start',
-                    $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
-            } else {
-                //default so let's just use what's been set for the default date-time which is 30 days from now.
-                $template_args['TKT_end_date'] = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
-                    mktime(24, 0, 0, date("m"), date("d") + 29, date("Y")));
-            }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        
-        //generate ticket_datetime items
-        if ( ! $default) {
-            $dttrow = 1;
-            foreach ($all_dtts as $dtt) {
-                $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item($dttrow, $tktrow, $dtt,
-                    $ticket, $ticket_datetimes, $default);
-                $dttrow++;
-            }
-        }
-        
-        $prcrow = 1;
-        foreach ($prices as $price) {
-            if ($price->is_base_price()) {
-                $prcrow++;
-                continue;
-            }
-            $show_trash  = (count($prices) > 1 && $prcrow === 1) || count($prices) === 1 ? false : true;
-            $show_create = count($prices) > 1 && count($prices) !== $prcrow ? false : true;
-            $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row($tktrow, $prcrow, $price, $default,
-                $ticket, $show_trash, $show_create);
-            $prcrow++;
-        }
-        
-        //filter $template_args
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
-            $template_args, $tktrow, $ticket, $ticket_datetimes, $all_dtts, $default, $all_tickets,
-            $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+			if ( ! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start',
+					$this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']);
+			} else {
+				//default so let's just use what's been set for the default date-time which is 30 days from now.
+				$template_args['TKT_end_date'] = date($this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'],
+					mktime(24, 0, 0, date("m"), date("d") + 29, date("Y")));
+			}
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+        
+		//generate ticket_datetime items
+		if ( ! $default) {
+			$dttrow = 1;
+			foreach ($all_dtts as $dtt) {
+				$template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item($dttrow, $tktrow, $dtt,
+					$ticket, $ticket_datetimes, $default);
+				$dttrow++;
+			}
+		}
+        
+		$prcrow = 1;
+		foreach ($prices as $price) {
+			if ($price->is_base_price()) {
+				$prcrow++;
+				continue;
+			}
+			$show_trash  = (count($prices) > 1 && $prcrow === 1) || count($prices) === 1 ? false : true;
+			$show_create = count($prices) > 1 && count($prices) !== $prcrow ? false : true;
+			$template_args['ticket_price_rows'] .= $this->_get_ticket_price_row($tktrow, $prcrow, $price, $default,
+				$ticket, $show_trash, $show_create);
+			$prcrow++;
+		}
+        
+		//filter $template_args
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
+			$template_args, $tktrow, $ticket, $ticket_datetimes, $all_dtts, $default, $all_tickets,
+			$this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_tax_rows($tktrow, $ticket)
-    {
-        $tax_rows      = '';
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php';
-        $template_args = array();
-        $taxes         = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
-        foreach ($taxes as $tax) {
-            $tax_added     = $this->_get_tax_added($tax, $ticket);
-            $template_args = array(
-                'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable') ? '' : ' style="display:none;"',
-                'tax_id'            => $tax->ID(),
-                'tkt_row'           => $tktrow,
-                'tax_label'         => $tax->get('PRC_name'),
-                'tax_added'         => $tax_added,
-                'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
-                'tax_amount'        => $tax->get('PRC_amount')
-            );
-            $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
-                $template_args, $tktrow, $ticket, $this->_is_creating_event);
-            $tax_rows .= EEH_Template::display_template($template, $template_args, true);
-        }
-        
-        
-        return $tax_rows;
-    }
+	protected function _get_tax_rows($tktrow, $ticket)
+	{
+		$tax_rows      = '';
+		$template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php';
+		$template_args = array();
+		$taxes         = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
+		foreach ($taxes as $tax) {
+			$tax_added     = $this->_get_tax_added($tax, $ticket);
+			$template_args = array(
+				'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable') ? '' : ' style="display:none;"',
+				'tax_id'            => $tax->ID(),
+				'tkt_row'           => $tktrow,
+				'tax_label'         => $tax->get('PRC_name'),
+				'tax_added'         => $tax_added,
+				'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
+				'tax_amount'        => $tax->get('PRC_amount')
+			);
+			$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
+				$template_args, $tktrow, $ticket, $this->_is_creating_event);
+			$tax_rows .= EEH_Template::display_template($template, $template_args, true);
+		}
+        
+        
+		return $tax_rows;
+	}
     
     
-    protected function _get_tax_added(EE_Price $tax, $ticket)
-    {
-        $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
+	protected function _get_tax_added(EE_Price $tax, $ticket)
+	{
+		$subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
         
-        return $subtotal * $tax->get('PRC_amount') / 100;
-    }
+		return $subtotal * $tax->get('PRC_amount') / 100;
+	}
     
     
-    protected function _get_ticket_price_row(
-        $tktrow,
-        $prcrow,
-        $price,
-        $default,
-        $ticket,
-        $show_trash = true,
-        $show_create = true
-    ) {
-        $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted') ? true : false;
-        $template_args = array(
-            'tkt_row'               => $default && empty($ticket) ? 'TICKETNUM' : $tktrow,
-            'PRC_order'             => $default && empty($price) ? 'PRICENUM' : $prcrow,
-            'edit_prices_name'      => $default && empty($price) ? 'PRICENAMEATTR' : 'edit_prices',
-            'price_type_selector'   => $default && empty($price) ? $this->_get_base_price_template($tktrow, $prcrow,
-                $price, $default) : $this->_get_price_type_selector($tktrow, $prcrow, $price, $default, $send_disabled),
-            'PRC_ID'                => $default && empty($price) ? 0 : $price->ID(),
-            'PRC_is_default'        => $default && empty($price) ? 0 : $price->get('PRC_is_default'),
-            'PRC_name'              => $default && empty($price) ? '' : $price->get('PRC_name'),
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'show_plus_or_minus'    => $default && empty($price) ? '' : ' style="display:none;"',
-            'show_plus'             => $default && empty($price) ? ' style="display:none;"' : ($price->is_discount() || $price->is_base_price() ? ' style="display:none;"' : ''),
-            'show_minus'            => $default && empty($price) ? ' style="display:none;"' : ($price->is_discount() ? '' : ' style="display:none;"'),
-            'show_currency_symbol'  => $default && empty($price) ? ' style="display:none"' : ($price->is_percent() ? ' style="display:none"' : ''),
-            'PRC_amount'            => $default && empty($price) ? 0 : $price->get_pretty('PRC_amount',
-                'localized_float'),
-            'show_percentage'       => $default && empty($price) ? ' style="display:none;"' : ($price->is_percent() ? '' : ' style="display:none;"'),
-            'show_trash_icon'       => $show_trash ? '' : ' style="display:none;"',
-            'show_create_button'    => $show_create ? '' : ' style="display:none;"',
-            'PRC_desc'              => $default && empty($price) ? '' : $price->get('PRC_desc'),
-            'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted') ? true : false
-        );
-        
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
-            $template_args, $tktrow, $prcrow, $price, $default, $ticket, $show_trash, $show_create,
-            $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_ticket_price_row(
+		$tktrow,
+		$prcrow,
+		$price,
+		$default,
+		$ticket,
+		$show_trash = true,
+		$show_create = true
+	) {
+		$send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted') ? true : false;
+		$template_args = array(
+			'tkt_row'               => $default && empty($ticket) ? 'TICKETNUM' : $tktrow,
+			'PRC_order'             => $default && empty($price) ? 'PRICENUM' : $prcrow,
+			'edit_prices_name'      => $default && empty($price) ? 'PRICENAMEATTR' : 'edit_prices',
+			'price_type_selector'   => $default && empty($price) ? $this->_get_base_price_template($tktrow, $prcrow,
+				$price, $default) : $this->_get_price_type_selector($tktrow, $prcrow, $price, $default, $send_disabled),
+			'PRC_ID'                => $default && empty($price) ? 0 : $price->ID(),
+			'PRC_is_default'        => $default && empty($price) ? 0 : $price->get('PRC_is_default'),
+			'PRC_name'              => $default && empty($price) ? '' : $price->get('PRC_name'),
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'show_plus_or_minus'    => $default && empty($price) ? '' : ' style="display:none;"',
+			'show_plus'             => $default && empty($price) ? ' style="display:none;"' : ($price->is_discount() || $price->is_base_price() ? ' style="display:none;"' : ''),
+			'show_minus'            => $default && empty($price) ? ' style="display:none;"' : ($price->is_discount() ? '' : ' style="display:none;"'),
+			'show_currency_symbol'  => $default && empty($price) ? ' style="display:none"' : ($price->is_percent() ? ' style="display:none"' : ''),
+			'PRC_amount'            => $default && empty($price) ? 0 : $price->get_pretty('PRC_amount',
+				'localized_float'),
+			'show_percentage'       => $default && empty($price) ? ' style="display:none;"' : ($price->is_percent() ? '' : ' style="display:none;"'),
+			'show_trash_icon'       => $show_trash ? '' : ' style="display:none;"',
+			'show_create_button'    => $show_create ? '' : ' style="display:none;"',
+			'PRC_desc'              => $default && empty($price) ? '' : $price->get('PRC_desc'),
+			'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted') ? true : false
+		);
+        
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
+			$template_args, $tktrow, $prcrow, $price, $default, $ticket, $show_trash, $show_create,
+			$this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_price_type_selector($tktrow, $prcrow, $price, $default, $disabled = false)
-    {
-        if ($price->is_base_price()) {
-            return $this->_get_base_price_template($tktrow, $prcrow, $price, $default);
-        } else {
-            return $this->_get_price_modifier_template($tktrow, $prcrow, $price, $default, $disabled);
-        }
-        
-    }
+	protected function _get_price_type_selector($tktrow, $prcrow, $price, $default, $disabled = false)
+	{
+		if ($price->is_base_price()) {
+			return $this->_get_base_price_template($tktrow, $prcrow, $price, $default);
+		} else {
+			return $this->_get_price_modifier_template($tktrow, $prcrow, $price, $default, $disabled);
+		}
+        
+	}
     
     
-    protected function _get_base_price_template($tktrow, $prcrow, $price, $default)
-    {
-        $template_args = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $tktrow,
-            'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $prcrow,
-            'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
-            'PRT_name'                  => __('Price', 'event_espresso'),
-            'price_selected_operator'   => '+',
-            'price_selected_is_percent' => 0
-        );
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php';
-        
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
-            $template_args, $tktrow, $prcrow, $price, $default, $this->_is_creating_event);
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_base_price_template($tktrow, $prcrow, $price, $default)
+	{
+		$template_args = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $tktrow,
+			'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $prcrow,
+			'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
+			'PRT_name'                  => __('Price', 'event_espresso'),
+			'price_selected_operator'   => '+',
+			'price_selected_is_percent' => 0
+		);
+		$template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php';
+        
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
+			$template_args, $tktrow, $prcrow, $price, $default, $this->_is_creating_event);
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_price_modifier_template($tktrow, $prcrow, $price, $default, $disabled = false)
-    {
-        $select_name                = $default && empty($price) ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' : 'edit_prices[' . $tktrow . '][' . $prcrow . '][PRT_ID]';
-        $price_types                = EE_Registry::instance()->load_model('Price_Type')->get_all(array(
-            array(
-                'OR' => array(
-                    'PBT_ID'  => '2',
-                    'PBT_ID*' => '3'
-                )
-            )
-        ));
-        $price_option_span_template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php';
-        $all_price_types            = $default && empty($price) ? array(
-            array(
-                'id'   => 0,
-                'text' => __('Select Modifier', 'event_espresso')
-            )
-        ) : array();
-        $selected_price_type_id     = $default && empty($price) ? 0 : $price->type();
-        $price_option_spans         = '';
-        //setup pricetypes for selector
-        foreach ($price_types as $price_type) {
-            $all_price_types[] = array(
-                'id'   => $price_type->ID(),
-                'text' => $price_type->get('PRT_name'),
-            );
+	protected function _get_price_modifier_template($tktrow, $prcrow, $price, $default, $disabled = false)
+	{
+		$select_name                = $default && empty($price) ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' : 'edit_prices[' . $tktrow . '][' . $prcrow . '][PRT_ID]';
+		$price_types                = EE_Registry::instance()->load_model('Price_Type')->get_all(array(
+			array(
+				'OR' => array(
+					'PBT_ID'  => '2',
+					'PBT_ID*' => '3'
+				)
+			)
+		));
+		$price_option_span_template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php';
+		$all_price_types            = $default && empty($price) ? array(
+			array(
+				'id'   => 0,
+				'text' => __('Select Modifier', 'event_espresso')
+			)
+		) : array();
+		$selected_price_type_id     = $default && empty($price) ? 0 : $price->type();
+		$price_option_spans         = '';
+		//setup pricetypes for selector
+		foreach ($price_types as $price_type) {
+			$all_price_types[] = array(
+				'id'   => $price_type->ID(),
+				'text' => $price_type->get('PRT_name'),
+			);
             
-            //while we're in the loop let's setup the option spans used by js
-            $spanargs = array(
-                'PRT_ID'         => $price_type->ID(),
-                'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
-                'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0
-            );
-            $price_option_spans .= EEH_Template::display_template($price_option_span_template, $spanargs, true);
-        }
-        
-        $select_params = $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"';
-        $main_name     = $select_name;
-        $select_name   = $disabled ? 'archive_price[' . $tktrow . '][' . $prcrow . '][PRT_ID]' : $main_name;
-        
-        $template_args = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $tktrow,
-            'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $prcrow,
-            'price_modifier_selector'   => EEH_Form_Fields::select_input($select_name, $all_price_types,
-                $selected_price_type_id, $select_params, 'edit-price-PRT_ID'),
-            'main_name'                 => $main_name,
-            'selected_price_type_id'    => $selected_price_type_id,
-            'price_option_spans'        => $price_option_spans,
-            'price_selected_operator'   => $default && empty($price) ? '' : ($price->is_discount() ? '-' : '+'),
-            'price_selected_is_percent' => $default && empty($price) ? '' : ($price->is_percent() ? 1 : 0),
-            'disabled'                  => $disabled
-        );
-        
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
-            $template_args, $tktrow, $prcrow, $price, $default, $disabled, $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+			//while we're in the loop let's setup the option spans used by js
+			$spanargs = array(
+				'PRT_ID'         => $price_type->ID(),
+				'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
+				'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0
+			);
+			$price_option_spans .= EEH_Template::display_template($price_option_span_template, $spanargs, true);
+		}
+        
+		$select_params = $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"';
+		$main_name     = $select_name;
+		$select_name   = $disabled ? 'archive_price[' . $tktrow . '][' . $prcrow . '][PRT_ID]' : $main_name;
+        
+		$template_args = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $tktrow,
+			'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $prcrow,
+			'price_modifier_selector'   => EEH_Form_Fields::select_input($select_name, $all_price_types,
+				$selected_price_type_id, $select_params, 'edit-price-PRT_ID'),
+			'main_name'                 => $main_name,
+			'selected_price_type_id'    => $selected_price_type_id,
+			'price_option_spans'        => $price_option_spans,
+			'price_selected_operator'   => $default && empty($price) ? '' : ($price->is_discount() ? '-' : '+'),
+			'price_selected_is_percent' => $default && empty($price) ? '' : ($price->is_percent() ? 1 : 0),
+			'disabled'                  => $disabled
+		);
+        
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
+			$template_args, $tktrow, $prcrow, $price, $default, $disabled, $this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_ticket_datetime_list_item($dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default)
-    {
-        $tkt_dtts      = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) ? $ticket_datetimes[$ticket->ID()] : array();
-        $template_args = array(
-            'dtt_row'                  => $default && ! $dtt instanceof EE_Datetime ? 'DTTNUM' : $dttrow,
-            'tkt_row'                  => $default ? 'TICKETNUM' : $tktrow,
-            'ticket_datetime_selected' => in_array($dttrow, $tkt_dtts) ? ' ticket-selected' : '',
-            'ticket_datetime_checked'  => in_array($dttrow, $tkt_dtts) ? ' checked="checked"' : '',
-            'DTT_name'                 => $default && empty($dtt) ? 'DTTNAME' : $dtt->get_dtt_display_name(true),
-            'tkt_status_class'         => '',
-        );
-        
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
-            $template_args, $dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default, $this->_is_creating_event);
-        $template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_ticket_datetime_list_item($dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default)
+	{
+		$tkt_dtts      = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) ? $ticket_datetimes[$ticket->ID()] : array();
+		$template_args = array(
+			'dtt_row'                  => $default && ! $dtt instanceof EE_Datetime ? 'DTTNUM' : $dttrow,
+			'tkt_row'                  => $default ? 'TICKETNUM' : $tktrow,
+			'ticket_datetime_selected' => in_array($dttrow, $tkt_dtts) ? ' ticket-selected' : '',
+			'ticket_datetime_checked'  => in_array($dttrow, $tkt_dtts) ? ' checked="checked"' : '',
+			'DTT_name'                 => $default && empty($dtt) ? 'DTTNAME' : $dtt->get_dtt_display_name(true),
+			'tkt_status_class'         => '',
+		);
+        
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
+			$template_args, $dttrow, $tktrow, $dtt, $ticket, $ticket_datetimes, $default, $this->_is_creating_event);
+		$template      = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
-    protected function _get_ticket_js_structure($all_dtts, $all_tickets)
-    {
-        $template_args = array(
-            'default_datetime_edit_row'                => $this->_get_dtt_edit_row('DTTNUM', null, true, $all_dtts),
-            'default_ticket_row'                       => $this->_get_ticket_row('TICKETNUM', null, array(), array(),
-                true),
-            'default_price_row'                        => $this->_get_ticket_price_row('TICKETNUM', 'PRICENUM', null,
-                true, null),
-            'default_price_rows'                       => '',
-            'default_base_price_amount'                => 0,
-            'default_base_price_name'                  => '',
-            'default_base_price_description'           => '',
-            'default_price_modifier_selector_row'      => $this->_get_price_modifier_template('TICKETNUM', 'PRICENUM',
-                null, true),
-            'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row('DTTNUM', null, array(),
-                array(), true),
-            'existing_available_datetime_tickets_list' => '',
-            'existing_available_ticket_datetimes_list' => '',
-            'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item('DTTNUM', 'TICKETNUM',
-                null, null, array(), true),
-            'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item('DTTNUM', 'TICKETNUM',
-                null, null, array(), true)
-        );
-        
-        $tktrow = 1;
-        foreach ($all_tickets as $ticket) {
-            $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item('DTTNUM',
-                $tktrow, null, $ticket, array(), true);
-            $tktrow++;
-        }
-        
-        
-        $dttrow = 1;
-        foreach ($all_dtts as $dtt) {
-            $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item($dttrow,
-                'TICKETNUM', $dtt, null, array(), true);
-            $dttrow++;
-        }
-        
-        $default_prices = EE_Registry::instance()->load_model('Price')->get_all_default_prices();
-        $prcrow         = 1;
-        foreach ($default_prices as $price) {
-            if ($price->is_base_price()) {
-                $template_args['default_base_price_amount']      = $price->get_pretty('PRC_amount', 'localized_float');
-                $template_args['default_base_price_name']        = $price->get('PRC_name');
-                $template_args['default_base_price_description'] = $price->get('PRC_desc');
-                $prcrow++;
-                continue;
-            }
-            $show_trash  = (count($default_prices) > 1 && $prcrow === 1) || count($default_prices) === 1 ? false : true;
-            $show_create = count($default_prices) > 1 && count($default_prices) !== $prcrow ? false : true;
-            $template_args['default_price_rows'] .= $this->_get_ticket_price_row('TICKETNUM', $prcrow, $price, true,
-                null, $show_trash, $show_create);
-            $prcrow++;
-        }
-        
-        $template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
-            $template_args, $all_dtts, $all_tickets, $this->_is_creating_event);
-        
-        $template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php';
-        
-        return EEH_Template::display_template($template, $template_args, true);
-    }
+	protected function _get_ticket_js_structure($all_dtts, $all_tickets)
+	{
+		$template_args = array(
+			'default_datetime_edit_row'                => $this->_get_dtt_edit_row('DTTNUM', null, true, $all_dtts),
+			'default_ticket_row'                       => $this->_get_ticket_row('TICKETNUM', null, array(), array(),
+				true),
+			'default_price_row'                        => $this->_get_ticket_price_row('TICKETNUM', 'PRICENUM', null,
+				true, null),
+			'default_price_rows'                       => '',
+			'default_base_price_amount'                => 0,
+			'default_base_price_name'                  => '',
+			'default_base_price_description'           => '',
+			'default_price_modifier_selector_row'      => $this->_get_price_modifier_template('TICKETNUM', 'PRICENUM',
+				null, true),
+			'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row('DTTNUM', null, array(),
+				array(), true),
+			'existing_available_datetime_tickets_list' => '',
+			'existing_available_ticket_datetimes_list' => '',
+			'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item('DTTNUM', 'TICKETNUM',
+				null, null, array(), true),
+			'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item('DTTNUM', 'TICKETNUM',
+				null, null, array(), true)
+		);
+        
+		$tktrow = 1;
+		foreach ($all_tickets as $ticket) {
+			$template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item('DTTNUM',
+				$tktrow, null, $ticket, array(), true);
+			$tktrow++;
+		}
+        
+        
+		$dttrow = 1;
+		foreach ($all_dtts as $dtt) {
+			$template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item($dttrow,
+				'TICKETNUM', $dtt, null, array(), true);
+			$dttrow++;
+		}
+        
+		$default_prices = EE_Registry::instance()->load_model('Price')->get_all_default_prices();
+		$prcrow         = 1;
+		foreach ($default_prices as $price) {
+			if ($price->is_base_price()) {
+				$template_args['default_base_price_amount']      = $price->get_pretty('PRC_amount', 'localized_float');
+				$template_args['default_base_price_name']        = $price->get('PRC_name');
+				$template_args['default_base_price_description'] = $price->get('PRC_desc');
+				$prcrow++;
+				continue;
+			}
+			$show_trash  = (count($default_prices) > 1 && $prcrow === 1) || count($default_prices) === 1 ? false : true;
+			$show_create = count($default_prices) > 1 && count($default_prices) !== $prcrow ? false : true;
+			$template_args['default_price_rows'] .= $this->_get_ticket_price_row('TICKETNUM', $prcrow, $price, true,
+				null, $show_trash, $show_create);
+			$prcrow++;
+		}
+        
+		$template_args = apply_filters('FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
+			$template_args, $all_dtts, $all_tickets, $this->_is_creating_event);
+        
+		$template = PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php';
+        
+		return EEH_Template::display_template($template, $template_args, true);
+	}
     
     
 } //end class espresso_events_Pricing_Hooks

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Indentation +6 added lines, -6 removed lines

@@ -38,15 +38,15 @@
 		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
 			EEH_HTML::indent( 1, 'optgroup' );
 			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
-			    if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
 				EEH_HTML::indent( 1, 'option' );
 				$html .= $this->_display_options( $opt_group );
 				EEH_HTML::indent( -1, 'option' );
-                if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
-			    }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+				}
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
 	/**
 	 * Checks if that value is the one selected
 	 * @param string|int $value unnormalized value option (string)
-	 * @return string
+	 * @return boolean
 	 */
 	protected function _check_if_option_selected( $value ){
 		return $this->_input->raw_value() === $value ? TRUE : FALSE;

Spacing +27 added lines, -27 removed lines

@@ -11,49 +11,49 @@ 
  * @since 				$VID:$
  *
  */
-class EE_Select_Display_Strategy extends EE_Display_Strategy_Base{
+class EE_Select_Display_Strategy extends EE_Display_Strategy_Base {
 
 	/**
 	 *
 	 * @throws EE_Error
 	 * @return string of html to display the field
 	 */
-	function display(){
-		if( ! $this->_input instanceof EE_Form_Input_With_Options_Base){
-			throw new EE_Error( sprintf( __( 'Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso' )));
+	function display() {
+		if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
 		}
 
-		$html = EEH_HTML::nl( 0, 'select' );
+		$html = EEH_HTML::nl(0, 'select');
 		$html .= '<select';
-		$html .= ' id="' . $this->_input->html_id() . '"';
-		$html .= ' name="' . $this->_input->html_name() . '"';
-		$class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-		$html .= ' class="' . $class . '"';
+		$html .= ' id="'.$this->_input->html_id().'"';
+		$html .= ' name="'.$this->_input->html_name().'"';
+		$class = $this->_input->required() ? $this->_input->required_css_class().' '.$this->_input->html_class() : $this->_input->html_class();
+		$html .= ' class="'.$class.'"';
 		// add html5 required
 		$html .= $this->_input->required() ? ' required' : '';
-		$html .= ' style="' . $this->_input->html_style() . '"';
-		$html .= ' ' . $this->_input->other_html_attributes();
+		$html .= ' style="'.$this->_input->html_style().'"';
+		$html .= ' '.$this->_input->other_html_attributes();
 		$html .= '>';
 
-		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
-			EEH_HTML::indent( 1, 'optgroup' );
-			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
 			    if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
-				EEH_HTML::indent( 1, 'option' );
-				$html .= $this->_display_options( $opt_group );
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
 				EEH_HTML::indent( -1, 'option' );
                 if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
 			    }
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {
-			$html.=$this->_display_options( $this->_input->options() );
+			$html .= $this->_display_options($this->_input->options());
 		}
 
-		$html.= EEH_HTML::nl( 0, 'select' ) . '</select>';
+		$html .= EEH_HTML::nl(0, 'select').'</select>';
 		return $html;
 	}
 
@@ -64,13 +64,13 @@ 
 	 * @param array $options
 	 * @return string
 	 */
-	protected function _display_options($options){
+	protected function _display_options($options) {
 		$html = '';
-		EEH_HTML::indent( 1, 'option' );
-		foreach( $options as $value => $display_text ){
-			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
-			$selected = $this->_check_if_option_selected( $unnormalized_value ) ? ' selected="selected"' : '';
-			$html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr( $unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+			$html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
 		}
 		EEH_HTML::indent( -1, 'option' );
 		return $html;
@@ -83,7 +83,7 @@ 
 	 * @param string|int $value unnormalized value option (string)
 	 * @return string
 	 */
-	protected function _check_if_option_selected( $value ){
+	protected function _check_if_option_selected($value) {
 		return $this->_input->raw_value() === $value ? TRUE : FALSE;
 	}
 

caffeinated/admin/extend/registration_form/Extend_Registration_Form_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -504,7 +504,7 @@
      *
      * @param int                  $id
      * @param EEM_Soft_Delete_Base $model
-     * @return boolean
+     * @return integer
      */
     protected function _delete_item($id, $model)
     {

Indentation +1085 added lines, -1085 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -25,1090 +25,1090 @@ 
 {
 
 
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
-        parent::__construct($routing);
-    }
-
-
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
-        $qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
-        $qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
-
-        $new_page_routes    = array(
-            'question_groups'    => array(
-                'func'       => '_question_groups_overview_list_table',
-                'capability' => 'ee_read_question_groups',
-            ),
-            'add_question'       => array(
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_questions',
-            ),
-            'insert_question'    => array(
-                'func'       => '_insert_or_update_question',
-                'args'       => array('new_question' => true),
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'duplicate_question' => array(
-                'func'       => '_duplicate_question',
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'trash_question'     => array(
-                'func'       => '_trash_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_question' => array(
-                'func'       => '_delete_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'trash_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-            ),
-
-            'restore_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_questions' => array(
-                'func'       => '_delete_questions',
-                'args'       => array(),
-                'capability' => 'ee_delete_questions',
-                'noheader'   => true,
-            ),
-
-            'add_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_groups',
-            ),
-
-            'edit_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'args'       => array('edit'),
-            ),
-
-            'delete_question_groups' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-            'delete_question_group' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'insert_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => true),
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'update_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => false),
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => array('trash' => false),
-            ),
-
-            'restore_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-
-            'espresso_update_question_group_order' => array(
-                'func'       => 'update_question_group_order',
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'view_reg_form_settings' => array(
-                'func'       => '_reg_form_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_reg_form_settings' => array(
-                'func'       => '_update_reg_form_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config    = array(
-
-            'question_groups' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
-                'help_tabs'     => array(
-                    'registration_form_question_groups_help_tab'                           => array(
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ),
-                    'registration_form_question_groups_table_column_headings_help_tab'     => array(
-                        'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_table_column_headings',
-                    ),
-                    'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
-                        'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_views_bulk_actions_search',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-                'qtips'         => array(
-                    'EE_Registration_Form_Tips',
-                ),
-            ),
-
-            'add_question' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_help_tab' => array(
-                        'title'    => esc_html__('Add Question', 'event_espresso'),
-                        'filename' => 'registration_form_add_question',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Add_Question_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'add_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_group_help_tab' => array(
-                        'title'    => esc_html__('Add Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_add_question_group',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Add_Question_Group_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'edit_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(array('question_group_id' => $this->_req_data['question_group_id']),
-                        $this->_current_page_view_url) : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_edit_question_group_help_tab' => array(
-                        'title'    => esc_html__('Edit Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question_group',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Edit_Question_Group_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'view_reg_form_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reg Form Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_reg_form_settings_help_tab' => array(
-                        'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
-                        'filename' => 'registration_form_reg_form_settings',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-
-        //change the list table we're going to use so it's the NEW list table!
-        $this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
-
-
-        //additional labels
-        $new_labels               = array(
-            'add_question'          => esc_html__('Add New Question', 'event_espresso'),
-            'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
-            'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
-            'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
-            'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
-        );
-        $this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
-
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
-    }
-
-
-    public function load_scripts_styles_question_groups()
-    {
-        wp_enqueue_script('espresso_ajax_table_sorting');
-    }
-
-
-    public function load_scripts_styles_add_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-    public function load_scripts_styles_edit_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-
-    /**
-     * registers and enqueues script for questions
-     *
-     * @return void
-     */
-    public function load_sortable_question_script()
-    {
-        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
-            array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
-        wp_enqueue_script('ee-question-sortable');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Questions', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_questions' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
-            'espresso_registration_form_trash_questions')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_questions' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_question_groups()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_question_groups',
-            'espresso_registration_form_trash_question_groups')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _questions_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_question',
-                'add_question',
-                array(),
-                'add-new-h2'
-            );
-        parent::_questions_overview_list_table();
-    }
-
-
-    protected function _question_groups_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_question_group',
-                'add_question_group',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _delete_question()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted',
-            array('action' => 'default', 'status' => 'all')
-        );
-    }
-
-
-    protected function _delete_questions()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted permanently',
-            array('action' => 'default', 'status' => 'trash')
-        );
-    }
-
-
-    /**
-     * Performs the deletion of a single or multiple questions or question groups.
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @return int number of items deleted permanently
-     */
-    private function _delete_items(EEM_Soft_Delete_Base $model)
-    {
-        $success = 0;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru bulk action checkboxes
-            while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! $this->_delete_item($ID, $model)) {
-                    $success = 0;
-                }
-            }
-
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
-
-        } elseif (! empty($this->_req_data['QST_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
-        } else {
-            EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
-                "event_espresso")), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-    /**
-     * Deletes the specified question (and its associated question options) or question group
-     *
-     * @param int                  $id
-     * @param EEM_Soft_Delete_Base $model
-     * @return boolean
-     */
-    protected function _delete_item($id, $model)
-    {
-        if ($model instanceof EEM_Question) {
-            EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
-        }
-        return $model->delete_permanently_by_ID(absint($id));
-    }
-
-
-    /******************************    QUESTION GROUPS    ******************************/
-
-
-    protected function _edit_question_group($type = 'add')
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID']) ? absint($this->_req_data['QSG_ID']) : false;
-
-        switch ($this->_req_action) {
-            case 'add_question_group' :
-                $this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
-                break;
-            case 'edit_question_group' :
-                $this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
-                break;
-            default :
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
-        if ($ID) {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
-            $additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
-            $this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
-        } else {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup = EEM_Question_Group::instance()->create_default_object();
-            $questionGroup->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question_group');
-        }
-        $this->_template_args['values']         = $this->_yes_no_values;
-        $this->_template_args['all_questions']  = $questionGroup->questions_in_and_not_in_group();
-        $this->_template_args['QSG_ID']         = $ID ? $ID : true;
-        $this->_template_args['question_group'] = $questionGroup;
-
-        $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
-        $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
-            $this->_template_args, true);
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _delete_question_groups()
-    {
-        $success = $this->_delete_items($this->_question_group_model);
-        $this->_redirect_after_action($success, $this->_question_group_model->item_name($success),
-            'deleted permanently', array('action' => 'question_groups', 'status' => 'trash'));
-    }
-
-
-    /**
-     * @param bool $new_question_group
-     */
-    protected function _insert_or_update_question_group($new_question_group = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_group_model);
-        if ($new_question_group) {
-            $QSG_ID  = $this->_question_group_model->insert($set_column_values);
-            $success = $QSG_ID ? 1 : 0;
-        } else {
-            $QSG_ID = absint($this->_req_data['QSG_ID']);
-            unset($set_column_values['QSG_ID']);
-            $success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
-        }
-        $phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(EEM_Attendee::system_question_phone);
-        // update the existing related questions
-        // BUT FIRST...  delete the phone question from the Question_Group_Question if it is being added to this question group (therefore removed from the existing group)
-        if (isset($this->_req_data['questions'], $this->_req_data['questions'][$phone_question_id])) {
-            // delete where QST ID = system phone question ID and Question Group ID is NOT this group
-            EEM_Question_Group_Question::instance()->delete(array(
-                array(
-                    'QST_ID' => $phone_question_id,
-                    'QSG_ID' => array('!=', $QSG_ID),
-                ),
-            ));
-        }
-        /** @type EE_Question_Group $question_group */
-        $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
-        $questions      = $question_group->questions();
-        // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[$phone_question_id])) {
-            $questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
-        }
-
-        foreach ($questions as $question_ID => $question) {
-            // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][$question_ID])) {
-                //update question order
-                $question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
-            }
-
-            // then we always check if adding or removing.
-            if (isset($this->_req_data['questions'], $this->_req_data['questions'][$question_ID])) {
-                $question_group->add_question($question_ID);
-            } else {
-                // not found, remove it (but only if not a system question for the personal group with the exception of lname system question - we allow removal of it)
-                if (
-                in_array(
-                    $question->system_ID(),
-                    EEM_Question::instance()->required_system_questions_in_system_question_group($question_group->system_group())
-                )
-                ) {
-                    continue;
-                } else {
-                    $question_group->remove_question($question_ID);
-                }
-            }
-        }
-        // save new related questions
-        if (isset($this->_req_data['questions'])) {
-            foreach ($this->_req_data['questions'] as $QST_ID) {
-                $question_group->add_question($QST_ID);
-                if (isset($this->_req_data['question_orders'][$QST_ID])) {
-                    $question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][$QST_ID]);
-                }
-            }
-        }
-
-        if ($success !== false) {
-            $msg = $new_question_group ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
-                $this->_question_group_model->item_name()) : sprintf(esc_html__('The %s has been updated',
-                'event_espresso'), $this->_question_group_model->item_name());
-            EE_Error::add_success($msg);
-        }
-        $this->_redirect_after_action(false, '', '', array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
-            true);
-
-    }
-
-    /**
-     * duplicates a question and all its question options and redirects to the new question.
-     */
-    public function _duplicate_question()
-    {
-        $question_ID = (int)$this->_req_data['QST_ID'];
-        $question    = EEM_Question::instance()->get_one_by_ID($question_ID);
-        if ($question instanceof EE_Question) {
-            $new_question = $question->duplicate();
-            if ($new_question instanceof EE_Question) {
-                $this->_redirect_after_action(true, esc_html__('Question', 'event_espresso'),
-                    esc_html__('Duplicated', 'event_espresso'),
-                    array('action' => 'edit_question', 'QST_ID' => $new_question->ID()), true);
-            } else {
-                global $wpdb;
-                EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %1$d because: %2$s',
-                    'event_espresso'), $question_ID, $wpdb->last_error), __FILE__, __FUNCTION__, __LINE__);
-                $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-            }
-        } else {
-            EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %d because it didn\'t exist!',
-                'event_espresso'), $question_ID), __FILE__, __FUNCTION__, __LINE__);
-            $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     */
-    protected function _trash_or_restore_question_groups($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_group_model, $trash);
-    }
-
-
-    /**
-     *_trash_question
-     */
-    protected function _trash_question()
-    {
-        $success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
-        $query_args = array('action' => 'default', 'status' => 'all');
-        $this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
-    }
-
-
-    /**
-     * @param bool $trash
-     */
-    protected function _trash_or_restore_questions($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_model, $trash);
-    }
-
-
-    /**
-     * Internally used to delete or restore items, using the request data. Meant to be
-     * flexible between question or question groups
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @param boolean              $trash whether to trash or restore
-     */
-    private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
-    {
-
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        $success = 1;
-        //Checkboxes
-        //echo "trash $trash";
-        //var_dump($this->_req_data['checkbox']);die;
-        if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                // if array has more than one element than success message should be plural
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-                // cycle thru bulk action checkboxes
-                while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
-                        $success = 0;
-                    }
-                }
-
-            } else {
-                // grab single id and delete
-                $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                    $success = 0;
-                }
-            }
-
-        } else {
-            // delete via trash link
-            // grab single id and delete
-            $ID = absint($this->_req_data[$model->primary_key_name()]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                $success = 0;
-            }
-
-        }
-
-
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
-        //echo "action :$action";
-        //$action = 'questions' ? 'default' : $action;
-        if ($trash) {
-            $action_desc = 'trashed';
-            $status      = 'trash';
-        } else {
-            $action_desc = 'restored';
-            $status      = 'all';
-        }
-        $this->_redirect_after_action($success, $model->item_name($success), $action_desc,
-            array('action' => $action, 'status' => $status));
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-
-        if ($count) {
-            //note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $where   = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $this->_question_model->count_deleted($where);
-        } else {
-            //note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $results = $this->_question_model->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where   = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $questionGroupModel->count($where);
-        } else {
-            $results = $questionGroupModel->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param      $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where                 = isset($query_params[0]) ? array($query_params[0]) : array();
-            $query_params['limit'] = null;
-            $results               = $questionGroupModel->count_deleted($where);
-        } else {
-            $results = $questionGroupModel->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * method for performing updates to question order
-     *
-     * @return array results array
-     */
-    public function update_question_group_order()
-    {
-
-        $success = esc_html__('Question group order was updated successfully.', 'event_espresso');
-
-        // grab our row IDs
-        $row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
-            ? explode(',', rtrim($this->_req_data['row_ids'], ','))
-            : array();
-
-        $perpage = ! empty($this->_req_data['perpage'])
-            ? (int)$this->_req_data['perpage']
-            : null;
-        $curpage = ! empty($this->_req_data['curpage'])
-            ? (int)$this->_req_data['curpage']
-            : null;
-
-        if (! empty($row_ids)) {
-            //figure out where we start the row_id count at for the current page.
-            $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
-
-            $row_count = count($row_ids);
-            for ($i = 0; $i < $row_count; $i++) {
-                //Update the questions when re-ordering
-                $updated = EEM_Question_Group::instance()->update(
-                    array('QSG_order' => $qsgcount),
-                    array(array('QSG_ID' => $row_ids[$i]))
-                );
-                if ($updated === false) {
-                    $success = false;
-                }
-                $qsgcount++;
-            }
-        } else {
-            $success = false;
-        }
-
-        $errors = ! $success
-            ? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
-            : false;
-
-        echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
-        die();
-
-    }
-
-
-
-    /***************************************        REGISTRATION SETTINGS        ***************************************/
-
-
-    /**
-     * _reg_form_settings
-     *
-     * @throws \EE_Error
-     */
-    protected function _reg_form_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array($this, 'email_validation_settings_form'),
-            2
-        );
-        $this->_template_args = (array)apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_reg_form_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _update_reg_form_settings
-     */
-    protected function _update_reg_form_settings()
-    {
-        EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
-            EE_Registry::instance()->CFG->registration
-        );
-        EE_Registry::instance()->CFG->registration = apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            EE_Registry::instance()->CFG->registration
-        );
-        $success                                   = $this->_update_espresso_configuration(
-            esc_html__('Registration Form Options', 'event_espresso'),
-            EE_Registry::instance()->CFG,
-            __FILE__, __FUNCTION__, __LINE__
-        );
-        $this->_redirect_after_action($success, esc_html__('Registration Form Options', 'event_espresso'), 'updated',
-            array('action' => 'view_reg_form_settings'));
-    }
-
-
-    /**
-     * email_validation_settings_form
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function email_validation_settings_form()
-    {
-        echo $this->_email_validation_settings_form()->get_html();
-    }
-
-
-    /**
-     * _email_validation_settings_form
-     *
-     * @access protected
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    protected function _email_validation_settings_form()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'email_validation_settings',
-                'html_id'         => 'email_validation_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => array(
-                    'email_validation_hdr'   => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
-                    ),
-                    'email_validation_level' => new EE_Select_Input(
-                        array(
-                            'basic'      => esc_html__('Basic', 'event_espresso'),
-                            'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
-                            'i18n'       => esc_html__('International', 'event_espresso'),
-                            'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
-                        ),
-                        array(
-                            'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
-                                                 . EEH_Template::get_help_tab_link('email_validation_info'),
-                            'html_help_text'  => esc_html__('These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
-                                'event_espresso'),
-                            'default'         => isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-                                ? EE_Registry::instance()->CFG->registration->email_validation_level
-                                : 'wp_default',
-                            'required'        => false,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * update_email_validation_settings_form
-     *
-     * @access    public
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @return \EE_Registration_Config
-     */
-    public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
-    {
-        $prev_email_validation_level = $EE_Registration_Config->email_validation_level;
-        try {
-            $email_validation_settings_form = $this->_email_validation_settings_form();
-            // if not displaying a form, then check for form submission
-            if ($email_validation_settings_form->was_submitted()) {
-                // capture form data
-                $email_validation_settings_form->receive_form_submission();
-                // validate form data
-                if ($email_validation_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $email_validation_settings_form->valid_data();
-                    if (isset($valid_data['email_validation_level'])) {
-                        $email_validation_level = $valid_data['email_validation_level'];
-                        // now if they want to use international email addresses
-                        if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
-                            // in case we need to reset their email validation level,
-                            // make sure that the previous value wasn't already set to one of the i18n options.
-                            if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
-                                // if so, then reset it back to "basic" since that is the only other option that,
-                                // despite offering poor validation, supports i18n email addresses
-                                $prev_email_validation_level = 'basic';
-                            }
-                            // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
-                                // or reset email validation level to previous value
-                                $email_validation_level = $prev_email_validation_level;
-                            }
-                        }
-                        $EE_Registration_Config->email_validation_level = $email_validation_level;
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Email Validation settings. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    }
-                } else {
-                    if ($email_validation_settings_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $email_validation_settings_form->submission_error_message(),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
-
-
-    /**
-     * confirms that the server's PHP version has the PCRE module enabled,
-     * and that the PCRE version works with our i18n email validation
-     *
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @param string                  $email_validation_level
-     * @return bool
-     */
-    private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
-    {
-        // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
-                        'event_espresso'
-                    ),
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        } else {
-            // PCRE support is enabled, but let's still
-            // perform a test to see if the server will support it.
-            // but first, save the updated validation level to the config,
-            // so that the validation strategy picks it up.
-            // this will get bumped back down if it doesn't work
-            $EE_Registration_Config->email_validation_level = $email_validation_level;
-            try {
-                $email_validator    = new EE_Email_Validation_Strategy();
-                $i18n_email_address = apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
-                    'jägerjürgen@deutschland.com'
-                );
-                $email_validator->validate($i18n_email_address);
-            } catch (Exception $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
-                            'event_espresso'
-                        ),
-                        '<br />',
-                        '<a href="http://php.net/manual/en/pcre.installation.php" target="_blank">http://php.net/manual/en/pcre.installation.php</a>'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
+		define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
+		define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
+		define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
+		define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+		parent::__construct($routing);
+	}
+
+
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
+		$qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
+		$qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
+
+		$new_page_routes    = array(
+			'question_groups'    => array(
+				'func'       => '_question_groups_overview_list_table',
+				'capability' => 'ee_read_question_groups',
+			),
+			'add_question'       => array(
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_questions',
+			),
+			'insert_question'    => array(
+				'func'       => '_insert_or_update_question',
+				'args'       => array('new_question' => true),
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'duplicate_question' => array(
+				'func'       => '_duplicate_question',
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'trash_question'     => array(
+				'func'       => '_trash_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'restore_question' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_question' => array(
+				'func'       => '_delete_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'trash_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+			),
+
+			'restore_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_questions' => array(
+				'func'       => '_delete_questions',
+				'args'       => array(),
+				'capability' => 'ee_delete_questions',
+				'noheader'   => true,
+			),
+
+			'add_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_groups',
+			),
+
+			'edit_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'args'       => array('edit'),
+			),
+
+			'delete_question_groups' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+			'delete_question_group' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'restore_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'insert_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => true),
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'update_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => false),
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => array('trash' => false),
+			),
+
+			'restore_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+
+			'espresso_update_question_group_order' => array(
+				'func'       => 'update_question_group_order',
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'view_reg_form_settings' => array(
+				'func'       => '_reg_form_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_reg_form_settings' => array(
+				'func'       => '_update_reg_form_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config    = array(
+
+			'question_groups' => array(
+				'nav'           => array(
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
+				'help_tabs'     => array(
+					'registration_form_question_groups_help_tab'                           => array(
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					),
+					'registration_form_question_groups_table_column_headings_help_tab'     => array(
+						'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_table_column_headings',
+					),
+					'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
+						'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_views_bulk_actions_search',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+				'qtips'         => array(
+					'EE_Registration_Form_Tips',
+				),
+			),
+
+			'add_question' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_help_tab' => array(
+						'title'    => esc_html__('Add Question', 'event_espresso'),
+						'filename' => 'registration_form_add_question',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Add_Question_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'add_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_group_help_tab' => array(
+						'title'    => esc_html__('Add Question Group', 'event_espresso'),
+						'filename' => 'registration_form_add_question_group',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Add_Question_Group_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'edit_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(array('question_group_id' => $this->_req_data['question_group_id']),
+						$this->_current_page_view_url) : $this->_admin_base_url,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_edit_question_group_help_tab' => array(
+						'title'    => esc_html__('Edit Question Group', 'event_espresso'),
+						'filename' => 'registration_form_edit_question_group',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Edit_Question_Group_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'view_reg_form_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Reg Form Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_reg_form_settings_help_tab' => array(
+						'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
+						'filename' => 'registration_form_reg_form_settings',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+
+		//change the list table we're going to use so it's the NEW list table!
+		$this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
+
+
+		//additional labels
+		$new_labels               = array(
+			'add_question'          => esc_html__('Add New Question', 'event_espresso'),
+			'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
+			'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
+			'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
+			'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
+		);
+		$this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
+
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
+	}
+
+
+	public function load_scripts_styles_question_groups()
+	{
+		wp_enqueue_script('espresso_ajax_table_sorting');
+	}
+
+
+	public function load_scripts_styles_add_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+	public function load_scripts_styles_edit_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+
+	/**
+	 * registers and enqueues script for questions
+	 *
+	 * @return void
+	 */
+	public function load_sortable_question_script()
+	{
+		wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+			array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+		wp_enqueue_script('ee-question-sortable');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Questions', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_questions' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
+			'espresso_registration_form_trash_questions')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_questions' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_question_groups()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_question_groups',
+			'espresso_registration_form_trash_question_groups')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _questions_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_question',
+				'add_question',
+				array(),
+				'add-new-h2'
+			);
+		parent::_questions_overview_list_table();
+	}
+
+
+	protected function _question_groups_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_question_group',
+				'add_question_group',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _delete_question()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted',
+			array('action' => 'default', 'status' => 'all')
+		);
+	}
+
+
+	protected function _delete_questions()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted permanently',
+			array('action' => 'default', 'status' => 'trash')
+		);
+	}
+
+
+	/**
+	 * Performs the deletion of a single or multiple questions or question groups.
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return int number of items deleted permanently
+	 */
+	private function _delete_items(EEM_Soft_Delete_Base $model)
+	{
+		$success = 0;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru bulk action checkboxes
+			while (list($ID, $value) = each($this->_req_data['checkbox'])) {
+				if (! $this->_delete_item($ID, $model)) {
+					$success = 0;
+				}
+			}
+
+		} elseif (! empty($this->_req_data['QSG_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
+
+		} elseif (! empty($this->_req_data['QST_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QST_ID'], $model);
+		} else {
+			EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
+				"event_espresso")), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+	/**
+	 * Deletes the specified question (and its associated question options) or question group
+	 *
+	 * @param int                  $id
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return boolean
+	 */
+	protected function _delete_item($id, $model)
+	{
+		if ($model instanceof EEM_Question) {
+			EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
+		}
+		return $model->delete_permanently_by_ID(absint($id));
+	}
+
+
+	/******************************    QUESTION GROUPS    ******************************/
+
+
+	protected function _edit_question_group($type = 'add')
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID']) ? absint($this->_req_data['QSG_ID']) : false;
+
+		switch ($this->_req_action) {
+			case 'add_question_group' :
+				$this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
+				break;
+			case 'edit_question_group' :
+				$this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
+				break;
+			default :
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add ID to title if editing
+		$this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+		if ($ID) {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
+			$additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
+			$this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
+		} else {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup = EEM_Question_Group::instance()->create_default_object();
+			$questionGroup->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question_group');
+		}
+		$this->_template_args['values']         = $this->_yes_no_values;
+		$this->_template_args['all_questions']  = $questionGroup->questions_in_and_not_in_group();
+		$this->_template_args['QSG_ID']         = $ID ? $ID : true;
+		$this->_template_args['question_group'] = $questionGroup;
+
+		$redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
+		$this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+			$this->_template_args, true);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _delete_question_groups()
+	{
+		$success = $this->_delete_items($this->_question_group_model);
+		$this->_redirect_after_action($success, $this->_question_group_model->item_name($success),
+			'deleted permanently', array('action' => 'question_groups', 'status' => 'trash'));
+	}
+
+
+	/**
+	 * @param bool $new_question_group
+	 */
+	protected function _insert_or_update_question_group($new_question_group = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_group_model);
+		if ($new_question_group) {
+			$QSG_ID  = $this->_question_group_model->insert($set_column_values);
+			$success = $QSG_ID ? 1 : 0;
+		} else {
+			$QSG_ID = absint($this->_req_data['QSG_ID']);
+			unset($set_column_values['QSG_ID']);
+			$success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
+		}
+		$phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(EEM_Attendee::system_question_phone);
+		// update the existing related questions
+		// BUT FIRST...  delete the phone question from the Question_Group_Question if it is being added to this question group (therefore removed from the existing group)
+		if (isset($this->_req_data['questions'], $this->_req_data['questions'][$phone_question_id])) {
+			// delete where QST ID = system phone question ID and Question Group ID is NOT this group
+			EEM_Question_Group_Question::instance()->delete(array(
+				array(
+					'QST_ID' => $phone_question_id,
+					'QSG_ID' => array('!=', $QSG_ID),
+				),
+			));
+		}
+		/** @type EE_Question_Group $question_group */
+		$question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
+		$questions      = $question_group->questions();
+		// make sure system phone question is added to list of questions for this group
+		if (! isset($questions[$phone_question_id])) {
+			$questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
+		}
+
+		foreach ($questions as $question_ID => $question) {
+			// first we always check for order.
+			if (! empty($this->_req_data['question_orders'][$question_ID])) {
+				//update question order
+				$question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
+			}
+
+			// then we always check if adding or removing.
+			if (isset($this->_req_data['questions'], $this->_req_data['questions'][$question_ID])) {
+				$question_group->add_question($question_ID);
+			} else {
+				// not found, remove it (but only if not a system question for the personal group with the exception of lname system question - we allow removal of it)
+				if (
+				in_array(
+					$question->system_ID(),
+					EEM_Question::instance()->required_system_questions_in_system_question_group($question_group->system_group())
+				)
+				) {
+					continue;
+				} else {
+					$question_group->remove_question($question_ID);
+				}
+			}
+		}
+		// save new related questions
+		if (isset($this->_req_data['questions'])) {
+			foreach ($this->_req_data['questions'] as $QST_ID) {
+				$question_group->add_question($QST_ID);
+				if (isset($this->_req_data['question_orders'][$QST_ID])) {
+					$question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][$QST_ID]);
+				}
+			}
+		}
+
+		if ($success !== false) {
+			$msg = $new_question_group ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
+				$this->_question_group_model->item_name()) : sprintf(esc_html__('The %s has been updated',
+				'event_espresso'), $this->_question_group_model->item_name());
+			EE_Error::add_success($msg);
+		}
+		$this->_redirect_after_action(false, '', '', array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
+			true);
+
+	}
+
+	/**
+	 * duplicates a question and all its question options and redirects to the new question.
+	 */
+	public function _duplicate_question()
+	{
+		$question_ID = (int)$this->_req_data['QST_ID'];
+		$question    = EEM_Question::instance()->get_one_by_ID($question_ID);
+		if ($question instanceof EE_Question) {
+			$new_question = $question->duplicate();
+			if ($new_question instanceof EE_Question) {
+				$this->_redirect_after_action(true, esc_html__('Question', 'event_espresso'),
+					esc_html__('Duplicated', 'event_espresso'),
+					array('action' => 'edit_question', 'QST_ID' => $new_question->ID()), true);
+			} else {
+				global $wpdb;
+				EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %1$d because: %2$s',
+					'event_espresso'), $question_ID, $wpdb->last_error), __FILE__, __FUNCTION__, __LINE__);
+				$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+			}
+		} else {
+			EE_Error::add_error(sprintf(esc_html__('Could not duplicate question with ID %d because it didn\'t exist!',
+				'event_espresso'), $question_ID), __FILE__, __FUNCTION__, __LINE__);
+			$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 */
+	protected function _trash_or_restore_question_groups($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_group_model, $trash);
+	}
+
+
+	/**
+	 *_trash_question
+	 */
+	protected function _trash_question()
+	{
+		$success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
+		$query_args = array('action' => 'default', 'status' => 'all');
+		$this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash
+	 */
+	protected function _trash_or_restore_questions($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_model, $trash);
+	}
+
+
+	/**
+	 * Internally used to delete or restore items, using the request data. Meant to be
+	 * flexible between question or question groups
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @param boolean              $trash whether to trash or restore
+	 */
+	private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
+	{
+
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		$success = 1;
+		//Checkboxes
+		//echo "trash $trash";
+		//var_dump($this->_req_data['checkbox']);die;
+		if (isset($this->_req_data['checkbox'])) {
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				// if array has more than one element than success message should be plural
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+				// cycle thru bulk action checkboxes
+				while (list($ID, $value) = each($this->_req_data['checkbox'])) {
+					if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+						$success = 0;
+					}
+				}
+
+			} else {
+				// grab single id and delete
+				$ID = absint($this->_req_data['checkbox']);
+				if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+					$success = 0;
+				}
+			}
+
+		} else {
+			// delete via trash link
+			// grab single id and delete
+			$ID = absint($this->_req_data[$model->primary_key_name()]);
+			if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+				$success = 0;
+			}
+
+		}
+
+
+		$action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
+		//echo "action :$action";
+		//$action = 'questions' ? 'default' : $action;
+		if ($trash) {
+			$action_desc = 'trashed';
+			$status      = 'trash';
+		} else {
+			$action_desc = 'restored';
+			$status      = 'all';
+		}
+		$this->_redirect_after_action($success, $model->item_name($success), $action_desc,
+			array('action' => $action, 'status' => $status));
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+
+		if ($count) {
+			//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$where   = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $this->_question_model->count_deleted($where);
+		} else {
+			//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$results = $this->_question_model->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where   = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $questionGroupModel->count($where);
+		} else {
+			$results = $questionGroupModel->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param      $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params       = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where                 = isset($query_params[0]) ? array($query_params[0]) : array();
+			$query_params['limit'] = null;
+			$results               = $questionGroupModel->count_deleted($where);
+		} else {
+			$results = $questionGroupModel->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * method for performing updates to question order
+	 *
+	 * @return array results array
+	 */
+	public function update_question_group_order()
+	{
+
+		$success = esc_html__('Question group order was updated successfully.', 'event_espresso');
+
+		// grab our row IDs
+		$row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
+			? explode(',', rtrim($this->_req_data['row_ids'], ','))
+			: array();
+
+		$perpage = ! empty($this->_req_data['perpage'])
+			? (int)$this->_req_data['perpage']
+			: null;
+		$curpage = ! empty($this->_req_data['curpage'])
+			? (int)$this->_req_data['curpage']
+			: null;
+
+		if (! empty($row_ids)) {
+			//figure out where we start the row_id count at for the current page.
+			$qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
+
+			$row_count = count($row_ids);
+			for ($i = 0; $i < $row_count; $i++) {
+				//Update the questions when re-ordering
+				$updated = EEM_Question_Group::instance()->update(
+					array('QSG_order' => $qsgcount),
+					array(array('QSG_ID' => $row_ids[$i]))
+				);
+				if ($updated === false) {
+					$success = false;
+				}
+				$qsgcount++;
+			}
+		} else {
+			$success = false;
+		}
+
+		$errors = ! $success
+			? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
+			: false;
+
+		echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
+		die();
+
+	}
+
+
+
+	/***************************************        REGISTRATION SETTINGS        ***************************************/
+
+
+	/**
+	 * _reg_form_settings
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _reg_form_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array($this, 'email_validation_settings_form'),
+			2
+		);
+		$this->_template_args = (array)apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_reg_form_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _update_reg_form_settings
+	 */
+	protected function _update_reg_form_settings()
+	{
+		EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
+			EE_Registry::instance()->CFG->registration
+		);
+		EE_Registry::instance()->CFG->registration = apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			EE_Registry::instance()->CFG->registration
+		);
+		$success                                   = $this->_update_espresso_configuration(
+			esc_html__('Registration Form Options', 'event_espresso'),
+			EE_Registry::instance()->CFG,
+			__FILE__, __FUNCTION__, __LINE__
+		);
+		$this->_redirect_after_action($success, esc_html__('Registration Form Options', 'event_espresso'), 'updated',
+			array('action' => 'view_reg_form_settings'));
+	}
+
+
+	/**
+	 * email_validation_settings_form
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function email_validation_settings_form()
+	{
+		echo $this->_email_validation_settings_form()->get_html();
+	}
+
+
+	/**
+	 * _email_validation_settings_form
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	protected function _email_validation_settings_form()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'email_validation_settings',
+				'html_id'         => 'email_validation_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => array(
+					'email_validation_hdr'   => new EE_Form_Section_HTML(
+						EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
+					),
+					'email_validation_level' => new EE_Select_Input(
+						array(
+							'basic'      => esc_html__('Basic', 'event_espresso'),
+							'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
+							'i18n'       => esc_html__('International', 'event_espresso'),
+							'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
+						),
+						array(
+							'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
+												 . EEH_Template::get_help_tab_link('email_validation_info'),
+							'html_help_text'  => esc_html__('These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
+								'event_espresso'),
+							'default'         => isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+								? EE_Registry::instance()->CFG->registration->email_validation_level
+								: 'wp_default',
+							'required'        => false,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * update_email_validation_settings_form
+	 *
+	 * @access    public
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @return \EE_Registration_Config
+	 */
+	public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
+	{
+		$prev_email_validation_level = $EE_Registration_Config->email_validation_level;
+		try {
+			$email_validation_settings_form = $this->_email_validation_settings_form();
+			// if not displaying a form, then check for form submission
+			if ($email_validation_settings_form->was_submitted()) {
+				// capture form data
+				$email_validation_settings_form->receive_form_submission();
+				// validate form data
+				if ($email_validation_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $email_validation_settings_form->valid_data();
+					if (isset($valid_data['email_validation_level'])) {
+						$email_validation_level = $valid_data['email_validation_level'];
+						// now if they want to use international email addresses
+						if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
+							// in case we need to reset their email validation level,
+							// make sure that the previous value wasn't already set to one of the i18n options.
+							if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
+								// if so, then reset it back to "basic" since that is the only other option that,
+								// despite offering poor validation, supports i18n email addresses
+								$prev_email_validation_level = 'basic';
+							}
+							// confirm our i18n email validation will work on the server
+							if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+								// or reset email validation level to previous value
+								$email_validation_level = $prev_email_validation_level;
+							}
+						}
+						$EE_Registration_Config->email_validation_level = $email_validation_level;
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Email Validation settings. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					}
+				} else {
+					if ($email_validation_settings_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$email_validation_settings_form->submission_error_message(),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
+
+
+	/**
+	 * confirms that the server's PHP version has the PCRE module enabled,
+	 * and that the PCRE version works with our i18n email validation
+	 *
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @param string                  $email_validation_level
+	 * @return bool
+	 */
+	private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
+	{
+		// first check that PCRE is enabled
+		if (! defined('PREG_BAD_UTF8_ERROR')) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
+						'event_espresso'
+					),
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		} else {
+			// PCRE support is enabled, but let's still
+			// perform a test to see if the server will support it.
+			// but first, save the updated validation level to the config,
+			// so that the validation strategy picks it up.
+			// this will get bumped back down if it doesn't work
+			$EE_Registration_Config->email_validation_level = $email_validation_level;
+			try {
+				$email_validator    = new EE_Email_Validation_Strategy();
+				$i18n_email_address = apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
+					'jägerjürgen@deutschland.com'
+				);
+				$email_validator->validate($i18n_email_address);
+			} catch (Exception $e) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
+							'event_espresso'
+						),
+						'<br />',
+						'<a href="http://php.net/manual/en/pcre.installation.php" target="_blank">http://php.net/manual/en/pcre.installation.php</a>'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
 
 
 }

Spacing +34 added lines, -34 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -32,11 +32,11 @@ 
      */
     public function __construct($routing = true)
     {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets' . DS);
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates' . DS);
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND.'registration_form'.DS);
+        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN.'assets'.DS);
+        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/assets/');
+        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN.'templates'.DS);
+        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/templates/');
         parent::__construct($routing);
     }
 
@@ -47,7 +47,7 @@ 
         $qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
         $qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID']) ? $this->_req_data['QSG_ID'] : 0;
 
-        $new_page_routes    = array(
+        $new_page_routes = array(
             'question_groups'    => array(
                 'func'       => '_question_groups_overview_list_table',
                 'capability' => 'ee_read_question_groups',
@@ -310,7 +310,7 @@ 
 
 
         //additional labels
-        $new_labels               = array(
+        $new_labels = array(
             'add_question'          => esc_html__('Add New Question', 'event_espresso'),
             'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
             'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
@@ -354,7 +354,7 @@ 
      */
     public function load_sortable_question_script()
     {
-        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+        wp_register_script('ee-question-sortable', REGISTRATION_FORM_CAF_ASSETS_URL.'ee_question_order.js',
             array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
         wp_enqueue_script('ee-question-sortable');
     }
@@ -420,7 +420,7 @@ 
 
     protected function _questions_overview_list_table()
     {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_question',
                 'add_question',
                 array(),
@@ -433,7 +433,7 @@ 
     protected function _question_groups_overview_list_table()
     {
         $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_question_group',
                 'add_question_group',
                 array(),
@@ -477,20 +477,20 @@ 
     {
         $success = 0;
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element than success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru bulk action checkboxes
             while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! $this->_delete_item($ID, $model)) {
+                if ( ! $this->_delete_item($ID, $model)) {
                     $success = 0;
                 }
             }
 
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
+        } elseif ( ! empty($this->_req_data['QSG_ID'])) {
             $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
 
-        } elseif (! empty($this->_req_data['QST_ID'])) {
+        } elseif ( ! empty($this->_req_data['QST_ID'])) {
             $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
         } else {
             EE_Error::add_error(sprintf(esc_html__("No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
@@ -534,7 +534,7 @@ 
                 $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
         }
         // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+        $this->_admin_page_title = $ID ? $this->_admin_page_title.' # '.$ID : $this->_admin_page_title;
         if ($ID) {
             /** @var EE_Question_Group $questionGroup */
             $questionGroup            = $this->_question_group_model->get_one_by_ID($ID);
@@ -553,7 +553,7 @@ 
 
         $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
         $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_CAF_TEMPLATE_PATH.'question_groups_main_meta_box.template.php',
             $this->_template_args, true);
 
         // the details template wrapper
@@ -600,13 +600,13 @@ 
         $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
         $questions      = $question_group->questions();
         // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[$phone_question_id])) {
+        if ( ! isset($questions[$phone_question_id])) {
             $questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
         }
 
         foreach ($questions as $question_ID => $question) {
             // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][$question_ID])) {
+            if ( ! empty($this->_req_data['question_orders'][$question_ID])) {
                 //update question order
                 $question_group->update_question_order($question_ID, $this->_req_data['question_orders'][$question_ID]);
             }
@@ -654,7 +654,7 @@ 
      */
     public function _duplicate_question()
     {
-        $question_ID = (int)$this->_req_data['QST_ID'];
+        $question_ID = (int) $this->_req_data['QST_ID'];
         $question    = EEM_Question::instance()->get_one_by_ID($question_ID);
         if ($question instanceof EE_Question) {
             $new_question = $question->duplicate();
@@ -690,7 +690,7 @@ 
      */
     protected function _trash_question()
     {
-        $success    = $this->_question_model->delete_by_ID((int)$this->_req_data['QST_ID']);
+        $success    = $this->_question_model->delete_by_ID((int) $this->_req_data['QST_ID']);
         $query_args = array('action' => 'default', 'status' => 'all');
         $this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
     }
@@ -722,12 +722,12 @@ 
         //echo "trash $trash";
         //var_dump($this->_req_data['checkbox']);die;
         if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
                 // if array has more than one element than success message should be plural
                 $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 // cycle thru bulk action checkboxes
                 while (list($ID, $value) = each($this->_req_data['checkbox'])) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+                    if ( ! $model->delete_or_restore_by_ID($trash, absint($ID))) {
                         $success = 0;
                     }
                 }
@@ -735,7 +735,7 @@ 
             } else {
                 // grab single id and delete
                 $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+                if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                     $success = 0;
                 }
             }
@@ -744,14 +744,14 @@ 
             // delete via trash link
             // grab single id and delete
             $ID = absint($this->_req_data[$model->primary_key_name()]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+            if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                 $success = 0;
             }
 
         }
 
 
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';//strtolower( $model->item_name(2) );
+        $action = $model instanceof EEM_Question ? 'default' : 'question_groups'; //strtolower( $model->item_name(2) );
         //echo "action :$action";
         //$action = 'questions' ? 'default' : $action;
         if ($trash) {
@@ -845,13 +845,13 @@ 
             : array();
 
         $perpage = ! empty($this->_req_data['perpage'])
-            ? (int)$this->_req_data['perpage']
+            ? (int) $this->_req_data['perpage']
             : null;
         $curpage = ! empty($this->_req_data['curpage'])
-            ? (int)$this->_req_data['curpage']
+            ? (int) $this->_req_data['curpage']
             : null;
 
-        if (! empty($row_ids)) {
+        if ( ! empty($row_ids)) {
             //figure out where we start the row_id count at for the current page.
             $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
 
@@ -898,14 +898,14 @@ 
             array($this, 'email_validation_settings_form'),
             2
         );
-        $this->_template_args = (array)apply_filters(
+        $this->_template_args = (array) apply_filters(
             'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
             $this->_template_args
         );
         $this->_set_add_edit_form_tags('update_reg_form_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+            REGISTRATION_FORM_CAF_TEMPLATE_PATH.'reg_form_settings.template.php',
             $this->_template_args,
             true
         );
@@ -925,7 +925,7 @@ 
             'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
             EE_Registry::instance()->CFG->registration
         );
-        $success                                   = $this->_update_espresso_configuration(
+        $success = $this->_update_espresso_configuration(
             esc_html__('Registration Form Options', 'event_espresso'),
             EE_Registry::instance()->CFG,
             __FILE__, __FUNCTION__, __LINE__
@@ -1022,7 +1022,7 @@ 
                                 $prev_email_validation_level = 'basic';
                             }
                             // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+                            if ( ! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
                                 // or reset email validation level to previous value
                                 $email_validation_level = $prev_email_validation_level;
                             }
@@ -1064,7 +1064,7 @@ 
     private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
     {
         // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
+        if ( ! defined('PREG_BAD_UTF8_ERROR')) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(

core/db_models/EEM_Transaction.model.php

Indentation +303 added lines, -303 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Base.model.php');
 
@@ -15,192 +15,192 @@ 
 class EEM_Transaction extends EEM_Base
 {
     
-    // private instance of the Transaction object
-    protected static $_instance;
+	// private instance of the Transaction object
+	protected static $_instance;
     
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
-     * but payment is pending. This is the state for transactions where payment is promised
-     * from an offline gateway.
-     */
-    //	const open_status_code = 'TPN';
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
+	 * but payment is pending. This is the state for transactions where payment is promised
+	 * from an offline gateway.
+	 */
+	//	const open_status_code = 'TPN';
     
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
-     * either due to a technical reason (server or computer crash during registration),
-     *  or some other reason that prevent the collection of any useful contact information from any of the registrants
-     */
-    const failed_status_code = 'TFL';
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
+	 * either due to a technical reason (server or computer crash during registration),
+	 *  or some other reason that prevent the collection of any useful contact information from any of the registrants
+	 */
+	const failed_status_code = 'TFL';
     
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
-     * either due to a technical reason (server or computer crash during registration),
-     * or due to an abandoned cart after registrant chose not to complete the registration process
-     * HOWEVER...
-     * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
-     * registrant
-     */
-    const abandoned_status_code = 'TAB';
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
+	 * either due to a technical reason (server or computer crash during registration),
+	 * or due to an abandoned cart after registrant chose not to complete the registration process
+	 * HOWEVER...
+	 * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
+	 * registrant
+	 */
+	const abandoned_status_code = 'TAB';
     
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
-     * meaning that monies are still owing: TXN_paid < TXN_total
-     */
-    const incomplete_status_code = 'TIN';
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
+	 * meaning that monies are still owing: TXN_paid < TXN_total
+	 */
+	const incomplete_status_code = 'TIN';
     
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
-     * meaning that NO monies are owing: TXN_paid == TXN_total
-     */
-    const complete_status_code = 'TCM';
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
+	 * meaning that NO monies are owing: TXN_paid == TXN_total
+	 */
+	const complete_status_code = 'TCM';
     
-    /**
-     *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
-     *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
-     */
-    const overpaid_status_code = 'TOP';
+	/**
+	 *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
+	 *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
+	 */
+	const overpaid_status_code = 'TOP';
     
     
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     *
-     * @return EEM_Transaction
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Transaction', 'event_espresso');
-        $this->plural_item   = __('Transactions', 'event_espresso');
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 *
+	 * @return EEM_Transaction
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Transaction', 'event_espresso');
+		$this->plural_item   = __('Transactions', 'event_espresso');
         
-        $this->_tables                 = array(
-            'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
-        );
-        $this->_fields                 = array(
-            'TransactionTable' => array(
-                'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
-                'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
-                    __('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
-                    $timezone),
-                'TXN_total'        => new EE_Money_Field('TXN_total',
-                    __('Total value of Transaction', 'event_espresso'), false, 0),
-                'TXN_paid'         => new EE_Money_Field('TXN_paid',
-                    __('Amount paid towards transaction to date', 'event_espresso'), false, 0),
-                'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
-                    false, EEM_Transaction::failed_status_code, 'Status'),
-                'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
-                    __('Serialized session data', 'event_espresso'), true, ''),
-                'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
-                    __('Transaction Hash Salt', 'event_espresso'), true, ''),
-                'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
-                    __("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
-                'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
-                    __('Registration Steps', 'event_espresso'), false, array()),
-            )
-        );
-        $this->_model_relations        = array(
-            'Registration'   => new EE_Has_Many_Relation(),
-            'Payment'        => new EE_Has_Many_Relation(),
-            'Status'         => new EE_Belongs_To_Relation(),
-            'Line_Item'      => new EE_Has_Many_Relation(false),
-            //you can delete a transaction without needing to delete its line items
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Message'        => new EE_Has_Many_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
+		$this->_tables                 = array(
+			'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
+		);
+		$this->_fields                 = array(
+			'TransactionTable' => array(
+				'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
+				'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
+					__('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
+					$timezone),
+				'TXN_total'        => new EE_Money_Field('TXN_total',
+					__('Total value of Transaction', 'event_espresso'), false, 0),
+				'TXN_paid'         => new EE_Money_Field('TXN_paid',
+					__('Amount paid towards transaction to date', 'event_espresso'), false, 0),
+				'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
+					false, EEM_Transaction::failed_status_code, 'Status'),
+				'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
+					__('Serialized session data', 'event_espresso'), true, ''),
+				'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
+					__('Transaction Hash Salt', 'event_espresso'), true, ''),
+				'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
+					__("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
+				'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
+					__('Registration Steps', 'event_espresso'), false, array()),
+			)
+		);
+		$this->_model_relations        = array(
+			'Registration'   => new EE_Has_Many_Relation(),
+			'Payment'        => new EE_Has_Many_Relation(),
+			'Status'         => new EE_Belongs_To_Relation(),
+			'Line_Item'      => new EE_Has_Many_Relation(false),
+			//you can delete a transaction without needing to delete its line items
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Message'        => new EE_Has_Many_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
         
-    }
+	}
     
     
-    /**
-     *    txn_status_array
-     * get list of transaction statuses
-     *
-     * @access public
-     * @return array
-     */
-    public static function txn_status_array()
-    {
-        return apply_filters(
-            'FHEE__EEM_Transaction__txn_status_array',
-            array(
-                EEM_Transaction::overpaid_status_code,
-                EEM_Transaction::complete_status_code,
-                EEM_Transaction::incomplete_status_code,
-                EEM_Transaction::abandoned_status_code,
-                EEM_Transaction::failed_status_code,
-            )
-        );
-    }
+	/**
+	 *    txn_status_array
+	 * get list of transaction statuses
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function txn_status_array()
+	{
+		return apply_filters(
+			'FHEE__EEM_Transaction__txn_status_array',
+			array(
+				EEM_Transaction::overpaid_status_code,
+				EEM_Transaction::complete_status_code,
+				EEM_Transaction::incomplete_status_code,
+				EEM_Transaction::abandoned_status_code,
+				EEM_Transaction::failed_status_code,
+			)
+		);
+	}
     
-    /**
-     *        get the revenue per day  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @return \stdClass[]
-     */
-    public function get_revenue_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s', 'UTC');
+	/**
+	 *        get the revenue per day  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @return \stdClass[]
+	 */
+	public function get_revenue_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s', 'UTC');
         
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
         
-        return $this->_get_all_wpdb_results(
-            array(
-                array(
-                    'TXN_timestamp' => array('>=', $sql_date)
-                ),
-                'group_by' => 'txnDate',
-                'order_by' => array('TXN_timestamp' => 'ASC')
-            ),
-            OBJECT,
-            array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
-            )
-        );
-    }
+		return $this->_get_all_wpdb_results(
+			array(
+				array(
+					'TXN_timestamp' => array('>=', $sql_date)
+				),
+				'group_by' => 'txnDate',
+				'order_by' => array('TXN_timestamp' => 'ASC')
+			),
+			OBJECT,
+			array(
+				'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
+			)
+		);
+	}
     
     
-    /**
-     *        get the revenue per event  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @throws \EE_Error
-     * @return mixed
-     */
-    public function get_revenue_per_event_report($period = '-1 month')
-    {
-        global $wpdb;
-        $transaction_table       = $wpdb->prefix . 'esp_transaction';
-        $registration_table      = $wpdb->prefix . 'esp_registration';
-        $event_table             = $wpdb->posts;
-        $payment_table           = $wpdb->prefix . 'esp_payment';
-        $sql_date                = date('Y-m-d H:i:s', strtotime($period));
-        $approved_payment_status = EEM_Payment::status_id_approved;
-        $extra_event_on_join     = '';
-        //exclude events not authored by user if permissions in effect
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
-        }
+	/**
+	 *        get the revenue per event  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @throws \EE_Error
+	 * @return mixed
+	 */
+	public function get_revenue_per_event_report($period = '-1 month')
+	{
+		global $wpdb;
+		$transaction_table       = $wpdb->prefix . 'esp_transaction';
+		$registration_table      = $wpdb->prefix . 'esp_registration';
+		$event_table             = $wpdb->posts;
+		$payment_table           = $wpdb->prefix . 'esp_payment';
+		$sql_date                = date('Y-m-d H:i:s', strtotime($period));
+		$approved_payment_status = EEM_Payment::status_id_approved;
+		$extra_event_on_join     = '';
+		//exclude events not authored by user if permissions in effect
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+		}
         
-        return $wpdb->get_results(
-            "SELECT
+		return $wpdb->get_results(
+			"SELECT
 			Transaction_Event.event_name AS event_name,
 			SUM(Transaction_Event.paid) AS revenue
 			FROM
@@ -220,158 +220,158 @@ 
 							$extra_event_on_join
 				) AS Transaction_Event
 			GROUP BY event_name",
-            OBJECT
-        );
-    }
+			OBJECT
+		);
+	}
     
     
-    /**
-     * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
-     * $_REQUEST global variable. Either way, tries to find the current transaction (through
-     * the registration pointed to by reg_url_link), if not returns null
-     *
-     * @param string $reg_url_link
-     *
-     * @return EE_Transaction
-     */
-    public function get_transaction_from_reg_url_link($reg_url_link = '')
-    {
-        return $this->get_one(array(
-            array(
-                'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
-                    '')
-            )
-        ));
-    }
+	/**
+	 * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
+	 * $_REQUEST global variable. Either way, tries to find the current transaction (through
+	 * the registration pointed to by reg_url_link), if not returns null
+	 *
+	 * @param string $reg_url_link
+	 *
+	 * @return EE_Transaction
+	 */
+	public function get_transaction_from_reg_url_link($reg_url_link = '')
+	{
+		return $this->get_one(array(
+			array(
+				'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
+					'')
+			)
+		));
+	}
     
     
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * (or fetch the EE_Transaction from its ID)
-     *
-     * @deprecated
-     *
-     * @param EE_Transaction|int $transaction_obj_or_id
-     * @param boolean            $save_txn whether or not to save the transaction during this function call
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * (or fetch the EE_Transaction from its ID)
+	 *
+	 * @deprecated
+	 *
+	 * @param EE_Transaction|int $transaction_obj_or_id
+	 * @param boolean            $save_txn whether or not to save the transaction during this function call
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
         
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->ensure_is_obj($transaction_obj_or_id)
-        );
-    }
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->ensure_is_obj($transaction_obj_or_id)
+		);
+	}
     
-    /**
-     * Deletes "junk" transactions that were probably added by bots. There might be TONS
-     * of these, so we are very careful to NOT select (which the models do even when deleting),
-     * and so we only use wpdb directly and only do minimal joins.
-     * Transactions are considered "junk" if they're failed for longer than a week.
-     * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
-     * it, it's probably not junk (regardless of what status it has).
-     * The downside to this approach is that is addons are listening for object deletions
-     * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
-     * to catch these types of deletions.
-     *
-     * @global WPDB $wpdb
-     * @return mixed
-     */
-    public function delete_junk_transactions()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $deleted             = false;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
-            , WEEK_IN_SECONDS
-        );
+	/**
+	 * Deletes "junk" transactions that were probably added by bots. There might be TONS
+	 * of these, so we are very careful to NOT select (which the models do even when deleting),
+	 * and so we only use wpdb directly and only do minimal joins.
+	 * Transactions are considered "junk" if they're failed for longer than a week.
+	 * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
+	 * it, it's probably not junk (regardless of what status it has).
+	 * The downside to this approach is that is addons are listening for object deletions
+	 * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
+	 * to catch these types of deletions.
+	 *
+	 * @global WPDB $wpdb
+	 * @return mixed
+	 */
+	public function delete_junk_transactions()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$deleted             = false;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
+			, WEEK_IN_SECONDS
+		);
         
         
-        /**
-         * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
-         * Useful for plugins that want to exclude transactions matching certain query parameters.
-         * The query parameters should be in the format accepted by the EEM_Base model queries.
-         */
-        $ids_query = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
-            array(
-                0 => array(
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
-                    'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
-                )
-            ),
-            $time_to_leave_alone
-        );
+		/**
+		 * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
+		 * Useful for plugins that want to exclude transactions matching certain query parameters.
+		 * The query parameters should be in the format accepted by the EEM_Base model queries.
+		 */
+		$ids_query = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
+			array(
+				0 => array(
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+					'Payment.PAY_ID' => array( 'IS NULL' ),
+					'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
+				)
+			),
+			$time_to_leave_alone
+		);
         
         
-        /**
-         * This filter is for when code needs to filter the list of transaction ids that represent transactions
-         * about to be deleted based on some other criteria that isn't easily done via the query args filter.
-         */
-        $txn_ids = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
-            EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
-            $time_to_leave_alone
-        );
-        //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
-            // first, make sure these TXN's are removed the "ee_locked_transactions" array
-            EEM_Transaction::unset_locked_transactions($txn_ids);
-            // let's get deletin'...
-            // Why no wpdb->prepare?  Because the data is trusted.
-            // We got the ids from the original query to get them FROM
-            // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+		/**
+		 * This filter is for when code needs to filter the list of transaction ids that represent transactions
+		 * about to be deleted based on some other criteria that isn't easily done via the query args filter.
+		 */
+		$txn_ids = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
+			EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
+			$time_to_leave_alone
+		);
+		//now that we have the ids to delete
+		if (! empty($txn_ids) && is_array($txn_ids)) {
+			// first, make sure these TXN's are removed the "ee_locked_transactions" array
+			EEM_Transaction::unset_locked_transactions($txn_ids);
+			// let's get deletin'...
+			// Why no wpdb->prepare?  Because the data is trusted.
+			// We got the ids from the original query to get them FROM
+			// the db (which is sanitized) so no need to prepare them again.
+			$query   = '
 				DELETE
 				FROM ' . $this->table() . '
 				WHERE
 					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
-            $deleted = $wpdb->query($query);
-        }
-        if ($deleted) {
-            /**
-             * Allows code to do something after the transactions have been deleted.
-             */
-            do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
-        }
+			$deleted = $wpdb->query($query);
+		}
+		if ($deleted) {
+			/**
+			 * Allows code to do something after the transactions have been deleted.
+			 */
+			do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
+		}
         
-        return $deleted;
-    }
+		return $deleted;
+	}
     
     
-    /**
-     * @param array $transaction_IDs
-     *
-     * @return bool
-     */
-    public static function unset_locked_transactions(array $transaction_IDs)
-    {
-        $locked_transactions = get_option('ee_locked_transactions', array());
-        $update              = false;
-        foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[$TXN_ID])) {
-                unset($locked_transactions[$TXN_ID]);
-                $update = true;
-            }
-        }
-        if ($update) {
-            update_option('ee_locked_transactions', $locked_transactions);
-        }
+	/**
+	 * @param array $transaction_IDs
+	 *
+	 * @return bool
+	 */
+	public static function unset_locked_transactions(array $transaction_IDs)
+	{
+		$locked_transactions = get_option('ee_locked_transactions', array());
+		$update              = false;
+		foreach ($transaction_IDs as $TXN_ID) {
+			if (isset($locked_transactions[$TXN_ID])) {
+				unset($locked_transactions[$TXN_ID]);
+				$update = true;
+			}
+		}
+		if ($update) {
+			update_option('ee_locked_transactions', $locked_transactions);
+		}
         
-        return $update;
-    }
+		return $update;
+	}
     
     
 }

Spacing +13 added lines, -13 removed lines

@@ -1,7 +1,7 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 /**
  *
@@ -105,7 +105,7 @@ 
                     __('Registration Steps', 'event_espresso'), false, array()),
             )
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -167,7 +167,7 @@ 
             ),
             OBJECT,
             array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'txnDate' => array('DATE('.$query_interval.')', '%s'),
                 'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
             )
         );
@@ -187,16 +187,16 @@ 
     public function get_revenue_per_event_report($period = '-1 month')
     {
         global $wpdb;
-        $transaction_table       = $wpdb->prefix . 'esp_transaction';
-        $registration_table      = $wpdb->prefix . 'esp_registration';
+        $transaction_table       = $wpdb->prefix.'esp_transaction';
+        $registration_table      = $wpdb->prefix.'esp_registration';
         $event_table             = $wpdb->posts;
-        $payment_table           = $wpdb->prefix . 'esp_payment';
+        $payment_table           = $wpdb->prefix.'esp_payment';
         $sql_date                = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status = EEM_Payment::status_id_approved;
         $extra_event_on_join     = '';
         //exclude events not authored by user if permissions in effect
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
         
         return $wpdb->get_results(
@@ -260,7 +260,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
             '4.6.0'
@@ -308,7 +308,7 @@ 
             array(
                 0 => array(
                     'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
+                    'Payment.PAY_ID' => array('IS NULL'),
                     'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
                 )
             ),
@@ -326,18 +326,18 @@ 
             $time_to_leave_alone
         );
         //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
             // let's get deletin'...
             // Why no wpdb->prepare?  Because the data is trusted.
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+            $query = '
 				DELETE
-				FROM ' . $this->table() . '
+				FROM ' . $this->table().'
 				WHERE
-					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
+					TXN_ID IN ( ' . implode(",", $txn_ids).')';
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {