eventespresso / event-espresso-core

caffeinated/admin/extend/events/Extend_Events_Admin_Page.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -342,7 +342,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function add_additional_datetime_button($template, $template_args)
@@ -360,7 +360,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function add_datetime_clone_button($template, $template_args)
@@ -378,7 +378,7 @@ 
      *
      * @param $template
      * @param $template_args
-     * @return mixed
+     * @return string
      * @throws DomainException
      */
     public function datetime_timezones_template($template, $template_args)

Indentation +1278 added lines, -1278 removed lines

@@ -16,1282 +16,1282 @@
 {
 
 
-    /**
-     * Extend_Events_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
-        }
-    }
-
-
-    /**
-     * Sets routes.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
-        // is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        // tkt_id?
-        $tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
-            ? $this->_req_data['TKT_ID']
-            : 0;
-        $new_page_routes = array(
-            'duplicate_event'          => array(
-                'func'       => '_duplicate_event',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'ticket_list_table'        => array(
-                'func'       => '_tickets_overview_list_table',
-                'capability' => 'ee_read_default_tickets',
-            ),
-            'trash_ticket'             => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'trash_tickets'            => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'restore_ticket'           => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'restore_tickets'          => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'delete_ticket'            => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'delete_tickets'           => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'import_page'              => array(
-                'func'       => '_import_page',
-                'capability' => 'import',
-            ),
-            'import'                   => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'import_events'            => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'export_events'            => array(
-                'func'       => '_events_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'export_categories'        => array(
-                'func'       => '_categories_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'sample_export_file'       => array(
-                'func'       => '_sample_export_file',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'update_template_settings' => array(
-                'func'       => '_update_template_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        // partial route/config override
-        $this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
-        $this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
-        // add tickets tab but only if there are more than one default ticket!
-        $tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        );
-        if ($tkt_count > 1) {
-            $new_page_config = array(
-                'ticket_list_table' => array(
-                    'nav'           => array(
-                        'label' => esc_html__('Default Tickets', 'event_espresso'),
-                        'order' => 60,
-                    ),
-                    'list_table'    => 'Tickets_List_Table',
-                    'require_nonce' => false,
-                ),
-            );
-        }
-        // template settings
-        $new_page_config['template_settings'] = array(
-            'nav'           => array(
-                'label' => esc_html__('Templates', 'event_espresso'),
-                'order' => 30,
-            ),
-            'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-            'help_tabs'     => array(
-                'general_settings_templates_help_tab' => array(
-                    'title'    => esc_html__('Templates', 'event_espresso'),
-                    'filename' => 'general_settings_templates',
-                ),
-            ),
-            'help_tour'     => array('Templates_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        // add filters and actions
-        // modifying _views
-        add_filter(
-            'FHEE_event_datetime_metabox_add_additional_date_time_template',
-            array($this, 'add_additional_datetime_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_clone_button_template',
-            array($this, 'add_datetime_clone_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_timezones_template',
-            array($this, 'datetime_timezones_template'),
-            10,
-            2
-        );
-        // filters for event list table
-        add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
-        add_filter(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            array($this, 'extra_list_table_actions'),
-            10,
-            2
-        );
-        // legend item
-        add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
-        add_action('admin_init', array($this, 'admin_init'));
-        // heartbeat stuff
-        add_filter('heartbeat_received', array($this, 'heartbeat_response'), 10, 2);
-    }
-
-
-    /**
-     * admin_init
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings = array_merge(
-            EE_Registry::$i18n_js_strings,
-            array(
-                'image_confirm'          => esc_html__(
-                    'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-                    'event_espresso'
-                ),
-                'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
-                'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
-                'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
-                'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
-                'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
-            )
-        );
-    }
-
-
-    /**
-     * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
-     * accordingly.
-     *
-     * @param array $response The existing heartbeat response array.
-     * @param array $data     The incoming data package.
-     * @return array  possibly appended response.
-     */
-    public function heartbeat_response($response, $data)
-    {
-        /**
-         * check whether count of tickets is approaching the potential
-         * limits for the server.
-         */
-        if (! empty($data['input_count'])) {
-            $response['max_input_vars_check'] = EE_Registry::instance()->CFG->environment->max_input_vars_limit_check(
-                $data['input_count']
-            );
-        }
-        return $response;
-    }
-
-
-    /**
-     * Add per page screen options to the default ticket list table view.
-     */
-    protected function _add_screen_options_ticket_list_table()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @param string $return
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $href = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'duplicate_event', 'EVT_ID' => $id),
-                $this->_admin_base_url
-            );
-            $title = esc_attr__('Duplicate Event', 'event_espresso');
-            $return .= '<a href="'
-                       . $href
-                       . '" title="'
-                       . $title
-                       . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
-                       . $title
-                       . '</a>';
-        }
-        return $return;
-    }
-
-
-    /**
-     * Set the list table views for the default ticket list table view.
-     */
-    public function _set_list_table_views_ticket_list_table()
-    {
-        $this->_views = array(
-            'all'     => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'trashed' => array(
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the event editor.
-     */
-    public function load_scripts_styles_edit()
-    {
-        wp_register_script(
-            'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
-            array('ee_admin_js', 'heartbeat'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-accounting');
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('event_editor_js');
-        wp_enqueue_script('ee-event-editor-heartbeat');
-    }
-
-
-    /**
-     * Returns template for the additional datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_additional_datetime_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for cloning a datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_datetime_clone_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for datetime timezones.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function datetime_timezones_template($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Sets the views for the default list table view.
-     */
-    protected function _set_list_table_views_default()
-    {
-        parent::_set_list_table_views_default();
-        $new_views = array(
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => esc_html__('Today', 'event_espresso'),
-                'count'       => $this->total_events_today(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => $this->total_events_this_month(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        $this->_views = array_merge($this->_views, $new_views);
-    }
-
-
-    /**
-     * Returns the extra action links for the default list table view.
-     *
-     * @param array     $action_links
-     * @param \EE_Event $event
-     * @return array
-     * @throws EE_Error
-     */
-    public function extra_list_table_actions(array $action_links, \EE_Event $event)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports',
-            $event->ID()
-        )
-        ) {
-            $reports_query_args = array(
-                'action' => 'reports',
-                'EVT_ID' => $event->ID(),
-            );
-            $reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="'
-                              . $reports_link
-                              . '" title="'
-                              . esc_attr__('View Report', 'event_espresso')
-                              . '"><div class="dashicons dashicons-chart-bar"></div></a>'
-                              . "\n\t";
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            $action_links[] = EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                array('EVT_ID' => $event->ID())
-            );
-        }
-        return $action_links;
-    }
-
-
-    /**
-     * @param $items
-     * @return mixed
-     */
-    public function additional_legend_items($items)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports'
-        )
-        ) {
-            $items['reports'] = array(
-                'class' => 'dashicons dashicons-chart-bar',
-                'desc'  => esc_html__('Event Reports', 'event_espresso'),
-            );
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        return $items;
-    }
-
-
-    /**
-     * This is the callback method for the duplicate event route
-     * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
-     * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
-     * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
-     * After duplication the redirect is to the new event edit page.
-     *
-     * @return void
-     * @access protected
-     * @throws EE_Error If EE_Event is not available with given ID
-     */
-    protected function _duplicate_event()
-    {
-        // first make sure the ID for the event is in the request.
-        //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        if (! isset($this->_req_data['EVT_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to duplicate an event an Event ID is required.  None was given.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-            return;
-        }
-        // k we've got EVT_ID so let's use that to get the event we'll duplicate
-        $orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
-        if (! $orig_event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
-                    $this->_req_data['EVT_ID']
-                )
-            );
-        }
-        // k now let's clone the $orig_event before getting relations
-        $new_event = clone $orig_event;
-        // original datetimes
-        $orig_datetimes = $orig_event->get_many_related('Datetime');
-        // other original relations
-        $orig_ven = $orig_event->get_many_related('Venue');
-        // reset the ID and modify other details to make it clear this is a dupe
-        $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
-        $new_event->set('EVT_name', $new_name);
-        $new_event->set(
-            'EVT_slug',
-            wp_unique_post_slug(
-                sanitize_title($orig_event->name()),
-                0,
-                'publish',
-                'espresso_events',
-                0
-            )
-        );
-        $new_event->set('status', 'draft');
-        // duplicate discussion settings
-        $new_event->set('comment_status', $orig_event->get('comment_status'));
-        $new_event->set('ping_status', $orig_event->get('ping_status'));
-        // save the new event
-        $new_event->save();
-        // venues
-        foreach ($orig_ven as $ven) {
-            $new_event->_add_relation_to($ven, 'Venue');
-        }
-        $new_event->save();
-        // now we need to get the question group relations and handle that
-        // first primary question groups
-        $orig_primary_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 1))
-        );
-        if (! empty($orig_primary_qgs)) {
-            foreach ($orig_primary_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
-                }
-            }
-        }
-        // next additional attendee question groups
-        $orig_additional_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 0))
-        );
-        if (! empty($orig_additional_qgs)) {
-            foreach ($orig_additional_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
-                }
-            }
-        }
-
-        $new_event->save();
-
-        // k now that we have the new event saved we can loop through the datetimes and start adding relations.
-        $cloned_tickets = array();
-        foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
-                continue;
-            }
-            $new_dtt = clone $orig_dtt;
-            $orig_tkts = $orig_dtt->tickets();
-            // save new dtt then add to event
-            $new_dtt->set('DTT_ID', 0);
-            $new_dtt->set('DTT_sold', 0);
-            $new_dtt->set_reserved(0);
-            $new_dtt->save();
-            $new_event->_add_relation_to($new_dtt, 'Datetime');
-            $new_event->save();
-            // now let's get the ticket relations setup.
-            foreach ((array) $orig_tkts as $orig_tkt) {
-                // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_tkt instanceof EE_Ticket) {
-                    continue;
-                }
-                // is this ticket archived?  If it is then let's skip
-                if ($orig_tkt->get('TKT_deleted')) {
-                    continue;
-                }
-                // does this original ticket already exist in the clone_tickets cache?
-                //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
-                    $new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
-                } else {
-                    $new_tkt = clone $orig_tkt;
-                    // get relations on the $orig_tkt that we need to setup.
-                    $orig_prices = $orig_tkt->prices();
-                    $new_tkt->set('TKT_ID', 0);
-                    $new_tkt->set('TKT_sold', 0);
-                    $new_tkt->set('TKT_reserved', 0);
-                    $new_tkt->save(); // make sure new ticket has ID.
-                    // price relations on new ticket need to be setup.
-                    foreach ($orig_prices as $orig_price) {
-                        $new_price = clone $orig_price;
-                        $new_price->set('PRC_ID', 0);
-                        $new_price->save();
-                        $new_tkt->_add_relation_to($new_price, 'Price');
-                        $new_tkt->save();
-                    }
-
-                    do_action(
-                        'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
-                        $orig_tkt,
-                        $new_tkt,
-                        $orig_prices,
-                        $orig_event,
-                        $orig_dtt,
-                        $new_dtt
-                    );
-                }
-                // k now we can add the new ticket as a relation to the new datetime
-                // and make sure its added to our cached $cloned_tickets array
-                // for use with later datetimes that have the same ticket.
-                $new_dtt->_add_relation_to($new_tkt, 'Ticket');
-                $new_dtt->save();
-                $cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
-            }
-        }
-        // clone taxonomy information
-        $taxonomies_to_clone_with = apply_filters(
-            'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
-            array('espresso_event_categories', 'espresso_event_type', 'post_tag')
-        );
-        // get terms for original event (notice)
-        $orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
-        // loop through terms and add them to new event.
-        foreach ($orig_terms as $term) {
-            wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
-        }
-
-        // duplicate other core WP_Post items for this event.
-        // post thumbnail (feature image).
-        $feature_image_id = get_post_thumbnail_id($orig_event->ID());
-        if ($feature_image_id) {
-            update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
-        }
-
-        // duplicate page_template setting
-        $page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
-        if ($page_template) {
-            update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
-        }
-
-        do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
-        // now let's redirect to the edit page for this duplicated event if we have a new event id.
-        if ($new_event->ID()) {
-            $redirect_args = array(
-                'post'   => $new_event->ID(),
-                'action' => 'edit',
-            );
-            EE_Error::add_success(
-                esc_html__(
-                    'Event successfully duplicated.  Please review the details below and make any necessary edits',
-                    'event_espresso'
-                )
-            );
-        } else {
-            $redirect_args = array(
-                'action' => 'default',
-            );
-            EE_Error::add_error(
-                esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $redirect_args, true);
-    }
-
-
-    /**
-     * Generates output for the import page.
-     *
-     * @throws DomainException
-     */
-    protected function _import_page()
-    {
-        $title = esc_html__('Import', 'event_espresso');
-        $intro = esc_html__(
-            'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
-            'event_espresso'
-        );
-        $form_url = EVENTS_ADMIN_URL;
-        $action = 'import_events';
-        $type = 'csv';
-        $this->_template_args['form'] = EE_Import::instance()->upload_form(
-            $title,
-            $intro,
-            $form_url,
-            $action,
-            $type
-        );
-        $this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'sample_export_file'),
-            $this->_admin_base_url
-        );
-        $content = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['admin_page_content'] = $content;
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _import_events
-     * This handles displaying the screen and running imports for importing events.
-     *
-     * @return void
-     */
-    protected function _import_events()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        $success = EE_Import::instance()->import();
-        $this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
-    }
-
-
-    /**
-     * _events_export
-     * Will export all (or just the given event) to a Excel compatible file.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _events_export()
-    {
-        if (isset($this->_req_data['EVT_ID'])) {
-            $event_ids = $this->_req_data['EVT_ID'];
-        } elseif (isset($this->_req_data['EVT_IDs'])) {
-            $event_ids = $this->_req_data['EVT_IDs'];
-        } else {
-            $event_ids = null;
-        }
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export' => 'report',
-            'action' => 'all_event_data',
-            'EVT_ID' => $event_ids,
-        );
-        $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export'       => 'report',
-            'action'       => 'categories',
-            'category_ids' => $this->_req_data['EVT_CAT_ID'],
-        );
-        $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * Creates a sample CSV file for importing
-     */
-    protected function _sample_export_file()
-    {
-        // require_once(EE_CLASSES . 'EE_Export.class.php');
-        EE_Export::instance()->export_sample();
-    }
-
-
-    /*************        Template Settings        *************/
-    /**
-     * Generates template settings page output
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        $this->_template_args = apply_filters(
-            'FHEE__General_Settings_Admin_Page__template_settings__template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_template_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating template settings.
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _update_template_settings()
-    {
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        EE_Registry::instance()->CFG->template_settings = apply_filters(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            EE_Registry::instance()->CFG->template_settings,
-            $this->_req_data
-        );
-        // update custom post type slugs and detect if we need to flush rewrite rules
-        $old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
-        EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
-            ? EE_Registry::instance()->CFG->core->event_cpt_slug
-            : sanitize_title_with_dashes($this->_req_data['event_cpt_slug']);
-        $what = 'Template Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->template_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-        }
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
-    }
-
-
-    /**
-     * _premium_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _premium_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            array($this, 'registration_options_meta_box'),
-            $this->page_slug,
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * override caf metabox
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = array(
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
-        );
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
-            'EVT_default_registration_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * wp_list_table_mods for caf
-     * ============================
-     */
-    /**
-     * hook into list table filters and provide filters for caffeinated list table
-     *
-     * @param  array $old_filters    any existing filters present
-     * @param  array $list_table_obj the list table object
-     * @return array                  new filters
-     */
-    public function list_table_filters($old_filters, $list_table_obj)
-    {
-        $filters = array();
-        // first month/year filters
-        $filters[] = $this->espresso_event_months_dropdown();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // active status dropdown
-        if ($status !== 'draft') {
-            $filters[] = $this->active_status_dropdown(
-                isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
-            );
-        }
-        // category filter
-        $filters[] = $this->category_dropdown();
-        return array_merge($old_filters, $filters);
-    }
-
-
-    /**
-     * espresso_event_months_dropdown
-     *
-     * @access public
-     * @return string                dropdown listing month/year selections for events.
-     */
-    public function espresso_event_months_dropdown()
-    {
-        // what we need to do is get all PRIMARY datetimes for all events to filter on.
-        // Note we need to include any other filters that are set!
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT']
-            : null;
-        // active status?
-        $active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
-        $cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
-        return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
-    }
-
-
-    /**
-     * returns a list of "active" statuses on the event
-     *
-     * @param  string $current_value whatever the current active status is
-     * @return string
-     */
-    public function active_status_dropdown($current_value = '')
-    {
-        $select_name = 'active_status';
-        $values = array(
-            'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
-            'active'   => esc_html__('Active', 'event_espresso'),
-            'upcoming' => esc_html__('Upcoming', 'event_espresso'),
-            'expired'  => esc_html__('Expired', 'event_espresso'),
-            'inactive' => esc_html__('Inactive', 'event_espresso'),
-        );
-        $id = 'id="espresso-active-status-dropdown-filter"';
-        $class = 'wide';
-        return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
-    }
-
-
-    /**
-     * output a dropdown of the categories for the category filter on the event admin list table
-     *
-     * @access  public
-     * @return string html
-     */
-    public function category_dropdown()
-    {
-        $cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
-        return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
-    }
-
-
-    /**
-     * get total number of events today
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_today()
-    {
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     * get total number of events this month
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_this_month()
-    {
-        // Dates
-        $this_year_r = date('Y');
-        $this_month_r = date('m');
-        $days_this_month = date('t');
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /** DEFAULT TICKETS STUFF **/
-
-    /**
-     * Output default tickets list table view.
-     */
-    public function _tickets_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $trashed
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
-    {
-        $orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
-        $order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
-        switch ($orderby) {
-            case 'TKT_name':
-                $orderby = array('TKT_name' => $order);
-                break;
-            case 'TKT_price':
-                $orderby = array('TKT_price' => $order);
-                break;
-            case 'TKT_uses':
-                $orderby = array('TKT_uses' => $order);
-                break;
-            case 'TKT_min':
-                $orderby = array('TKT_min' => $order);
-                break;
-            case 'TKT_max':
-                $orderby = array('TKT_max' => $order);
-                break;
-            case 'TKT_qty':
-                $orderby = array('TKT_qty' => $order);
-                break;
-        }
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where = array(
-            'TKT_is_default' => 1,
-            'TKT_deleted'    => $trashed,
-        );
-        $offset = ($current_page - 1) * $per_page;
-        $limit = array($offset, $per_page);
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'TKT_name'        => array('LIKE', $sstr),
-                'TKT_description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $_where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-            'group_by' => 'TKT_ID',
-        );
-        if ($count) {
-            return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
-        } else {
-            return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_ticket($trash = false)
-    {
-        $success = 1;
-        $TKT = EEM_Ticket::instance();
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        }
-        $action_desc = $trash ? 'moved to the trash' : 'restored';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => $trash ? '' : 'trashed',
-        );
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * Handles trashing default ticket.
-     */
-    protected function _delete_ticket()
-    {
-        $success = 1;
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if (! $this->_delete_the_ticket($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = 'deleted';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => 'trashed',
-        );
-        // fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
-        if (EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        )
-        ) {
-            $query_args = array();
-        }
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param int $TKT_ID
-     * @return bool|int
-     * @throws EE_Error
-     */
-    protected function _delete_the_ticket($TKT_ID)
-    {
-        $tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
-        $tkt->_remove_relations('Datetime');
-        // delete all related prices first
-        $tkt->delete_related_permanently('Price');
-        return $tkt->delete_permanently();
-    }
+	/**
+	 * Extend_Events_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+			define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
+			define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
+			define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+		}
+	}
+
+
+	/**
+	 * Sets routes.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+		// is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		// tkt_id?
+		$tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
+			? $this->_req_data['TKT_ID']
+			: 0;
+		$new_page_routes = array(
+			'duplicate_event'          => array(
+				'func'       => '_duplicate_event',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'ticket_list_table'        => array(
+				'func'       => '_tickets_overview_list_table',
+				'capability' => 'ee_read_default_tickets',
+			),
+			'trash_ticket'             => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'trash_tickets'            => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'restore_ticket'           => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'restore_tickets'          => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'delete_ticket'            => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'delete_tickets'           => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'import_page'              => array(
+				'func'       => '_import_page',
+				'capability' => 'import',
+			),
+			'import'                   => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'import_events'            => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'export_events'            => array(
+				'func'       => '_events_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'export_categories'        => array(
+				'func'       => '_categories_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'sample_export_file'       => array(
+				'func'       => '_sample_export_file',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'update_template_settings' => array(
+				'func'       => '_update_template_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		// partial route/config override
+		$this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
+		$this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
+		// add tickets tab but only if there are more than one default ticket!
+		$tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		);
+		if ($tkt_count > 1) {
+			$new_page_config = array(
+				'ticket_list_table' => array(
+					'nav'           => array(
+						'label' => esc_html__('Default Tickets', 'event_espresso'),
+						'order' => 60,
+					),
+					'list_table'    => 'Tickets_List_Table',
+					'require_nonce' => false,
+				),
+			);
+		}
+		// template settings
+		$new_page_config['template_settings'] = array(
+			'nav'           => array(
+				'label' => esc_html__('Templates', 'event_espresso'),
+				'order' => 30,
+			),
+			'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+			'help_tabs'     => array(
+				'general_settings_templates_help_tab' => array(
+					'title'    => esc_html__('Templates', 'event_espresso'),
+					'filename' => 'general_settings_templates',
+				),
+			),
+			'help_tour'     => array('Templates_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		// add filters and actions
+		// modifying _views
+		add_filter(
+			'FHEE_event_datetime_metabox_add_additional_date_time_template',
+			array($this, 'add_additional_datetime_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_clone_button_template',
+			array($this, 'add_datetime_clone_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_timezones_template',
+			array($this, 'datetime_timezones_template'),
+			10,
+			2
+		);
+		// filters for event list table
+		add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
+		add_filter(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			array($this, 'extra_list_table_actions'),
+			10,
+			2
+		);
+		// legend item
+		add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
+		add_action('admin_init', array($this, 'admin_init'));
+		// heartbeat stuff
+		add_filter('heartbeat_received', array($this, 'heartbeat_response'), 10, 2);
+	}
+
+
+	/**
+	 * admin_init
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings = array_merge(
+			EE_Registry::$i18n_js_strings,
+			array(
+				'image_confirm'          => esc_html__(
+					'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+					'event_espresso'
+				),
+				'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
+				'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
+				'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
+				'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
+				'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
+			)
+		);
+	}
+
+
+	/**
+	 * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
+	 * accordingly.
+	 *
+	 * @param array $response The existing heartbeat response array.
+	 * @param array $data     The incoming data package.
+	 * @return array  possibly appended response.
+	 */
+	public function heartbeat_response($response, $data)
+	{
+		/**
+		 * check whether count of tickets is approaching the potential
+		 * limits for the server.
+		 */
+		if (! empty($data['input_count'])) {
+			$response['max_input_vars_check'] = EE_Registry::instance()->CFG->environment->max_input_vars_limit_check(
+				$data['input_count']
+			);
+		}
+		return $response;
+	}
+
+
+	/**
+	 * Add per page screen options to the default ticket list table view.
+	 */
+	protected function _add_screen_options_ticket_list_table()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @param string $return
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		$return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$href = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'duplicate_event', 'EVT_ID' => $id),
+				$this->_admin_base_url
+			);
+			$title = esc_attr__('Duplicate Event', 'event_espresso');
+			$return .= '<a href="'
+					   . $href
+					   . '" title="'
+					   . $title
+					   . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
+					   . $title
+					   . '</a>';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * Set the list table views for the default ticket list table view.
+	 */
+	public function _set_list_table_views_ticket_list_table()
+	{
+		$this->_views = array(
+			'all'     => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'trashed' => array(
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the event editor.
+	 */
+	public function load_scripts_styles_edit()
+	{
+		wp_register_script(
+			'ee-event-editor-heartbeat',
+			EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+			array('ee_admin_js', 'heartbeat'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-accounting');
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('event_editor_js');
+		wp_enqueue_script('ee-event-editor-heartbeat');
+	}
+
+
+	/**
+	 * Returns template for the additional datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_additional_datetime_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for cloning a datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_datetime_clone_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for datetime timezones.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function datetime_timezones_template($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Sets the views for the default list table view.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		parent::_set_list_table_views_default();
+		$new_views = array(
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => esc_html__('Today', 'event_espresso'),
+				'count'       => $this->total_events_today(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => $this->total_events_this_month(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		$this->_views = array_merge($this->_views, $new_views);
+	}
+
+
+	/**
+	 * Returns the extra action links for the default list table view.
+	 *
+	 * @param array     $action_links
+	 * @param \EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function extra_list_table_actions(array $action_links, \EE_Event $event)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports',
+			$event->ID()
+		)
+		) {
+			$reports_query_args = array(
+				'action' => 'reports',
+				'EVT_ID' => $event->ID(),
+			);
+			$reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="'
+							  . $reports_link
+							  . '" title="'
+							  . esc_attr__('View Report', 'event_espresso')
+							  . '"><div class="dashicons dashicons-chart-bar"></div></a>'
+							  . "\n\t";
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			$action_links[] = EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				array('EVT_ID' => $event->ID())
+			);
+		}
+		return $action_links;
+	}
+
+
+	/**
+	 * @param $items
+	 * @return mixed
+	 */
+	public function additional_legend_items($items)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports'
+		)
+		) {
+			$items['reports'] = array(
+				'class' => 'dashicons dashicons-chart-bar',
+				'desc'  => esc_html__('Event Reports', 'event_espresso'),
+			);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		return $items;
+	}
+
+
+	/**
+	 * This is the callback method for the duplicate event route
+	 * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
+	 * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
+	 * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
+	 * After duplication the redirect is to the new event edit page.
+	 *
+	 * @return void
+	 * @access protected
+	 * @throws EE_Error If EE_Event is not available with given ID
+	 */
+	protected function _duplicate_event()
+	{
+		// first make sure the ID for the event is in the request.
+		//  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
+		if (! isset($this->_req_data['EVT_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to duplicate an event an Event ID is required.  None was given.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+			return;
+		}
+		// k we've got EVT_ID so let's use that to get the event we'll duplicate
+		$orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
+		if (! $orig_event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
+					$this->_req_data['EVT_ID']
+				)
+			);
+		}
+		// k now let's clone the $orig_event before getting relations
+		$new_event = clone $orig_event;
+		// original datetimes
+		$orig_datetimes = $orig_event->get_many_related('Datetime');
+		// other original relations
+		$orig_ven = $orig_event->get_many_related('Venue');
+		// reset the ID and modify other details to make it clear this is a dupe
+		$new_event->set('EVT_ID', 0);
+		$new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+		$new_event->set('EVT_name', $new_name);
+		$new_event->set(
+			'EVT_slug',
+			wp_unique_post_slug(
+				sanitize_title($orig_event->name()),
+				0,
+				'publish',
+				'espresso_events',
+				0
+			)
+		);
+		$new_event->set('status', 'draft');
+		// duplicate discussion settings
+		$new_event->set('comment_status', $orig_event->get('comment_status'));
+		$new_event->set('ping_status', $orig_event->get('ping_status'));
+		// save the new event
+		$new_event->save();
+		// venues
+		foreach ($orig_ven as $ven) {
+			$new_event->_add_relation_to($ven, 'Venue');
+		}
+		$new_event->save();
+		// now we need to get the question group relations and handle that
+		// first primary question groups
+		$orig_primary_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 1))
+		);
+		if (! empty($orig_primary_qgs)) {
+			foreach ($orig_primary_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
+				}
+			}
+		}
+		// next additional attendee question groups
+		$orig_additional_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 0))
+		);
+		if (! empty($orig_additional_qgs)) {
+			foreach ($orig_additional_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
+				}
+			}
+		}
+
+		$new_event->save();
+
+		// k now that we have the new event saved we can loop through the datetimes and start adding relations.
+		$cloned_tickets = array();
+		foreach ($orig_datetimes as $orig_dtt) {
+			if (! $orig_dtt instanceof EE_Datetime) {
+				continue;
+			}
+			$new_dtt = clone $orig_dtt;
+			$orig_tkts = $orig_dtt->tickets();
+			// save new dtt then add to event
+			$new_dtt->set('DTT_ID', 0);
+			$new_dtt->set('DTT_sold', 0);
+			$new_dtt->set_reserved(0);
+			$new_dtt->save();
+			$new_event->_add_relation_to($new_dtt, 'Datetime');
+			$new_event->save();
+			// now let's get the ticket relations setup.
+			foreach ((array) $orig_tkts as $orig_tkt) {
+				// it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
+				if (! $orig_tkt instanceof EE_Ticket) {
+					continue;
+				}
+				// is this ticket archived?  If it is then let's skip
+				if ($orig_tkt->get('TKT_deleted')) {
+					continue;
+				}
+				// does this original ticket already exist in the clone_tickets cache?
+				//  If so we'll just use the new ticket from it.
+				if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
+					$new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
+				} else {
+					$new_tkt = clone $orig_tkt;
+					// get relations on the $orig_tkt that we need to setup.
+					$orig_prices = $orig_tkt->prices();
+					$new_tkt->set('TKT_ID', 0);
+					$new_tkt->set('TKT_sold', 0);
+					$new_tkt->set('TKT_reserved', 0);
+					$new_tkt->save(); // make sure new ticket has ID.
+					// price relations on new ticket need to be setup.
+					foreach ($orig_prices as $orig_price) {
+						$new_price = clone $orig_price;
+						$new_price->set('PRC_ID', 0);
+						$new_price->save();
+						$new_tkt->_add_relation_to($new_price, 'Price');
+						$new_tkt->save();
+					}
+
+					do_action(
+						'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
+						$orig_tkt,
+						$new_tkt,
+						$orig_prices,
+						$orig_event,
+						$orig_dtt,
+						$new_dtt
+					);
+				}
+				// k now we can add the new ticket as a relation to the new datetime
+				// and make sure its added to our cached $cloned_tickets array
+				// for use with later datetimes that have the same ticket.
+				$new_dtt->_add_relation_to($new_tkt, 'Ticket');
+				$new_dtt->save();
+				$cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
+			}
+		}
+		// clone taxonomy information
+		$taxonomies_to_clone_with = apply_filters(
+			'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
+			array('espresso_event_categories', 'espresso_event_type', 'post_tag')
+		);
+		// get terms for original event (notice)
+		$orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
+		// loop through terms and add them to new event.
+		foreach ($orig_terms as $term) {
+			wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
+		}
+
+		// duplicate other core WP_Post items for this event.
+		// post thumbnail (feature image).
+		$feature_image_id = get_post_thumbnail_id($orig_event->ID());
+		if ($feature_image_id) {
+			update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
+		}
+
+		// duplicate page_template setting
+		$page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
+		if ($page_template) {
+			update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
+		}
+
+		do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
+		// now let's redirect to the edit page for this duplicated event if we have a new event id.
+		if ($new_event->ID()) {
+			$redirect_args = array(
+				'post'   => $new_event->ID(),
+				'action' => 'edit',
+			);
+			EE_Error::add_success(
+				esc_html__(
+					'Event successfully duplicated.  Please review the details below and make any necessary edits',
+					'event_espresso'
+				)
+			);
+		} else {
+			$redirect_args = array(
+				'action' => 'default',
+			);
+			EE_Error::add_error(
+				esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $redirect_args, true);
+	}
+
+
+	/**
+	 * Generates output for the import page.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _import_page()
+	{
+		$title = esc_html__('Import', 'event_espresso');
+		$intro = esc_html__(
+			'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
+			'event_espresso'
+		);
+		$form_url = EVENTS_ADMIN_URL;
+		$action = 'import_events';
+		$type = 'csv';
+		$this->_template_args['form'] = EE_Import::instance()->upload_form(
+			$title,
+			$intro,
+			$form_url,
+			$action,
+			$type
+		);
+		$this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'sample_export_file'),
+			$this->_admin_base_url
+		);
+		$content = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['admin_page_content'] = $content;
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _import_events
+	 * This handles displaying the screen and running imports for importing events.
+	 *
+	 * @return void
+	 */
+	protected function _import_events()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		$success = EE_Import::instance()->import();
+		$this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
+	}
+
+
+	/**
+	 * _events_export
+	 * Will export all (or just the given event) to a Excel compatible file.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _events_export()
+	{
+		if (isset($this->_req_data['EVT_ID'])) {
+			$event_ids = $this->_req_data['EVT_ID'];
+		} elseif (isset($this->_req_data['EVT_IDs'])) {
+			$event_ids = $this->_req_data['EVT_IDs'];
+		} else {
+			$event_ids = null;
+		}
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export' => 'report',
+			'action' => 'all_event_data',
+			'EVT_ID' => $event_ids,
+		);
+		$this->_req_data = array_merge($this->_req_data, $new_request_args);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export'       => 'report',
+			'action'       => 'categories',
+			'category_ids' => $this->_req_data['EVT_CAT_ID'],
+		);
+		$this->_req_data = array_merge($this->_req_data, $new_request_args);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * Creates a sample CSV file for importing
+	 */
+	protected function _sample_export_file()
+	{
+		// require_once(EE_CLASSES . 'EE_Export.class.php');
+		EE_Export::instance()->export_sample();
+	}
+
+
+	/*************        Template Settings        *************/
+	/**
+	 * Generates template settings page output
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _template_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		$this->_template_args = apply_filters(
+			'FHEE__General_Settings_Admin_Page__template_settings__template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_template_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating template settings.
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _update_template_settings()
+	{
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		EE_Registry::instance()->CFG->template_settings = apply_filters(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			EE_Registry::instance()->CFG->template_settings,
+			$this->_req_data
+		);
+		// update custom post type slugs and detect if we need to flush rewrite rules
+		$old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
+		EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
+			? EE_Registry::instance()->CFG->core->event_cpt_slug
+			: sanitize_title_with_dashes($this->_req_data['event_cpt_slug']);
+		$what = 'Template Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->template_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+		}
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
+	}
+
+
+	/**
+	 * _premium_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _premium_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			array($this, 'registration_options_meta_box'),
+			$this->page_slug,
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * override caf metabox
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = array(
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
+		);
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
+			'EVT_default_registration_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * wp_list_table_mods for caf
+	 * ============================
+	 */
+	/**
+	 * hook into list table filters and provide filters for caffeinated list table
+	 *
+	 * @param  array $old_filters    any existing filters present
+	 * @param  array $list_table_obj the list table object
+	 * @return array                  new filters
+	 */
+	public function list_table_filters($old_filters, $list_table_obj)
+	{
+		$filters = array();
+		// first month/year filters
+		$filters[] = $this->espresso_event_months_dropdown();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// active status dropdown
+		if ($status !== 'draft') {
+			$filters[] = $this->active_status_dropdown(
+				isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
+			);
+		}
+		// category filter
+		$filters[] = $this->category_dropdown();
+		return array_merge($old_filters, $filters);
+	}
+
+
+	/**
+	 * espresso_event_months_dropdown
+	 *
+	 * @access public
+	 * @return string                dropdown listing month/year selections for events.
+	 */
+	public function espresso_event_months_dropdown()
+	{
+		// what we need to do is get all PRIMARY datetimes for all events to filter on.
+		// Note we need to include any other filters that are set!
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT']
+			: null;
+		// active status?
+		$active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
+		$cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
+		return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
+	}
+
+
+	/**
+	 * returns a list of "active" statuses on the event
+	 *
+	 * @param  string $current_value whatever the current active status is
+	 * @return string
+	 */
+	public function active_status_dropdown($current_value = '')
+	{
+		$select_name = 'active_status';
+		$values = array(
+			'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
+			'active'   => esc_html__('Active', 'event_espresso'),
+			'upcoming' => esc_html__('Upcoming', 'event_espresso'),
+			'expired'  => esc_html__('Expired', 'event_espresso'),
+			'inactive' => esc_html__('Inactive', 'event_espresso'),
+		);
+		$id = 'id="espresso-active-status-dropdown-filter"';
+		$class = 'wide';
+		return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
+	}
+
+
+	/**
+	 * output a dropdown of the categories for the category filter on the event admin list table
+	 *
+	 * @access  public
+	 * @return string html
+	 */
+	public function category_dropdown()
+	{
+		$cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
+		return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
+	}
+
+
+	/**
+	 * get total number of events today
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_today()
+	{
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 * get total number of events this month
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_this_month()
+	{
+		// Dates
+		$this_year_r = date('Y');
+		$this_month_r = date('m');
+		$days_this_month = date('t');
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-01 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/** DEFAULT TICKETS STUFF **/
+
+	/**
+	 * Output default tickets list table view.
+	 */
+	public function _tickets_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $trashed
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
+	{
+		$orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
+		$order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
+		switch ($orderby) {
+			case 'TKT_name':
+				$orderby = array('TKT_name' => $order);
+				break;
+			case 'TKT_price':
+				$orderby = array('TKT_price' => $order);
+				break;
+			case 'TKT_uses':
+				$orderby = array('TKT_uses' => $order);
+				break;
+			case 'TKT_min':
+				$orderby = array('TKT_min' => $order);
+				break;
+			case 'TKT_max':
+				$orderby = array('TKT_max' => $order);
+				break;
+			case 'TKT_qty':
+				$orderby = array('TKT_qty' => $order);
+				break;
+		}
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where = array(
+			'TKT_is_default' => 1,
+			'TKT_deleted'    => $trashed,
+		);
+		$offset = ($current_page - 1) * $per_page;
+		$limit = array($offset, $per_page);
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'TKT_name'        => array('LIKE', $sstr),
+				'TKT_description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$_where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+			'group_by' => 'TKT_ID',
+		);
+		if ($count) {
+			return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
+		} else {
+			return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_ticket($trash = false)
+	{
+		$success = 1;
+		$TKT = EEM_Ticket::instance();
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				if ($trash) {
+					if (! $TKT->delete_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				} else {
+					if (! $TKT->restore_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if ($trash) {
+				if (! $TKT->delete_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			} else {
+				if (! $TKT->restore_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		}
+		$action_desc = $trash ? 'moved to the trash' : 'restored';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => $trash ? '' : 'trashed',
+		);
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * Handles trashing default ticket.
+	 */
+	protected function _delete_ticket()
+	{
+		$success = 1;
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				// delete
+				if (! $this->_delete_the_ticket($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if (! $this->_delete_the_ticket($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = 'deleted';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => 'trashed',
+		);
+		// fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
+		if (EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		)
+		) {
+			$query_args = array();
+		}
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param int $TKT_ID
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	protected function _delete_the_ticket($TKT_ID)
+	{
+		$tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
+		$tkt->_remove_relations('Datetime');
+		// delete all related prices first
+		$tkt->delete_related_permanently('Price');
+		return $tkt->delete_permanently();
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -24,10 +24,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+        if ( ! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'events/templates/');
+            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'events/assets/');
+            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'events/assets/');
         }
     }
 
@@ -37,7 +37,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'events';
         // is there a evt_id in the request?
         $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
             ? $this->_req_data['EVT_ID']
@@ -243,7 +243,7 @@ 
          * check whether count of tickets is approaching the potential
          * limits for the server.
          */
-        if (! empty($data['input_count'])) {
+        if ( ! empty($data['input_count'])) {
             $response['max_input_vars_check'] = EE_Registry::instance()->CFG->environment->max_input_vars_limit_check(
                 $data['input_count']
             );
@@ -272,7 +272,7 @@ 
     {
         $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
         // make sure this is only when editing
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $href = EE_Admin_Page::add_query_args_and_nonce(
                 array('action' => 'duplicate_event', 'EVT_ID' => $id),
                 $this->_admin_base_url
@@ -324,7 +324,7 @@ 
     {
         wp_register_script(
             'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+            EVENTS_CAF_ASSETS_URL.'event-editor-heartbeat.js',
             array('ee_admin_js', 'heartbeat'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -348,7 +348,7 @@ 
     public function add_additional_datetime_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_add_additional_time.template.php',
             $template_args,
             true
         );
@@ -366,7 +366,7 @@ 
     public function add_datetime_clone_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_metabox_clone_button.template.php',
             $template_args,
             true
         );
@@ -384,7 +384,7 @@ 
     public function datetime_timezones_template($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_timezones.template.php',
             $template_args,
             true
         );
@@ -503,7 +503,7 @@ 
     {
         // first make sure the ID for the event is in the request.
         //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        if (! isset($this->_req_data['EVT_ID'])) {
+        if ( ! isset($this->_req_data['EVT_ID'])) {
             EE_Error::add_error(
                 esc_html__(
                     'In order to duplicate an event an Event ID is required.  None was given.',
@@ -518,7 +518,7 @@ 
         }
         // k we've got EVT_ID so let's use that to get the event we'll duplicate
         $orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
-        if (! $orig_event instanceof EE_Event) {
+        if ( ! $orig_event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
@@ -534,7 +534,7 @@ 
         $orig_ven = $orig_event->get_many_related('Venue');
         // reset the ID and modify other details to make it clear this is a dupe
         $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+        $new_name = $new_event->name().' '.esc_html__('**DUPLICATE**', 'event_espresso');
         $new_event->set('EVT_name', $new_name);
         $new_event->set(
             'EVT_slug',
@@ -563,7 +563,7 @@ 
             'Question_Group',
             array(array('Event_Question_Group.EQG_primary' => 1))
         );
-        if (! empty($orig_primary_qgs)) {
+        if ( ! empty($orig_primary_qgs)) {
             foreach ($orig_primary_qgs as $id => $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
@@ -575,7 +575,7 @@ 
             'Question_Group',
             array(array('Event_Question_Group.EQG_primary' => 0))
         );
-        if (! empty($orig_additional_qgs)) {
+        if ( ! empty($orig_additional_qgs)) {
             foreach ($orig_additional_qgs as $id => $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
@@ -588,7 +588,7 @@ 
         // k now that we have the new event saved we can loop through the datetimes and start adding relations.
         $cloned_tickets = array();
         foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
+            if ( ! $orig_dtt instanceof EE_Datetime) {
                 continue;
             }
             $new_dtt = clone $orig_dtt;
@@ -603,7 +603,7 @@ 
             // now let's get the ticket relations setup.
             foreach ((array) $orig_tkts as $orig_tkt) {
                 // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_tkt instanceof EE_Ticket) {
+                if ( ! $orig_tkt instanceof EE_Ticket) {
                     continue;
                 }
                 // is this ticket archived?  If it is then let's skip
@@ -612,8 +612,8 @@ 
                 }
                 // does this original ticket already exist in the clone_tickets cache?
                 //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
-                    $new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
+                if (isset($cloned_tickets[$orig_tkt->ID()])) {
+                    $new_tkt = $cloned_tickets[$orig_tkt->ID()];
                 } else {
                     $new_tkt = clone $orig_tkt;
                     // get relations on the $orig_tkt that we need to setup.
@@ -646,7 +646,7 @@ 
                 // for use with later datetimes that have the same ticket.
                 $new_dtt->_add_relation_to($new_tkt, 'Ticket');
                 $new_dtt->save();
-                $cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
+                $cloned_tickets[$orig_tkt->ID()] = $new_tkt;
             }
         }
         // clone taxonomy information
@@ -729,7 +729,7 @@ 
             $this->_admin_base_url
         );
         $content = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'import_page.template.php',
             $this->_template_args,
             true
         );
@@ -746,7 +746,7 @@ 
      */
     protected function _import_events()
     {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         $success = EE_Import::instance()->import();
         $this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
     }
@@ -775,8 +775,8 @@ 
             'EVT_ID' => $event_ids,
         );
         $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export();
         }
@@ -797,8 +797,8 @@ 
             'category_ids' => $this->_req_data['EVT_CAT_ID'],
         );
         $this->_req_data = array_merge($this->_req_data, $new_request_args);
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export();
         }
@@ -836,7 +836,7 @@ 
         $this->_set_add_edit_form_tags('update_template_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'template_settings.template.php',
             $this->_template_args,
             true
         );
@@ -963,7 +963,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1067,13 +1067,13 @@ 
     {
         $start = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
+            date('Y-m-d').' 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
         $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
+            date('Y-m-d').' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
@@ -1100,13 +1100,13 @@ 
         $days_this_month = date('t');
         $start = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
+            $this_year_r.'-'.$this_month_r.'-01 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
         $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+            $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
@@ -1173,7 +1173,7 @@ 
         $offset = ($current_page - 1) * $per_page;
         $limit = array($offset, $per_page);
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $_where['OR'] = array(
                 'TKT_name'        => array('LIKE', $sstr),
                 'TKT_description' => array('LIKE', $sstr),
@@ -1202,17 +1202,17 @@ 
         $success = 1;
         $TKT = EEM_Ticket::instance();
         // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element then success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru the boxes
             while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
                 if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
+                    if ( ! $TKT->delete_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
+                    if ( ! $TKT->restore_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 }
@@ -1221,11 +1221,11 @@ 
             // grab single id and trash
             $TKT_ID = absint($this->_req_data['TKT_ID']);
             if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
+                if ( ! $TKT->delete_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
+                if ( ! $TKT->restore_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             }
@@ -1246,20 +1246,20 @@ 
     {
         $success = 1;
         // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element then success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru the boxes
             while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
                 // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
+                if ( ! $this->_delete_the_ticket($TKT_ID)) {
                     $success = 0;
                 }
             }
         } else {
             // grab single id and trash
             $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if (! $this->_delete_the_ticket($TKT_ID)) {
+            if ( ! $this->_delete_the_ticket($TKT_ID)) {
                 $success = 0;
             }
         }

core/admin/EE_Admin_Page_Loader.core.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 
 use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice;
-use EventEspresso\core\exceptions\InvalidDataTypeException;
 
 /**
  * Event Espresso

Indentation +674 added lines, -674 removed lines

@@ -24,678 +24,678 @@
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        // load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        // define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-
-        // let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        // set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        // set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[ $group->menu_slug ] = $group;
-        }
-        return $groups;
-    }
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n"
-                           . sprintf(
-                               __(
-                                   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                                   'event_espresso'
-                               ),
-                               EE_ADMIN_PAGES
-                           );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-                ) {
-                    unset($installed_refs[ $page ]);
-                    continue;
-                }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
-                // flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
-                            return $caf_path;
-                        }
-                    );
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
-                            return $caf_admin_page;
-                        }
-                    );
-                    $extend = true;
-                }
-                // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
-                $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />'
-                               . sprintf(
-                                   esc_html__(
-                                       'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                       'event_espresso'
-                                   ),
-                                   '<strong>' . $class_name . '</strong>'
-                               );
-            $error_msg[] = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[] = $error_msg[0]
-                           . "\r\n"
-                           . sprintf(
-                               esc_html__(
-                                   'There is no Init class in place for the %s admin page.',
-                                   'event_espresso'
-                               ),
-                               $page
-                           )
-                           . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        // prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        // rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                    new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                // use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        // let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            // sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
-            // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
-        }
-        // now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
-            }
-        }/**/
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                }
-            }
-        }
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    // now let's make sure there is a file that matches the expected format
-                    $filename = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
-                        array('\\', '/'),
-                        DS,
-                        EE_CORE_CAF_ADMIN
-                        . 'extend'
-                        . DS
-                        . $extend_ref
-                        . DS
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                }
-            }
-        }
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		// load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		// define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+
+		// let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		// set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		// set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		// first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[ $group->menu_slug ] = $group;
+		}
+		return $groups;
+	}
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n"
+						   . sprintf(
+							   __(
+								   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+								   'event_espresso'
+							   ),
+							   EE_ADMIN_PAGES
+						   );
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				// skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+				) {
+					unset($installed_refs[ $page ]);
+					continue;
+				}
+				$menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
+				$this->_menu_slugs[ $menu_slug ] = $page;
+				// flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				// now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[ $page ])) {
+					$this->_current_caf_extend_slug = $page;
+					$admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
+					$caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
+					$caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
+						function ($path_to_file) use ($caf_path) {
+							return $caf_path;
+						}
+					);
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
+						function ($admin_page) use ($caf_admin_page) {
+							return $caf_admin_page;
+						}
+					);
+					$extend = true;
+				}
+				// let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+				$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[ $page ]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[ $page_slug ])) {
+			return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />'
+							   . sprintf(
+								   esc_html__(
+									   'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+									   'event_espresso'
+								   ),
+								   '<strong>' . $class_name . '</strong>'
+							   );
+			$error_msg[] = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[] = $error_msg[0]
+						   . "\r\n"
+						   . sprintf(
+							   esc_html__(
+								   'There is no Init class in place for the %s admin page.',
+								   'event_espresso'
+							   ),
+							   $page
+						   )
+						   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		// prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		// rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				// if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					new PersistentAdminNotice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				// if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				// use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				// assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[ $page_map->menu_group ][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		// let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			// valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			// sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			// prepend header
+			array_unshift($menu_maps, $menu_groups[ $group ]);
+			// reset $pages_array with prepped data
+			$pages_array[ $group ] = $menu_maps;
+		}
+		// now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[ $group ])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+			}
+		}/**/
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+				}
+			}
+		}
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					// now let's make sure there is a file that matches the expected format
+					$filename = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+						array('\\', '/'),
+						DS,
+						EE_CORE_CAF_ADMIN
+						. 'extend'
+						. DS
+						. $extend_ref
+						. DS
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+				}
+			}
+		}
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -120,13 +120,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -237,7 +237,7 @@ 
         // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -248,7 +248,7 @@ 
                     )
                 );
             }
