eventespresso / event-espresso-core

core/db_classes/EE_Registration.class.php

Indentation +1685 added lines, -1685 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -15,1690 +15,1690 @@ 
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param        int $EVT_ID Event ID
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code' :
-                if (! empty($field_value) && $this->reg_code() === null) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID' :
-                $this->set_status($field_value, $use_default);
-                break;
-            default :
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string  $new_STS_ID
-     * @param boolean $use_default
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function set_status($new_STS_ID = null, $use_default = false)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if (
-            $old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->_reserve_registration_space();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
-                // OR FROM  approved
-            } else if ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->_release_registration_space();
-                do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-            $this->transaction()->update_status_based_on_total_paid(true);
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
-            return true;
-        }
-        //even though the old value matches the new value, it's still good to
-        //allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string $new_STS_ID
-     * @param string $old_STS_ID
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
-            return;
-        }
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
-        }
-    }
-
-
-    /**
-     *        get Status ID
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _reserve_registration_space()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket();
-        $ticket = $this->ticket();
-        $ticket->increase_sold();
-        $ticket->save();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = array();
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event()
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @since 4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        $event = $this->event();
-        if ($event instanceof EE_Event) {
-            return $event->wp_user();
-        }
-        return 0;
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _release_registration_space()
-    {
-        $ticket = $this->ticket();
-        $ticket->decrease_sold();
-        $ticket->save();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function reserve_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param        int $ATT_ID Attendee ID
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param        int $REG_count Primary Attendee
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                       Date
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @access    public
-     * @param    float $REG_paid
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param        boolean $REG_att_is_going Attendee Is Going
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function receipt_url($messenger = 'html')
-    {
-
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
-        }
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            if ($messenger == 'html') {
-                return $this->invoice_url('launch');
-            }
-            $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
-
-            $query_args = array('ee' => $route, 'id' => $this->reg_url_link());
-            if ($messenger == 'html') {
-                $query_args['html'] = true;
-            }
-            return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
-        }
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @access public
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_url_link()
-    {
-        return (string)$this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo $this->invoice_url($type);
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo $this->payment_overview_url();
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function payment_overview_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'attendee_information',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(array(
-            'page'    => 'espresso_registrations',
-            'action'  => 'view_registration',
-            '_REG_ID' => $this->ID(),
-        ), admin_url('admin.php'));
-    }
-
-
-    /**
-     *    is_primary_registrant?
-     */
-    public function is_primary_registrant()
-    {
-        return $this->get('REG_count') == 1 ? true : false;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        $primary_registrant = EEM_Registration::instance()->get_one(array(
-            array(
-                'TXN_ID'    => $this->transaction_ID(),
-                'REG_count' => 1,
-            ),
-        ));
-        return $primary_registrant;
-    }
-
-
-    /**
-     *        get  Attendee Number
-     *
-     * @access        public
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     *        get Group Size
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     *        get Registration Date
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return    float
-     */
-    public function final_price()
-    {
-        return $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return    float
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return    float
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment
-     * @return bool
-     */
-    public function owes_monies_and_can_pay($requires_payment = array())
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
-        if (
-            in_array($this->status_ID(), $requires_payment) &&
-            $this->final_price() != 0 &&
-            $this->final_price() != $this->paid()
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
-            false, 'sentence');
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Answer[]
-     */
-    public function answers($query_params = null)
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        $question_groups = array();
-        if ($this->event() instanceof EE_Event) {
-            $question_groups = $this->event()->question_groups(
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC'),
-                )
-            );
-        }
-        return $question_groups;
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     */
-    public function count_question_groups()
-    {
-        $qg_count = 0;
-        if ($this->event() instanceof EE_Event) {
-            $qg_count = $this->event()->count_related(
-                'Question_Group',
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                )
-            );
-        }
-        return $qg_count;
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Datetime_Ticket
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Datetime_Ticket
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return boolean
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        //first check registration status
-        if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
-            return false;
-        }
-        //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
-            array(
-                'TKT_ID' => $this->get('TKT_ID'),
-                'DTT_ID' => $DTT_ID,
-            ),
-        )))
-        ) {
-            return false;
-        }
-
-        //final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool   true means can checkin.  false means cannot checkin.
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
-        // or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        //does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        //go ahead and toggle.
-        if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
-            return true;
-        }
-
-        //made it here so the last check is whether the number of checkins per unique datetime on this registration
-        //disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
-            array(
-                'REG_ID' => $this->ID(),
-                'CHK_in' => true,
-            ),
-        ), 'DTT_ID', true);
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        $status_paths = array(
-            EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
-            EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
-            EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
-        );
-        //start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
-        $status_to  = $status_paths[$cur_status];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(array(
-            'REG_ID' => $this->ID(),
-            'DTT_ID' => $DTT_ID,
-            'CHK_in' => $new_status,
-        ));
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    __('Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = __('Registration check in update failed because of an unknown database error',
-                    'event_espresso');
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
-    public function get_latest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int       $DTT_ID  The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
-    public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
-    {
-        $checkin_query_params = array(
-            'order_by' => array('CHK_timestamp' => 'DESC'),
-        );
-
-        if ($DTT_ID > 0) {
-            $checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
-        }
-
-        //get checkin object (if exists)
-        $checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related('Checkin', $checkin_query_params);
-        if ($checkin instanceof EE_Checkin) {
-            if ($checkin->get('CHK_in')) {
-                return EE_Registration::checkin_status_in; //checked in
-            }
-            return EE_Registration::checkin_status_out; //had checked in but is now checked out.
-        }
-        return EE_Registration::checkin_status_never; //never been checked in
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                     then it is assumed Check-in for primary datetime was toggled.
-     * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
-     *                     message can be customized with the attendee name.
-     * @return string         internationalized message
-     */
-    public function get_checkin_msg($DTT_ID, $error = false)
-    {
-        //let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            //what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Registration::checkin_status_never :
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_in :
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_out :
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return __("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *        get Registration Code
-     */
-    public function reg_code()
-    {
-        return $this->get('REG_code');
-    }
-
-
-    /**
-     *        get Transaction ID
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                __('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @since 4.5.0
-     * @return EE_Registration[]  or empty array if this isn't a group registration.
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return array();
-        }
-
-        $query[0] = array(
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => array('!=', $this->ID()),
-            'TKT_ID' => $this->ticket_ID(),
-        );
-
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page' => 'espresso_registrations',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration[]
-     * @throws \EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        return $this->final_price();
-    }
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.7.0
-     * @return string
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'), '4.7.0');
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param        int $EVT_ID Event ID
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code' :
+				if (! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID' :
+				$this->set_status($field_value, $use_default);
+				break;
+			default :
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string  $new_STS_ID
+	 * @param boolean $use_default
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if (
+			$old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->_reserve_registration_space();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
+				// OR FROM  approved
+			} else if ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->_release_registration_space();
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+			$this->transaction()->update_status_based_on_total_paid(true);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
+			return true;
+		}
+		//even though the old value matches the new value, it's still good to
+		//allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string $new_STS_ID
+	 * @param string $old_STS_ID
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
+			return;
+		}
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
+		}
+	}
+
+
+	/**
+	 *        get Status ID
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _reserve_registration_space()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
+		$ticket = $this->ticket();
+		$ticket->increase_sold();
+		$ticket->save();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = array();
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event()
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof \EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		$event = $this->event();
+		if ($event instanceof EE_Event) {
+			return $event->wp_user();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _release_registration_space()
+	{
+		$ticket = $this->ticket();
+		$ticket->decrease_sold();
+		$ticket->save();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function reserve_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param        int $ATT_ID Attendee ID
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param        int $REG_count Primary Attendee
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                       Date
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @access    public
+	 * @param    float $REG_paid
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param        boolean $REG_att_is_going Attendee Is Going
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
+		}
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
+			}
+			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
+
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
+				$query_args['html'] = true;
+			}
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
+		}
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @access public
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_url_link()
+	{
+		return (string)$this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo $this->invoice_url($type);
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo $this->payment_overview_url();
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function payment_overview_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'attendee_information',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(array(
+			'page'    => 'espresso_registrations',
+			'action'  => 'view_registration',
+			'_REG_ID' => $this->ID(),
+		), admin_url('admin.php'));
+	}
+
+
+	/**
+	 *    is_primary_registrant?
+	 */
+	public function is_primary_registrant()
+	{
+		return $this->get('REG_count') == 1 ? true : false;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		$primary_registrant = EEM_Registration::instance()->get_one(array(
+			array(
+				'TXN_ID'    => $this->transaction_ID(),
+				'REG_count' => 1,
+			),
+		));
+		return $primary_registrant;
+	}
+
+
+	/**
+	 *        get  Attendee Number
+	 *
+	 * @access        public
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 *        get Group Size
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 *        get Registration Date
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return    float
+	 */
+	public function final_price()
+	{
+		return $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return    float
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return    float
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment
+	 * @return bool
+	 */
+	public function owes_monies_and_can_pay($requires_payment = array())
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		if (
+			in_array($this->status_ID(), $requires_payment) &&
+			$this->final_price() != 0 &&
+			$this->final_price() != $this->paid()
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
+			false, 'sentence');
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Answer[]
+	 */
+	public function answers($query_params = null)
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		$question_groups = array();
+		if ($this->event() instanceof EE_Event) {
+			$question_groups = $this->event()->question_groups(
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+					'order_by' => array('QSG_order' => 'ASC'),
+				)
+			);
+		}
+		return $question_groups;
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 */
+	public function count_question_groups()
+	{
+		$qg_count = 0;
+		if ($this->event() instanceof EE_Event) {
+			$qg_count = $this->event()->count_related(
+				'Question_Group',
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+				)
+			);
+		}
+		return $qg_count;
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Datetime_Ticket
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Datetime_Ticket
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return boolean
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		//first check registration status
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
+			return false;
+		}
+		//is there a datetime ticket that matches this dtt_ID?
+		if (! (EEM_Datetime_Ticket::instance()->exists(array(
+			array(
+				'TKT_ID' => $this->get('TKT_ID'),
+				'DTT_ID' => $DTT_ID,
+			),
+		)))
+		) {
+			return false;
+		}
+
+		//final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool   true means can checkin.  false means cannot checkin.
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
+		// or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		//go ahead and toggle.
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
+			return true;
+		}
+
+		//made it here so the last check is whether the number of checkins per unique datetime on this registration
+		//disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
+			array(
+				'REG_ID' => $this->ID(),
+				'CHK_in' => true,
+			),
+		), 'DTT_ID', true);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		$status_paths = array(
+			EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
+			EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
+			EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
+		);
+		//start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
+		$status_to  = $status_paths[$cur_status];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(array(
+			'REG_ID' => $this->ID(),
+			'DTT_ID' => $DTT_ID,
+			'CHK_in' => $new_status,
+		));
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					__('Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = __('Registration check in update failed because of an unknown database error',
+					'event_espresso');
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
+	public function get_latest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int       $DTT_ID  The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
+	{
+		$checkin_query_params = array(
+			'order_by' => array('CHK_timestamp' => 'DESC'),
+		);
+
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
+		}
+
+		//get checkin object (if exists)
+		$checkin = $checkin instanceof EE_Checkin
+			? $checkin
+			: $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
+				return EE_Registration::checkin_status_in; //checked in
+			}
+			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
+		}
+		return EE_Registration::checkin_status_never; //never been checked in
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                     then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                     message can be customized with the attendee name.
+	 * @return string         internationalized message
+	 */
+	public function get_checkin_msg($DTT_ID, $error = false)
+	{
+		//let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			//what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Registration::checkin_status_never :
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_in :
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_out :
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return __("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *        get Registration Code
+	 */
+	public function reg_code()
+	{
+		return $this->get('REG_code');
+	}
+
+
+	/**
+	 *        get Transaction ID
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @since 4.5.0
+	 * @return EE_Registration[]  or empty array if this isn't a group registration.
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return array();
+		}
+
+		$query[0] = array(
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => array('!=', $this->ID()),
+			'TKT_ID' => $this->ticket_ID(),
+		);
+
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page' => 'espresso_registrations',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration[]
+	 * @throws \EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.7.0
+	 * @return string
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'), '4.7.0');
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +675 added lines, -675 removed lines

@@ -16,7 +16,7 @@ 
 use WP_Post;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -33,683 +33,683 @@ 
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     *@var string $date_format
-     */
-    private $date_format;
-
-    /**
-     *@var string $time_format
-     */
-    private $time_format;
-
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     */
-    public function __construct()
-    {
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe( $iframe = true )
-    {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function setEvent( $event = null )
-    {
-        if ( $event === null ) {
-            global $post;
-            $event = $post;
-        }
-        if ( $event instanceof EE_Event ) {
-            $this->event = $event;
-        } else if ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
-                $this->event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso'
-                );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool         $view_details
-     * @return string
-     * @throws EE_Error
-     */
-    public function display( $event = null, $view_details = false )
-    {
-        // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
-        // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        if (EED_Events_Archive::is_iframe()){
-            $this->setIframe();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url();
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = ! is_admin()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string       $_event_active_status
-     * @param bool         $view_details
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return ! is_admin()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 *@var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 *@var string $time_format
+	 */
+	private $time_format;
+
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 */
+	public function __construct()
+	{
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe( $iframe = true )
+	{
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function setEvent( $event = null )
+	{
+		if ( $event === null ) {
+			global $post;
+			$event = $post;
+		}
+		if ( $event instanceof EE_Event ) {
+			$this->event = $event;
+		} else if ( $event instanceof WP_Post ) {
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+				$this->event = $event->EE_Event;
+			} else if ( $event->post_type === 'espresso_events' ) {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
+			$dev_msg = $user_msg . __(
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso'
+				);
+			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool         $view_details
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display( $event = null, $view_details = false )
+	{
+		// reset filter for displaying submit button
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+		// poke and prod incoming event till it tells us what it is
+		if ( ! $this->setEvent( $event ) ) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
+		if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		if ( $template_args[ 'event_is_expired' ] ) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		if (EED_Events_Archive::is_iframe()){
+			$this->setIframe();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url();
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets,$template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = ! is_admin()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string       $_event_active_status
+	 * @param bool         $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return ! is_admin()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws EE_Error
-     */
-    protected function getTickets()
-    {
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array  $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        //display notice to admin that registration is external
-        return is_admin()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen( $ID = 0, $external_url = '' )
-    {
-        // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                EED_Events_Archive::is_iframe()
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
-        return $html;
-    }
-
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ( ! is_admin()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } else if ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
-                } else if (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } else if (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if ( ! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-	    return apply_filters(
-		    'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-		    $html,
-		    $this->event
-	    );
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = $this->event->external_url();
-        $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayViewDetailsButton( $DWMTS = false )
-    {
-        if ( ! $this->event->get_permalink() ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            EED_Events_Archive::is_iframe()
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .='>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	protected function getTickets()
+	{
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array  $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		//display notice to admin that registration is external
+		return is_admin()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen( $ID = 0, $external_url = '' )
+	{
+		// if redirecting, we don't need any anything else
+		if ( $external_url ) {
+			$html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				EED_Events_Archive::is_iframe()
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = EEH_URL::get_query_string( $external_url );
+			foreach ( (array)$query_args as $query_arg => $value ) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url( $ID );
+		if ( ! $checkout_url ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+		return $html;
+	}
+
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ( ! is_admin()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} else if ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .=  $this->ticketSelectorEndDiv();
+				} else if (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} else if (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if ( ! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = $this->event->external_url();
+		$html = EEH_HTML::div(
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayViewDetailsButton( $DWMTS = false )
+	{
+		if ( ! $this->event->get_permalink() ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			EED_Events_Archive::is_iframe()
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .='>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}
 
 
 

admin_pages/events/Events_Admin_Page.core.php

Indentation +2687 added lines, -2687 removed lines

@@ -15,2694 +15,2694 @@
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * This will hold the event object for event_details screen.
-     *
-     * @access protected
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug = EVENTS_PG_SLUG;
-        $this->page_label = EVENTS_LABEL;
-        $this->_admin_base_url = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = array(
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_events' => 'edit',
-        );
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            array($this, 'verify_event_edit'), 10, 2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels = array(
-            'buttons'      => array(
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ),
-            'editor_title' => array(
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ),
-            'publishbox'   => array(
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        //load formatter helper
-        //load field generator helper
-        //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;
-        $this->_page_routes = array(
-            'default'                       => array(
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ),
-            'create_new'                    => array(
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ),
-            'edit'                          => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-            ),
-            'copy_event'                    => array(
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_event'                   => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_events'                  => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'restore_event'                 => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'restore_events'                => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'delete_event'                  => array(
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'delete_events'                 => array(
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'view_report'                   => array(
-                'func'      => '_view_report',
-                'capablity' => 'ee_edit_events',
-            ),
-            'default_event_settings'        => array(
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_default_event_settings' => array(
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'template_settings'             => array(
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ),
-            //event category tab related
-            'add_category'                  => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('add'),
-            ),
-            'edit_category'                 => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('edit'),
-            ),
-            'delete_categories'             => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'delete_category'               => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'insert_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => true),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'update_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => false),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'category_list'                 => array(
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ),
-        );
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ),
-                    'events_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ),
-                    'events_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ),
-                    'events_overview_view_help_tab'                  => array(
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ),
-                    'events_overview_other_help_tab'                 => array(
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Overview_Help_Tour',
-                    //'New_Features_Test_Help_Tour' for testing multiple help tour
-                ),
-                'qtips'         => array(
-                    'EE_Event_List_Table_Tips',
-                ),
-                'require_nonce' => false,
-            ),
-            'create_new'             => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Editor_Help_Tour',
-                ),
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'edit'                   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['post'])
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            array('post' => $this->_req_data['post'], 'action' => 'edit'),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                /*'help_tour' => array(
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @access protected
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug = EVENTS_PG_SLUG;
+		$this->page_label = EVENTS_LABEL;
+		$this->_admin_base_url = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = array(
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_events' => 'edit',
+		);
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			array($this, 'verify_event_edit'), 10, 2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels = array(
+			'buttons'      => array(
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			),
+			'editor_title' => array(
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			),
+			'publishbox'   => array(
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		//load formatter helper
+		//load field generator helper
+		//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;
+		$this->_page_routes = array(
+			'default'                       => array(
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			),
+			'create_new'                    => array(
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			),
+			'edit'                          => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+			),
+			'copy_event'                    => array(
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_event'                   => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_events'                  => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'restore_event'                 => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'restore_events'                => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'delete_event'                  => array(
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'delete_events'                 => array(
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'view_report'                   => array(
+				'func'      => '_view_report',
+				'capablity' => 'ee_edit_events',
+			),
+			'default_event_settings'        => array(
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			),
+			'update_default_event_settings' => array(
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'template_settings'             => array(
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			),
+			//event category tab related
+			'add_category'                  => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('add'),
+			),
+			'edit_category'                 => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('edit'),
+			),
+			'delete_categories'             => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'delete_category'               => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'insert_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => true),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'update_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => false),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'category_list'                 => array(
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			),
+		);
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_overview_help_tab'                       => array(
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					),
+					'events_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					),
+					'events_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					),
+					'events_overview_view_help_tab'                  => array(
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					),
+					'events_overview_other_help_tab'                 => array(
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Overview_Help_Tour',
+					//'New_Features_Test_Help_Tour' for testing multiple help tour
+				),
+				'qtips'         => array(
+					'EE_Event_List_Table_Tips',
+				),
+				'require_nonce' => false,
+			),
+			'create_new'             => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Editor_Help_Tour',
+				),
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'edit'                   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['post'])
+						? EE_Admin_Page::add_query_args_and_nonce(
+							array('post' => $this->_req_data['post'], 'action' => 'edit'),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				/*'help_tour' => array(
 					'Event_Edit_Help_Tour'
 				),*/
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'default_event_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'help_tabs'     => array(
-                    'default_settings_help_tab'        => array(
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ),
-                    'default_settings_status_help_tab' => array(
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ),
-                    'default_maximum_tickets_help_tab' => array(
-                        'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    )
-                ),
-                'help_tour'     => array('Event_Default_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            //template settings
-            'template_settings'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                '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,
-            ),
-            //event category stuff
-            'add_category'           => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'add_category_help_tab' => array(
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ),
-                ),
-                'help_tour'     => array('Event_Add_Category_Help_Tour'),
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'edit_category'          => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['EVT_CAT_ID'])
-                        ? add_query_arg(
-                            array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'help_tabs'     => array(
-                    'edit_category_help_tab' => array(
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ),
-                ),
-                /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'category_list'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_categories_help_tab'                       => array(
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ),
-                    'events_categories_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ),
-                    'events_categories_view_help_tab'                  => array(
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ),
-                    'events_categories_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Categories_Help_Tour',
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        //todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
-        //registers for all views
-        //scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        //scripts
-        wp_register_script(
-            'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-            array('event_editor_js', 'ee-datepicker'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script('event-datetime-metabox');
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param  EE_Event $event Event object
-     * @param string    $req_type
-     * @return void
-     * @throws EE_Error
-     * @access public
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if(!empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (empty($event)) {
-            // set event
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        //made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        } else if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        //now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if ( ! $event->tickets_on_sale()) {
-            return;
-        }
-        //made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            esc_html__(
-                'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        //only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button-secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'draft' => array(
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     * @return array
-     */
-    protected function _event_legend_items()
-    {
-        $items = array(
-            'view_details'   => array(
-                'class' => 'dashicons dashicons-search',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ),
-            'edit_event'     => array(
-                'class' => 'ee-icon ee-icon-calendar-edit',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ),
-            'view_attendees' => array(
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ),
-        );
-        $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = array(
-            'sold_out_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ),
-            'active_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ),
-            'upcoming_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ),
-            'postponed_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ),
-            'expired_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ),
-            'inactive_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ),
-        );
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-
-    /**
-     * @return EEM_Event
-     */
-    private function _event_model()
-    {
-        if ( ! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param  string $return    the current html
-     * @param  int    $id        the post id for the page
-     * @param  string $new_title What the title is
-     * @param  string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        //make sure this is only when editing
-        if ( ! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _events_overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array)$this->_template_args['after_list_table']
-            : array();
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
-                                                                              . EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__("View Event Archive Page", "event_espresso"),
-                'button'
-            );
-        $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'create_new',
-                'add',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
-     * So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  object $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            //get out we're not processing an event save.
-            return;
-        }
-        $event_values = array(
-            'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
-            'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
-            'EVT_additional_limit'            => min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
-            ),
-            'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
-                ? $this->_req_data['EVT_default_registration_status']
-                : EE_Registry::instance()->CFG->registration->default_STS_ID,
-            'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
-            'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
-            'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
-                ? $this->_req_data['timezone_string'] : null,
-            'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
-                ? $this->_req_data['externalURL'] : null,
-            'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
-                ? $this->_req_data['event_phone'] : null,
-        );
-        //update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        //get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = array(
-            $this->_event_model()->primary_key_name() => $post_id,
-            'OR' => array(
-                'status' => $post->post_status,
-                // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                // but the returned object here has a status of "publish", so use the original post status as well
-                'status*1' => $this->_req_data['original_post_status'],
-            )
-        );
-        $event = $this->_event_model()->get_one(array($get_one_where));
-        //the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array(
-                array($this, '_default_venue_update'),
-                array($this, '_default_tickets_update')
-            )
-        );
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = $e_callback($event, $this->_req_data);
-            //if ANY of these updates fail then we want the appropriate global error message
-            $att_success = ! $att_success ? $att_success : $_success;
-        }
-        //any errors?
-        if ($success && false === $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else if ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * @see parent::restore_item()
-     * @param int $post_id
-     * @param int $revision_id
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        //copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            //meta revision restore
-            $post_evt->restore_revision($revision_id);
-            //related objs restore
-            $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
-        }
-    }
-
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param  \EE_Event $evtobj Event Object to add the venue to
-     * @param  array     $data   The request data from the form
-     * @return bool           Success or fail.
-     */
-    protected function _default_venue_update(\EE_Event $evtobj, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $rows_affected = null;
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = array(
-            'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        );
-        //if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if ( ! empty($venue_id)) {
-            $update_where = array($venue_model->primary_key_name() => $venue_id);
-            $rows_affected = $venue_model->update($venue_array, array($update_where));
-            //we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0 ? true : false;
-        } else {
-            //we insert the venue
-            $venue_id = $venue_model->insert($venue_array);
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return ! empty($venue_id) ? true : false;
-        }
-        //when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $evtobj The Event object we're attaching data to
-     * @param  array    $data   The request data from the form
-     * @return array
-     */
-    protected function _default_tickets_update(EE_Event $evtobj, $data)
-    {
-        $success = true;
-        $saved_dtt = null;
-        $saved_tickets = array();
-        $incoming_date_formats = array('Y-m-d', 'h:i a');
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
-            //trim all values to ensure any excess whitespace is removed.
-            $dtt = array_map('trim', $dtt);
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
-                : $dtt['DTT_EVT_start'];
-            $datetime_values = array(
-                'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
-                'DTT_EVT_start' => $dtt['DTT_EVT_start'],
-                'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            );
-            //if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
-            if ( ! empty($dtt['DTT_ID'])) {
-                $DTM = EE_Registry::instance()
-                                  ->load_model('Datetime', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($dtt['DTT_ID']);
-                $DTM->set_date_format($incoming_date_formats[0]);
-                $DTM->set_time_format($incoming_date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-                //make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
-                $saved_dtts[$DTM->ID()] = $DTM;
-            } else {
-                $DTM = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-            }
-            $DTM->save();
-            $DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
-            //load DTT helper
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
-                $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
-                $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
-                $DTT->save();
-            }
-            //now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
-            $saved_dtt = $DTT;
-            $success = ! $success ? $success : $DTT;
-            //if ANY of these updates fail then we want the appropriate global error message.
-            // //todo this is actually sucky we need a better error message but this is what it is for now.
-        }
-        //no dtts get deleted so we don't do any of that logic here.
-        //update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $incoming_date_formats = array('Y-m-d', 'h:i a');
-            $update_prices = false;
-            $ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
-                ? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map('trim', $tkt);
-            if (empty($tkt['TKT_start_date'])) {
-                //let's use now in the set timezone.
-                $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                //use the start date of the first datetime
-                $dtt = $evtobj->first_datetime();
-                $tkt['TKT_end_date'] = $dtt->start_date_and_time(
-                    $incoming_date_formats[0],
-                    $incoming_date_formats[1]
-                );
-            }
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-            );
-            //if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID'] = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $TKT_values['TKT_price'] = $ticket_price;
-                $update_prices = true;
-            }
-            //if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            //we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
-            //keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if ( ! empty($tkt['TKT_ID'])) {
-                $TKT = EE_Registry::instance()
-                                  ->load_model('Ticket', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($tkt['TKT_ID']);
-                if ($TKT instanceof EE_Ticket) {
-                    $ticket_sold = $TKT->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array(
-                                    'NOT IN',
-                                    array(EEM_Registration::status_id_incomplete),
-                                ),
-                            ),
-                        )
-                    ) > 0 ? true : false;
-                    //let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
-                                      && ! $TKT->get(
-                        'TKT_deleted'
-                    ) ? true : false;
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    //if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        //archive the old ticket first
-                        $TKT->set('TKT_deleted', 1);
-                        $TKT->save();
-                        //make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
-                        $saved_tickets[$TKT->ID()] = $TKT;
-                        //create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
-                        $TKT = clone $TKT;
-                        $TKT->set('TKT_ID', 0);
-                        $TKT->set('TKT_deleted', 0);
-                        $TKT->set('TKT_price', $ticket_price);
-                        $TKT->set('TKT_sold', 0);
-                        //now we need to make sure that $new prices are created as well and attached to new ticket.
-                        $update_prices = true;
-                    }
-                    //make sure price is set if it hasn't been already
-                    $TKT->set('TKT_price', $ticket_price);
-                }
-            } else {
-                //no TKT_id so a new TKT
-                $TKT_values['TKT_price'] = $ticket_price;
-                $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
-                if ($TKT instanceof EE_Ticket) {
-                    //need to reset values to properly account for the date formats
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    $TKT->set_timezone($evtobj->get_timezone());
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    $update_prices = true;
-                }
-            }
-            // cap ticket qty by datetime reg limits
-            $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
-            //update ticket.
-            $TKT->save();
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
-                $TKT->save();
-            }
-            //initially let's add the ticket to the dtt
-            $saved_dtt->_add_relation_to($TKT, 'Ticket');
-            $saved_tickets[$TKT->ID()] = $TKT;
-            //add prices to ticket
-            $this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
-        }
-        //however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            //need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($dtts as $dtt) {
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
-            }
-            //need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            //finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return array($saved_dtt, $saved_tickets);
-    }
-
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices     Array of prices from the form.
-     * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
-     * @return  void
-     */
-    private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
-    {
-        foreach ($prices as $row => $prc) {
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
-            } else {
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $newprc) {
-                    $PRC->set($field, $newprc);
-                }
-                $PRC->save();
-            }
-            $ticket->_add_relation_to($PRC, 'Price');
-        }
-    }
-
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-        return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
-    }
-
-
-
-    /**
-     *    _generate_publish_box_extra_content
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        //load formatter helper
-        //args for getting related registrations
-        $approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ),
-        );
-        $not_approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ),
-        );
-        $pending_payment_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ),
-        );
-        // publish box
-        $publish_box_extra_args = array(
-            'view_approved_reg_url'        => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ),
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        );
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_tickets',
-            esc_html__('Event Datetime & Ticket', 'event_espresso'),
-            array($this, 'ticket_metabox'),
-            $this->page_slug,
-            'normal',
-            'high'
-        );
-        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',
-            'default'
-        );
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = array();
-        //defaults for template args
-        $template_args = array(
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'ee-lock-icon',
-            'disabled'                 => '',
-        );
-        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        //do we get related tickets?
-        if ($first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time'] = $first_datetime;
-            $related_tickets = $first_datetime->tickets(
-                array(
-                    array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
-                    'default_where_conditions' => 'none',
-                )
-            );
-            if ( ! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket $ticket */
-            $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure'] = $this->_get_ticket_row(
-            EE_Registry::instance()->load_model('Ticket')->create_default_object(),
-            true
-        );
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param  EE_Ticket $ticket   the ticket object
-     * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int        $row
-     * @return string generated html for the ticket row.
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = array(
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
-            'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        );
-        $price = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
-            : EE_Registry::instance()->load_model('Price')->create_default_object();
-        $price_args = array(
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        );
-        //make sure we have default start and end dates if skeleton
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
-                )
-                : null;
-            if ( ! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
-            } else {
-                $template_args['TKT_end_date'] = date(
-                    'Y-m-d h:i a',
-                    mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
-                );
-            }
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @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,
-            ),
-            true
-        );
-        //$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $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['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_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array an array of event objects.
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEME = $this->_event_model();
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
-        if (isset($this->_req_data['month_range'])) {
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
-            //simulate the FIRST day of the month, that fixes issues for months like February
-            //where PHP doesn't know what to assume for date.
-            //@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where = array();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        //determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month' :
-            case 'today' :
-            case null :
-            case 'all' :
-                break;
-            case 'draft' :
-                $where['status'] = array('IN', array('draft', 'auto-draft'));
-                break;
-            default :
-                $where['status'] = $status;
-        }
-        //categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT'] : null;
-        if ( ! empty ($category)) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Term_Taxonomy.term_id'] = $category;
-        }
-        //date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone(EEM_Datetime::instance()->get_timezone())
-            );
-            $start = $DateTime->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate($year_r, $month_r, $DateTime
-                ->format('t'))->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
-            $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
-            $now = date('Y-m-01');
-            $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                            ->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        }
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if ( ! isset($where['status'])) {
-                if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = array(
-                        'status*restrict_private' => array('!=', 'private'),
-                        'AND'                     => array(
-                            'status*inclusive' => array('=', 'private'),
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ),
-                    );
-                }
-            }
-        }
-        if (isset($this->_req_data['EVT_wp_user'])) {
-            if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
-                && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-            ) {
-                $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
-            }
-        }
-        //search query handling
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'EVT_name'       => array('LIKE', $search_string),
-                'EVT_desc'       => array('LIKE', $search_string),
-                'EVT_short_desc' => array('LIKE', $search_string),
-            );
-        }
-        $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
-        $query_params = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            array(
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ),
-            $this->_req_data
-        );
-        //let's first check if we have special requests coming in.
-        if (isset($this->_req_data['active_status'])) {
-            switch ($this->_req_data['active_status']) {
-                case 'upcoming' :
-                    return $EEME->get_upcoming_events($query_params, $count);
-                    break;
-                case 'expired' :
-                    return $EEME->get_expired_events($query_params, $count);
-                    break;
-                case 'active' :
-                    return $EEME->get_active_events($query_params, $count);
-                    break;
-                case 'inactive' :
-                    return $EEME->get_inactive_events($query_params, $count);
-                    break;
-            }
-        }
-        $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
-        return $events;
-    }
-
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_delete_event(false);
-    }
-
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param  string $event_status
-     * @param bool    $redirect_after
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if ( ! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param  string $event_status
-     * @return void
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if ( ! empty($event_status)) {
-            $success = true;
-            //determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access  private
-     * @param  int    $EVT_ID
-     * @param  string $event_status
-     * @return bool
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft' :
-                $action = 'restored from the trash';
-                $hook = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash' :
-                $action = 'moved to the trash';
-                $hook = 'AHEE_event_moved_to_trash';
-                break;
-            default :
-                $action = 'updated';
-                $hook = false;
-        }
-        //use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _delete_event
-     *
-     * @access protected
-     * @param bool $redirect_after
-     */
-    protected function _delete_event($redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
-        $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
-        // loop thru events
-        if ($EVT_ID) {
-            $success = $this->_permanently_delete_event($EVT_ID);
-            // get list of events with no prices
-            $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-            // remove this event from the list of events with no prices
-            if (isset($espresso_no_ticket_prices[$EVT_ID])) {
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            }
-            update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action(
-                $success,
-                'Event',
-                'deleted',
-                array('action' => 'default', 'status' => 'trash')
-            );
-        }
-    }
-
-
-
-    /**
-     * _delete_events
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _delete_events()
-    {
-        $success = true;
-        // get list of events with no prices
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-        //determine the event id and set to array.
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-        // loop thru events
-        foreach ($EVT_IDs as $EVT_ID) {
-            $EVT_ID = absint($EVT_ID);
-            if ($EVT_ID) {
-                $results = $this->_permanently_delete_event($EVT_ID);
-                $success = $results !== false ? $success : false;
-                // remove this event from the list of events with no prices
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _permanently_delete_event
-     *
-     * @access  private
-     * @param  int $EVT_ID
-     * @return bool
-     */
-    private function _permanently_delete_event($EVT_ID = 0)
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (
-            ! $this->_cpt_model_obj instanceof EE_Event
-            || $this->_cpt_model_obj->ID() !== $EVT_ID
-        ) {
-            $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        if ( ! $this->_cpt_model_obj instanceof EE_Event) {
-            return false;
-        }
-        //need to delete related tickets and prices first.
-        $datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
-        foreach ($datetimes as $datetime) {
-            $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
-            $tickets = $datetime->get_many_related('Ticket');
-            foreach ($tickets as $ticket) {
-                $ticket->_remove_relation_to($datetime, 'Datetime');
-                $ticket->delete_related_permanently('Price');
-                $ticket->delete_permanently();
-            }
-            $datetime->delete();
-        }
-        //what about related venues or terms?
-        $venues = $this->_cpt_model_obj->get_many_related('Venue');
-        foreach ($venues as $venue) {
-            $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
-        }
-        //any attached question groups?
-        $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
-        if ( ! empty($question_groups)) {
-            foreach ($question_groups as $question_group) {
-                $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
-            }
-        }
-        //Message Template Groups
-        $this->_cpt_model_obj->_remove_relations('Message_Template_Group');
-        /** @type EE_Term_Taxonomy[] $term_taxonomies */
-        $term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
-        foreach ($term_taxonomies as $term_taxonomy) {
-            $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
-        }
-        $success = $this->_cpt_model_obj->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg = sprintf(
-                esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
-                $EVT_ID
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
-        return true;
-    }
-
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events()
-    {
-        $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events_draft()
-    {
-        $where = array(
-            'status' => array('IN', array('draft', 'auto-draft')),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_trashed_events()
-    {
-        $where = array(
-            'status' => 'trash',
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        //exclude
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'update_default_event_settings',
-                'html_id' => 'update_default_event_settings',
-                'html_class' => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    array(
-                        'default_reg_status' => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            array(
-                                'default' => isset($registration_config->default_STS_ID)
-                                             && array_key_exists(
-                                                $registration_config->default_STS_ID,
-                                                $registration_stati_for_selection
-                                             )
-                                            ? sanitize_text_field($registration_config->default_STS_ID)
-                                            : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                    . EEH_Template::get_help_tab_link(
-                                                        'default_settings_status_help_tab'
-                                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            array(
-                                'default' => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                ) . EEH_Template::get_help_tab_link(
-                                    'default_maximum_tickets_help_tab"'
-                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                )
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_default_event_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_default_event_settings()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                //update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    __('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
-    }
-
-
-
-    /*************        Templates        *************/
-    protected function _template_settings()
-    {
-        $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img'] = '<img src="'
-                                               . EVENTS_ASSETS_URL
-                                               . DS
-                                               . 'images'
-                                               . DS
-                                               . 'caffeinated_template_features.jpg" alt="'
-                                               . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                               . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__(
-                'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                'event_espresso'
-            ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        //set default category object
-        $this->_set_empty_category_object();
-        //only set if we've got an id
-        if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
-            return;
-        }
-        $category_id = absint($this->_req_data['EVT_CAT_ID']);
-        $term = get_term($category_id, 'espresso_event_categories');
-        if ( ! empty($term)) {
-            $this->_category->category_name = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc = $term->description;
-            $this->_category->id = $term->term_id;
-            $this->_category->parent = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_category',
-                'add_category',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details view.
-     */
-    protected function _category_details($view)
-    {
-        //load formatter helper
-        //load field generator helper
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        //custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'category_list'),
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        //take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details content.
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = array(
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => array('media_buttons' => false),
-        );
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms = get_terms(
-            array('espresso_event_categories'),
-            array('hide_empty' => 0, 'exclude' => array($this->_category->id))
-        );
-        //setup category select for term parents.
-        $category_select_values[] = array(
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        );
-        foreach ($all_terms as $term) {
-            $category_select_values[] = array(
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            );
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args = array(
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     */
-    protected function _delete_categories()
-    {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
-            : (array)$this->_req_data['category_id'];
-        foreach ($cat_ids as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-        //doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = array(
-            'action' => 'category_list',
-        );
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-
-    /**
-     * Handles deleting specific category.
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_event_categories');
-    }
-
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     * @param bool $new_category  true means we're triggering the insert of a new category.
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; //we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = array(
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            );
-        } else {
-            $query_args = array('action' => 'add_category');
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * Inserts or updates category
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = array(
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        );
-        //was the category_identifier input disabled?
-        if (isset($this->_req_data['category_identifier'])) {
-            $term_args['slug'] = $this->_req_data['category_identifier'];
-        }
-        $insert_ids = $update
-            ? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
-            : wp_insert_term($category_name, 'espresso_event_categories', $term_args);
-        if ( ! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $cat_id = $insert_ids['term_id'];
-            $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-        return $cat_id;
-    }
-
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        //testing term stuff
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $limit = ($current_page - 1) * $per_page;
-        $where = array('taxonomy' => 'espresso_event_categories');
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'Term.name'   => array('LIKE', $sstr),
-                'description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $where,
-            'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => array('Term'),
-        );
-        $categories = $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-        return $categories;
-    }
-
-    /* end category stuff */
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     * @throws EE_Error
-     */
-    public function save_timezonestring_setting()
-    {
-        $timezone_string = isset($this->_req_data['timezone_selected'])
-            ? $this->_req_data['timezone_selected']
-            : '';
-        if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
-        {
-            EE_Error::add_error(
-                esc_html('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, array('action' => 'create_new'));
-    }
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'default_event_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'help_tabs'     => array(
+					'default_settings_help_tab'        => array(
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					),
+					'default_settings_status_help_tab' => array(
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					),
+					'default_maximum_tickets_help_tab' => array(
+						'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					)
+				),
+				'help_tour'     => array('Event_Default_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+			//template settings
+			'template_settings'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'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,
+			),
+			//event category stuff
+			'add_category'           => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'add_category_help_tab' => array(
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					),
+				),
+				'help_tour'     => array('Event_Add_Category_Help_Tour'),
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'edit_category'          => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['EVT_CAT_ID'])
+						? add_query_arg(
+							array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'help_tabs'     => array(
+					'edit_category_help_tab' => array(
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					),
+				),
+				/*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'category_list'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_categories_help_tab'                       => array(
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					),
+					'events_categories_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					),
+					'events_categories_view_help_tab'                  => array(
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					),
+					'events_categories_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Categories_Help_Tour',
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		//todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
+		//registers for all views
+		//scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		//scripts
+		wp_register_script(
+			'event-datetime-metabox',
+			EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+			array('event_editor_js', 'ee-datepicker'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script('event-datetime-metabox');
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param  EE_Event $event Event object
+	 * @param string    $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if(!empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (empty($event)) {
+			// set event
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		//made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		} else if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		//now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if ( ! $event->tickets_on_sale()) {
+			return;
+		}
+		//made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			esc_html__(
+				'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		//only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button-secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'draft' => array(
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 * @return array
+	 */
+	protected function _event_legend_items()
+	{
+		$items = array(
+			'view_details'   => array(
+				'class' => 'dashicons dashicons-search',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			),
+			'edit_event'     => array(
+				'class' => 'ee-icon ee-icon-calendar-edit',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			),
+			'view_attendees' => array(
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			),
+		);
+		$items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = array(
+			'sold_out_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			),
+			'active_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			),
+			'upcoming_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			),
+			'postponed_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			),
+			'expired_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			),
+			'inactive_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			),
+		);
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+
+	/**
+	 * @return EEM_Event
+	 */
+	private function _event_model()
+	{
+		if ( ! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param  string $return    the current html
+	 * @param  int    $id        the post id for the page
+	 * @param  string $new_title What the title is
+	 * @param  string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		//make sure this is only when editing
+		if ( ! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _events_overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
+			? (array)$this->_template_args['after_list_table']
+			: array();
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
+																			  . EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__("View Event Archive Page", "event_espresso"),
+				'button'
+			);
+		$this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'create_new',
+				'add',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
+	 * So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  object $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			//get out we're not processing an event save.
+			return;
+		}
+		$event_values = array(
+			'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
+			'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
+			'EVT_additional_limit'            => min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
+			),
+			'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
+				? $this->_req_data['EVT_default_registration_status']
+				: EE_Registry::instance()->CFG->registration->default_STS_ID,
+			'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
+			'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
+			'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
+				? $this->_req_data['timezone_string'] : null,
+			'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
+				? $this->_req_data['externalURL'] : null,
+			'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
+				? $this->_req_data['event_phone'] : null,
+		);
+		//update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		//get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = array(
+			$this->_event_model()->primary_key_name() => $post_id,
+			'OR' => array(
+				'status' => $post->post_status,
+				// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+				// but the returned object here has a status of "publish", so use the original post status as well
+				'status*1' => $this->_req_data['original_post_status'],
+			)
+		);
+		$event = $this->_event_model()->get_one(array($get_one_where));
+		//the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array(
+				array($this, '_default_venue_update'),
+				array($this, '_default_tickets_update')
+			)
+		);
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = $e_callback($event, $this->_req_data);
+			//if ANY of these updates fail then we want the appropriate global error message
+			$att_success = ! $att_success ? $att_success : $_success;
+		}
+		//any errors?
+		if ($success && false === $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else if ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * @see parent::restore_item()
+	 * @param int $post_id
+	 * @param int $revision_id
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		//copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			//meta revision restore
+			$post_evt->restore_revision($revision_id);
+			//related objs restore
+			$post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
+		}
+	}
+
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param  \EE_Event $evtobj Event Object to add the venue to
+	 * @param  array     $data   The request data from the form
+	 * @return bool           Success or fail.
+	 */
+	protected function _default_venue_update(\EE_Event $evtobj, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$rows_affected = null;
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = array(
+			'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		);
+		//if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if ( ! empty($venue_id)) {
+			$update_where = array($venue_model->primary_key_name() => $venue_id);
+			$rows_affected = $venue_model->update($venue_array, array($update_where));
+			//we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0 ? true : false;
+		} else {
+			//we insert the venue
+			$venue_id = $venue_model->insert($venue_array);
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return ! empty($venue_id) ? true : false;
+		}
+		//when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $evtobj The Event object we're attaching data to
+	 * @param  array    $data   The request data from the form
+	 * @return array
+	 */
+	protected function _default_tickets_update(EE_Event $evtobj, $data)
+	{
+		$success = true;
+		$saved_dtt = null;
+		$saved_tickets = array();
+		$incoming_date_formats = array('Y-m-d', 'h:i a');
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
+			//trim all values to ensure any excess whitespace is removed.
+			$dtt = array_map('trim', $dtt);
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
+				: $dtt['DTT_EVT_start'];
+			$datetime_values = array(
+				'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
+				'DTT_EVT_start' => $dtt['DTT_EVT_start'],
+				'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			);
+			//if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
+			if ( ! empty($dtt['DTT_ID'])) {
+				$DTM = EE_Registry::instance()
+								  ->load_model('Datetime', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($dtt['DTT_ID']);
+				$DTM->set_date_format($incoming_date_formats[0]);
+				$DTM->set_time_format($incoming_date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+				//make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
+				$saved_dtts[$DTM->ID()] = $DTM;
+			} else {
+				$DTM = EE_Registry::instance()->load_class(
+					'Datetime',
+					array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+			}
+			$DTM->save();
+			$DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
+			//load DTT helper
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
+				$DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
+				$DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
+				$DTT->save();
+			}
+			//now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
+			$saved_dtt = $DTT;
+			$success = ! $success ? $success : $DTT;
+			//if ANY of these updates fail then we want the appropriate global error message.
+			// //todo this is actually sucky we need a better error message but this is what it is for now.
+		}
+		//no dtts get deleted so we don't do any of that logic here.
+		//update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$incoming_date_formats = array('Y-m-d', 'h:i a');
+			$update_prices = false;
+			$ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
+				? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map('trim', $tkt);
+			if (empty($tkt['TKT_start_date'])) {
+				//let's use now in the set timezone.
+				$now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				//use the start date of the first datetime
+				$dtt = $evtobj->first_datetime();
+				$tkt['TKT_end_date'] = $dtt->start_date_and_time(
+					$incoming_date_formats[0],
+					$incoming_date_formats[1]
+				);
+			}
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+			);
+			//if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID'] = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$TKT_values['TKT_price'] = $ticket_price;
+				$update_prices = true;
+			}
+			//if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			//we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
+			//keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if ( ! empty($tkt['TKT_ID'])) {
+				$TKT = EE_Registry::instance()
+								  ->load_model('Ticket', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($tkt['TKT_ID']);
+				if ($TKT instanceof EE_Ticket) {
+					$ticket_sold = $TKT->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array(
+									'NOT IN',
+									array(EEM_Registration::status_id_incomplete),
+								),
+							),
+						)
+					) > 0 ? true : false;
+					//let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
+									  && ! $TKT->get(
+						'TKT_deleted'
+					) ? true : false;
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					//if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						//archive the old ticket first
+						$TKT->set('TKT_deleted', 1);
+						$TKT->save();
+						//make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
+						$saved_tickets[$TKT->ID()] = $TKT;
+						//create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
+						$TKT = clone $TKT;
+						$TKT->set('TKT_ID', 0);
+						$TKT->set('TKT_deleted', 0);
+						$TKT->set('TKT_price', $ticket_price);
+						$TKT->set('TKT_sold', 0);
+						//now we need to make sure that $new prices are created as well and attached to new ticket.
+						$update_prices = true;
+					}
+					//make sure price is set if it hasn't been already
+					$TKT->set('TKT_price', $ticket_price);
+				}
+			} else {
+				//no TKT_id so a new TKT
+				$TKT_values['TKT_price'] = $ticket_price;
+				$TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
+				if ($TKT instanceof EE_Ticket) {
+					//need to reset values to properly account for the date formats
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					$TKT->set_timezone($evtobj->get_timezone());
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					$update_prices = true;
+				}
+			}
+			// cap ticket qty by datetime reg limits
+			$TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
+			//update ticket.
+			$TKT->save();
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
+				$TKT->save();
+			}
+			//initially let's add the ticket to the dtt
+			$saved_dtt->_add_relation_to($TKT, 'Ticket');
+			$saved_tickets[$TKT->ID()] = $TKT;
+			//add prices to ticket
+			$this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
+		}
+		//however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($dtts as $dtt) {
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
+			}
+			//need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			//finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return array($saved_dtt, $saved_tickets);
+	}
+
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices     Array of prices from the form.
+	 * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 */
+	private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
+	{
+		foreach ($prices as $row => $prc) {
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
+			} else {
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $newprc) {
+					$PRC->set($field, $newprc);
+				}
+				$PRC->save();
+			}
+			$ticket->_add_relation_to($PRC, 'Price');
+		}
+	}
+
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+		return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
+	}
+
+
+
+	/**
+	 *    _generate_publish_box_extra_content
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		//load formatter helper
+		//args for getting related registrations
+		$approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			),
+		);
+		$not_approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			),
+		);
+		$pending_payment_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			),
+		);
+		// publish box
+		$publish_box_extra_args = array(
+			'view_approved_reg_url'        => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				),
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		);
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_tickets',
+			esc_html__('Event Datetime & Ticket', 'event_espresso'),
+			array($this, 'ticket_metabox'),
+			$this->page_slug,
+			'normal',
+			'high'
+		);
+		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',
+			'default'
+		);
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = array();
+		//defaults for template args
+		$template_args = array(
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'ee-lock-icon',
+			'disabled'                 => '',
+		);
+		$event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		$times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		//do we get related tickets?
+		if ($first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time'] = $first_datetime;
+			$related_tickets = $first_datetime->tickets(
+				array(
+					array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
+					'default_where_conditions' => 'none',
+				)
+			);
+			if ( ! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[] = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket $ticket */
+			$ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure'] = $this->_get_ticket_row(
+			EE_Registry::instance()->load_model('Ticket')->create_default_object(),
+			true
+		);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param  EE_Ticket $ticket   the ticket object
+	 * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int        $row
+	 * @return string generated html for the ticket row.
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = array(
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
+			'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		);
+		$price = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
+			: EE_Registry::instance()->load_model('Price')->create_default_object();
+		$price_args = array(
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		);
+		//make sure we have default start and end dates if skeleton
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
+				)
+				: null;
+			if ( ! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
+			} else {
+				$template_args['TKT_end_date'] = date(
+					'Y-m-d h:i a',
+					mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
+				);
+			}
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @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,
+			),
+			true
+		);
+		//$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$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['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_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array an array of event objects.
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEME = $this->_event_model();
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $count ? null : $offset . ',' . $per_page;
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
+		if (isset($this->_req_data['month_range'])) {
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
+			//simulate the FIRST day of the month, that fixes issues for months like February
+			//where PHP doesn't know what to assume for date.
+			//@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where = array();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		//determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month' :
+			case 'today' :
+			case null :
+			case 'all' :
+				break;
+			case 'draft' :
+				$where['status'] = array('IN', array('draft', 'auto-draft'));
+				break;
+			default :
+				$where['status'] = $status;
+		}
+		//categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT'] : null;
+		if ( ! empty ($category)) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Term_Taxonomy.term_id'] = $category;
+		}
+		//date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone(EEM_Datetime::instance()->get_timezone())
+			);
+			$start = $DateTime->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate($year_r, $month_r, $DateTime
+				->format('t'))->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
+			$DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
+			$now = date('Y-m-01');
+			$DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+							->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		}
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if ( ! isset($where['status'])) {
+				if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = array(
+						'status*restrict_private' => array('!=', 'private'),
+						'AND'                     => array(
+							'status*inclusive' => array('=', 'private'),
+							'EVT_wp_user'      => get_current_user_id(),
+						),
+					);
+				}
+			}
+		}
+		if (isset($this->_req_data['EVT_wp_user'])) {
+			if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
+				&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+			) {
+				$where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
+			}
+		}
+		//search query handling
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'EVT_name'       => array('LIKE', $search_string),
+				'EVT_desc'       => array('LIKE', $search_string),
+				'EVT_short_desc' => array('LIKE', $search_string),
+			);
+		}
+		$where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
+		$query_params = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			array(
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			),
+			$this->_req_data
+		);
+		//let's first check if we have special requests coming in.
+		if (isset($this->_req_data['active_status'])) {
+			switch ($this->_req_data['active_status']) {
+				case 'upcoming' :
+					return $EEME->get_upcoming_events($query_params, $count);
+					break;
+				case 'expired' :
+					return $EEME->get_expired_events($query_params, $count);
+					break;
+				case 'active' :
+					return $EEME->get_active_events($query_params, $count);
+					break;
+				case 'inactive' :
+					return $EEME->get_inactive_events($query_params, $count);
+					break;
+			}
+		}
+		$events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
+		return $events;
+	}
+
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_delete_event(false);
+	}
+
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @param bool    $redirect_after
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if ( ! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @return void
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if ( ! empty($event_status)) {
+			$success = true;
+			//determine the event id and set to array.
+			$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access  private
+	 * @param  int    $EVT_ID
+	 * @param  string $event_status
+	 * @return bool
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft' :
+				$action = 'restored from the trash';
+				$hook = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash' :
+				$action = 'moved to the trash';
+				$hook = 'AHEE_event_moved_to_trash';
+				break;
+			default :
+				$action = 'updated';
+				$hook = false;
+		}
+		//use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _delete_event
+	 *
+	 * @access protected
+	 * @param bool $redirect_after
+	 */
+	protected function _delete_event($redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
+		$EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
+		// loop thru events
+		if ($EVT_ID) {
+			$success = $this->_permanently_delete_event($EVT_ID);
+			// get list of events with no prices
+			$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+			// remove this event from the list of events with no prices
+			if (isset($espresso_no_ticket_prices[$EVT_ID])) {
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			}
+			update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action(
+				$success,
+				'Event',
+				'deleted',
+				array('action' => 'default', 'status' => 'trash')
+			);
+		}
+	}
+
+
+
+	/**
+	 * _delete_events
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _delete_events()
+	{
+		$success = true;
+		// get list of events with no prices
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+		//determine the event id and set to array.
+		$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+		// loop thru events
+		foreach ($EVT_IDs as $EVT_ID) {
+			$EVT_ID = absint($EVT_ID);
+			if ($EVT_ID) {
+				$results = $this->_permanently_delete_event($EVT_ID);
+				$success = $results !== false ? $success : false;
+				// remove this event from the list of events with no prices
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _permanently_delete_event
+	 *
+	 * @access  private
+	 * @param  int $EVT_ID
+	 * @return bool
+	 */
+	private function _permanently_delete_event($EVT_ID = 0)
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (
+			! $this->_cpt_model_obj instanceof EE_Event
+			|| $this->_cpt_model_obj->ID() !== $EVT_ID
+		) {
+			$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		if ( ! $this->_cpt_model_obj instanceof EE_Event) {
+			return false;
+		}
+		//need to delete related tickets and prices first.
+		$datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
+		foreach ($datetimes as $datetime) {
+			$this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
+			$tickets = $datetime->get_many_related('Ticket');
+			foreach ($tickets as $ticket) {
+				$ticket->_remove_relation_to($datetime, 'Datetime');
+				$ticket->delete_related_permanently('Price');
+				$ticket->delete_permanently();
+			}
+			$datetime->delete();
+		}
+		//what about related venues or terms?
+		$venues = $this->_cpt_model_obj->get_many_related('Venue');
+		foreach ($venues as $venue) {
+			$this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
+		}
+		//any attached question groups?
+		$question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
+		if ( ! empty($question_groups)) {
+			foreach ($question_groups as $question_group) {
+				$this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
+			}
+		}
+		//Message Template Groups
+		$this->_cpt_model_obj->_remove_relations('Message_Template_Group');
+		/** @type EE_Term_Taxonomy[] $term_taxonomies */
+		$term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
+		foreach ($term_taxonomies as $term_taxonomy) {
+			$this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
+		}
+		$success = $this->_cpt_model_obj->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg = sprintf(
+				esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
+				$EVT_ID
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
+		return true;
+	}
+
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events()
+	{
+		$count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events_draft()
+	{
+		$where = array(
+			'status' => array('IN', array('draft', 'auto-draft')),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_trashed_events()
+	{
+		$where = array(
+			'status' => 'trash',
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		//exclude
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'update_default_event_settings',
+				'html_id' => 'update_default_event_settings',
+				'html_class' => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					array(
+						'default_reg_status' => new EE_Select_Input(
+							$registration_stati_for_selection,
+							array(
+								'default' => isset($registration_config->default_STS_ID)
+											 && array_key_exists(
+												$registration_config->default_STS_ID,
+												$registration_stati_for_selection
+											 )
+											? sanitize_text_field($registration_config->default_STS_ID)
+											: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													. EEH_Template::get_help_tab_link(
+														'default_settings_status_help_tab'
+													),
+								'html_help_text' => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								)
+							)
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							array(
+								'default' => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								) . EEH_Template::get_help_tab_link(
+									'default_maximum_tickets_help_tab"'
+									),
+								'html_help_text' => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								)
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_default_event_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_default_event_settings()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				//update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
+	}
+
+
+
+	/*************        Templates        *************/
+	protected function _template_settings()
+	{
+		$this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img'] = '<img src="'
+											   . EVENTS_ASSETS_URL
+											   . DS
+											   . 'images'
+											   . DS
+											   . 'caffeinated_template_features.jpg" alt="'
+											   . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+											   . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . esc_html__(
+				'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+				'event_espresso'
+			) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		//set default category object
+		$this->_set_empty_category_object();
+		//only set if we've got an id
+		if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
+			return;
+		}
+		$category_id = absint($this->_req_data['EVT_CAT_ID']);
+		$term = get_term($category_id, 'espresso_event_categories');
+		if ( ! empty($term)) {
+			$this->_category->category_name = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc = $term->description;
+			$this->_category->id = $term->term_id;
+			$this->_category->parent = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_category',
+				'add_category',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details view.
+	 */
+	protected function _category_details($view)
+	{
+		//load formatter helper
+		//load field generator helper
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		//custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'category_list'),
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		//take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details content.
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = array(
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => array('media_buttons' => false),
+		);
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms = get_terms(
+			array('espresso_event_categories'),
+			array('hide_empty' => 0, 'exclude' => array($this->_category->id))
+		);
+		//setup category select for term parents.
+		$category_select_values[] = array(
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		);
+		foreach ($all_terms as $term) {
+			$category_select_values[] = array(
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			);
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args = array(
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		);
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 */
+	protected function _delete_categories()
+	{
+		$cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
+			: (array)$this->_req_data['category_id'];
+		foreach ($cat_ids as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+		//doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = array(
+			'action' => 'category_list',
+		);
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+
+	/**
+	 * Handles deleting specific category.
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_event_categories');
+	}
+
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 * @param bool $new_category  true means we're triggering the insert of a new category.
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; //we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = array(
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			);
+		} else {
+			$query_args = array('action' => 'add_category');
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * Inserts or updates category
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = array(
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		);
+		//was the category_identifier input disabled?
+		if (isset($this->_req_data['category_identifier'])) {
+			$term_args['slug'] = $this->_req_data['category_identifier'];
+		}
+		$insert_ids = $update
+			? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
+			: wp_insert_term($category_name, 'espresso_event_categories', $term_args);
+		if ( ! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$cat_id = $insert_ids['term_id'];
+			$msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+		return $cat_id;
+	}
+
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		//testing term stuff
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$limit = ($current_page - 1) * $per_page;
+		$where = array('taxonomy' => 'espresso_event_categories');
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'Term.name'   => array('LIKE', $sstr),
+				'description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$where,
+			'order_by'   => array($orderby => $order),
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => array('Term'),
+		);
+		$categories = $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+		return $categories;
+	}
+
+	/* end category stuff */
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 * @throws EE_Error
+	 */
+	public function save_timezonestring_setting()
+	{
+		$timezone_string = isset($this->_req_data['timezone_selected'])
+			? $this->_req_data['timezone_selected']
+			: '';
+		if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
+		{
+			EE_Error::add_error(
+				esc_html('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, array('action' => 'create_new'));
+	}
 }
 //end class Events_Admin_Page

Spacing +39 added lines, -39 removed lines

@@ -553,11 +553,11 @@ 
     {
         wp_register_style(
             'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
+            EVENTS_ASSETS_URL.'events-admin-page.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL.'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('events-admin-css');
         wp_enqueue_style('ee-cat-admin');
         //todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
@@ -565,7 +565,7 @@ 
         //scripts
         wp_register_script(
             'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
+            EVENTS_ASSETS_URL.'event_editor.js',
             array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -593,7 +593,7 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
+            EVENTS_ASSETS_URL.'event-editor.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -601,7 +601,7 @@ 
         //scripts
         wp_register_script(
             'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+            EVENTS_ASSETS_URL.'event-datetime-metabox.js',
             array('event_editor_js', 'ee-datepicker'),
             EVENT_ESPRESSO_VERSION
         );
@@ -670,7 +670,7 @@ 
     public function verify_event_edit($event = null, $req_type = '')
     {
         // don't need to do this when processing
-        if(!empty($req_type)) {
+        if ( ! empty($req_type)) {
             return;
         }
         // no event?
@@ -679,7 +679,7 @@ 
             $event = $this->_cpt_model_obj;
         }
         // STILL no event?
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             return;
         }
         $orig_status = $event->status();
@@ -761,7 +761,7 @@ 
     {
         $has_timezone_string = get_option('timezone_string');
         //only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
+        if ( ! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
             EE_Error::add_attention(
                 sprintf(
                     __(
@@ -845,31 +845,31 @@ 
         $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
         $statuses = array(
             'sold_out_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::sold_out,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
             ),
             'active_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::active,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
             ),
             'upcoming_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::upcoming,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
             ),
             'postponed_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::postponed,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::cancelled,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
             ),
             'expired_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::expired,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
             ),
             'inactive_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::inactive,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
             ),
         );
@@ -931,7 +931,7 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array)$this->_template_args['after_list_table']
+            ? (array) $this->_template_args['after_list_table']
             : array();
         $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
                                                                               . EEH_Template::get_button_or_link(
@@ -940,7 +940,7 @@ 
                 'button'
             );
         $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'create_new',
                 'add',
                 array(),
@@ -1081,7 +1081,7 @@ 
      */
     protected function _default_venue_update(\EE_Event $evtobj, $data)
     {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
+        require_once(EE_MODELS.'EEM_Venue.model.php');
         $venue_model = EE_Registry::instance()->load_model('Venue');
         $rows_affected = null;
         $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
@@ -1205,7 +1205,7 @@ 
             if (empty($tkt['TKT_start_date'])) {
                 //let's use now in the set timezone.
                 $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0].' '.$incoming_date_formats[1]);
             }
             if (empty($tkt['TKT_end_date'])) {
                 //use the start date of the first datetime
@@ -1484,7 +1484,7 @@ 
         $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
         // load template
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+            EVENTS_TEMPLATE_PATH.'event_publish_box_extras.template.php',
             $publish_box_extra_args
         );
     }
@@ -1611,7 +1611,7 @@ 
         );
         $template = apply_filters(
             'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_main.template.php'
         );
         EEH_Template::display_template($template, $template_args);
     }
@@ -1630,7 +1630,7 @@ 
     private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
     {
         $template_args = array(
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+            'tkt_status_class'    => ' tkt-status-'.$ticket->ticket_status(),
             'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
                 : '',
             'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
@@ -1684,7 +1684,7 @@ 
         $template_args = array_merge($template_args, $price_args);
         $template = apply_filters(
             'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_ticket_row.template.php',
             $ticket
         );
         return EEH_Template::display_template($template, $template_args, true);
@@ -1738,7 +1738,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1761,7 +1761,7 @@ 
     {
         $EEME = $this->_event_model();
         $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
+        $limit = $count ? null : $offset.','.$per_page;
         $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
         $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
         if (isset($this->_req_data['month_range'])) {
@@ -1798,7 +1798,7 @@ 
         $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
         if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
             $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
+                $year_r.'-'.$month_r.'-01 00:00:00',
                 new DateTimeZone(EEM_Datetime::instance()->get_timezone())
             );
             $start = $DateTime->format(implode(' ', $start_formats));
@@ -1844,7 +1844,7 @@ 
         }
         //search query handling
         if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+            $search_string = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'EVT_name'       => array('LIKE', $search_string),
                 'EVT_desc'       => array('LIKE', $search_string),
@@ -1978,7 +1978,7 @@ 
         if ( ! empty($event_status)) {
             $success = true;
             //determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
             // loop thru events
             foreach ($EVT_IDs as $EVT_ID) {
                 if ($EVT_ID = absint($EVT_ID)) {
@@ -2126,7 +2126,7 @@ 
         // get list of events with no prices
         $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
         //determine the event id and set to array.
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
         // loop thru events
         foreach ($EVT_IDs as $EVT_ID) {
             $EVT_ID = absint($EVT_ID);
@@ -2346,7 +2346,7 @@ 
                                 'html_label_text' => esc_html__(
                                     'Default Maximum Tickets Allowed Per Order:',
                                     'event_espresso'
-                                ) . EEH_Template::get_help_tab_link(
+                                ).EEH_Template::get_help_tab_link(
                                     'default_maximum_tickets_help_tab"'
                                     ),
                                 'html_help_text' => esc_html__(
@@ -2408,10 +2408,10 @@ 
                                                . 'caffeinated_template_features.jpg" alt="'
                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__(
+        $this->_template_args['preview_text'] = '<strong>'.esc_html__(
                 'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
                 'event_espresso'
-            ) . '</strong>';
+            ).'</strong>';
         $this->display_admin_caf_preview_page('template_settings_tab');
     }
 
@@ -2464,7 +2464,7 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_category',
                 'add_category',
                 array(),
@@ -2540,7 +2540,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -2550,8 +2550,8 @@ 
      */
     protected function _delete_categories()
     {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
-            : (array)$this->_req_data['category_id'];
+        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
+            : (array) $this->_req_data['category_id'];
         foreach ($cat_ids as $cat_id) {
             $this->_delete_category($cat_id);
         }
@@ -2656,7 +2656,7 @@ 
         $limit = ($current_page - 1) * $per_page;
         $where = array('taxonomy' => 'espresso_event_categories');
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'Term.name'   => array('LIKE', $sstr),
                 'description' => array('LIKE', $sstr),
@@ -2665,7 +2665,7 @@ 
         $query_params = array(
             $where,
             'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => array('Term'),
         );
         $categories = $count
@@ -2687,7 +2687,7 @@ 
         $timezone_string = isset($this->_req_data['timezone_selected'])
             ? $this->_req_data['timezone_selected']
             : '';
-        if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
+        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
         {
             EE_Error::add_error(
                 esc_html('An invalid timezone string submitted.', 'event_espresso'),

admin_pages/registrations/Registrations_Admin_Page.core.php

Indentation +3427 added lines, -3427 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,2113 +23,2113 @@ 
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * @var EE_Registration
-     */
-    private $_registration;
-
-    /**
-     * @var EE_Event
-     */
-    private $_reg_event;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    private static $_reg_status;
-
-    /**
-     * Form for displaying the custom questions for this registration.
-     * This gets used a few times throughout the request so its best to cache it
-     *
-     * @var EE_Registration_Custom_Questions_Form
-     */
-    protected $_reg_custom_questions_form = null;
-
-
-    /**
-     *        constructor
-     *
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @return Registrations_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        add_action('wp_loaded', array($this, 'wp_loaded'));
-    }
-
-
-    public function wp_loaded()
-    {
-        // when adding a new registration...
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
-            EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
-                 || absint($this->_req_data['processing_registration']) !== 1
-            ) {
-                // and it's NOT the attendee information reg step
-                // force cookie expiration by setting time to last week
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
-                // and update the global
-                $_COOKIE['ee_registration_added'] = 0;
-            }
-        }
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REG_PG_SLUG;
-        $this->_admin_base_url  = REG_ADMIN_URL;
-        $this->_admin_base_path = REG_ADMIN;
-        $this->page_label       = esc_html__('Registrations', 'event_espresso');
-        $this->_cpt_routes      = array(
-            'add_new_attendee' => 'espresso_attendees',
-            'edit_attendee'    => 'espresso_attendees',
-            'insert_attendee'  => 'espresso_attendees',
-            'update_attendee'  => 'espresso_attendees',
-        );
-        $this->_cpt_model_names = array(
-            'add_new_attendee' => 'EEM_Attendee',
-            'edit_attendee'    => 'EEM_Attendee',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_attendees' => 'edit_attendee',
-        );
-        $this->_pagenow_map     = array(
-            'add_new_attendee' => 'post-new.php',
-            'edit_attendee'    => 'post.php',
-            'trash'            => 'post.php',
-        );
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
-        //add filters so that the comment urls don't take users to a confusing 404 page
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
-    }
-
-
-    public function clear_comment_link($link, $comment, $args)
-    {
-        //gotta make sure this only happens on this route
-        $post_type = get_post_type($comment->comment_post_ID);
-        if ($post_type === 'espresso_attendees') {
-            return '#commentsdiv';
-        }
-        return $link;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        //todo: all hooks for registrations ajax goes in here
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'                      => array(
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
-                'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
-                'contact_list_export' => esc_html__("Export Data", "event_espresso"),
-            ),
-            'publishbox'                   => array(
-                'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
-                'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
-            ),
-            'hide_add_button_on_cpt_route' => array(
-                'edit_attendee' => true,
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     */
-    public function _set_page_routes()
-    {
-        $this->_get_registration_status_array();
-        $reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID'] : 0;
-        $att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
-            ? $this->_req_data['ATT_ID'] : 0;
-        $att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
-            ? $this->_req_data['post']
-            : $att_id;
-        $this->_page_routes = array(
-            'default'                            => array(
-                'func'       => '_registrations_overview_list_table',
-                'capability' => 'ee_read_registrations',
-            ),
-            'view_registration'                  => array(
-                'func'       => '_registration_details',
-                'capability' => 'ee_read_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'edit_registration'                  => array(
-                'func'               => '_update_attendee_registration_form',
-                'noheader'           => true,
-                'headers_sent_route' => 'view_registration',
-                'capability'         => 'ee_edit_registration',
-                'obj_id'             => $reg_id,
-                '_REG_ID'            => $reg_id,
-            ),
-            'trash_registrations'                => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'restore_registrations'              => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'delete_registrations'               => array(
-                'func'       => '_delete_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'new_registration'                   => array(
-                'func'       => 'new_registration',
-                'capability' => 'ee_edit_registrations',
-            ),
-            'process_reg_step'                   => array(
-                'func'       => 'process_reg_step',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'redirect_to_txn'                    => array(
-                'func'       => 'redirect_to_txn',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'change_reg_status'                  => array(
-                'func'       => '_change_reg_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registration'               => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_and_notify_registration'    => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_registration'               => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_and_notify_registration'    => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_registration'               => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_and_notify_registration'    => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_registration'            => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_and_notify_registration' => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_registration'                => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_and_notify_registration'     => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'wait_list_registration' => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'contact_list'                       => array(
-                'func'       => '_attendee_contact_list_table',
-                'capability' => 'ee_read_contacts',
-            ),
-            'add_new_attendee'                   => array(
-                'func' => '_create_new_cpt_item',
-                'args' => array(
-                    'new_attendee' => true,
-                    'capability'   => 'ee_edit_contacts',
-                ),
-            ),
-            'edit_attendee'                      => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'duplicate_attendee'                 => array(
-                'func'       => '_duplicate_attendee',
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'insert_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-            ),
-            'update_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'trash_attendee'                    => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'restore_attendees'                  => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'resend_registration'                => array(
-                'func'       => '_resend_registration',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'registrations_report'               => array(
-                'func'       => '_registrations_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-            'contact_list_export'                => array(
-                'func'       => '_contact_list_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ),
-            'contact_list_report'                => array(
-                'func'       => '_contact_list_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_contacts',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'           => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 5,
-                ),
-                'help_tabs'     => array(
-                    'registrations_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
-                        'filename' => 'registrations_overview',
-                    ),
-                    'registrations_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_overview_table_column_headings',
-                    ),
-                    'registrations_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
-                        'filename' => 'registrations_overview_filters',
-                    ),
-                    'registrations_overview_views_help_tab'                 => array(
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
-                        'filename' => 'registrations_overview_views',
-                    ),
-                    'registrations_regoverview_other_help_tab'              => array(
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
-                        'filename' => 'registrations_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Registrations_List_Table',
-                'require_nonce' => false,
-            ),
-            'view_registration' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
-                    'order'      => 15,
-                    'url'        => isset($this->_req_data['_REG_ID'])
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'registrations_details_help_tab'                    => array(
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
-                        'filename' => 'registrations_details',
-                    ),
-                    'registrations_details_table_help_tab'              => array(
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
-                        'filename' => 'registrations_details_table',
-                    ),
-                    'registrations_details_form_answers_help_tab'       => array(
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
-                        'filename' => 'registrations_details_form_answers',
-                    ),
-                    'registrations_details_registrant_details_help_tab' => array(
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
-                        'filename' => 'registrations_details_registrant_details',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Details_Help_Tour'),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_registration_details_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'new_registration'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
-                    'url'        => '#',
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'labels'        => array(
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
-                ),
-                'require_nonce' => false,
-            ),
-            'add_new_attendee'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_publish_post_box', 'attendee_editor_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'edit_attendee'     => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['ATT_ID'])
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('attendee_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'contact_list'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Contact List', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
-                'help_tabs'     => array(
-                    'registrations_contact_list_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
-                        'filename' => 'registrations_contact_list',
-                    ),
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_table_column_headings',
-                    ),
-                    'registrations_contact_list_views_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_views',
-                    ),
-                    'registrations_contact_list_other_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_other',
-                    ),
-                ),
-                'help_tour'     => array('Contact_List_Help_Tour'),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            //override default cpt routes
-            'create_new'        => '',
-            'edit'              => '',
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
-            'click "Update Registration Questions" to save your changes',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access private
-     * @return void
-     */
-    private function _get_registration_status_array()
-    {
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_contact_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    public function load_scripts_styles()
-    {
-        //style
-        wp_register_style(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_reg');
-        //script
-        wp_register_script(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_reg');
-    }
-
-
-    public function load_scripts_styles_edit_attendee()
-    {
-        //stuff to only show up on our attendee edit details page.
-        $attendee_details_translations = array(
-            'att_publish_text' => sprintf(
-                esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
-                $this->_cpt_model_obj->get_datetime('ATT_created')
-            ),
-        );
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
-        wp_enqueue_script('jquery-validate');
-    }
-
-
-    public function load_scripts_styles_view_registration()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        //scripts
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
-    }
-
-
-    public function load_scripts_styles_contact_list()
-    {
-        wp_deregister_style('espresso_reg');
-        wp_register_style(
-            'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_att');
-    }
-
-
-    public function load_scripts_styles_new_registration()
-    {
-        wp_register_script(
-            'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
-            array('underscore', 'jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-spco-for-admin');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        EE_Form_Section_Proper::wp_enqueue_scripts();
-        EED_Ticket_Selector::load_tckt_slctr_assets();
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        //for notification related bulk actions we need to make sure only active messengers have an option.
-        EED_Messages::set_autoloaders();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts               = $message_resource_manager->list_of_active_message_types();
-        //key= bulk_action_slug, value= message type.
-        $match_array = array(
-            'approve_registration'    => 'registration',
-            'decline_registration'    => 'declined_registration',
-            'pending_registration'    => 'pending_approval',
-            'no_approve_registration' => 'not_approved_registration',
-            'cancel_registration'     => 'cancelled_registration',
-        );
-        $can_send = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'batch_send_messages'
-        );
-        /** setup reg status bulk actions **/
-        $def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registration'], $active_mts, true)) {
-                $def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
-                    'event_espresso');
-        }
-        $def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registration'], $active_mts, true)) {
-                $def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
-                    'event_espresso');
-        }
-        $def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
-        if ($can_send && in_array($match_array['pending_registration'], $active_mts, true)) {
-                $def_reg_status_actions['pending_and_notify_registration'] = __(
-                    'Set Registrations to Pending Payment and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
-        if ($can_send && in_array($match_array['no_approve_registration'], $active_mts, true)) {
-                $def_reg_status_actions['no_approve_and_notify_registration'] = __(
-                    'Set Registrations to Not Approved and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registration'], $active_mts, true)) {
-                $def_reg_status_actions['cancel_and_notify_registration'] = __(
-                    'Cancel Registrations and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
-            $def_reg_status_actions,
-            $active_mts
-        );
-
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => sprintf(
-                    esc_html__('Today - %s', 'event_espresso'),
-                    date('M d, Y', current_time('timestamp'))
-                ),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_registrations',
-            'espresso_registrations_delete_registration'
-        )) {
-            $this->_views['incomplete'] = array(
-                'slug'        => 'incomplete',
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                ),
-            );
-            $this->_views['trash']      = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_contact_list()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => esc_html__('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
-            'espresso_registrations_trash_attendees')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _registration_legend_items()
-    {
-        $fc_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-clipboard',
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-            ),
-            'edit_attendee'    => array(
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
-            ),
-            'view_transaction' => array(
-                'class' => 'dashicons dashicons-cart',
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-            ),
-            'view_invoice'     => array(
-                'class' => 'dashicons dashicons-media-spreadsheet',
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_resend_registration'
-        )) {
-            $fc_items['resend_registration'] = array(
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
-            );
-        } else {
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
-        }
-        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'])) {
-                $fc_items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        $sc_items = array(
-            'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_pending_payment,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_wait_list,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_incomplete,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_not_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_declined,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_cancelled,
-                    false,
-                    'sentence'
-                ),
-            ),
-        );
-        return array_merge($fc_items, $sc_items);
-    }
-
-
-
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
-    /**
-     * @throws \EE_Error
-     */
-    protected function _registrations_overview_list_table()
-    {
-        $this->_template_args['admin_page_header'] = '';
-        $EVT_ID                                    = ! empty($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : 0;
-        if ($EVT_ID) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $EVT_ID
-            )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                    'new_registration',
-                    'add-registrant',
-                    array('event_id' => $EVT_ID),
-                    'add-new-h2'
-                );
-            }
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            if ($event instanceof EE_Event) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%s Viewing registrations for the event: %s%s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<br /><a href="'
-                        . EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $event->ID(),
-                            ),
-                            EVENTS_ADMIN_URL
-                        )
-                        . '">&nbsp;'
-                        . $event->get('EVT_name')
-                        . '&nbsp;</a>&nbsp;',
-                    '</h3>'
-                );
-            }
-            $DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
-                $this->_template_args['admin_page_header'] = substr(
-                    $this->_template_args['admin_page_header'],
-                    0,
-                    -5
-                );
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
-                $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
-            }
-        }
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * This sets the _registration property for the registration details screen
-     *
-     * @access private
-     * @return bool
-     */
-    private function _set_registration_object()
-    {
-        //get out if we've already set the object
-        if (is_object($this->_registration)) {
-            return true;
-        }
-        $REG    = EEM_Registration::instance();
-        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
-            return true;
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for Registration ID #%s could not be retrieved.',
-                    'event_espresso'
-                ),
-                $REG_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_registration = null;
-            return false;
-        }
-    }
-
-
-    /**
-     * Used to retrieve registrations for the list table.
-     *
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $this_month
-     * @param bool $today
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     */
-    public function get_registrations(
-        $per_page = 10,
-        $count = false,
-        $this_month = false,
-        $today = false
-    ) {
-        if ($this_month) {
-            $this->_req_data['status'] = 'month';
-        }
-        if ($today) {
-            $this->_req_data['status'] = 'today';
-        }
-        $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see EEM_Base::get_all()
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
-
-
-
-    /**
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
-     * Note: this listens to values on the request for some of the query parameters.
-     *
-     * @param array $request
-     * @param int    $per_page
-     * @param bool   $count
-     * @return array
-     */
-    protected function _get_registration_query_parameters(
-        $request = array(),
-        $per_page = 10,
-        $count = false
-    ) {
-
-        $query_params = array(
-            0                          => $this->_get_where_conditions_for_registrations_query(
-                $request
-            ),
-            'caps'                     => EEM_Registration::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        );
-        if (! $count) {
-            $query_params = array_merge(
-                $query_params,
-                $this->_get_orderby_for_registrations_query(),
-                $this->_get_limit($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_event_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['event_id'])) {
-            $where['EVT_ID'] = absint($request['event_id']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_category_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
-            $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_datetime_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['datetime_id'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
-        }
-        if (! empty($request['DTT_ID'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_registration_status_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $registration_status = ! empty($request['_reg_status'])
-            ? sanitize_text_field($request['_reg_status'])
-            : '';
-
-        /*
+	/**
+	 * @var EE_Registration
+	 */
+	private $_registration;
+
+	/**
+	 * @var EE_Event
+	 */
+	private $_reg_event;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	private static $_reg_status;
+
+	/**
+	 * Form for displaying the custom questions for this registration.
+	 * This gets used a few times throughout the request so its best to cache it
+	 *
+	 * @var EE_Registration_Custom_Questions_Form
+	 */
+	protected $_reg_custom_questions_form = null;
+
+
+	/**
+	 *        constructor
+	 *
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @return Registrations_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		add_action('wp_loaded', array($this, 'wp_loaded'));
+	}
+
+
+	public function wp_loaded()
+	{
+		// when adding a new registration...
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
+			EE_System::do_not_cache();
+			if (! isset($this->_req_data['processing_registration'])
+				 || absint($this->_req_data['processing_registration']) !== 1
+			) {
+				// and it's NOT the attendee information reg step
+				// force cookie expiration by setting time to last week
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
+				// and update the global
+				$_COOKIE['ee_registration_added'] = 0;
+			}
+		}
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REG_PG_SLUG;
+		$this->_admin_base_url  = REG_ADMIN_URL;
+		$this->_admin_base_path = REG_ADMIN;
+		$this->page_label       = esc_html__('Registrations', 'event_espresso');
+		$this->_cpt_routes      = array(
+			'add_new_attendee' => 'espresso_attendees',
+			'edit_attendee'    => 'espresso_attendees',
+			'insert_attendee'  => 'espresso_attendees',
+			'update_attendee'  => 'espresso_attendees',
+		);
+		$this->_cpt_model_names = array(
+			'add_new_attendee' => 'EEM_Attendee',
+			'edit_attendee'    => 'EEM_Attendee',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_attendees' => 'edit_attendee',
+		);
+		$this->_pagenow_map     = array(
+			'add_new_attendee' => 'post-new.php',
+			'edit_attendee'    => 'post.php',
+			'trash'            => 'post.php',
+		);
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
+		//add filters so that the comment urls don't take users to a confusing 404 page
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
+	}
+
+
+	public function clear_comment_link($link, $comment, $args)
+	{
+		//gotta make sure this only happens on this route
+		$post_type = get_post_type($comment->comment_post_ID);
+		if ($post_type === 'espresso_attendees') {
+			return '#commentsdiv';
+		}
+		return $link;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		//todo: all hooks for registrations ajax goes in here
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'                      => array(
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
+				'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
+				'contact_list_export' => esc_html__("Export Data", "event_espresso"),
+			),
+			'publishbox'                   => array(
+				'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
+				'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
+			),
+			'hide_add_button_on_cpt_route' => array(
+				'edit_attendee' => true,
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function _set_page_routes()
+	{
+		$this->_get_registration_status_array();
+		$reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID'] : 0;
+		$att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
+			? $this->_req_data['ATT_ID'] : 0;
+		$att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
+			? $this->_req_data['post']
+			: $att_id;
+		$this->_page_routes = array(
+			'default'                            => array(
+				'func'       => '_registrations_overview_list_table',
+				'capability' => 'ee_read_registrations',
+			),
+			'view_registration'                  => array(
+				'func'       => '_registration_details',
+				'capability' => 'ee_read_registration',
+				'obj_id'     => $reg_id,
+			),
+			'edit_registration'                  => array(
+				'func'               => '_update_attendee_registration_form',
+				'noheader'           => true,
+				'headers_sent_route' => 'view_registration',
+				'capability'         => 'ee_edit_registration',
+				'obj_id'             => $reg_id,
+				'_REG_ID'            => $reg_id,
+			),
+			'trash_registrations'                => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'restore_registrations'              => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'delete_registrations'               => array(
+				'func'       => '_delete_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'new_registration'                   => array(
+				'func'       => 'new_registration',
+				'capability' => 'ee_edit_registrations',
+			),
+			'process_reg_step'                   => array(
+				'func'       => 'process_reg_step',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'redirect_to_txn'                    => array(
+				'func'       => 'redirect_to_txn',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'change_reg_status'                  => array(
+				'func'       => '_change_reg_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registration'               => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_and_notify_registration'    => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_registration'               => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_and_notify_registration'    => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_registration'               => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_and_notify_registration'    => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_registration'            => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_and_notify_registration' => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_registration'                => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_and_notify_registration'     => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'wait_list_registration' => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'contact_list'                       => array(
+				'func'       => '_attendee_contact_list_table',
+				'capability' => 'ee_read_contacts',
+			),
+			'add_new_attendee'                   => array(
+				'func' => '_create_new_cpt_item',
+				'args' => array(
+					'new_attendee' => true,
+					'capability'   => 'ee_edit_contacts',
+				),
+			),
+			'edit_attendee'                      => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'duplicate_attendee'                 => array(
+				'func'       => '_duplicate_attendee',
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'insert_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+			),
+			'update_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'trash_attendee'                    => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'restore_attendees'                  => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'resend_registration'                => array(
+				'func'       => '_resend_registration',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'registrations_report'               => array(
+				'func'       => '_registrations_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+			'contact_list_export'                => array(
+				'func'       => '_contact_list_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			),
+			'contact_list_report'                => array(
+				'func'       => '_contact_list_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_contacts',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'           => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 5,
+				),
+				'help_tabs'     => array(
+					'registrations_overview_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
+						'filename' => 'registrations_overview',
+					),
+					'registrations_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_overview_table_column_headings',
+					),
+					'registrations_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
+						'filename' => 'registrations_overview_filters',
+					),
+					'registrations_overview_views_help_tab'                 => array(
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
+						'filename' => 'registrations_overview_views',
+					),
+					'registrations_regoverview_other_help_tab'              => array(
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
+						'filename' => 'registrations_overview_other',
+					),
+				),
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Registrations_List_Table',
+				'require_nonce' => false,
+			),
+			'view_registration' => array(
+				'nav'           => array(
+					'label'      => esc_html__('REG Details', 'event_espresso'),
+					'order'      => 15,
+					'url'        => isset($this->_req_data['_REG_ID'])
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'registrations_details_help_tab'                    => array(
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
+						'filename' => 'registrations_details',
+					),
+					'registrations_details_table_help_tab'              => array(
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
+						'filename' => 'registrations_details_table',
+					),
+					'registrations_details_form_answers_help_tab'       => array(
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
+						'filename' => 'registrations_details_form_answers',
+					),
+					'registrations_details_registrant_details_help_tab' => array(
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
+						'filename' => 'registrations_details_registrant_details',
+					),
+				),
+				'help_tour'     => array('Registration_Details_Help_Tour'),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_registration_details_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'new_registration'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
+					'url'        => '#',
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'labels'        => array(
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
+				),
+				'require_nonce' => false,
+			),
+			'add_new_attendee'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_publish_post_box', 'attendee_editor_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'edit_attendee'     => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['ATT_ID'])
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('attendee_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'contact_list'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Contact List', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
+				'help_tabs'     => array(
+					'registrations_contact_list_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
+						'filename' => 'registrations_contact_list',
+					),
+					'registrations_contact-list_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_contact_list_table_column_headings',
+					),
+					'registrations_contact_list_views_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
+						'filename' => 'registrations_contact_list_views',
+					),
+					'registrations_contact_list_other_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
+						'filename' => 'registrations_contact_list_other',
+					),
+				),
+				'help_tour'     => array('Contact_List_Help_Tour'),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			//override default cpt routes
+			'create_new'        => '',
+			'edit'              => '',
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
+			'click "Update Registration Questions" to save your changes',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _get_registration_status_array()
+	{
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_contact_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	public function load_scripts_styles()
+	{
+		//style
+		wp_register_style(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_reg');
+		//script
+		wp_register_script(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_reg');
+	}
+
+
+	public function load_scripts_styles_edit_attendee()
+	{
+		//stuff to only show up on our attendee edit details page.
+		$attendee_details_translations = array(
+			'att_publish_text' => sprintf(
+				esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
+				$this->_cpt_model_obj->get_datetime('ATT_created')
+			),
+		);
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
+		wp_enqueue_script('jquery-validate');
+	}
+
+
+	public function load_scripts_styles_view_registration()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		//scripts
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
+	}
+
+
+	public function load_scripts_styles_contact_list()
+	{
+		wp_deregister_style('espresso_reg');
+		wp_register_style(
+			'espresso_att',
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_att');
+	}
+
+
+	public function load_scripts_styles_new_registration()
+	{
+		wp_register_script(
+			'ee-spco-for-admin',
+			REG_ASSETS_URL . 'spco_for_admin.js',
+			array('underscore', 'jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-spco-for-admin');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		EE_Form_Section_Proper::wp_enqueue_scripts();
+		EED_Ticket_Selector::load_tckt_slctr_assets();
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		//for notification related bulk actions we need to make sure only active messengers have an option.
+		EED_Messages::set_autoloaders();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts               = $message_resource_manager->list_of_active_message_types();
+		//key= bulk_action_slug, value= message type.
+		$match_array = array(
+			'approve_registration'    => 'registration',
+			'decline_registration'    => 'declined_registration',
+			'pending_registration'    => 'pending_approval',
+			'no_approve_registration' => 'not_approved_registration',
+			'cancel_registration'     => 'cancelled_registration',
+		);
+		$can_send = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'batch_send_messages'
+		);
+		/** setup reg status bulk actions **/
+		$def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registration'], $active_mts, true)) {
+				$def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
+					'event_espresso');
+		}
+		$def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registration'], $active_mts, true)) {
+				$def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
+					'event_espresso');
+		}
+		$def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
+		if ($can_send && in_array($match_array['pending_registration'], $active_mts, true)) {
+				$def_reg_status_actions['pending_and_notify_registration'] = __(
+					'Set Registrations to Pending Payment and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
+		if ($can_send && in_array($match_array['no_approve_registration'], $active_mts, true)) {
+				$def_reg_status_actions['no_approve_and_notify_registration'] = __(
+					'Set Registrations to Not Approved and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registration'], $active_mts, true)) {
+				$def_reg_status_actions['cancel_and_notify_registration'] = __(
+					'Cancel Registrations and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
+			$def_reg_status_actions,
+			$active_mts
+		);
+
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => sprintf(
+					esc_html__('Today - %s', 'event_espresso'),
+					date('M d, Y', current_time('timestamp'))
+				),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_registrations',
+			'espresso_registrations_delete_registration'
+		)) {
+			$this->_views['incomplete'] = array(
+				'slug'        => 'incomplete',
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				),
+			);
+			$this->_views['trash']      = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_contact_list()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => esc_html__('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
+			'espresso_registrations_trash_attendees')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _registration_legend_items()
+	{
+		$fc_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-clipboard',
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+			),
+			'edit_attendee'    => array(
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
+			),
+			'view_transaction' => array(
+				'class' => 'dashicons dashicons-cart',
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+			),
+			'view_invoice'     => array(
+				'class' => 'dashicons dashicons-media-spreadsheet',
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_resend_registration'
+		)) {
+			$fc_items['resend_registration'] = array(
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
+			);
+		} else {
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
+		}
+		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'])) {
+				$fc_items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		$sc_items = array(
+			'approved_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_approved,
+					false,
+					'sentence'
+				),
+			),
+			'pending_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_pending_payment,
+					false,
+					'sentence'
+				),
+			),
+			'wait_list'         => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_wait_list,
+					false,
+					'sentence'
+				),
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_incomplete,
+					false,
+					'sentence'
+				),
+			),
+			'not_approved'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_not_approved,
+					false,
+					'sentence'
+				),
+			),
+			'declined_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_declined,
+					false,
+					'sentence'
+				),
+			),
+			'cancelled_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_cancelled,
+					false,
+					'sentence'
+				),
+			),
+		);
+		return array_merge($fc_items, $sc_items);
+	}
+
+
+
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
+	/**
+	 * @throws \EE_Error
+	 */
+	protected function _registrations_overview_list_table()
+	{
+		$this->_template_args['admin_page_header'] = '';
+		$EVT_ID                                    = ! empty($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: 0;
+		if ($EVT_ID) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$EVT_ID
+			)) {
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+					'new_registration',
+					'add-registrant',
+					array('event_id' => $EVT_ID),
+					'add-new-h2'
+				);
+			}
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			if ($event instanceof EE_Event) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%s Viewing registrations for the event: %s%s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<br /><a href="'
+						. EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $event->ID(),
+							),
+							EVENTS_ADMIN_URL
+						)
+						. '">&nbsp;'
+						. $event->get('EVT_name')
+						. '&nbsp;</a>&nbsp;',
+					'</h3>'
+				);
+			}
+			$DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
+				$this->_template_args['admin_page_header'] = substr(
+					$this->_template_args['admin_page_header'],
+					0,
+					-5
+				);
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
+				$this->_template_args['admin_page_header'] .= $datetime->name();
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
+			}
+		}
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * This sets the _registration property for the registration details screen
+	 *
+	 * @access private
+	 * @return bool
+	 */
+	private function _set_registration_object()
+	{
+		//get out if we've already set the object
+		if (is_object($this->_registration)) {
+			return true;
+		}
+		$REG    = EEM_Registration::instance();
+		$REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
+			return true;
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for Registration ID #%s could not be retrieved.',
+					'event_espresso'
+				),
+				$REG_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_registration = null;
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used to retrieve registrations for the list table.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $this_month
+	 * @param bool $today
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 */
+	public function get_registrations(
+		$per_page = 10,
+		$count = false,
+		$this_month = false,
+		$today = false
+	) {
+		if ($this_month) {
+			$this->_req_data['status'] = 'month';
+		}
+		if ($today) {
+			$this->_req_data['status'] = 'today';
+		}
+		$query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see EEM_Base::get_all()
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
+	 * Note: this listens to values on the request for some of the query parameters.
+	 *
+	 * @param array $request
+	 * @param int    $per_page
+	 * @param bool   $count
+	 * @return array
+	 */
+	protected function _get_registration_query_parameters(
+		$request = array(),
+		$per_page = 10,
+		$count = false
+	) {
+
+		$query_params = array(
+			0                          => $this->_get_where_conditions_for_registrations_query(
+				$request
+			),
+			'caps'                     => EEM_Registration::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		);
+		if (! $count) {
+			$query_params = array_merge(
+				$query_params,
+				$this->_get_orderby_for_registrations_query(),
+				$this->_get_limit($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_event_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['event_id'])) {
+			$where['EVT_ID'] = absint($request['event_id']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_category_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
+			$where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_datetime_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['datetime_id'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
+		}
+		if (! empty($request['DTT_ID'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_registration_status_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$registration_status = ! empty($request['_reg_status'])
+			? sanitize_text_field($request['_reg_status'])
+			: '';
+
+		/*
          * If filtering by registration status, then we show registrations matching that status.
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
-            $where['STS_ID'] = $registration_status;
-        } else {
-            //make sure we exclude incomplete registrations, but only if not trashed.
-            if ($view === 'trash') {
-                $where['REG_deleted'] = true;
-            } elseif ($view === 'incomplete') {
-                $where['STS_ID'] = EEM_Registration::status_id_incomplete;
-            } else {
-                $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _add_date_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $month_range             = ! empty($request['month_range'])
-            ? sanitize_text_field($request['month_range'])
-            : '';
-        $retrieve_for_today      = $view === 'today';
-        $retrieve_for_this_month = $view === 'month';
-
-        if ($retrieve_for_today) {
-            $now               = date('Y-m-d', current_time('timestamp'));
-            $where['REG_date'] = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($retrieve_for_this_month) {
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
-            $days_this_month        = date('t', current_time('timestamp'));
-            $where['REG_date']      = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($month_range) {
-            $pieces          = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested  = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            //if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $where['REG_date'] = array(
-                    'BETWEEN',
-                    array(
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s'
-                        ),
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s'
-                        ),
-                    ),
-                );
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_search_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
-            $where['OR*search_conditions'] = array(
-                'Event.EVT_name'                          => array('LIKE', $search_string),
-                'Event.EVT_desc'                          => array('LIKE', $search_string),
-                'Event.EVT_short_desc'                    => array('LIKE', $search_string),
-                'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
-                'Attendee.ATT_fname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_lname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
-                'Attendee.ATT_email'                      => array('LIKE', $search_string),
-                'Attendee.ATT_address'                    => array('LIKE', $search_string),
-                'Attendee.ATT_address2'                   => array('LIKE', $search_string),
-                'Attendee.ATT_city'                       => array('LIKE', $search_string),
-                'REG_final_price'                         => array('LIKE', $search_string),
-                'REG_code'                                => array('LIKE', $search_string),
-                'REG_count'                               => array('LIKE', $search_string),
-                'REG_group_size'                          => array('LIKE', $search_string),
-                'Ticket.TKT_name'                         => array('LIKE', $search_string),
-                'Ticket.TKT_description'                  => array('LIKE', $search_string),
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
-            );
-        }
-        return $where;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param array $request
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_where_conditions_for_registrations_query($request)
-    {
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            array_merge(
-                $this->_add_event_id_to_where_conditions($request),
-                $this->_add_category_id_to_where_conditions($request),
-                $this->_add_datetime_id_to_where_conditions($request),
-                $this->_add_registration_status_to_where_conditions($request),
-                $this->_add_date_to_where_conditions($request),
-                $this->_add_search_to_where_conditions($request)
-            ),
-            $request
-        );
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function _get_orderby_for_registrations_query()
-    {
-        $orderby_field = ! empty($this->_req_data['orderby'])
-            ? sanitize_text_field($this->_req_data['orderby'])
-            : '';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby_field = 'REG_ID';
-                break;
-            case '_Reg_status':
-                $orderby_field = 'STS_ID';
-                break;
-            case 'ATT_fname':
-                $orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
-                break;
-            case 'ATT_lname':
-                $orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
-                break;
-            case 'event_name':
-                $orderby_field = 'Event.EVT_name';
-                break;
-            case 'DTT_EVT_start':
-                $orderby_field = 'Event.Datetime.DTT_EVT_start';
-                break;
-            default: //'REG_date'
-                $orderby_field = 'REG_date';
-        }
-
-        //order
-        $order = ! empty($this->_req_data['order'])
-            ? sanitize_text_field($this->_req_data['order'])
-            : 'DESC';
-
-        //mutate orderby_field
-        $orderby_field = array_combine(
-            (array) $orderby_field,
-            array_fill(0, count($orderby_field), $order)
-        );
-        return array('order_by' => $orderby_field);
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param $per_page
-     * @return array
-     */
-    protected function _get_limit($per_page)
-    {
-        $current_page = ! empty($this->_req_data['paged'])
-            ? absint($this->_req_data['paged'])
-            : 1;
-        $per_page     = ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-
-        //-1 means return all results so get out if that's set.
-        if ((int)$per_page === -1) {
-            return array();
-        }
-        $per_page = absint($per_page);
-        $offset   = ($current_page - 1) * $per_page;
-        return array('limit' => array($offset, $per_page));
-    }
-
-
-    public function get_registration_status_array()
-    {
-        return self::$_reg_status;
-    }
-
-
-
-
-    /***************************************        REGISTRATION DETAILS        ***************************************/
-    /**
-     *        generates HTML for the View Registration Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _registration_details()
-    {
-        $this->_template_args = array();
-        $this->_set_registration_object();
-        if (is_object($this->_registration)) {
-            $transaction                                   = $this->_registration->transaction()
-                ? $this->_registration->transaction()
-                : EE_Transaction::new_instance();
-            $this->_session                                = $transaction->session_data();
-            $event_id                                      = $this->_registration->event_ID();
-            $this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
-            $this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
-            $this->_template_args['grand_total']           = $transaction->total();
-            $this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
-            // link back to overview
-            $this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
-            $this->_template_args['registration']                = $this->_registration;
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'default',
-                    'event_id' => $event_id,
-                ),
-                REG_ADMIN_URL
-            );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event_id,
-                    'page'   => 'espresso_transactions',
-                ),
-                admin_url('admin.php')
-            );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_events',
-                    'action' => 'edit',
-                    'post'   => $event_id,
-                ),
-                admin_url('admin.php')
-            );
-            //next and previous links
-            $next_reg                                      = $this->_registration->next(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['next_registration']     = $next_reg
-                ? $this->_next_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $next_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
-                )
-                : '';
-            $previous_reg                                  = $this->_registration->previous(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['previous_registration'] = $previous_reg
-                ? $this->_previous_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $previous_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
-                )
-                : '';
-            // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
-            $this->_template_args['REG_ID']            = $this->_registration->ID();
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-        } else {
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
-        }
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _registration_details_metaboxes()
-    {
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
-        $this->_set_registration_object();
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
-        add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
-            array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
-        add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
-            array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'edit-reg-questions-mbox'
-            )
-        ) {
-            add_meta_box(
-                'edit-reg-questions-mbox',
-                esc_html__('Registration Form Answers', 'event_espresso'),
-                array($this, '_reg_questions_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-        add_meta_box(
-            'edit-reg-registrant-mbox',
-            esc_html__('Contact Details', 'event_espresso'),
-            array($this, '_reg_registrant_side_meta_box'),
-            $this->wp_page_slug,
-            'side',
-            'high'
-        );
-        if ($this->_registration->group_size() > 1) {
-            add_meta_box(
-                'edit-reg-attendees-mbox',
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
-                array($this, '_reg_attendees_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-    }
-
-
-    /**
-     * set_reg_status_buttons_metabox
-     *
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    public function set_reg_status_buttons_metabox()
-    {
-        $this->_set_registration_object();
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
-        echo $change_reg_status_form->form_open(
-            self::add_query_args_and_nonce(
-                array(
-                    'action' => 'change_reg_status',
-                ),
-                REG_ADMIN_URL
-            )
-        );
-        echo $change_reg_status_form->get_html();
-        echo $change_reg_status_form->form_close();
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_reg_status_change_form()
-    {
-        return new EE_Form_Section_Proper(array(
-            'name'            => 'reg_status_change_form',
-            'html_id'         => 'reg-status-change-form',
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-            'subsections'     => array(
-                'return'             => new EE_Hidden_Input(array(
-                    'name'    => 'return',
-                    'default' => 'view_registration',
-                )),
-                'REG_ID'             => new EE_Hidden_Input(array(
-                    'name'    => 'REG_ID',
-                    'default' => $this->_registration->ID(),
-                )),
-                'current_status'     => new EE_Form_Section_HTML(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
-                                )
-                            )
-                        )
-                        . EEH_HTML::td(
-                            EEH_HTML::strong(
-                                $this->_registration->pretty_status(),
-                                '',
-                                'status-' . $this->_registration->status_ID(),
-                                'line-height: 1em; font-size: 1.5em; font-weight: bold;'
-                            )
-                        )
-                    )
-                ),
-                'reg_status'         => new EE_Select_Input(
-                    $this->_get_reg_statuses(),
-                    array(
-                        'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
-                        'default'         => $this->_registration->status_ID(),
-                    )
-                ),
-                'send_notifications' => new EE_Yes_No_Input(
-                    array(
-                        'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
-                        'default'         => false,
-                        'html_help_text'  => esc_html__(
-                            'If set to "Yes", then the related messages will be sent to the registrant.',
-                            'event_espresso'
-                        ),
-                    )
-                ),
-                'submit'             => new EE_Submit_Input(
-                    array(
-                        'html_class'      => 'button-primary',
-                        'html_label_text' => '&nbsp;',
-                        'default'         => esc_html__('Update Registration Status', 'event_espresso'),
-                    )
-                ),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns an array of all the buttons for the various statuses and switch status actions
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _get_reg_statuses()
-    {
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
-        unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
-        // get current reg status
-        $current_status = $this->_registration->status_ID();
-        // is registration for free event? This will determine whether to display the pending payment option
-        if (
-            $current_status !== EEM_Registration::status_id_pending_payment
-            && $this->_registration->transaction()->is_free()
-        ) {
-            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
-        }
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
-    }
-
-
-
-    /**
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
-     *
-     * @param bool $status REG status given for changing registrations to.
-     * @param bool $notify Whether to send messages notifications or not.
-     * @return array  (array with reg_id(s) updated and whether update was successful.
-     * @throws \EE_Error
-     */
-    protected function _set_registration_status_from_request($status = false, $notify = false)
-    {
-        if (isset($this->_req_data['reg_status_change_form'])) {
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
-        } else {
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
-        }
-        $success = $this->_set_registration_status($REG_IDs, $status);
-        //notify?
-        if ($success
-            && $notify
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $success;
-    }
-
-
-
-    /**
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
-     *
-     * @param array $REG_IDs
-     * @param bool  $status
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     *               the array of updated registrations).
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    protected function _set_registration_status($REG_IDs = array(), $status = false)
-    {
-        $success = false;
-        // typecast $REG_IDs
-        $REG_IDs = (array)$REG_IDs;
-        if ( ! empty($REG_IDs)) {
-            $success = true;
-            // set default status if none is passed
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
-            // sanitize $REG_IDs
-            $REG_IDs = array_filter($REG_IDs, 'absint');
-            //loop through REG_ID's and change status
-            foreach ($REG_IDs as $REG_ID) {
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_status($status);
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-        //reset _req_data['_REG_ID'] for any potential future messages notifications
-        $this->_req_data['_REG_ID'] = $REG_IDs;
-        //return $success and processed registrations
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
-    }
-
-
-    /**
-     * Common logic for setting up success message and redirecting to appropriate route
-     *
-     * @param  string $STS_ID status id for the registration changed to
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
-     * @return void
-     */
-    protected function _reg_status_change_return($STS_ID, $notify = false)
-    {
-        $result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
-            : array('success' => false);
-        $success = isset($result['success']) && $result['success'];
-        //setup success message
-        if ($success) {
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
-                $msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            } else {
-                $msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            }
-            EE_Error::add_success($msg);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong, and the status was not changed',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-        }
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
-        } else {
-            $route = array('action' => 'default');
-        }
-        //unset nonces
-        foreach ($this->_req_data as $ref => $value) {
-            if (strpos($ref, 'nonce') !== false) {
-                unset($this->_req_data[$ref]);
-                continue;
-            }
-            $value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
-            $this->_req_data[$ref] = $value;
-        }
-        //merge request vars so that the reloaded list table contains any existing filter query params
-        $route = array_merge($this->_req_data, $route);
-        $this->_redirect_after_action($success, '', '', $route, true);
-    }
-
-
-    /**
-     * incoming reg status change from reg details page.
-     *
-     * @return void
-     */
-    protected function _change_reg_status()
-    {
-        $this->_req_data['return'] = 'view_registration';
-        //set notify based on whether the send notifications toggle is set or not
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
-        //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
-            case EEM_Registration::status_id_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
-                $this->approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_pending_payment :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
-                $this->pending_registration($notify);
-                break;
-            case EEM_Registration::status_id_not_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
-                $this->not_approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_declined :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
-                $this->decline_registration($notify);
-                break;
-            case EEM_Registration::status_id_cancelled :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
-                $this->cancel_registration($notify);
-                break;
-            case EEM_Registration::status_id_wait_list :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
-                $this->wait_list_registration($notify);
-                break;
-            case EEM_Registration::status_id_incomplete :
-            default :
-                $result['success'] = false;
-                unset($this->_req_data['return']);
-                $this->_reg_status_change_return('', false);
-                break;
-        }
-    }
-
-
-    /**
-     * approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their approval.
-     * @return void
-     */
-    protected function approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function decline_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
-    }
-
-
-    /**
-     *        cancel_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function cancel_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
-    }
-
-
-    /**
-     *        not_approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function not_approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function pending_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
-    }
-
-
-    /**
-     * waitlist_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function wait_list_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    public function _reg_details_meta_box()
-    {
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        EEH_Autoloader::register_line_item_filter_autoloaders();
-        EE_Registry::instance()->load_helper('Line_Item');
-        $transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
-            : EE_Transaction::new_instance();
-        $this->_session = $transaction->session_data();
-        $filters        = new EE_Line_Item_Filter_Collection();
-        //$filters->add( new EE_Non_Zero_Line_Item_Filter() );
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
-            $transaction->total_line_item());
-        $filtered_line_item_tree                 = $line_item_filter_processor->process();
-        $line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
-            $filtered_line_item_tree,
-            array('EE_Registration' => $this->_registration)
-        );
-        $attendee                                = $this->_registration->attendee();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction'
-        )) {
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' View Transaction', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-cart'
-            );
-        } else {
-            $this->_template_args['view_transaction_button'] = '';
-        }
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'      => 'resend_registration',
-                        '_REG_ID'     => $this->_registration->ID(),
-                        'redirect_to' => 'view_registration',
-                    ),
-                    REG_ADMIN_URL
-                ),
-                esc_html__(' Resend Registration', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-email-alt'
-            );
-        } else {
-            $this->_template_args['resend_registration_button'] = '';
-        }
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        $payment                               = $transaction->get_first_related('Payment');
-        $payment                               = ! $payment instanceof EE_Payment
-            ? EE_Payment::new_instance()
-            : $payment;
-        $payment_method                        = $payment->get_first_related('Payment_Method');
-        $payment_method                        = ! $payment_method instanceof EE_Payment_Method
-            ? EE_Payment_Method::new_instance()
-            : $payment_method;
-        $reg_details                           = array(
-            'payment_method'       => $payment_method->name(),
-            'response_msg'         => $payment->gateway_response(),
-            'registration_id'      => $this->_registration->get('REG_code'),
-            'registration_session' => $this->_registration->session_ID(),
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
-        );
-        if (isset($reg_details['registration_id'])) {
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
-                'Registration ID',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
-        }
-        if (isset($reg_details['payment_method'])) {
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
-                'Most Recent Payment Method',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
-            $this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
-            $this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
-                'Payment method response',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
-        }
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
-        $this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
-            'Registration placed from IP',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
-        $this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
-        $this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
-            'event_espresso');
-        $this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
-        $this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'   => 'default',
-                'event_id' => $this->_registration->event_ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $this->_template_args['REG_ID']                                       = $this->_registration->ID();
-        $this->_template_args['event_id']                                     = $this->_registration->event_ID();
-        $template_path                                                        =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * generates HTML for the Registration Questions meta box.
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
-     * otherwise uses new forms system
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_questions_meta_box()
-    {
-        //allow someone to override this method entirely
-        if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
-            $this->_registration)) {
-            $form                                              = $this->_get_reg_custom_questions_form(
-                $this->_registration->ID()
-            );
-            $this->_template_args['att_questions']             = count($form->subforms()) > 0
-                ? $form->get_html_and_js()
-                : '';
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
-            $this->_template_args['REG_ID']                    = $this->_registration->ID();
-            $template_path                                     =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
-        }
-    }
-
-
-    /**
-     * form_before_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_before_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+		if (! empty($registration_status)) {
+			$where['STS_ID'] = $registration_status;
+		} else {
+			//make sure we exclude incomplete registrations, but only if not trashed.
+			if ($view === 'trash') {
+				$where['REG_deleted'] = true;
+			} elseif ($view === 'incomplete') {
+				$where['STS_ID'] = EEM_Registration::status_id_incomplete;
+			} else {
+				$where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _add_date_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$month_range             = ! empty($request['month_range'])
+			? sanitize_text_field($request['month_range'])
+			: '';
+		$retrieve_for_today      = $view === 'today';
+		$retrieve_for_this_month = $view === 'month';
+
+		if ($retrieve_for_today) {
+			$now               = date('Y-m-d', current_time('timestamp'));
+			$where['REG_date'] = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($retrieve_for_this_month) {
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
+			$days_this_month        = date('t', current_time('timestamp'));
+			$where['REG_date']      = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($month_range) {
+			$pieces          = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested  = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			//if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$where['REG_date'] = array(
+					'BETWEEN',
+					array(
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s'
+						),
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s'
+						),
+					),
+				);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_search_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['s'])) {
+			$search_string = '%' . sanitize_text_field($request['s']) . '%';
+			$where['OR*search_conditions'] = array(
+				'Event.EVT_name'                          => array('LIKE', $search_string),
+				'Event.EVT_desc'                          => array('LIKE', $search_string),
+				'Event.EVT_short_desc'                    => array('LIKE', $search_string),
+				'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
+				'Attendee.ATT_fname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_lname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
+				'Attendee.ATT_email'                      => array('LIKE', $search_string),
+				'Attendee.ATT_address'                    => array('LIKE', $search_string),
+				'Attendee.ATT_address2'                   => array('LIKE', $search_string),
+				'Attendee.ATT_city'                       => array('LIKE', $search_string),
+				'REG_final_price'                         => array('LIKE', $search_string),
+				'REG_code'                                => array('LIKE', $search_string),
+				'REG_count'                               => array('LIKE', $search_string),
+				'REG_group_size'                          => array('LIKE', $search_string),
+				'Ticket.TKT_name'                         => array('LIKE', $search_string),
+				'Ticket.TKT_description'                  => array('LIKE', $search_string),
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
+			);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param array $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_where_conditions_for_registrations_query($request)
+	{
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			array_merge(
+				$this->_add_event_id_to_where_conditions($request),
+				$this->_add_category_id_to_where_conditions($request),
+				$this->_add_datetime_id_to_where_conditions($request),
+				$this->_add_registration_status_to_where_conditions($request),
+				$this->_add_date_to_where_conditions($request),
+				$this->_add_search_to_where_conditions($request)
+			),
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function _get_orderby_for_registrations_query()
+	{
+		$orderby_field = ! empty($this->_req_data['orderby'])
+			? sanitize_text_field($this->_req_data['orderby'])
+			: '';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby_field = 'REG_ID';
+				break;
+			case '_Reg_status':
+				$orderby_field = 'STS_ID';
+				break;
+			case 'ATT_fname':
+				$orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
+				break;
+			case 'ATT_lname':
+				$orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
+				break;
+			case 'event_name':
+				$orderby_field = 'Event.EVT_name';
+				break;
+			case 'DTT_EVT_start':
+				$orderby_field = 'Event.Datetime.DTT_EVT_start';
+				break;
+			default: //'REG_date'
+				$orderby_field = 'REG_date';
+		}
+
+		//order
+		$order = ! empty($this->_req_data['order'])
+			? sanitize_text_field($this->_req_data['order'])
+			: 'DESC';
+
+		//mutate orderby_field
+		$orderby_field = array_combine(
+			(array) $orderby_field,
+			array_fill(0, count($orderby_field), $order)
+		);
+		return array('order_by' => $orderby_field);
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param $per_page
+	 * @return array
+	 */
+	protected function _get_limit($per_page)
+	{
+		$current_page = ! empty($this->_req_data['paged'])
+			? absint($this->_req_data['paged'])
+			: 1;
+		$per_page     = ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+
+		//-1 means return all results so get out if that's set.
+		if ((int)$per_page === -1) {
+			return array();
+		}
+		$per_page = absint($per_page);
+		$offset   = ($current_page - 1) * $per_page;
+		return array('limit' => array($offset, $per_page));
+	}
+
+
+	public function get_registration_status_array()
+	{
+		return self::$_reg_status;
+	}
+
+
+
+
+	/***************************************        REGISTRATION DETAILS        ***************************************/
+	/**
+	 *        generates HTML for the View Registration Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _registration_details()
+	{
+		$this->_template_args = array();
+		$this->_set_registration_object();
+		if (is_object($this->_registration)) {
+			$transaction                                   = $this->_registration->transaction()
+				? $this->_registration->transaction()
+				: EE_Transaction::new_instance();
+			$this->_session                                = $transaction->session_data();
+			$event_id                                      = $this->_registration->event_ID();
+			$this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
+			$this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
+			$this->_template_args['grand_total']           = $transaction->total();
+			$this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
+			// link back to overview
+			$this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
+			$this->_template_args['registration']                = $this->_registration;
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'default',
+					'event_id' => $event_id,
+				),
+				REG_ADMIN_URL
+			);
+			$this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event_id,
+					'page'   => 'espresso_transactions',
+				),
+				admin_url('admin.php')
+			);
+			$this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_events',
+					'action' => 'edit',
+					'post'   => $event_id,
+				),
+				admin_url('admin.php')
+			);
+			//next and previous links
+			$next_reg                                      = $this->_registration->next(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['next_registration']     = $next_reg
+				? $this->_next_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $next_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-right ee-icon-size-22'
+				)
+				: '';
+			$previous_reg                                  = $this->_registration->previous(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['previous_registration'] = $previous_reg
+				? $this->_previous_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $previous_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-left ee-icon-size-22'
+				)
+				: '';
+			// grab header
+			$template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+			$this->_template_args['REG_ID']            = $this->_registration->ID();
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+		} else {
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
+		}
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _registration_details_metaboxes()
+	{
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
+		$this->_set_registration_object();
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
+		add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
+			array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
+		add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
+			array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'edit-reg-questions-mbox'
+			)
+		) {
+			add_meta_box(
+				'edit-reg-questions-mbox',
+				esc_html__('Registration Form Answers', 'event_espresso'),
+				array($this, '_reg_questions_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+		add_meta_box(
+			'edit-reg-registrant-mbox',
+			esc_html__('Contact Details', 'event_espresso'),
+			array($this, '_reg_registrant_side_meta_box'),
+			$this->wp_page_slug,
+			'side',
+			'high'
+		);
+		if ($this->_registration->group_size() > 1) {
+			add_meta_box(
+				'edit-reg-attendees-mbox',
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
+				array($this, '_reg_attendees_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+	}
+
+
+	/**
+	 * set_reg_status_buttons_metabox
+	 *
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function set_reg_status_buttons_metabox()
+	{
+		$this->_set_registration_object();
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
+		echo $change_reg_status_form->form_open(
+			self::add_query_args_and_nonce(
+				array(
+					'action' => 'change_reg_status',
+				),
+				REG_ADMIN_URL
+			)
+		);
+		echo $change_reg_status_form->get_html();
+		echo $change_reg_status_form->form_close();
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_reg_status_change_form()
+	{
+		return new EE_Form_Section_Proper(array(
+			'name'            => 'reg_status_change_form',
+			'html_id'         => 'reg-status-change-form',
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+			'subsections'     => array(
+				'return'             => new EE_Hidden_Input(array(
+					'name'    => 'return',
+					'default' => 'view_registration',
+				)),
+				'REG_ID'             => new EE_Hidden_Input(array(
+					'name'    => 'REG_ID',
+					'default' => $this->_registration->ID(),
+				)),
+				'current_status'     => new EE_Form_Section_HTML(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
+								)
+							)
+						)
+						. EEH_HTML::td(
+							EEH_HTML::strong(
+								$this->_registration->pretty_status(),
+								'',
+								'status-' . $this->_registration->status_ID(),
+								'line-height: 1em; font-size: 1.5em; font-weight: bold;'
+							)
+						)
+					)
+				),
+				'reg_status'         => new EE_Select_Input(
+					$this->_get_reg_statuses(),
+					array(
+						'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
+						'default'         => $this->_registration->status_ID(),
+					)
+				),
+				'send_notifications' => new EE_Yes_No_Input(
+					array(
+						'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
+						'default'         => false,
+						'html_help_text'  => esc_html__(
+							'If set to "Yes", then the related messages will be sent to the registrant.',
+							'event_espresso'
+						),
+					)
+				),
+				'submit'             => new EE_Submit_Input(
+					array(
+						'html_class'      => 'button-primary',
+						'html_label_text' => '&nbsp;',
+						'default'         => esc_html__('Update Registration Status', 'event_espresso'),
+					)
+				),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns an array of all the buttons for the various statuses and switch status actions
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _get_reg_statuses()
+	{
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
+		unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
+		// get current reg status
+		$current_status = $this->_registration->status_ID();
+		// is registration for free event? This will determine whether to display the pending payment option
+		if (
+			$current_status !== EEM_Registration::status_id_pending_payment
+			&& $this->_registration->transaction()->is_free()
+		) {
+			unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
+		}
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
+	}
+
+
+
+	/**
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
+	 *
+	 * @param bool $status REG status given for changing registrations to.
+	 * @param bool $notify Whether to send messages notifications or not.
+	 * @return array  (array with reg_id(s) updated and whether update was successful.
+	 * @throws \EE_Error
+	 */
+	protected function _set_registration_status_from_request($status = false, $notify = false)
+	{
+		if (isset($this->_req_data['reg_status_change_form'])) {
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
+				? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
+		} else {
+			$REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
+		}
+		$success = $this->_set_registration_status($REG_IDs, $status);
+		//notify?
+		if ($success
+			&& $notify
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $success;
+	}
+
+
+
+	/**
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
+	 *
+	 * @param array $REG_IDs
+	 * @param bool  $status
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 *               the array of updated registrations).
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	protected function _set_registration_status($REG_IDs = array(), $status = false)
+	{
+		$success = false;
+		// typecast $REG_IDs
+		$REG_IDs = (array)$REG_IDs;
+		if ( ! empty($REG_IDs)) {
+			$success = true;
+			// set default status if none is passed
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
+			// sanitize $REG_IDs
+			$REG_IDs = array_filter($REG_IDs, 'absint');
+			//loop through REG_ID's and change status
+			foreach ($REG_IDs as $REG_ID) {
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+				if ($registration instanceof EE_Registration) {
+					$registration->set_status($status);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+		//reset _req_data['_REG_ID'] for any potential future messages notifications
+		$this->_req_data['_REG_ID'] = $REG_IDs;
+		//return $success and processed registrations
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
+	}
+
+
+	/**
+	 * Common logic for setting up success message and redirecting to appropriate route
+	 *
+	 * @param  string $STS_ID status id for the registration changed to
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
+	 * @return void
+	 */
+	protected function _reg_status_change_return($STS_ID, $notify = false)
+	{
+		$result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
+			: array('success' => false);
+		$success = isset($result['success']) && $result['success'];
+		//setup success message
+		if ($success) {
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
+				$msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			} else {
+				$msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			}
+			EE_Error::add_success($msg);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong, and the status was not changed',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+		}
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
+		} else {
+			$route = array('action' => 'default');
+		}
+		//unset nonces
+		foreach ($this->_req_data as $ref => $value) {
+			if (strpos($ref, 'nonce') !== false) {
+				unset($this->_req_data[$ref]);
+				continue;
+			}
+			$value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->_req_data[$ref] = $value;
+		}
+		//merge request vars so that the reloaded list table contains any existing filter query params
+		$route = array_merge($this->_req_data, $route);
+		$this->_redirect_after_action($success, '', '', $route, true);
+	}
+
+
+	/**
+	 * incoming reg status change from reg details page.
+	 *
+	 * @return void
+	 */
+	protected function _change_reg_status()
+	{
+		$this->_req_data['return'] = 'view_registration';
+		//set notify based on whether the send notifications toggle is set or not
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
+		//$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
+			case EEM_Registration::status_id_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
+				$this->approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_pending_payment :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
+				$this->pending_registration($notify);
+				break;
+			case EEM_Registration::status_id_not_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
+				$this->not_approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_declined :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
+				$this->decline_registration($notify);
+				break;
+			case EEM_Registration::status_id_cancelled :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
+				$this->cancel_registration($notify);
+				break;
+			case EEM_Registration::status_id_wait_list :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
+				$this->wait_list_registration($notify);
+				break;
+			case EEM_Registration::status_id_incomplete :
+			default :
+				$result['success'] = false;
+				unset($this->_req_data['return']);
+				$this->_reg_status_change_return('', false);
+				break;
+		}
+	}
+
+
+	/**
+	 * approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their approval.
+	 * @return void
+	 */
+	protected function approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function decline_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
+	}
+
+
+	/**
+	 *        cancel_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function cancel_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
+	}
+
+
+	/**
+	 *        not_approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function not_approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function pending_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
+	}
+
+
+	/**
+	 * waitlist_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function wait_list_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	public function _reg_details_meta_box()
+	{
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		EEH_Autoloader::register_line_item_filter_autoloaders();
+		EE_Registry::instance()->load_helper('Line_Item');
+		$transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
+			: EE_Transaction::new_instance();
+		$this->_session = $transaction->session_data();
+		$filters        = new EE_Line_Item_Filter_Collection();
+		//$filters->add( new EE_Non_Zero_Line_Item_Filter() );
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
+		$line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
+			$transaction->total_line_item());
+		$filtered_line_item_tree                 = $line_item_filter_processor->process();
+		$line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
+			$filtered_line_item_tree,
+			array('EE_Registration' => $this->_registration)
+		);
+		$attendee                                = $this->_registration->attendee();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction'
+		)) {
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'view_transaction',
+						'TXN_ID' => $transaction->ID(),
+					),
+					TXN_ADMIN_URL
+				),
+				esc_html__(' View Transaction', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-cart'
+			);
+		} else {
+			$this->_template_args['view_transaction_button'] = '';
+		}
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'      => 'resend_registration',
+						'_REG_ID'     => $this->_registration->ID(),
+						'redirect_to' => 'view_registration',
+					),
+					REG_ADMIN_URL
+				),
+				esc_html__(' Resend Registration', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-email-alt'
+			);
+		} else {
+			$this->_template_args['resend_registration_button'] = '';
+		}
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		$payment                               = $transaction->get_first_related('Payment');
+		$payment                               = ! $payment instanceof EE_Payment
+			? EE_Payment::new_instance()
+			: $payment;
+		$payment_method                        = $payment->get_first_related('Payment_Method');
+		$payment_method                        = ! $payment_method instanceof EE_Payment_Method
+			? EE_Payment_Method::new_instance()
+			: $payment_method;
+		$reg_details                           = array(
+			'payment_method'       => $payment_method->name(),
+			'response_msg'         => $payment->gateway_response(),
+			'registration_id'      => $this->_registration->get('REG_code'),
+			'registration_session' => $this->_registration->session_ID(),
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
+		);
+		if (isset($reg_details['registration_id'])) {
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
+				'Registration ID',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
+		}
+		if (isset($reg_details['payment_method'])) {
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
+				'Most Recent Payment Method',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
+			$this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
+			$this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
+				'Payment method response',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+		}
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
+		$this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
+			'Registration placed from IP',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
+		$this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
+		$this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
+			'event_espresso');
+		$this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
+		$this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'   => 'default',
+				'event_id' => $this->_registration->event_ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$this->_template_args['REG_ID']                                       = $this->_registration->ID();
+		$this->_template_args['event_id']                                     = $this->_registration->event_ID();
+		$template_path                                                        =
+			REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * generates HTML for the Registration Questions meta box.
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
+	 * otherwise uses new forms system
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_questions_meta_box()
+	{
+		//allow someone to override this method entirely
+		if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
+			$this->_registration)) {
+			$form                                              = $this->_get_reg_custom_questions_form(
+				$this->_registration->ID()
+			);
+			$this->_template_args['att_questions']             = count($form->subforms()) > 0
+				? $form->get_html_and_js()
+				: '';
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
+			$this->_template_args['REG_ID']                    = $this->_registration->ID();
+			$template_path                                     =
+				REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
+		}
+	}
+
+
+	/**
+	 * form_before_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_before_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 	<table class="form-table ee-width-100">
 		<tbody>
 			';
-    }
-
-
-    /**
-     * form_after_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_after_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_after_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_after_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr class="hide-if-no-js">
 				<th> </th>
 				<td class="reg-admin-edit-attendee-question-td">
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
-               . esc_attr__('click to edit question', 'event_espresso')
-               . '">
+			   . esc_attr__('click to edit question', 'event_espresso')
+			   . '">
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
-               . esc_html__('edit the above question group', 'event_espresso')
-               . '</span>
+			   . esc_html__('edit the above question group', 'event_espresso')
+			   . '</span>
 						<div class="dashicons dashicons-edit"></div>
 					</a>
 				</td>
@@ -2137,558 +2137,558 @@ 
 		</tbody>
 	</table>
 ';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function form_form_field_label_wrap($label)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function form_form_field_label_wrap($label)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $input
-     * @return        string
-     */
-    public function form_form_field_input__wrap($input)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $input
+	 * @return        string
+	 */
+	public function form_form_field_input__wrap($input)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
-     * to display the page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_attendee_registration_form()
-    {
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
-            if ($success) {
-                $what  = esc_html__('Registration Form', 'event_espresso');
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
-                    : array('action' => 'default');
-                $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the form for saving registrations custom questions (if done
-     * previously retrieves the cached form object, which may have validation errors in it)
-     *
-     * @param int $REG_ID
-     * @return EE_Registration_Custom_Questions_Form
-     * @throws EE_Error
-     */
-    protected function _get_reg_custom_questions_form($REG_ID)
-    {
-        if ( ! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
-                EEM_Registration::instance()->get_one_by_ID($REG_ID)
-            );
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
-        }
-        return $this->_reg_custom_questions_form;
-    }
-
-
-    /**
-     * Saves
-     *
-     * @access private
-     * @param bool $REG_ID
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _save_reg_custom_questions_form($REG_ID = false)
-    {
-        if ( ! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No registration ID was received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
-        $form->receive_form_submission($this->_req_data);
-        $success = false;
-        if ($form->is_valid()) {
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
-                foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = array(
-                        'QST_ID' => $question_id,
-                        'REG_ID' => $REG_ID,
-                    );
-                    $possibly_new_values = array(
-                        'ANS_value' => $input->normalized_value(),
-                    );
-                    $answer              = EEM_Answer::instance()->get_one(array($where_conditions));
-                    if ($answer instanceof EE_Answer) {
-                        $success = $answer->save($possibly_new_values);
-                    } else {
-                        //insert it then
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
-                        $answer      = EE_Answer::new_instance($cols_n_vals);
-                        $success     = $answer->save();
-                    }
-                }
-            }
-        } else {
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_attendees_meta_box()
-    {
-        $REG = EEM_Registration::instance();
-        //get all other registrations on this transaction, and cache
-        //the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(array(
-            array(
-                'TXN_ID' => $this->_registration->transaction_ID(),
-                'REG_ID' => array('!=', $this->_registration->ID()),
-            ),
-            'force_join' => array('Attendee'),
-        ));
-        $this->_template_args['attendees']       = array();
-        $this->_template_args['attendee_notice'] = '';
-        if (empty($registrations)
-            || (is_array($registrations)
-                && ! EEH_Array::get_one_item_from_array($registrations))
-        ) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
-                    'event_espresso'
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
-        } else {
-            $att_nmbr = 1;
-            foreach ($registrations as $registration) {
-                /* @var $registration EE_Registration */
-                $attendee                                                    = $registration->attendee()
-                    ? $registration->attendee()
-                    : EEM_Attendee::instance()
-                                  ->create_default_object();
-                $this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
-                $this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
-                $this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
-                $this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][$att_nmbr]['address']     = implode(
-                    ', ',
-                    $attendee->full_address_as_array()
-                );
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
-                    array(
-                        'action' => 'edit_attendee',
-                        'post'   => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
-                $att_nmbr++;
-            }
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Edit Registration side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_registrant_side_meta_box()
-    {
-        /*@var $attendee EE_Attendee */
-        $att_check = $this->_registration->attendee();
-        $attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
-        //now let's determine if this is not the primary registration.  If it isn't then we set the
-        //primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
-        //primary registration object (that way we know if we need to show create button or not)
-        if ( ! $this->_registration->is_primary_registrant()) {
-            $primary_registration = $this->_registration->get_primary_registration();
-            $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
-                : null;
-            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
-                //in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
-                //custom attendee object so let's not worry about the primary reg.
-                $primary_registration = null;
-            }
-        } else {
-            $primary_registration = null;
-        }
-        $this->_template_args['ATT_ID']            = $attendee->ID();
-        $this->_template_args['fname']             = $attendee->fname();
-        $this->_template_args['lname']             = $attendee->lname();
-        $this->_template_args['email']             = $attendee->email();
-        $this->_template_args['phone']             = $attendee->phone();
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
-        //edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'edit_attendee',
-            'post'   => $attendee->ID(),
-        ), REG_ADMIN_URL);
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
-        //create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'duplicate_attendee',
-                '_REG_ID' => $this->_registration->ID(),
-            ), REG_ADMIN_URL) : '';
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
-        $this->_template_args['att_check']    = $att_check;
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * trash or restore registrations
-     *
-     * @param  boolean $trash whether to archive or restore
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     * @access protected
-     */
-    protected function _trash_or_restore_registrations($trash = true)
-    {
-        //if empty _REG_ID then get out because there's nothing to do
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
-                        'event_espresso'
-                    ),
-                    $trash ? 'trash' : 'restore'
-                ),
-                __FILE__, __LINE__, __FUNCTION__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-        $success = 0;
-        $overwrite_msgs = false;
-        //Checkboxes
-        if ( ! is_array($this->_req_data['_REG_ID'])) {
-            $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
-        }
-        $reg_count = count($this->_req_data['_REG_ID']);
-        // cycle thru checkboxes
-        foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
-            /** @var EE_Registration $REG */
-            $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-            $payments = $REG->registration_payments();
-            if (! empty($payments)) {
-                $name = $REG->attendee() instanceof EE_Attendee
-                    ? $REG->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $overwrite_msgs = true;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
-                            'event_espresso'
-                        ),
-                        $name
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //can't trash this registration because it has payments.
-                continue;
-            }
-            $updated = $trash ? $REG->delete() : $REG->restore();
-            if ($updated) {
-                $success++;
-            }
-        }
-        $this->_redirect_after_action(
-            $success === $reg_count, // were ALL registrations affected?
-            $success > 1
-                ? esc_html__('Registrations', 'event_espresso')
-                : esc_html__('Registration', 'event_espresso'),
-            $trash
-                ? esc_html__('moved to the trash', 'event_espresso')
-                : esc_html__('restored', 'event_espresso'),
-            array('action' => 'default'),
-            $overwrite_msgs
-        );
-    }
-
-
-    /**
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
-     * registration but also.
-     * 1. Removing relations to EE_Attendee
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
-     * ALSO trashed.
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
-     * 4. Removing relationships between all tickets and the related registrations
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
-     * 6. Deleting permanently any related Checkins.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _delete_registrations()
-    {
-        $REG_MDL = EEM_Registration::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if ( ! $REG instanceof EE_Registration) {
-                    continue;
-                }
-                $deleted = $this->_delete_registration($REG);
-                if ( ! $deleted) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $REG_ID  = $this->_req_data['_REG_ID'];
-            $REG     = $REG_MDL->get_one_by_ID($REG_ID);
-            $deleted = $this->_delete_registration($REG);
-            if ( ! $deleted) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Registrations', 'event_espresso')
-            : esc_html__('Registration', 'event_espresso');
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            array('action' => 'default'),
-            true
-        );
-    }
-
-
-    /**
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
-     * models get affected.
-     *
-     * @param  EE_Registration $REG registration to be deleted permenantly
-     * @return bool true = successful deletion, false = fail.
-     * @throws EE_Error
-     */
-    protected function _delete_registration(EE_Registration $REG)
-    {
-        //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
-        //registrations on the transaction that are NOT trashed.
-        $TXN         = $REG->get_first_related('Transaction');
-        $REGS        = $TXN->get_many_related('Registration');
-        $all_trashed = true;
-        foreach ($REGS as $registration) {
-            if ( ! $registration->get('REG_deleted')) {
-                $all_trashed = false;
-            }
-        }
-        if ( ! $all_trashed) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        //k made it here so that means we can delete all the related transactions and their answers (but let's do them
-        //separately from THIS one).
-        foreach ($REGS as $registration) {
-            //delete related answers
-            $registration->delete_related_permanently('Answer');
-            //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
-            $attendee = $registration->get_first_related('Attendee');
-            if ($attendee instanceof EE_Attendee) {
-                $registration->_remove_relation_to($attendee, 'Attendee');
-            }
-            //now remove relationships to tickets on this registration.
-            $registration->_remove_relations('Ticket');
-            //now delete permanently the checkins related to this registration.
-            $registration->delete_related_permanently('Checkin');
-            if ($registration->ID() === $REG->ID()) {
-                continue;
-            } //we don't want to delete permanently the existing registration just yet.
-            //remove relation to transaction for these registrations if NOT the existing registrations
-            $registration->_remove_relations('Transaction');
-            //delete permanently any related messages.
-            $registration->delete_related_permanently('Message');
-            //now delete this registration permanently
-            $registration->delete_permanently();
-        }
-        //now all related registrations on the transaction are handled.  So let's just handle this registration itself
-        // (the transaction and line items should be all that's left).
-        // delete the line items related to the transaction for this registration.
-        $TXN->delete_related_permanently('Line_Item');
-        //we need to remove all the relationships on the transaction
-        $TXN->delete_related_permanently('Payment');
-        $TXN->delete_related_permanently('Extra_Meta');
-        $TXN->delete_related_permanently('Message');
-        //now we can delete this REG permanently (and the transaction of course)
-        $REG->delete_related_permanently('Transaction');
-        return $REG->delete_permanently();
-    }
-
-
-    /**
-     *    generates HTML for the Register New Attendee Admin page
-     *
-     * @access private
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function new_registration()
-    {
-        if ( ! $this->_set_reg_event()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Unable to continue with registering because there is no Event ID in the request',
-                    'event_espresso'
-                )
-            );
-        }
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // gotta start with a clean slate if we're not coming here via ajax
-        if ( ! defined('DOING_AJAX')
-             && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
-        ) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        $this->_template_args['event_name'] = '';
-        // event name
-        if ($this->_reg_event) {
-            $this->_template_args['event_name'] = $this->_reg_event->name();
-            $edit_event_url                     = self::add_query_args_and_nonce(array(
-                'action' => 'edit',
-                'post'   => $this->_reg_event->ID(),
-            ), EVENTS_ADMIN_URL);
-            $edit_event_lnk                     = '<a href="'
-                                                  . $edit_event_url
-                                                  . '" title="'
-                                                  . esc_attr__('Edit ', 'event_espresso')
-                                                  . $this->_reg_event->name()
-                                                  . '">'
-                                                  . esc_html__('Edit Event', 'event_espresso')
-                                                  . '</a>';
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
-                                                   . $edit_event_lnk
-                                                   . '</span>';
-        }
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
-        if (defined('DOING_AJAX')) {
-            $this->_return_json();
-        }
-        // grab header
-        $template_path                              =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_template_args, true);
-        //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This returns the content for a registration step
-     *
-     * @access protected
-     * @return string html
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_registration_step_content()
-    {
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
-            $warning_msg = sprintf(
-                esc_html__(
-                    '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<h3 class="important-notice">',
-                '</h3>',
-                '<div class="float-right">',
-                '<span id="redirect_timer" class="important-notice">30</span>',
-                '</div>',
-                '<b>',
-                '</b>'
-            );
-            return '
+	}
+
+
+	/**
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
+	 * to display the page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_attendee_registration_form()
+	{
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			$REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
+			if ($success) {
+				$what  = esc_html__('Registration Form', 'event_espresso');
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
+					: array('action' => 'default');
+				$this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the form for saving registrations custom questions (if done
+	 * previously retrieves the cached form object, which may have validation errors in it)
+	 *
+	 * @param int $REG_ID
+	 * @return EE_Registration_Custom_Questions_Form
+	 * @throws EE_Error
+	 */
+	protected function _get_reg_custom_questions_form($REG_ID)
+	{
+		if ( ! $this->_reg_custom_questions_form) {
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
+				EEM_Registration::instance()->get_one_by_ID($REG_ID)
+			);
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
+		}
+		return $this->_reg_custom_questions_form;
+	}
+
+
+	/**
+	 * Saves
+	 *
+	 * @access private
+	 * @param bool $REG_ID
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _save_reg_custom_questions_form($REG_ID = false)
+	{
+		if ( ! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No registration ID was received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
+		$form->receive_form_submission($this->_req_data);
+		$success = false;
+		if ($form->is_valid()) {
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
+				foreach ($question_group_form->inputs() as $question_id => $input) {
+					$where_conditions    = array(
+						'QST_ID' => $question_id,
+						'REG_ID' => $REG_ID,
+					);
+					$possibly_new_values = array(
+						'ANS_value' => $input->normalized_value(),
+					);
+					$answer              = EEM_Answer::instance()->get_one(array($where_conditions));
+					if ($answer instanceof EE_Answer) {
+						$success = $answer->save($possibly_new_values);
+					} else {
+						//insert it then
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
+						$answer      = EE_Answer::new_instance($cols_n_vals);
+						$success     = $answer->save();
+					}
+				}
+			}
+		} else {
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_attendees_meta_box()
+	{
+		$REG = EEM_Registration::instance();
+		//get all other registrations on this transaction, and cache
+		//the attendees for them so we don't have to run another query using force_join
+		$registrations                           = $REG->get_all(array(
+			array(
+				'TXN_ID' => $this->_registration->transaction_ID(),
+				'REG_ID' => array('!=', $this->_registration->ID()),
+			),
+			'force_join' => array('Attendee'),
+		));
+		$this->_template_args['attendees']       = array();
+		$this->_template_args['attendee_notice'] = '';
+		if (empty($registrations)
+			|| (is_array($registrations)
+				&& ! EEH_Array::get_one_item_from_array($registrations))
+		) {
+			EE_Error::add_error(
+				esc_html__(
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
+					'event_espresso'
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
+		} else {
+			$att_nmbr = 1;
+			foreach ($registrations as $registration) {
+				/* @var $registration EE_Registration */
+				$attendee                                                    = $registration->attendee()
+					? $registration->attendee()
+					: EEM_Attendee::instance()
+								  ->create_default_object();
+				$this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
+				$this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
+				$this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
+				$this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
+				$this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
+				$this->_template_args['attendees'][$att_nmbr]['address']     = implode(
+					', ',
+					$attendee->full_address_as_array()
+				);
+				$this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
+					array(
+						'action' => 'edit_attendee',
+						'post'   => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
+				$att_nmbr++;
+			}
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		}
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Edit Registration side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_registrant_side_meta_box()
+	{
+		/*@var $attendee EE_Attendee */
+		$att_check = $this->_registration->attendee();
+		$attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
+		//now let's determine if this is not the primary registration.  If it isn't then we set the
+		//primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
+		//primary registration object (that way we know if we need to show create button or not)
+		if ( ! $this->_registration->is_primary_registrant()) {
+			$primary_registration = $this->_registration->get_primary_registration();
+			$primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
+				: null;
+			if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+				//in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
+				//custom attendee object so let's not worry about the primary reg.
+				$primary_registration = null;
+			}
+		} else {
+			$primary_registration = null;
+		}
+		$this->_template_args['ATT_ID']            = $attendee->ID();
+		$this->_template_args['fname']             = $attendee->fname();
+		$this->_template_args['lname']             = $attendee->lname();
+		$this->_template_args['email']             = $attendee->email();
+		$this->_template_args['phone']             = $attendee->phone();
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
+		//edit link
+		$this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'edit_attendee',
+			'post'   => $attendee->ID(),
+		), REG_ADMIN_URL);
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
+		//create link
+		$this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'duplicate_attendee',
+				'_REG_ID' => $this->_registration->ID(),
+			), REG_ADMIN_URL) : '';
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
+		$this->_template_args['att_check']    = $att_check;
+		$template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * trash or restore registrations
+	 *
+	 * @param  boolean $trash whether to archive or restore
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_registrations($trash = true)
+	{
+		//if empty _REG_ID then get out because there's nothing to do
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
+						'event_espresso'
+					),
+					$trash ? 'trash' : 'restore'
+				),
+				__FILE__, __LINE__, __FUNCTION__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+		$success = 0;
+		$overwrite_msgs = false;
+		//Checkboxes
+		if ( ! is_array($this->_req_data['_REG_ID'])) {
+			$this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
+		}
+		$reg_count = count($this->_req_data['_REG_ID']);
+		// cycle thru checkboxes
+		foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
+			/** @var EE_Registration $REG */
+			$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+			$payments = $REG->registration_payments();
+			if (! empty($payments)) {
+				$name = $REG->attendee() instanceof EE_Attendee
+					? $REG->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$overwrite_msgs = true;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
+							'event_espresso'
+						),
+						$name
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//can't trash this registration because it has payments.
+				continue;
+			}
+			$updated = $trash ? $REG->delete() : $REG->restore();
+			if ($updated) {
+				$success++;
+			}
+		}
+		$this->_redirect_after_action(
+			$success === $reg_count, // were ALL registrations affected?
+			$success > 1
+				? esc_html__('Registrations', 'event_espresso')
+				: esc_html__('Registration', 'event_espresso'),
+			$trash
+				? esc_html__('moved to the trash', 'event_espresso')
+				: esc_html__('restored', 'event_espresso'),
+			array('action' => 'default'),
+			$overwrite_msgs
+		);
+	}
+
+
+	/**
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
+	 * registration but also.
+	 * 1. Removing relations to EE_Attendee
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
+	 * ALSO trashed.
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
+	 * 4. Removing relationships between all tickets and the related registrations
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
+	 * 6. Deleting permanently any related Checkins.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _delete_registrations()
+	{
+		$REG_MDL = EEM_Registration::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
+				if ( ! $REG instanceof EE_Registration) {
+					continue;
+				}
+				$deleted = $this->_delete_registration($REG);
+				if ( ! $deleted) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$REG_ID  = $this->_req_data['_REG_ID'];
+			$REG     = $REG_MDL->get_one_by_ID($REG_ID);
+			$deleted = $this->_delete_registration($REG);
+			if ( ! $deleted) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Registrations', 'event_espresso')
+			: esc_html__('Registration', 'event_espresso');
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			array('action' => 'default'),
+			true
+		);
+	}
+
+
+	/**
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
+	 * models get affected.
+	 *
+	 * @param  EE_Registration $REG registration to be deleted permenantly
+	 * @return bool true = successful deletion, false = fail.
+	 * @throws EE_Error
+	 */
+	protected function _delete_registration(EE_Registration $REG)
+	{
+		//first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
+		//registrations on the transaction that are NOT trashed.
+		$TXN         = $REG->get_first_related('Transaction');
+		$REGS        = $TXN->get_many_related('Registration');
+		$all_trashed = true;
+		foreach ($REGS as $registration) {
+			if ( ! $registration->get('REG_deleted')) {
+				$all_trashed = false;
+			}
+		}
+		if ( ! $all_trashed) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		//k made it here so that means we can delete all the related transactions and their answers (but let's do them
+		//separately from THIS one).
+		foreach ($REGS as $registration) {
+			//delete related answers
+			$registration->delete_related_permanently('Answer');
+			//remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
+			$attendee = $registration->get_first_related('Attendee');
+			if ($attendee instanceof EE_Attendee) {
+				$registration->_remove_relation_to($attendee, 'Attendee');
+			}
+			//now remove relationships to tickets on this registration.
+			$registration->_remove_relations('Ticket');
+			//now delete permanently the checkins related to this registration.
+			$registration->delete_related_permanently('Checkin');
+			if ($registration->ID() === $REG->ID()) {
+				continue;
+			} //we don't want to delete permanently the existing registration just yet.
+			//remove relation to transaction for these registrations if NOT the existing registrations
+			$registration->_remove_relations('Transaction');
+			//delete permanently any related messages.
+			$registration->delete_related_permanently('Message');
+			//now delete this registration permanently
+			$registration->delete_permanently();
+		}
+		//now all related registrations on the transaction are handled.  So let's just handle this registration itself
+		// (the transaction and line items should be all that's left).
+		// delete the line items related to the transaction for this registration.
+		$TXN->delete_related_permanently('Line_Item');
+		//we need to remove all the relationships on the transaction
+		$TXN->delete_related_permanently('Payment');
+		$TXN->delete_related_permanently('Extra_Meta');
+		$TXN->delete_related_permanently('Message');
+		//now we can delete this REG permanently (and the transaction of course)
+		$REG->delete_related_permanently('Transaction');
+		return $REG->delete_permanently();
+	}
+
+
+	/**
+	 *    generates HTML for the Register New Attendee Admin page
+	 *
+	 * @access private
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function new_registration()
+	{
+		if ( ! $this->_set_reg_event()) {
+			throw new EE_Error(
+				esc_html__(
+					'Unable to continue with registering because there is no Event ID in the request',
+					'event_espresso'
+				)
+			);
+		}
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// gotta start with a clean slate if we're not coming here via ajax
+		if ( ! defined('DOING_AJAX')
+			 && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
+		) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		$this->_template_args['event_name'] = '';
+		// event name
+		if ($this->_reg_event) {
+			$this->_template_args['event_name'] = $this->_reg_event->name();
+			$edit_event_url                     = self::add_query_args_and_nonce(array(
+				'action' => 'edit',
+				'post'   => $this->_reg_event->ID(),
+			), EVENTS_ADMIN_URL);
+			$edit_event_lnk                     = '<a href="'
+												  . $edit_event_url
+												  . '" title="'
+												  . esc_attr__('Edit ', 'event_espresso')
+												  . $this->_reg_event->name()
+												  . '">'
+												  . esc_html__('Edit Event', 'event_espresso')
+												  . '</a>';
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
+												   . $edit_event_lnk
+												   . '</span>';
+		}
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
+		if (defined('DOING_AJAX')) {
+			$this->_return_json();
+		}
+		// grab header
+		$template_path                              =
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_template_args, true);
+		//$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This returns the content for a registration step
+	 *
+	 * @access protected
+	 * @return string html
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_registration_step_content()
+	{
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
+			$warning_msg = sprintf(
+				esc_html__(
+					'%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
+					'event_espresso'
+				),
+				'<br />',
+				'<h3 class="important-notice">',
+				'</h3>',
+				'<div class="float-right">',
+				'<span id="redirect_timer" class="important-notice">30</span>',
+				'</div>',
+				'<b>',
+				'</b>'
+			);
+			return '
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2701,792 +2701,792 @@ 
 	        }
 	    }, 800 );
 	</script >';
-        }
-        $template_args = array(
-            'title'                    => '',
-            'content'                  => '',
-            'step_button_text'         => '',
-            'show_notification_toggle' => false,
-        );
-        //to indicate we're processing a new registration
-        $hidden_fields = array(
-            'processing_registration' => array(
-                'type'  => 'hidden',
-                'value' => 0,
-            ),
-            'event_id'                => array(
-                'type'  => 'hidden',
-                'value' => $this->_reg_event->ID(),
-            ),
-        );
-        //if the cart is empty then we know we're at step one so we'll display ticket selector
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        switch ($step) {
-            case 'ticket' :
-                $hidden_fields['processing_registration']['value'] = 1;
-                $template_args['title']                            = esc_html__(
-                    'Step One: Select the Ticket for this registration',
-                    'event_espresso'
-                );
-                $template_args['content']                          =
-                    EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
-                $template_args['step_button_text']                 = esc_html__(
-                    'Add Tickets and Continue to Registrant Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle']         = false;
-                break;
-            case 'questions' :
-                $hidden_fields['processing_registration']['value'] = 2;
-                $template_args['title']                            = esc_html__(
-                    'Step Two: Add Registrant Details for this Registration',
-                    'event_espresso'
-                );
-                //in theory we should be able to run EED_SPCO at this point because the cart should have been setup
-                // properly by the first process_reg_step run.
-                $template_args['content']                  =
-                    EED_Single_Page_Checkout::registration_checkout_for_admin();
-                $template_args['step_button_text']         = esc_html__(
-                    'Save Registration and Continue to Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = true;
-                break;
-        }
-        //we come back to the process_registration_step route.
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
-        return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     *        set_reg_event
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _set_reg_event()
-    {
-        if (is_object($this->_reg_event)) {
-            return true;
-        }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
-        if ( ! $EVT_ID) {
-            return false;
-        }
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        return true;
-    }
-
-
-    /**
-     * process_reg_step
-     *
-     * @access        public
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function process_reg_step()
-    {
-        EE_System::do_not_cache();
-        $this->_set_reg_event();
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        EE_Registry::instance()->REQ->set('uts', time());
-        //what step are we on?
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        //if doing ajax then we need to verify the nonce
-        if (defined('DOING_AJAX')) {
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        switch ($step) {
-            case 'ticket' :
-                //process ticket selection
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
-                if ($success) {
-                    EE_Error::add_success(
-                        esc_html__(
-                            'Tickets Selected. Now complete the registration.',
-                            'event_espresso'
-                        )
-                    );
-                } else {
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
-                }
-                if (defined('DOING_AJAX')) {
-                    $this->new_registration(); //display next step
-                } else {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 1,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                }
-                break;
-            case 'questions' :
-                if (! isset(
-                    $this->_req_data['txn_reg_status_change'],
-                    $this->_req_data['txn_reg_status_change']['send_notifications'])
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
-                }
-                //process registration
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
-                if ($cart instanceof EE_Cart) {
-                    $grand_total = $cart->get_cart_grand_total();
-                    if ($grand_total instanceof EE_Line_Item) {
-                        $grand_total->save_this_and_descendants_to_txn();
-                    }
-                }
-                if ( ! $transaction instanceof EE_Transaction) {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 2,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    if (defined('DOING_AJAX')) {
-                        //display registration form again because there are errors (maybe validation?)
-                        $this->new_registration();
-                        return;
-                    } else {
-                        $this->_redirect_after_action(
-                            false,
-                            '',
-                            '',
-                            $query_args,
-                            true
-                        );
-                        return;
-                    }
-                }
-                // maybe update status, and make sure to save transaction if not done already
-                if ( ! $transaction->update_status_based_on_total_paid()) {
-                    $transaction->save();
-                }
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                $this->_req_data = array();
-                $query_args      = array(
-                    'action'        => 'redirect_to_txn',
-                    'TXN_ID'        => $transaction->ID(),
-                    'EVT_ID'        => $this->_reg_event->ID(),
-                    'event_name'    => urlencode($this->_reg_event->name()),
-                    'redirect_from' => 'new_registration',
-                );
-                $this->_redirect_after_action(false, '', '', $query_args, true);
-                break;
-        }
-        //what are you looking here for?  Should be nothing to do at this point.
-    }
-
-
-    /**
-     * redirect_to_txn
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function redirect_to_txn()
-    {
-        EE_System::do_not_cache();
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $query_args = array(
-            'action' => 'view_transaction',
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
-            'page'   => 'espresso_transactions',
-        );
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
-            $query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
-            $query_args['event_name']    = urlencode($this->_req_data['event_name']);
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
-        }
-        EE_Error::add_success(
-            esc_html__(
-                'Registration Created.  Please review the transaction and add any payments as necessary',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Attendee Contact List
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _attendee_contact_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *        get_attendees
-     *
-     * @param      $per_page
-     * @param bool $count whether to return count or data.
-     * @param bool $trash
-     * @return array
-     * @throws EE_Error
-     * @access public
-     */
-    public function get_attendees($per_page, $count = false, $trash = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
-        $ATT_MDL                    = EEM_Attendee::instance();
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-        switch ($this->_req_data['orderby']) {
-            case 'ATT_ID':
-                $orderby = 'ATT_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'ATT_fname';
-                break;
-            case 'ATT_email':
-                $orderby = 'ATT_email';
-                break;
-            case 'ATT_city':
-                $orderby = 'ATT_city';
-                break;
-            case 'STA_ID':
-                $orderby = 'STA_ID';
-                break;
-            case 'CNT_ID':
-                $orderby = 'CNT_ID';
-                break;
-            default:
-                $orderby = 'ATT_lname';
-        }
-        $sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where       = array();
-        if ( ! empty($this->_req_data['s'])) {
-            $sstr         = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
-                'ATT_fname'                         => array('LIKE', $sstr),
-                'ATT_lname'                         => array('LIKE', $sstr),
-                'ATT_short_bio'                     => array('LIKE', $sstr),
-                'ATT_email'                         => array('LIKE', $sstr),
-                'ATT_address'                       => array('LIKE', $sstr),
-                'ATT_address2'                      => array('LIKE', $sstr),
-                'ATT_city'                          => array('LIKE', $sstr),
-                'Country.CNT_name'                  => array('LIKE', $sstr),
-                'State.STA_name'                    => array('LIKE', $sstr),
-                'ATT_phone'                         => array('LIKE', $sstr),
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
-                'Registration.REG_code'             => array('LIKE', $sstr),
-                'Registration.REG_count'            => array('LIKE', $sstr),
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
-            );
-        }
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $count ? null : array($offset, $per_page);
-        if ($trash) {
-            $_where['status'] = array('!=', 'publish');
-            $all_attendees    = $count
-                ? $ATT_MDL->count(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ), 'ATT_ID', true)
-                : $ATT_MDL->get_all(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ));
-        } else {
-            $_where['status'] = array('IN', array('publish'));
-            $all_attendees    = $count
-                ? $ATT_MDL->count(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ), 'ATT_ID', true)
-                : $ATT_MDL->get_all(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ));
-        }
-        return $all_attendees;
-    }
-
-
-    /**
-     * This is just taking care of resending the registration confirmation
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _resend_registration()
-    {
-        $this->_process_resend_registration();
-        $query_args = isset($this->_req_data['redirect_to'])
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
-            : array('action' => 'default');
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-    /**
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
-     * to use when selecting registrations
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
-     *                                                     the query parameters from the request
-     * @return void ends the request with a redirect or download
-     */
-    public function _registrations_report_base( $method_name_for_getting_query_params )
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'        => 'espresso_batch',
-                    'batch'       => 'file',
-                    'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-                    'filters'     => urlencode(
-                        serialize(
-                            call_user_func(
-                                array( $this, $method_name_for_getting_query_params ),
-                                EEH_Array::is_set(
-                                    $this->_req_data,
-                                    'filters',
-                                    array()
-                                )
-                            )
-                        )
-                ),
-                'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            $new_request_args = array(
-                'export' => 'report',
-                'action' => 'registrations_report_for_event',
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-            );
-            $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 registration report using only query parameters in the request
-     * @return void
-     */
-    public function _registrations_report()
-    {
-        $this->_registrations_report_base('_get_registration_query_parameters');
-    }
-
-
-    public function _contact_list_export()
-    {
-        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_attendees();
-        }
-    }
-
-
-    public function _contact_list_report()
-    {
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
-                'page'        => 'espresso_batch',
-                'batch'       => 'file',
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            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->report_attendees();
-            }
-        }
-    }
-
-
-
-
-
-    /***************************************        ATTENDEE DETAILS        ***************************************/
-    /**
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _duplicate_attendee()
-    {
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
-        //verify we have necessary info
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-            $query_args = array('action' => $action);
-            $this->_redirect_after_action('', '', '', $query_args, true);
-        }
-        //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
-        $attendee     = $registration->attendee();
-        //remove relation of existing attendee on registration
-        $registration->_remove_relation_to($attendee, 'Attendee');
-        //new attendee
-        $new_attendee = clone $attendee;
-        $new_attendee->set('ATT_ID', 0);
-        $new_attendee->save();
-        //add new attendee to reg
-        $registration->_add_relation_to($new_attendee, 'Attendee');
-        EE_Error::add_success(
-            esc_html__(
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
-                'event_espresso'
-            )
-        );
-        //redirect to edit page for attendee
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
-        $this->_redirect_after_action('', '', '', $query_args, true);
-    }
-
-
-    //related to cpt routes
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        $success  = true;
-        $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
-        //for attendee updates
-        if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
-            //note we should only be UPDATING attendees at this point.
-            $updated_fields = array(
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
-                'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
-                'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
-            );
-            foreach ($updated_fields as $field => $value) {
-                $attendee->set($field, $value);
-            }
-            $success                   = $attendee->save();
-            $attendee_update_callbacks = apply_filters(
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
-                array()
-            );
-            foreach ($attendee_update_callbacks as $a_callback) {
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
-                                'event_espresso'
-                            ),
-                            $a_callback
-                        )
-                    );
-                }
-            }
-        }
-        if ($success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with updating the meta table data for the registration.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-    }
-
-
-    public function attendee_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-        remove_meta_box(
-            'postexcerpt',
-            esc_html__('Excerpt', 'event_espresso'),
-            'post_excerpt_meta_box',
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
-            add_meta_box(
-                'postexcerpt',
-                esc_html__('Short Biography', 'event_espresso'),
-                'post_excerpt_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal'
-            );
-        }
-        if (post_type_supports('espresso_attendees', 'comments')) {
-            add_meta_box(
-                'commentsdiv',
-                esc_html__('Notes on the Contact', 'event_espresso'),
-                'post_comment_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal',
-                'core'
-            );
-        }
-        add_meta_box(
-            'attendee_contact_info',
-            esc_html__('Contact Info', 'event_espresso'),
-            array($this, 'attendee_contact_info'),
-            $this->_cpt_routes[$this->_req_action],
-            'side',
-            'core'
-        );
-        add_meta_box(
-            'attendee_details_address',
-            esc_html__('Address Details', 'event_espresso'),
-            array($this, 'attendee_address_details'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        add_meta_box(
-            'attendee_registrations',
-            esc_html__('Registrations for this Contact', 'event_espresso'),
-            array($this, 'attendee_registrations_meta_box'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'high'
-        );
-    }
-
-
-    /**
-     * Metabox for attendee contact info
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee contact info ( and form )
-     * @throws DomainException
-     */
-    public function attendee_contact_info($post)
-    {
-        //get attendee object ( should already have it )
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
-        $template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * Metabox for attendee details
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee address details (and form)
-     * @throws DomainException
-     */
-    public function attendee_address_details($post)
-    {
-        //get attendee object (should already have it)
-        $this->_template_args['attendee']     = $this->_cpt_model_obj;
-        $this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
-                        'QST_system'       => 'admin-state',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'STA_ID',
-                    'input_name'     => 'STA_ID',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
-                        'QST_system'       => 'admin-country',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'CNT_ISO',
-                    'input_name'     => 'CNT_ISO',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $template                             =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     *        _attendee_details
-     *
-     * @access protected
-     * @param $post
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function attendee_registrations_meta_box($post)
-    {
-        $this->_template_args['attendee']      = $this->_cpt_model_obj;
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template                              =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * add in the form fields for the attendee edit
-     *
-     * @param  WP_Post $post wp post object
-     * @return string html for new form.
-     * @throws DomainException
-     */
-    public function after_title_form_fields($post)
-    {
-        if ($post->post_type == 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
-            $template_args['attendee'] = $this->_cpt_model_obj;
-            EEH_Template::display_template($template, $template_args);
-        }
-    }
-
-
-    /**
-     *        _trash_or_restore_attendee
-     *
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @access protected
-     */
-    protected function _trash_or_restore_attendees($trash = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ATT_MDL = EEM_Attendee::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
-                if ( ! $updated) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
-            //get attendee
-            $att     = $ATT_MDL->get_one_by_ID($ATT_ID);
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
-            $updated = $att->save();
-            if ( ! $updated) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Contacts', 'event_espresso')
-            : esc_html__('Contact', 'event_espresso');
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
-    }
+		}
+		$template_args = array(
+			'title'                    => '',
+			'content'                  => '',
+			'step_button_text'         => '',
+			'show_notification_toggle' => false,
+		);
+		//to indicate we're processing a new registration
+		$hidden_fields = array(
+			'processing_registration' => array(
+				'type'  => 'hidden',
+				'value' => 0,
+			),
+			'event_id'                => array(
+				'type'  => 'hidden',
+				'value' => $this->_reg_event->ID(),
+			),
+		);
+		//if the cart is empty then we know we're at step one so we'll display ticket selector
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		switch ($step) {
+			case 'ticket' :
+				$hidden_fields['processing_registration']['value'] = 1;
+				$template_args['title']                            = esc_html__(
+					'Step One: Select the Ticket for this registration',
+					'event_espresso'
+				);
+				$template_args['content']                          =
+					EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
+				$template_args['step_button_text']                 = esc_html__(
+					'Add Tickets and Continue to Registrant Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle']         = false;
+				break;
+			case 'questions' :
+				$hidden_fields['processing_registration']['value'] = 2;
+				$template_args['title']                            = esc_html__(
+					'Step Two: Add Registrant Details for this Registration',
+					'event_espresso'
+				);
+				//in theory we should be able to run EED_SPCO at this point because the cart should have been setup
+				// properly by the first process_reg_step run.
+				$template_args['content']                  =
+					EED_Single_Page_Checkout::registration_checkout_for_admin();
+				$template_args['step_button_text']         = esc_html__(
+					'Save Registration and Continue to Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = true;
+				break;
+		}
+		//we come back to the process_registration_step route.
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
+		return EEH_Template::display_template(
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 *        set_reg_event
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _set_reg_event()
+	{
+		if (is_object($this->_reg_event)) {
+			return true;
+		}
+		$EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+		if ( ! $EVT_ID) {
+			return false;
+		}
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		return true;
+	}
+
+
+	/**
+	 * process_reg_step
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function process_reg_step()
+	{
+		EE_System::do_not_cache();
+		$this->_set_reg_event();
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		EE_Registry::instance()->REQ->set('uts', time());
+		//what step are we on?
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		//if doing ajax then we need to verify the nonce
+		if (defined('DOING_AJAX')) {
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		switch ($step) {
+			case 'ticket' :
+				//process ticket selection
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
+				if ($success) {
+					EE_Error::add_success(
+						esc_html__(
+							'Tickets Selected. Now complete the registration.',
+							'event_espresso'
+						)
+					);
+				} else {
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
+				}
+				if (defined('DOING_AJAX')) {
+					$this->new_registration(); //display next step
+				} else {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 1,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+				}
+				break;
+			case 'questions' :
+				if (! isset(
+					$this->_req_data['txn_reg_status_change'],
+					$this->_req_data['txn_reg_status_change']['send_notifications'])
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
+				}
+				//process registration
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
+				if ($cart instanceof EE_Cart) {
+					$grand_total = $cart->get_cart_grand_total();
+					if ($grand_total instanceof EE_Line_Item) {
+						$grand_total->save_this_and_descendants_to_txn();
+					}
+				}
+				if ( ! $transaction instanceof EE_Transaction) {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 2,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					if (defined('DOING_AJAX')) {
+						//display registration form again because there are errors (maybe validation?)
+						$this->new_registration();
+						return;
+					} else {
+						$this->_redirect_after_action(
+							false,
+							'',
+							'',
+							$query_args,
+							true
+						);
+						return;
+					}
+				}
+				// maybe update status, and make sure to save transaction if not done already
+				if ( ! $transaction->update_status_based_on_total_paid()) {
+					$transaction->save();
+				}
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+				$this->_req_data = array();
+				$query_args      = array(
+					'action'        => 'redirect_to_txn',
+					'TXN_ID'        => $transaction->ID(),
+					'EVT_ID'        => $this->_reg_event->ID(),
+					'event_name'    => urlencode($this->_reg_event->name()),
+					'redirect_from' => 'new_registration',
+				);
+				$this->_redirect_after_action(false, '', '', $query_args, true);
+				break;
+		}
+		//what are you looking here for?  Should be nothing to do at this point.
+	}
+
+
+	/**
+	 * redirect_to_txn
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function redirect_to_txn()
+	{
+		EE_System::do_not_cache();
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$query_args = array(
+			'action' => 'view_transaction',
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
+			'page'   => 'espresso_transactions',
+		);
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
+			$query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
+			$query_args['event_name']    = urlencode($this->_req_data['event_name']);
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
+		}
+		EE_Error::add_success(
+			esc_html__(
+				'Registration Created.  Please review the transaction and add any payments as necessary',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Attendee Contact List
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _attendee_contact_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *        get_attendees
+	 *
+	 * @param      $per_page
+	 * @param bool $count whether to return count or data.
+	 * @param bool $trash
+	 * @return array
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function get_attendees($per_page, $count = false, $trash = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+		$ATT_MDL                    = EEM_Attendee::instance();
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+		switch ($this->_req_data['orderby']) {
+			case 'ATT_ID':
+				$orderby = 'ATT_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'ATT_fname';
+				break;
+			case 'ATT_email':
+				$orderby = 'ATT_email';
+				break;
+			case 'ATT_city':
+				$orderby = 'ATT_city';
+				break;
+			case 'STA_ID':
+				$orderby = 'STA_ID';
+				break;
+			case 'CNT_ID':
+				$orderby = 'CNT_ID';
+				break;
+			default:
+				$orderby = 'ATT_lname';
+		}
+		$sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where       = array();
+		if ( ! empty($this->_req_data['s'])) {
+			$sstr         = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
+				'ATT_fname'                         => array('LIKE', $sstr),
+				'ATT_lname'                         => array('LIKE', $sstr),
+				'ATT_short_bio'                     => array('LIKE', $sstr),
+				'ATT_email'                         => array('LIKE', $sstr),
+				'ATT_address'                       => array('LIKE', $sstr),
+				'ATT_address2'                      => array('LIKE', $sstr),
+				'ATT_city'                          => array('LIKE', $sstr),
+				'Country.CNT_name'                  => array('LIKE', $sstr),
+				'State.STA_name'                    => array('LIKE', $sstr),
+				'ATT_phone'                         => array('LIKE', $sstr),
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
+				'Registration.REG_code'             => array('LIKE', $sstr),
+				'Registration.REG_count'            => array('LIKE', $sstr),
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
+			);
+		}
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $count ? null : array($offset, $per_page);
+		if ($trash) {
+			$_where['status'] = array('!=', 'publish');
+			$all_attendees    = $count
+				? $ATT_MDL->count(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				), 'ATT_ID', true)
+				: $ATT_MDL->get_all(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				));
+		} else {
+			$_where['status'] = array('IN', array('publish'));
+			$all_attendees    = $count
+				? $ATT_MDL->count(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				), 'ATT_ID', true)
+				: $ATT_MDL->get_all(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				));
+		}
+		return $all_attendees;
+	}
+
+
+	/**
+	 * This is just taking care of resending the registration confirmation
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _resend_registration()
+	{
+		$this->_process_resend_registration();
+		$query_args = isset($this->_req_data['redirect_to'])
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
+			: array('action' => 'default');
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+	/**
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
+	 * to use when selecting registrations
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
+	 *                                                     the query parameters from the request
+	 * @return void ends the request with a redirect or download
+	 */
+	public function _registrations_report_base( $method_name_for_getting_query_params )
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'        => 'espresso_batch',
+					'batch'       => 'file',
+					'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+					'filters'     => urlencode(
+						serialize(
+							call_user_func(
+								array( $this, $method_name_for_getting_query_params ),
+								EEH_Array::is_set(
+									$this->_req_data,
+									'filters',
+									array()
+								)
+							)
+						)
+				),
+				'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			$new_request_args = array(
+				'export' => 'report',
+				'action' => 'registrations_report_for_event',
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+			);
+			$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 registration report using only query parameters in the request
+	 * @return void
+	 */
+	public function _registrations_report()
+	{
+		$this->_registrations_report_base('_get_registration_query_parameters');
+	}
+
+
+	public function _contact_list_export()
+	{
+		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_attendees();
+		}
+	}
+
+
+	public function _contact_list_report()
+	{
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
+				'page'        => 'espresso_batch',
+				'batch'       => 'file',
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			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->report_attendees();
+			}
+		}
+	}
+
+
+
+
+
+	/***************************************        ATTENDEE DETAILS        ***************************************/
+	/**
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _duplicate_attendee()
+	{
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
+		//verify we have necessary info
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+			$query_args = array('action' => $action);
+			$this->_redirect_after_action('', '', '', $query_args, true);
+		}
+		//okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
+		$attendee     = $registration->attendee();
+		//remove relation of existing attendee on registration
+		$registration->_remove_relation_to($attendee, 'Attendee');
+		//new attendee
+		$new_attendee = clone $attendee;
+		$new_attendee->set('ATT_ID', 0);
+		$new_attendee->save();
+		//add new attendee to reg
+		$registration->_add_relation_to($new_attendee, 'Attendee');
+		EE_Error::add_success(
+			esc_html__(
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
+				'event_espresso'
+			)
+		);
+		//redirect to edit page for attendee
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
+		$this->_redirect_after_action('', '', '', $query_args, true);
+	}
+
+
+	//related to cpt routes
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		$success  = true;
+		$attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
+		//for attendee updates
+		if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
+			//note we should only be UPDATING attendees at this point.
+			$updated_fields = array(
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
+				'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
+				'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
+			);
+			foreach ($updated_fields as $field => $value) {
+				$attendee->set($field, $value);
+			}
+			$success                   = $attendee->save();
+			$attendee_update_callbacks = apply_filters(
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
+				array()
+			);
+			foreach ($attendee_update_callbacks as $a_callback) {
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
+								'event_espresso'
+							),
+							$a_callback
+						)
+					);
+				}
+			}
+		}
+		if ($success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with updating the meta table data for the registration.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+	}
+
+
+	public function attendee_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+		remove_meta_box(
+			'postexcerpt',
+			esc_html__('Excerpt', 'event_espresso'),
+			'post_excerpt_meta_box',
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
+			add_meta_box(
+				'postexcerpt',
+				esc_html__('Short Biography', 'event_espresso'),
+				'post_excerpt_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal'
+			);
+		}
+		if (post_type_supports('espresso_attendees', 'comments')) {
+			add_meta_box(
+				'commentsdiv',
+				esc_html__('Notes on the Contact', 'event_espresso'),
+				'post_comment_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal',
+				'core'
+			);
+		}
+		add_meta_box(
+			'attendee_contact_info',
+			esc_html__('Contact Info', 'event_espresso'),
+			array($this, 'attendee_contact_info'),
+			$this->_cpt_routes[$this->_req_action],
+			'side',
+			'core'
+		);
+		add_meta_box(
+			'attendee_details_address',
+			esc_html__('Address Details', 'event_espresso'),
+			array($this, 'attendee_address_details'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		add_meta_box(
+			'attendee_registrations',
+			esc_html__('Registrations for this Contact', 'event_espresso'),
+			array($this, 'attendee_registrations_meta_box'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Metabox for attendee contact info
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee contact info ( and form )
+	 * @throws DomainException
+	 */
+	public function attendee_contact_info($post)
+	{
+		//get attendee object ( should already have it )
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
+		$template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * Metabox for attendee details
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee address details (and form)
+	 * @throws DomainException
+	 */
+	public function attendee_address_details($post)
+	{
+		//get attendee object (should already have it)
+		$this->_template_args['attendee']     = $this->_cpt_model_obj;
+		$this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
+						'QST_system'       => 'admin-state',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'STA_ID',
+					'input_name'     => 'STA_ID',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
+						'QST_system'       => 'admin-country',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'CNT_ISO',
+					'input_name'     => 'CNT_ISO',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$template                             =
+			REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 *        _attendee_details
+	 *
+	 * @access protected
+	 * @param $post
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function attendee_registrations_meta_box($post)
+	{
+		$this->_template_args['attendee']      = $this->_cpt_model_obj;
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
+		$template                              =
+			REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * add in the form fields for the attendee edit
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string html for new form.
+	 * @throws DomainException
+	 */
+	public function after_title_form_fields($post)
+	{
+		if ($post->post_type == 'espresso_attendees') {
+			$template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+			$template_args['attendee'] = $this->_cpt_model_obj;
+			EEH_Template::display_template($template, $template_args);
+		}
+	}
+
+
+	/**
+	 *        _trash_or_restore_attendee
+	 *
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	protected function _trash_or_restore_attendees($trash = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ATT_MDL = EEM_Attendee::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
+				if ( ! $updated) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
+			//get attendee
+			$att     = $ATT_MDL->get_one_by_ID($ATT_ID);
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
+			$updated = $att->save();
+			if ( ! $updated) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Contacts', 'event_espresso')
+			: esc_html__('Contact', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
+	}
 
 }

core/domain/DomainBase.php

Indentation +127 added lines, -127 removed lines

@@ -18,132 +18,132 @@
 abstract class DomainBase
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var string
-     */
-    private static $plugin_file = '';
-
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private static $version = '';
-
-    /**
-     * @var string $plugin_basename
-     */
-    private static $plugin_basename = '';
-
-    /**
-     * @var string $plugin_path
-     */
-    private static $plugin_path = '';
-
-    /**
-     * @var string $plugin_url
-     */
-    private static $plugin_url = '';
-
-
-
-    /**
-     * Initializes internal static properties.
-     *
-     * @param string $plugin_file
-     * @param string $version
-     */
-    public static function init($plugin_file, $version)
-    {
-        self::$plugin_file = $plugin_file;
-        self::$version = $version;
-        self::$plugin_basename = plugin_basename($plugin_file);
-        self::$plugin_path = plugin_dir_path($plugin_file);
-        self::$plugin_url = plugin_dir_url($plugin_file);
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginFile()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginBasename()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginPath()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginUrl()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function version()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$version;
-    }
-
-
-
-    /**
-     * @param string $method
-     * @throws DomainException
-     */
-    private static function verifyInitialized($method)
-    {
-        if (self::$plugin_file === '') {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '%1$s needs to be called before %2$s can return a value.',
-                        'event_espresso'
-                    ),
-                    get_called_class() . '::init()',
-                    "{$method}()"
-                )
-            );
-        }
-    }
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var string
+	 */
+	private static $plugin_file = '';
+
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private static $version = '';
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private static $plugin_basename = '';
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private static $plugin_path = '';
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private static $plugin_url = '';
+
+
+
+	/**
+	 * Initializes internal static properties.
+	 *
+	 * @param string $plugin_file
+	 * @param string $version
+	 */
+	public static function init($plugin_file, $version)
+	{
+		self::$plugin_file = $plugin_file;
+		self::$version = $version;
+		self::$plugin_basename = plugin_basename($plugin_file);
+		self::$plugin_path = plugin_dir_path($plugin_file);
+		self::$plugin_url = plugin_dir_url($plugin_file);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginFile()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginBasename()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginPath()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginUrl()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function version()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$version;
+	}
+
+
+
+	/**
+	 * @param string $method
+	 * @throws DomainException
+	 */
+	private static function verifyInitialized($method)
+	{
+		if (self::$plugin_file === '') {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'%1$s needs to be called before %2$s can return a value.',
+						'event_espresso'
+					),
+					get_called_class() . '::init()',
+					"{$method}()"
+				)
+			);
+		}
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
                         '%1$s needs to be called before %2$s can return a value.',
                         'event_espresso'
                     ),
