eventespresso / event-espresso-core

core/libraries/messages/EE_Messages_Queue.lib.php

Indentation +690 added lines, -690 removed lines

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

Spacing +12 added lines, -12 removed lines

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

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +666 added lines, -666 removed lines

@@ -11,674 +11,674 @@
  */
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
-                    // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
-                // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
-                // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION' => '204.0',
-            'USER' => urlencode($this->_api_username),
-            'PWD' => urlencode($this->_api_password),
-            'SIGNATURE' => urlencode($this->_api_signature),
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls, '', '&'),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if ((
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
-                : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
-                : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
-                : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$itemized_list[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+					// Item Number.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+					// Item quantity.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+				// Cost of individual item.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+				// Item quantity.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+				// Digital item is sold.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION' => '204.0',
+			'USER' => urlencode($this->_api_username),
+			'PWD' => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature),
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls, '', '&'),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if ((
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
+				? $data_array[ "L_ERRORCODE{$n}" ]
+				: '';
+			$l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
+				? $data_array[ "L_SEVERITYCODE{$n}" ]
+				: '';
+			$l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
+				? $data_array[ "L_SHORTMESSAGE{$n}" ]
+				: '';
+			$l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
+				? $data_array[ "L_LONGMESSAGE{$n}" ]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 }

Spacing +38 added lines, -38 removed lines

@@ -10,7 +10,7 @@ 
  * ----------------------------------------------
  */
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
@@ -141,7 +141,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -152,7 +152,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -199,13 +199,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -230,7 +230,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -261,7 +261,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -274,7 +274,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -399,7 +399,7 @@ 
         $itemized_list = array();
         $gateway_formatter = $this->_get_gateway_formatter();
         // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (! empty($request_response_args)
+        if ( ! empty($request_response_args)
             && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
             && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
         ) {
@@ -407,7 +407,7 @@ 
                 if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
                     && strpos($arg_key, 'NOTIFYURL') === false
                 ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
+                    $itemized_list[$arg_key] = $arg_val;
                 }
             }
             // If we got only a few Items then something is not right.
@@ -460,25 +460,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemDesc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+                    $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency($unit_price);
                     // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+                    $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -496,7 +496,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -505,17 +505,17 @@ 
                     127
                 );
                 // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+                $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+                $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+                $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -570,7 +570,7 @@ 
             'BUTTONSOURCE' => 'EventEspresso_SP',
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -584,7 +584,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -604,7 +604,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if ((
@@ -651,18 +651,18 @@ 
     {
         $errors = array();
         $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
+        while (isset($data_array["L_ERRORCODE{$n}"])) {
+            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+                ? $data_array["L_ERRORCODE{$n}"]
                 : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
+            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+                ? $data_array["L_SEVERITYCODE{$n}"]
                 : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
+            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+                ? $data_array["L_SHORTMESSAGE{$n}"]
                 : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
+            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+                ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
             if ($n === 0) {
                 $errors = array(
@@ -672,10 +672,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_events.dmsstage.php

Indentation +634 added lines, -639 removed lines

@@ -84,8 +84,6 @@ 
   KEY `submitted` (`submitted`),
   KEY `likes` (`likes`)
 ) ENGINE=InnoDB AUTO_INCREMENT=63 DEFAULT CHARSET=utf8$$
-
-
  *
  * 4.1 Event model:
  * $this->_tables = array(
@@ -124,7 +122,6 @@ 
                 'EVT_donations'=>new EE_Boolean_Field('EVT_donations', __("Accept Donations?", "event_espresso"), false, false)
 
             ));
-
  *
  * 3.1's start end table
  *
@@ -137,8 +134,6 @@ 
   PRIMARY KEY (`id`),
   KEY `event_id` (`event_id`)
 ) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8$$
-
-
  *
  * and 4.1 Datetime model's tables and fields:
  * $this->_tables = array(
@@ -160,172 +155,172 @@ 
  */
 class EE_DMS_4_1_0_events extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_old_start_end_table;
-    private $_new_table;
-    private $_new_meta_table;
-    private $_new_datetime_table;
-
-
-
-    /**
-     * Just initializes the status of the migration
-     * @throws EE_Error
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_detail";
-        $this->_old_start_end_table = $wpdb->prefix."events_start_end";
-        $this->_new_table = $wpdb->prefix."posts";
-        $this->_new_meta_table = $wpdb->prefix."esp_event_meta";
-        $this->_new_datetime_table = $wpdb->prefix."esp_datetime";
-        $this->_pretty_name = __("Events", "event_espresso");
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
-        return intval($count);
-    }
-
-
-
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
-     * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
-     * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
-     * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
-     * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        // because the migration of each event can be a LOT more work, make each step smaller
-        $num_items_to_migrate = max(1, $num_items_to_migrate/5);
-        $events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
-        $items_migrated_this_step = 0;
-
-        foreach ($events as $event_row) {
-            $guid = null;
-            // insert new 4.1 Attendee object using $wpdb
-            $post_id = $this->_insert_cpt($event_row);
-            if ($post_id) {
-                $this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_table, $post_id);
-                $meta_id = $this->_insert_event_meta($event_row, $post_id);
-                if ($meta_id) {
-                    $this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_meta_table, $meta_id);
-                }
-                $this->_convert_start_end_times($event_row, $post_id);
-                $event_meta = maybe_unserialize($event_row['event_meta']);
-                $guid = isset($event_meta['event_thumbnail_url']) ? $event_meta['event_thumbnail_url'] : null;
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $post_id, $this);
-
-                // maybe create a venue from info on the event?
-                $new_venue_id = $this->_maybe_create_venue($event_row);
-                if ($new_venue_id) {
-                    $this->_insert_new_venue_to_event($post_id, $new_venue_id);
-                }
-                $this->_add_post_metas($event_row, $post_id);
-            }
-            $items_migrated_this_step++;
-            if ($guid) {
-                // if we had to check for an image attachment
-                // then let's call it a day (avoid timing out, because this took a long time)
-                break;
-            }
-        }
-        if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
-            $this->set_status(EE_Data_Migration_Manager::status_completed);
-        }
-        return $items_migrated_this_step;
-    }
-
-    /**
-     * Stores any extra 3.1 "event_meta" column things as post meta
-     * @param array $old_event
-     * @param int $post_id
-     * @return void
-     */
-    private function _add_post_metas($old_event, $post_id)
-    {
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
-            return;
-        }
-        unset($event_meta['date_submitted']);// factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);// dido
-        unset($event_meta['event_thumbnail_url']);// used to find post featured image
-        foreach ($event_meta as $meta_key => $meta_value) {
-            if ($meta_key) {// if the meta key is just an empty string, ignore it
-                $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
-                    $this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
-                }
-            }
-        }
-        if ($old_event['alt_email']) {
-            add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
-        }
-        if ($old_event['recurrence_id']) {
-            add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
-        }
-    }
-
-
-
-    /**
-     * Finds a unique slug for this event, given its name (we could have simply used
-     * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
-     * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
-     * @param string $event_name (the name of the event for reading by humans)
-     * @param string $old_identifier the old EE3 identifier (a long unique string)
-     * @param string $new_post_status a post status
-     * @return string
-     */
-    private function _find_unique_slug($event_name, $old_identifier = '', $new_post_status = 'publish')
-    {
-        $count = 0;
-        $original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
-        return wp_unique_post_slug($original_name, 0, $new_post_status, 'espresso_events', 0);
-    }
-
-    /**
-     * returns whether or not there is a post that has this same slug (post_title)
-     * @global wpdb $wpdb
-     * @param string $slug
-     * @return boolean
-     */
-    private function _other_post_exists_with_that_slug($slug)
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("SELECT COUNT(ID) FROM {$this->_new_table} WHERE event_status != 'D' AND post_name = %s", $slug);
-        $count = $wpdb->get_var($query);
-        return (boolean) intval($count);
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _insert_cpt($old_event)
-    {
-        global $wpdb;
-        // convert 3.1 event status to 4.1 CPT status
-        // for reference, 3.1 event stati available for setting are:
+	private $_old_table;
+	private $_old_start_end_table;
+	private $_new_table;
+	private $_new_meta_table;
+	private $_new_datetime_table;
+
+
+
+	/**
+	 * Just initializes the status of the migration
+	 * @throws EE_Error
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_detail";
+		$this->_old_start_end_table = $wpdb->prefix."events_start_end";
+		$this->_new_table = $wpdb->prefix."posts";
+		$this->_new_meta_table = $wpdb->prefix."esp_event_meta";
+		$this->_new_datetime_table = $wpdb->prefix."esp_datetime";
+		$this->_pretty_name = __("Events", "event_espresso");
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
+		return intval($count);
+	}
+
+
+
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
+	 * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
+	 * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
+	 * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
+	 * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		// because the migration of each event can be a LOT more work, make each step smaller
+		$num_items_to_migrate = max(1, $num_items_to_migrate/5);
+		$events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
+		$items_migrated_this_step = 0;
+
+		foreach ($events as $event_row) {
+			$guid = null;
+			// insert new 4.1 Attendee object using $wpdb
+			$post_id = $this->_insert_cpt($event_row);
+			if ($post_id) {
+				$this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_table, $post_id);
+				$meta_id = $this->_insert_event_meta($event_row, $post_id);
+				if ($meta_id) {
+					$this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_meta_table, $meta_id);
+				}
+				$this->_convert_start_end_times($event_row, $post_id);
+				$event_meta = maybe_unserialize($event_row['event_meta']);
+				$guid = isset($event_meta['event_thumbnail_url']) ? $event_meta['event_thumbnail_url'] : null;
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $post_id, $this);
+
+				// maybe create a venue from info on the event?
+				$new_venue_id = $this->_maybe_create_venue($event_row);
+				if ($new_venue_id) {
+					$this->_insert_new_venue_to_event($post_id, $new_venue_id);
+				}
+				$this->_add_post_metas($event_row, $post_id);
+			}
+			$items_migrated_this_step++;
+			if ($guid) {
+				// if we had to check for an image attachment
+				// then let's call it a day (avoid timing out, because this took a long time)
+				break;
+			}
+		}
+		if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
+			$this->set_status(EE_Data_Migration_Manager::status_completed);
+		}
+		return $items_migrated_this_step;
+	}
+
+	/**
+	 * Stores any extra 3.1 "event_meta" column things as post meta
+	 * @param array $old_event
+	 * @param int $post_id
+	 * @return void
+	 */
+	private function _add_post_metas($old_event, $post_id)
+	{
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (! $event_meta || ! is_array($event_meta)) {
+			return;
+		}
+		unset($event_meta['date_submitted']);// factored into CPT
+		unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
+		unset($event_meta['default_payment_status']);// dido
+		unset($event_meta['event_thumbnail_url']);// used to find post featured image
+		foreach ($event_meta as $meta_key => $meta_value) {
+			if ($meta_key) {// if the meta key is just an empty string, ignore it
+				$success = add_post_meta($post_id, $meta_key, $meta_value, true);
+				if (! $success) {
+					$this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
+				}
+			}
+		}
+		if ($old_event['alt_email']) {
+			add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
+		}
+		if ($old_event['recurrence_id']) {
+			add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
+		}
+	}
+
+
+
+	/**
+	 * Finds a unique slug for this event, given its name (we could have simply used
+	 * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
+	 * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
+	 * @param string $event_name (the name of the event for reading by humans)
+	 * @param string $old_identifier the old EE3 identifier (a long unique string)
+	 * @param string $new_post_status a post status
+	 * @return string
+	 */
+	private function _find_unique_slug($event_name, $old_identifier = '', $new_post_status = 'publish')
+	{
+		$count = 0;
+		$original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
+		return wp_unique_post_slug($original_name, 0, $new_post_status, 'espresso_events', 0);
+	}
+
+	/**
+	 * returns whether or not there is a post that has this same slug (post_title)
+	 * @global wpdb $wpdb
+	 * @param string $slug
+	 * @return boolean
+	 */
+	private function _other_post_exists_with_that_slug($slug)
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("SELECT COUNT(ID) FROM {$this->_new_table} WHERE event_status != 'D' AND post_name = %s", $slug);
+		$count = $wpdb->get_var($query);
+		return (boolean) intval($count);
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _insert_cpt($old_event)
+	{
+		global $wpdb;
+		// convert 3.1 event status to 4.1 CPT status
+		// for reference, 3.1 event stati available for setting are:
 //      $status = array(array('id' => 'A', 'text' => __('Public', 'event_espresso')), array('id' => 'S', 'text' => __('Waitlist', 'event_espresso')), array('id' => 'O', 'text' => __('Ongoing', 'event_espresso')), array('id' => 'R', 'text' => __('Draft', 'event_espresso')), array('id' => 'D', 'text' => __('Deleted', 'event_espresso')));
 //      and the json api uses the following to convert from 3.1 to 4.0
 //      'S'=>'secondary/waitlist',
@@ -339,486 +334,486 @@ 
 //      4.1 Event Post stati are the normal post statis
 //      (publish,future,draft,pending,private,trash,auto-draft,inherit)
 //      and 3 custom ones: cancelled,postponed,sold_out
-        $status_conversions = array(
-            'R'=>'draft',
-            'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
-            'P'=>'pending',
-            'IA'=>'draft',// draft and in the past
+		$status_conversions = array(
+			'R'=>'draft',
+			'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
+			'P'=>'pending',
+			'IA'=>'draft',// draft and in the past
 // IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
-            'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
-            'A'=>'publish',
-            'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
-            'D'=>'trash',
-        );
-        $post_status = $status_conversions[ $old_event['event_status'] ];
-        // check if we've sold out
-        if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
-            $post_status = 'sold_out';
-        }
+			'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
+			'A'=>'publish',
+			'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
+			'D'=>'trash',
+		);
+		$post_status = $status_conversions[ $old_event['event_status'] ];
+		// check if we've sold out
+		if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
+			$post_status = 'sold_out';
+		}
 //      FYI postponed and cancelled don't exist in 3.1
-        $cols_n_values = array(
-            'post_title'=>stripslashes($old_event['event_name']),// EVT_name
-            'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
-            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
-            'post_date'=>$old_event['submitted'],// EVT_created NOT
-            'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'=>'',// EVT_short_desc
-            'post_modified'=>$old_event['submitted'],// EVT_modified
-            'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_author'=>$old_event['wp_user'],// EVT_wp_user
-            'post_parent'=>0,// parent maybe get this from some REM field?
-            'menu_order'=>0,// EVT_order
-            'post_type'=>'espresso_events',// post_type
-            'post_status'=>$post_status,// status
-        );
-        $cols_n_values_with_no_invalid_text = array();
-        foreach ($cols_n_values as $col => $value) {
-            $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
-            } else {
-                // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
-            }
-        }
-        $cols_n_values = $cols_n_values_with_no_invalid_text;
-        $datatypes = array(
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
-            '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
-            '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
-        );
-        $success = $wpdb->insert(
-            $this->_new_table,
-            $cols_n_values,
-            $datatypes
-        );
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent various registrations)
-     * @global wpdb $wpdb
-     * @param int $event_id
-     * @return int
-     */
-    public static function count_registrations($event_id)
-    {
-        global $wpdb;
-        $count = $wpdb->get_var($wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id));
-        return intval($count);
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @param $new_cpt_id
-     * @return int
-     */
-    private function _insert_event_meta($old_event, $new_cpt_id)
-    {
-        global $wpdb;
-        $event_meta = maybe_unserialize($old_event['event_meta']);
+		$cols_n_values = array(
+			'post_title'=>stripslashes($old_event['event_name']),// EVT_name
+			'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
+			'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
+			'post_date'=>$old_event['submitted'],// EVT_created NOT
+			'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
+			'post_excerpt'=>'',// EVT_short_desc
+			'post_modified'=>$old_event['submitted'],// EVT_modified
+			'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
+			'post_author'=>$old_event['wp_user'],// EVT_wp_user
+			'post_parent'=>0,// parent maybe get this from some REM field?
+			'menu_order'=>0,// EVT_order
+			'post_type'=>'espresso_events',// post_type
+			'post_status'=>$post_status,// status
+		);
+		$cols_n_values_with_no_invalid_text = array();
+		foreach ($cols_n_values as $col => $value) {
+			$value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
+			if (! is_wp_error($value_sans_invalid_chars)) {
+				$cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+			} else {
+				// otherwise leave it as-is. It will blow everything up and stop the migration
+				$cols_n_values_with_no_invalid_text[ $col ] = $value;
+			}
+		}
+		$cols_n_values = $cols_n_values_with_no_invalid_text;
+		$datatypes = array(
+			'%s',// EVT_name
+			'%s',// EVT_desc
+			'%s',// EVT_slug
+			'%s',// EVT_created
+			'%s',
+			'%s',// EVT_short_desc
+			'%s',// EVT_modified
+			'%s',
+			'%s',// EVT_wp_user
+			'%d',// post_parent
+			'%d',// EVT_order
+			'%s',// post_type
+			'%s',// status
+		);
+		$success = $wpdb->insert(
+			$this->_new_table,
+			$cols_n_values,
+			$datatypes
+		);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent various registrations)
+	 * @global wpdb $wpdb
+	 * @param int $event_id
+	 * @return int
+	 */
+	public static function count_registrations($event_id)
+	{
+		global $wpdb;
+		$count = $wpdb->get_var($wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id));
+		return intval($count);
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @param $new_cpt_id
+	 * @return int
+	 */
+	private function _insert_event_meta($old_event, $new_cpt_id)
+	{
+		global $wpdb;
+		$event_meta = maybe_unserialize($old_event['event_meta']);
 //      for reference, 3.1 'default_payment_status' are: $default_payment_status = array(
 //  array('id' => "", 'text' => 'No Change'),
 //  array('id' => 'Incomplete', 'text' => 'Incomplete'),
 //  array('id' => 'Pending', 'text' => 'Pending'),
 //  //array('id' => 'Completed', 'text' => 'Completed')
 // );
-        $default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
-        $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
-            'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
-            'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
-            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
-            'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
-            'EVT_default_registration_status' => $default_reg_status,
-            'EVT_member_only'=>$old_event['member_only'],
-            'EVT_phone'=> $old_event['phone'],
-            'EVT_allow_overflow' => 'Y' == $old_event['allow_overflow'],
-            'EVT_timezone_string'=> $old_event['timezone_string'],
-            'EVT_external_URL'=>$old_event['externalURL'],
-            'EVT_donations'=>false// doesnt exist in 3.1
-
-        );
-        $datatypes = array(
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
-        );
-        $success = $wpdb->insert(
-            $this->_new_meta_table,
-            $cols_n_values,
-            $datatypes
-        );
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _maybe_create_venue($old_event)
-    {
-        if ($old_event['address'] ||
-                $old_event['address2'] ||
-                $old_event['city'] ||
-                $old_event['state'] ||
-                $old_event['zip'] ||
-                $old_event['venue_title'] ||
-                $old_event['venue_url'] ||
-                $old_event['venue_image'] ||
-                $old_event['venue_phone'] ||
-                $old_event['virtual_url'] ||
-                $old_event['virtual_phone']
-                ) {
-            $old_id = $this->_duplicate_venue_exists($old_event);
-            if ($old_id) {
-                return $old_id;
-            }
-            $new_id = $this->_insert_venue_into_posts($old_event);
-            if ($new_id) {
-                $this->_insert_venue_into_meta_table($new_id, $old_event);
-                $guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
-            }
-            // we don't bother recording the conversion from old events to venues as that
-            // will complicate finding the conversion from old venues to new events
-            return $new_id;
-        } else {
-            return 0;
-        }
-    }
-
-    /**
-     * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
-     * If so, return it. Otherwise return NULL.
-     * @param array $old_event
-     * @return int duplicate venue id
-     */
-    private function _duplicate_venue_exists($old_event)
-    {
-        global $wpdb;
-        $conditions = array(
-            'VNU_address' => $old_event ['address'],
-            'VNU_address2' => $old_event['address2'],
-            'VNU_city' => $old_event['city'],
-            'VNU_zip' => $old_event['zip'],
-            'post_title'=> $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-        );
-        $sql_conditions = array();
-        foreach ($conditions as $column => $value) {
-            $sql_conditions [] = $wpdb->prepare("$column = %s", $value);
-        }
-        $query = "SELECT VNU_ID
+		$default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
+		$cols_n_values = array(
+			'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
+			'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
+			'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
+			'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
+			'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
+			'EVT_default_registration_status' => $default_reg_status,
+			'EVT_member_only'=>$old_event['member_only'],
+			'EVT_phone'=> $old_event['phone'],
+			'EVT_allow_overflow' => 'Y' == $old_event['allow_overflow'],
+			'EVT_timezone_string'=> $old_event['timezone_string'],
+			'EVT_external_URL'=>$old_event['externalURL'],
+			'EVT_donations'=>false// doesnt exist in 3.1
+
+		);
+		$datatypes = array(
+			'%s',// EVT_ID
+			'%d',// EVT_display_desc
+			'%d',// EVT_display_ticket_selector
+			'%s',// EVT_visible_on
+			'%d',// EVT_additional_limit
+			'%s',// EVT_default_registration_status
+			'%d',// EVT_member_only
+			'%s',// EVT_phone
+			'%d',// EVT_allow_overflow
+			'%s',// EVT_timezone_string
+			'%s',// EVT_external_URL
+			'%d',// EVT_donations
+		);
+		$success = $wpdb->insert(
+			$this->_new_meta_table,
+			$cols_n_values,
+			$datatypes
+		);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _maybe_create_venue($old_event)
+	{
+		if ($old_event['address'] ||
+				$old_event['address2'] ||
+				$old_event['city'] ||
+				$old_event['state'] ||
+				$old_event['zip'] ||
+				$old_event['venue_title'] ||
+				$old_event['venue_url'] ||
+				$old_event['venue_image'] ||
+				$old_event['venue_phone'] ||
+				$old_event['virtual_url'] ||
+				$old_event['virtual_phone']
+				) {
+			$old_id = $this->_duplicate_venue_exists($old_event);
+			if ($old_id) {
+				return $old_id;
+			}
+			$new_id = $this->_insert_venue_into_posts($old_event);
+			if ($new_id) {
+				$this->_insert_venue_into_meta_table($new_id, $old_event);
+				$guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
+			}
+			// we don't bother recording the conversion from old events to venues as that
+			// will complicate finding the conversion from old venues to new events
+			return $new_id;
+		} else {
+			return 0;
+		}
+	}
+
+	/**
+	 * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
+	 * If so, return it. Otherwise return NULL.
+	 * @param array $old_event
+	 * @return int duplicate venue id
+	 */
+	private function _duplicate_venue_exists($old_event)
+	{
+		global $wpdb;
+		$conditions = array(
+			'VNU_address' => $old_event ['address'],
+			'VNU_address2' => $old_event['address2'],
+			'VNU_city' => $old_event['city'],
+			'VNU_zip' => $old_event['zip'],
+			'post_title'=> $this->_get_venue_title_for_event($old_event),
+			'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
+			'VNU_url'=>$old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+		);
+		$sql_conditions = array();
+		foreach ($conditions as $column => $value) {
+			$sql_conditions [] = $wpdb->prepare("$column = %s", $value);
+		}
+		$query = "SELECT VNU_ID
 					FROM
 		{$wpdb->posts} as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
 			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
-        $id = $wpdb->get_var($query);
-        return $id;
-    }
-
-    /**
-     * Gets teh venue's title or makes one up if there is none
-     * @param array $event_data_array keys are events_details columns and values are their values
-     * @return string
-     */
-    protected function _get_venue_title_for_event($event_data_array)
-    {
-        return $event_data_array['venue_title'] ? stripslashes($event_data_array['venue_title']) : stripslashes(sprintf(__('Venue of %s', 'event_espresso'), $event_data_array['event_name']));
-    }
-
-    /**
-     * Inserts the CPT
-     *
-     * @param array $old_event keys are cols, values are col values
-     * @return int
-     */
-    private function _insert_venue_into_posts($old_event)
-    {
-        global $wpdb;
-        $insertion_array = array(
-                    'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
-                    'post_content'=>'',// VNU_desc
-                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
-                    'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
-                    'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_author'=>$old_event['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
-                    'post_type'=>'espresso_venues'// post_type
-                );
-        $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
-                    '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
-                    '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
-                );
-        $success = $wpdb->insert(
-            $wpdb->posts,
-            $insertion_array,
-            $datatypes_array
-        );
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_table,
-                    $insertion_array,
-                    $datatypes_array
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Inserts into the venue_meta table
-     * @param int $cpt_id
-     * @param array $old_event
-     * @return int
-     */
-    private function _insert_venue_into_meta_table($cpt_id, $old_event)
-    {
-        global $wpdb;
-
-        // assume the country is the same as the organization's old settings
-        $country_iso = $this->get_migration_script()->get_default_country_iso();
-        // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
-            $old_org_options = get_option('events_organization_settings');
-            $state_name = stripslashes($old_org_options['organization_state']);
-        } else {
-            $state_name = $old_event['state'];
-        }
-        if (! $state_name) {
-            $state_name = 'CA';
-        }
-        // get a state ID with the same name, if possible
-        try {
-            $state = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
-            $state_id = $state['STA_ID'];
-        } catch (EE_Error $e) {
-            $this->add_error($e->getMessage());
-            $state_id = 0;
-        }
-        // now insert into meta table
-        $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_event['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>$old_event['zip'],// VNU_zip
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
-            'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
-        );
-        $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
-        );
-        $success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-
-    /**
-     * @param $new_event_id
-     * @param $new_venue_id
-     * @return int
-     */
-    private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
-    {
-        global $wpdb;
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
-            return 0;
-        }
-        if (! $new_venue_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
-            return 0;
-        }
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'VNU_ID'=>$new_venue_id,
-            'EVV_primary'=>true
-        );
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
-        );
-        $success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    array(),
-                    $this->_new_table,
-                    $cols_n_values,
-                    $datatypes
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-    /**
-     * Converts all the 3.1 start-end times for the event to 4.1 datetimes
-     * @global wpdb $wpdb
-     * @param array $old_event results of get_results(...,ARRAY_A)
-     * @param int $new_cpt_id new post ID
-     * @return void (if there are errors though, adds them to the stage's error list
-     */
-    private function _convert_start_end_times($old_event, $new_cpt_id)
-    {
-        $start_end_times = $this->_get_old_start_end_times($old_event['id']);
-        foreach ($start_end_times as $start_end_time) {
-            $datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
-            if ($datetime_id) {
-                $this->get_migration_script()->set_mapping($this->_old_start_end_table, $start_end_time['id'], $this->_new_datetime_table, $datetime_id);
-            }
-        }
-    }
-    /**
-     * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
-     * @global wpdb $wpdb
-     * @param int $old_event_id
-     * @return array
-     */
-    private function _get_old_start_end_times($old_event_id)
-    {
-        global $wpdb;
-        return $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id), ARRAY_A);
-    }
-    /**
-     * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
-     * @param array $start_end_time_row
-     * @param array $old_event_row
-     * @param int $new_cpt_id
-     * @return int ID of new datetime
-     */
-    private function _insert_new_datetime($start_end_time_row, $old_event_row, $new_cpt_id)
-    {
-        global $wpdb;
-        $start_date = $old_event_row['start_date'];
-        $start_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
-        $end_date = $old_event_row['end_date'];
-        $end_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
-        $existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
-        $start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
-        $end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
-        $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID
-            'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
-            'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
-            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
-            'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
+		$id = $wpdb->get_var($query);
+		return $id;
+	}
+
+	/**
+	 * Gets teh venue's title or makes one up if there is none
+	 * @param array $event_data_array keys are events_details columns and values are their values
+	 * @return string
+	 */
+	protected function _get_venue_title_for_event($event_data_array)
+	{
+		return $event_data_array['venue_title'] ? stripslashes($event_data_array['venue_title']) : stripslashes(sprintf(__('Venue of %s', 'event_espresso'), $event_data_array['event_name']));
+	}
+
+	/**
+	 * Inserts the CPT
+	 *
+	 * @param array $old_event keys are cols, values are col values
+	 * @return int
+	 */
+	private function _insert_venue_into_posts($old_event)
+	{
+		global $wpdb;
+		$insertion_array = array(
+					'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
+					'post_content'=>'',// VNU_desc
+					'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
+					'post_date'=>current_time('mysql'),// VNU_created
+					'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
+					'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
+					'post_modified'=>current_time('mysql'),// VNU_modified
+					'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
+					'post_author'=>$old_event['wp_user'],// VNU_wp_user
+					'post_parent'=>0,// parent
+					'menu_order'=>0,// VNU_order
+					'post_type'=>'espresso_venues'// post_type
+				);
+		$datatypes_array = array(
+					'%s',// VNU_name
+					'%s',// VNU_desc
+					'%s',// VNU_identifier
+					'%s',// VNU_created
+					'%s',
+					'%s',// VNU_short_desc
+					'%s',// VNU_modified
+					'%s',
+					'%d',// VNU_wp_user
+					'%d',// parent
+					'%d',// VNU_order
+					'%s',// post_type
+				);
+		$success = $wpdb->insert(
+			$wpdb->posts,
+			$insertion_array,
+			$datatypes_array
+		);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_table,
+					$insertion_array,
+					$datatypes_array
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Inserts into the venue_meta table
+	 * @param int $cpt_id
+	 * @param array $old_event
+	 * @return int
+	 */
+	private function _insert_venue_into_meta_table($cpt_id, $old_event)
+	{
+		global $wpdb;
+
+		// assume the country is the same as the organization's old settings
+		$country_iso = $this->get_migration_script()->get_default_country_iso();
+		// find the state from the venue, or the organization, or just guess california
+		if (! $old_event['state']) {
+			$old_org_options = get_option('events_organization_settings');
+			$state_name = stripslashes($old_org_options['organization_state']);
+		} else {
+			$state_name = $old_event['state'];
+		}
+		if (! $state_name) {
+			$state_name = 'CA';
+		}
+		// get a state ID with the same name, if possible
+		try {
+			$state = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
+			$state_id = $state['STA_ID'];
+		} catch (EE_Error $e) {
+			$this->add_error($e->getMessage());
+			$state_id = 0;
+		}
+		// now insert into meta table
+		$insertion_array = array(
+			'VNU_ID'=>$cpt_id,// VNU_ID_fk
+			'VNU_address'=>stripslashes($old_event['address']),// VNU_address
+			'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
+			'VNU_city'=>stripslashes($old_event['city']),// VNU_city
+			'STA_ID'=>$state_id,// STA_ID
+			'CNT_ISO'=>$country_iso,// CNT_ISO
+			'VNU_zip'=>$old_event['zip'],// VNU_zip
+			'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
+			'VNU_capacity'=>-1,// VNU_capacity
+			'VNU_url'=>$old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+			'VNU_google_map_link'=>'',// VNU_google_map_link
+			'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
+		);
+		$datatypes = array(
+			'%d',// VNU_ID_fk
+			'%s',// VNU_address
+			'%s',// VNU_address2
+			'%s',// VNU_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// VNU_zip
+			'%s',// VNU_phone
+			'%d',// VNU_capacity
+			'%s',// VNU_url
+			'%s',// VNU_virtual_phone
+			'%s',// VNU_virtual_url
+			'%s',// VNU_google_map_link
+			'%d',// VNU_enable_for_gmap
+		);
+		$success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+
+	/**
+	 * @param $new_event_id
+	 * @param $new_venue_id
+	 * @return int
+	 */
+	private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
+	{
+		global $wpdb;
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
+			return 0;
+		}
+		if (! $new_venue_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
+			return 0;
+		}
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'VNU_ID'=>$new_venue_id,
+			'EVV_primary'=>true
+		);
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// VNU_ID
+			'%d',// EVT_primary
+		);
+		$success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					array(),
+					$this->_new_table,
+					$cols_n_values,
+					$datatypes
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+	/**
+	 * Converts all the 3.1 start-end times for the event to 4.1 datetimes
+	 * @global wpdb $wpdb
+	 * @param array $old_event results of get_results(...,ARRAY_A)
+	 * @param int $new_cpt_id new post ID
+	 * @return void (if there are errors though, adds them to the stage's error list
+	 */
+	private function _convert_start_end_times($old_event, $new_cpt_id)
+	{
+		$start_end_times = $this->_get_old_start_end_times($old_event['id']);
+		foreach ($start_end_times as $start_end_time) {
+			$datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
+			if ($datetime_id) {
+				$this->get_migration_script()->set_mapping($this->_old_start_end_table, $start_end_time['id'], $this->_new_datetime_table, $datetime_id);
+			}
+		}
+	}
+	/**
+	 * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
+	 * @global wpdb $wpdb
+	 * @param int $old_event_id
+	 * @return array
+	 */
+	private function _get_old_start_end_times($old_event_id)
+	{
+		global $wpdb;
+		return $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id), ARRAY_A);
+	}
+	/**
+	 * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
+	 * @param array $start_end_time_row
+	 * @param array $old_event_row
+	 * @param int $new_cpt_id
+	 * @return int ID of new datetime
+	 */
+	private function _insert_new_datetime($start_end_time_row, $old_event_row, $new_cpt_id)
+	{
+		global $wpdb;
+		$start_date = $old_event_row['start_date'];
+		$start_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
+		$end_date = $old_event_row['end_date'];
+		$end_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
+		$existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
+		$start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
+		$end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
+		$cols_n_values = array(
+			'EVT_ID'=>$new_cpt_id,// EVT_ID
+			'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
+			'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
+			'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
+			'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
 //          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
-            'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
-            'DTT_parent'=>0,
-            'DTT_deleted'=>false
-        );
-        $datatypes = array(
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
+			'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
+			'DTT_parent'=>0,
+			'DTT_deleted'=>false
+		);
+		$datatypes = array(
+			'%d',// EVT_Id
+			'%s',// DTT_EVT_start
+			'%s',// DTT_EVT_end
+			'%d',// DTT_reg_limit
+			'%d',// DTT_sold
 //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
-        );
-        $success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
-     * when deciding whether a datetime we're about ot insert should be the 'primary' or not
-     * @global wpdb $wpdb
-     * @param int $cpt_event_id
-     * @return int
-     */
-    private function _count_other_datetimes_exist_for_new_event($cpt_event_id)
-    {
-        global $wpdb;
-        $count = $wpdb->get_var($wpdb->prepare("SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d", $cpt_event_id));
-        return intval($count);
-    }
+			'%d',// DTT_order
+			'%d',// DTT_parent
+			'%d',// DTT_deleted
+		);
+		$success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
+	 * when deciding whether a datetime we're about ot insert should be the 'primary' or not
+	 * @global wpdb $wpdb
+	 * @param int $cpt_event_id
+	 * @return int
+	 */
+	private function _count_other_datetimes_exist_for_new_event($cpt_event_id)
+	{
+		global $wpdb;
+		$count = $wpdb->get_var($wpdb->prepare("SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d", $cpt_event_id));
+		return intval($count);
+	}
 }