-            $groups[ $group->menu_slug ] = $group;
+            $groups[$group->menu_slug] = $group;
         }
         return $groups;
     }
@@ -267,13 +267,13 @@ 
         $installed_refs = array();
         $exclude = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                 }
             }
         }
@@ -282,7 +282,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n"
+            $error_msg[] = $error_msg[0]."\r\n"
                            . sprintf(
                                __(
                                    'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
@@ -309,46 +309,46 @@ 
             // set autoloaders for our admin page classes based on included path information
             EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
             // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
                 if (empty($maintenance_mode_parent)
                     && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
                 ) {
-                    unset($installed_refs[ $page ]);
+                    unset($installed_refs[$page]);
                     continue;
                 }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
+                $menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
+                $this->_menu_slugs[$menu_slug] = $page;
                 // flag for register hooks on extended pages b/c extended pages use the default INIT.
                 $extend = false;
                 // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
+                if (isset($this->_caffeinated_extends[$page])) {
                     $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+                    $admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
+                    $caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
+                    $caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
+                        function($path_to_file) use ($caf_path) {
                             return $caf_path;
                         }
                     );
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
+                        function($admin_page) use ($caf_admin_page) {
                             return $caf_admin_page;
                         }
                     );
                     $extend = true;
                 }
                 // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
                 $hooks_ref = array_merge($hooks_ref, $extended_hooks);
             }
         }