-                    get_called_class() . '::init()',
+                    get_called_class().'::init()',
                     "{$method}()"
                 )
             );

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +637 added lines, -637 removed lines

@@ -15,7 +15,7 @@ 
 use EventEspresso\core\exceptions\InvalidFormSubmissionException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -34,642 +34,642 @@ 
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-
-
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if (
-                $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if (! $this->form instanceof EE_Form_Section_Proper) {
-            static $generated = false;
-            if (! $generated) {
-                $generated = true;
-                $form = apply_filters(
-                    'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-                    $this->generate(),
-                    $this
-                );
-                if ($form instanceof EE_Form_Section_Proper) {
-                    $this->setForm($form);
-                }
-            }
-            return $this->verifyForm();
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function verifyForm()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing', 'event_espresso'),
-                $this->form_name
-            )
-        );
-    }
-
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (
-        ! in_array(
-            $form_config,
-            array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-            ),
-            true
-        )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form(false)->enqueue_js();
-    }
-
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_open($this->formAction());
-        }
-        $form_html .= $this->form(true)->get_html($this->form_has_errors);
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    $this->form()->submission_error_message()
-                )
-            );
-        }
-        return $this->form()->valid_data();
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+
+
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if (
+				$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if (! $this->form instanceof EE_Form_Section_Proper) {
+			static $generated = false;
+			if (! $generated) {
+				$generated = true;
+				$form = apply_filters(
+					'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+					$this->generate(),
+					$this
+				);
+				if ($form instanceof EE_Form_Section_Proper) {
+					$this->setForm($form);
+				}
+			}
+			return $this->verifyForm();
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function verifyForm()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing', 'event_espresso'),
+				$this->form_name
+			)
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (
+		! in_array(
+			$form_config,
+			array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+			),
+			true
+		)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form(false)->enqueue_js();
+	}
+
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_open($this->formAction());
+		}
+		$form_html .= $this->form(true)->get_html($this->form_has_errors);
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					$this->form()->submission_error_message()
+				)
+			);
+		}
+		return $this->form()->valid_data();
+	}
 
 
 