Spacing +132 added lines, -132 removed lines

@@ -193,7 +193,7 @@ 
     public function _count_records_to_migrate()
     {
         global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
+        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table.' WHERE event_status !="D"');
         return intval($count);
     }
 
@@ -212,7 +212,7 @@ 
     {
         global $wpdb;
         // because the migration of each event can be a LOT more work, make each step smaller
-        $num_items_to_migrate = max(1, $num_items_to_migrate/5);
+        $num_items_to_migrate = max(1, $num_items_to_migrate / 5);
         $events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
         $items_migrated_this_step = 0;
 
@@ -260,17 +260,17 @@ 
     private function _add_post_metas($old_event, $post_id)
     {
         $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
+        if ( ! $event_meta || ! is_array($event_meta)) {
             return;
         }
-        unset($event_meta['date_submitted']);// factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);// dido
-        unset($event_meta['event_thumbnail_url']);// used to find post featured image
+        unset($event_meta['date_submitted']); // factored into CPT
+        unset($event_meta['additional_attendee_reg_info']); // factored into event meta table
+        unset($event_meta['default_payment_status']); // dido
+        unset($event_meta['event_thumbnail_url']); // used to find post featured image
         foreach ($event_meta as $meta_key => $meta_value) {
             if ($meta_key) {// if the meta key is just an empty string, ignore it
                 $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
+                if ( ! $success) {
                     $this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
                 }
             }
@@ -341,68 +341,68 @@ 
 //      and 3 custom ones: cancelled,postponed,sold_out
         $status_conversions = array(
             'R'=>'draft',
-            'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
+            'X'=>'draft', // 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
             'P'=>'pending',
-            'IA'=>'draft',// draft and in the past
+            'IA'=>'draft', // draft and in the past
 // IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
-            'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
+            'O'=>'publish', // @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
             'A'=>'publish',
-            'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
+            'S'=>'draft', // @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
             'D'=>'trash',
         );
-        $post_status = $status_conversions[ $old_event['event_status'] ];
+        $post_status = $status_conversions[$old_event['event_status']];
         // check if we've sold out
         if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
             $post_status = 'sold_out';
         }
 //      FYI postponed and cancelled don't exist in 3.1
         $cols_n_values = array(
-            'post_title'=>stripslashes($old_event['event_name']),// EVT_name
-            'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
-            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
-            'post_date'=>$old_event['submitted'],// EVT_created NOT
+            'post_title'=>stripslashes($old_event['event_name']), // EVT_name
+            'post_content'=>stripslashes($old_event['event_desc']), // EVT_desc
+            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status), // EVT_slug
+            'post_date'=>$old_event['submitted'], // EVT_created NOT
             'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'=>'',// EVT_short_desc
-            'post_modified'=>$old_event['submitted'],// EVT_modified
+            'post_excerpt'=>'', // EVT_short_desc
+            'post_modified'=>$old_event['submitted'], // EVT_modified
             'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_author'=>$old_event['wp_user'],// EVT_wp_user
-            'post_parent'=>0,// parent maybe get this from some REM field?
-            'menu_order'=>0,// EVT_order
-            'post_type'=>'espresso_events',// post_type
-            'post_status'=>$post_status,// status
+            'post_author'=>$old_event['wp_user'], // EVT_wp_user
+            'post_parent'=>0, // parent maybe get this from some REM field?
+            'menu_order'=>0, // EVT_order
+            'post_type'=>'espresso_events', // post_type
+            'post_status'=>$post_status, // status
         );
         $cols_n_values_with_no_invalid_text = array();
         foreach ($cols_n_values as $col => $value) {
             $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+            if ( ! is_wp_error($value_sans_invalid_chars)) {
+                $cols_n_values_with_no_invalid_text[$col] = $value_sans_invalid_chars;
             } else {
                 // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
+                $cols_n_values_with_no_invalid_text[$col] = $value;
             }
         }
         $cols_n_values = $cols_n_values_with_no_invalid_text;
         $datatypes = array(
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
+            '%s', // EVT_name
+            '%s', // EVT_desc
+            '%s', // EVT_slug
+            '%s', // EVT_created
             '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
+            '%s', // EVT_short_desc
+            '%s', // EVT_modified
             '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
+            '%s', // EVT_wp_user
+            '%d', // post_parent
+            '%d', // EVT_order
+            '%s', // post_type
+            '%s', // status
         );
         $success = $wpdb->insert(
             $this->_new_table,
             $cols_n_values,
             $datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -441,10 +441,10 @@ 
 // );
         $default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
         $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
+            'EVT_ID'=>$new_cpt_id, // EVT_ID_fk
             'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
-            'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
-            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
+            'EVT_display_ticket_selector'=> 'Y' == $old_event['display_reg_form'],
+            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']), // don't use the old 'visible_on', as it wasn't ever used
             'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
             'EVT_default_registration_status' => $default_reg_status,
             'EVT_member_only'=>$old_event['member_only'],
@@ -456,25 +456,25 @@ 
 
         );
         $datatypes = array(
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
+            '%s', // EVT_ID
+            '%d', // EVT_display_desc
+            '%d', // EVT_display_ticket_selector
+            '%s', // EVT_visible_on
+            '%d', // EVT_additional_limit
+            '%s', // EVT_default_registration_status
+            '%d', // EVT_member_only
+            '%s', // EVT_phone
+            '%d', // EVT_allow_overflow
+            '%s', // EVT_timezone_string
+            '%s', // EVT_external_URL
+            '%d', // EVT_donations
         );
         $success = $wpdb->insert(
             $this->_new_meta_table,
             $cols_n_values,
             $datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -508,7 +508,7 @@ 
             $new_id = $this->_insert_venue_into_posts($old_event);
             if ($new_id) {
                 $this->_insert_venue_into_meta_table($new_id, $old_event);
-                $guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
+                $guid = isset($old_event['venue_image']) ? $old_event['venue_image'] : null;
                 $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
             }
             // we don't bother recording the conversion from old events to venues as that
@@ -534,10 +534,10 @@ 
             'VNU_city' => $old_event['city'],
             'VNU_zip' => $old_event['zip'],
             'post_title'=> $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+            'VNU_phone'=>$old_event['venue_phone'], // VNU_phone
+            'VNU_url'=>$old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone'=>$old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'=>$old_event['virtual_url'], // VNU_virtual_url
         );
         $sql_conditions = array();
         foreach ($conditions as $column => $value) {
@@ -547,7 +547,7 @@ 
 					FROM
 		{$wpdb->posts} as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
-			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
+			WHERE ".implode(" AND ", $sql_conditions)." LIMIT 1";
         $id = $wpdb->get_var($query);
         return $id;
     }
@@ -572,39 +572,39 @@ 
     {
         global $wpdb;
         $insertion_array = array(
-                    'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
-                    'post_content'=>'',// VNU_desc
-                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
+                    'post_title'=> $this->_get_venue_title_for_event($old_event), // VNU_name
+                    'post_content'=>'', // VNU_desc
+                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-'.$old_event['event_name'])), // VNU_identifier
+                    'post_date'=>current_time('mysql'), // VNU_created
                     'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
+                    'post_excerpt'=>'', // VNU_short_desc arbitrary only 50 characters
+                    'post_modified'=>current_time('mysql'), // VNU_modified
                     'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_author'=>$old_event['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
+                    'post_author'=>$old_event['wp_user'], // VNU_wp_user
+                    'post_parent'=>0, // parent
+                    'menu_order'=>0, // VNU_order
                     'post_type'=>'espresso_venues'// post_type
                 );
         $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
+                    '%s', // VNU_name
+                    '%s', // VNU_desc
+                    '%s', // VNU_identifier
+                    '%s', // VNU_created
                     '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
+                    '%s', // VNU_short_desc
+                    '%s', // VNU_modified
                     '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
+                    '%d', // VNU_wp_user
+                    '%d', // parent
+                    '%d', // VNU_order
+                    '%s', // post_type
                 );
         $success = $wpdb->insert(
             $wpdb->posts,
             $insertion_array,
             $datatypes_array
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -632,13 +632,13 @@ 
         // assume the country is the same as the organization's old settings
         $country_iso = $this->get_migration_script()->get_default_country_iso();
         // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
+        if ( ! $old_event['state']) {
             $old_org_options = get_option('events_organization_settings');
             $state_name = stripslashes($old_org_options['organization_state']);
         } else {
             $state_name = $old_event['state'];
         }
-        if (! $state_name) {
+        if ( ! $state_name) {
             $state_name = 'CA';
         }
         // get a state ID with the same name, if possible
@@ -651,39 +651,39 @@ 
         }
         // now insert into meta table
         $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_event['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>$old_event['zip'],// VNU_zip
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
+            'VNU_ID'=>$cpt_id, // VNU_ID_fk
+            'VNU_address'=>stripslashes($old_event['address']), // VNU_address
+            'VNU_address2'=>stripslashes($old_event['address2']), // VNU_address2
+            'VNU_city'=>stripslashes($old_event['city']), // VNU_city
+            'STA_ID'=>$state_id, // STA_ID
+            'CNT_ISO'=>$country_iso, // CNT_ISO
+            'VNU_zip'=>$old_event['zip'], // VNU_zip
+            'VNU_phone'=>$old_event['venue_phone'], // VNU_phone
+            'VNU_capacity'=>-1, // VNU_capacity
+            'VNU_url'=>$old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone'=>$old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'=>$old_event['virtual_url'], // VNU_virtual_url
+            'VNU_google_map_link'=>'', // VNU_google_map_link
             'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
         );
         $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
+            '%d', // VNU_ID_fk
+            '%s', // VNU_address
+            '%s', // VNU_address2
+            '%s', // VNU_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // VNU_zip
+            '%s', // VNU_phone
+            '%d', // VNU_capacity
+            '%s', // VNU_url
+            '%s', // VNU_virtual_phone
+            '%s', // VNU_virtual_url
+            '%s', // VNU_google_map_link
+            '%d', // VNU_enable_for_gmap
         );
         $success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
             return 0;
         }
@@ -700,11 +700,11 @@ 
     private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
     {
         global $wpdb;
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
             return 0;
         }
-        if (! $new_venue_id) {
+        if ( ! $new_venue_id) {
             $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
             return 0;
         }
@@ -714,12 +714,12 @@ 
             'EVV_primary'=>true
         );
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
+            '%d', // EVT_ID
+            '%d', // VNU_ID
+            '%d', // EVT_primary
         );
         $success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -779,29 +779,29 @@ 
         $start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
         $end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
         $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID
-            'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
-            'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
-            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
-            'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
+            'EVT_ID'=>$new_cpt_id, // EVT_ID
+            'DTT_EVT_start'=>$start_datetime_utc, // DTT_EVT_start
+            'DTT_EVT_end'=> $end_datetime_utc, // DTT_EVT_end
+            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'], // DTT_reg_limit
+            'DTT_sold'=>0, // note: we will increment this as registrations are added during the migration
 //          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
-            'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
+            'DTT_order'=> $existing_datetimes, // DTT_order, just give it the same order as the count of how many datetimes already exist
             'DTT_parent'=>0,
             'DTT_deleted'=>false
         );
         $datatypes = array(
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
+            '%d', // EVT_Id
+            '%s', // DTT_EVT_start
+            '%s', // DTT_EVT_end
+            '%d', // DTT_reg_limit
+            '%d', // DTT_sold
 //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
+            '%d', // DTT_order
+            '%d', // DTT_parent
+            '%d', // DTT_deleted
         );
         $success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
             return 0;
         }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_checkins.dmsstage.php

Indentation +116 added lines, -116 removed lines

@@ -26,132 +26,132 @@
 
 class EE_DMS_4_1_0_checkins extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Checkins", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        $this->_extra_where_sql = 'AS att
+	private $_new_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Checkins", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$this->_extra_where_sql = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_table = $wpdb->prefix."esp_checkin";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        global $wpdb;
-        $new_reg_table = $wpdb->prefix."esp_registration";
+		$this->_new_table = $wpdb->prefix."esp_checkin";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		global $wpdb;
+		$new_reg_table = $wpdb->prefix."esp_registration";
 
-        $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ;
+		$num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ;
 
-        $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
-        if (! $new_registrations_for_attendee) {
-            $new_registrations_for_attendee = array();
-        }
-        $new_datetime = $this->_try_to_find_datetime($old_row);
+		$new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
+		if (! $new_registrations_for_attendee) {
+			$new_registrations_for_attendee = array();
+		}
+		$new_datetime = $this->_try_to_find_datetime($old_row);
 