@@ -364,8 +364,8 @@ 
         $ee_menu_slugs = $this->_menu_slugs;
         // we need to loop again to run any early code
         foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                $this->_installed_pages[$page]->do_initial_loads();
             }
         }
         do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
@@ -380,8 +380,8 @@ 
      */
     public function get_admin_page_object($page_slug = '')
     {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+        if (isset($this->_installed_pages[$page_slug])) {
+            return $this->_installed_pages[$page_slug]->loaded_page_object();
         }
         return null;
     }
@@ -397,7 +397,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -411,7 +411,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -428,14 +428,14 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $inner_error_msg = '<br />'
                                . sprintf(
                                    esc_html__(
                                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                                        'event_espresso'
                                    ),
-                                   '<strong>' . $class_name . '</strong>'
+                                   '<strong>'.$class_name.'</strong>'
                                );
             $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
@@ -515,7 +515,7 @@ 
                 // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                     new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -527,7 +527,7 @@ 
                     continue;
                 }
                 // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -546,7 +546,7 @@ 
                     continue;
                 }
                 // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
+                $pages_array[$page_map->menu_group][] = $page_map;
             }
         }
         if (empty($pages_array)) {
@@ -555,20 +555,20 @@ 
         // let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             // sort pages.
             usort($menu_maps, array($this, '_sort_menu_maps'));
             // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
+            array_unshift($menu_maps, $menu_groups[$group]);
             // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
+            $pages_array[$group] = $menu_maps;
         }
         // now let's setup the _prepped_menu_maps property
         foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+            if (isset($pages_array[$group])) {
+                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
             }
         }/**/
     }