Spacing +20 added lines, -20 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidFormSubmissionException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -179,7 +179,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -203,9 +203,9 @@ 
      */
     public function formIsValid()
     {
-        if (! $this->form instanceof EE_Form_Section_Proper) {
+        if ( ! $this->form instanceof EE_Form_Section_Proper) {
             static $generated = false;
-            if (! $generated) {
+            if ( ! $generated) {
                 $generated = true;
                 $form = apply_filters(
                     'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
@@ -290,7 +290,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -316,7 +316,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -342,7 +342,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -367,7 +367,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -398,7 +398,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -522,11 +522,11 @@ 
         $text = ! empty($text) ? $text : $this->submitBtnText();
         return new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(),
+                'html_id'               => 'ee-form-submit-'.$this->slug(),
                 'html_class'            => 'ee-form-submit',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -544,11 +544,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -566,11 +566,11 @@ 
     {
         $cancel_button = new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(), // YES! Same name as submit !!!
+                'html_id'               => 'ee-cancel-form-'.$this->slug(),
                 'html_class'            => 'ee-cancel-form',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -591,7 +591,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -650,11 +650,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        if ( ! $this->form()->was_submitted($submitted_form_data)) {
             throw new InvalidFormSubmissionException($this->form_name);
         }
         $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Indentation +419 added lines, -419 removed lines

@@ -19,420 +19,420 @@ 
 class EE_Payment_Method_Manager implements ResettableInterface
 {
 
-    /**
-     * @var EE_Payment_Method_Manager $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var array keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            self::$_instance = new self();
-        }
-        EE_Registry::instance()->load_lib('PMT_Base');
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-            //if in admin lets ensure caps are set.
-            if (is_admin()) {
-                add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps'));
-                EE_Registry::instance()->CAP->init_caps();
-            }
-        }
-    }
-
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        //keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create classname from module directory name
-        $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ), $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
-        return true;
-    }
-
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie classname without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if (
-            $force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[$payment_method_name])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[$payment_method_name])) {
-            require_once($this->_payment_method_types[$payment_method_name]);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        $payment_method_objects = array();
-        foreach ($this->payment_method_type_names(true) as $classname) {
-            $payment_method_objects[] = new $classname;
-        }
-        return $payment_method_objects;
-    }
-
-
-
-    /**
-     * Changes the payment method's classname into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        $this->maybe_register_payment_methods();
-        return 'EE_PMT_' . $type;
-    }
-
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class;
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        if ($payment_method->type() === 'Invoice') {
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            $message_resource_manager->ensure_messenger_is_active('pdf');
-            EE_Error::add_persistent_admin_notice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->pretty_name(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                        array(array('PMD_type' => array('!=', 'Admin_Only')))
-                    ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        //now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            //verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        return $count_updated;
-    }
-
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter to add dynamic payment method
-     * access caps.
-     *
-     * @param array $caps capabilities being filtered
-     * @return array
-     */
-    public function add_payment_method_caps($caps)
-    {
-        /* add dynamic caps from payment methods
+	/**
+	 * @var EE_Payment_Method_Manager $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			self::$_instance = new self();
+		}
+		EE_Registry::instance()->load_lib('PMT_Base');
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+			//if in admin lets ensure caps are set.
+			if (is_admin()) {
+				add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps'));
+				EE_Registry::instance()->CAP->init_caps();
+			}
+		}
+	}
+
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		//keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create classname from module directory name
+		$module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				), $module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . DS . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
+		return true;
+	}
+
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie classname without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if (
+			$force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[$payment_method_name])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[$payment_method_name])) {
+			require_once($this->_payment_method_types[$payment_method_name]);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		$payment_method_objects = array();
+		foreach ($this->payment_method_type_names(true) as $classname) {
+			$payment_method_objects[] = new $classname;
+		}
+		return $payment_method_objects;
+	}
+
+
+
+	/**
+	 * Changes the payment method's classname into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		$this->maybe_register_payment_methods();
+		return 'EE_PMT_' . $type;
+	}
+
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class;
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		if ($payment_method->type() === 'Invoice') {
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			$message_resource_manager->ensure_messenger_is_active('pdf');
+			EE_Error::add_persistent_admin_notice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->pretty_name(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+						array(array('PMD_type' => array('!=', 'Admin_Only')))
+					) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		//now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			//verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		return $count_updated;
+	}
+
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter to add dynamic payment method
+	 * access caps.
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @return array
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		/* add dynamic caps from payment methods
          * at the time of writing, october 20 2014, these are the caps added:
          * ee_payment_method_admin_only
          * ee_payment_method_aim
@@ -446,10 +446,10 @@ 
          * their related capability automatically added too, so long as they are
          * registered properly using EE_Register_Payment_Method::register()
          */
-        foreach ($this->payment_method_types() as $payment_method_type_obj) {
-            $caps['administrator'][] = $payment_method_type_obj->cap_name();
-        }
-        return $caps;
-    }
+		foreach ($this->payment_method_types() as $payment_method_type_obj) {
+			$caps['administrator'][] = $payment_method_type_obj->cap_name();
+		}
+		return $caps;
+	}
 
 }

core/helpers/EEH_Activation.helper.php

Indentation +1653 added lines, -1653 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\interfaces\ResettableInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,244 +17,244 @@ 
 class EEH_Activation implements ResettableInterface
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * option name that will indicate whether or not we still
-     * need to create EE's folders in the uploads directory
-     * (because if EE was installed without file system access,
-     * we need to request credentials before we can create them)
-     */
-    const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableAnalysis
-     */
-    public static function getTableAnalysis()
-    {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        }
-        return self::$table_analysis;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableManager
-     */
-    public static function getTableManager()
-    {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        }
-        return self::$table_manager;
-    }
-
-
-    /**
-     *    _ensure_table_name_has_prefix
-     *
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     * @access     public
-     * @static
-     * @param $table_name
-     * @return string
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-    /**
-     *    system_initialization
-     *    ensures the EE configuration settings are loaded with at least default options set
-     *    and that all critical EE pages have been generated with the appropriate shortcodes in place
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function system_initialization()
-    {
-        EEH_Activation::reset_and_update_config();
-        //which is fired BEFORE activation of plugin anyways
-        EEH_Activation::verify_default_pages_exist();
-    }
-
-
-    /**
-     * Sets the database schema and creates folders. This should
-     * be called on plugin activation and reactivation
-     *
-     * @return boolean success, whether the database and folders are setup properly
-     * @throws \EE_Error
-     */
-    public static function initialize_db_and_folders()
-    {
-        $good_filesystem = EEH_Activation::create_upload_directories();
-        $good_db         = EEH_Activation::create_database_tables();
-        return $good_filesystem && $good_db;
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws \EE_Error
-     */
-    public static function initialize_db_content()
-    {
-        //let's avoid doing all this logic repeatedly, especially when addons are requesting it
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
-            return;
-        }
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
-
-        EEH_Activation::initialize_system_questions();
-        EEH_Activation::insert_default_status_codes();
-        EEH_Activation::generate_default_message_templates();
-        EEH_Activation::create_no_ticket_prices_array();
-        EE_Registry::instance()->CAP->init_caps();
-
-        EEH_Activation::validate_messages_system();
-        EEH_Activation::insert_default_payment_methods();
-        //in case we've
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::create_cron_tasks();
-        // remove all TXN locks since that is being done via extra meta now
-        delete_option('ee_locked_transactions');
-        //also, check for CAF default db content
-        do_action('AHEE__EEH_Activation__initialize_db_content');
-        //also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
-        //which users really won't care about on initial activation
-        EE_Error::overwrite_success();
-    }
-
-
-    /**
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
-     * (null)
-     *
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function get_cron_tasks($which_to_include)
-    {
-        $cron_tasks = apply_filters(
-            'FHEE__EEH_Activation__get_cron_tasks',
-            array(
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * option name that will indicate whether or not we still
+	 * need to create EE's folders in the uploads directory
+	 * (because if EE was installed without file system access,
+	 * we need to request credentials before we can create them)
+	 */
+	const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableAnalysis
+	 */
+	public static function getTableAnalysis()
+	{
+		if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		}
+		return self::$table_analysis;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableManager
+	 */
+	public static function getTableManager()
+	{
+		if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		}
+		return self::$table_manager;
+	}
+
+
+	/**
+	 *    _ensure_table_name_has_prefix
+	 *
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 * @access     public
+	 * @static
+	 * @param $table_name
+	 * @return string
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+	/**
+	 *    system_initialization
+	 *    ensures the EE configuration settings are loaded with at least default options set
+	 *    and that all critical EE pages have been generated with the appropriate shortcodes in place
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function system_initialization()
+	{
+		EEH_Activation::reset_and_update_config();
+		//which is fired BEFORE activation of plugin anyways
+		EEH_Activation::verify_default_pages_exist();
+	}
+
+
+	/**
+	 * Sets the database schema and creates folders. This should
+	 * be called on plugin activation and reactivation
+	 *
+	 * @return boolean success, whether the database and folders are setup properly
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_and_folders()
+	{
+		$good_filesystem = EEH_Activation::create_upload_directories();
+		$good_db         = EEH_Activation::create_database_tables();
+		return $good_filesystem && $good_db;
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_content()
+	{
+		//let's avoid doing all this logic repeatedly, especially when addons are requesting it
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
+			return;
+		}
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
+
+		EEH_Activation::initialize_system_questions();
+		EEH_Activation::insert_default_status_codes();
+		EEH_Activation::generate_default_message_templates();
+		EEH_Activation::create_no_ticket_prices_array();
+		EE_Registry::instance()->CAP->init_caps();
+
+		EEH_Activation::validate_messages_system();
+		EEH_Activation::insert_default_payment_methods();
+		//in case we've
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::create_cron_tasks();
+		// remove all TXN locks since that is being done via extra meta now
+		delete_option('ee_locked_transactions');
+		//also, check for CAF default db content
+		do_action('AHEE__EEH_Activation__initialize_db_content');
+		//also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
+		//which users really won't care about on initial activation
+		EE_Error::overwrite_success();
+	}
+
+
+	/**
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
+	 * (null)
+	 *
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function get_cron_tasks($which_to_include)
+	{
+		$cron_tasks = apply_filters(
+			'FHEE__EEH_Activation__get_cron_tasks',
+			array(
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
 //				'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
-                //there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
-            )
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws \EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                /**
-                 * This allows client code to define the initial start timestamp for this schedule.
-                 */
-                if (is_array($frequency)
-                    && count($frequency) === 2
-                    && isset($frequency[0], $frequency[1])
-                ) {
-                    $start_timestamp = $frequency[0];
-                    $frequency = $frequency[1];
-                } else {
-                    $start_timestamp = time();
-                }
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
-            }
-        }
-
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws \EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : array();
-        /* reminder of what $crons look like:
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
+				//there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
+			)
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				/**
+				 * This allows client code to define the initial start timestamp for this schedule.
+				 */
+				if (is_array($frequency)
+					&& count($frequency) === 2
+					&& isset($frequency[0], $frequency[1])
+				) {
+					$start_timestamp = $frequency[0];
+					$frequency = $frequency[1];
+				} else {
+					$start_timestamp = time();
+				}
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
+			}
+		}
+
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws \EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : array();
+		/* reminder of what $crons look like:
          * Top-level keys are timestamps, and their values are arrays.
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
          * and their values are arrays.
@@ -271,912 +271,912 @@ 
          *					...
          *      ...
          */
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
-            if (is_array($hooks_to_fire_at_time)) {
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (isset($ee_cron_tasks_to_remove[$hook_name])
-                        && is_array($ee_cron_tasks_to_remove[$hook_name])
-                    ) {
-                        unset($crons[$timestamp][$hook_name]);
-                    }
-                }
-                //also take care of any empty cron timestamps.
-                if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[$timestamp]);
-                }
-            }
-        }
-        _set_cron_array($crons);
-    }
-
-
-    /**
-     *    CPT_initialization
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-
-    /**
-     *    reset_and_update_config
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter(
-            'FHEE__EE_Config___load_core_config__config_settings',
-            array('EEH_Activation', 'migrate_old_config_data'),
-            10,
-            3
-        );
-        //EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-    /**
-     *    load_calendar_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
-        if (empty($plugins)) {
-            return;
-        }
-        foreach ($plugins as $plugin_path) {
-            // grab plugin folder name from path
-            $plugin = basename($plugin_path);
-            // drill down to Espresso plugins
-            // then to calendar related plugins
-            if (
-                strpos($plugin, 'espresso') !== false
-                || strpos($plugin, 'Espresso') !== false
-                || strpos($plugin, 'ee4') !== false
-                || strpos($plugin, 'EE4') !== false
-                || strpos($plugin, 'calendar') !== false
-            ) {
-                // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = array('addons');
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
-
-
-    /**
-     * deactivate_event_espresso
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-
-
-
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ),
-        );
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = __(
-                            'The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso'
-                        );
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                //update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = __(
-                        'The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso'
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            $msg = sprintf(
-                __(
-                    'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                    'event_espresso'
-                ),
-                '<a href="'
-                . admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
-                . '">'
-                . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                . '</a>'
-            );
-            EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, true);
-        }
-    }
-
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    This function generates a post for critical espresso pages
-     *
-     * @access public
-     * @static
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-
-        $post_args = array(
-            'post_title'     => $critical_page['name'],
-            'post_status'    => 'publish',
-            'post_type'      => 'page',
-            'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
-        );
-
-        $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
-            $msg = sprintf(
-                __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return $critical_page;
-        }
-        // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        return $critical_page;
-
-    }
-
-
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if ( ! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        //let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters(
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
-            false,
-            $role_to_check
-        );
-        if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
-        }
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query = $wpdb->prepare(
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
-        );
-        $user_id = $wpdb->get_var($query);
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @access public
-     * @static
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } else if ( ! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        __(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
-
-
-    /**
-     * get_fields_on_table
-     * Gets all the fields on the database table.
-     *
-     * @access     public
-     * @deprecated instead use TableManager::getTableColumns()
-     * @static
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-    /**
-     * db_table_is_empty
-     *
-     * @access     public\
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     * @static
-     * @param string $table_name
-     * @return bool
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-    /**
-     * delete_db_table_if_empty
-     *
-     * @access public
-     * @static
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_db_table_if_empty($table_name)
-    {
-        if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
-            return \EEH_Activation::getTableManager()->dropTable($table_name);
-        }
-        return false;
-    }
-
-
-    /**
-     * delete_unused_db_table
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropTable()
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-    /**
-     * drop_index
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropIndex()
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool | int
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        //find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if ($dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                if (WP_DEBUG) {
-                    foreach ($current_data_migration_script->get_errors() as $error) {
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    EE_Error::add_error(
-                        __(
-                            'There were errors creating the Event Espresso database tables and Event Espresso has been 
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (isset($ee_cron_tasks_to_remove[$hook_name])
+						&& is_array($ee_cron_tasks_to_remove[$hook_name])
+					) {
+						unset($crons[$timestamp][$hook_name]);
+					}
+				}
+				//also take care of any empty cron timestamps.
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[$timestamp]);
+				}
+			}
+		}
+		_set_cron_array($crons);
+	}
+
+
+	/**
+	 *    CPT_initialization
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+
+	/**
+	 *    reset_and_update_config
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter(
+			'FHEE__EE_Config___load_core_config__config_settings',
+			array('EEH_Activation', 'migrate_old_config_data'),
+			10,
+			3
+		);
+		//EE_Config::reset();
+		if (! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+	/**
+	 *    load_calendar_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
+			return;
+		}
+		foreach ($plugins as $plugin_path) {
+			// grab plugin folder name from path
+			$plugin = basename($plugin_path);
+			// drill down to Espresso plugins
+			// then to calendar related plugins
+			if (
+				strpos($plugin, 'espresso') !== false
+				|| strpos($plugin, 'Espresso') !== false
+				|| strpos($plugin, 'ee4') !== false
+				|| strpos($plugin, 'EE4') !== false
+				|| strpos($plugin, 'calendar') !== false
+			) {
+				// this is what we are looking for
+				$calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = array('addons');
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * deactivate_event_espresso
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+
+
+
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			),
+		);
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = __(
+							'The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso'
+						);
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				//update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = __(
+						'The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso'
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			$msg = sprintf(
+				__(
+					'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+					'event_espresso'
+				),
+				'<a href="'
+				. admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
+				. '">'
+				. __('Event Espresso Critical Pages Settings', 'event_espresso')
+				. '</a>'
+			);
+			EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, true);
+		}
+	}
+
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    This function generates a post for critical espresso pages
+	 *
+	 * @access public
+	 * @static
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+
+		$post_args = array(
+			'post_title'     => $critical_page['name'],
+			'post_status'    => 'publish',
+			'post_type'      => 'page',
+			'comment_status' => 'closed',
+			'post_content'   => '[' . $critical_page['code'] . ']',
+		);
+
+		$post_id = wp_insert_post($post_args);
+		if (! $post_id) {
+			$msg = sprintf(
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return $critical_page;
+		}
+		// get newly created post's details
+		if (! $critical_page['post'] = get_post($post_id)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		return $critical_page;
+
+	}
+
+
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if ( ! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		//let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters(
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
+			false,
+			$role_to_check
+		);
+		if ($pre_filtered_id !== false) {
+			return (int)$pre_filtered_id;
+		}
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query = $wpdb->prepare(
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%'
+		);
+		$user_id = $wpdb->get_var($query);
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int)$user_id) {
+			self::$_default_creator_id = (int)$user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @access public
+	 * @static
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} else if ( ! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
+
+
+	/**
+	 * get_fields_on_table
+	 * Gets all the fields on the database table.
+	 *
+	 * @access     public
+	 * @deprecated instead use TableManager::getTableColumns()
+	 * @static
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+	/**
+	 * db_table_is_empty
+	 *
+	 * @access     public\
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 * @static
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+	/**
+	 * delete_db_table_if_empty
+	 *
+	 * @access public
+	 * @static
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_db_table_if_empty($table_name)
+	{
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
+		}
+		return false;
+	}
+
+
+	/**
+	 * delete_unused_db_table
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropTable()
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+	/**
+	 * drop_index
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropIndex()
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool | int
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		//find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if ($dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				if (WP_DEBUG) {
+					foreach ($current_data_migration_script->get_errors() as $error) {
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					EE_Error::add_error(
+						__(
+							'There were errors creating the Event Espresso database tables and Event Espresso has been 
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                return false;
-            }
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        } else {
-            EE_Error::add_error(
-                __(
-                    'Could not determine most up-to-date data migration script from which to pull database schema
+							'event_espresso'
+						)
+					);
+				}
+				return false;
+			}
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		} else {
+			EE_Error::add_error(
+				__(
+					'Could not determine most up-to-date data migration script from which to pull database schema
                      structure. So database is probably not setup properly',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : array();
-        // what we should have
-        $QSG_systems = array(1, 2);
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = array();
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                    case 2:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
-                    );
-                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // what we should have
-        $QST_systems = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'country',
-            'state',
-            'zip',
-            'phone',
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = array();
-            // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'lname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'country':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'phone':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                }
-                if (! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } else {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    }
-                    if (isset($QSG_IDs[$system_question_we_want])) {
-                        $QSG_ID = $QSG_IDs[$system_question_we_want];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            //ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    __(
-                                        'Could not associate question %1$s to a question group because no system question
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : array();
+		// what we should have
+		$QSG_systems = array(1, 2);
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = array();
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if (! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = array(
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						);
+						break;
+					case 2:
+						$QSG_values = array(
+							'QSG_name'            => __('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						);
+						break;
+				}
+				// make sure we have some values before inserting them
+				if (! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
+					);
+					$QSG_IDs[$QSG_system] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// what we should have
+		$QST_systems = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'country',
+			'state',
+			'zip',
+			'phone',
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = array();
+			// if we don't have what we should have
+			if (! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'lname':
+						$QST_values = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email':
+						$QST_values = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'country':
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'phone':
+						$QST_values = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+				}
+				if (! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} else {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					}
+					if (isset($QSG_IDs[$system_question_we_want])) {
+						$QSG_ID = $QSG_IDs[$system_question_we_want];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							//ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									__(
+										'Could not associate question %1$s to a question group because no system question
                                          group existed',
-                                        'event_espresso'
-                                    ),
-                                    $QST_ID),
-                                'error');
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%d', '%d', '%d')
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Makes sure the default payment method (Invoice) is active.
-     * This used to be done automatically as part of constructing the old gateways config
-     *
-     * @throws \EE_Error
-     */
-    public static function insert_default_payment_methods()
-    {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-        } else {
-            EEM_Payment_Method::instance()->verify_button_urls();
-        }
-    }
-
-    /**
-     * insert_default_status_codes
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function insert_default_status_codes()
-    {
-
-        global $wpdb;
-
-        if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
-
-            $table_name = EEM_Status::instance()->table();
-
-            $SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID),
+								'error');
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%d', '%d', '%d')
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Makes sure the default payment method (Invoice) is active.
+	 * This used to be done automatically as part of constructing the old gateways config
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function insert_default_payment_methods()
+	{
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
+			EEM_Payment_Method::instance()->verify_button_urls();
+		}
+	}
+
+	/**
+	 * insert_default_status_codes
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function insert_default_status_codes()
+	{
+
+		global $wpdb;
+
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
+
+			$table_name = EEM_Status::instance()->table();
+
+			$SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1216,521 +1216,521 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-
-        }
-
-    }
-
-
-    /**
-     * create_upload_directories
-     * Creates folders in the uploads directory to facilitate addons and templates
-     *
-     * @access public
-     * @static
-     * @return boolean success of verifying upload directories exist
-     */
-    public static function create_upload_directories()
-    {
-        // Create the required folders
-        $folders = array(
-            EVENT_ESPRESSO_TEMPLATE_DIR,
-            EVENT_ESPRESSO_GATEWAY_DIR,
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
-        );
-        foreach ($folders as $folder) {
-            try {
-                EEH_File::ensure_folder_exists_and_is_writable($folder);
-                @ chmod($folder, 0755);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
-                        $folder,
-                        '<br />' . $e->getMessage()
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //indicate we'll need to fix this later
-                update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
-                return false;
-            }
-        }
-        //just add the .htaccess file to the logs directory to begin with. Even if logging
-        //is disabled, there might be activation errors recorded in there
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
-        //remember EE's folders are all good
-        delete_option(EEH_Activation::upload_directories_incomplete_option_name);
-        return true;
-    }
-
-    /**
-     * Whether the upload directories need to be fixed or not.
-     * If EE is installed but filesystem access isn't initially available,
-     * we need to get the user's filesystem credentials and THEN create them,
-     * so there might be period of time when EE is installed but its
-     * upload directories aren't available. This indicates such a state
-     *
-     * @return boolean
-     */
-    public static function upload_directories_incomplete()
-    {
-        return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
-    }
-
-
-    /**
-     * generate_default_message_templates
-     *
-     * @static
-     * @throws EE_Error
-     * @return bool     true means new templates were created.
-     *                  false means no templates were created.
-     *                  This is NOT an error flag. To check for errors you will want
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
-     */
-    public static function generate_default_message_templates()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        /*
+			$wpdb->query($SQL);
+
+		}
+
+	}
+
+
+	/**
+	 * create_upload_directories
+	 * Creates folders in the uploads directory to facilitate addons and templates
+	 *
+	 * @access public
+	 * @static
+	 * @return boolean success of verifying upload directories exist
+	 */
+	public static function create_upload_directories()
+	{
+		// Create the required folders
+		$folders = array(
+			EVENT_ESPRESSO_TEMPLATE_DIR,
+			EVENT_ESPRESSO_GATEWAY_DIR,
+			EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
+		);
+		foreach ($folders as $folder) {
+			try {
+				EEH_File::ensure_folder_exists_and_is_writable($folder);
+				@ chmod($folder, 0755);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					sprintf(
+						__('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
+						$folder,
+						'<br />' . $e->getMessage()
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//indicate we'll need to fix this later
+				update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
+				return false;
+			}
+		}
+		//just add the .htaccess file to the logs directory to begin with. Even if logging
+		//is disabled, there might be activation errors recorded in there
+		EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
+		//remember EE's folders are all good
+		delete_option(EEH_Activation::upload_directories_incomplete_option_name);
+		return true;
+	}
+
+	/**
+	 * Whether the upload directories need to be fixed or not.
+	 * If EE is installed but filesystem access isn't initially available,
+	 * we need to get the user's filesystem credentials and THEN create them,
+	 * so there might be period of time when EE is installed but its
+	 * upload directories aren't available. This indicates such a state
+	 *
+	 * @return boolean
+	 */
+	public static function upload_directories_incomplete()
+	{
+		return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
+	}
+
+
+	/**
+	 * generate_default_message_templates
+	 *
+	 * @static
+	 * @throws EE_Error
+	 * @return bool     true means new templates were created.
+	 *                  false means no templates were created.
+	 *                  This is NOT an error flag. To check for errors you will want
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
+	 */
+	public static function generate_default_message_templates()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		/*
          * This first method is taking care of ensuring any default messengers
          * that should be made active and have templates generated are done.
          */
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
-            $message_resource_manager
-        );
-        /**
-         * This method is verifying there are no NEW default message types
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
-         */
-        $new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
-            $message_resource_manager
-        );
-        //after all is done, let's persist these changes to the db.
-        $message_resource_manager->update_has_activated_messengers_option();
-        $message_resource_manager->update_active_messengers_option();
-        // will return true if either of these are true.  Otherwise will return false.
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
-    }
-
-
-
-    /**
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $active_messengers = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate = array();
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $default_message_type_name_for_messenger,
-                        $active_messenger->name
-                    )
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            //let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            //activate the templates for these message types
-            if ( ! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            //verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[$name])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $name,
-                        $messenger_to_generate->name
-                    )
-                ) {
-                    unset($default_message_type_names_for_messenger[$key]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate->name,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            //create any templates needing created (or will reactivate templates already generated as necessary).
-            if ( ! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
-
-
-    /**
-     * This returns the default messengers to generate templates for on activation of EE.
-     * It considers:
-     * - whether a messenger is already active in the db.
-     * - whether a messenger has been made active at any time in the past.
-     *
-     * @static
-     * @param  EE_Message_Resource_Manager $message_resource_manager
-     * @return EE_messenger[]
-     */
-    protected static function _get_default_messengers_to_generate_on_activation(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers    = $message_resource_manager->active_messengers();
-        $installed_messengers = $message_resource_manager->installed_messengers();
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
-
-        $messengers_to_generate = array();
-        foreach ($installed_messengers as $installed_messenger) {
-            //if installed messenger is a messenger that should be activated on install
-            //and is not already active
-            //and has never been activated
-            if (
-                ! $installed_messenger->activate_on_install
-                || isset($active_messengers[$installed_messenger->name])
-                || isset($has_activated[$installed_messenger->name])
-            ) {
-                continue;
-            }
-            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
-        }
-        return $messengers_to_generate;
-    }
-
-
-    /**
-     * This simply validates active message types to ensure they actually match installed
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
-     * rows are set inactive.
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
-     * are still handled in here.
-     *
-     * @since 4.3.1
-     * @return void
-     */
-    public static function validate_messages_system()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $message_resource_manager->validate_active_message_types_are_installed();
-        do_action('AHEE__EEH_Activation__validate_messages_system');
-    }
-
-
-    /**
-     * create_no_ticket_prices_array
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function create_no_ticket_prices_array()
-    {
-        // this creates an array for tracking events that have no active ticket prices created
-        // this allows us to warn admins of the situation so that it can be corrected
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
-            add_option('ee_no_ticket_prices', array(), '', false);
-        }
-    }
-
-
-    /**
-     * plugin_deactivation
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function plugin_deactivation()
-    {
-    }
-
-
-    /**
-     * Finds all our EE4 custom post types, and deletes them and their associated data
-     * (like post meta or term relations)
-     *
-     * @global wpdb $wpdb
-     * @throws \EE_Error
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        //get all the CPT post_types
-        $ee_post_types = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_CPT_Base) {
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
-                }
-            }
-        }
-        //get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
-        $cpt_ids = $wpdb->get_col($query);
-        //delete each post meta and term relations too
-        foreach ($cpt_ids as $post_id) {
-            wp_delete_post($post_id, true);
-        }
-    }
-
-    /**
-     * Deletes all EE custom tables
-     *
-     * @return array
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = array();
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (strpos($table->get_table_name(), 'esp_')
-                            &&
-                            (
-                                is_main_site()//main site? nuke them all
-                                || ! $table->is_global()//not main site,but not global either. nuke it
-                            )
-                        ) {
-                            $tables[$table->get_table_name()] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-
-        //there are some tables whose models were removed.
-        //they should be removed when removing all EE core's data
-        $tables_without_models = array(
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        );
-        foreach ($tables_without_models as $table) {
-            $tables[$table] = $table;
-        }
-        return \EEH_Activation::getTableManager()->dropTables($tables);
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            'ee_flush_rewrite_rules'             => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if ( ! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if ( ! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        //also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
-                    $db_update_sans_ee4[$version] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if ( ! empty($undeleted_options)) {
-            $errors .= sprintf(
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if ( ! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-    /**
-     * Gets the mysql error code from the last used query by wpdb
-     *
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
-     */
-    public static function last_wpdb_error_code()
-    {
-        global $wpdb;
-        if ($wpdb->use_mysqli) {
-            return mysqli_errno($wpdb->dbh);
-        } else {
-            return mysql_errno($wpdb->dbh);
-        }
-    }
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     */
-    public static function table_exists($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
-    }
-
-    /**
-     * Resets the cache on EEH_Activation
-     */
-    public static function reset()
-    {
-        self::$_default_creator_id                             = null;
-        self::$_initialized_db_content_already_in_this_request = false;
-    }
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
+			$message_resource_manager
+		);
+		/**
+		 * This method is verifying there are no NEW default message types
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
+		 */
+		$new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
+			$message_resource_manager
+		);
+		//after all is done, let's persist these changes to the db.
+		$message_resource_manager->update_has_activated_messengers_option();
+		$message_resource_manager->update_active_messengers_option();
+		// will return true if either of these are true.  Otherwise will return false.
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
+	}
+
+
+
+	/**
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$active_messengers = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate = array();
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
+						$default_message_type_name_for_messenger,
+						$active_messenger->name
+					)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[$default_message_type_name_for_messenger])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			//let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			//activate the templates for these message types
+			if ( ! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			//verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[$name])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$name,
+						$messenger_to_generate->name
+					)
+				) {
+					unset($default_message_type_names_for_messenger[$key]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate->name,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			//create any templates needing created (or will reactivate templates already generated as necessary).
+			if ( ! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
+
+
+	/**
+	 * This returns the default messengers to generate templates for on activation of EE.
+	 * It considers:
+	 * - whether a messenger is already active in the db.
+	 * - whether a messenger has been made active at any time in the past.
+	 *
+	 * @static
+	 * @param  EE_Message_Resource_Manager $message_resource_manager
+	 * @return EE_messenger[]
+	 */
+	protected static function _get_default_messengers_to_generate_on_activation(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers    = $message_resource_manager->active_messengers();
+		$installed_messengers = $message_resource_manager->installed_messengers();
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
+
+		$messengers_to_generate = array();
+		foreach ($installed_messengers as $installed_messenger) {
+			//if installed messenger is a messenger that should be activated on install
+			//and is not already active
+			//and has never been activated
+			if (
+				! $installed_messenger->activate_on_install
+				|| isset($active_messengers[$installed_messenger->name])
+				|| isset($has_activated[$installed_messenger->name])
+			) {
+				continue;
+			}
+			$messengers_to_generate[$installed_messenger->name] = $installed_messenger;
+		}
+		return $messengers_to_generate;
+	}
+
+
+	/**
+	 * This simply validates active message types to ensure they actually match installed
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
+	 * rows are set inactive.
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
+	 * are still handled in here.
+	 *
+	 * @since 4.3.1
+	 * @return void
+	 */
+	public static function validate_messages_system()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$message_resource_manager->validate_active_message_types_are_installed();
+		do_action('AHEE__EEH_Activation__validate_messages_system');
+	}
+
+
+	/**
+	 * create_no_ticket_prices_array
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function create_no_ticket_prices_array()
+	{
+		// this creates an array for tracking events that have no active ticket prices created
+		// this allows us to warn admins of the situation so that it can be corrected
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
+		if (! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', false);
+		}
+	}
+
+
+	/**
+	 * plugin_deactivation
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function plugin_deactivation()
+	{
+	}
+
+
+	/**
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
+	 * (like post meta or term relations)
+	 *
+	 * @global wpdb $wpdb
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		//get all the CPT post_types
+		$ee_post_types = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
+				}
+			}
+		}
+		//get all our CPTs
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+		$cpt_ids = $wpdb->get_col($query);
+		//delete each post meta and term relations too
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
+		}
+	}
+
+	/**
+	 * Deletes all EE custom tables
+	 *
+	 * @return array
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = array();
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (strpos($table->get_table_name(), 'esp_')
+							&&
+							(
+								is_main_site()//main site? nuke them all
+								|| ! $table->is_global()//not main site,but not global either. nuke it
+							)
+						) {
+							$tables[$table->get_table_name()] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+
+		//there are some tables whose models were removed.
+		//they should be removed when removing all EE core's data
+		$tables_without_models = array(
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		);
+		foreach ($tables_without_models as $table) {
+			$tables[$table] = $table;
+		}
+		return \EEH_Activation::getTableManager()->dropTables($tables);
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			'ee_flush_rewrite_rules'             => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if ( ! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if ( ! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		//also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string)$version[0] === '3') {//if its NON EE4
+					$db_update_sans_ee4[$version] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if ( ! empty($undeleted_options)) {
+			$errors .= sprintf(
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if ( ! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+	/**
+	 * Gets the mysql error code from the last used query by wpdb
+	 *
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
+	 */
+	public static function last_wpdb_error_code()
+	{
+		global $wpdb;
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
+		} else {
+			return mysql_errno($wpdb->dbh);
+		}
+	}
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 */
+	public static function table_exists($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
+	}
+
+	/**
+	 * Resets the cache on EEH_Activation
+	 */
+	public static function reset()
+	{
+		self::$_default_creator_id                             = null;
+		self::$_initialized_db_content_already_in_this_request = false;
+	}
 }
 // End of file EEH_Activation.helper.php
 // Location: /helpers/EEH_Activation.core.php