-        // make sure registrations array is numerically indexed starting at 0 (it probably already is)
-        $new_registrations_for_attendee = array_values($new_registrations_for_attendee);
-        $new_checkin_ids = array();
-        for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) {
-            $new_reg_id = $new_registrations_for_attendee[ $i ];
-            if (! $new_reg_id) {
-                $this->add_error(sprintf(
-                    __('It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)', "event_espresso"),
-                    $this->_json_encode($old_row),
-                    abs($num_to_checkin_at_this_time),
-                    count($new_registrations_for_attendee),
-                    $this->_json_encode($new_registrations_for_attendee)
-                ));
-                break;
-            }
-            $new_last_checkin_record = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1", $new_reg_id));
-            if (! $new_last_checkin_record) {
-                $is_checked_in = false;
-            } else {
-                $is_checked_in = intval($new_last_checkin_record['CHK_in']);
-            }
-            $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
-            if ($new_id) {
-                $new_checkin_ids[]= $new_id;
-            }
-        }
-        if ($new_checkin_ids) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_table, $new_checkin_ids);
-        }
-    }
+		// make sure registrations array is numerically indexed starting at 0 (it probably already is)
+		$new_registrations_for_attendee = array_values($new_registrations_for_attendee);
+		$new_checkin_ids = array();
+		for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) {
+			$new_reg_id = $new_registrations_for_attendee[ $i ];
+			if (! $new_reg_id) {
+				$this->add_error(sprintf(
+					__('It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)', "event_espresso"),
+					$this->_json_encode($old_row),
+					abs($num_to_checkin_at_this_time),
+					count($new_registrations_for_attendee),
+					$this->_json_encode($new_registrations_for_attendee)
+				));
+				break;
+			}
+			$new_last_checkin_record = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1", $new_reg_id));
+			if (! $new_last_checkin_record) {
+				$is_checked_in = false;
+			} else {
+				$is_checked_in = intval($new_last_checkin_record['CHK_in']);
+			}
+			$new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
+			if ($new_id) {
+				$new_checkin_ids[]= $new_id;
+			}
+		}
+		if ($new_checkin_ids) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_table, $new_checkin_ids);
+		}
+	}
 
 
-    /**
-     * Tries to find the new datetime the Check-in was for, based on the attendee row
-     * (because we know the attendee was for an event as a specific time, and we know
-     * the event's OLD ID...)
-     * @global type $wpdb
-     * @param array $old_attendee_row
-     * @return array row of datetime from DB
-     */
-    private function _try_to_find_datetime($old_attendee)
-    {
-        global $wpdb;
+	/**
+	 * Tries to find the new datetime the Check-in was for, based on the attendee row
+	 * (because we know the attendee was for an event as a specific time, and we know
+	 * the event's OLD ID...)
+	 * @global type $wpdb
+	 * @param array $old_attendee_row
+	 * @return array row of datetime from DB
+	 */
+	private function _try_to_find_datetime($old_attendee)
+	{
+		global $wpdb;
 
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could nto find new event ID with old event id '%d', on attendee row %s; and because of that couldnt find the correct datetime for Check-in", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
-            return 0;
-        }
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts);
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could nto find new event ID with old event id '%d', on attendee row %s; and because of that couldnt find the correct datetime for Check-in", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
+			return 0;
+		}
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
 
-        $datetime_table = $wpdb->prefix."esp_datetime";
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        );
-        // start running queries, widening search each time by removing a condition
-        $datetime_found = null;
-        do {
-            $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1";
-            $datetime_found = $wpdb->get_row($full_query, ARRAY_A);
-            array_shift($conditions);
-        } while (! $datetime_found && $conditions);
-        return $datetime_found;
-    }
+		$datetime_table = $wpdb->prefix."esp_datetime";
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions = array(
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		);
+		// start running queries, widening search each time by removing a condition
+		$datetime_found = null;
+		do {
+			$full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1";
+			$datetime_found = $wpdb->get_row($full_query, ARRAY_A);
+			array_shift($conditions);
+		} while (! $datetime_found && $conditions);
+		return $datetime_found;
+	}
 
-    /**
-     * Adds a new Check-in/checkout record according for $new_reg_id,$new_datetime_id,$checking_in, and $timestmap
-     * @param int $new_reg_id
-     * @param int $new_datetime_id
-     * @param string $timestamp mysql datetime
-     * @return int new Check-in id
-     */
-    private function _insert_checkin_record($new_reg_id, $new_datetime)
-    {
-        global $wpdb;
+	/**
+	 * Adds a new Check-in/checkout record according for $new_reg_id,$new_datetime_id,$checking_in, and $timestmap
+	 * @param int $new_reg_id
+	 * @param int $new_datetime_id
+	 * @param string $timestamp mysql datetime
+	 * @return int new Check-in id
+	 */
+	private function _insert_checkin_record($new_reg_id, $new_datetime)
+	{
+		global $wpdb;
 
 
-        // ok we can actually do what we set out to do: add a checkin/checkout record
-        $cols_n_values = array(
-            'REG_ID'=>$new_reg_id,
-            'DTT_ID'=>$new_datetime['DTT_ID'],
-            'CHK_in'=>true,
-            'CHK_timestamp'=>$new_datetime['DTT_EVT_start']
-        );
-        $datatypes = array(
-            '%d',// REG_ID
-            '%d',// DTT_ID
-            '%d',// CHK_in
-            '%s',// CHK_timestamp
-        );
-        $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		// ok we can actually do what we set out to do: add a checkin/checkout record
+		$cols_n_values = array(
+			'REG_ID'=>$new_reg_id,
+			'DTT_ID'=>$new_datetime['DTT_ID'],
+			'CHK_in'=>true,
+			'CHK_timestamp'=>$new_datetime['DTT_EVT_start']
+		);
+		$datatypes = array(
+			'%d',// REG_ID
+			'%d',// DTT_ID
+			'%d',// CHK_in
+			'%s',// CHK_timestamp
+		);
+		$success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -33,7 +33,7 @@ 
         $this->_pretty_name = __("Checkins", "event_espresso");
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->_extra_where_sql = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_table = $wpdb->prefix."esp_checkin";
         parent::__construct();
@@ -43,10 +43,10 @@ 
         global $wpdb;
         $new_reg_table = $wpdb->prefix."esp_registration";
 
-        $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ;
+        $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']), intval($old_row['checked_in'])));
 
         $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
-        if (! $new_registrations_for_attendee) {
+        if ( ! $new_registrations_for_attendee) {
             $new_registrations_for_attendee = array();
         }
         $new_datetime = $this->_try_to_find_datetime($old_row);
@@ -54,9 +54,9 @@ 
         // make sure registrations array is numerically indexed starting at 0 (it probably already is)
         $new_registrations_for_attendee = array_values($new_registrations_for_attendee);
         $new_checkin_ids = array();
-        for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) {
-            $new_reg_id = $new_registrations_for_attendee[ $i ];
-            if (! $new_reg_id) {
+        for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) {
+            $new_reg_id = $new_registrations_for_attendee[$i];
+            if ( ! $new_reg_id) {
                 $this->add_error(sprintf(
                     __('It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)', "event_espresso"),
                     $this->_json_encode($old_row),
@@ -67,14 +67,14 @@ 
                 break;
             }
             $new_last_checkin_record = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1", $new_reg_id));
-            if (! $new_last_checkin_record) {
+            if ( ! $new_last_checkin_record) {
                 $is_checked_in = false;
             } else {
                 $is_checked_in = intval($new_last_checkin_record['CHK_in']);
             }
             $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
             if ($new_id) {
-                $new_checkin_ids[]= $new_id;
+                $new_checkin_ids[] = $new_id;
             }
         }
         if ($new_checkin_ids) {
@@ -96,7 +96,7 @@ 
         global $wpdb;
 
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could nto find new event ID with old event id '%d', on attendee row %s; and because of that couldnt find the correct datetime for Check-in", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
             return 0;
         }
@@ -108,8 +108,8 @@ 
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         );
         // start running queries, widening search each time by removing a condition
         $datetime_found = null;
@@ -117,7 +117,7 @@ 
             $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $datetime_found = $wpdb->get_row($full_query, ARRAY_A);
             array_shift($conditions);
-        } while (! $datetime_found && $conditions);
+        }while ( ! $datetime_found && $conditions);
         return $datetime_found;
     }
 
@@ -141,13 +141,13 @@ 
             'CHK_timestamp'=>$new_datetime['DTT_EVT_start']
         );
         $datatypes = array(
-            '%d',// REG_ID
-            '%d',// DTT_ID
-            '%d',// CHK_in
-            '%s',// CHK_timestamp
+            '%d', // REG_ID
+            '%d', // DTT_ID
+            '%d', // CHK_in
+            '%s', // CHK_timestamp
         );
         $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_line_items.dmsstage.php

Indentation +156 added lines, -156 removed lines

@@ -38,171 +38,171 @@
  */
 class EE_DMS_4_1_0_line_items extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_line_table;
-    private $_new_transaction_table;
-    private $_new_reg_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Line Items", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        $this->_extra_where_sql = ' AS att
+	private $_new_line_table;
+	private $_new_transaction_table;
+	private $_new_reg_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Line Items", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$this->_extra_where_sql = ' AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
-        $this->_new_line_table = $wpdb->prefix."esp_line_item";
-        $this->_new_reg_table = $wpdb->prefix."esp_registration";
-        parent::__construct();
-    }
+		$this->_new_transaction_table = $wpdb->prefix."esp_transaction";
+		$this->_new_line_table = $wpdb->prefix."esp_line_item";
+		$this->_new_reg_table = $wpdb->prefix."esp_registration";
+		parent::__construct();
+	}
     
-    protected function _migrate_old_row($old_row)
-    {
-        // insert line items if its a primary id
-        if (intval($old_row['is_primary'])) {
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
-            if (! $txn_id) {
-                $this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
-                return;
-            }
-            $txn = $this->_get_txn($txn_id);
-            $new_line_items = $this->_insert_new_line_items($txn, $old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_line_table, $new_line_items);
-        }
-    }
+	protected function _migrate_old_row($old_row)
+	{
+		// insert line items if its a primary id
+		if (intval($old_row['is_primary'])) {
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
+			if (! $txn_id) {
+				$this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
+				return;
+			}
+			$txn = $this->_get_txn($txn_id);
+			$new_line_items = $this->_insert_new_line_items($txn, $old_row);
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_line_table, $new_line_items);
+		}
+	}
     
-    private function _get_txn($txn_id)
-    {
-        global $wpdb;
-        $txn = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_transaction_table WHERE TXN_ID=%d", $txn_id), ARRAY_A);
-        return $txn;
-    }
+	private function _get_txn($txn_id)
+	{
+		global $wpdb;
+		$txn = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_transaction_table WHERE TXN_ID=%d", $txn_id), ARRAY_A);
+		return $txn;
+	}
     
-    /**
-     * In 4.1, we'd normally need more info than just the registrations to make the line items. Ie, we'd need
-     * the transaction, and tax prices at the time of registration. (And probably promotions and other price factors).
-     * But seeing how these are REGs created from 3.1 attendee data, which have
-     * @param array $transaction
-     * @return array new line item ids
-     */
-    private function _insert_new_line_items($transaction, $old_attendee)
-    {
-        global $wpdb;
-        $regs_on_this_transaction = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_new_reg_table." WHERE TXN_ID=%d", $transaction['TXN_ID']), ARRAY_A);
-        $new_line_item_ids = array();
-        // create a totla line item
-        $total_line_item_id = $this->_insert_new_line_item(array(
-            'LIN_code'=>'total',
-            'TXN_ID'=>$transaction['TXN_ID'],
-            'LIN_name'=>  __("Total", "event_espresso"),
-            'LIN_total'=>$transaction['TXN_total'],
-            'LIN_type'=>'total',
-            'OBJ_ID'=>$transaction['TXN_ID'],
-            'OBJ_type'=>'Transaction'
-        ), $old_attendee);
-        $new_line_item_ids[] = $total_line_item_id;
-        // create a subtotal line item
-        $reg_total = 0;
-        foreach ($regs_on_this_transaction as $new_reg) {
-            $reg_total += floatval($new_reg['REG_final_price']);
-        }
-        $subtotal_line_item_id = $this->_insert_new_line_item(array(
-            'LIN_code'=>'sub-total',
-            'TXN_ID'=>$transaction['TXN_ID'],
-            'LIN_name'=>  __("Subtotal", "event_espresso"),
-            'LIN_total'=>$reg_total,
-            'LIN_parent'=>$total_line_item_id,
-            'LIN_type'=>'sub-total',
-        ), $old_attendee);
-        $new_line_item_ids[] = $subtotal_line_item_id;
-        // group REGs by TKT_ID
-        $regs_by_tkt = array();
-        foreach ($regs_on_this_transaction as $new_reg) {
-            $regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
-        }
+	/**
+	 * In 4.1, we'd normally need more info than just the registrations to make the line items. Ie, we'd need
+	 * the transaction, and tax prices at the time of registration. (And probably promotions and other price factors).
+	 * But seeing how these are REGs created from 3.1 attendee data, which have
+	 * @param array $transaction
+	 * @return array new line item ids
+	 */
+	private function _insert_new_line_items($transaction, $old_attendee)
+	{
+		global $wpdb;
+		$regs_on_this_transaction = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_new_reg_table." WHERE TXN_ID=%d", $transaction['TXN_ID']), ARRAY_A);
+		$new_line_item_ids = array();
+		// create a totla line item
+		$total_line_item_id = $this->_insert_new_line_item(array(
+			'LIN_code'=>'total',
+			'TXN_ID'=>$transaction['TXN_ID'],
+			'LIN_name'=>  __("Total", "event_espresso"),
+			'LIN_total'=>$transaction['TXN_total'],
+			'LIN_type'=>'total',
+			'OBJ_ID'=>$transaction['TXN_ID'],
+			'OBJ_type'=>'Transaction'
+		), $old_attendee);
+		$new_line_item_ids[] = $total_line_item_id;
+		// create a subtotal line item
+		$reg_total = 0;
+		foreach ($regs_on_this_transaction as $new_reg) {
+			$reg_total += floatval($new_reg['REG_final_price']);
+		}
+		$subtotal_line_item_id = $this->_insert_new_line_item(array(
+			'LIN_code'=>'sub-total',
+			'TXN_ID'=>$transaction['TXN_ID'],
+			'LIN_name'=>  __("Subtotal", "event_espresso"),
+			'LIN_total'=>$reg_total,
+			'LIN_parent'=>$total_line_item_id,
+			'LIN_type'=>'sub-total',
+		), $old_attendee);
+		$new_line_item_ids[] = $subtotal_line_item_id;
+		// group REGs by TKT_ID
+		$regs_by_tkt = array();
+		foreach ($regs_on_this_transaction as $new_reg) {
+			$regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
+		}
         
-        // create individual line items
+		// create individual line items
         
-        foreach ($regs_by_tkt as $ticket_id => $regs) {
-            $count = count($regs);
-            $line_total = 0;
-            foreach ($regs as $new_reg) {
-                $line_total += $new_reg['REG_final_price'];
-            }
-            $a_reg = reset($regs);
-            $new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
-            $reg_line_item_id = $this->_insert_new_line_item(array(
-                'LIN_code'=> md5('Ticket' . $ticket_id . time()),
-                'TXN_ID'=>$transaction['TXN_ID'],
-                'LIN_name'=>$new_ticket['TKT_name'],
-                'LIN_unit_price'=>$a_reg['REG_final_price'],
-                'LIN_is_taxable'=>false,
-                'LIN_total'=>$line_total,
-                'LIN_quantity'=>$count,
-                'LIN_parent'=>$subtotal_line_item_id,
-                'OBJ_ID'=>$ticket_id,
-                'OBJ_type'=>'Ticket'
-            ), $old_attendee);
-            $new_line_item_ids[] = $reg_line_item_id;
-        }
+		foreach ($regs_by_tkt as $ticket_id => $regs) {
+			$count = count($regs);
+			$line_total = 0;
+			foreach ($regs as $new_reg) {
+				$line_total += $new_reg['REG_final_price'];
+			}
+			$a_reg = reset($regs);
+			$new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
+			$reg_line_item_id = $this->_insert_new_line_item(array(
+				'LIN_code'=> md5('Ticket' . $ticket_id . time()),
+				'TXN_ID'=>$transaction['TXN_ID'],
+				'LIN_name'=>$new_ticket['TKT_name'],
+				'LIN_unit_price'=>$a_reg['REG_final_price'],
+				'LIN_is_taxable'=>false,
+				'LIN_total'=>$line_total,
+				'LIN_quantity'=>$count,
+				'LIN_parent'=>$subtotal_line_item_id,
+				'OBJ_ID'=>$ticket_id,
+				'OBJ_type'=>'Ticket'
+			), $old_attendee);
+			$new_line_item_ids[] = $reg_line_item_id;
+		}
         
             
         