@@ -596,26 +596,26 @@ 
     {
 
         // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated'.DS.'admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
                 }
             }
         }
         // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
@@ -632,8 +632,8 @@ 
                             )
                         )
                     );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+                    $filename = 'Extend_'.$filename.'_Admin_Page';
+                    $this->_caffeinated_extends[$extend_ref]['path'] = str_replace(
                         array('\\', '/'),
                         DS,
                         EE_CORE_CAF_ADMIN
@@ -644,7 +644,7 @@ 
                         . $filename
                         . '.core.php'
                     );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
                 }
@@ -652,12 +652,12 @@ 
         }
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a = new ReflectionClass($classname);

core/admin/EE_Admin_Page_Menu_Map.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
      *
      * @param  array $menu_args           An array of arguments used to setup the menu
      *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
+     * @param  string[] $required            An array of keys that should be in the $menu_args, this
      *                                    is used to validate that the items that should be defined
      *                                    are present.
      * @return void

Indentation +357 added lines, -357 removed lines

@@ -11,257 +11,257 @@ 
 {
 
 
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    public $title;
-
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_label;
-
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $parent_slug;
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $capability = 'administrator';
-
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_slug;
-
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_callback;
-
-
-    /**
-     * The EE_Admin_Page_Init attached to this map.
-     *
-     * @var EE_Admin_Page_Init
-     */
-    public $admin_init_page;
-
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_group;
-
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $menu_order;
-
-
-    const NONE = 0;
-    const BLOG_ADMIN_ONLY = 1;
-    const BLOG_AND_NETWORK_ADMIN = 2;
-    const NETWORK_ADMIN_ONLY = 3;
-
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $show_on_menu = self::BLOG_ADMIN_ONLY;
-
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::level_2_complete_maintenance is active.
-     *
-     * @var bool
-     */
-    public $maintenance_mode_parent = '';
-
-
-    /**
-     * Constructor.
-     *
-     * @since 4.4.0
-     *
-     * @param  array $menu_args           An array of arguments used to setup the menu
-     *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
-     *                                    is used to validate that the items that should be defined
-     *                                    are present.
-     * @return void
-     */
-    public function __construct($menu_args, $required)
-    {
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff((array) $required, array_keys((array) $menu_args));
-
-        if (! empty($missing)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%s is missing some expected keys in the argument array.  The following keys are missing: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        // made it here okay, so let's set the properties!
-        foreach ($menu_args as $prop => $value) {
-            switch ($prop) {
-                case 'show_on_menu':
-                    $value = (int) $value;
-                    break;
-                case 'admin_init_page':
-                    if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
-                        throw new EE_Error(
-                            sprintf(
-                                __(
-                                    'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                                    'event_espresso'
-                                ),
-                                print_r($value, true)
-                            )
-                        );
-                    }
-                    break;
-                case 'menu_callback':
-                    break;
-
-                default:
-                    $value = (string) $value;
-                    break;
-            }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        $prop
-                    )
-                );
-            }
-            $this->{$prop} = $value;
-        }
-
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-
-        // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
-            && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            $this->parent_slug = $this->maintenance_mode_parent;
-        }
-
-        // if empty menu_callback let's set default (but only if we have admin page init object)
-        if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            $this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
-        }
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @since  4.4.0
-     * @return string wp_page_slug.
-     */
-    abstract protected function _add_menu_page();
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function add_menu_page($network_admin = false)
-    {
-
-        $show_on_menu_int = (int) $this->show_on_menu;
-        if (($network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
-                 true
-             ))
-            ||
-            (! $network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
-                 true
-             ))) {
-            $wp_page_slug = $this->_add_menu_page();
-        } else {
-            $wp_page_slug = '';
-        }
-
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            try {
-                $this->admin_init_page->set_page_dependencies($wp_page_slug);
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-    }
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	public $title;
+
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_label;
+
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $parent_slug;
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $capability = 'administrator';
+
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_slug;
+
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_callback;
+
+
+	/**
+	 * The EE_Admin_Page_Init attached to this map.
+	 *
+	 * @var EE_Admin_Page_Init
+	 */
+	public $admin_init_page;
+
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_group;
+
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $menu_order;
+
+
+	const NONE = 0;
+	const BLOG_ADMIN_ONLY = 1;
+	const BLOG_AND_NETWORK_ADMIN = 2;
+	const NETWORK_ADMIN_ONLY = 3;
+
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $show_on_menu = self::BLOG_ADMIN_ONLY;
+
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::level_2_complete_maintenance is active.
+	 *
+	 * @var bool
+	 */
+	public $maintenance_mode_parent = '';
+
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @param  array $menu_args           An array of arguments used to setup the menu
+	 *                                    properties on construct.
+	 * @param  array $required            An array of keys that should be in the $menu_args, this
+	 *                                    is used to validate that the items that should be defined
+	 *                                    are present.
+	 * @return void
+	 */
+	public function __construct($menu_args, $required)
+	{
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff((array) $required, array_keys((array) $menu_args));
+
+		if (! empty($missing)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%s is missing some expected keys in the argument array.  The following keys are missing: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		// made it here okay, so let's set the properties!
+		foreach ($menu_args as $prop => $value) {
+			switch ($prop) {
+				case 'show_on_menu':
+					$value = (int) $value;
+					break;
+				case 'admin_init_page':
+					if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
+						throw new EE_Error(
+							sprintf(
+								__(
+									'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+									'event_espresso'
+								),
+								print_r($value, true)
+							)
+						);
+					}
+					break;
+				case 'menu_callback':
+					break;
+
+				default:
+					$value = (string) $value;
+					break;
+			}
+			if (! EEH_Class_Tools::has_property($this, $prop)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
+							'event_espresso'
+						),
+						get_class($this),
+						$prop
+					)
+				);
+			}
+			$this->{$prop} = $value;
+		}
+
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+
+		// Might need to change parent slug depending on maintenance mode.
+		if (! empty($this->maintenance_mode_parent)
+			&& EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			$this->parent_slug = $this->maintenance_mode_parent;
+		}
+
+		// if empty menu_callback let's set default (but only if we have admin page init object)
+		if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			$this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
+		}
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @since  4.4.0
+	 * @return string wp_page_slug.
+	 */
+	abstract protected function _add_menu_page();
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function add_menu_page($network_admin = false)
+	{
+
+		$show_on_menu_int = (int) $this->show_on_menu;
+		if (($network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
+				 true
+			 ))
+			||
+			(! $network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
+				 true
+			 ))) {
+			$wp_page_slug = $this->_add_menu_page();
+		} else {
+			$wp_page_slug = '';
+		}
+
+		if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			try {
+				$this->admin_init_page->set_page_dependencies($wp_page_slug);
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+	}
 }
 
 