core/admin/EE_Admin_Page.core.php

Indentation +3299 added lines, -3299 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\interfaces\InterminableInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -30,2114 +30,2114 @@ 
 {
 
 
-    //set in _init_page_props()
-    public $page_slug;
+	//set in _init_page_props()
+	public $page_slug;
 
-    public $page_label;
+	public $page_label;
 
-    public $page_folder;
+	public $page_folder;
 
-    //set in define_page_props()
-    protected $_admin_base_url;
+	//set in define_page_props()
+	protected $_admin_base_url;
 
-    protected $_admin_base_path;
+	protected $_admin_base_path;
 
-    protected $_admin_page_title;
+	protected $_admin_page_title;
 
-    protected $_labels;
+	protected $_labels;
 
 
-    //set early within EE_Admin_Init
-    protected $_wp_page_slug;
+	//set early within EE_Admin_Init
+	protected $_wp_page_slug;
 
-    //navtabs
-    protected $_nav_tabs;
+	//navtabs
+	protected $_nav_tabs;
 
-    protected $_default_nav_tab_name;
+	protected $_default_nav_tab_name;
 
-    //helptourstops
-    protected $_help_tour = array();
+	//helptourstops
+	protected $_help_tour = array();
 
 
-    //template variables (used by templates)
-    protected $_template_path;
+	//template variables (used by templates)
+	protected $_template_path;
 
-    protected $_column_template_path;
+	protected $_column_template_path;
 
-    /**
-     * @var array $_template_args
-     */
-    protected $_template_args = array();
+	/**
+	 * @var array $_template_args
+	 */
+	protected $_template_args = array();
 
-    /**
-     * this will hold the list table object for a given view.
-     *
-     * @var EE_Admin_List_Table $_list_table_object
-     */
-    protected $_list_table_object;
+	/**
+	 * this will hold the list table object for a given view.
+	 *
+	 * @var EE_Admin_List_Table $_list_table_object
+	 */
+	protected $_list_table_object;
 
-    //bools
-    protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
+	//bools
+	protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
 
-    protected $_routing;
+	protected $_routing;
 
-    //list table args
-    protected $_view;
+	//list table args
+	protected $_view;
 
-    protected $_views;
+	protected $_views;
 
 
-    //action => method pairs used for routing incoming requests
-    protected $_page_routes;
+	//action => method pairs used for routing incoming requests
+	protected $_page_routes;
 
-    protected $_page_config;
+	protected $_page_config;
 
-    //the current page route and route config
-    protected $_route;
+	//the current page route and route config
+	protected $_route;
 
-    protected $_route_config;
+	protected $_route_config;
 
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     * @var array.
-     */
-    protected $_default_route_query_args;
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 * @var array.
+	 */
+	protected $_default_route_query_args;
 
-    //set via request page and action args.
-    protected $_current_page;
+	//set via request page and action args.
+	protected $_current_page;
 
-    protected $_current_view;
+	protected $_current_view;
 
-    protected $_current_page_view_url;
+	protected $_current_page_view_url;
 
-    //sanitized request action (and nonce)
-    /**
-     * @var string $_req_action
-     */
-    protected $_req_action;
+	//sanitized request action (and nonce)
+	/**
+	 * @var string $_req_action
+	 */
+	protected $_req_action;
 
-    /**
-     * @var string $_req_nonce
-     */
-    protected $_req_nonce;
+	/**
+	 * @var string $_req_nonce
+	 */
+	protected $_req_nonce;
 
-    //search related
-    protected $_search_btn_label;
+	//search related
+	protected $_search_btn_label;
 
-    protected $_search_box_callback;
+	protected $_search_box_callback;
 
-    /**
-     * WP Current Screen object
-     *
-     * @var WP_Screen
-     */
-    protected $_current_screen;
+	/**
+	 * WP Current Screen object
+	 *
+	 * @var WP_Screen
+	 */
+	protected $_current_screen;
 
-    //for holding EE_Admin_Hooks object when needed (set via set_hook_object())
-    protected $_hook_obj;
+	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
+	protected $_hook_obj;
 
-    //for holding incoming request data
-    protected $_req_data;
+	//for holding incoming request data
+	protected $_req_data;
 
-    // yes / no array for admin form fields
-    protected $_yes_no_values = array();
-
-    //some default things shared by all child classes
-    protected $_default_espresso_metaboxes;
-
-    /**
-     *    EE_Registry Object
-     *
-     * @var    EE_Registry
-     * @access    protected
-     */
-    protected $EE = null;
-
-
-
-    /**
-     * This is just a property that flags whether the given route is a caffeinated route or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
-            $this->_is_caf = true;
-        }
-        $this->_yes_no_values = array(
-                array('id' => true, 'text' => __('Yes', 'event_espresso')),
-                array('id' => false, 'text' => __('No', 'event_espresso')),
-        );
-        //set the _req_data property.
-        $this->_req_data = array_merge($_GET, $_POST);
-        //routing enabled?
-        $this->_routing = $routing;
-        //set initial page props (child method)
-        $this->_init_page_props();
-        //set global defaults
-        $this->_set_defaults();
-        //set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        //other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        //This just allows us to have extending classes do something specific
-        // before the parent constructor runs _page_setup().
-        if (method_exists($this, '_before_page_setup')) {
-            $this->_before_page_setup();
-        }
-        //set up page dependencies
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => __('label for add new button'),
-     *            'edit' => __('label for edit button'),
-     *            'delete' => __('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
-     * route. Here's the format
-     * $this->_page_routes = array(
-     *        'default' => array(
-     *            'func' => '_default_method_handling_route',
-     *            'args' => array('array','of','args'),
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
-     *        ),
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
-     *        )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_routes();
-
-
-
-    /**
-     * _set_page_config
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
-     * Format:
-     * $this->_page_config = array(
-     *        'default' => array(
-     *            'labels' => array(
-     *                'buttons' => array(
-     *                    'add' => __('label for adding item'),
-     *                    'edit' => __('label for editing item'),
-     *                    'delete' => __('label for deleting item')
-     *                ),
-     *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
-     *            'nav' => array(
-     *                'label' => __('Label for Tab', 'event_espresso').
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
-     *                'order' => 10, //required to indicate tab position.
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
-     *            this flag to make sure the necessary js gets enqueued on page load.
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
-     *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
-     *                'tab_id' => array(
-     *                    'title' => 'tab_title',
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
-     *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
-     *                    ),
-     *                'tab2_id' => array(
-     *                    'title' => 'tab2 title',
-     *                    'filename' => 'file_name_2'
-     *                    'callback' => 'callback_method_for_content',
-     *                 ),
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
-     *            'help_tour' => array(
-     *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
-     *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
-     *            ),
-     *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
-     *            'require_nonce' to FALSE
-     *            )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_config();
-
-
-
-
-
-    /** end sample help_tour methods **/
-    /**
-     * _add_screen_options
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_screen_options();
-
-
-
-    /**
-     * _add_feature_pointers
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     *
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_feature_pointers();
-
-
-
-    /**
-     * load_scripts_styles
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
-     * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function load_scripts_styles();
-
-
-
-    /**
-     * admin_init
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_init();
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_notices();
-
-
-
-    /**
-     * admin_footer_scripts
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access public
-     * @return void
-     */
-    abstract public function admin_footer_scripts();
-
-
-
-    /**
-     * admin_footer
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access  public
-     * @return void
-     */
-    public function admin_footer()
-    {
-    }
-
-
-
-    /**
-     * _global_ajax_hooks
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    protected function _global_ajax_hooks()
-    {
-        //for lazy loading of metabox content
-        add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
-    }
-
-
-
-    public function ajax_metabox_content()
-    {
-        $contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
-        $url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
-        self::cached_rss_display($contentid, $url);
-        wp_die();
-    }
-
-
-
-    /**
-     * _page_setup
-     * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
-     *
-     * @final
-     * @access protected
-     * @return void
-     */
-    final protected function _page_setup()
-    {
-        //requires?
-        //admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
-        add_action('admin_init', array($this, 'admin_init_global'), 5);
-        //next verify if we need to load anything...
-        $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
-        $this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
-        global $ee_menu_slugs;
-        $ee_menu_slugs = (array)$ee_menu_slugs;
-        if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
-            return;
-        }
-        // becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
-        if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
-            $this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
-        }
-        // then set blank or -1 action values to 'default'
-        $this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
-        //if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
-        $this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        //however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
-        $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        $this->_current_view = $this->_req_action;
-        $this->_req_nonce = $this->_req_action . '_nonce';
-        $this->_define_page_props();
-        $this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
-        //default things
-        $this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
-        //set page configs
-        $this->_set_page_routes();
-        $this->_set_page_config();
-        //let's include any referrer data in our default_query_args for this route for "stickiness".
-        if (isset($this->_req_data['wp_referer'])) {
-            $this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
-        }
-        //for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
-        if (method_exists($this, '_extend_page_config')) {
-            $this->_extend_page_config();
-        }
-        //for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
-            $this->_extend_page_config_for_cpt();
-        }
-        //filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
-        $this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
-        //if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
-        }
-        //next route only if routing enabled
-        if ($this->_routing && ! defined('DOING_AJAX')) {
-            $this->_verify_routes();
-            //next let's just check user_access and kill if no access
-            $this->check_user_access();
-            if ($this->_is_UI_request) {
-                //admin_init stuff - global, all views for this page class, specific view
-                add_action('admin_init', array($this, 'admin_init'), 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
-                }
-            } else {
-                //hijack regular WP loading and route admin request immediately
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
-                $this->route_admin_request();
-            }
-        }
-    }
-
-
-
-    /**
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _do_other_page_hooks()
-    {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
-        foreach ($registered_pages as $page) {
-            //now let's setup the file name and class that should be present
-            $classname = str_replace('.class.php', '', $page);
-            //autoloaders should take care of loading file
-            if ( ! class_exists($classname)) {
-                $error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
-                $error_msg[] = $error_msg[0]
-                               . "\r\n"
-                               . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'), $page, '<br />', '<strong>' . $classname . '</strong>');
-                throw new EE_Error(implode('||', $error_msg));
-            }
-            $a = new ReflectionClass($classname);
-            //notice we are passing the instance of this class to the hook object.
-            $hookobj[] = $a->newInstance($this);
-        }
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
-     *
-     * @access public
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //let's set the current_screen and screen options to override what WP set
-        $this->_current_screen = get_current_screen();
-        //load admin_notices - global, page class, and view specific
-        add_action('admin_notices', array($this, 'admin_notices_global'), 5);
-        add_action('admin_notices', array($this, 'admin_notices'), 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
-        }
-        //load network admin_notices - global, page class, and view specific
-        add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
-        }
-        //this will save any per_page screen options if they are present
-        $this->_set_per_page_screen_options();
-        //setup list table properties
-        $this->_set_list_table();
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
-        $this->_add_registered_meta_boxes();
-        $this->_add_screen_columns();
-        //add screen options - global, page child class, and view specific
-        $this->_add_global_screen_options();
-        $this->_add_screen_options();
-        if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
-        }
-        //add help tab(s) and tours- set via page_config and qtips.
-        $this->_add_help_tour();
-        $this->_add_help_tabs();
-        $this->_add_qtips();
-        //add feature_pointers - global, page child class, and view specific
-        $this->_add_feature_pointers();
-        $this->_add_global_feature_pointers();
-        if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
-        }
-        //enqueue scripts/styles - global, page class, and view specific
-        add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
-        add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
-        if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
-            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
-        }
-        add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
-        //admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
-        if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
-            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
-        }
-        //admin footer scripts
-        add_action('admin_footer', array($this, 'admin_footer_global'), 99);
-        add_action('admin_footer', array($this, 'admin_footer'), 100);
-        if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
-            add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
-        }
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
-        //targeted hook
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
-    }
-
-
-
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        $this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
-        $this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
-        $this->default_nav_tab_name = 'overview';
-        //init template args
-        $this->_template_args = array(
-                'admin_page_header'  => '',
-                'admin_page_content' => '',
-                'post_body_content'  => '',
-                'before_list_table'  => '',
-                'after_list_table'   => '',
-        );
-    }
-
-
-
-    /**
-     * route_admin_request
-     *
-     * @see    _route_admin_request()
-     * @access public
-     * @return void|exception error
-     */
-    public function route_admin_request()
-    {
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    public function set_wp_page_slug($wp_page_slug)
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-        //if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
-        if (is_network_admin()) {
-            $this->_wp_page_slug .= '-network';
-        }
-    }
-
-
-
-    /**
-     * _verify_routes
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _verify_routes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
-            return false;
-        }
-        $this->_route = false;
-        $func = false;
-        $args = array();
-        // check that the page_routes array is not empty
-        if (empty($this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        // and that the requested page route exists
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route = $this->_page_routes[$this->_req_action];
-            $this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        // and that a default route exists
-        if ( ! array_key_exists('default', $this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        //first lets' catch if the UI request has EVER been set.
-        if ($this->_is_UI_request === null) {
-            //lets set if this is a UI request or not.
-            $this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
-            //wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
-        }
-        $this->_set_current_labels();
-    }
-
-
-
-    /**
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
-     *
-     * @param  string $route the route name we're verifying
-     * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
-     */
-    protected function _verify_route($route)
-    {
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            return true;
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
-            throw new EE_Error($error_msg);
-        }
-    }
-
-
-
-    /**
-     * perform nonce verification
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
-     *
-     * @param  string $nonce     The nonce sent
-     * @param  string $nonce_ref The nonce reference string (name0)
-     * @return mixed (bool|die)
-     */
-    protected function _verify_nonce($nonce, $nonce_ref)
-    {
-        // verify nonce against expected value
-        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
-            // these are not the droids you are looking for !!!
-            $msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
-            if (WP_DEBUG) {
-                $msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
-            }
-            if ( ! defined('DOING_AJAX')) {
-                wp_die($msg);
-            } else {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                $this->_return_json();
-            }
-        }
-    }
-
-
-
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _route_admin_request()
-    {
-        if ( ! $this->_is_UI_request) {
-            $this->_verify_routes();
-        }
-        $nonce_check = isset($this->_route_config['require_nonce'])
-            ? $this->_route_config['require_nonce']
-            : true;
-        if ($this->_req_action !== 'default' && $nonce_check) {
-            // set nonce from post data
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce])
-                : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        //set the nav_tabs array but ONLY if this is  UI_request
-        if ($this->_is_UI_request) {
-            $this->_set_nav_tabs();
-        }
-        // grab callback function
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
-        // check if callback has args
-        $args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
-        $error_msg = '';
-        // action right before calling route
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
-        }
-        // right before calling the route, let's remove _wp_http_referer from the
-        // $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
-        $_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
-        if ( ! empty($func)) {
-            if (is_array($func)) {
-                list($class, $method) = $func;
-            } else if (strpos($func, '::') !== false) {
-                list($class, $method) = explode('::', $func);
-            } else {
-                $class = $this;
-                $method = $func;
-            }
-            if ( ! (is_object($class) && $class === $this)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page_object'] = $this;
-            }
-
-            if (
-                //is it a method on a class that doesn't work?
-                (
-                    (
-                        method_exists($class, $method)
-                        && call_user_func_array(array($class, $method), $args) === false
-                    )
-                    && (
-                        //is it a standalone function that doesn't work?
-                        function_exists($method)
-                        && call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
-                    )
-                )
-                || (
-                    //is it neither a class method NOR a standalone function?
-                    ! method_exists($class, $method)
-                    && ! function_exists($method)
-                )
-            ) {
-                // user error msg
-                $error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
-                // developer error msg
-                $error_msg .= '||';
-                $error_msg .= sprintf(
-                    __(
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
-                        'event_espresso'
-                    ),
-                    $method
-                );
-            }
-            if ( ! empty($error_msg)) {
-                throw new EE_Error($error_msg);
-            }
-        }
-        //if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
-        //now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
-        if ($this->_is_UI_request === false
-            && is_array($this->_route)
-            && ! empty($this->_route['headers_sent_route'])
-        ) {
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
-        }
-    }
-
-
-
-    /**
-     * This method just allows the resetting of page properties in the case where a no headers
-     * route redirects to a headers route in its route config.
-     *
-     * @since   4.3.0
-     * @param  string $new_route New (non header) route to redirect to.
-     * @return   void
-     */
-    protected function _reset_routing_properties($new_route)
-    {
-        $this->_is_UI_request = true;
-        //now we set the current route to whatever the headers_sent_route is set at
-        $this->_req_data['action'] = $new_route;
-        //rerun page setup
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *(internally just uses EEH_URL's function with the same name)
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
-     *                                        url in an associative array indexed by the key 'wp_referer';
-     *                                        Example usage:
-     *                                        If the current page is:
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
-     *                                        &action=default&event_id=20&month_range=March%202015
-     *                                        &_wpnonce=5467821
-     *                                        and you call:
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
-     *                                        array(
-     *                                        'action' => 'resend_something',
-     *                                        'page=>espresso_registrations'
-     *                                        ),
-     *                                        $some_url,
-     *                                        true
-     *                                        );
-     *                                        It will produce a url in this structure:
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
-     *                                        month_range]=March%202015
-     * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
-    {
-        //if there is a _wp_http_referer include the values from the request but only if sticky = true
-        if ($sticky) {
-            $request = $_REQUEST;
-            unset($request['_wp_http_referer']);
-            unset($request['wp_referer']);
-            foreach ($request as $key => $value) {
-                //do not add nonces
-                if (strpos($key, 'nonce') !== false) {
-                    continue;
-                }
-                $args['wp_referer[' . $key . ']'] = $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
-    }
-
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param  string $help_tab_id the id for the connected help tab
-     * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @uses EEH_Template::get_help_tab_link()
-     * @return string              generated link
-     */
-    protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
-    {
-        return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
-    }
-
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tabs()
-    {
-        $tour_buttons = '';
-        if (isset($this->_page_config[$this->_req_action])) {
-            $config = $this->_page_config[$this->_req_action];
-            //is there a help tour for the current route?  if there is let's setup the tour buttons
-            if (isset($this->_help_tour[$this->_req_action])) {
-                $tb = array();
-                $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
-                foreach ($this->_help_tour['tours'] as $tour) {
-                    //if this is the end tour then we don't need to setup a button
-                    if ($tour instanceof EE_Help_Tour_final_stop) {
-                        continue;
-                    }
-                    $tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
-                }
-                $tour_buttons .= implode('<br />', $tb);
-                $tour_buttons .= '</div></div>';
-            }
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
-            if (is_array($config) && isset($config['help_sidebar'])) {
-                //check that the callback given is valid
-                if ( ! method_exists($this, $config['help_sidebar'])) {
-                    throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
-                            'event_espresso'), $config['help_sidebar'], get_class($this)));
-                }
-                $content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
-                $content .= $tour_buttons; //add help tour buttons.
-                //do we have any help tours setup?  Cause if we do we want to add the buttons
-                $this->_current_screen->set_help_sidebar($content);
-            }
-            //if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
-            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
-                $this->_current_screen->set_help_sidebar($tour_buttons);
-            }
-            //handle if no help_tabs are set so the sidebar will still show for the help tour buttons
-            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
-                $_ht['id'] = $this->page_slug;
-                $_ht['title'] = __('Help Tours', 'event_espresso');
-                $_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
-                $this->_current_screen->add_help_tab($_ht);
-            }/**/
-            if ( ! isset($config['help_tabs'])) {
-                return;
-            } //no help tabs for this route
-            foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
-                //we're here so there ARE help tabs!
-                //make sure we've got what we need
-                if ( ! isset($cfg['title'])) {
-                    throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
-                }
-                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
-                    throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
-                            'event_espresso'));
-                }
-                //first priority goes to content.
-                if ( ! empty($cfg['content'])) {
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
-                    //second priority goes to filename
-                } else if ( ! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
-                    //it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
-                        EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
-                                'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    $template_args['admin_page_obj'] = $this;
-                    $content = EEH_Template::display_template($file_path, $template_args, true);
-                } else {
-                    $content = '';
-                }
-                //check if callback is valid
-                if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
-                    EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
-                            'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
-                    return;
-                }
-                //setup config array for help tab method
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
-                $_ht = array(
-                        'id'       => $id,
-                        'title'    => $cfg['title'],
-                        'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
-                        'content'  => $content,
-                );
-                $this->_current_screen->add_help_tab($_ht);
-            }
-        }
-    }
-
-
-
-    /**
-     * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
-     *
-     * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tour()
-    {
-        $tours = array();
-        $this->_help_tour = array();
-        //exit early if help tours are turned off globally
-        if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
-            return;
-        }
-        //loop through _page_config to find any help_tour defined
-        foreach ($this->_page_config as $route => $config) {
-            //we're only going to set things up for this route
-            if ($route !== $this->_req_action) {
-                continue;
-            }
-            if (isset($config['help_tour'])) {
-                foreach ($config['help_tour'] as $tour) {
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
-                    //let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path)) {
-                        EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
-                                $file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    require_once $file_path;
-                    if ( ! class_exists($tour)) {
-                        $error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
-                        $error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
-                                        'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
-                        throw new EE_Error(implode('||', $error_msg));
-                    }
-                    $a = new ReflectionClass($tour);
-                    $tour_obj = $a->newInstance($this->_is_caf);
-                    $tours[] = $tour_obj;
-                    $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
-                }
-                //let's inject the end tour stop element common to all pages... this will only get seen once per machine.
-                $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
-                $tours[] = $end_stop_tour;
-                $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
-            }
-        }
-        if ( ! empty($tours)) {
-            $this->_help_tour['tours'] = $tours;
-        }
-        //thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
-    }
-
-
-
-    /**
-     * This simply sets up any qtips that have been defined in the page config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array)$this->_route_config['qtips'];
-            //load qtip loader
-            $path = array(
-                    $this->_get_dir() . '/qtips/',
-                    EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            );
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_nav_tabs()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $i = 0;
-        foreach ($this->_page_config as $slug => $config) {
-            if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
-                continue;
-            } //no nav tab for this config
-            //check for persistent flag
-            if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
-                continue;
-            } //nav tab is only to appear when route requested.
-            if ( ! $this->check_user_access($slug, true)) {
-                continue;
-            } //no nav tab becasue current user does not have access.
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[$slug] = array(
-                    'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
-                    'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
-                    'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
-                    'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
-            );
-            $i++;
-        }
-        //if $this->_nav_tabs is empty then lets set the default
-        if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[$this->default_nav_tab_name] = array(
-                    'url'       => $this->admin_base_url,
-                    'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
-                    'css_class' => 'nav-tab-active',
-                    'order'     => 10,
-            );
-        }
-        //now let's sort the tabs according to order
-        usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
-    }
-
-
-
-    /**
-     * _set_current_labels
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_current_labels()
-    {
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
-            foreach ($this->_route_config['labels'] as $label => $text) {
-                if (is_array($text)) {
-                    foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[$label][$sublabel] = $subtext;
-                    }
-                } else {
-                    $this->_labels[$label] = $text;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        verifies user access for this admin page
-     *
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
-     * @return        BOOL|wp_die()
-     */
-    public function check_user_access($route_to_check = '', $verify_only = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
-                ? $this->_page_routes[$route_to_check]['capability'] : null;
-        if (empty($capability) && empty($route_to_check)) {
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
-        } else {
-            $capability = empty($capability) ? 'manage_options' : $capability;
-        }
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
-        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
-            if ($verify_only) {
-                return false;
-            } else {
-                if ( is_user_logged_in() ) {
-                    wp_die(__('You do not have access to this route.', 'event_espresso'));
-                } else {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_init_global()
-    {
-    }
-
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @access public
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-        //if metaboxes are present we need to add the nonce field
-        if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
-     *
-     * @access  public
-     * @return  void
-     */
-    public function admin_footer_global()
-    {
-        //dialog container for dialog helper
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
-        $d_cont .= '<div class="ee-notices"></div>';
-        $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
-        $d_cont .= '</div>';
-        echo $d_cont;
-        //help tour stuff?
-        if (isset($this->_help_tour[$this->_req_action])) {
-            echo implode('<br />', $this->_help_tour[$this->_req_action]);
-        }
-        //current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
-    }
-
-
-
-    /**
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
-     * For child classes:
-     * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
-     * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
-     *    'help_trigger_id' => array(
-     *        'title' => __('localized title for popup', 'event_espresso'),
-     *        'content' => __('localized content for popup', 'event_espresso')
-     *    )
-     * );
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
-     *
-     * @access protected
-     * @return string content
-     */
-    protected function _set_help_popup_content($help_array = array(), $display = false)
-    {
-        $content = '';
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
-        //loop through the array and setup content
-        foreach ($help_array as $trigger => $help) {
-            //make sure the array is setup properly
-            if ( ! isset($help['title']) || ! isset($help['content'])) {
-                throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'));
-            }
-            //we're good so let'd setup the template vars and then assign parsed template content to our content.
-            $template_args = array(
-                    'help_popup_id'      => $trigger,
-                    'help_popup_title'   => $help['title'],
-                    'help_popup_content' => $help['content'],
-            );
-            $content .= EEH_Template::display_template($template_path, $template_args, true);
-        }
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * All this does is retrive the help content array if set by the EE_Admin_Page child
-     *
-     * @access private
-     * @return array properly formatted array for help popup content
-     */
-    private function _get_help_content()
-    {
-        //what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        //if method doesn't exist let's get out.
-        if ( ! method_exists($this, $method_name)) {
-            return array();
-        }
-        //k we're good to go let's retrieve the help array
-        $help_array = call_user_func(array($this, $method_name));
-        //make sure we've got an array!
-        if ( ! is_array($help_array)) {
-            throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
-        }
-        return $help_array;
-    }
-
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @access protected
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
-     * @param boolean $display    if false then we return the trigger string
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     */
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
-    {
-        if (defined('DOING_AJAX')) {
-            return;
-        }
-        //let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
-            $help_array[$trigger_id] = array(
-                    'title'   => __('Missing Content', 'event_espresso'),
-                    'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                            'event_espresso'),
-            );
-            $help_content = $this->_set_help_popup_content($help_array, false);
-        }
-        //let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content = $content . $help_content;
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access private
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        /** STYLES **/
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', array($this, 'add_xdebug_style'));
-        }
-        // register all styles
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
-        //helpers styles
-        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
-        /** SCRIPTS **/
-        //register all scripts
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
-        add_filter('FHEE_load_joyride', '__return_true');
-        //script for sorting tables
-        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
-        //script for parsing uri's
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
-        //and parsing associative serialized form elements
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        //helpers scripts
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
-        //google charts
-        wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
-        // ENQUEUE ALL BASICS BY DEFAULT
-        wp_enqueue_style('ee-admin-css');
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-accounting');
-        wp_enqueue_script('jquery-validate');
-        //taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-        // LOCALIZED DATA
-        //localize script for ajax lazy loading
-        $lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
-        /**
-         * help tour stuff
-         */
-        if ( ! empty($this->_help_tour)) {
-            //register the js for kicking things off
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
-            //setup tours for the js tour object
-            foreach ($this->_help_tour['tours'] as $tour) {
-                $tours[] = array(
-                        'id'      => $tour->get_slug(),
-                        'options' => $tour->get_options(),
-                );
-            }
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
-            //admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
-        }
-    }
-
-
-
-    /**
-     *        admin_footer_scripts_eei18n_js_strings
-     *
-     * @access        public
-     * @return        void
-     */
-    public function admin_footer_scripts_eei18n_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
-        EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
-        EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
-        EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
-        EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
-        EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
-        EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
-        EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
-        EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
-        EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
-        EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
-        EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
-    }
-
-
-
-    /**
-     *        load enhanced xdebug styles for ppl with failing eyesight
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_xdebug_style()
-    {
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
-    }
-
-
-    /************************/
-    /** LIST TABLE METHODS **/
-    /************************/
-    /**
-     * this sets up the list table if the current view requires it.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table()
-    {
-        //first is this a list_table view?
-        if ( ! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        //list table functions are per view specific (because some admin pages might have more than one listtable!)
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
-            //user error msg
-            $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
-            //developer error msg
-            $error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
-        $this->_set_list_table_view();
-        $this->_set_list_table_object();
-    }
-
-
-
-    /**
-     *        set current view for List Table
-     *
-     * @access public
-     * @return array
-     */
-    protected function _set_list_table_view()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // looking at active items or dumpster diving ?
-        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
-        } else {
-            $this->_view = sanitize_key($this->_req_data['status']);
-        }
-    }
-
-
-
-    /**
-     * _set_list_table_object
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_list_table_object()
-    {
-        if (isset($this->_route_config['list_table'])) {
-            if ( ! class_exists($this->_route_config['list_table'])) {
-                throw new EE_Error(
-                        sprintf(
-                                __(
-                                        'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
-                                        'event_espresso'
-                                ),
-                                $this->_route_config['list_table'],
-                                get_class($this)
-                        )
-                );
-            }
-            $list_table = $this->_route_config['list_table'];
-            $this->_list_table_object = new $list_table($this);
-        }
-    }
-
-
-
-    /**
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
-     *
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
-     *                                                    urls.  The array should be indexed by the view it is being
-     *                                                    added to.
-     * @return array
-     */
-    public function get_list_table_view_RLs($extra_query_args = array())
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (empty($this->_views)) {
-            $this->_views = array();
-        }
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = array();
-            // check for current view
-            $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
-            $query_args['action'] = $this->_req_action;
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-            $query_args['status'] = $view['slug'];
-            //merge any other arguments sent in.
-            if (isset($extra_query_args[$view['slug']])) {
-                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
-            }
-            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        }
-        return $this->_views;
-    }
-
-
-
-    /**
-     * _entries_per_page_dropdown
-     * generates a drop down box for selecting the number of visiable rows in an admin page list table
-     *
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
-     * @access protected
-     * @param int $max_entries total number of rows in the table
-     * @return string
-     */
-    protected function _entries_per_page_dropdown($max_entries = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $values = array(10, 25, 50, 100);
-        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+	// yes / no array for admin form fields
+	protected $_yes_no_values = array();
+
+	//some default things shared by all child classes
+	protected $_default_espresso_metaboxes;
+
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var    EE_Registry
+	 * @access    protected
+	 */
+	protected $EE = null;
+
+
+
+	/**
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
+			$this->_is_caf = true;
+		}
+		$this->_yes_no_values = array(
+				array('id' => true, 'text' => __('Yes', 'event_espresso')),
+				array('id' => false, 'text' => __('No', 'event_espresso')),
+		);
+		//set the _req_data property.
+		$this->_req_data = array_merge($_GET, $_POST);
+		//routing enabled?
+		$this->_routing = $routing;
+		//set initial page props (child method)
+		$this->_init_page_props();
+		//set global defaults
+		$this->_set_defaults();
+		//set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		//other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		//This just allows us to have extending classes do something specific
+		// before the parent constructor runs _page_setup().
+		if (method_exists($this, '_before_page_setup')) {
+			$this->_before_page_setup();
+		}
+		//set up page dependencies
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => __('label for add new button'),
+	 *            'edit' => __('label for edit button'),
+	 *            'delete' => __('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
+	 * route. Here's the format
+	 * $this->_page_routes = array(
+	 *        'default' => array(
+	 *            'func' => '_default_method_handling_route',
+	 *            'args' => array('array','of','args'),
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
+	 *        ),
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
+	 *        )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_routes();
+
+
+
+	/**
+	 * _set_page_config
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
+	 * Format:
+	 * $this->_page_config = array(
+	 *        'default' => array(
+	 *            'labels' => array(
+	 *                'buttons' => array(
+	 *                    'add' => __('label for adding item'),
+	 *                    'edit' => __('label for editing item'),
+	 *                    'delete' => __('label for deleting item')
+	 *                ),
+	 *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
+	 *            'nav' => array(
+	 *                'label' => __('Label for Tab', 'event_espresso').
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
+	 *                'order' => 10, //required to indicate tab position.
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
+	 *            this flag to make sure the necessary js gets enqueued on page load.
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
+	 *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
+	 *                'tab_id' => array(
+	 *                    'title' => 'tab_title',
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
+	 *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
+	 *                    ),
+	 *                'tab2_id' => array(
+	 *                    'title' => 'tab2 title',
+	 *                    'filename' => 'file_name_2'
+	 *                    'callback' => 'callback_method_for_content',
+	 *                 ),
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
+	 *            'help_tour' => array(
+	 *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
+	 *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
+	 *            ),
+	 *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
+	 *            'require_nonce' to FALSE
+	 *            )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_config();
+
+
+
+
+
+	/** end sample help_tour methods **/
+	/**
+	 * _add_screen_options
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_screen_options();
+
+
+
+	/**
+	 * _add_feature_pointers
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 *
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_feature_pointers();
+
+
+
+	/**
+	 * load_scripts_styles
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
+	 * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function load_scripts_styles();
+
+
+
+	/**
+	 * admin_init
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_init();
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_notices();
+
+
+
+	/**
+	 * admin_footer_scripts
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_footer_scripts();
+
+
+
+	/**
+	 * admin_footer
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access  public
+	 * @return void
+	 */
+	public function admin_footer()
+	{
+	}
+
+
+
+	/**
+	 * _global_ajax_hooks
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	protected function _global_ajax_hooks()
+	{
+		//for lazy loading of metabox content
+		add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
+	}
+
+
+
+	public function ajax_metabox_content()
+	{
+		$contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
+		$url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
+		self::cached_rss_display($contentid, $url);
+		wp_die();
+	}
+
+
+
+	/**
+	 * _page_setup
+	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
+	 *
+	 * @final
+	 * @access protected
+	 * @return void
+	 */
+	final protected function _page_setup()
+	{
+		//requires?
+		//admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
+		add_action('admin_init', array($this, 'admin_init_global'), 5);
+		//next verify if we need to load anything...
+		$this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
+		$this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
+		global $ee_menu_slugs;
+		$ee_menu_slugs = (array)$ee_menu_slugs;
+		if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
+			return;
+		}
+		// becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
+		if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
+			$this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
+		}
+		// then set blank or -1 action values to 'default'
+		$this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
+		//if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
+		$this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
+		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		$this->_current_view = $this->_req_action;
+		$this->_req_nonce = $this->_req_action . '_nonce';
+		$this->_define_page_props();
+		$this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
+		//default things
+		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
+		//set page configs
+		$this->_set_page_routes();
+		$this->_set_page_config();
+		//let's include any referrer data in our default_query_args for this route for "stickiness".
+		if (isset($this->_req_data['wp_referer'])) {
+			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
+		}
+		//for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
+		if (method_exists($this, '_extend_page_config')) {
+			$this->_extend_page_config();
+		}
+		//for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
+			$this->_extend_page_config_for_cpt();
+		}
+		//filter routes and page_config so addons can add their stuff. Filtering done per class
+		$this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
+		$this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
+		//if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+			add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
+		}
+		//next route only if routing enabled
+		if ($this->_routing && ! defined('DOING_AJAX')) {
+			$this->_verify_routes();
+			//next let's just check user_access and kill if no access
+			$this->check_user_access();
+			if ($this->_is_UI_request) {
+				//admin_init stuff - global, all views for this page class, specific view
+				add_action('admin_init', array($this, 'admin_init'), 10);
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
+					add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
+				}
+			} else {
+				//hijack regular WP loading and route admin request immediately
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
+				$this->route_admin_request();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _do_other_page_hooks()
+	{
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
+		foreach ($registered_pages as $page) {
+			//now let's setup the file name and class that should be present
+			$classname = str_replace('.class.php', '', $page);
+			//autoloaders should take care of loading file
+			if ( ! class_exists($classname)) {
+				$error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
+				$error_msg[] = $error_msg[0]
+							   . "\r\n"
+							   . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'), $page, '<br />', '<strong>' . $classname . '</strong>');
+				throw new EE_Error(implode('||', $error_msg));
+			}
+			$a = new ReflectionClass($classname);
+			//notice we are passing the instance of this class to the hook object.
+			$hookobj[] = $a->newInstance($this);
+		}
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * load_page_dependencies
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//let's set the current_screen and screen options to override what WP set
+		$this->_current_screen = get_current_screen();
+		//load admin_notices - global, page class, and view specific
+		add_action('admin_notices', array($this, 'admin_notices_global'), 5);
+		add_action('admin_notices', array($this, 'admin_notices'), 10);
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
+			add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
+		}
+		//load network admin_notices - global, page class, and view specific
+		add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
+			add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
+		}
+		//this will save any per_page screen options if they are present
+		$this->_set_per_page_screen_options();
+		//setup list table properties
+		$this->_set_list_table();
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
+		$this->_add_registered_meta_boxes();
+		$this->_add_screen_columns();
+		//add screen options - global, page child class, and view specific
+		$this->_add_global_screen_options();
+		$this->_add_screen_options();
+		if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
+		}
+		//add help tab(s) and tours- set via page_config and qtips.
+		$this->_add_help_tour();
+		$this->_add_help_tabs();
+		$this->_add_qtips();
+		//add feature_pointers - global, page child class, and view specific
+		$this->_add_feature_pointers();
+		$this->_add_global_feature_pointers();
+		if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
+		}
+		//enqueue scripts/styles - global, page class, and view specific
+		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
+		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
+		if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
+			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
+		}
+		add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
+		//admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
+		if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
+			add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
+		}
+		//admin footer scripts
+		add_action('admin_footer', array($this, 'admin_footer_global'), 99);
+		add_action('admin_footer', array($this, 'admin_footer'), 100);
+		if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
+			add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
+		}
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
+		//targeted hook
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
+	}
+
+
+
+	/**
+	 * _set_defaults
+	 * This sets some global defaults for class properties.
+	 */
+	private function _set_defaults()
+	{
+		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
+		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
+		$this->default_nav_tab_name = 'overview';
+		//init template args
+		$this->_template_args = array(
+				'admin_page_header'  => '',
+				'admin_page_content' => '',
+				'post_body_content'  => '',
+				'before_list_table'  => '',
+				'after_list_table'   => '',
+		);
+	}
+
+
+
+	/**
+	 * route_admin_request
+	 *
+	 * @see    _route_admin_request()
+	 * @access public
+	 * @return void|exception error
+	 */
+	public function route_admin_request()
+	{
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	public function set_wp_page_slug($wp_page_slug)
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
+		if (is_network_admin()) {
+			$this->_wp_page_slug .= '-network';
+		}
+	}
+
+
+
+	/**
+	 * _verify_routes
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _verify_routes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
+			return false;
+		}
+		$this->_route = false;
+		$func = false;
+		$args = array();
+		// check that the page_routes array is not empty
+		if (empty($this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		// and that the requested page route exists
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			$this->_route = $this->_page_routes[$this->_req_action];
+			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		// and that a default route exists
+		if ( ! array_key_exists('default', $this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		//first lets' catch if the UI request has EVER been set.
+		if ($this->_is_UI_request === null) {
+			//lets set if this is a UI request or not.
+			$this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
+			//wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
+		}
+		$this->_set_current_labels();
+	}
+
+
+
+	/**
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
+	 *
+	 * @param  string $route the route name we're verifying
+	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
+	 */
+	protected function _verify_route($route)
+	{
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			return true;
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
+			throw new EE_Error($error_msg);
+		}
+	}
+
+
+
+	/**
+	 * perform nonce verification
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
+	 *
+	 * @param  string $nonce     The nonce sent
+	 * @param  string $nonce_ref The nonce reference string (name0)
+	 * @return mixed (bool|die)
+	 */
+	protected function _verify_nonce($nonce, $nonce_ref)
+	{
+		// verify nonce against expected value
+		if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
+			// these are not the droids you are looking for !!!
+			$msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
+			if (WP_DEBUG) {
+				$msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
+			}
+			if ( ! defined('DOING_AJAX')) {
+				wp_die($msg);
+			} else {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				$this->_return_json();
+			}
+		}
+	}
+
+
+
+	/**
+	 * _route_admin_request()
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _route_admin_request()
+	{
+		if ( ! $this->_is_UI_request) {
+			$this->_verify_routes();
+		}
+		$nonce_check = isset($this->_route_config['require_nonce'])
+			? $this->_route_config['require_nonce']
+			: true;
+		if ($this->_req_action !== 'default' && $nonce_check) {
+			// set nonce from post data
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce])
+				: '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		//set the nav_tabs array but ONLY if this is  UI_request
+		if ($this->_is_UI_request) {
+			$this->_set_nav_tabs();
+		}
+		// grab callback function
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
+		// check if callback has args
+		$args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
+		$error_msg = '';
+		// action right before calling route
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
+		if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
+		}
+		// right before calling the route, let's remove _wp_http_referer from the
+		// $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
+		$_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
+		if ( ! empty($func)) {
+			if (is_array($func)) {
+				list($class, $method) = $func;
+			} else if (strpos($func, '::') !== false) {
+				list($class, $method) = explode('::', $func);
+			} else {
+				$class = $this;
+				$method = $func;
+			}
+			if ( ! (is_object($class) && $class === $this)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page_object'] = $this;
+			}
+
+			if (
+				//is it a method on a class that doesn't work?
+				(
+					(
+						method_exists($class, $method)
+						&& call_user_func_array(array($class, $method), $args) === false
+					)
+					&& (
+						//is it a standalone function that doesn't work?
+						function_exists($method)
+						&& call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
+					)
+				)
+				|| (
+					//is it neither a class method NOR a standalone function?
+					! method_exists($class, $method)
+					&& ! function_exists($method)
+				)
+			) {
+				// user error msg
+				$error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
+				// developer error msg
+				$error_msg .= '||';
+				$error_msg .= sprintf(
+					__(
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
+						'event_espresso'
+					),
+					$method
+				);
+			}
+			if ( ! empty($error_msg)) {
+				throw new EE_Error($error_msg);
+			}
+		}
+		//if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
+		//now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
+		if ($this->_is_UI_request === false
+			&& is_array($this->_route)
+			&& ! empty($this->_route['headers_sent_route'])
+		) {
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
+		}
+	}
+
+
+
+	/**
+	 * This method just allows the resetting of page properties in the case where a no headers
+	 * route redirects to a headers route in its route config.
+	 *
+	 * @since   4.3.0
+	 * @param  string $new_route New (non header) route to redirect to.
+	 * @return   void
+	 */
+	protected function _reset_routing_properties($new_route)
+	{
+		$this->_is_UI_request = true;
+		//now we set the current route to whatever the headers_sent_route is set at
+		$this->_req_data['action'] = $new_route;
+		//rerun page setup
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *(internally just uses EEH_URL's function with the same name)
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
+	 *                                        url in an associative array indexed by the key 'wp_referer';
+	 *                                        Example usage:
+	 *                                        If the current page is:
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
+	 *                                        &action=default&event_id=20&month_range=March%202015
+	 *                                        &_wpnonce=5467821
+	 *                                        and you call:
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
+	 *                                        array(
+	 *                                        'action' => 'resend_something',
+	 *                                        'page=>espresso_registrations'
+	 *                                        ),
+	 *                                        $some_url,
+	 *                                        true
+	 *                                        );
+	 *                                        It will produce a url in this structure:
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
+	 *                                        month_range]=March%202015
+	 * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
+	{
+		//if there is a _wp_http_referer include the values from the request but only if sticky = true
+		if ($sticky) {
+			$request = $_REQUEST;
+			unset($request['_wp_http_referer']);
+			unset($request['wp_referer']);
+			foreach ($request as $key => $value) {
+				//do not add nonces
+				if (strpos($key, 'nonce') !== false) {
+					continue;
+				}
+				$args['wp_referer[' . $key . ']'] = $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
+	}
+
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param  string $help_tab_id the id for the connected help tab
+	 * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @uses EEH_Template::get_help_tab_link()
+	 * @return string              generated link
+	 */
+	protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
+	{
+		return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
+	}
+
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tabs()
+	{
+		$tour_buttons = '';
+		if (isset($this->_page_config[$this->_req_action])) {
+			$config = $this->_page_config[$this->_req_action];
+			//is there a help tour for the current route?  if there is let's setup the tour buttons
+			if (isset($this->_help_tour[$this->_req_action])) {
+				$tb = array();
+				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
+				foreach ($this->_help_tour['tours'] as $tour) {
+					//if this is the end tour then we don't need to setup a button
+					if ($tour instanceof EE_Help_Tour_final_stop) {
+						continue;
+					}
+					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
+				}
+				$tour_buttons .= implode('<br />', $tb);
+				$tour_buttons .= '</div></div>';
+			}
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
+			if (is_array($config) && isset($config['help_sidebar'])) {
+				//check that the callback given is valid
+				if ( ! method_exists($this, $config['help_sidebar'])) {
+					throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
+							'event_espresso'), $config['help_sidebar'], get_class($this)));
+				}
+				$content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
+				$content .= $tour_buttons; //add help tour buttons.
+				//do we have any help tours setup?  Cause if we do we want to add the buttons
+				$this->_current_screen->set_help_sidebar($content);
+			}
+			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
+			if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
+				$this->_current_screen->set_help_sidebar($tour_buttons);
+			}
+			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
+			if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
+				$_ht['id'] = $this->page_slug;
+				$_ht['title'] = __('Help Tours', 'event_espresso');
+				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
+				$this->_current_screen->add_help_tab($_ht);
+			}/**/
+			if ( ! isset($config['help_tabs'])) {
+				return;
+			} //no help tabs for this route
+			foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
+				//we're here so there ARE help tabs!
+				//make sure we've got what we need
+				if ( ! isset($cfg['title'])) {
+					throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
+				}
+				if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+					throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
+							'event_espresso'));
+				}
+				//first priority goes to content.
+				if ( ! empty($cfg['content'])) {
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
+					//second priority goes to filename
+				} else if ( ! empty($cfg['filename'])) {
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+					//it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
+						EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
+								'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					$template_args['admin_page_obj'] = $this;
+					$content = EEH_Template::display_template($file_path, $template_args, true);
+				} else {
+					$content = '';
+				}
+				//check if callback is valid
+				if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
+					EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
+							'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
+					return;
+				}
+				//setup config array for help tab method
+				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+				$_ht = array(
+						'id'       => $id,
+						'title'    => $cfg['title'],
+						'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
+						'content'  => $content,
+				);
+				$this->_current_screen->add_help_tab($_ht);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
+	 *
+	 * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tour()
+	{
+		$tours = array();
+		$this->_help_tour = array();
+		//exit early if help tours are turned off globally
+		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
+			return;
+		}
+		//loop through _page_config to find any help_tour defined
+		foreach ($this->_page_config as $route => $config) {
+			//we're only going to set things up for this route
+			if ($route !== $this->_req_action) {
+				continue;
+			}
+			if (isset($config['help_tour'])) {
+				foreach ($config['help_tour'] as $tour) {
+					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
+					//let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path)) {
+						EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
+								$file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					require_once $file_path;
+					if ( ! class_exists($tour)) {
+						$error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
+						$error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
+										'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
+						throw new EE_Error(implode('||', $error_msg));
+					}
+					$a = new ReflectionClass($tour);
+					$tour_obj = $a->newInstance($this->_is_caf);
+					$tours[] = $tour_obj;
+					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
+				}
+				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
+				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
+				$tours[] = $end_stop_tour;
+				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
+			}
+		}
+		if ( ! empty($tours)) {
+			$this->_help_tour['tours'] = $tours;
+		}
+		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
+	}
+
+
+
+	/**
+	 * This simply sets up any qtips that have been defined in the page config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array)$this->_route_config['qtips'];
+			//load qtip loader
+			$path = array(
+					$this->_get_dir() . '/qtips/',
+					EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			);
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_nav_tabs()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$i = 0;
+		foreach ($this->_page_config as $slug => $config) {
+			if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
+				continue;
+			} //no nav tab for this config
+			//check for persistent flag
+			if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
+				continue;
+			} //nav tab is only to appear when route requested.
+			if ( ! $this->check_user_access($slug, true)) {
+				continue;
+			} //no nav tab becasue current user does not have access.
+			$css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+			$this->_nav_tabs[$slug] = array(
+					'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
+					'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
+					'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
+					'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
+			);
+			$i++;
+		}
+		//if $this->_nav_tabs is empty then lets set the default
+		if (empty($this->_nav_tabs)) {
+			$this->_nav_tabs[$this->default_nav_tab_name] = array(
+					'url'       => $this->admin_base_url,
+					'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
+					'css_class' => 'nav-tab-active',
+					'order'     => 10,
+			);
+		}
+		//now let's sort the tabs according to order
+		usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
+	}
+
+
+
+	/**
+	 * _set_current_labels
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_current_labels()
+	{
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
+			foreach ($this->_route_config['labels'] as $label => $text) {
+				if (is_array($text)) {
+					foreach ($text as $sublabel => $subtext) {
+						$this->_labels[$label][$sublabel] = $subtext;
+					}
+				} else {
+					$this->_labels[$label] = $text;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        verifies user access for this admin page
+	 *
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
+	 * @return        BOOL|wp_die()
+	 */
+	public function check_user_access($route_to_check = '', $verify_only = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
+		$capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
+				? $this->_page_routes[$route_to_check]['capability'] : null;
+		if (empty($capability) && empty($route_to_check)) {
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
+		} else {
+			$capability = empty($capability) ? 'manage_options' : $capability;
+		}
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
+		if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
+			if ($verify_only) {
+				return false;
+			} else {
+				if ( is_user_logged_in() ) {
+					wp_die(__('You do not have access to this route.', 'event_espresso'));
+				} else {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+	}
+
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+		//if metaboxes are present we need to add the nonce field
+		if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
+	 *
+	 * @access  public
+	 * @return  void
+	 */
+	public function admin_footer_global()
+	{
+		//dialog container for dialog helper
+		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
+		$d_cont .= '<div class="ee-notices"></div>';
+		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
+		$d_cont .= '</div>';
+		echo $d_cont;
+		//help tour stuff?
+		if (isset($this->_help_tour[$this->_req_action])) {
+			echo implode('<br />', $this->_help_tour[$this->_req_action]);
+		}
+		//current set timezone for timezone js
+		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
+	}
+
+
+
+	/**
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
+	 * For child classes:
+	 * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
+	 * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
+	 *    'help_trigger_id' => array(
+	 *        'title' => __('localized title for popup', 'event_espresso'),
+	 *        'content' => __('localized content for popup', 'event_espresso')
+	 *    )
+	 * );
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
+	 *
+	 * @access protected
+	 * @return string content
+	 */
+	protected function _set_help_popup_content($help_array = array(), $display = false)
+	{
+		$content = '';
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
+		//loop through the array and setup content
+		foreach ($help_array as $trigger => $help) {
+			//make sure the array is setup properly
+			if ( ! isset($help['title']) || ! isset($help['content'])) {
+				throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'));
+			}
+			//we're good so let'd setup the template vars and then assign parsed template content to our content.
+			$template_args = array(
+					'help_popup_id'      => $trigger,
+					'help_popup_title'   => $help['title'],
+					'help_popup_content' => $help['content'],
+			);
+			$content .= EEH_Template::display_template($template_path, $template_args, true);
+		}
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * All this does is retrive the help content array if set by the EE_Admin_Page child
+	 *
+	 * @access private
+	 * @return array properly formatted array for help popup content
+	 */
+	private function _get_help_content()
+	{
+		//what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		//if method doesn't exist let's get out.
+		if ( ! method_exists($this, $method_name)) {
+			return array();
+		}
+		//k we're good to go let's retrieve the help array
+		$help_array = call_user_func(array($this, $method_name));
+		//make sure we've got an array!
+		if ( ! is_array($help_array)) {
+			throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
+		}
+		return $help_array;
+	}
+
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @access protected
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
+	 * @param boolean $display    if false then we return the trigger string
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 */
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
+	{
+		if (defined('DOING_AJAX')) {
+			return;
+		}
+		//let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+			$help_array[$trigger_id] = array(
+					'title'   => __('Missing Content', 'event_espresso'),
+					'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+							'event_espresso'),
+			);
+			$help_content = $this->_set_help_popup_content($help_array, false);
+		}
+		//let's setup the trigger
+		$content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+		$content = $content . $help_content;
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access private
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		/** STYLES **/
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', array($this, 'add_xdebug_style'));
+		}
+		// register all styles
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
+		//helpers styles
+		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
+		/** SCRIPTS **/
+		//register all scripts
+		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
+		add_filter('FHEE_load_joyride', '__return_true');
+		//script for sorting tables
+		wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+		//script for parsing uri's
+		wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
+		//and parsing associative serialized form elements
+		wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		//helpers scripts
+		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
+		//google charts
+		wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
+		// ENQUEUE ALL BASICS BY DEFAULT
+		wp_enqueue_style('ee-admin-css');
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-accounting');
+		wp_enqueue_script('jquery-validate');
+		//taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+		// LOCALIZED DATA
+		//localize script for ajax lazy loading
+		$lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
+		/**
+		 * help tour stuff
+		 */
+		if ( ! empty($this->_help_tour)) {
+			//register the js for kicking things off
+			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
+			//setup tours for the js tour object
+			foreach ($this->_help_tour['tours'] as $tour) {
+				$tours[] = array(
+						'id'      => $tour->get_slug(),
+						'options' => $tour->get_options(),
+				);
+			}
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
+			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
+		}
+	}
+
+
+
+	/**
+	 *        admin_footer_scripts_eei18n_js_strings
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function admin_footer_scripts_eei18n_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
+		EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
+		EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
+		EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
+		EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
+		EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
+		EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
+		EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
+		EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
+		EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
+		EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
+		EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
+	}
+
+
+
+	/**
+	 *        load enhanced xdebug styles for ppl with failing eyesight
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_xdebug_style()
+	{
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
+	}
+
+
+	/************************/
+	/** LIST TABLE METHODS **/
+	/************************/
+	/**
+	 * this sets up the list table if the current view requires it.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table()
+	{
+		//first is this a list_table view?
+		if ( ! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		//list table functions are per view specific (because some admin pages might have more than one listtable!)
+		if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
+			//user error msg
+			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
+			//developer error msg
+			$error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
+							$this->_req_action, '_set_list_table_views_' . $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
+		$this->_set_list_table_view();
+		$this->_set_list_table_object();
+	}
+
+
+
+	/**
+	 *        set current view for List Table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	protected function _set_list_table_view()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// looking at active items or dumpster diving ?
+		if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
+		} else {
+			$this->_view = sanitize_key($this->_req_data['status']);
+		}
+	}
+
+
+
+	/**
+	 * _set_list_table_object
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_list_table_object()
+	{
+		if (isset($this->_route_config['list_table'])) {
+			if ( ! class_exists($this->_route_config['list_table'])) {
+				throw new EE_Error(
+						sprintf(
+								__(
+										'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
+										'event_espresso'
+								),
+								$this->_route_config['list_table'],
+								get_class($this)
+						)
+				);
+			}
+			$list_table = $this->_route_config['list_table'];
+			$this->_list_table_object = new $list_table($this);
+		}
+	}
+
+
+
+	/**
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
+	 *
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
+	 *                                                    urls.  The array should be indexed by the view it is being
+	 *                                                    added to.
+	 * @return array
+	 */
+	public function get_list_table_view_RLs($extra_query_args = array())
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (empty($this->_views)) {
+			$this->_views = array();
+		}
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = array();
+			// check for current view
+			$this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
+			$query_args['action'] = $this->_req_action;
+			$query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+			$query_args['status'] = $view['slug'];
+			//merge any other arguments sent in.
+			if (isset($extra_query_args[$view['slug']])) {
+				$query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
+			}
+			$this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		}
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * _entries_per_page_dropdown
+	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
+	 *
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
+	 * @access protected
+	 * @param int $max_entries total number of rows in the table
+	 * @return string
+	 */
+	protected function _entries_per_page_dropdown($max_entries = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$values = array(10, 25, 50, 100);
+		$per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
+		if ($max_entries) {
+			$values[] = $max_entries;
+			sort($values);
+		}
+		$entries_per_page_dropdown = '
 			<div id="entries-per-page-dv" class="alignleft actions">
 				<label class="hide-if-no-js">
 					Show
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
-        foreach ($values as $value) {
-            if ($value < $max_entries) {
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
-                $entries_per_page_dropdown .= '
+		foreach ($values as $value) {
+			if ($value < $max_entries) {
+				$selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
+				$entries_per_page_dropdown .= '
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
-            }
-        }
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
-        $entries_per_page_dropdown .= '
+			}
+		}
+		$selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
+		$entries_per_page_dropdown .= '
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
-        $entries_per_page_dropdown .= '
+		$entries_per_page_dropdown .= '
 					</select>
 					entries
 				</label>
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
 			</div>
 		';
-        return $entries_per_page_dropdown;
-    }
-
-
-
-    /**
-     *        _set_search_attributes
-     *
-     * @access        protected
-     * @return        void
-     */
-    public function _set_search_attributes()
-    {
-        $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
-    }
-
-    /*** END LIST TABLE METHODS **/
-    /*****************************/
-    /**
-     *        _add_registered_metaboxes
-     *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
-     * @access private
-     * @return void
-     */
-    private function _add_registered_meta_boxes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //we only add meta boxes if the page_route calls for it
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
-            && is_array(
-                    $this->_route_config['metaboxes']
-            )
-        ) {
-            // this simply loops through the callbacks provided
-            // and checks if there is a corresponding callback registered by the child
-            // if there is then we go ahead and process the metabox loader.
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
-                } else {
-                    $result = call_user_func(array($this, &$metabox_callback));
-                }
-                if ($result === false) {
-                    // user error msg
-                    $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
-                    // developer error msg
-                    $error_msg .= '||' . sprintf(
-                                    __(
-                                            'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
-                                            'event_espresso'
-                                    ),
-                                    $metabox_callback
-                            );
-                    throw new EE_Error($error_msg);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * _add_screen_columns
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-                is_array($this->_route_config)
-                && isset($this->_route_config['columns'])
-                && is_array($this->_route_config['columns'])
-                && count($this->_route_config['columns']) === 2
-        ) {
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
-            $screen_id = $this->_current_screen->id;
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
-            $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
-            $this->_template_args['screen'] = $this->_current_screen;
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
-            //finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
-            $this->_route_config['has_metaboxes'] = true;
-        }
-    }
-
-
-
-    /**********************************/
-    /** GLOBALLY AVAILABLE METABOXES **/
-    /**
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
-     * loaded on.
-     */
-    private function _espresso_news_post_box()
-    {
-        $news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
-        add_meta_box('espresso_news_post_box', $news_box_title, array(
-                $this,
-                'espresso_news_post_box',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox.
-     */
-    protected function _espresso_ratings_request()
-    {
-        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
-            return '';
-        }
-        $ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
-        add_meta_box('espresso_ratings_request', $ratings_box_title, array(
-                $this,
-                'espresso_ratings_request',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     */
-    public function espresso_ratings_request()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
-        EEH_Template::display_template($template_path, array());
-    }
-
-
-
-    public static function cached_rss_display($rss_id, $url)
-    {
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
-        $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
-        $post = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
-        if (false != ($output = get_transient($cache_key))) {
-            echo $pre . $output . $post;
-            return true;
-        }
-        if ( ! $doing_ajax) {
-            echo $pre . $loading . $post;
-            return false;
-        }
-        ob_start();
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
-        return true;
-    }
-
-
-
-    public function espresso_news_post_box()
-    {
-        ?>
+		return $entries_per_page_dropdown;
+	}
+
+
+
+	/**
+	 *        _set_search_attributes
+	 *
+	 * @access        protected
+	 * @return        void
+	 */
+	public function _set_search_attributes()
+	{
+		$this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
+	}
+
+	/*** END LIST TABLE METHODS **/
+	/*****************************/
+	/**
+	 *        _add_registered_metaboxes
+	 *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
+	 * @access private
+	 * @return void
+	 */
+	private function _add_registered_meta_boxes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//we only add meta boxes if the page_route calls for it
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
+			&& is_array(
+					$this->_route_config['metaboxes']
+			)
+		) {
+			// this simply loops through the callbacks provided
+			// and checks if there is a corresponding callback registered by the child
+			// if there is then we go ahead and process the metabox loader.
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
+				} else {
+					$result = call_user_func(array($this, &$metabox_callback));
+				}
+				if ($result === false) {
+					// user error msg
+					$error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
+					// developer error msg
+					$error_msg .= '||' . sprintf(
+									__(
+											'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
+											'event_espresso'
+									),
+									$metabox_callback
+							);
+					throw new EE_Error($error_msg);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * _add_screen_columns
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+				is_array($this->_route_config)
+				&& isset($this->_route_config['columns'])
+				&& is_array($this->_route_config['columns'])
+				&& count($this->_route_config['columns']) === 2
+		) {
+			add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
+			$screen_id = $this->_current_screen->id;
+			$screen_columns = (int)get_user_option("screen_layout_$screen_id");
+			$total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
+			$this->_template_args['screen'] = $this->_current_screen;
+			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
+			//finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
+			$this->_route_config['has_metaboxes'] = true;
+		}
+	}
+
+
+
+	/**********************************/
+	/** GLOBALLY AVAILABLE METABOXES **/
+	/**
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
+	 * loaded on.
+	 */
+	private function _espresso_news_post_box()
+	{
+		$news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
+		add_meta_box('espresso_news_post_box', $news_box_title, array(
+				$this,
+				'espresso_news_post_box',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox.
+	 */
+	protected function _espresso_ratings_request()
+	{
+		if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+			return '';
+		}
+		$ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
+		add_meta_box('espresso_ratings_request', $ratings_box_title, array(
+				$this,
+				'espresso_ratings_request',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 */
+	public function espresso_ratings_request()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
+		EEH_Template::display_template($template_path, array());
+	}
+
+
+
+	public static function cached_rss_display($rss_id, $url)
+	{
+		$loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
+		$doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
+		$post = '</div>' . "\n";
+		$cache_key = 'ee_rss_' . md5($rss_id);
+		if (false != ($output = get_transient($cache_key))) {
+			echo $pre . $output . $post;
+			return true;
+		}
+		if ( ! $doing_ajax) {
+			echo $pre . $loading . $post;
+			return false;
+		}
+		ob_start();
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
+		return true;
+	}
+
+
+
+	public function espresso_news_post_box()
+	{
+		?>
         <div class="padding">
             <div id="espresso_news_post_box_content" class="infolinks">
                 <?php
-                // Get RSS Feed(s)
-                $feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
-                $url = urlencode($feed_url);
-                self::cached_rss_display('espresso_news_post_box_content', $url);
-                ?>
+				// Get RSS Feed(s)
+				$feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
+				$url = urlencode($feed_url);
+				self::cached_rss_display('espresso_news_post_box_content', $url);
+				?>
             </div>
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
         </div>
         <?php
-    }
-
-
-
-    private function _espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    public function espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
-        //EEH_Template::display_template( $templatepath );
-    }
-
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        $show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
-        if ($show_sponsors) {
-            add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
-        }
-    }
-
-
-
-    public function espresso_sponsors_post_box()
-    {
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
-        EEH_Template::display_template($templatepath);
-    }
-
-
-
-    private function _publish_post_box()
-    {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
-        //if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
-        } else {
-            $box_label = __('Publish', 'event_espresso');
-        }
-        $box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
-        add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
-    }
-
-
-
-    public function editor_overview()
-    {
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /** end of globally available metaboxes section **/
-    /*************************************************/
-    /**
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
-     * protected method.
-     *
-     * @see   $this->_set_publish_post_box_vars for param details
-     * @since 4.6.0
-     */
-    public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
-    {
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
-    }
-
-
-
-    /**
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
-     * Note: currently there is no validation for this.  However if you want the delete button, the
-     * save, and save and close buttons to work properly, then you will want to include a
-     * values for the name and id arguments.
-     *
-     * @todo  Add in validation for name/id arguments.
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
-     * @param    int     $id                      id attached to the item published
-     * @param    string  $delete                  page route callback for the delete action
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
-     * @throws \EE_Error
-     */
-    protected function _set_publish_post_box_vars(
-            $name = '',
-            $id = 0,
-            $delete = '',
-            $save_close_redirect_URL = '',
-            $both_btns = true
-    ) {
-        // if Save & Close, use a custom redirect URL or default to the main page?
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
-        // create the Save & Close and Save buttons
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        if ($delete && ! empty($id)) {
-            //make sure we have a default if just true is sent.
-            $delete = ! empty($delete) ? $delete : 'delete';
-            $delete_link_args = array($name => $id);
-            $delete = $this->get_action_link_or_button(
-                    $delete,
-                    $delete,
-                    $delete_link_args,
-                    'submitdelete deletion',
-                    '',
-                    false
-            );
-        }
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if ( ! empty($name) && ! empty($id)) {
-            $hidden_field_arr[$name] = array(
-                    'type'  => 'hidden',
-                    'value' => $id,
-            );
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
-        } else {
-            $hf = '';
-        }
-        // add hidden field
-        $this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
-    }
-
-
-
-    /**
-     *        displays an error message to ppl who have javascript disabled
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_no_javascript_warning()
-    {
-        ?>
+	}
+
+
+
+	private function _espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	public function espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
+		//EEH_Template::display_template( $templatepath );
+	}
+
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		$show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
+		if ($show_sponsors) {
+			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
+		}
+	}
+
+
+
+	public function espresso_sponsors_post_box()
+	{
+		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
+		EEH_Template::display_template($templatepath);
+	}
+
+
+
+	private function _publish_post_box()
+	{
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+		//if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
+		} else {
+			$box_label = __('Publish', 'event_espresso');
+		}
+		$box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
+		add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
+	}
+
+
+
+	public function editor_overview()
+	{
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/** end of globally available metaboxes section **/
+	/*************************************************/
+	/**
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
+	 * protected method.
+	 *
+	 * @see   $this->_set_publish_post_box_vars for param details
+	 * @since 4.6.0
+	 */
+	public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
+	{
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
+	}
+
+
+
+	/**
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
+	 * save, and save and close buttons to work properly, then you will want to include a
+	 * values for the name and id arguments.
+	 *
+	 * @todo  Add in validation for name/id arguments.
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
+	 * @param    int     $id                      id attached to the item published
+	 * @param    string  $delete                  page route callback for the delete action
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
+	 * @throws \EE_Error
+	 */
+	protected function _set_publish_post_box_vars(
+			$name = '',
+			$id = 0,
+			$delete = '',
+			$save_close_redirect_URL = '',
+			$both_btns = true
+	) {
+		// if Save & Close, use a custom redirect URL or default to the main page?
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
+		// create the Save & Close and Save buttons
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		if ($delete && ! empty($id)) {
+			//make sure we have a default if just true is sent.
+			$delete = ! empty($delete) ? $delete : 'delete';
+			$delete_link_args = array($name => $id);
+			$delete = $this->get_action_link_or_button(
+					$delete,
+					$delete,
+					$delete_link_args,
+					'submitdelete deletion',
+					'',
+					false
+			);
+		}
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
+		if ( ! empty($name) && ! empty($id)) {
+			$hidden_field_arr[$name] = array(
+					'type'  => 'hidden',
+					'value' => $id,
+			);
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+		} else {
+			$hf = '';
+		}
+		// add hidden field
+		$this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
+	}
+
+
+
+	/**
+	 *        displays an error message to ppl who have javascript disabled
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
         <noscript>
             <div id="no-js-message" class="error">
                 <p style="font-size:1.3em;">
@@ -2147,1267 +2147,1267 @@ 
             </div>
         </noscript>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        displays espresso success and/or error notices
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_espresso_notices()
-    {
-        $notices = $this->_get_transient(true);
-        echo stripslashes($notices);
-    }
+	/**
+	 *        displays espresso success and/or error notices
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_espresso_notices()
+	{
+		$notices = $this->_get_transient(true);
+		echo stripslashes($notices);
+	}
 
 
 
-    /**
-     *        spinny things pacify the masses
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	/**
+	 *        spinny things pacify the masses
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php esc_html_e('loading...', 'event_espresso'); ?></span>
         </div>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        add admin page overlay for modal boxes
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 *        add admin page overlay for modal boxes
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
         <div id="espresso-admin-page-overlay-dv" class=""></div>
         <?php
-    }
-
-
-
-    /**
-     * facade for add_meta_box
-     *
-     * @param string  $action        where the metabox get's displayed
-     * @param string  $title         Title of Metabox (output in metabox header)
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
-     * @param array   $callback_args an array of args supplied for the metabox
-     * @param string  $column        what metabox column
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
-     */
-    public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
-        //if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = array(
-                    'template_path' => $this->_template_path,
-                    'template_args' => $this->_template_args,
-            );
-        }
-        //if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func ? create_function('$post, $metabox',
-                'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
-    }
-
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @return [type] [description]
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
-        //the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @access private
-     * @param  boolean $sidebar true with sidebar, false without
-     * @param  boolean $about   use the about admin wrapper instead of the default.
-     * @return void
-     */
-    private function _display_admin_page($sidebar = false, $about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
-        // set current wp page slug - looks like: event-espresso_page_event_categories
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
-                ? 'poststuff'
-                : 'espresso-default-admin';
-        $template_path = $sidebar
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-        // the final template wrapper
-        $this->admin_page_wrapper($about);
-    }
-
-
-
-    /**
-     * This is used to display caf preview pages.
-     *
-     * @since 4.3.2
-     * @param string $utm_campaign_source what is the key used for google analytics link
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
-     * @return void
-     * @throws \EE_Error
-     */
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
-    {
-        //let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
-        $buy_now_url = add_query_arg(
-                array(
-                        'ee_ver'       => 'ee4',
-                        'utm_source'   => 'ee4_plugin_admin',
-                        'utm_medium'   => 'link',
-                        'utm_campaign' => $utm_campaign_source,
-                        'utm_content'  => 'buy_now_button',
-                ),
-                'http://eventespresso.com/pricing/'
-        );
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
-                ? $this->get_action_link_or_button(
-                        '',
-                        'buy_now',
-                        array(),
-                        'button-primary button-large',
-                        $buy_now_url,
-                        true
-                )
-                : $this->_template_args['preview_action_button'];
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @access private
-     * @param boolean $sidebar whether to display with sidebar or not.
-     * @return void
-     */
-    private function _display_admin_list_table_page($sidebar = false)
-    {
-        //setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
-                ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
-                : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
-        $this->_template_args['list_table'] = $this->_list_table_object;
-        $this->_template_args['current_route'] = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
-        if ( ! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                    $ajax_sorting_callback . '_nonce',
-                    $ajax_sorting_callback . '_nonce',
-                    false,
-                    false
-            );
-            //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
-            //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
-        $nonce_ref = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
-        //display message about search results?
-        $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
-                ? '<p class="ee-search-results">' . sprintf(
-                        esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
-                        trim($this->_req_data['s'], '%')
-                ) . '</p>'
-                : '';
-        // filter before_list_table template arg
-        $this->_template_args['before_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-            $this->_template_args['before_list_table'],
-            $this->page_slug,
-            $this->_req_data,
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['before_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
-                (array) $this->_template_args['before_list_table'],
-                $this->page_slug,
-                $this->_req_data,
-                $this->_req_action
-            )
-        );
-        // filter after_list_table template arg
-        $this->_template_args['after_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
-            $this->_template_args['after_list_table'],
-            $this->page_slug,
-            $this->_req_data,
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-                (array) $this->_template_args['after_list_table'],
-                $this->page_slug,
-                $this->_req_data,
-                $this->_req_action
-            )
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => __('localized description of item');
-     *        )
-     * );
-     *
-     * @param  array $items see above for format of array
-     * @return string        html string of legend
-     */
-    protected function _display_legend($items)
-    {
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
-        return EEH_Template::display_template($legend_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     * The returned json object is created from an array in the following format:
-     * array(
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
-     *  'notices' => '', // - contains any EE_Error formatted notices
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
-     *  specific template args that might be included in here)
-     * )
-     * The json object is populated by whatever is set in the $_template_args property.
-     *
-     * @param bool  $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
-     * @param array $notices_arguments  Use this to pass any additional args on to the _process_notices.
-     * @return void
-     */
-    protected function _return_json($sticky_notices = false, $notices_arguments = array())
-    {
-        //make sure any EE_Error notices have been handled.
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
-        unset($this->_template_args['data']);
-        $json = array(
-                'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
-                'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
-                'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
-                'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
-                'notices'   => EE_Error::get_notices(),
-                'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
-                'data'      => array_merge($data, array('template_args' => $this->_template_args)),
-                'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        );
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-
-        exit();
-    }
-
-
-
-    /**
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function return_json()
-    {
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
-        }
-    }
-
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     * @access   public
-     */
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
-    {
-        $this->_hook_obj = $hook_obj;
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper with Tabbed nav for an admin page
-     *
-     * @access public
-     * @param  boolean $about whether to use the special about page wrapper or default.
-     * @return void
-     */
-    public function admin_page_wrapper($about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
-        // load settings page wrapper template
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
-        //about page?
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
-        if (defined('DOING_AJAX')) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-            $this->_return_json();
-        } else {
-            EEH_Template::display_template($template_path, $this->_template_args);
-        }
-    }
-
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     */
-    protected function _get_main_nav_tabs()
-    {
-        //let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
-    }
-
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @access public
-     * @param $a
-     * @param $b
-     * @return int
-     */
-    private function _sort_nav_tabs($a, $b)
-    {
-        if ($a['order'] == $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-
-    /**
-     *    generates HTML for the forms used on admin pages
-     *
-     * @access protected
-     * @param    array $input_vars - array of input field details
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
-     * @return string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
-    {
-        $content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
-        return $content;
-    }
-
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @access protected
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
-     */
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
-    {
-        //make sure $text and $actions are in an array
-        $text = (array)$text;
-        $actions = (array)$actions;
-        $referrer_url = empty($referrer) ? '' : $referrer;
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
-        $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
-        $default_names = array('save', 'save_and_close');
-        //add in a hidden index for the current page (so save and close redirects properly)
-        $this->_template_args['save_buttons'] = $referrer_url;
-        foreach ($button_text as $key => $button) {
-            $ref = $default_names[$key];
-            $id = $this->_current_view . '_' . $ref;
-            $name = ! empty($actions) ? $actions[$key] : $ref;
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
-            if ( ! $both) {
-                break;
-            }
-        }
-    }
-
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     */
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @access protected
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        if (empty($route)) {
-            $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
-        // add nonce
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = array(
-                'action' => array('type' => 'hidden', 'value' => $route),
-        );
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array)$form_fields as $field_name => $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
-     * @since 4.5.0
-     */
-    public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        $this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
-    }
-
-
-
-    /**
-     *    _redirect_after_action
-     *
-     * @param int    $success            - whether success was for two or more records, or just one, or none
-     * @param string $what               - what the action was performed on
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //class name for actions/filters.
-        $classname = get_class($this);
-        //set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
-        $notices = EE_Error::get_notices(false);
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if ( ! $override_overwrite || ! empty($notices['errors'])) {
-            EE_Error::overwrite_success();
-        }
-        if ( ! empty($what) && ! empty($action_desc)) {
-            // how many records affected ? more than one record ? or just one ?
-            if ($success > 1 && empty($notices['errors'])) {
-                // set plural msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" have been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            } else if ($success == 1 && empty($notices['errors'])) {
-                // set singular msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" has been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        }
-        // check that $query_args isn't something crazy
-        if ( ! is_array($query_args)) {
-            $query_args = array();
-        }
-        /**
-         * Allow injecting actions before the query_args are modified for possible different
-         * redirections on save and close actions
-         *
-         * @since 4.2.0
-         * @param array $query_args       The original query_args array coming into the
-         *                                method.
-         */
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
-        //calculate where we're going (if we have a "save and close" button pushed)
-        if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
-            // regenerate query args array from referrer URL
-            parse_str($parsed_url['query'], $query_args);
-            // correct page and action will be in the query args now
-            $redirect_url = admin_url('admin.php');
-        }
-        //merge any default query_args set in _default_route_query_args property
-        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
-            $args_to_merge = array();
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
-                //is there a wp_referer array in our _default_route_query_args property?
-                if ($query_param == 'wp_referer') {
-                    $query_value = (array)$query_value;
-                    foreach ($query_value as $reference => $value) {
-                        if (strpos($reference, 'nonce') !== false) {
-                            continue;
-                        }
-                        //finally we will override any arguments in the referer with
-                        //what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[$reference])) {
-                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
-                        } else {
-                            $args_to_merge[$reference] = urlencode($value);
-                        }
-                    }
-                    continue;
-                }
-                $args_to_merge[$query_param] = $query_value;
-            }
-            //now let's merge these arguments but override with what was specifically sent in to the
-            //redirect.
-            $query_args = array_merge($args_to_merge, $query_args);
-        }
-        $this->_process_notices($query_args);
-        // generate redirect url
-        // if redirecting to anything other than the main page, add a nonce
-        if (isset($query_args['action'])) {
-            // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-        }
-        //we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if (defined('DOING_AJAX')) {
-            $default_data = array(
-                    'close'        => true,
-                    'redirect_url' => $redirect_url,
-                    'where'        => 'main',
-                    'what'         => 'append',
-            );
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
-     * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
-     * @return void
-     */
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
-    {
-        //first let's set individual error properties if doing_ajax and the properties aren't already set.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $notices = EE_Error::get_notices(false);
-            if (empty($this->_template_args['success'])) {
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
-            }
-        }
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        //IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if ( ! defined('DOING_AJAX') || $sticky_notices) {
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
-            $this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
-        }
-    }
-
-
-
-    /**
-     * get_action_link_or_button
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
-     *
-     * @param string $action        use this to indicate which action the url is generated with.
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
-     * @param string $base_url      If this is not provided
-     *                              the _admin_base_url will be used as the default for the button base_url.
-     *                              Otherwise this value will be used.
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_action_link_or_button(
-            $action,
-            $type = 'add',
-            $extra_request = array(),
-            $class = 'button-primary',
-            $base_url = '',
-            $exclude_nonce = false
-    ) {
-        //first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no page route for given action for the button.  This action was given: %s',
-                                    'event_espresso'
-                            ),
-                            $action
-                    )
-            );
-        }
-        if ( ! isset($this->_labels['buttons'][$type])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
-                                    'event_espresso'
-                            ),
-                            $type
-                    )
-            );
-        }
-        //finally check user access for this button.
-        $has_access = $this->check_user_access($action, true);
-        if ( ! $has_access) {
-            return '';
-        }
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
-        $query_args = array(
-                'action' => $action,
-        );
-        //merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if ( ! empty($extra_request)) {
-            $query_args = array_merge($extra_request, $query_args);
-        }
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
-    }
-
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args = array(
-                'label'   => $this->_admin_page_title,
-                'default' => 10,
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        );
-        //ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if ( ! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $_POST['wp_screen_options']['option'];
-            $value = $_POST['wp_screen_options']['value'];
-            if ($option != sanitize_key($option)) {
-                return;
-            }
-            $map_option = $option;
-            $option = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $value = (int)$value;
-                    if ($value < 1 || $value > 999) {
-                        return;
-                    }
-                    break;
-                default:
-                    $value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
-            exit;
-        }
-    }
-
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args($data)
-    {
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
-    }
-
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @access protected
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
-     * @return void
-     */
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
-    {
-        $user_id = get_current_user_id();
-        if ( ! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        //now let's set the string for what kind of transient we're setting
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = $notices ? array('notices' => $data) : $data;
-        //is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        if ($existing) {
-            $data = array_merge((array)$data, (array)$existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool $notices true we get notices transient. False we just return normal route transient
-     * @return mixed data
-     */
-    protected function _get_transient($notices = false, $route = false)
-    {
-        $user_id = get_current_user_id();
-        $route = ! $route ? $this->_req_action : $route;
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        //delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
-     * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        //retrieve all existing transients
-        $query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * get_view
-     *
-     * @access public
-     * @return string content of _view property
-     */
-    public function get_view()
-    {
-        return $this->_view;
-    }
-
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-
-    /**
-     * get_current_page
-     *
-     * @access public
-     * @return string _current_page property value
-     */
-    public function get_current_page()
-    {
-        return $this->_current_page;
-    }
-
-
-
-    /**
-     * get_current_view
-     *
-     * @access public
-     * @return string _current_view property value
-     */
-    public function get_current_view()
-    {
-        return $this->_current_view;
-    }
-
-
-
-    /**
-     * get_current_screen
-     *
-     * @access public
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @access public
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url()
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data()
-    {
-        return $this->_req_data;
-    }
-
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action()
-    {
-        return $this->_req_action;
-    }
-
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf()
-    {
-        return $this->_is_caf;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function default_espresso_metaboxes()
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function admin_base_url()
-    {
-        return $this->_admin_base_url;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function wp_page_slug()
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @access    protected
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return boolean
-     */
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
-    {
-        //remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            $config->core->ee_ueip_has_notified = true;
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        } else {
-            EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values()
-    {
-        return $this->_yes_no_values;
-    }
-
-
-
-    protected function _get_dir()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        return dirname($reflector->getFileName());
-    }
-
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    //below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
-     * array.
-     *
-     * @return bool success/fail
-     */
-    protected function _process_resend_registration()
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
-        do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
-        return $this->_template_args['success'];
-    }
-
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @access protected
-     * @param \EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
-        return $this->_template_args['success'];
-    }
+	}
+
+
+
+	/**
+	 * facade for add_meta_box
+	 *
+	 * @param string  $action        where the metabox get's displayed
+	 * @param string  $title         Title of Metabox (output in metabox header)
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
+	 * @param array   $callback_args an array of args supplied for the metabox
+	 * @param string  $column        what metabox column
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
+	 */
+	public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
+		//if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
+		if (empty($callback_args) && $create_func) {
+			$callback_args = array(
+					'template_path' => $this->_template_path,
+					'template_args' => $this->_template_args,
+			);
+		}
+		//if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
+		$call_back_func = $create_func ? create_function('$post, $metabox',
+				'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
+		add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @return [type] [description]
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
+		//the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @access private
+	 * @param  boolean $sidebar true with sidebar, false without
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
+	 * @return void
+	 */
+	private function _display_admin_page($sidebar = false, $about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
+		// set current wp page slug - looks like: event-espresso_page_event_categories
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
+				? 'poststuff'
+				: 'espresso-default-admin';
+		$template_path = $sidebar
+				? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+				: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+		// the final template wrapper
+		$this->admin_page_wrapper($about);
+	}
+
+
+
+	/**
+	 * This is used to display caf preview pages.
+	 *
+	 * @since 4.3.2
+	 * @param string $utm_campaign_source what is the key used for google analytics link
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
+	{
+		//let's generate a default preview action button if there isn't one already present.
+		$this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
+		$buy_now_url = add_query_arg(
+				array(
+						'ee_ver'       => 'ee4',
+						'utm_source'   => 'ee4_plugin_admin',
+						'utm_medium'   => 'link',
+						'utm_campaign' => $utm_campaign_source,
+						'utm_content'  => 'buy_now_button',
+				),
+				'http://eventespresso.com/pricing/'
+		);
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
+				? $this->get_action_link_or_button(
+						'',
+						'buy_now',
+						array(),
+						'button-primary button-large',
+						$buy_now_url,
+						true
+				)
+				: $this->_template_args['preview_action_button'];
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @access private
+	 * @param boolean $sidebar whether to display with sidebar or not.
+	 * @return void
+	 */
+	private function _display_admin_list_table_page($sidebar = false)
+	{
+		//setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
+				? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
+				: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
+		$this->_template_args['list_table'] = $this->_list_table_object;
+		$this->_template_args['current_route'] = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
+		if ( ! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+					$ajax_sorting_callback . '_nonce',
+					$ajax_sorting_callback . '_nonce',
+					false,
+					false
+			);
+			//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
+			//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
+		$nonce_ref = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
+		//display message about search results?
+		$this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
+				? '<p class="ee-search-results">' . sprintf(
+						esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
+						trim($this->_req_data['s'], '%')
+				) . '</p>'
+				: '';
+		// filter before_list_table template arg
+		$this->_template_args['before_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+			$this->_template_args['before_list_table'],
+			$this->page_slug,
+			$this->_req_data,
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['before_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
+				(array) $this->_template_args['before_list_table'],
+				$this->page_slug,
+				$this->_req_data,
+				$this->_req_action
+			)
+		);
+		// filter after_list_table template arg
+		$this->_template_args['after_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
+			$this->_template_args['after_list_table'],
+			$this->page_slug,
+			$this->_req_data,
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['after_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+				(array) $this->_template_args['after_list_table'],
+				$this->page_slug,
+				$this->_req_data,
+				$this->_req_action
+			)
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => __('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param  array $items see above for format of array
+	 * @return string        html string of legend
+	 */
+	protected function _display_legend($items)
+	{
+		$this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
+		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
+		return EEH_Template::display_template($legend_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *  'notices' => '', // - contains any EE_Error formatted notices
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
+	 *  specific template args that might be included in here)
+	 * )
+	 * The json object is populated by whatever is set in the $_template_args property.
+	 *
+	 * @param bool  $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
+	 * @param array $notices_arguments  Use this to pass any additional args on to the _process_notices.
+	 * @return void
+	 */
+	protected function _return_json($sticky_notices = false, $notices_arguments = array())
+	{
+		//make sure any EE_Error notices have been handled.
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
+		unset($this->_template_args['data']);
+		$json = array(
+				'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
+				'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
+				'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
+				'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
+				'notices'   => EE_Error::get_notices(),
+				'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
+				'data'      => array_merge($data, array('template_args' => $this->_template_args)),
+				'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		);
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+
+		exit();
+	}
+
+
+
+	/**
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function return_json()
+	{
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
+		}
+	}
+
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 * @access   public
+	 */
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
+	{
+		$this->_hook_obj = $hook_obj;
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
+	 *
+	 * @access public
+	 * @param  boolean $about whether to use the special about page wrapper or default.
+	 * @return void
+	 */
+	public function admin_page_wrapper($about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
+		$this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
+		// load settings page wrapper template
+		$template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+		//about page?
+		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
+		if (defined('DOING_AJAX')) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+			$this->_return_json();
+		} else {
+			EEH_Template::display_template($template_path, $this->_template_args);
+		}
+	}
+
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 */
+	protected function _get_main_nav_tabs()
+	{
+		//let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
+	}
+
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @access public
+	 * @param $a
+	 * @param $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs($a, $b)
+	{
+		if ($a['order'] == $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+
+	/**
+	 *    generates HTML for the forms used on admin pages
+	 *
+	 * @access protected
+	 * @param    array $input_vars - array of input field details
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
+	 * @return string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
+	{
+		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
+		return $content;
+	}
+
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @access protected
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
+	 */
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
+	{
+		//make sure $text and $actions are in an array
+		$text = (array)$text;
+		$actions = (array)$actions;
+		$referrer_url = empty($referrer) ? '' : $referrer;
+		$referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
+				: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
+		$button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
+		$default_names = array('save', 'save_and_close');
+		//add in a hidden index for the current page (so save and close redirects properly)
+		$this->_template_args['save_buttons'] = $referrer_url;
+		foreach ($button_text as $key => $button) {
+			$ref = $default_names[$key];
+			$id = $this->_current_view . '_' . $ref;
+			$name = ! empty($actions) ? $actions[$key] : $ref;
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
+			if ( ! $both) {
+				break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 */
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @access protected
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		if (empty($route)) {
+			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
+			$dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
+		// add nonce
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = array(
+				'action' => array('type' => 'hidden', 'value' => $route),
+		);
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array)$form_fields as $field_name => $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		$this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
+	}
+
+
+
+	/**
+	 *    _redirect_after_action
+	 *
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
+	 * @param string $what               - what the action was performed on
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//class name for actions/filters.
+		$classname = get_class($this);
+		//set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
+		$notices = EE_Error::get_notices(false);
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
+		if ( ! $override_overwrite || ! empty($notices['errors'])) {
+			EE_Error::overwrite_success();
+		}
+		if ( ! empty($what) && ! empty($action_desc)) {
+			// how many records affected ? more than one record ? or just one ?
+			if ($success > 1 && empty($notices['errors'])) {
+				// set plural msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" have been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			} else if ($success == 1 && empty($notices['errors'])) {
+				// set singular msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" has been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		}
+		// check that $query_args isn't something crazy
+		if ( ! is_array($query_args)) {
+			$query_args = array();
+		}
+		/**
+		 * Allow injecting actions before the query_args are modified for possible different
+		 * redirections on save and close actions
+		 *
+		 * @since 4.2.0
+		 * @param array $query_args       The original query_args array coming into the
+		 *                                method.
+		 */
+		do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
+		//calculate where we're going (if we have a "save and close" button pushed)
+		if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
+			// regenerate query args array from referrer URL
+			parse_str($parsed_url['query'], $query_args);
+			// correct page and action will be in the query args now
+			$redirect_url = admin_url('admin.php');
+		}
+		//merge any default query_args set in _default_route_query_args property
+		if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+			$args_to_merge = array();
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
+				//is there a wp_referer array in our _default_route_query_args property?
+				if ($query_param == 'wp_referer') {
+					$query_value = (array)$query_value;
+					foreach ($query_value as $reference => $value) {
+						if (strpos($reference, 'nonce') !== false) {
+							continue;
+						}
+						//finally we will override any arguments in the referer with
+						//what might be set on the _default_route_query_args array.
+						if (isset($this->_default_route_query_args[$reference])) {
+							$args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
+						} else {
+							$args_to_merge[$reference] = urlencode($value);
+						}
+					}
+					continue;
+				}
+				$args_to_merge[$query_param] = $query_value;
+			}
+			//now let's merge these arguments but override with what was specifically sent in to the
+			//redirect.
+			$query_args = array_merge($args_to_merge, $query_args);
+		}
+		$this->_process_notices($query_args);
+		// generate redirect url
+		// if redirecting to anything other than the main page, add a nonce
+		if (isset($query_args['action'])) {
+			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+		}
+		//we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+		$redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if (defined('DOING_AJAX')) {
+			$default_data = array(
+					'close'        => true,
+					'redirect_url' => $redirect_url,
+					'where'        => 'main',
+					'what'         => 'append',
+			);
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
+	 * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
+	 * @return void
+	 */
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
+	{
+		//first let's set individual error properties if doing_ajax and the properties aren't already set.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$notices = EE_Error::get_notices(false);
+			if (empty($this->_template_args['success'])) {
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
+			}
+		}
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
+		if ( ! defined('DOING_AJAX') || $sticky_notices) {
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
+			$this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
+		}
+	}
+
+
+
+	/**
+	 * get_action_link_or_button
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
+	 *
+	 * @param string $action        use this to indicate which action the url is generated with.
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
+	 * @param string $base_url      If this is not provided
+	 *                              the _admin_base_url will be used as the default for the button base_url.
+	 *                              Otherwise this value will be used.
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_action_link_or_button(
+			$action,
+			$type = 'add',
+			$extra_request = array(),
+			$class = 'button-primary',
+			$base_url = '',
+			$exclude_nonce = false
+	) {
+		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
+		if (empty($base_url) && ! isset($this->_page_routes[$action])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no page route for given action for the button.  This action was given: %s',
+									'event_espresso'
+							),
+							$action
+					)
+			);
+		}
+		if ( ! isset($this->_labels['buttons'][$type])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
+									'event_espresso'
+							),
+							$type
+					)
+			);
+		}
+		//finally check user access for this button.
+		$has_access = $this->check_user_access($action, true);
+		if ( ! $has_access) {
+			return '';
+		}
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
+		$query_args = array(
+				'action' => $action,
+		);
+		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
+		if ( ! empty($extra_request)) {
+			$query_args = array_merge($extra_request, $query_args);
+		}
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
+	}
+
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args = array(
+				'label'   => $this->_admin_page_title,
+				'default' => 10,
+				'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		);
+		//ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if ( ! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $_POST['wp_screen_options']['option'];
+			$value = $_POST['wp_screen_options']['value'];
+			if ($option != sanitize_key($option)) {
+				return;
+			}
+			$map_option = $option;
+			$option = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$value = (int)$value;
+					if ($value < 1 || $value > 999) {
+						return;
+					}
+					break;
+				default:
+					$value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
+			exit;
+		}
+	}
+
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args($data)
+	{
+		$this->_template_args = array_merge($this->_template_args, (array)$data);
+	}
+
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @access protected
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 */
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
+	{
+		$user_id = get_current_user_id();
+		if ( ! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		//now let's set the string for what kind of transient we're setting
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = $notices ? array('notices' => $data) : $data;
+		//is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		if ($existing) {
+			$data = array_merge((array)$data, (array)$existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool $notices true we get notices transient. False we just return normal route transient
+	 * @return mixed data
+	 */
+	protected function _get_transient($notices = false, $route = false)
+	{
+		$user_id = get_current_user_id();
+		$route = ! $route ? $this->_req_action : $route;
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		//delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
+	 * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		//retrieve all existing transients
+		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * get_view
+	 *
+	 * @access public
+	 * @return string content of _view property
+	 */
+	public function get_view()
+	{
+		return $this->_view;
+	}
+
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @access public
+	 * @return string _current_page property value
+	 */
+	public function get_current_page()
+	{
+		return $this->_current_page;
+	}
+
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @access public
+	 * @return string _current_view property value
+	 */
+	public function get_current_view()
+	{
+		return $this->_current_view;
+	}
+
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @access public
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @access public
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url()
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data()
+	{
+		return $this->_req_data;
+	}
+
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action()
+	{
+		return $this->_req_action;
+	}
+
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf()
+	{
+		return $this->_is_caf;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function default_espresso_metaboxes()
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function admin_base_url()
+	{
+		return $this->_admin_base_url;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function wp_page_slug()
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @access    protected
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return boolean
+	 */
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
+	{
+		//remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			$config->core->ee_ueip_has_notified = true;
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		} else {
+			EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values()
+	{
+		return $this->_yes_no_values;
+	}
+
+
+
+	protected function _get_dir()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		return dirname($reflector->getFileName());
+	}
+
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
+	 * array.
+	 *
+	 * @return bool success/fail
+	 */
+	protected function _process_resend_registration()
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
+		do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
+		return $this->_template_args['success'];
+	}
+
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @access protected
+	 * @param \EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
+		return $this->_template_args['success'];
+	}
 
 
 }