-        return $new_line_item_ids;
-    }
-    /**
-     * Gets the full ticket by ID
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @return array
-     */
-    private function _get_new_ticket_row($new_ticket_id)
-    {
-        global $wpdb;
-        $ticket_row = $wpdb->get_row($wpdb->prepare("SELECT * FROM ".$wpdb->prefix."esp_ticket WHERE TKT_ID=%d", $new_ticket_id), ARRAY_A);
-        return $ticket_row;
-    }
+		return $new_line_item_ids;
+	}
+	/**
+	 * Gets the full ticket by ID
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @return array
+	 */
+	private function _get_new_ticket_row($new_ticket_id)
+	{
+		global $wpdb;
+		$ticket_row = $wpdb->get_row($wpdb->prepare("SELECT * FROM ".$wpdb->prefix."esp_ticket WHERE TKT_ID=%d", $new_ticket_id), ARRAY_A);
+		return $ticket_row;
+	}
     
-    private function _insert_new_line_item($cols_n_values, $old_attendee)
-    {
-        global $wpdb;
-        $default_cols_n_values = array(
-            'LIN_code'=>'',
-            'TXN_ID'=>0,
-            'LIN_name'=>'',
-            'LIN_desc'=>'',
-            'LIN_unit_price'=>0,
-            'LIN_percent'=>0,
-            'LIN_is_taxable'=>false,
-            'LIN_order'=>0,
-            'LIN_total'=>0,
-            'LIN_quantity'=>null,
-            'LIN_parent'=>0,
-            'LIN_type'=>'line-item',
-            'OBJ_ID'=>null,
-            'OBJ_type'=>null
-        );
-        $cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
-            $datatypes = array(
-                '%s',// LIN_code
-                '%d',// TXN_ID
-                '%s',// LIN_name
-                '%s',// LIN_desc
-                '%f',// LIN_unit_price
-                '%f',// LIN_percent
-                '%d',// LIN_is_taxable
-                '%d',// LIN_order
-                '%f',// LIN_total
-                '%d',// LIN_quantity
-                '%d',// LIN_parent
-                '%s',// LIN_type
-                '%d',// OBJ_ID
-                '%s',// OBJ_type
-            );
-            $success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-            return $wpdb->insert_id;
-    }
+	private function _insert_new_line_item($cols_n_values, $old_attendee)
+	{
+		global $wpdb;
+		$default_cols_n_values = array(
+			'LIN_code'=>'',
+			'TXN_ID'=>0,
+			'LIN_name'=>'',
+			'LIN_desc'=>'',
+			'LIN_unit_price'=>0,
+			'LIN_percent'=>0,
+			'LIN_is_taxable'=>false,
+			'LIN_order'=>0,
+			'LIN_total'=>0,
+			'LIN_quantity'=>null,
+			'LIN_parent'=>0,
+			'LIN_type'=>'line-item',
+			'OBJ_ID'=>null,
+			'OBJ_type'=>null
+		);
+		$cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
+			$datatypes = array(
+				'%s',// LIN_code
+				'%d',// TXN_ID
+				'%s',// LIN_name
+				'%s',// LIN_desc
+				'%f',// LIN_unit_price
+				'%f',// LIN_percent
+				'%d',// LIN_is_taxable
+				'%d',// LIN_order
+				'%f',// LIN_total
+				'%d',// LIN_quantity
+				'%d',// LIN_parent
+				'%s',// LIN_type
+				'%d',// OBJ_ID
+				'%s',// OBJ_type
+			);
+			$success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+			return $wpdb->insert_id;
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -47,7 +47,7 @@ 
         $this->_pretty_name = __("Line Items", "event_espresso");
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->_extra_where_sql = ' AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
         $this->_new_line_table = $wpdb->prefix."esp_line_item";
@@ -60,7 +60,7 @@ 
         // insert line items if its a primary id
         if (intval($old_row['is_primary'])) {
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
                 return;
             }
@@ -117,7 +117,7 @@ 
         // group REGs by TKT_ID
         $regs_by_tkt = array();
         foreach ($regs_on_this_transaction as $new_reg) {
-            $regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
+            $regs_by_tkt[$new_reg['TKT_ID']][] = $new_reg;
         }
         
         // create individual line items
@@ -131,7 +131,7 @@ 
             $a_reg = reset($regs);
             $new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
             $reg_line_item_id = $this->_insert_new_line_item(array(
-                'LIN_code'=> md5('Ticket' . $ticket_id . time()),
+                'LIN_code'=> md5('Ticket'.$ticket_id.time()),
                 'TXN_ID'=>$transaction['TXN_ID'],
                 'LIN_name'=>$new_ticket['TKT_name'],
                 'LIN_unit_price'=>$a_reg['REG_final_price'],
@@ -183,23 +183,23 @@ 
         );
         $cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
             $datatypes = array(
-                '%s',// LIN_code
-                '%d',// TXN_ID
-                '%s',// LIN_name
-                '%s',// LIN_desc
-                '%f',// LIN_unit_price
-                '%f',// LIN_percent
-                '%d',// LIN_is_taxable
-                '%d',// LIN_order
-                '%f',// LIN_total
-                '%d',// LIN_quantity
-                '%d',// LIN_parent
-                '%s',// LIN_type
-                '%d',// OBJ_ID
-                '%s',// OBJ_type
+                '%s', // LIN_code
+                '%d', // TXN_ID
+                '%s', // LIN_name
+                '%s', // LIN_desc
+                '%f', // LIN_unit_price
+                '%f', // LIN_percent
+                '%d', // LIN_is_taxable
+                '%d', // LIN_order
+                '%f', // LIN_total
+                '%d', // LIN_quantity
+                '%d', // LIN_parent
+                '%s', // LIN_type
+                '%d', // OBJ_ID
+                '%s', // OBJ_type
             );
             $success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
             return 0;
         }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_prices.dmsstage.php

Indentation +291 added lines, -291 removed lines

@@ -87,56 +87,56 @@ 
  */
 class EE_DMS_4_1_0_prices extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_price_table;
-    private $_new_ticket_table;
-    private $_new_ticket_price_table;
-    private $_new_datetime_ticket_table;
-    /**
-     * A count of all the different tickets created, used for setting the new ones' TKT_Order
-     * @var int
-     */
-    private $_ticket_count = 0;
-    const price_type_base = 1;
-    const price_type_member_discount = 3;
-    const price_type_percent_surcharge = 4;
-    const price_type_flat_surcharge = 5;
+	private $_new_price_table;
+	private $_new_ticket_table;
+	private $_new_ticket_price_table;
+	private $_new_datetime_ticket_table;
+	/**
+	 * A count of all the different tickets created, used for setting the new ones' TKT_Order
+	 * @var int
+	 */
+	private $_ticket_count = 0;
+	const price_type_base = 1;
+	const price_type_member_discount = 3;
+	const price_type_percent_surcharge = 4;
+	const price_type_flat_surcharge = 5;
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Prices", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_prices";
-        $this->_extra_where_sql = ' AS p 
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Prices", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_prices";
+		$this->_extra_where_sql = ' AS p 
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // create the base price
-        $new_price_id = $this->_insert_new_price($old_row);
-        // create the member discount if there is any
-        // commented-out because we may actually NOT be supporting this in 4.1
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// create the base price
+		$new_price_id = $this->_insert_new_price($old_row);
+		// create the member discount if there is any
+		// commented-out because we may actually NOT be supporting this in 4.1
 //      if($old_row['event_cost'] != $old_row['member_price']){
 //          $member_price_discount_id = $this->_insert_new_member_price($old_row);
 //      }else{
 //          $member_price_discount_id = 0;
 //      }
-        // create the surcharge if there is any
-        if (floatval($old_row['surcharge']) >= 0.01) {
-            $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
-        } else {
-            $surcharge_price_id = 0;
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
-        }
-        // associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
-        // if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
-        // create ticket
+		// create the surcharge if there is any
+		if (floatval($old_row['surcharge']) >= 0.01) {
+			$surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+		} else {
+			$surcharge_price_id = 0;
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
+		}
+		// associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
+		// if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
+		// create ticket
 //      $ticket_id = $this->_insert_new_ticket($old_row);
 //      if($ticket_id){
 //          $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $ticket_id);
@@ -148,62 +148,62 @@ 
 //              $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
 //          }
 //      }
-        // create a ticket for each old price -old datetime combo
-        $tickets_for_old_price = array();
-        foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
-            $ticket_id = $this->_insert_new_ticket($old_row);
-            $tickets_for_old_price[] = $ticket_id;
-            // associate to old prices
-            $this->_insert_ticket_price_relation($ticket_id, $new_price_id);
-            $this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
-            $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_price($old_price)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>self::price_type_base,
-            'PRC_amount'=>floatval($old_price['event_cost']),
-            'PRC_name'=>$old_price['price_type'],
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>0,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		// create a ticket for each old price -old datetime combo
+		$tickets_for_old_price = array();
+		foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
+			$ticket_id = $this->_insert_new_ticket($old_row);
+			$tickets_for_old_price[] = $ticket_id;
+			// associate to old prices
+			$this->_insert_ticket_price_relation($ticket_id, $new_price_id);
+			$this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
+			$this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_price($old_price)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>self::price_type_base,
+			'PRC_amount'=>floatval($old_price['event_cost']),
+			'PRC_name'=>$old_price['price_type'],
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>0,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
 //  private function _insert_new_member_price($old_price){
 //      $discount_amount = floatval($old_price['event_cost']) - floatval($old_price['member_price']);
 //      global $wpdb;
@@ -236,207 +236,207 @@ 
 //      $new_id = $wpdb->insert_id;
 //      return $new_id;
 //  }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_surcharge_price($old_price)
-    {
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_surcharge_price($old_price)
+	{
 
-        if ($old_price['surcharge_type'] == 'flat_rate') {
-            $price_type = self::price_type_flat_surcharge;
-        } else {
-            $price_type = self::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>$price_type,
-            'PRC_amount'=>floatval($old_price['surcharge']),
-            'PRC_name'=>  __("Surcharge", "event_espresso"),
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>20,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		if ($old_price['surcharge_type'] == 'flat_rate') {
+			$price_type = self::price_type_flat_surcharge;
+		} else {
+			$price_type = self::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>$price_type,
+			'PRC_amount'=>floatval($old_price['surcharge']),
+			'PRC_name'=>  __("Surcharge", "event_espresso"),
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>20,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
-     * @param $old_price_row array where keys are columns
-     * @param $new_base_price_id int
-     * @param $new_member_discount_id int
-     * @param $new_surcharge_id int
-     * @return int new ticket id
-     */
-    private function _insert_new_ticket($old_price_row)
-    {
-        global $wpdb;
-        $event_row = $this->_get_event_row($old_price_row['event_id']);
-        if ($old_price_row['surcharge_type'] == 'flat_rate') {
-            $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
-        } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
-        }
-        $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
-        $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
-        $end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
-        $end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
-        $cols_n_values = array(
-            'TTM_ID'=>0,
-            'TKT_name'=>$old_price_row['price_type'],
-            'TKT_description'=>'',
-            'TKT_start_date'=>$start_date_utc,
-            'TKT_end_date'=>$end_date_utc,
-            'TKT_min'=>0,
-            'TKT_max'=>-1,
-            'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
-            'TKT_qty'=> -1,
-            'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
-            'TKT_is_default'=>false,
-            'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
-            'TKT_deleted'=>false,
-            'TKT_parent'=>0
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
+	 * @param $old_price_row array where keys are columns
+	 * @param $new_base_price_id int
+	 * @param $new_member_discount_id int
+	 * @param $new_surcharge_id int
+	 * @return int new ticket id
+	 */
+	private function _insert_new_ticket($old_price_row)
+	{
+		global $wpdb;
+		$event_row = $this->_get_event_row($old_price_row['event_id']);
+		if ($old_price_row['surcharge_type'] == 'flat_rate') {
+			$final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
+		} else {// percent surcharge
+			$final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+		}
+		$start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
+		$start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
+		$end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
+		$end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
+		$cols_n_values = array(
+			'TTM_ID'=>0,
+			'TKT_name'=>$old_price_row['price_type'],
+			'TKT_description'=>'',
+			'TKT_start_date'=>$start_date_utc,
+			'TKT_end_date'=>$end_date_utc,
+			'TKT_min'=>0,
+			'TKT_max'=>-1,
+			'TKT_price'=>$final_ticket_price,
+			'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+			'TKT_qty'=> -1,
+			'TKT_uses'=> 1,
+			'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+			'TKT_is_default'=>false,
+			'TKT_order'=>$this->_get_ticket_count(),
+			'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+			'TKT_deleted'=>false,
+			'TKT_parent'=>0
 
-        );
-        $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
-        );
-        $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		);
+		$datatypes = array(
+			'%d',// TTM_ID
+			'%s',// TKT_name
+			'%s',// TKT_description
+			'%s',// TKT_start_date
+			'%s',// TKT_end_date
+			'%d',// TKT_min
+			'%d',// TKT_max
+			'%f',// TKT_price
+			'%d',// TKT_sold
+			'%d',// TKT_qty
+			'%d',// TKT_uses
+			'%d',// TKT_taxable
+			'%d',// TKT_is_default
+			'%d',// TKT_order
+			'%d',// TKT_row
+			'%d',// TKT_deleted
+			'%d',// TKT_parent
+		);
+		$success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a price
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'PRC_ID'=>$new_price_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
-        );
-        $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a price
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'PRC_ID'=>$new_price_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// PRC_ID
+		);
+		$success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a datetime
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'DTT_ID'=>$new_datetime_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
-        );
-        $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a datetime
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'DTT_ID'=>$new_datetime_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// DTT_ID
+		);
+		$success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Simply gets the 3.1 event row data
-     * @global type $wpdb
-     * @param type $event_id
-     * @return array
-     */
-    private function _get_event_row($event_id)
-    {
-        global $wpdb;
-        $old_event_table = $wpdb->prefix."events_detail";
-        return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
-    }
-    /**
-     * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
-     * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
-     * @return int
-     */
-    private function _get_ticket_count()
-    {
-        return $this->_ticket_count++;
-    }
+	/**
+	 * Simply gets the 3.1 event row data
+	 * @global type $wpdb
+	 * @param type $event_id
+	 * @return array
+	 */
+	private function _get_event_row($event_id)
+	{
+		global $wpdb;
+		$old_event_table = $wpdb->prefix."events_detail";
+		return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
+	}
+	/**
+	 * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
+	 * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
+	 * @return int
+	 */
+	private function _get_ticket_count()
+	{
+		return $this->_ticket_count++;
+	}
 
-    /**
-     * Using the 3.1 event id, gets the 4.1 datetimes for it
-     * @param int $old_event_id
-     * @return array where values are datetime ids
-     */
-    private function _get_datetime_ids_for_old_event_id($old_event_id)
-    {
-        global $wpdb;
-        $new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
-        $datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
-        return $datetime_ids;
-    }
+	/**
+	 * Using the 3.1 event id, gets the 4.1 datetimes for it
+	 * @param int $old_event_id
+	 * @return array where values are datetime ids
+	 */
+	private function _get_datetime_ids_for_old_event_id($old_event_id)
+	{
+		global $wpdb;
+		$new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
+		$datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
+		return $datetime_ids;
+	}
 }
 // @todo: tell users that in 3.1 the limit was on registration PER event,in 4.1 it's limit PER TICKET... SO, if they sell 2 different types of tickets
 //

Spacing +50 added lines, -50 removed lines

@@ -107,7 +107,7 @@ 
         $this->_pretty_name = __("Prices", "event_espresso");
         $this->_old_table = $wpdb->prefix."events_prices";
         $this->_extra_where_sql = ' AS p 
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_price_table = $wpdb->prefix."esp_price";
         $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
@@ -129,7 +129,7 @@ 
         // create the surcharge if there is any
         if (floatval($old_row['surcharge']) >= 0.01) {
             $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id, $surcharge_price_id));
         } else {
             $surcharge_price_id = 0;
             $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
@@ -181,17 +181,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -263,17 +263,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -295,7 +295,7 @@ 
         if ($old_price_row['surcharge_type'] == 'flat_rate') {
             $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
         } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge']) / 100);
         }
         $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
         $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
@@ -310,38 +310,38 @@ 
             'TKT_min'=>0,
             'TKT_max'=>-1,
             'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+            'TKT_sold'=> 0, // note: this will get calculated as we actually add registrations during the migration
             'TKT_qty'=> -1,
             'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+            'TKT_taxable'=>false, // so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
             'TKT_is_default'=>false,
             'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+            'TKT_row'=>0, // doesn't matter because UI reset this on first save anyways
             'TKT_deleted'=>false,
             'TKT_parent'=>0
 
         );
         $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