@@ -275,75 +275,75 @@ 
 class EE_Admin_Page_Main_Menu extends EE_Admin_Page_Menu_Map
 {
 
-    /**
-     * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     *
-     * @var string
-     */
-    public $subtitle;
-
-    /**
-     * The page to a icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    public $icon_url;
-
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    public $position;
-
-
-    public function __construct($menu_args)
-    {
-        $required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
-
-        parent::__construct($menu_args, $required);
-
-        $this->position = ! empty($this->position) ? (int) $this->position : $this->position;
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function _add_menu_page()
-    {
-        $main = add_menu_page(
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->parent_slug,
-            $this->menu_callback,
-            $this->icon_url,
-            $this->position
-        );
-        if (! empty($this->subtitle)) {
-            add_submenu_page(
-                $this->parent_slug,
-                $this->subtitle,
-                $this->subtitle,
-                $this->capability,
-                $this->menu_slug,
-                $this->menu_callback
-            );
-        }
-        return $main;
-    }
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @var string
+	 */
+	public $subtitle;
+
+	/**
+	 * The page to a icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	public $icon_url;
+
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	public $position;
+
+
+	public function __construct($menu_args)
+	{
+		$required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
+
+		parent::__construct($menu_args, $required);
+
+		$this->position = ! empty($this->position) ? (int) $this->position : $this->position;
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function _add_menu_page()
+	{
+		$main = add_menu_page(
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->parent_slug,
+			$this->menu_callback,
+			$this->icon_url,
+			$this->position
+		);
+		if (! empty($this->subtitle)) {
+			add_submenu_page(
+				$this->parent_slug,
+				$this->subtitle,
+				$this->subtitle,
+				$this->capability,
+				$this->menu_slug,
+				$this->menu_callback
+			);
+		}
+		return $main;
+	}
 } //end EE_Admin_Page_Main_Menu
 
 
@@ -357,23 +357,23 @@ 
 class EE_Admin_Page_Sub_Menu extends EE_Admin_Page_Main_Menu
 {
 
-    public function __construct($menu_args)
-    {
-        parent::__construct($menu_args);
-    }
-
-
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->menu_slug,
-            $this->menu_callback
-        );
-    }
+	public function __construct($menu_args)
+	{
+		parent::__construct($menu_args);
+	}
+
+
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->menu_slug,
+			$this->menu_callback
+		);
+	}
 }
 
 
@@ -392,28 +392,28 @@ 
 {
 
 
-    public function __construct($menu_args = array())
-    {
-        $required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
-        parent::__construct($menu_args, $required);
-    }
+	public function __construct($menu_args = array())
+	{
+		$required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
+		parent::__construct($menu_args, $required);
+	}
 
 
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->menu_label,
-            $this->_group_link(),
-            $this->capability,
-            $this->menu_slug,
-            '__return_false'
-        );
-    }
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->menu_label,
+			$this->_group_link(),
+			$this->capability,
+			$this->menu_slug,
+			'__return_false'
+		);
+	}
 
 
-    private function _group_link()
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
-    }
+	private function _group_link()
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -143,7 +143,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -182,7 +182,7 @@ 
                     $value = (string) $value;
                     break;
             }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
+            if ( ! EEH_Class_Tools::has_property($this, $prop)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -199,10 +199,10 @@ 
 
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
 
         // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
+        if ( ! empty($this->maintenance_mode_parent)
             && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
         ) {
             $this->parent_slug = $this->maintenance_mode_parent;
@@ -243,7 +243,7 @@ 
                  true
              ))
             ||
-            (! $network_admin
+            ( ! $network_admin
              && in_array(
                  $show_on_menu_int,
                  array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
@@ -254,7 +254,7 @@ 
             $wp_page_slug = '';
         }
 
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+        if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
             try {
                 $this->admin_init_page->set_page_dependencies($wp_page_slug);
             } catch (EE_Error $e) {
@@ -332,7 +332,7 @@ 
             $this->icon_url,
             $this->position
         );
-        if (! empty($this->subtitle)) {
+        if ( ! empty($this->subtitle)) {
             add_submenu_page(
                 $this->parent_slug,
                 $this->subtitle,
@@ -414,6 +414,6 @@ 
 
     private function _group_link()
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menu_label.'</span>';
     }
 }

core/admin/EE_Help_Tour.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
      *
      * @access public
      * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
+     * @return EE_Help_Tour
      */
     public function __construct($caf = false)
     {

Indentation +264 added lines, -264 removed lines

@@ -15,268 +15,268 @@
 abstract class EE_Help_Tour extends EE_Base
 {
 
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = __('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => __('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            'cookieDomain'          => false,
-            // set to false or yoursite.com
-            // 'tipContainer' => 'body',            // Where the tip be attached if not inline
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = __('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => __('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			'cookieDomain'          => false,
+			// set to false or yoursite.com
+			// 'tipContainer' => 'body',            // Where the tip be attached if not inline
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

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

Doc Comments -1 removed lines

@@ -62,7 +62,6 @@
     /**
      * Creates a 4.1 price base type
      * @global type $wpdb
-     * @param array $old_price
      * @param int $new_reg_id
      * @return int
      */

Indentation +75 added lines, -75 removed lines

@@ -32,81 +32,81 @@
 
 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";
-        $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);
+	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";
+		$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 +5 added lines, -5 removed lines

@@ -50,7 +50,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;
         }
@@ -84,12 +84,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

Doc Comments +6 added lines, -2 removed lines

@@ -579,8 +579,8 @@ 
      * 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
+     * @param string $STS_ID
+     * @param integer $quantity_sold
      * @return boolean whether they were successfully updated or not
      */
     protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
@@ -777,6 +777,10 @@ 
         }
         return $count;
     }
+
+    /**
+     * @param integer $new_txn_id
+     */
     private function _insert_new_payment($old_attendee, $new_txn_id)
     {
         global $wpdb;

Indentation +598 added lines, -601 removed lines

@@ -84,9 +84,6 @@ 
   KEY `submitted` (`submitted`),
   KEY `likes` (`likes`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8$$
-
-
-
  * 4.1 Attendee tables and fields:
  * $this->_tables = array(
             'Attendee_CPT'=> new EE_Primary_Table('posts', 'ID'),
@@ -216,632 +213,632 @@ 
  */
 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->_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();
-    }
+	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->_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 +104 added lines, -104 removed lines

@@ -260,9 +260,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;
             }
@@ -274,7 +274,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;
         }
@@ -308,31 +308,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;
         }