+            '%d', // TTM_ID
+            '%s', // TKT_name
+            '%s', // TKT_description
+            '%s', // TKT_start_date
+            '%s', // TKT_end_date
+            '%d', // TKT_min
+            '%d', // TKT_max
+            '%f', // TKT_price
+            '%d', // TKT_sold
+            '%d', // TKT_qty
+            '%d', // TKT_uses
+            '%d', // TKT_taxable
+            '%d', // TKT_is_default
+            '%d', // TKT_order
+            '%d', // TKT_row
+            '%d', // TKT_deleted
+            '%d', // TKT_parent
         );
         $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -364,12 +364,12 @@ 
             'PRC_ID'=>$new_price_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
+            '%d', // TKT_ID
+            '%d', // PRC_ID
         );
         $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;
@@ -391,12 +391,12 @@ 
             'DTT_ID'=>$new_datetime_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
+            '%d', // TKT_ID
+            '%d', // DTT_ID
         );
         $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_answers.dmsstage.php

Indentation +77 added lines, -77 removed lines

@@ -32,86 +32,86 @@
 
 class EE_DMS_4_1_0_answers extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_answer_table;
-    private $_new_question_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Answers", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_answer";
-        // join to attendee and then join to events table
-        $this->_extra_where_sql = ' AS ans 
+	private $_new_answer_table;
+	private $_new_question_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Answers", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_answer";
+		// join to attendee and then join to events table
+		$this->_extra_where_sql = ' AS ans 
             INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
-        $this->_new_answer_table = $wpdb->prefix."esp_answer";
-        $this->_new_question_table = $wpdb->prefix."esp_question";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // get the new REGs for the old answer
-        global $wpdb;
-        $old_attendee_table = $wpdb->prefix."events_attendee";
-        $new_reg_table = $wpdb->prefix."esp_registration";
-        $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
-            $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
-            return false;
-        }
-        // as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
-        foreach ($regs as $new_reg_id) {
-            $new_answer_id = $this->_insert_new_answer($old_row, $new_reg_id);
-        }
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param array $old_price
-     * @param int $new_reg_id
-     * @return int
-     */
-    private function _insert_new_answer($old_answer, $new_reg_id)
-    {
-        global $wpdb;
-        $old_question_table = $wpdb->prefix."events_question";
-        $new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
+		$this->_new_answer_table = $wpdb->prefix."esp_answer";
+		$this->_new_question_table = $wpdb->prefix."esp_question";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// get the new REGs for the old answer
+		global $wpdb;
+		$old_attendee_table = $wpdb->prefix."events_attendee";
+		$new_reg_table = $wpdb->prefix."esp_registration";
+		$regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
+		if (! $regs) {
+			$this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
+			return false;
+		}
+		// as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
+		foreach ($regs as $new_reg_id) {
+			$new_answer_id = $this->_insert_new_answer($old_row, $new_reg_id);
+		}
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param array $old_price
+	 * @param int $new_reg_id
+	 * @return int
+	 */
+	private function _insert_new_answer($old_answer, $new_reg_id)
+	{
+		global $wpdb;
+		$old_question_table = $wpdb->prefix."events_question";
+		$new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
 
-        $question_type = $this->_get_question_type($new_question_id);
-        if (in_array($question_type, array('MULTIPLE'))) {
-            $ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
-        } else {
-            $ans_value = stripslashes($old_answer['answer']);
-        }
-        $cols_n_values = array(
-            'REG_ID'=>$new_reg_id,
-            'QST_ID'=>$new_question_id,
-            'ANS_value'=>$ans_value
-        );
-        $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
-        );
-        $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		$question_type = $this->_get_question_type($new_question_id);
+		if (in_array($question_type, array('MULTIPLE'))) {
+			$ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
+		} else {
+			$ans_value = stripslashes($old_answer['answer']);
+		}
+		$cols_n_values = array(
+			'REG_ID'=>$new_reg_id,
+			'QST_ID'=>$new_question_id,
+			'ANS_value'=>$ans_value
+		);
+		$datatypes = array(
+			'%d',// REG_ID
+			'%d',// QST_ID
+			'%s',// ANS_value
+		);
+		$success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Gets the question's type
-     * @global type $wpdb
-     * @param type $question_id
-     * @return string
-     */
-    private function _get_question_type($question_id)
-    {
-        global $wpdb;
-        $type = $wpdb->get_var($wpdb->prepare("SELECT QST_type FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1", $question_id));
-        return $type;
-    }
+	/**
+	 * Gets the question's type
+	 * @global type $wpdb
+	 * @param type $question_id
+	 * @return string
+	 */
+	private function _get_question_type($question_id)
+	{
+		global $wpdb;
+		$type = $wpdb->get_var($wpdb->prepare("SELECT QST_type FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1", $question_id));
+		return $type;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -41,8 +41,8 @@ 
         $this->_old_table = $wpdb->prefix."events_answer";
         // join to attendee and then join to events table
         $this->_extra_where_sql = ' AS ans 
-            INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
+            INNER JOIN ' . $wpdb->prefix.'events_attendee AS att ON ans.attendee_id = att.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
         $this->_new_answer_table = $wpdb->prefix."esp_answer";
         $this->_new_question_table = $wpdb->prefix."esp_question";
@@ -55,7 +55,7 @@ 
         $old_attendee_table = $wpdb->prefix."events_attendee";
         $new_reg_table = $wpdb->prefix."esp_registration";
         $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
+        if ( ! $regs) {
             $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
             return false;
         }
@@ -89,12 +89,12 @@ 
             'ANS_value'=>$ans_value
         );
         $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
+            '%d', // REG_ID
+            '%d', // QST_ID
+            '%s', // ANS_value
         );
         $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
             return 0;
         }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_attendees.dmsstage.php

Indentation +598 added lines, -602 removed lines

@@ -53,10 +53,6 @@ 
 ENGINE=InnoDB
 AUTO_INCREMENT=3
 ;
-
-
-
-
  * 4.1 Attendee tables and fields:
  * $this->_tables = array(
             'Attendee_CPT'=> new EE_Primary_Table('posts', 'ID'),
@@ -186,634 +182,634 @@ 
  */
 class EE_DMS_4_1_0_attendees extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_attendee_cpt_table;
-    private $_new_attendee_meta_table;
-    private $_new_reg_table;
-    private $_new_transaction_table;
-    private $_new_payment_table;
-    private $_new_line_table;
-    private $_old_mer_table;
-    private $_new_ticket_table;
-    private $_new_ticket_datetime_table;
-    private $_new_datetime_table;
-    private $_new_datetime_ticket_table;
-    private $_new_price_table;
-    private $_new_ticket_price_table;
-    /**
-     * Rememebrs whether or not the mer table exists
-     * @var boolean
-     */
-    private $_mer_tables_exist = null;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Attendees", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        $this->_extra_where_sql = 'AS att
+	private $_new_attendee_cpt_table;
+	private $_new_attendee_meta_table;
+	private $_new_reg_table;
+	private $_new_transaction_table;
+	private $_new_payment_table;
+	private $_new_line_table;
+	private $_old_mer_table;
+	private $_new_ticket_table;
+	private $_new_ticket_datetime_table;
+	private $_new_datetime_table;
+	private $_new_datetime_ticket_table;
+	private $_new_price_table;
+	private $_new_ticket_price_table;
+	/**
+	 * Rememebrs whether or not the mer table exists
+	 * @var boolean
+	 */
+	private $_mer_tables_exist = null;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Attendees", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$this->_extra_where_sql = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
-        $this->_new_attendee_cpt_table = $wpdb->posts;
-        $this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
-        $this->_new_reg_table = $wpdb->prefix."esp_registration";
-        $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
-        $this->_new_payment_table = $wpdb->prefix."esp_payment";
-        $this->_new_line_table = $wpdb->prefix."esp_line_item";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_datetime_table = $wpdb->prefix."esp_datetime";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        parent::__construct();
-    }
+		$this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
+		$this->_new_attendee_cpt_table = $wpdb->posts;
+		$this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
+		$this->_new_reg_table = $wpdb->prefix."esp_registration";
+		$this->_new_transaction_table = $wpdb->prefix."esp_transaction";
+		$this->_new_payment_table = $wpdb->prefix."esp_payment";
+		$this->_new_line_table = $wpdb->prefix."esp_line_item";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_datetime_table = $wpdb->prefix."esp_datetime";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		parent::__construct();
+	}
 
-    protected function _migrate_old_row($old_row)
-    {
-        // first check if there's already a new attendee with similar characteristics
-        $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
-            $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
-                // if we couldnt even make an attendee, abandon all hope
-                return false;
-            }
-            $new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
-            if ($new_att_meta_id) {
-                $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
-            }
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
+	protected function _migrate_old_row($old_row)
+	{
+		// first check if there's already a new attendee with similar characteristics
+		$new_att_id = $this->_find_attendee_cpt_matching($old_row);
+		if (! $new_att_id) {
+			$new_att_id = $this->_insert_new_attendee_cpt($old_row);
+			if (! $new_att_id) {
+				// if we couldnt even make an attendee, abandon all hope
+				return false;
+			}
+			$new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
+			if ($new_att_meta_id) {
+				$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
+			}
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
-        $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
-            // if we couldnt make the transaction, also abandon all hope
-            return false;
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
-        $pay_id = $this->_insert_new_payment($old_row, $txn_id);
-        if ($pay_id) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
-        }
+		$txn_id = $this->_insert_new_transaction($old_row);
+		if (! $txn_id) {
+			// if we couldnt make the transaction, also abandon all hope
+			return false;
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
+		$pay_id = $this->_insert_new_payment($old_row, $txn_id);
+		if ($pay_id) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
+		}
 
 
-        // even if there was no payment, we can go ahead with adding the reg
-        $new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
-        if ($new_regs) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
-        }
-    }
-    /**
-     * Checks if there's already an attendee CPT in the db that has the same
-     * first and last name, and email. If so, returns its ID as an int.
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @return int
-     */
-    private function _find_attendee_cpt_matching($old_attendee)
-    {
-        global $wpdb;
-        $existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
-        return intval($existing_attendee_id);
-    }
-    private function _insert_new_attendee_cpt($old_attendee)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
-            'post_status'=>'publish'// status
-        );
-        $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
-        );
-        $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		// even if there was no payment, we can go ahead with adding the reg
+		$new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
+		if ($new_regs) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
+		}
+	}
+	/**
+	 * Checks if there's already an attendee CPT in the db that has the same
+	 * first and last name, and email. If so, returns its ID as an int.
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @return int
+	 */
+	private function _find_attendee_cpt_matching($old_attendee)
+	{
+		global $wpdb;
+		$existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
+		return intval($existing_attendee_id);
+	}
+	private function _insert_new_attendee_cpt($old_attendee)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
+			'post_content'=>'',// ATT_bio
+			'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
+			'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
+			'post_excerpt'=>'',// ATT_short_bio
+			'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
+			'post_author'=>0,// ATT_author
+			'post_parent'=>0,// ATT_parent
+			'post_type'=>'espresso_attendees',// post_type
+			'post_status'=>'publish'// status
+		);
+		$datatypes = array(
+			'%s',// ATT_full_name
+			'%s',// ATT_bio
+			'%s',// ATT_slug
+			'%s',// ATT_created
+			'%s',// ATT_short_bio
+			'%s',// ATT_modified
+			'%d',// ATT_author
+			'%d',// ATT_parent
+			'%s',// post_type
+			'%s',// status
+		);
+		$success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
-    {
-        global $wpdb;
-        // get the state and country ids from the old row
-        try {
-            $new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
-            $new_country_iso = $new_country['CNT_ISO'];
-        } catch (EE_Error $exception) {
-            $new_country_iso = $this->get_migration_script()->get_default_country_iso();
-        }
-        try {
-            $new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
-            $new_state_id = $new_state['STA_ID'];
-        } catch (EE_Error $exception) {
-            $new_state_id = 0;
-        }
-        $cols_n_values = array(
-            'ATT_ID'=>$new_attendee_cpt_id,
-            'ATT_fname'=>stripslashes($old_attendee['fname']),
-            'ATT_lname'=>stripslashes($old_attendee['lname']),
-            'ATT_address'=>stripslashes($old_attendee['address']),
-            'ATT_address2'=>stripslashes($old_attendee['address2']),
-            'ATT_city'=>stripslashes($old_attendee['city']),
-            'STA_ID'=>$new_state_id,
-            'CNT_ISO'=>$new_country_iso,
-            'ATT_zip'=>stripslashes($old_attendee['zip']),
-            'ATT_email'=>stripslashes($old_attendee['email']),
-            'ATT_phone'=>stripslashes($old_attendee['phone']),
-        );
-        $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
-        );
-        $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
+	{
+		global $wpdb;
+		// get the state and country ids from the old row
+		try {
+			$new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
+			$new_country_iso = $new_country['CNT_ISO'];
+		} catch (EE_Error $exception) {
+			$new_country_iso = $this->get_migration_script()->get_default_country_iso();
+		}
+		try {
+			$new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
+			$new_state_id = $new_state['STA_ID'];
+		} catch (EE_Error $exception) {
+			$new_state_id = 0;
+		}
+		$cols_n_values = array(
+			'ATT_ID'=>$new_attendee_cpt_id,
+			'ATT_fname'=>stripslashes($old_attendee['fname']),
+			'ATT_lname'=>stripslashes($old_attendee['lname']),
+			'ATT_address'=>stripslashes($old_attendee['address']),
+			'ATT_address2'=>stripslashes($old_attendee['address2']),
+			'ATT_city'=>stripslashes($old_attendee['city']),
+			'STA_ID'=>$new_state_id,
+			'CNT_ISO'=>$new_country_iso,
+			'ATT_zip'=>stripslashes($old_attendee['zip']),
+			'ATT_email'=>stripslashes($old_attendee['email']),
+			'ATT_phone'=>stripslashes($old_attendee['phone']),
+		);
+		$datatypes = array(
+			'%d',// ATT_ID
+			'%s',// ATT_fname
+			'%s',// ATT_lname
+			'%s',// ATT_address
+			'%s',// ATT_address2
+			'%s',// ATT_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// ATT_zip
+			'%s',// ATT_email
+			'%s',// ATT_phone
+		);
+		$success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Note: we don't necessarily create a new transaction for each attendee row.
-     * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
-     * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
-     * @global type $wpdb
-     * @param type $old_attendee
-     * @return int new transaction id
-     */
-    private function _insert_new_transaction($old_attendee)
-    {
-        global $wpdb;
+	/**
+	 * Note: we don't necessarily create a new transaction for each attendee row.
+	 * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
+	 * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
+	 * @global type $wpdb
+	 * @param type $old_attendee
+	 * @return int new transaction id
+	 */
+	private function _insert_new_transaction($old_attendee)
+	{
+		global $wpdb;
 
-        // first: let's check for an existing transaction for this old attendee
-        if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
-        } else { // non-primary attendee, so find its primary attendee's transaction
-            $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
-                $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
-                $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
-            }
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
-                $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
-                $txn_id = 0;
-            }
-        }
-        // if there isn't yet a transaction row for this, create one
-        // (so even if it was a non-primary attendee with no EE3 primary attendee,
-        // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
-            // maps 3.1 payment stati onto 4.1 transaction stati
-            $txn_status_mapping = array(
-                'Completed'=>'TCM',
-                'Pending'=>'TIN',
-                'Payment Declined'=>'TIN',
-                'Incomplete'=>'TIN',
-                'Not Completed'=>'TIN',
-                'Cancelled'=>'TIN',
-                'Declined'=>'TIN'
-            );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
-            $cols_n_values = array(
-                'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'TXN_total'=>floatval($old_attendee['total_cost']),
-                'TXN_paid'=>floatval($old_attendee['amount_pd']),
-                'STS_ID'=>$STS_ID,
-                'TXN_hash_salt'=>$old_attendee['hashSalt']
-            );
-            $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
-            );
-            $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $txn_id = $wpdb->insert_id;
-        }
+		// first: let's check for an existing transaction for this old attendee
+		if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
+		} else { // non-primary attendee, so find its primary attendee's transaction
+			$primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
+			if (! $primary_attendee_old_id) {
+				$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
+				$primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
+			}
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
+			if (! $txn_id) {
+				$this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
+				$txn_id = 0;
+			}
+		}
+		// if there isn't yet a transaction row for this, create one
+		// (so even if it was a non-primary attendee with no EE3 primary attendee,
+		// it ought to have SOME transaction, so we'll make one)
+		if (! $txn_id) {
+			// maps 3.1 payment stati onto 4.1 transaction stati
+			$txn_status_mapping = array(
+				'Completed'=>'TCM',
+				'Pending'=>'TIN',
+				'Payment Declined'=>'TIN',
+				'Incomplete'=>'TIN',
+				'Not Completed'=>'TIN',
+				'Cancelled'=>'TIN',
+				'Declined'=>'TIN'
+			);
+			$STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+			$cols_n_values = array(
+				'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'TXN_total'=>floatval($old_attendee['total_cost']),
+				'TXN_paid'=>floatval($old_attendee['amount_pd']),
+				'STS_ID'=>$STS_ID,
+				'TXN_hash_salt'=>$old_attendee['hashSalt']
+			);
+			$datatypes = array(
+				'%s',// TXN_timestamp
+				'%f',// TXN_total
+				'%f',// TXN_paid
+				'%s',// STS_ID
+				'%s',// TXN_hash_salt
+			);
+			$success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$txn_id = $wpdb->insert_id;
+		}
 
-        return $txn_id;
-    }
-    /**
-     * Detects if the MER tables exist
-     * @global type $wpdb
-     * @return boolean
-     */
-    private function _mer_tables_exist()
-    {
-        if ($this->_mer_tables_exist === null) {
-            global $wpdb;
+		return $txn_id;
+	}
+	/**
+	 * Detects if the MER tables exist
+	 * @global type $wpdb
+	 * @return boolean
+	 */
+	private function _mer_tables_exist()
+	{
+		if ($this->_mer_tables_exist === null) {
+			global $wpdb;
 
-            if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
-                $this->_mer_tables_exist = false;
-            } else {
-                $this->_mer_tables_exist = true;
-            }
-        }
-        return $this->_mer_tables_exist;
-    }
+			if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
+				$this->_mer_tables_exist = false;
+			} else {
+				$this->_mer_tables_exist = true;
+			}
+		}
+		return $this->_mer_tables_exist;
+	}
 
-    /**
-     * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
-     * whether the event required pre-approval or not,a dn the 4.1 payment status.
-     * @global type $wpdb
-     * @param type $old_attendee_row
-     * @return string
-     */
-    private function _get_reg_status_for_old_payment_status($old_attendee_row)
-    {
-        // need event default reg status and if pre_approval was required
-        global $wpdb;
-        $event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
-        return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
-            $old_attendee_row['payment_status'],
-            intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
-        );
-    }
-    /**
-     * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
-     * and returns an array of their IDs
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @param int $new_attendee_id
-     * @param int $new_txn_id
-     * @return array of new registratio ids
-     */
-    private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
-    {
-        global $wpdb;
+	/**
+	 * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
+	 * whether the event required pre-approval or not,a dn the 4.1 payment status.
+	 * @global type $wpdb
+	 * @param type $old_attendee_row
+	 * @return string
+	 */
+	private function _get_reg_status_for_old_payment_status($old_attendee_row)
+	{
+		// need event default reg status and if pre_approval was required
+		global $wpdb;
+		$event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
+		return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
+			$old_attendee_row['payment_status'],
+			intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
+		);
+	}
+	/**
+	 * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
+	 * and returns an array of their IDs
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @param int $new_attendee_id
+	 * @param int $new_txn_id
+	 * @return array of new registratio ids
+	 */
+	private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
+	{
+		global $wpdb;
 
-        $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
-        }
+		$STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
+		}
 
-        $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
-            $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
-            $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
-        }
-        $regs_on_this_row = intval($old_attendee['quantity']);
-        $new_regs = array();
-        // 4 cases we need to account for:
-        // 1 old attendee_details row with a quantity of X (no mer)
-        // Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
-        // Y old attendee_details rows with a quantity of x (because of mer)
-        // Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
-        for ($count = 1; $count <= $regs_on_this_row; $count++) {
-            // sum regs on older rows
-            $regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
-            $cols_n_values = array(
-                'EVT_ID'=>$new_event_id,
-                'ATT_ID'=>$new_attendee_id,
-                'TXN_ID'=>$new_txn_id,
-                'TKT_ID'=>$ticket_id,
-                'STS_ID'=>$STS_ID,
-                'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'REG_final_price'=>$old_attendee['final_price'],
-                'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
-                'REG_code'=>sanitize_key($old_attendee['registration_id']),
-                'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
-                'REG_count'=>$regs_on_this_event_and_txn + $count,
-                'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
-                'REG_att_is_going'=>true,
-                'REG_deleted'=>false
-            );
-            $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
-            );
-            $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $cols_n_values['REG_ID'] = $wpdb->insert_id;
-            $new_regs[] = $wpdb->insert_id;
-        }
-        $this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
-        return $new_regs;
-    }
+		$ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
+		if (! $ticket_id) {
+			$ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
+			$this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
+		}
+		$regs_on_this_row = intval($old_attendee['quantity']);
+		$new_regs = array();
+		// 4 cases we need to account for:
+		// 1 old attendee_details row with a quantity of X (no mer)
+		// Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
+		// Y old attendee_details rows with a quantity of x (because of mer)
+		// Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
+		for ($count = 1; $count <= $regs_on_this_row; $count++) {
+			// sum regs on older rows
+			$regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
+			$cols_n_values = array(
+				'EVT_ID'=>$new_event_id,
+				'ATT_ID'=>$new_attendee_id,
+				'TXN_ID'=>$new_txn_id,
+				'TKT_ID'=>$ticket_id,
+				'STS_ID'=>$STS_ID,
+				'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'REG_final_price'=>$old_attendee['final_price'],
+				'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
+				'REG_code'=>sanitize_key($old_attendee['registration_id']),
+				'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
+				'REG_count'=>$regs_on_this_event_and_txn + $count,
+				'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
+				'REG_att_is_going'=>true,
+				'REG_deleted'=>false
+			);
+			$datatypes = array(
+				'%d',// EVT_ID
+				'%d',// ATT_ID
+				'%d',// TXN_ID
+				'%d',// TKT_ID
+				'%s',// STS_ID
+				'%s',// REG_date
+				'%f',// REG_final_price
+				'%s',// REG_session
+				'%s',// REG_code
+				'%s',// REG_url_link
+				'%d',// REG_count
+				'%d',// REG_group_size
+				'%d',// REG_att_is_going
+				'%d',// REG_deleted
+			);
+			$success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$cols_n_values['REG_ID'] = $wpdb->insert_id;
+			$new_regs[] = $wpdb->insert_id;
+		}
+		$this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
+		return $new_regs;
+	}
 
-    /**
-     * Increments the sold values on the ticket and its related datetimes by the amount sold,
-     * which should be done directly after adding the rows. Yes this means we're constantly incrementing
-     * the sold amounts as we go, and is less efficient than a single big query,
-     * but its safer because we KNOW these regs have been added, rather than inferring
-     * that they WILL be added (because the attendees stage runs nearly last during
-     * the migration script)
-     * @param type $new_ticket_id
-     * @param type $sold
-     * @param type $STS_ID
-     * @return boolean whether they were successfully updated or not
-     */
-    protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
-    {
-        if ($STS_ID != 'RAP') {
-            return true;
-        }
-        global $wpdb;
-        $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
-        if ($success) {
-            // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+	/**
+	 * Increments the sold values on the ticket and its related datetimes by the amount sold,
+	 * which should be done directly after adding the rows. Yes this means we're constantly incrementing
+	 * the sold amounts as we go, and is less efficient than a single big query,
+	 * but its safer because we KNOW these regs have been added, rather than inferring
+	 * that they WILL be added (because the attendees stage runs nearly last during
+	 * the migration script)
+	 * @param type $new_ticket_id
+	 * @param type $sold
+	 * @param type $STS_ID
+	 * @return boolean whether they were successfully updated or not
+	 */
+	protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
+	{
+		if ($STS_ID != 'RAP') {
+			return true;
+		}
+		global $wpdb;
+		$success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
+		if ($success) {
+			// get the ticket's datetimes, and increment them too
+			$success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
-                $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-            }
-        } else {
-            $this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-        }
-        return true;
-    }
-    /**
-     * Makes a best guess at which ticket is the one the attendee purchased.
-     * Obviously, the old attendee's event_id narrows it down quite a bit;
-     * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
-     * however, if we don't find an exact match, see if any of those conditions match;
-     * and lastly if none of that works, just use the first ticket for the event we find
-     * @param array $old_attendee
-     */
-    private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $tickets_table = $this->_new_ticket_table;
-        $datetime_tickets_table = $this->_new_ticket_datetime_table;
-        $datetime_table = $this->_new_datetime_table;
+			if (! $success_update_dateimtes) {
+				$this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+			}
+		} else {
+			$this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+		}
+		return true;
+	}
+	/**
+	 * Makes a best guess at which ticket is the one the attendee purchased.
+	 * Obviously, the old attendee's event_id narrows it down quite a bit;
+	 * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
+	 * however, if we don't find an exact match, see if any of those conditions match;
+	 * and lastly if none of that works, just use the first ticket for the event we find
+	 * @param array $old_attendee
+	 */
+	private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$tickets_table = $this->_new_ticket_table;
+		$datetime_tickets_table = $this->_new_ticket_datetime_table;
+		$datetime_table = $this->_new_datetime_table;
 
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        );
-        $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions = array(
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
+			$wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		);
+		$select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
 			$datetime_table ON $datetime_tickets_table.DTT_ID = $datetime_table.DTT_ID";
-        // start running queries, widening search each time by removing a condition
-        do {
-            $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
-            $ticket_id_found = $wpdb->get_var($full_query);
-            array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
-        return $ticket_id_found;
-    }
+		// start running queries, widening search each time by removing a condition
+		do {
+			$full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
+			$ticket_id_found = $wpdb->get_var($full_query);
+			array_shift($conditions);
+		} while (! $ticket_id_found && $conditions);
+		return $ticket_id_found;
+	}
 
-    /**
-     * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
-     * and it also tries to find a datetime that works, and a inserts a price, and associates
-     * the new ticket to that datetime and price.
-     * @return int ticket id
-     */
-    private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+	/**
+	 * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
+	 * and it also tries to find a datetime that works, and a inserts a price, and associates
+	 * the new ticket to that datetime and price.
+	 * @return int ticket id
+	 */
+	private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
 
 
-        // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
-            $old_att_end_date = $old_attendee['start_date'];
-            $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-            $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
-            $wpdb->insert(
-                $this->_new_datetime_table,
-                array(
-                        'EVT_ID' => $new_event_id,
-                        'DTT_EVT_start' => $old_att_start_datetime,
-                        'DTT_EVT_end' => $old_att_end_datetime,
-                        'DTT_deleted' => true
-                    ),
-                array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
-                    )
-            );
-            $datetime_id = $wpdb->insert_id;
-        }
+		// insert new datetime unless we find one
+		$datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+		if (! $datetime_id) {
+			$old_att_end_date = $old_attendee['start_date'];
+			$old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+			$old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
+			$wpdb->insert(
+				$this->_new_datetime_table,
+				array(
+						'EVT_ID' => $new_event_id,
+						'DTT_EVT_start' => $old_att_start_datetime,
+						'DTT_EVT_end' => $old_att_end_datetime,
+						'DTT_deleted' => true
+					),
+				array(
+						'%d',// EVT_ID
+						'%s',// DTT_EVT_start
+						'%s',// DTT_EVT_end
+						'%d',// DTT_deleted
+					)
+			);
+			$datetime_id = $wpdb->insert_id;
+		}
 
-        // insert new ticket
-        $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
-            array(
-                    'TKT_name' => $old_att_price_option,
-                    'TKT_qty' => -1,
-                    'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
-                    'TKT_end_date' => $old_att_end_datetime,
+		// insert new ticket
+		$success = $wpdb->insert(
+			$wpdb->prefix . 'esp_ticket',
+			array(
+					'TKT_name' => $old_att_price_option,
+					'TKT_qty' => -1,
+					'TKT_price' => $old_att_price,
+					'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+					'TKT_end_date' => $old_att_end_datetime,
 
-                ),
-            array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
-                )
-        );
-        $ticket_id = $wpdb->insert_id;
-        // associate the ticket with the datetime we found earlier
-        $wpdb->insert(
-            $this->_new_datetime_ticket_table,
-            array(
-                    'DTT_ID' => $datetime_id,
-                    'TKT_ID' => $ticket_id
-                ),
-            array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
-                )
-        );
-        // insert new price
-        $wpdb->insert(
-            $this->_new_price_table,
-            array(
-                    'PRC_amount' => $old_att_price,
-                    'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
-                    'PRC_name' => $old_att_price_option,
-                    'PRC_deleted' => true
-                ),
-            array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
-                )
-        );
-        $price_id = $wpdb->insert_id;
-        // associate the price to the ticket
-        $wpdb->insert(
-            $this->_new_ticket_price_table,
-            array(
-                    'TKT_ID' => $ticket_id,
-                    'PRC_ID' => $price_id
-                ),
-            array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
-                )
-        );
-        return $ticket_id;
-    }
-    /**
-     * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
-     * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
-     * @global type $wpdb
-     * @param array $old_attendee_row
-     * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
-     * @return int
-     */
-    private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
-    {
-        global $wpdb;
-        $count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
-        $count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
+				),
+			array(
+					'%s',// name
+					'%d',// qty
+					'%d',// price
+					'%s',// start_date
+					'%s',// end_date
+				)
+		);
+		$ticket_id = $wpdb->insert_id;
+		// associate the ticket with the datetime we found earlier
+		$wpdb->insert(
+			$this->_new_datetime_ticket_table,
+			array(
+					'DTT_ID' => $datetime_id,
+					'TKT_ID' => $ticket_id
+				),
+			array(
+					'%d',// DTT_ID
+					'%d',// TKT_ID
+				)
+		);
+		// insert new price
+		$wpdb->insert(
+			$this->_new_price_table,
+			array(
+					'PRC_amount' => $old_att_price,
+					'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
+					'PRC_name' => $old_att_price_option,
+					'PRC_deleted' => true
+				),
+			array(
+					'%d',// PRC_amount
+					'%d',// PRT_ID
+					'%s',// PRC_name
+					'%d',// PRC_deleted
+				)
+		);
+		$price_id = $wpdb->insert_id;
+		// associate the price to the ticket
+		$wpdb->insert(
+			$this->_new_ticket_price_table,
+			array(
+					'TKT_ID' => $ticket_id,
+					'PRC_ID' => $price_id
+				),
+			array(
+					'%d',// TKT_ID
+					'%d',// PRC_ID
+				)
+		);
+		return $ticket_id;
+	}
+	/**
+	 * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
+	 * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
+	 * @global type $wpdb
+	 * @param array $old_attendee_row
+	 * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
+	 * @return int
+	 */
+	private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
+	{
+		global $wpdb;
+		$count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
+		$count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
 
-        if ($this->_mer_tables_exist()) {
-            // if MER exists, then its a little tricky.
-            // when users registered by adding items to the cart, and it was a
-            // group registration requiring additional attendee INFO, then the attendee rows
-            // DO NOT have the same registration_id (although they probably should have)
-            // they are related just like MER attendee rows are related, through the MER group table
-            // BUT we want to count all the MER attendee rows for the same registration
-            $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
+		if ($this->_mer_tables_exist()) {
+			// if MER exists, then its a little tricky.
+			// when users registered by adding items to the cart, and it was a
+			// group registration requiring additional attendee INFO, then the attendee rows
+			// DO NOT have the same registration_id (although they probably should have)
+			// they are related just like MER attendee rows are related, through the MER group table
+			// BUT we want to count all the MER attendee rows for the same registration
+			$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
 
-            $count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
-            $count = max($count_using_mer_table, $count);
-        }
-        return $count;
-    }
-    private function _insert_new_payment($old_attendee, $new_txn_id)
-    {
-        global $wpdb;
-        // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
-        // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
-        if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
-            $pay_status_mapping = array(
-                'Completed'=>'PAP',
-                'Payment Declined'=>'PDC',
-                'Cancelled'=>'PCN',
-                'Declined'=>'PDC'
-            );
-            $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
-            $cols_n_values = array(
-                'TXN_ID'=>$new_txn_id,
-                'STS_ID'=>$STS_ID,
-                'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'PAY_method'=>'CART',
-                'PAY_amount'=>$old_attendee['amount_pd'],
-                'PAY_gateway'=>$old_attendee['txn_type'],
-                'PAY_gateway_response'=>'',
-                'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
-                'PAY_via_admin'=>$by_admin,
-                'PAY_details'=>$old_attendee['transaction_details']
+			$count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
+			$count = max($count_using_mer_table, $count);
+		}
+		return $count;
+	}
+	private function _insert_new_payment($old_attendee, $new_txn_id)
+	{
+		global $wpdb;
+		// only add a payment for primary attendees
+		$old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+		// if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
+		if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
+			$pay_status_mapping = array(
+				'Completed'=>'PAP',
+				'Payment Declined'=>'PDC',
+				'Cancelled'=>'PCN',
+				'Declined'=>'PDC'
+			);
+			$by_admin = $old_attendee['payment'] == 'Admin';
+			$STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+			$cols_n_values = array(
+				'TXN_ID'=>$new_txn_id,
+				'STS_ID'=>$STS_ID,
+				'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'PAY_method'=>'CART',
+				'PAY_amount'=>$old_attendee['amount_pd'],
+				'PAY_gateway'=>$old_attendee['txn_type'],
+				'PAY_gateway_response'=>'',
+				'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
+				'PAY_via_admin'=>$by_admin,
+				'PAY_details'=>$old_attendee['transaction_details']
 
-            );
-            $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
-            );
-            $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $new_id = $wpdb->insert_id;
-            return $new_id;
-        } else {
-            return 0;
-        }
-    }
+			);
+			$datatypes = array(
+				'%d',// TXN_Id
+				'%s',// STS_ID
+				'%s',// PAY_timestamp
+				'%s',// PAY_method
+				'%f',// PAY_amount
+				'%s',// PAY_gateway
+				'%s',// PAY_gateway_response
+				'%s',// PAY_txn_id_chq_nmbr
+				'%d',// PAY_via_admin
+				'%s',// PAY_details
+			);
+			$success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$new_id = $wpdb->insert_id;
+			return $new_id;
+		} else {
+			return 0;
+		}
+	}
 