@@ -370,20 +370,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;
         }
@@ -408,12 +408,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;
             }
@@ -421,7 +421,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',
@@ -432,7 +432,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']),
@@ -441,14 +441,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;
             }
@@ -508,12 +508,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));
         }
@@ -544,23 +544,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;
             }
@@ -592,11 +592,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 {
@@ -628,10 +628,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
@@ -641,7 +641,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;
     }
 
@@ -663,8 +663,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");
@@ -677,10 +677,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;
@@ -688,21 +688,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;
@@ -714,8 +714,8 @@ 
                     'TKT_ID' => $ticket_id
                 ),
             array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
+                    '%d', // DTT_ID
+                    '%d', // TKT_ID
                 )
         );
         // insert new price
@@ -728,10 +728,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;
@@ -743,8 +743,8 @@ 
                     'PRC_ID' => $price_id
                 ),
             array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
+                    '%d', // TKT_ID
+                    '%d', // PRC_ID
                 )
         );
         return $ticket_id;
@@ -781,7 +781,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(
@@ -791,7 +791,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,
@@ -806,19 +806,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;
             }
@@ -837,7 +837,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_checkins.dmsstage.php

Doc Comments +2 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
      * (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
+     * @param array $old_attendee
      * @return array row of datetime from DB
      */
     private function _try_to_find_datetime($old_attendee)
@@ -121,8 +121,7 @@ 
     /**
      * 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
+     * @param int $new_datetime
      * @return int new Check-in id
      */
     private function _insert_checkin_record($new_reg_id, $new_datetime)

Indentation +115 added lines, -115 removed lines

@@ -26,129 +26,129 @@
 
 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->_new_table = $wpdb->prefix."esp_checkin";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        global $wpdb;
-        $new_reg_table = $wpdb->prefix."esp_registration";
+	private $_new_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Checkins", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$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 +16 added lines, -16 removed lines

@@ -40,10 +40,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);
@@ -51,9 +51,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),
@@ -64,14 +64,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) {
@@ -93,7 +93,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;
         }
@@ -105,8 +105,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;
@@ -114,7 +114,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;
     }
 
@@ -138,13 +138,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_event_question_group.dmsstage.php

Doc Comments +3 added lines

@@ -98,6 +98,9 @@
         $this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
     }
 
+    /**
+     * @param boolean $primary
+     */
     private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
     {
         global $wpdb;

Indentation +74 added lines, -76 removed lines

@@ -16,15 +16,13 @@ 
             'EQG_primary'=>new EE_Boolean_Field('EQG_primary', __('Flag indicating question is only for primary attendees','event_espresso'), false, false)
         )
     );
-
-
  *
  */
 class EE_DMS_4_1_0_event_question_group extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_table;
-    public function _migrate_old_row($old_row)
-    {
+	private $_new_table;
+	public function _migrate_old_row($old_row)
+	{
 //      $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)));
@@ -34,8 +32,8 @@ 
 //          $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);
 
-            $this->_insert_new_event_question_groups($old_row);
-    }
+			$this->_insert_new_event_question_groups($old_row);
+	}
 //  function _migration_step($num_items=50){
 //      global $wpdb;
 //      $start_at_record = $this->count_records_migrated();
@@ -55,78 +53,78 @@ 
 //      $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
 //      return $count;
 //  }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_detail";
-        $this->_new_table = $wpdb->prefix."esp_event_question_group";
-        $this->_pretty_name = __("Question Groups in each Event", "event_espresso");
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_detail";
+		$this->_new_table = $wpdb->prefix."esp_event_question_group";
+		$this->_pretty_name = __("Question Groups in each Event", "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
-     * @return void
-     */
-    private function _insert_new_event_question_groups($old_event)
-    {
-        $new_event_question_group_ids = array();
-        $question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
-        if (is_array($question_groups_for_primary)) {
-            foreach ($question_groups_for_primary as $old_question_group_id) {
-                $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
-                if ($new_id) {
-                    $new_event_question_group_ids[] = $new_id;
-                }
-            }
-        }
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (isset($event_meta['add_attendee_question_groups'])) {
-            if (is_array($event_meta['add_attendee_question_groups'])) {
-                foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
-                    $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
-                    if ($new_id) {
-                        $new_event_question_group_ids[] = $new_id;
-                    }
-                }
-            }
-        }
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_event
+	 * @return void
+	 */
+	private function _insert_new_event_question_groups($old_event)
+	{
+		$new_event_question_group_ids = array();
+		$question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
+		if (is_array($question_groups_for_primary)) {
+			foreach ($question_groups_for_primary as $old_question_group_id) {
+				$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
+				if ($new_id) {
+					$new_event_question_group_ids[] = $new_id;
+				}
+			}
+		}
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (isset($event_meta['add_attendee_question_groups'])) {
+			if (is_array($event_meta['add_attendee_question_groups'])) {
+				foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
+					$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
+					if ($new_id) {
+						$new_event_question_group_ids[] = $new_id;
+					}
+				}
+			}
+		}
 
 
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
-    }
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
+	}
 
-    private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
-    {
-        global $wpdb;
-        $new_question_group_id =$this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", intval($old_question_group_id), $wpdb->prefix."esp_question_group");
+	private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
+	{
+		global $wpdb;
+		$new_question_group_id =$this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", intval($old_question_group_id), $wpdb->prefix."esp_question_group");
 
-        if (! $new_question_group_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"), $old_question_group_id, $old_event['id']));
-            return 0;
-        }
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", intval($old_event['id']), $wpdb->posts);
-        if (! $new_question_group_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 event 3.1 event id #%s", "event_espresso"), $old_event['id']));
-            return 0;
-        }
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'QSG_ID'=>$new_question_group_id,
-            'EQG_primary'=>$primary
-        );
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_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, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+		if (! $new_question_group_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"), $old_question_group_id, $old_event['id']));
+			return 0;
+		}
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", intval($old_event['id']), $wpdb->posts);
+		if (! $new_question_group_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 event 3.1 event id #%s", "event_espresso"), $old_event['id']));
+			return 0;
+		}
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'QSG_ID'=>$new_question_group_id,
+			'EQG_primary'=>$primary
+		);
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// QSG_ID
+			'%d',// EQG_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, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -101,14 +101,14 @@ 
     private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
     {
         global $wpdb;
-        $new_question_group_id =$this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", intval($old_question_group_id), $wpdb->prefix."esp_question_group");
+        $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", intval($old_question_group_id), $wpdb->prefix."esp_question_group");
 
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(sprintf(__("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"), $old_question_group_id, $old_event['id']));
             return 0;
         }
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", intval($old_event['id']), $wpdb->posts);
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(sprintf(__("Could not find 4.1 event 3.1 event id #%s", "event_espresso"), $old_event['id']));
             return 0;
         }
@@ -118,12 +118,12 @@ 
             'EQG_primary'=>$primary
         );
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_primary
+            '%d', // EVT_ID
+            '%d', // QSG_ID
+            '%d', // EQG_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, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }

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

Doc Comments +3 added lines, -3 removed lines

@@ -426,7 +426,7 @@ 
 
     /**
      * @param $old_event
-     * @param $new_cpt_id
+     * @param integer $new_cpt_id
      * @return int
      */
     private function _insert_event_meta($old_event, $new_cpt_id)
@@ -693,8 +693,8 @@ 
 
 
     /**
-     * @param $new_event_id
-     * @param $new_venue_id
+     * @param integer $new_event_id
+     * @param integer $new_venue_id
      * @return int
      */
     private function _insert_new_venue_to_event($new_event_id, $new_venue_id)

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);
-        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 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 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);
+		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 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 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 +131 added lines, -131 removed lines

@@ -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 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;
         }