-    /**
-     * If MER is active, if you want ot fin dthe other registrations on that attendee row
-     * @global type $wpdb
-     * @param type $old_registration_id
-     * @return array
-     */
-    private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
-    {
-        if (! $this->_mer_tables_exist()) {
-            return false;
-        }
-        global $wpdb;
-        $old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
-        return $old_att_for_primary_reg;
-    }
+	/**
+	 * If MER is active, if you want ot fin dthe other registrations on that attendee row
+	 * @global type $wpdb
+	 * @param type $old_registration_id
+	 * @return array
+	 */
+	private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
+	{
+		if (! $this->_mer_tables_exist()) {
+			return false;
+		}
+		global $wpdb;
+		$old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
+		return $old_att_for_primary_reg;
+	}
 }

Spacing +105 added lines, -105 removed lines

@@ -210,7 +210,7 @@ 
         $this->_pretty_name = __("Attendees", "event_espresso");
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->_extra_where_sql = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
         $this->_new_attendee_cpt_table = $wpdb->posts;
@@ -232,9 +232,9 @@ 
     {
         // first check if there's already a new attendee with similar characteristics
         $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
+        if ( ! $new_att_id) {
             $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
+            if ( ! $new_att_id) {
                 // if we couldnt even make an attendee, abandon all hope
                 return false;
             }
@@ -246,7 +246,7 @@ 
         $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
         $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // if we couldnt make the transaction, also abandon all hope
             return false;
         }
@@ -280,31 +280,31 @@ 
     {
         global $wpdb;
         $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
+            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']), // ATT_full_name
+            'post_content'=>'', // ATT_bio
+            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']), // ATT_slug
+            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_created
+            'post_excerpt'=>'', // ATT_short_bio
+            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_modified
+            'post_author'=>0, // ATT_author
+            'post_parent'=>0, // ATT_parent
+            'post_type'=>'espresso_attendees', // post_type
             'post_status'=>'publish'// status
         );
         $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
+            '%s', // ATT_full_name
+            '%s', // ATT_bio
+            '%s', // ATT_slug
+            '%s', // ATT_created
+            '%s', // ATT_short_bio
+            '%s', // ATT_modified
+            '%d', // ATT_author
+            '%d', // ATT_parent
+            '%s', // post_type
+            '%s', // status
         );
         $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -342,20 +342,20 @@ 
             'ATT_phone'=>stripslashes($old_attendee['phone']),
         );
         $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
+            '%d', // ATT_ID
+            '%s', // ATT_fname
+            '%s', // ATT_lname
+            '%s', // ATT_address
+            '%s', // ATT_address2
+            '%s', // ATT_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // ATT_zip
+            '%s', // ATT_email
+            '%s', // ATT_phone
         );
         $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -380,12 +380,12 @@ 
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
         } else { // non-primary attendee, so find its primary attendee's transaction
             $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
+            if ( ! $primary_attendee_old_id) {
                 $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
                 $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
             }
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
                 $txn_id = 0;
             }
@@ -393,7 +393,7 @@ 
         // if there isn't yet a transaction row for this, create one
         // (so even if it was a non-primary attendee with no EE3 primary attendee,
         // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // maps 3.1 payment stati onto 4.1 transaction stati
             $txn_status_mapping = array(
                 'Completed'=>'TCM',
@@ -404,7 +404,7 @@ 
                 'Cancelled'=>'TIN',
                 'Declined'=>'TIN'
             );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+            $STS_ID = isset($txn_status_mapping[$old_attendee['payment_status']]) ? $txn_status_mapping[$old_attendee['payment_status']] : 'TIN';
             $cols_n_values = array(
                 'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
                 'TXN_total'=>floatval($old_attendee['total_cost']),
@@ -413,14 +413,14 @@ 
                 'TXN_hash_salt'=>$old_attendee['hashSalt']
             );
             $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
+                '%s', // TXN_timestamp
+                '%f', // TXN_total
+                '%f', // TXN_paid
+                '%s', // STS_ID
+                '%s', // TXN_hash_salt
             );
             $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -480,12 +480,12 @@ 
 
         $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
         }
 
         $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
+        if ( ! $ticket_id) {
             $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
             $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
         }
@@ -516,23 +516,23 @@ 
                 'REG_deleted'=>false
             );
             $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
+                '%d', // EVT_ID
+                '%d', // ATT_ID
+                '%d', // TXN_ID
+                '%d', // TKT_ID
+                '%s', // STS_ID
+                '%s', // REG_date
+                '%f', // REG_final_price
+                '%s', // REG_session
+                '%s', // REG_code
+                '%s', // REG_url_link
+                '%d', // REG_count
+                '%d', // REG_group_size
+                '%d', // REG_att_is_going
+                '%d', // REG_deleted
             );
             $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -564,11 +564,11 @@ 
         $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
         if ($success) {
             // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+            $success_update_dateimtes = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
+            if ( ! $success_update_dateimtes) {
                 $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
             }
         } else {
@@ -600,10 +600,10 @@ 
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price), // prices match?
+            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option), // names match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         );
         $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
@@ -613,7 +613,7 @@ 
             $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $ticket_id_found = $wpdb->get_var($full_query);
             array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
+        }while ( ! $ticket_id_found && $conditions);
         return $ticket_id_found;
     }
 
@@ -635,8 +635,8 @@ 
 
 
         // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
+        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM ".$this->_new_datetime_table." WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+        if ( ! $datetime_id) {
             $old_att_end_date = $old_attendee['start_date'];
             $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
             $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
@@ -649,10 +649,10 @@ 
                         'DTT_deleted' => true
                     ),
                 array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
+                        '%d', // EVT_ID
+                        '%s', // DTT_EVT_start
+                        '%s', // DTT_EVT_end
+                        '%d', // DTT_deleted
                     )
             );
             $datetime_id = $wpdb->insert_id;
@@ -660,21 +660,21 @@ 
 
         // insert new ticket
         $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
+            $wpdb->prefix.'esp_ticket',
             array(
                     'TKT_name' => $old_att_price_option,
                     'TKT_qty' => -1,
                     'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+                    'TKT_start_date' => $old_att_start_datetime, // we really have no clue what the time should be, but at least it was available when they attended
                     'TKT_end_date' => $old_att_end_datetime,
 
                 ),
             array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
+                    '%s', // name
+                    '%d', // qty
+                    '%d', // price
+                    '%s', // start_date
+                    '%s', // end_date
                 )
         );
         $ticket_id = $wpdb->insert_id;
@@ -686,8 +686,8 @@ 
                     'TKT_ID' => $ticket_id
                 ),
             array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
+                    '%d', // DTT_ID
+                    '%d', // TKT_ID
                 )
         );
         // insert new price
@@ -700,10 +700,10 @@ 
                     'PRC_deleted' => true
                 ),
             array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
+                    '%d', // PRC_amount
+                    '%d', // PRT_ID
+                    '%s', // PRC_name
+                    '%d', // PRC_deleted
                 )
         );
         $price_id = $wpdb->insert_id;
@@ -715,8 +715,8 @@ 
                     'PRC_ID' => $price_id
                 ),
             array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
+                    '%d', // TKT_ID
+                    '%d', // PRC_ID
                 )
         );
         return $ticket_id;
@@ -753,7 +753,7 @@ 
     {
         global $wpdb;
         // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+        $old_pay_stati_indicating_no_payment = array('Pending', 'Incomplete', 'Not Completed');
         // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
         if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
             $pay_status_mapping = array(
@@ -763,7 +763,7 @@ 
                 'Declined'=>'PDC'
             );
             $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+            $STS_ID = isset($pay_status_mapping[$old_attendee['payment_status']]) ? $pay_status_mapping[$old_attendee['payment_status']] : 'PFL'; // IE, if we don't recognize the status, assume payment failed
             $cols_n_values = array(
                 'TXN_ID'=>$new_txn_id,
                 'STS_ID'=>$STS_ID,
@@ -778,19 +778,19 @@ 
 
             );
             $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
+                '%d', // TXN_Id
+                '%s', // STS_ID
+                '%s', // PAY_timestamp
+                '%s', // PAY_method
+                '%f', // PAY_amount
+                '%s', // PAY_gateway
+                '%s', // PAY_gateway_response
+                '%s', // PAY_txn_id_chq_nmbr
+                '%d', // PAY_via_admin
+                '%s', // PAY_details
             );
             $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -809,7 +809,7 @@ 
      */
     private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
     {
-        if (! $this->_mer_tables_exist()) {
+        if ( ! $this->_mer_tables_exist()) {
             return false;
         }
         global $wpdb;

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_event_venue.dmsstage.php

Indentation +87 added lines, -90 removed lines

@@ -25,105 +25,102 @@
 
             )
         );
-
-
-
  *
  */
 class EE_DMS_4_1_0_event_venue extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_new_table;
-    public function _migration_step($num_items = 50)
-    {
+	private $_old_table;
+	private $_new_table;
+	public function _migration_step($num_items = 50)
+	{
         
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results(
-            $wpdb->prepare(
-                "SELECT * FROM $this->_old_table AS ev 
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT * FROM $this->_old_table AS ev 
                     INNER JOIN " . $wpdb->prefix . "events_detail AS e ON ev.event_id=e.id
                     WHERE e.event_status!='D' LIMIT %d,%d",
-                $start_at_record,
-                $num_items
-            ),
-            ARRAY_A
-        );
-        $items_actually_migrated = 0;
-        foreach ($rows as $event_venue_rel) {
-            $this->_insert_new_event_to_venue_rel($event_venue_rel);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var(
-            "SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
+				$start_at_record,
+				$num_items
+			),
+			ARRAY_A
+		);
+		$items_actually_migrated = 0;
+		foreach ($rows as $event_venue_rel) {
+			$this->_insert_new_event_to_venue_rel($event_venue_rel);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var(
+			"SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
             INNER JOIN " . $wpdb->prefix . 'events_detail AS e ON ev.event_id=e.id
             WHERE e.event_status!="D"'
-        );
-        return $count;
-    }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_venue_rel";
-        $this->_new_table = $wpdb->prefix."esp_event_venue";
-        $this->_pretty_name = __("Event to Venue Relations", "event_espresso");
-        parent::__construct();
-    }
+		);
+		return $count;
+	}
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_venue_rel";
+		$this->_new_table = $wpdb->prefix."esp_event_venue";
+		$this->_pretty_name = __("Event to Venue Relations", "event_espresso");
+		parent::__construct();
+	}
     
-    /**
-     * Attempts to insert a new question group inthe new format given an old one
-     * @global type $wpdb
-     * @param array $old_event_venue_rel
-     * @return int
-     */
-    private function _insert_new_event_to_venue_rel($old_event_venue_rel)
-    {
-        global $wpdb;
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
-        $new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
-            return 0;
-        }
-        if (! $new_venue_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
-            return 0;
-        }
-        // first ensure there are no other relation entries for this event
-        // because although EE4 supports it, EE3 didn't really
-        $wpdb->delete(
-            $this->_new_table,
-            array(
-                    'EVT_ID' => $new_event_id,
-                ),
-            array(
-                    '%d',// EVT_ID
-                )
-        );
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_event_venue_rel
+	 * @return int
+	 */
+	private function _insert_new_event_to_venue_rel($old_event_venue_rel)
+	{
+		global $wpdb;
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
+		$new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
+			return 0;
+		}
+		if (! $new_venue_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
+			return 0;
+		}
+		// first ensure there are no other relation entries for this event
+		// because although EE4 supports it, EE3 didn't really
+		$wpdb->delete(
+			$this->_new_table,
+			array(
+					'EVT_ID' => $new_event_id,
+				),
+			array(
+					'%d',// EVT_ID
+				)
+		);
 //      echo "last query". $wpdb->last_query;die;
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'VNU_ID'=>$new_venue_id,
-            'EVV_primary'=>true
-        );
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
-        );
-        $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'VNU_ID'=>$new_venue_id,
+			'EVV_primary'=>true
+		);
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// VNU_ID
+			'%d',// EVT_primary
+		);
+		$success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -42,7 +42,7 @@ 
         $rows = $wpdb->get_results(
             $wpdb->prepare(
                 "SELECT * FROM $this->_old_table AS ev 
-                    INNER JOIN " . $wpdb->prefix . "events_detail AS e ON ev.event_id=e.id
+                    INNER JOIN ".$wpdb->prefix."events_detail AS e ON ev.event_id=e.id
                     WHERE e.event_status!='D' LIMIT %d,%d",
                 $start_at_record,
                 $num_items
@@ -63,8 +63,8 @@ 
     {
         global $wpdb;
         $count = $wpdb->get_var(
-            "SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
-            INNER JOIN " . $wpdb->prefix . 'events_detail AS e ON ev.event_id=e.id
+            "SELECT COUNT(ev.id) FROM ".$this->_old_table." AS ev 
+            INNER JOIN " . $wpdb->prefix.'events_detail AS e ON ev.event_id=e.id
             WHERE e.event_status!="D"'
         );
         return $count;
@@ -89,11 +89,11 @@ 
         global $wpdb;
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
         $new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
             return 0;
         }
-        if (! $new_venue_id) {
+        if ( ! $new_venue_id) {
             $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
             return 0;
         }
@@ -105,7 +105,7 @@ 
                     'EVT_ID' => $new_event_id,
                 ),
             array(
-                    '%d',// EVT_ID
+                    '%d', // EVT_ID
                 )
         );
 //      echo "last query". $wpdb->last_query;die;
@@ -115,12 +115,12 @@ 
             'EVV_primary'=>true
         );
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
+            '%d', // EVT_ID
+            '%d', // VNU_ID
+            '%d', // EVT_primary
         );
         $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }