eventespresso / event-espresso-core

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1860 added lines, -1860 removed lines

@@ -5,7 +5,7 @@ 
 use EventEspresso\core\exceptions\InvalidEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,1865 +20,1865 @@ 
 class EED_Single_Page_Checkout extends EED_Module
 {
 
-    /**
-     * $_initialized - has the SPCO controller already been initialized ?
-     *
-     * @access private
-     * @var bool $_initialized
-     */
-    private static $_initialized = false;
-
-
-    /**
-     * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
-     *
-     * @access private
-     * @var bool $_valid_checkout
-     */
-    private static $_checkout_verified = true;
-
-    /**
-     *    $_reg_steps_array - holds initial array of reg steps
-     *
-     * @access private
-     * @var array $_reg_steps_array
-     */
-    private static $_reg_steps_array = array();
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-
-    /**
-     * @return EED_Module|EED_Single_Page_Checkout
-     */
-    public static function instance()
-    {
-        add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @return EE_CART
-     */
-    public function cart()
-    {
-        return $this->checkout->cart;
-    }
-
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->checkout->transaction;
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
-            return;
-        }
-        // going to start an output buffer in case anything gets accidentally output
-        // that might disrupt our JSON response
-        ob_start();
-        EED_Single_Page_Checkout::load_request_handler();
-        EED_Single_Page_Checkout::load_reg_steps();
-        // set ajax hooks
-        add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-        add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-    }
-
-
-
-    /**
-     *    process ajax request
-     *
-     * @param string $ajax_action
-     * @throws EE_Error
-     */
-    public static function process_ajax_request($ajax_action)
-    {
-        EE_Registry::instance()->REQ->set('action', $ajax_action);
-        EED_Single_Page_Checkout::instance()->_initialize();
-    }
-
-
-
-    /**
-     *    ajax display registration step
-     *
-     * @throws EE_Error
-     */
-    public static function display_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws EE_Error
-     */
-    public static function process_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws EE_Error
-     */
-    public static function update_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
-    }
-
-
-
-    /**
-     *   update_checkout
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public static function update_checkout()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_checkout');
-    }
-
-
-
-    /**
-     *    load_request_handler
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_request_handler()
-    {
-        // load core Request_Handler class
-        if (EE_Registry::instance()->REQ !== null) {
-            EE_Registry::instance()->load_core('Request_Handler');
-        }
-    }
-
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_definitions()
-    {
-        if(defined('SPCO_BASE_PATH')) {
-            return;
-        }
-        define(
-            'SPCO_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
-        );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
-
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     */
-    public static function load_reg_steps()
-    {
-        static $reg_steps_loaded = false;
-        if ($reg_steps_loaded) {
-            return;
-        }
-        // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
-            'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
-            EED_Single_Page_Checkout::get_reg_steps()
-        );
-        // sort by key (order)
-        ksort($reg_steps_to_load);
-        // loop through folders
-        foreach ($reg_steps_to_load as $order => $reg_step) {
-            // we need a
-            if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-                // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
-                // register custom key route for each reg step
-                // ie: step=>"slug" - this is the entire reason we load the reg steps array now
-                EE_Config::register_route(
-                    $reg_step['slug'],
-                    'EED_Single_Page_Checkout',
-                    'run',
-                    'step'
-                );
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if ( ! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
-                            $reg_step['file_path'],
-                            true
-                        );
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func(array($reg_step['class_name'], 'set_hooks'));
-                    }
-                }
-            }
-        }
-        $reg_steps_loaded = true;
-    }
-
-
-
-    /**
-     *    get_reg_steps
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_reg_steps()
-    {
-        $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
-        if (empty($reg_steps)) {
-            $reg_steps = array(
-                10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
-                    'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
-                    'slug'       => 'attendee_information',
-                    'has_hooks'  => false,
-                ),
-                20  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
-                    'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
-                    'slug'       => 'registration_confirmation',
-                    'has_hooks'  => false,
-                ),
-                30  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
-                    'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
-                    'slug'       => 'payment_options',
-                    'has_hooks'  => true,
-                ),
-                999 => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
-                    'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
-                    'slug'       => 'finalize_registration',
-                    'has_hooks'  => false,
-                ),
-            );
-        }
-        return $reg_steps;
-    }
-
-
-
-    /**
-     *    registration_checkout_for_admin
-     *
-     * @access    public
-     * @return    string
-     * @throws EE_Error
-     */
-    public static function registration_checkout_for_admin()
-    {
-        EED_Single_Page_Checkout::load_request_handler();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
-        EE_Registry::instance()->REQ->set('process_form_submission', false);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
-        return EE_Registry::instance()->REQ->get_output();
-    }
-
-
-
-    /**
-     * process_registration_from_admin
-     *
-     * @access public
-     * @return \EE_Transaction
-     * @throws EE_Error
-     */
-    public static function process_registration_from_admin()
-    {
-        EED_Single_Page_Checkout::load_request_handler();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'process_reg_step');
-        EE_Registry::instance()->REQ->set('process_form_submission', true);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
-            $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
-            if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-                EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
-                if ($final_reg_step->process_reg_step()) {
-                    $final_reg_step->set_completed();
-                    EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
-                    return EED_Single_Page_Checkout::instance()->checkout->transaction;
-                }
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     */
-    public function run($WP_Query)
-    {
-        if (
-            $WP_Query instanceof WP_Query
-            && $WP_Query->is_main_query()
-            && apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
-            && $this->_is_reg_checkout()
-        ) {
-            $this->_initialize();
-        }
-    }
-
-
-
-    /**
-     * determines whether current url matches reg page url
-     *
-     * @return bool
-     */
-    protected function _is_reg_checkout()
-    {
-        // get current permalink for reg page without any extra query args
-        $reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id);
-        // get request URI for current request, but without the scheme or host
-        $current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI');
-        $current_request_uri = html_entity_decode($current_request_uri);
-        // get array of query args from the current request URI
-        $query_args = \EEH_URL::get_query_string($current_request_uri);
-        // grab page id if it is set
-        $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
-        // and remove the page id from the query args (we will re-add it later)
-        unset($query_args['page_id']);
-        // now strip all query args from current request URI
-        $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
-        // and re-add the page id if it was set
-        if ($page_id) {
-            $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
-        }
-        // remove slashes and ?
-        $current_request_uri = trim($current_request_uri, '?/');
-        // is current request URI part of the known full reg page URL ?
-        return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
-    }
-
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function init($wp_query)
-    {
-        EED_Single_Page_Checkout::instance()->run($wp_query);
-    }
-
-
-
-    /**
-     *    _initialize - initial module setup
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    void
-     */
-    private function _initialize()
-    {
-        // ensure SPCO doesn't run twice
-        if (EED_Single_Page_Checkout::$_initialized) {
-            return;
-        }
-        try {
-            EED_Single_Page_Checkout::load_reg_steps();
-            $this->_verify_session();
-            // setup the EE_Checkout object
-            $this->checkout = $this->_initialize_checkout();
-            // filter checkout
-            $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
-            // get the $_GET
-            $this->_get_request_vars();
-            if ($this->_block_bots()) {
-                return;
-            }
-            // filter continue_reg
-            $this->checkout->continue_reg = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                true,
-                $this->checkout
-            );
-            // load the reg steps array
-            if ( ! $this->_load_and_instantiate_reg_steps()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // set the current step
-            $this->checkout->set_current_step($this->checkout->step);
-            // and the next step
-            $this->checkout->set_next_step();
-            // verify that everything has been setup correctly
-            if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if( ! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts();
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
-            // remove transaction lock
-            add_action('shutdown', array($this, 'unlock_transaction'), 1);
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     *    _verify_session
-     * checks that the session is valid and not expired
-     *
-     * @access    private
-     * @throws EE_Error
-     */
-    private function _verify_session()
-    {
-        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
-            throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
-        }
-        $clear_session_requested = filter_var(
-            EE_Registry::instance()->REQ->get('clear_session', false),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // is session still valid ?
-        if ($clear_session_requested
-            || ( EE_Registry::instance()->SSN->expired()
-              && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === ''
-            )
-        ) {
-            $this->checkout = new EE_Checkout();
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            // EE_Registry::instance()->SSN->reset_cart();
-            // EE_Registry::instance()->SSN->reset_checkout();
-            // EE_Registry::instance()->SSN->reset_transaction();
-            if (! $clear_session_requested) {
-                EE_Error::add_attention(
-                    EE_Registry::$i18n_js_strings['registration_expiration_notice'],
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-            // EE_Registry::instance()->SSN->reset_expired();
-        }
-    }
-
-
-
-    /**
-     *    _initialize_checkout
-     * loads and instantiates EE_Checkout
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return EE_Checkout
-     */
-    private function _initialize_checkout()
-    {
-        // look in session for existing checkout
-        /** @type EE_Checkout $checkout */
-        $checkout = EE_Registry::instance()->SSN->checkout();
-        // verify
-        if ( ! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(
-                SPCO_INC_PATH,
-                'EE_Checkout',
-                'class', array(),
-                false
-            );
-        } else {
-            if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
-                $this->unlock_transaction();
-                wp_safe_redirect($checkout->redirect_url);
-                exit();
-            }
-        }
-        $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
-        // verify again
-        if ( ! $checkout instanceof EE_Checkout) {
-            throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-
-    /**
-     *    _get_request_vars
-     *
-     * @access    private
-     * @return    void
-     * @throws EE_Error
-     */
-    private function _get_request_vars()
-    {
-        // load classes
-        EED_Single_Page_Checkout::load_request_handler();
-        //make sure this request is marked as belonging to EE
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // which step is being requested ?
-        $this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
-        // which step is being edited ?
-        $this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
-        // and what we're doing on the current step
-        $this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
-        // timestamp
-        $this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
-        // returning to edit ?
-        $this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
-        // add reg url link to registration query params
-        if ($this->checkout->reg_url_link) {
-            $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
-        }
-        // or some other kind of revisit ?
-        $this->checkout->revisit = filter_var(
-            EE_Registry::instance()->REQ->get('revisit', false),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to generate a reg form for this request
-        $this->checkout->generate_reg_form = filter_var(
-            EE_Registry::instance()->REQ->get('generate_reg_form', true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to process a reg form submission for this request
-        $this->checkout->process_form_submission = filter_var(
-            EE_Registry::instance()->REQ->get(
-                'process_form_submission',
-                $this->checkout->action === 'process_reg_step'
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        $this->checkout->process_form_submission = filter_var(
-            $this->checkout->action !== 'display_spco_reg_step'
-                ? $this->checkout->process_form_submission
-                : false,
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // $this->_display_request_vars();
-    }
-
-
-
-    /**
-     *  _display_request_vars
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _display_request_vars()
-    {
-        if ( ! WP_DEBUG) {
-            return;
-        }
-        EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
-    }
-
-
-
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @return boolean
-     */
-    private function _block_bots()
-    {
-        $invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    _get_first_step
-     *  gets slug for first step in $_reg_steps_array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    string
-     */
-    private function _get_first_step()
-    {
-        $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
-        return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
-    }
-
-
-
-    /**
-     *    _load_and_instantiate_reg_steps
-     *  instantiates each reg step based on the loaded reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    bool
-     */
-    private function _load_and_instantiate_reg_steps()
-    {
-        do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
-        // have reg_steps already been instantiated ?
-        if (
-            empty($this->checkout->reg_steps)
-            || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
-        ) {
-            // if not, then loop through raw reg steps array
-            foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
-                    return false;
-                }
-            }
-            EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
-            EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
-            // skip the registration_confirmation page ?
-            if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
-                // just remove it from the reg steps array
-                $this->checkout->remove_reg_step('registration_confirmation', false);
-            } else if (
-                isset($this->checkout->reg_steps['registration_confirmation'])
-                && EE_Registry::instance()->CFG->registration->reg_confirmation_last
-            ) {
-                // set the order to something big like 100
-                $this->checkout->set_reg_step_order('registration_confirmation', 100);
-            }
-            // filter the array for good luck
-            $this->checkout->reg_steps = apply_filters(
-                'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
-                $this->checkout->reg_steps
-            );
-            // finally re-sort based on the reg step class order properties
-            $this->checkout->sort_reg_steps();
-        } else {
-            foreach ($this->checkout->reg_steps as $reg_step) {
-                // set all current step stati to FALSE
-                $reg_step->set_is_current_step(false);
-            }
-        }
-        if (empty($this->checkout->reg_steps)) {
-            EE_Error::add_error(
-                __('No Reg Steps were loaded..', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-
-    /**
-     *     _load_and_instantiate_reg_step
-     *
-     * @access    private
-     * @param array $reg_step
-     * @param int   $order
-     * @return bool
-     */
-    private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
-    {
-        // we need a file_path, class_name, and slug to add a reg step
-        if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-            // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
-            if (
-                $this->checkout->reg_url_link
-                && $this->checkout->step !== $reg_step['slug']
-                && $reg_step['slug'] !== 'finalize_registration'
-                // normally at this point we would NOT load the reg step, but this filter can change that
-                && apply_filters(
-                    'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
-                    true,
-                    $reg_step,
-                    $this->checkout
-                )
-            ) {
-                return true;
-            }
-            // instantiate step class using file path and class name
-            $reg_step_obj = EE_Registry::instance()->load_file(
-                $reg_step['file_path'],
-                $reg_step['class_name'],
-                'class',
-                $this->checkout,
-                false
-            );
-            // did we gets the goods ?
-            if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
-                // set reg step order based on config
-                $reg_step_obj->set_order($order);
-                // add instantiated reg step object to the master reg steps array
-                $this->checkout->add_reg_step($reg_step_obj);
-            } else {
-                EE_Error::add_error(
-                    __('The current step could not be set.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
-                            'event_espresso'
-                        ),
-                        isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
-                        isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
-                        isset($reg_step['slug']) ? $reg_step['slug'] : '',
-                        '<ul>',
-                        '<li>',
-                        '</li>',
-                        '</ul>'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _verify_transaction_and_get_registrations
-     *
-     * @access private
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _verify_transaction_and_get_registrations()
-    {
-        // was there already a valid transaction in the checkout from the session ?
-        if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-            // get transaction from db or session
-            $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
-                ? $this->_get_transaction_and_cart_for_previous_visit()
-                : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-                EE_Error::add_error(
-                    __('Your Registration and Transaction information could not be retrieved from the db.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $this->checkout->transaction = EE_Transaction::new_instance();
-                // add some style and make it dance
-                $this->add_styles_and_scripts();
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_previous_visit
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _get_transaction_and_cart_for_previous_visit()
-    {
-        /** @var $TXN_model EEM_Transaction */
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        // because the reg_url_link is present in the request,
-        // this is a return visit to SPCO, so we'll get the transaction data from the db
-        $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and get the cart that was used for that transaction
-            $this->checkout->cart = $this->_get_cart_for_transaction($transaction);
-            return $transaction;
-        }
-        EE_Error::add_error(
-            __('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
-            __FILE__, __FUNCTION__, __LINE__
-        );
-        return null;
-
-    }
-
-
-
-    /**
-     * _get_cart_for_transaction
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    private function _get_cart_for_transaction($transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_current_session
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @access private
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    private function _get_cart_for_current_session_and_setup_new_transaction()
-    {
-        //  if there's no transaction, then this is the FIRST visit to SPCO
-        // so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
-        $this->checkout->cart = $this->_get_cart_for_transaction(null);
-        // and then create a new transaction
-        $transaction = $this->_initialize_transaction();
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // and save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
-        } else {
-            EE_Error::add_error(
-                __('A Valid Transaction could not be initialized.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return $transaction;
-    }
-
-
-
-    /**
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _initialize_transaction()
-    {
-        try {
-            // ensure cart totals have been calculated
-            $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $this->checkout->cart->get_cart_grand_total();
-            // create new TXN
-            $transaction = EE_Transaction::new_instance(
-                array(
-                    'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
-                    'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
-                    'TXN_paid'      => 0,
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                )
-            );
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // set cron job for following up on TXNs after their session has expired
-            EE_Cron_Tasks::schedule_expired_transaction_check(
-                EE_Registry::instance()->SSN->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
-        $this->checkout->total_ticket_count = count($registrations);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
-        // then loop thru the array
-        foreach ($registrations as $registration) {
-            // verify each registration
-            if ($registration instanceof EE_Registration) {
-                // we display all attendee info for the primary registrant
-                if ($this->checkout->reg_url_link === $registration->reg_url_link()
-                    && $registration->is_primary_registrant()
-                ) {
-                    $this->checkout->primary_revisit = true;
-                    break;
-                }
-                if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
-                    // but hide info if it doesn't belong to you
-                    $transaction->clear_cache('Registration', $registration->ID());
-                    $this->checkout->total_ticket_count--;
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-    /**
-     *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return    array
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    private function _initialize_registrations(EE_Transaction $transaction)
-    {
-        $att_nmbr = 0;
-        $registrations = array();
-        if ($transaction instanceof EE_Transaction) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
-            // now let's add the cart items to the $transaction
-            foreach ($this->checkout->cart->get_tickets() as $line_item) {
-                //do the following for each ticket of this type they selected
-                for ($x = 1; $x <= $line_item->quantity(); $x++) {
-                    $att_nmbr++;
-                    /** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
-                    $CreateRegistrationCommand = EE_Registry::instance()->create(
-                        'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-                        array(
-                            $transaction,
-                            $line_item,
-                            $att_nmbr,
-                            $this->checkout->total_ticket_count,
-                        )
-                    );
-                    // override capabilities for frontend registrations
-                    if ( ! is_admin()) {
-                        $CreateRegistrationCommand->setCapCheck(
-                            new PublicCapabilities('', 'create_new_registration')
-                        );
-                    }
-                    $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                    if ( ! $registration instanceof EE_Registration) {
-                        throw new InvalidEntityException($registration, 'EE_Registration');
-                    }
-                    $registrations[ $registration->ID() ] = $registration;
-                }
-            }
-            $registration_processor->fix_reg_final_price_rounding_issue($transaction);
-        }
-        return $registrations;
-    }
-
-
-
-    /**
-     * sorts registrations by REG_count
-     *
-     * @access public
-     * @param EE_Registration $reg_A
-     * @param EE_Registration $reg_B
-     * @return int
-     */
-    public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
-    {
-        // this shouldn't ever happen within the same TXN, but oh well
-        if ($reg_A->count() === $reg_B->count()) {
-            return 0;
-        }
-        return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
-    }
-
-
-
-    /**
-     *    _final_verifications
-     * just makes sure that everything is set up correctly before proceeding
-     *
-     * @access    private
-     * @return    bool
-     * @throws EE_Error
-     */
-    private function _final_verifications()
-    {
-        // filter checkout
-        $this->checkout = apply_filters(
-            'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
-            $this->checkout
-        );
-        //verify that current step is still set correctly
-        if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                __('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // if returning to SPCO, then verify that primary registrant is set
-        if ( ! empty($this->checkout->reg_url_link)) {
-            $valid_registrant = $this->checkout->transaction->primary_registration();
-            if ( ! $valid_registrant instanceof EE_Registration) {
-                EE_Error::add_error(
-                    __('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $valid_registrant = null;
-            foreach (
-                $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration
-            ) {
-                if (
-                    $registration instanceof EE_Registration
-                    && $registration->reg_url_link() === $this->checkout->reg_url_link
-                ) {
-                    $valid_registrant = $registration;
-                }
-            }
-            if ( ! $valid_registrant instanceof EE_Registration) {
-                // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
-                if (EED_Single_Page_Checkout::$_checkout_verified) {
-                    // clear the session, mark the checkout as unverified, and try again
-                    EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                    EED_Single_Page_Checkout::$_initialized = false;
-                    EED_Single_Page_Checkout::$_checkout_verified = false;
-                    $this->_initialize();
-                    EE_Error::reset_notices();
-                    return false;
-                }
-                EE_Error::add_error(
-                    __(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        EE_Registry::instance()->SSN->set_checkout($this->checkout);
-        return true;
-    }
-
-
-
-    /**
-     *    _initialize_reg_steps
-     * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
-     * then loops thru all of the active reg steps and calls the initialize_reg_step() method
-     *
-     * @access    private
-     * @param bool $reinitializing
-     * @throws EE_Error
-     */
-    private function _initialize_reg_steps($reinitializing = false)
-    {
-        $this->checkout->set_reg_step_initiated($this->checkout->current_step);
-        // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if ( ! $reg_step->initialize_reg_step()) {
-                // if not initialized then maybe this step is being removed...
-                if ( ! $reinitializing && $reg_step->is_current_step()) {
-                    // if it was the current step, then we need to start over here
-                    $this->_initialize_reg_steps(true);
-                    return;
-                }
-                continue;
-            }
-            // add css and JS for current step
-            $reg_step->enqueue_styles_and_scripts();
-            // i18n
-            $reg_step->translate_js_strings();
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action(
-            "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
-            $this->checkout->current_step
-        );
-    }
-
-
-
-    /**
-     * _check_form_submission
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _check_form_submission()
-    {
-        //does this request require the reg form to be generated ?
-        if ($this->checkout->generate_reg_form) {
-            // ever heard that song by Blue Rodeo ?
-            try {
-                $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
-                // if not displaying a form, then check for form submission
-                if (
-                    $this->checkout->process_form_submission
-                    && $this->checkout->current_step->reg_form->was_submitted()
-                ) {
-                    // clear out any old data in case this step is being run again
-                    $this->checkout->current_step->set_valid_data(array());
-                    // capture submitted form data
-                    $this->checkout->current_step->reg_form->receive_form_submission(
-                        apply_filters(
-                            'FHEE__Single_Page_Checkout___check_form_submission__request_params',
-                            EE_Registry::instance()->REQ->params(),
-                            $this->checkout
-                        )
-                    );
-                    // validate submitted form data
-                    if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
-                        // thou shall not pass !!!
-                        $this->checkout->continue_reg = false;
-                        // any form validation errors?
-                        if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
-                            $submission_error_messages = array();
-                            // bad, bad, bad registrant
-                            foreach (
-                                $this->checkout->current_step->reg_form->get_validation_errors_accumulated()
-                                as $validation_error
-                            ) {
-                                if ($validation_error instanceof EE_Validation_Error) {
-                                    $submission_error_messages[] = sprintf(
-                                        __('%s : %s', 'event_espresso'),
-                                        $validation_error->get_form_section()->html_label_text(),
-                                        $validation_error->getMessage()
-                                    );
-                                }
-                            }
-                            EE_Error::add_error(
-                                implode('<br />', $submission_error_messages),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                        // well not really... what will happen is
-                        // we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _process_action
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     */
-    private function _process_form_action()
-    {
-        // what cha wanna do?
-        switch ($this->checkout->action) {
-            // AJAX next step reg form
-            case 'display_spco_reg_step' :
-                $this->checkout->redirect = false;
-                if (EE_Registry::instance()->REQ->ajax) {
-                    $this->checkout->json_response->set_reg_step_html(
-                        $this->checkout->current_step->display_reg_form()
-                    );
-                }
-                break;
-            default :
-                // meh... do one of those other steps first
-                if (
-                    ! empty($this->checkout->action)
-                    && is_callable(array($this->checkout->current_step, $this->checkout->action))
-                ) {
-                    // dynamically creates hook point like:
-                    //   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                    // call action on current step
-                    if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) {
-                        // good registrant, you get to proceed
-                        if (
-                            $this->checkout->current_step->success_message() !== ''
-                            && apply_filters(
-                                'FHEE__Single_Page_Checkout___process_form_action__display_success',
-                                false
-                            )
-                        ) {
-                            EE_Error::add_success(
-                                $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
-                            );
-                        }
-                        // pack it up, pack it in...
-                        $this->_setup_redirect();
-                    }
-                    // dynamically creates hook point like:
-                    //  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The requested form action "%s" does not exist for the current "%s" registration step.',
-                                'event_espresso'
-                            ),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-
-    /**
-     *        add_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_styles_and_scripts()
-    {
-        // i18n
-        $this->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        } else {
-            add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        }
-    }
-
-
-
-    /**
-     *        translate_js_strings
-     *
-     * @access        public
-     * @return        void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
-        EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
-        EE_Registry::$i18n_js_strings['server_error'] = __(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_json_response'] = __(
-            'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['validation_error'] = __(
-            'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = __(
-            'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['reg_step_error'] = __(
-            'This registration step could not be completed. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_coupon'] = __(
-            'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
-            __(
-                'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
-                'event_espresso'
-            ),
-            '<br/>',
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
-        EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
-        EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
-        EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
-        EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __(
-                '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-        EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension'] = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
-            'M d, Y H:i:s',
-            EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-        );
-    }
-
-
-
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     * @throws EE_Error
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
-            array('espresso_default'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('single_page_checkout');
-        // load JS
-        wp_register_script(
-            'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
-            array('jquery'),
-            '1.0.1',
-            true
-        );
-        wp_register_script(
-            'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
-            array('jquery_plugin'),
-            '2.0.2',
-            true
-        );
-        wp_register_script(
-            'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
-            array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like:
-         *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
-            $this
-        );
-    }
-
-
-
-    /**
-     *    display the Registration Single Page Checkout Form
-     *
-     * @access    private
-     * @return    void
-     * @throws EE_Error
-     */
-    private function _display_spco_reg_form()
-    {
-        // if registering via the admin, just display the reg form for the current step
-        if ($this->checkout->admin_request) {
-            EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
-        } else {
-            // add powered by EE msg
-            add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
-            $empty_cart = count(
-                $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
-            ) < 1;
-            EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-            $cookies_not_set_msg = '';
-            if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        __(
-                            '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                            'event_espresso'
-                        ),
-                        '<div class="ee-attention">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
-                        '</a>'
-                    )
-                );
-            }
-            $this->checkout->registration_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'single-page-checkout',
-                    'html_id'         => 'ee-single-page-checkout-dv',
-                    'layout_strategy' =>
-                        new EE_Template_Layout(
-                            array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                                'template_args'        => array(
-                                    'empty_cart'              => $empty_cart,
-                                    'revisit'                 => $this->checkout->revisit,
-                                    'reg_steps'               => $this->checkout->reg_steps,
-                                    'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                        ? $this->checkout->next_step->slug()
-                                        : '',
-                                    'cancel_page_url'         => $this->checkout->cancel_page_url,
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            __(
-                                                'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'
-                                            ),
-                                            '<a href="'
-                                            . get_post_type_archive_link('espresso_events')
-                                            . '" title="',
-                                            '">',
-                                            '</a>'
-                                        )
-                                    ),
-                                    'cookies_not_set_msg'     => $cookies_not_set_msg,
-                                    'registration_time_limit' => $this->checkout->get_registration_time_limit(),
-                                    'session_expiration'      => gmdate(
-                                        'M d, Y H:i:s',
-                                        EE_Registry::instance()->SSN->expiration()
-                                        + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                    ),
-                                ),
-                            )
-                        ),
-                )
-            );
-            // load template and add to output sent that gets filtered into the_content()
-            EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
-        }
-    }
-
-
-
-    /**
-     *    add_extra_finalize_registration_inputs
-     *
-     * @access    public
-     * @param $next_step
-     * @internal  param string $label
-     * @return void
-     */
-    public function add_extra_finalize_registration_inputs($next_step)
-    {
-        if ($next_step === 'finalize_registration') {
-            echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
-        }
-    }
-
-
-
-    /**
-     *    display_registration_footer
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function display_registration_footer()
-    {
-        if (
-        apply_filters(
-            'FHEE__EE_Front__Controller__show_reg_footer',
-            EE_Registry::instance()->CFG->admin->show_reg_footer
-        )
-        ) {
-            add_filter(
-                'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
-                    return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
-                }
-            );
-            echo apply_filters(
-                'FHEE__EE_Front_Controller__display_registration_footer',
-                \EEH_Template::powered_by_event_espresso(
-                    '',
-                    'espresso-registration-footer-dv',
-                    array('utm_content' => 'registration_checkout')
-                )
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    unlock_transaction
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function unlock_transaction()
-    {
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $this->checkout->transaction->unlock();
-        }
-    }
-
-
-
-    /**
-     *        _setup_redirect
-     *
-     * @access    private
-     * @return void
-     */
-    private function _setup_redirect()
-    {
-        if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            $this->checkout->redirect = true;
-            if (empty($this->checkout->redirect_url)) {
-                $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
-            }
-            $this->checkout->redirect_url = apply_filters(
-                'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
-                $this->checkout->redirect_url,
-                $this->checkout
-            );
-        }
-    }
-
-
-
-    /**
-     *   handle ajax message responses and redirects
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function go_to_next_step()
-    {
-        if (EE_Registry::instance()->REQ->ajax) {
-            // capture contents of output buffer we started earlier in the request, and insert into JSON response
-            $this->checkout->json_response->set_unexpected_errors(ob_get_clean());
-        }
-        $this->unlock_transaction();
-        // just return for these conditions
-        if (
-            $this->checkout->admin_request
-            || $this->checkout->action === 'redirect_form'
-            || $this->checkout->action === 'update_checkout'
-        ) {
-            return;
-        }
-        // AJAX response
-        $this->_handle_json_response();
-        // redirect to next step or the Thank You page
-        $this->_handle_html_redirects();
-        // hmmm... must be something wrong, so let's just display the form again !
-        $this->_display_spco_reg_form();
-    }
-
-
-
-    /**
-     *   _handle_json_response
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if (EE_Registry::instance()->REQ->ajax) {
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
-            //		'redirect'                   => $this->checkout->redirect,
-            //		'continue_reg'               => $this->checkout->continue_reg,
-            //	)
-            //);
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            // just send the ajax (
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            echo $json_response;
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   _handle_redirects
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _handle_html_redirects()
-    {
-        // going somewhere ?
-        if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
-            // store notices in a transient
-            EE_Error::get_notices(false, true, true);
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'headers_sent' => headers_sent(),
-            //		'redirect_url'     => $this->checkout->redirect_url,
-            //		'headers_list'    => headers_list(),
-            //	)
-            //);
-            wp_safe_redirect($this->checkout->redirect_url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   set_checkout_anchor
-     *
-     * @access public
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
-    }
+	/**
+	 * $_initialized - has the SPCO controller already been initialized ?
+	 *
+	 * @access private
+	 * @var bool $_initialized
+	 */
+	private static $_initialized = false;
+
+
+	/**
+	 * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
+	 *
+	 * @access private
+	 * @var bool $_valid_checkout
+	 */
+	private static $_checkout_verified = true;
+
+	/**
+	 *    $_reg_steps_array - holds initial array of reg steps
+	 *
+	 * @access private
+	 * @var array $_reg_steps_array
+	 */
+	private static $_reg_steps_array = array();
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+
+	/**
+	 * @return EED_Module|EED_Single_Page_Checkout
+	 */
+	public static function instance()
+	{
+		add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @return EE_CART
+	 */
+	public function cart()
+	{
+		return $this->checkout->cart;
+	}
+
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->checkout->transaction;
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+		if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+			return;
+		}
+		// going to start an output buffer in case anything gets accidentally output
+		// that might disrupt our JSON response
+		ob_start();
+		EED_Single_Page_Checkout::load_request_handler();
+		EED_Single_Page_Checkout::load_reg_steps();
+		// set ajax hooks
+		add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+		add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+	}
+
+
+
+	/**
+	 *    process ajax request
+	 *
+	 * @param string $ajax_action
+	 * @throws EE_Error
+	 */
+	public static function process_ajax_request($ajax_action)
+	{
+		EE_Registry::instance()->REQ->set('action', $ajax_action);
+		EED_Single_Page_Checkout::instance()->_initialize();
+	}
+
+
+
+	/**
+	 *    ajax display registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function display_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function process_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws EE_Error
+	 */
+	public static function update_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
+	}
+
+
+
+	/**
+	 *   update_checkout
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function update_checkout()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_checkout');
+	}
+
+
+
+	/**
+	 *    load_request_handler
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_request_handler()
+	{
+		// load core Request_Handler class
+		if (EE_Registry::instance()->REQ !== null) {
+			EE_Registry::instance()->load_core('Request_Handler');
+		}
+	}
+
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_definitions()
+	{
+		if(defined('SPCO_BASE_PATH')) {
+			return;
+		}
+		define(
+			'SPCO_BASE_PATH',
+			rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
+		);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
+
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 */
+	public static function load_reg_steps()
+	{
+		static $reg_steps_loaded = false;
+		if ($reg_steps_loaded) {
+			return;
+		}
+		// filter list of reg_steps
+		$reg_steps_to_load = (array)apply_filters(
+			'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
+			EED_Single_Page_Checkout::get_reg_steps()
+		);
+		// sort by key (order)
+		ksort($reg_steps_to_load);
+		// loop through folders
+		foreach ($reg_steps_to_load as $order => $reg_step) {
+			// we need a
+			if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+				// copy over to the reg_steps_array
+				EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
+				// register custom key route for each reg step
+				// ie: step=>"slug" - this is the entire reason we load the reg steps array now
+				EE_Config::register_route(
+					$reg_step['slug'],
+					'EED_Single_Page_Checkout',
+					'run',
+					'step'
+				);
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if ( ! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
+							$reg_step['file_path'],
+							true
+						);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func(array($reg_step['class_name'], 'set_hooks'));
+					}
+				}
+			}
+		}
+		$reg_steps_loaded = true;
+	}
+
+
+
+	/**
+	 *    get_reg_steps
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_reg_steps()
+	{
+		$reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
+		if (empty($reg_steps)) {
+			$reg_steps = array(
+				10  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+					'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
+					'slug'       => 'attendee_information',
+					'has_hooks'  => false,
+				),
+				20  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
+					'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
+					'slug'       => 'registration_confirmation',
+					'has_hooks'  => false,
+				),
+				30  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+					'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
+					'slug'       => 'payment_options',
+					'has_hooks'  => true,
+				),
+				999 => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+					'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
+					'slug'       => 'finalize_registration',
+					'has_hooks'  => false,
+				),
+			);
+		}
+		return $reg_steps;
+	}
+
+
+
+	/**
+	 *    registration_checkout_for_admin
+	 *
+	 * @access    public
+	 * @return    string
+	 * @throws EE_Error
+	 */
+	public static function registration_checkout_for_admin()
+	{
+		EED_Single_Page_Checkout::load_request_handler();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
+		EE_Registry::instance()->REQ->set('process_form_submission', false);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
+		return EE_Registry::instance()->REQ->get_output();
+	}
+
+
+
+	/**
+	 * process_registration_from_admin
+	 *
+	 * @access public
+	 * @return \EE_Transaction
+	 * @throws EE_Error
+	 */
+	public static function process_registration_from_admin()
+	{
+		EED_Single_Page_Checkout::load_request_handler();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'process_reg_step');
+		EE_Registry::instance()->REQ->set('process_form_submission', true);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
+			$final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
+			if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+				EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
+				if ($final_reg_step->process_reg_step()) {
+					$final_reg_step->set_completed();
+					EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
+					return EED_Single_Page_Checkout::instance()->checkout->transaction;
+				}
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function run($WP_Query)
+	{
+		if (
+			$WP_Query instanceof WP_Query
+			&& $WP_Query->is_main_query()
+			&& apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
+			&& $this->_is_reg_checkout()
+		) {
+			$this->_initialize();
+		}
+	}
+
+
+
+	/**
+	 * determines whether current url matches reg page url
+	 *
+	 * @return bool
+	 */
+	protected function _is_reg_checkout()
+	{
+		// get current permalink for reg page without any extra query args
+		$reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id);
+		// get request URI for current request, but without the scheme or host
+		$current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI');
+		$current_request_uri = html_entity_decode($current_request_uri);
+		// get array of query args from the current request URI
+		$query_args = \EEH_URL::get_query_string($current_request_uri);
+		// grab page id if it is set
+		$page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
+		// and remove the page id from the query args (we will re-add it later)
+		unset($query_args['page_id']);
+		// now strip all query args from current request URI
+		$current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
+		// and re-add the page id if it was set
+		if ($page_id) {
+			$current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
+		}
+		// remove slashes and ?
+		$current_request_uri = trim($current_request_uri, '?/');
+		// is current request URI part of the known full reg page URL ?
+		return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
+	}
+
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function init($wp_query)
+	{
+		EED_Single_Page_Checkout::instance()->run($wp_query);
+	}
+
+
+
+	/**
+	 *    _initialize - initial module setup
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    void
+	 */
+	private function _initialize()
+	{
+		// ensure SPCO doesn't run twice
+		if (EED_Single_Page_Checkout::$_initialized) {
+			return;
+		}
+		try {
+			EED_Single_Page_Checkout::load_reg_steps();
+			$this->_verify_session();
+			// setup the EE_Checkout object
+			$this->checkout = $this->_initialize_checkout();
+			// filter checkout
+			$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
+			// get the $_GET
+			$this->_get_request_vars();
+			if ($this->_block_bots()) {
+				return;
+			}
+			// filter continue_reg
+			$this->checkout->continue_reg = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				true,
+				$this->checkout
+			);
+			// load the reg steps array
+			if ( ! $this->_load_and_instantiate_reg_steps()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// set the current step
+			$this->checkout->set_current_step($this->checkout->step);
+			// and the next step
+			$this->checkout->set_next_step();
+			// verify that everything has been setup correctly
+			if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if( ! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts();
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
+			// remove transaction lock
+			add_action('shutdown', array($this, 'unlock_transaction'), 1);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 *    _verify_session
+	 * checks that the session is valid and not expired
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 */
+	private function _verify_session()
+	{
+		if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
+			throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
+		}
+		$clear_session_requested = filter_var(
+			EE_Registry::instance()->REQ->get('clear_session', false),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// is session still valid ?
+		if ($clear_session_requested
+			|| ( EE_Registry::instance()->SSN->expired()
+			  && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === ''
+			)
+		) {
+			$this->checkout = new EE_Checkout();
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			// EE_Registry::instance()->SSN->reset_cart();
+			// EE_Registry::instance()->SSN->reset_checkout();
+			// EE_Registry::instance()->SSN->reset_transaction();
+			if (! $clear_session_requested) {
+				EE_Error::add_attention(
+					EE_Registry::$i18n_js_strings['registration_expiration_notice'],
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+			// EE_Registry::instance()->SSN->reset_expired();
+		}
+	}
+
+
+
+	/**
+	 *    _initialize_checkout
+	 * loads and instantiates EE_Checkout
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return EE_Checkout
+	 */
+	private function _initialize_checkout()
+	{
+		// look in session for existing checkout
+		/** @type EE_Checkout $checkout */
+		$checkout = EE_Registry::instance()->SSN->checkout();
+		// verify
+		if ( ! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(
+				SPCO_INC_PATH,
+				'EE_Checkout',
+				'class', array(),
+				false
+			);
+		} else {
+			if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
+				$this->unlock_transaction();
+				wp_safe_redirect($checkout->redirect_url);
+				exit();
+			}
+		}
+		$checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
+		// verify again
+		if ( ! $checkout instanceof EE_Checkout) {
+			throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+
+	/**
+	 *    _get_request_vars
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	private function _get_request_vars()
+	{
+		// load classes
+		EED_Single_Page_Checkout::load_request_handler();
+		//make sure this request is marked as belonging to EE
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// which step is being requested ?
+		$this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
+		// which step is being edited ?
+		$this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
+		// and what we're doing on the current step
+		$this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
+		// timestamp
+		$this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
+		// returning to edit ?
+		$this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
+		// add reg url link to registration query params
+		if ($this->checkout->reg_url_link) {
+			$this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
+		}
+		// or some other kind of revisit ?
+		$this->checkout->revisit = filter_var(
+			EE_Registry::instance()->REQ->get('revisit', false),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to generate a reg form for this request
+		$this->checkout->generate_reg_form = filter_var(
+			EE_Registry::instance()->REQ->get('generate_reg_form', true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to process a reg form submission for this request
+		$this->checkout->process_form_submission = filter_var(
+			EE_Registry::instance()->REQ->get(
+				'process_form_submission',
+				$this->checkout->action === 'process_reg_step'
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		$this->checkout->process_form_submission = filter_var(
+			$this->checkout->action !== 'display_spco_reg_step'
+				? $this->checkout->process_form_submission
+				: false,
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// $this->_display_request_vars();
+	}
+
+
+
+	/**
+	 *  _display_request_vars
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _display_request_vars()
+	{
+		if ( ! WP_DEBUG) {
+			return;
+		}
+		EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
+	}
+
+
+
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @return boolean
+	 */
+	private function _block_bots()
+	{
+		$invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    _get_first_step
+	 *  gets slug for first step in $_reg_steps_array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	private function _get_first_step()
+	{
+		$first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
+		return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
+	}
+
+
+
+	/**
+	 *    _load_and_instantiate_reg_steps
+	 *  instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    bool
+	 */
+	private function _load_and_instantiate_reg_steps()
+	{
+		do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
+		// have reg_steps already been instantiated ?
+		if (
+			empty($this->checkout->reg_steps)
+			|| apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
+		) {
+			// if not, then loop through raw reg steps array
+			foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
+				if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+					return false;
+				}
+			}
+			EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
+			EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
+			// skip the registration_confirmation page ?
+			if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
+				// just remove it from the reg steps array
+				$this->checkout->remove_reg_step('registration_confirmation', false);
+			} else if (
+				isset($this->checkout->reg_steps['registration_confirmation'])
+				&& EE_Registry::instance()->CFG->registration->reg_confirmation_last
+			) {
+				// set the order to something big like 100
+				$this->checkout->set_reg_step_order('registration_confirmation', 100);
+			}
+			// filter the array for good luck
+			$this->checkout->reg_steps = apply_filters(
+				'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
+				$this->checkout->reg_steps
+			);
+			// finally re-sort based on the reg step class order properties
+			$this->checkout->sort_reg_steps();
+		} else {
+			foreach ($this->checkout->reg_steps as $reg_step) {
+				// set all current step stati to FALSE
+				$reg_step->set_is_current_step(false);
+			}
+		}
+		if (empty($this->checkout->reg_steps)) {
+			EE_Error::add_error(
+				__('No Reg Steps were loaded..', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+
+	/**
+	 *     _load_and_instantiate_reg_step
+	 *
+	 * @access    private
+	 * @param array $reg_step
+	 * @param int   $order
+	 * @return bool
+	 */
+	private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
+	{
+		// we need a file_path, class_name, and slug to add a reg step
+		if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+			// if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
+			if (
+				$this->checkout->reg_url_link
+				&& $this->checkout->step !== $reg_step['slug']
+				&& $reg_step['slug'] !== 'finalize_registration'
+				// normally at this point we would NOT load the reg step, but this filter can change that
+				&& apply_filters(
+					'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
+					true,
+					$reg_step,
+					$this->checkout
+				)
+			) {
+				return true;
+			}
+			// instantiate step class using file path and class name
+			$reg_step_obj = EE_Registry::instance()->load_file(
+				$reg_step['file_path'],
+				$reg_step['class_name'],
+				'class',
+				$this->checkout,
+				false
+			);
+			// did we gets the goods ?
+			if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
+				// set reg step order based on config
+				$reg_step_obj->set_order($order);
+				// add instantiated reg step object to the master reg steps array
+				$this->checkout->add_reg_step($reg_step_obj);
+			} else {
+				EE_Error::add_error(
+					__('The current step could not be set.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
+							'event_espresso'
+						),
+						isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
+						isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
+						isset($reg_step['slug']) ? $reg_step['slug'] : '',
+						'<ul>',
+						'<li>',
+						'</li>',
+						'</ul>'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _verify_transaction_and_get_registrations
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _verify_transaction_and_get_registrations()
+	{
+		// was there already a valid transaction in the checkout from the session ?
+		if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+			// get transaction from db or session
+			$this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
+				? $this->_get_transaction_and_cart_for_previous_visit()
+				: $this->_get_cart_for_current_session_and_setup_new_transaction();
+			if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+				EE_Error::add_error(
+					__('Your Registration and Transaction information could not be retrieved from the db.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$this->checkout->transaction = EE_Transaction::new_instance();
+				// add some style and make it dance
+				$this->add_styles_and_scripts();
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_previous_visit
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _get_transaction_and_cart_for_previous_visit()
+	{
+		/** @var $TXN_model EEM_Transaction */
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		// because the reg_url_link is present in the request,
+		// this is a return visit to SPCO, so we'll get the transaction data from the db
+		$transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and get the cart that was used for that transaction
+			$this->checkout->cart = $this->_get_cart_for_transaction($transaction);
+			return $transaction;
+		}
+		EE_Error::add_error(
+			__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'),
+			__FILE__, __FUNCTION__, __LINE__
+		);
+		return null;
+
+	}
+
+
+
+	/**
+	 * _get_cart_for_transaction
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	private function _get_cart_for_transaction($transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_current_session
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @access private
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	private function _get_cart_for_current_session_and_setup_new_transaction()
+	{
+		//  if there's no transaction, then this is the FIRST visit to SPCO
+		// so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
+		$this->checkout->cart = $this->_get_cart_for_transaction(null);
+		// and then create a new transaction
+		$transaction = $this->_initialize_transaction();
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// and save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
+		} else {
+			EE_Error::add_error(
+				__('A Valid Transaction could not be initialized.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return $transaction;
+	}
+
+
+
+	/**
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _initialize_transaction()
+	{
+		try {
+			// ensure cart totals have been calculated
+			$this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $this->checkout->cart->get_cart_grand_total();
+			// create new TXN
+			$transaction = EE_Transaction::new_instance(
+				array(
+					'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
+					'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
+					'TXN_paid'      => 0,
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+				)
+			);
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// set cron job for following up on TXNs after their session has expired
+			EE_Cron_Tasks::schedule_expired_transaction_check(
+				EE_Registry::instance()->SSN->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
+		$this->checkout->total_ticket_count = count($registrations);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
+		// then loop thru the array
+		foreach ($registrations as $registration) {
+			// verify each registration
+			if ($registration instanceof EE_Registration) {
+				// we display all attendee info for the primary registrant
+				if ($this->checkout->reg_url_link === $registration->reg_url_link()
+					&& $registration->is_primary_registrant()
+				) {
+					$this->checkout->primary_revisit = true;
+					break;
+				}
+				if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
+					// but hide info if it doesn't belong to you
+					$transaction->clear_cache('Registration', $registration->ID());
+					$this->checkout->total_ticket_count--;
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+	/**
+	 *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return    array
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	private function _initialize_registrations(EE_Transaction $transaction)
+	{
+		$att_nmbr = 0;
+		$registrations = array();
+		if ($transaction instanceof EE_Transaction) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
+			// now let's add the cart items to the $transaction
+			foreach ($this->checkout->cart->get_tickets() as $line_item) {
+				//do the following for each ticket of this type they selected
+				for ($x = 1; $x <= $line_item->quantity(); $x++) {
+					$att_nmbr++;
+					/** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
+					$CreateRegistrationCommand = EE_Registry::instance()->create(
+						'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+						array(
+							$transaction,
+							$line_item,
+							$att_nmbr,
+							$this->checkout->total_ticket_count,
+						)
+					);
+					// override capabilities for frontend registrations
+					if ( ! is_admin()) {
+						$CreateRegistrationCommand->setCapCheck(
+							new PublicCapabilities('', 'create_new_registration')
+						);
+					}
+					$registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
+					if ( ! $registration instanceof EE_Registration) {
+						throw new InvalidEntityException($registration, 'EE_Registration');
+					}
+					$registrations[ $registration->ID() ] = $registration;
+				}
+			}
+			$registration_processor->fix_reg_final_price_rounding_issue($transaction);
+		}
+		return $registrations;
+	}
+
+
+
+	/**
+	 * sorts registrations by REG_count
+	 *
+	 * @access public
+	 * @param EE_Registration $reg_A
+	 * @param EE_Registration $reg_B
+	 * @return int
+	 */
+	public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
+	{
+		// this shouldn't ever happen within the same TXN, but oh well
+		if ($reg_A->count() === $reg_B->count()) {
+			return 0;
+		}
+		return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
+	}
+
+
+
+	/**
+	 *    _final_verifications
+	 * just makes sure that everything is set up correctly before proceeding
+	 *
+	 * @access    private
+	 * @return    bool
+	 * @throws EE_Error
+	 */
+	private function _final_verifications()
+	{
+		// filter checkout
+		$this->checkout = apply_filters(
+			'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
+			$this->checkout
+		);
+		//verify that current step is still set correctly
+		if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				__('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// if returning to SPCO, then verify that primary registrant is set
+		if ( ! empty($this->checkout->reg_url_link)) {
+			$valid_registrant = $this->checkout->transaction->primary_registration();
+			if ( ! $valid_registrant instanceof EE_Registration) {
+				EE_Error::add_error(
+					__('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$valid_registrant = null;
+			foreach (
+				$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration
+			) {
+				if (
+					$registration instanceof EE_Registration
+					&& $registration->reg_url_link() === $this->checkout->reg_url_link
+				) {
+					$valid_registrant = $registration;
+				}
+			}
+			if ( ! $valid_registrant instanceof EE_Registration) {
+				// hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
+				if (EED_Single_Page_Checkout::$_checkout_verified) {
+					// clear the session, mark the checkout as unverified, and try again
+					EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+					EED_Single_Page_Checkout::$_initialized = false;
+					EED_Single_Page_Checkout::$_checkout_verified = false;
+					$this->_initialize();
+					EE_Error::reset_notices();
+					return false;
+				}
+				EE_Error::add_error(
+					__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		EE_Registry::instance()->SSN->set_checkout($this->checkout);
+		return true;
+	}
+
+
+
+	/**
+	 *    _initialize_reg_steps
+	 * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
+	 * then loops thru all of the active reg steps and calls the initialize_reg_step() method
+	 *
+	 * @access    private
+	 * @param bool $reinitializing
+	 * @throws EE_Error
+	 */
+	private function _initialize_reg_steps($reinitializing = false)
+	{
+		$this->checkout->set_reg_step_initiated($this->checkout->current_step);
+		// loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if ( ! $reg_step->initialize_reg_step()) {
+				// if not initialized then maybe this step is being removed...
+				if ( ! $reinitializing && $reg_step->is_current_step()) {
+					// if it was the current step, then we need to start over here
+					$this->_initialize_reg_steps(true);
+					return;
+				}
+				continue;
+			}
+			// add css and JS for current step
+			$reg_step->enqueue_styles_and_scripts();
+			// i18n
+			$reg_step->translate_js_strings();
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action(
+			"AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
+			$this->checkout->current_step
+		);
+	}
+
+
+
+	/**
+	 * _check_form_submission
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _check_form_submission()
+	{
+		//does this request require the reg form to be generated ?
+		if ($this->checkout->generate_reg_form) {
+			// ever heard that song by Blue Rodeo ?
+			try {
+				$this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
+				// if not displaying a form, then check for form submission
+				if (
+					$this->checkout->process_form_submission
+					&& $this->checkout->current_step->reg_form->was_submitted()
+				) {
+					// clear out any old data in case this step is being run again
+					$this->checkout->current_step->set_valid_data(array());
+					// capture submitted form data
+					$this->checkout->current_step->reg_form->receive_form_submission(
+						apply_filters(
+							'FHEE__Single_Page_Checkout___check_form_submission__request_params',
+							EE_Registry::instance()->REQ->params(),
+							$this->checkout
+						)
+					);
+					// validate submitted form data
+					if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+						// thou shall not pass !!!
+						$this->checkout->continue_reg = false;
+						// any form validation errors?
+						if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
+							$submission_error_messages = array();
+							// bad, bad, bad registrant
+							foreach (
+								$this->checkout->current_step->reg_form->get_validation_errors_accumulated()
+								as $validation_error
+							) {
+								if ($validation_error instanceof EE_Validation_Error) {
+									$submission_error_messages[] = sprintf(
+										__('%s : %s', 'event_espresso'),
+										$validation_error->get_form_section()->html_label_text(),
+										$validation_error->getMessage()
+									);
+								}
+							}
+							EE_Error::add_error(
+								implode('<br />', $submission_error_messages),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+						// well not really... what will happen is
+						// we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _process_action
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _process_form_action()
+	{
+		// what cha wanna do?
+		switch ($this->checkout->action) {
+			// AJAX next step reg form
+			case 'display_spco_reg_step' :
+				$this->checkout->redirect = false;
+				if (EE_Registry::instance()->REQ->ajax) {
+					$this->checkout->json_response->set_reg_step_html(
+						$this->checkout->current_step->display_reg_form()
+					);
+				}
+				break;
+			default :
+				// meh... do one of those other steps first
+				if (
+					! empty($this->checkout->action)
+					&& is_callable(array($this->checkout->current_step, $this->checkout->action))
+				) {
+					// dynamically creates hook point like:
+					//   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+					// call action on current step
+					if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) {
+						// good registrant, you get to proceed
+						if (
+							$this->checkout->current_step->success_message() !== ''
+							&& apply_filters(
+								'FHEE__Single_Page_Checkout___process_form_action__display_success',
+								false
+							)
+						) {
+							EE_Error::add_success(
+								$this->checkout->current_step->success_message()
+								. '<br />' . $this->checkout->next_step->_instructions()
+							);
+						}
+						// pack it up, pack it in...
+						$this->_setup_redirect();
+					}
+					// dynamically creates hook point like:
+					//  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The requested form action "%s" does not exist for the current "%s" registration step.',
+								'event_espresso'
+							),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+
+	/**
+	 *        add_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_styles_and_scripts()
+	{
+		// i18n
+		$this->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		} else {
+			add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		}
+	}
+
+
+
+	/**
+	 *        translate_js_strings
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
+		EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
+		EE_Registry::$i18n_js_strings['server_error'] = __(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_json_response'] = __(
+			'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['validation_error'] = __(
+			'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = __(
+			'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['reg_step_error'] = __(
+			'This registration step could not be completed. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_coupon'] = __(
+			'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
+			__(
+				'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
+				'event_espresso'
+			),
+			'<br/>',
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
+		EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
+		EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
+		EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
+		EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__(
+				'%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+		EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension'] = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
+			'M d, Y H:i:s',
+			EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+		);
+	}
+
+
+
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 * @throws EE_Error
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'single_page_checkout',
+			SPCO_CSS_URL . 'single_page_checkout.css',
+			array('espresso_default'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('single_page_checkout');
+		// load JS
+		wp_register_script(
+			'jquery_plugin',
+			EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+			array('jquery'),
+			'1.0.1',
+			true
+		);
+		wp_register_script(
+			'jquery_countdown',
+			EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+			array('jquery_plugin'),
+			'2.0.2',
+			true
+		);
+		wp_register_script(
+			'single_page_checkout',
+			SPCO_JS_URL . 'single_page_checkout.js',
+			array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like:
+		 *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action(
+			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+			$this
+		);
+	}
+
+
+
+	/**
+	 *    display the Registration Single Page Checkout Form
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	private function _display_spco_reg_form()
+	{
+		// if registering via the admin, just display the reg form for the current step
+		if ($this->checkout->admin_request) {
+			EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
+		} else {
+			// add powered by EE msg
+			add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
+			$empty_cart = count(
+				$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
+			) < 1;
+			EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+			$cookies_not_set_msg = '';
+			if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						__(
+							'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+							'event_espresso'
+						),
+						'<div class="ee-attention">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
+						'</a>'
+					)
+				);
+			}
+			$this->checkout->registration_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'single-page-checkout',
+					'html_id'         => 'ee-single-page-checkout-dv',
+					'layout_strategy' =>
+						new EE_Template_Layout(
+							array(
+								'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+								'template_args'        => array(
+									'empty_cart'              => $empty_cart,
+									'revisit'                 => $this->checkout->revisit,
+									'reg_steps'               => $this->checkout->reg_steps,
+									'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+										? $this->checkout->next_step->slug()
+										: '',
+									'cancel_page_url'         => $this->checkout->cancel_page_url,
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											__(
+												'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'
+											),
+											'<a href="'
+											. get_post_type_archive_link('espresso_events')
+											. '" title="',
+											'">',
+											'</a>'
+										)
+									),
+									'cookies_not_set_msg'     => $cookies_not_set_msg,
+									'registration_time_limit' => $this->checkout->get_registration_time_limit(),
+									'session_expiration'      => gmdate(
+										'M d, Y H:i:s',
+										EE_Registry::instance()->SSN->expiration()
+										+ (get_option('gmt_offset') * HOUR_IN_SECONDS)
+									),
+								),
+							)
+						),
+				)
+			);
+			// load template and add to output sent that gets filtered into the_content()
+			EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
+		}
+	}
+
+
+
+	/**
+	 *    add_extra_finalize_registration_inputs
+	 *
+	 * @access    public
+	 * @param $next_step
+	 * @internal  param string $label
+	 * @return void
+	 */
+	public function add_extra_finalize_registration_inputs($next_step)
+	{
+		if ($next_step === 'finalize_registration') {
+			echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
+		}
+	}
+
+
+
+	/**
+	 *    display_registration_footer
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function display_registration_footer()
+	{
+		if (
+		apply_filters(
+			'FHEE__EE_Front__Controller__show_reg_footer',
+			EE_Registry::instance()->CFG->admin->show_reg_footer
+		)
+		) {
+			add_filter(
+				'FHEE__EEH_Template__powered_by_event_espresso__url',
+				function ($url) {
+					return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
+				}
+			);
+			echo apply_filters(
+				'FHEE__EE_Front_Controller__display_registration_footer',
+				\EEH_Template::powered_by_event_espresso(
+					'',
+					'espresso-registration-footer-dv',
+					array('utm_content' => 'registration_checkout')
+				)
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    unlock_transaction
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function unlock_transaction()
+	{
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$this->checkout->transaction->unlock();
+		}
+	}
+
+
+
+	/**
+	 *        _setup_redirect
+	 *
+	 * @access    private
+	 * @return void
+	 */
+	private function _setup_redirect()
+	{
+		if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			$this->checkout->redirect = true;
+			if (empty($this->checkout->redirect_url)) {
+				$this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
+			}
+			$this->checkout->redirect_url = apply_filters(
+				'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
+				$this->checkout->redirect_url,
+				$this->checkout
+			);
+		}
+	}
+
+
+
+	/**
+	 *   handle ajax message responses and redirects
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function go_to_next_step()
+	{
+		if (EE_Registry::instance()->REQ->ajax) {
+			// capture contents of output buffer we started earlier in the request, and insert into JSON response
+			$this->checkout->json_response->set_unexpected_errors(ob_get_clean());
+		}
+		$this->unlock_transaction();
+		// just return for these conditions
+		if (
+			$this->checkout->admin_request
+			|| $this->checkout->action === 'redirect_form'
+			|| $this->checkout->action === 'update_checkout'
+		) {
+			return;
+		}
+		// AJAX response
+		$this->_handle_json_response();
+		// redirect to next step or the Thank You page
+		$this->_handle_html_redirects();
+		// hmmm... must be something wrong, so let's just display the form again !
+		$this->_display_spco_reg_form();
+	}
+
+
+
+	/**
+	 *   _handle_json_response
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if (EE_Registry::instance()->REQ->ajax) {
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
+			//		'redirect'                   => $this->checkout->redirect,
+			//		'continue_reg'               => $this->checkout->continue_reg,
+			//	)
+			//);
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			// just send the ajax (
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			echo $json_response;
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   _handle_redirects
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _handle_html_redirects()
+	{
+		// going somewhere ?
+		if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
+			// store notices in a transient
+			EE_Error::get_notices(false, true, true);
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'headers_sent' => headers_sent(),
+			//		'redirect_url'     => $this->checkout->redirect_url,
+			//		'headers_list'    => headers_list(),
+			//	)
+			//);
+			wp_safe_redirect($this->checkout->redirect_url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   set_checkout_anchor
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
+	}
 
 
 

modules/single_page_checkout/inc/EE_Checkout.class.php

Indentation +28 added lines, -28 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_Checkout
- *
- * Description
- *
- * @package 			Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since 				4.5.0
- *
- */
+  *
+  * Class EE_Checkout
+  *
+  * Description
+  *
+  * @package 			Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since 				4.5.0
+  *
+  */
 class EE_Checkout {
 
 	/**
@@ -250,9 +250,9 @@ 
 		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', TRUE );
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
 		$this->reg_cache_where_params = array(
-		    0 => array( 'REG_deleted' => false ),
-		    'order_by' => array( 'REG_count' => 'ASC' )
-        );
+			0 => array( 'REG_deleted' => false ),
+			'order_by' => array( 'REG_count' => 'ASC' )
+		);
 	}
 
 
@@ -807,10 +807,10 @@ 
 	 */
 	public function visit_allows_processing_of_this_registration( EE_Registration $registration ) {
 		return ! $this->revisit
-		       || $this->primary_revisit
-		       || (
-			       $this->revisit && $this->reg_url_link === $registration->reg_url_link()
-		       )
+			   || $this->primary_revisit
+			   || (
+				   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
+			   )
 			? true
 			: false;
 	}
@@ -1202,16 +1202,16 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-    public function __sleep()
-    {
-	    if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
-		    $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
-	    }        // remove the reg form and the checkout
-	    if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
-		    $this->transaction = $this->transaction->ID();
-	    }        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
-    }
+	public function __sleep()
+	{
+		if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
+			$this->primary_attendee_obj = $this->primary_attendee_obj->ID();
+		}        // remove the reg form and the checkout
+		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+			$this->transaction = $this->transaction->ID();
+		}        // remove the reg form and the checkout
+		return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
+	}
 
 
 	/**

Spacing +207 added lines, -207 removed lines

@@ -247,11 +247,11 @@ 
 		$this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
 		$this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
 		$this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
-		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', TRUE );
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', TRUE);
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
 		$this->reg_cache_where_params = array(
-		    0 => array( 'REG_deleted' => false ),
-		    'order_by' => array( 'REG_count' => 'ASC' )
+		    0 => array('REG_deleted' => false),
+		    'order_by' => array('REG_count' => 'ASC')
         );
 	}
 
@@ -263,8 +263,8 @@ 
 	 * @return boolean
 	 */
 	public function any_reg_status_updated() {
-		foreach ( $this->reg_status_updated as $reg_status ) {
-			if ( $reg_status ) {
+		foreach ($this->reg_status_updated as $reg_status) {
+			if ($reg_status) {
 				return true;
 			}
 		}
@@ -277,8 +277,8 @@ 
 	 * @param $REG_ID
 	 * @return boolean
 	 */
-	public function reg_status_updated( $REG_ID ) {
-		return isset( $this->reg_status_updated[ $REG_ID ] ) ? $this->reg_status_updated[ $REG_ID ] : false;
+	public function reg_status_updated($REG_ID) {
+		return isset($this->reg_status_updated[$REG_ID]) ? $this->reg_status_updated[$REG_ID] : false;
 	}
 
 
@@ -287,8 +287,8 @@ 
 	 * @param $REG_ID
 	 * @param $reg_status
 	 */
-	public function set_reg_status_updated( $REG_ID, $reg_status ) {
-		$this->reg_status_updated[ $REG_ID ] = filter_var( $reg_status, FILTER_VALIDATE_BOOLEAN );
+	public function set_reg_status_updated($REG_ID, $reg_status) {
+		$this->reg_status_updated[$REG_ID] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * can ONLY be set by the  Finalize_Registration reg step
 	 */
 	public function set_exit_spco() {
-		if ( $this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration ) {
+		if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
 			$this->exit_spco = true;
 		}
 	}
@@ -326,12 +326,12 @@ 
 	 */
 	public function reset_for_current_request() {
 		$this->process_form_submission = FALSE;
-		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', true );
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->front_ajax;
 		$this->continue_reg = true;
 		$this->redirect = false;
 		// don't reset the cached redirect form if we're about to be asked to display it !!!
-		if ( EE_Registry::instance()->REQ->get( 'action', 'display_spco_reg_step' ) !== 'redirect_form' ) {
+		if (EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step') !== 'redirect_form') {
 			$this->redirect_form = '';
 		}
 		$this->redirect_url = '';
@@ -348,8 +348,8 @@ 
 	 * @param EE_SPCO_Reg_Step $reg_step_obj
 	 * @return    void
 	 */
-	public function add_reg_step( EE_SPCO_Reg_Step $reg_step_obj ) {
-		$this->reg_steps[ $reg_step_obj->slug()  ] = $reg_step_obj;
+	public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj) {
+		$this->reg_steps[$reg_step_obj->slug()] = $reg_step_obj;
 	}
 
 
@@ -365,22 +365,22 @@ 
 	 * @return    void
 	 * @throws \EE_Error
 	 */
-	public function skip_reg_step( $reg_step_slug = '' ) {
-		$step_to_skip = $this->find_reg_step( $reg_step_slug );
-		if ( $step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step() ) {
-			$step_to_skip->set_is_current_step( false );
+	public function skip_reg_step($reg_step_slug = '') {
+		$step_to_skip = $this->find_reg_step($reg_step_slug);
+		if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
+			$step_to_skip->set_is_current_step(false);
 			$step_to_skip->set_completed();
 			// advance to the next step
-			$this->set_current_step( $this->next_step->slug() );
+			$this->set_current_step($this->next_step->slug());
 			// also reset the step param in the request in case any other code references that directly
-			EE_Registry::instance()->REQ->set( 'step', $this->current_step->slug() );
+			EE_Registry::instance()->REQ->set('step', $this->current_step->slug());
 			// since we are skipping a step and setting the current step to be what was previously the next step,
 			// we need to check that the next step is now correct, and not still set to the current step.
-			if ( $this->current_step->slug() === $this->next_step->slug() ) {
+			if ($this->current_step->slug() === $this->next_step->slug()) {
 				// correctly setup the next step
 				$this->set_next_step();
 			}
-			$this->set_reg_step_initiated( $this->current_step );
+			$this->set_reg_step_initiated($this->current_step);
 		}
 	}
 
@@ -394,14 +394,14 @@ 
 	 * @param bool   $reset whether to reset reg steps after removal
 	 * @throws EE_Error
 	 */
-	public function remove_reg_step( $reg_step_slug = '', $reset = true ) {
-		unset( $this->reg_steps[ $reg_step_slug  ] );
-		if ( $this->transaction instanceof EE_Transaction ) {
+	public function remove_reg_step($reg_step_slug = '', $reset = true) {
+		unset($this->reg_steps[$reg_step_slug]);
+		if ($this->transaction instanceof EE_Transaction) {
 			// now remove reg step from TXN and save
-			$this->transaction->remove_reg_step( $reg_step_slug );
+			$this->transaction->remove_reg_step($reg_step_slug);
 			$this->transaction->save();
 		}
-		if ( $reset ) {
+		if ($reset) {
 			$this->reset_reg_steps();
 		}
 	}
@@ -416,9 +416,9 @@ 
 	 * @param int    $order
 	 * @return    void
 	 */
-	public function set_reg_step_order( $reg_step_slug = '', $order = 100 ) {
-		if ( isset( $this->reg_steps[ $reg_step_slug  ] )) {
-			$this->reg_steps[ $reg_step_slug ]->set_order( $order );
+	public function set_reg_step_order($reg_step_slug = '', $order = 100) {
+		if (isset($this->reg_steps[$reg_step_slug])) {
+			$this->reg_steps[$reg_step_slug]->set_order($order);
 		}
 	}
 
@@ -431,25 +431,25 @@ 
 	 * @param string $current_step
 	 * @return    void
 	 */
-	public function set_current_step( $current_step ) {
+	public function set_current_step($current_step) {
 		// grab what step we're on
-		$this->current_step = isset( $this->reg_steps[ $current_step ] ) ? $this->reg_steps[ $current_step ] : reset( $this->reg_steps );
+		$this->current_step = isset($this->reg_steps[$current_step]) ? $this->reg_steps[$current_step] : reset($this->reg_steps);
 		// verify instance
-		if ( $this->current_step instanceof EE_SPCO_Reg_Step ) {
+		if ($this->current_step instanceof EE_SPCO_Reg_Step) {
 			// we don't want to repeat completed steps if this is the first time through SPCO
-			if ( $this->continue_reg && ! $this->revisit && $this->current_step->completed() ) {
+			if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
 				// so advance to the next step
 				$this->set_next_step();
-				if ( $this->next_step instanceof EE_SPCO_Reg_Step ) {
+				if ($this->next_step instanceof EE_SPCO_Reg_Step) {
 					// and attempt to set it as the current step
-					$this->set_current_step( $this->next_step->slug() );
+					$this->set_current_step($this->next_step->slug());
 				}
 				return;
 			}
-			$this->current_step->set_is_current_step( TRUE );
+			$this->current_step->set_is_current_step(TRUE);
 		} else {
 			EE_Error::add_error(
-				__( 'The current step could not be set.', 'event_espresso' ),
+				__('The current step could not be set.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -466,20 +466,20 @@ 
 	 */
 	public function set_next_step() {
 		// set pointer to start of array
-		reset( $this->reg_steps );
+		reset($this->reg_steps);
 		// if there is more than one step
-		if ( count( $this->reg_steps ) > 1 ) {
+		if (count($this->reg_steps) > 1) {
 			// advance to the current step and set pointer
-			while ( key( $this->reg_steps ) !== $this->current_step->slug() && key( $this->reg_steps ) !== '' ) {
-				next( $this->reg_steps );
+			while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
+				next($this->reg_steps);
 			}
 		}
 		// advance one more spot ( if it exists )
-		$this->next_step = next( $this->reg_steps );
+		$this->next_step = next($this->reg_steps);
 		// verify instance
-		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step  : NULL;
+		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : NULL;
 		// then back to current step to reset
-		prev( $this->reg_steps );
+		prev($this->reg_steps);
 	}
 
 
@@ -493,8 +493,8 @@ 
 	 *  @return 	EE_SPCO_Reg_Step | null
 	 */
 	public function get_next_reg_step() {
-		$next = next( $this->reg_steps );
-		prev( $this->reg_steps );
+		$next = next($this->reg_steps);
+		prev($this->reg_steps);
 		return $next instanceof EE_SPCO_Reg_Step ? $next : null;
 	}
 
@@ -509,8 +509,8 @@ 
 	 *  @return 	EE_SPCO_Reg_Step | null
 	 */
 	public function get_prev_reg_step() {
-		$prev = prev( $this->reg_steps );
-		next( $this->reg_steps );
+		$prev = prev($this->reg_steps);
+		next($this->reg_steps);
 		return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
 	}
 
@@ -523,8 +523,8 @@ 
 	 * @return void
 	 */
 	public function sort_reg_steps() {
-		$reg_step_sorting_callback = apply_filters( 'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback', 'reg_step_sorting_callback' );
-		uasort( $this->reg_steps, array( $this, $reg_step_sorting_callback ));
+		$reg_step_sorting_callback = apply_filters('FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback', 'reg_step_sorting_callback');
+		uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
 	}
 
 
@@ -537,19 +537,19 @@ 
 	 * @param string $reg_step_slug
 	 * @return EE_SPCO_Reg_Step|null
 	 */
-	public function find_reg_step( $reg_step_slug = '' ) {
-		if ( ! empty( $reg_step_slug ) ) {
+	public function find_reg_step($reg_step_slug = '') {
+		if ( ! empty($reg_step_slug)) {
 			// copy reg step array
 			$reg_steps = $this->reg_steps;
 			// set pointer to start of array
-			reset( $reg_steps );
+			reset($reg_steps);
 			// if there is more than one step
-			if ( count( $reg_steps ) > 1 ) {
+			if (count($reg_steps) > 1) {
 				// advance to the current step and set pointer
-				while ( key( $reg_steps ) !== $reg_step_slug && key( $reg_steps ) !== '' ) {
-					next( $reg_steps );
+				while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
+					next($reg_steps);
 				}
-				return current( $reg_steps );
+				return current($reg_steps);
 			}
 		}
 		return null;
@@ -565,17 +565,17 @@ 
 	 * @param EE_SPCO_Reg_Step $reg_step_B
 	 * @return int
 	 */
-	public function reg_step_sorting_callback( EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B ) {
+	public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B) {
 		// send finalize_registration step to the end of the array
-		if ( $reg_step_A->slug() === 'finalize_registration' ) {
+		if ($reg_step_A->slug() === 'finalize_registration') {
 			return 1;
-		} else if ( $reg_step_B->slug() === 'finalize_registration' ) {
+		} else if ($reg_step_B->slug() === 'finalize_registration') {
 			return -1;
 		}
-		if ( $reg_step_A->order() === $reg_step_B->order() ) {
+		if ($reg_step_A->order() === $reg_step_B->order()) {
 			return 0;
 		}
-		return ( $reg_step_A->order() > $reg_step_B->order() ) ? 1 : -1;
+		return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
 	}
 
 
@@ -587,7 +587,7 @@ 
 	 * @param    EE_SPCO_Reg_Step $reg_step
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_initiated( EE_SPCO_Reg_Step $reg_step ) {
+	public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step) {
 		// call set_reg_step_initiated ???
 		if (
 			// first time visiting SPCO ?
@@ -600,11 +600,11 @@ 
 			)
 		) {
 			// set the start time for this reg step
-			if ( ! $this->transaction->set_reg_step_initiated( $reg_step->slug() ) ) {
-				if ( WP_DEBUG ) {
+			if ( ! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+				if (WP_DEBUG) {
 					EE_Error::add_error(
 						sprintf(
-							__( 'The "%1$s" registration step was not initialized properly.', 'event_espresso' ),
+							__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
 							$reg_step->name()
 						),
 						__FILE__, __FUNCTION__, __LINE__
@@ -623,10 +623,10 @@ 
 	 * 	@return 	void
 	 */
 	public function set_reg_step_JSON_info() {
-		EE_Registry::$i18n_js_strings[ 'reg_steps' ] = array();
+		EE_Registry::$i18n_js_strings['reg_steps'] = array();
 		// pass basic reg step data to JS
-		foreach ( $this->reg_steps as $reg_step ) {
-			EE_Registry::$i18n_js_strings[ 'reg_steps' ][] = $reg_step->slug();
+		foreach ($this->reg_steps as $reg_step) {
+			EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
 		}
 		// reset reg step html
 //		$this->json_response->set_reg_step_html( '' );
@@ -642,7 +642,7 @@ 
 	 */
 	public function reset_reg_steps() {
 		$this->sort_reg_steps();
-		$this->set_current_step( EE_Registry::instance()->REQ->get( 'step' ));
+		$this->set_current_step(EE_Registry::instance()->REQ->get('step'));
 		$this->set_next_step();
 		// the text that appears on the reg step form submit button
 		$this->current_step->set_submit_button_text();
@@ -659,9 +659,9 @@ 
 	 */
 	public function get_registration_time_limit() {
 
-		$registration_time_limit = (float)( EE_Registry::instance()	->SSN->expiration() - time() );
+		$registration_time_limit = (float) (EE_Registry::instance()	->SSN->expiration() - time());
 		$time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
-		$registration_time_limit = date( $time_limit_format, $registration_time_limit );
+		$registration_time_limit = date($time_limit_format, $registration_time_limit);
 		return apply_filters(
 			'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
 			$registration_time_limit
@@ -681,7 +681,7 @@ 
 		//		overpaid TXN
 		//		free TXN ( total = 0.00 )
 		// then payment required is TRUE
-		return ! ( $this->admin_request || $this->transaction->is_completed() || $this->transaction->is_overpaid() || $this->transaction->is_free() ) ? TRUE : FALSE;
+		return ! ($this->admin_request || $this->transaction->is_completed() || $this->transaction->is_overpaid() || $this->transaction->is_free()) ? TRUE : FALSE;
 	}
 
 
@@ -693,12 +693,12 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Cart
 	 */
-	public function get_cart_for_transaction( $transaction ) {
-		$session = EE_Registry::instance()->load_core( 'Session' );
-		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn( $transaction, $session ) : null;
+	public function get_cart_for_transaction($transaction) {
+		$session = EE_Registry::instance()->load_core('Session');
+		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
 		// verify cart
-		if ( ! $cart instanceof EE_Cart ) {
-			$cart = EE_Registry::instance()->load_core( 'Cart' );
+		if ( ! $cart instanceof EE_Cart) {
+			$cart = EE_Registry::instance()->load_core('Cart');
 		}
 
 		return $cart;
@@ -714,8 +714,8 @@ 
 	 */
 	public function initialize_txn_reg_steps_array() {
 		$txn_reg_steps_array = array();
-		foreach ( $this->reg_steps as $reg_step ) {
-			$txn_reg_steps_array[ $reg_step->slug() ] = FALSE;
+		foreach ($this->reg_steps as $reg_step) {
+			$txn_reg_steps_array[$reg_step->slug()] = FALSE;
 		}
 		return $txn_reg_steps_array;
 	}
@@ -731,14 +731,14 @@ 
 	 */
 	public function update_txn_reg_steps_array() {
 		$updated = false;
-		foreach ( $this->reg_steps as $reg_step ) {
-			if ( $reg_step->completed() ) {
-				$updated = $this->transaction->set_reg_step_completed( $reg_step->slug() )
+		foreach ($this->reg_steps as $reg_step) {
+			if ($reg_step->completed()) {
+				$updated = $this->transaction->set_reg_step_completed($reg_step->slug())
 					? true
 					: $updated;
 			}
 		}
-		if ( $updated ) {
+		if ($updated) {
 			$this->transaction->save();
 		}
 		return $updated;
@@ -754,14 +754,14 @@ 
 	 * @throws \EE_Error
 	 */
 	public function stash_transaction_and_checkout() {
-		if ( ! $this->revisit ) {
+		if ( ! $this->revisit) {
 			$this->update_txn_reg_steps_array();
 		}
 		$this->track_transaction_and_registration_status_updates();
 		// save all data to the db, but suppress errors
 		//$this->save_all_data( FALSE );
 		// cache the checkout in the session
-		EE_Registry::instance()->SSN->set_checkout( $this );
+		EE_Registry::instance()->SSN->set_checkout($this);
 	}
 
 
@@ -776,15 +776,15 @@ 
 	 */
 	public function track_transaction_and_registration_status_updates() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction ) {
+		if ($this->transaction instanceof EE_Transaction) {
 			// has there been a TXN status change during this checkout?
 			$this->txn_status_updated = $this->transaction->txn_status_updated();
 			/** @type EE_Registration_Processor $registration_processor */
-			$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 			// grab the saved registrations from the transaction
-			foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as $registration ) {
-				if ( $registration_processor->reg_status_updated( $registration->ID() ) ) {
-					$this->set_reg_status_updated( $registration->ID(), true );
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				if ($registration_processor->reg_status_updated($registration->ID())) {
+					$this->set_reg_status_updated($registration->ID(), true);
 				}
 			}
 		}
@@ -805,7 +805,7 @@ 
 	 * @return    bool
 	 * @throws \EE_Error
 	 */
-	public function visit_allows_processing_of_this_registration( EE_Registration $registration ) {
+	public function visit_allows_processing_of_this_registration(EE_Registration $registration) {
 		return ! $this->revisit
 		       || $this->primary_revisit
 		       || (
@@ -838,18 +838,18 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function save_all_data( $show_errors = TRUE ) {
+	public function save_all_data($show_errors = TRUE) {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction ) {
+		if ($this->transaction instanceof EE_Transaction) {
 			// save to ensure that TXN has ID
 			$this->transaction->save();
 			// grab the saved registrations from the transaction
-			foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as  $registration ) {
-				$this->_save_registration( $registration, $show_errors );
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as  $registration) {
+				$this->_save_registration($registration, $show_errors);
 			}
 		} else {
-			if ( $show_errors ) {
-				EE_Error::add_error( __( 'A valid Transaction was not found when attempting to save your registration information.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			if ($show_errors) {
+				EE_Error::add_error(__('A valid Transaction was not found when attempting to save your registration information.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			}
 			return FALSE;
 		}
@@ -866,32 +866,32 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration( $registration, $show_errors = TRUE  ) {
+	private function _save_registration($registration, $show_errors = TRUE) {
 		// verify object
-		if ( $registration instanceof EE_Registration ) {
+		if ($registration instanceof EE_Registration) {
 			// should this registration be processed during this visit ?
-			if ( $this->visit_allows_processing_of_this_registration( $registration ) ) {
+			if ($this->visit_allows_processing_of_this_registration($registration)) {
 				//set TXN ID
-				if ( ! $registration->transaction_ID() ) {
-					$registration->set_transaction_id( $this->transaction->ID() );
+				if ( ! $registration->transaction_ID()) {
+					$registration->set_transaction_id($this->transaction->ID());
 				}
 				// verify and save the attendee
-				$this->_save_registration_attendee( $registration, $show_errors );
+				$this->_save_registration_attendee($registration, $show_errors);
 				// save answers to reg form questions
-				$this->_save_registration_answers( $registration, $show_errors );
+				$this->_save_registration_answers($registration, $show_errors);
 				// save changes
 				$registration->save();
 				// update txn cache
-				if ( ! $this->transaction->update_cache_after_object_save( 'Registration', $registration )) {
-					if ( $show_errors ) {
-						EE_Error::add_error( __( 'The newly saved Registration object could not be cached on the Transaction.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+				if ( ! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+					if ($show_errors) {
+						EE_Error::add_error(__('The newly saved Registration object could not be cached on the Transaction.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 					}
 				}
 			}
 		} else {
-			if ( $show_errors ) {
+			if ($show_errors) {
 				EE_Error::add_error(
-					__( 'An invalid Registration object was discovered when attempting to save your registration information.', 'event_espresso' ),
+					__('An invalid Registration object was discovered when attempting to save your registration information.', 'event_espresso'),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -908,25 +908,25 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration_attendee( $registration, $show_errors = TRUE ) {
-		if ( $registration->attendee() instanceof EE_Attendee ) {
+	private function _save_registration_attendee($registration, $show_errors = TRUE) {
+		if ($registration->attendee() instanceof EE_Attendee) {
 			// save so that ATT has ID
 			$registration->attendee()->save();
-			if ( ! $registration->update_cache_after_object_save( 'Attendee', $registration->attendee() ) ) {
-				if ( $show_errors ) {
+			if ( ! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+				if ($show_errors) {
 					EE_Error::add_error(
-						__( 'The newly saved Attendee object could not be cached on the registration.', 'event_espresso' ),
+						__('The newly saved Attendee object could not be cached on the registration.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 					);
 				}
 			}
 		} else {
-			if ( $show_errors ) {
+			if ($show_errors) {
 				EE_Error::add_error(
 					sprintf(
 						'%1$s||%1$s $attendee = %2$s',
-						__( 'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.', 'event_espresso' ),
-						var_export( $registration->attendee(), true )
+						__('Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.', 'event_espresso'),
+						var_export($registration->attendee(), true)
 					),
 					__FILE__, __FUNCTION__, __LINE__
 				);
@@ -944,25 +944,25 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration_answers( $registration, $show_errors = TRUE ) {
+	private function _save_registration_answers($registration, $show_errors = TRUE) {
 		// now save the answers
-		foreach ( $registration->answers() as $cache_key => $answer ) {
+		foreach ($registration->answers() as $cache_key => $answer) {
 			// verify object
-			if ( $answer instanceof EE_Answer ) {
-				$answer->set_registration( $registration->ID() );
+			if ($answer instanceof EE_Answer) {
+				$answer->set_registration($registration->ID());
 				$answer->save();
-				if ( ! $registration->update_cache_after_object_save( 'Answer', $answer, $cache_key )) {
-					if ( $show_errors ) {
+				if ( ! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+					if ($show_errors) {
 						EE_Error::add_error(
-							__( 'The newly saved Answer object could not be cached on the registration.', 'event_espresso' ),
+							__('The newly saved Answer object could not be cached on the registration.', 'event_espresso'),
 							__FILE__, __FUNCTION__, __LINE__
 						);
 					}
 				}
 			} else {
-				if ( $show_errors ) {
+				if ($show_errors) {
 					EE_Error::add_error(
-						__( 'An invalid Answer object was discovered when attempting to save your registration information.', 'event_espresso' ),
+						__('An invalid Answer object was discovered when attempting to save your registration information.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 					);
 				}
@@ -981,7 +981,7 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function refresh_all_entities( $from_db = false ) {
+	public function refresh_all_entities($from_db = false) {
 		$from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
 			? true
 			: $from_db;
@@ -1005,11 +1005,11 @@ 
 	 */
 	protected function refresh_from_db() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 			// pull fresh TXN data from the db
-			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db( $this->transaction->ID() );
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
 			// update EE_Checkout's cached primary_attendee object
-			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db( $this->transaction );
+			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
 			// update EE_Checkout's cached payment object
 			$payment = $this->transaction->last_payment();
 			$this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
@@ -1017,9 +1017,9 @@ 
 			$payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
 			$this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method : $this->payment_method;
 			//now refresh the cart, based on the TXN
-			$this->cart = $this->get_cart_for_transaction( $this->transaction );
+			$this->cart = $this->get_cart_for_transaction($this->transaction);
 		} else {
-			EE_Error::add_error( __( 'A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			EE_Error::add_error(__('A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		return TRUE;
@@ -1034,21 +1034,21 @@ 
 	 * @return  EE_Attendee | null
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_primary_attendee_obj_from_db( EE_Transaction $transaction ) {
+	protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction) {
 
 		$primary_attendee_obj = null;
 		// grab the saved registrations from the transaction
-		foreach ( $transaction->registrations( $this->reg_cache_where_params, true ) as $registration ) {
+		foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
 			// verify object
-			if ( $registration instanceof EE_Registration ) {
+			if ($registration instanceof EE_Registration) {
 				$attendee = $registration->attendee();
 				// verify object && maybe cache primary_attendee_obj ?
-				if ( $attendee instanceof EE_Attendee&& $registration->is_primary_registrant() ) {
+				if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
 					$primary_attendee_obj = $attendee;
 				}
 			} else {
 				EE_Error::add_error(
-						__( 'An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+						__('An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -1069,43 +1069,43 @@ 
 	 */
 	protected function refresh_entity_map() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 			// never cache payment info
-			$this->transaction->clear_cache( 'Payment' );
+			$this->transaction->clear_cache('Payment');
 			// is the Payment Options Reg Step completed ?
-			if ( $this->transaction->reg_step_completed( 'payment_options' ) ) {
+			if ($this->transaction->reg_step_completed('payment_options')) {
 				// then check for payments and update TXN accordingly
 				/** @type EE_Transaction_Payments $transaction_payments */
-				$transaction_payments = EE_Registry::instance()->load_class( 'Transaction_Payments' );
-				$transaction_payments->calculate_total_payments_and_update_status( $this->transaction );
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				$transaction_payments->calculate_total_payments_and_update_status($this->transaction);
 			}
 			// grab the saved registrations from the transaction
 			foreach (
-				$this->transaction->registrations( $this->reg_cache_where_params ) as $reg_cache_ID => $registration
+				$this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration
 			) {
-				$this->_refresh_registration( $reg_cache_ID, $registration );
+				$this->_refresh_registration($reg_cache_ID, $registration);
 			}
 			// make sure our cached TXN is added to the model entity mapper
-			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with( $this->transaction->ID(), $this->transaction );
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with($this->transaction->ID(), $this->transaction);
 
 		} else {
-			EE_Error::add_error( __( 'A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			EE_Error::add_error(__('A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		// verify and update the cart because inaccurate totals are not so much fun
-		if ( $this->cart instanceof EE_Cart ) {
+		if ($this->cart instanceof EE_Cart) {
 			$grand_total = $this->cart->get_grand_total();
-			if ( $grand_total instanceof EE_Line_Item && $grand_total->ID() ) {
+			if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
 				$grand_total->recalculate_total_including_taxes();
 				$grand_total = $grand_total->get_model()->refresh_entity_map_with(
 					$this->cart->get_grand_total()->ID(),
 					$this->cart->get_grand_total()
 				);
 			}
-			if ( $grand_total instanceof EE_Line_Item ) {
-				$this->cart = EE_Cart::instance( $grand_total );
+			if ($grand_total instanceof EE_Line_Item) {
+				$this->cart = EE_Cart::instance($grand_total);
 			} else {
-				EE_Error::add_error( __( 'A valid Cart was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(__('A valid Cart was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 				return false;
 			}
 		}
@@ -1122,19 +1122,19 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration( $reg_cache_ID, $registration ) {
+	protected function _refresh_registration($reg_cache_ID, $registration) {
 
 		// verify object
-		if ( $registration instanceof EE_Registration ) {
+		if ($registration instanceof EE_Registration) {
 			// update the entity mapper attendee
-			$this->_refresh_registration_attendee( $registration );
+			$this->_refresh_registration_attendee($registration);
 			// update the entity mapper answers for reg form questions
-			$this->_refresh_registration_answers( $registration );
+			$this->_refresh_registration_answers($registration);
 			// make sure the cached registration is added to the model entity mapper
-			$registration->get_model()->refresh_entity_map_with( $reg_cache_ID, $registration );
+			$registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
 		} else {
 			EE_Error::add_error(
-				__( 'An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+				__('An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -1149,15 +1149,15 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration_attendee( $registration ) {
+	protected function _refresh_registration_attendee($registration) {
 
 		$attendee = $registration->attendee();
 		// verify object
-		if ( $attendee instanceof EE_Attendee && $attendee->ID() ) {
+		if ($attendee instanceof EE_Attendee && $attendee->ID()) {
 			// make sure the cached attendee is added to the model entity mapper
-			$registration->attendee()->get_model()->refresh_entity_map_with( $attendee->ID(), $attendee );
+			$registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
 			// maybe cache primary_attendee_obj ?
-			if ( $registration->is_primary_registrant() ) {
+			if ($registration->is_primary_registrant()) {
 				$this->primary_attendee_obj = $attendee;
 			}
 		}
@@ -1172,19 +1172,19 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration_answers( $registration ) {
+	protected function _refresh_registration_answers($registration) {
 
 		// now update the answers
-		foreach ( $registration->answers() as $cache_key => $answer ) {
+		foreach ($registration->answers() as $cache_key => $answer) {
 			// verify object
-			if ( $answer instanceof EE_Answer ) {
-				if ( $answer->ID() ) {
+			if ($answer instanceof EE_Answer) {
+				if ($answer->ID()) {
 					// make sure the cached answer is added to the model entity mapper
-					$answer->get_model()->refresh_entity_map_with( $answer->ID(), $answer );
+					$answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
 				}
 			} else {
 				EE_Error::add_error(
-					__( 'An invalid Answer object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+					__('An invalid Answer object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -1204,13 +1204,13 @@ 
 	 */
     public function __sleep()
     {
-	    if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
+	    if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
 		    $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
 	    }        // remove the reg form and the checkout
-	    if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+	    if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 		    $this->transaction = $this->transaction->ID();
 	    }        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
+        return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
     }
 
 
@@ -1220,15 +1220,15 @@ 
 	 * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
 	 */
 	public function __wakeup() {
-		if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint( $this->primary_attendee_obj ) !== 0 ) {
+		if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
 			// $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
-			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID( $this->primary_attendee_obj );
+			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
 		}
-		if ( ! $this->transaction instanceof EE_Transaction && absint( $this->transaction ) !== 0 ) {
+		if ( ! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
 			// $this->transaction is actually just an ID, so use it to get the object from the db
-			$this->transaction = EEM_Transaction::instance()->get_one_by_ID( $this->transaction );
+			$this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
 		}
-		foreach ( $this->reg_steps as $reg_step ) {
+		foreach ($this->reg_steps as $reg_step) {
 			$reg_step->checkout = $this;
 		}
 	}
@@ -1245,12 +1245,12 @@ 
 	 * @param bool   $display_request
 	 * @throws \EE_Error
 	 */
-	public function log( $class = '', $func = '', $line = '', $info = array(), $display_request = false ) {
+	public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false) {
 		$disabled = true;
-		if ( WP_DEBUG && ! $disabled ) {
-			$debug_data = get_option( 'EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array() );
+		if (WP_DEBUG && ! $disabled) {
+			$debug_data = get_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), array());
 			$default_data = array(
-				$class 		=> $func . '() : ' . $line,
+				$class 		=> $func.'() : '.$line,
 				'request->step' 		=> $this->step,
 				'request->action' 	=> $this->action,
 				'current_step->slug' => $this->current_step instanceof EE_SPCO_Reg_Step ?
@@ -1262,24 +1262,24 @@ 
 				'reg_url_link' => $this->reg_url_link,
 				'REQ' => $display_request ? $_REQUEST : '',
 			);
-			if ( $this->transaction instanceof EE_Transaction ) {
-				$default_data[ 'TXN_status' ] 		= $this->transaction->status_ID();
-				$default_data[ 'TXN_reg_steps' ] 	= $this->transaction->reg_steps();
-				foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as $REG_ID => $registration ) {
-					$default_data[ 'registrations' ][ $REG_ID ] = $registration->status_ID();
+			if ($this->transaction instanceof EE_Transaction) {
+				$default_data['TXN_status'] = $this->transaction->status_ID();
+				$default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
+				foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
+					$default_data['registrations'][$REG_ID] = $registration->status_ID();
 				}
-				if ( $this->transaction->ID() ) {
-					$TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+				if ($this->transaction->ID()) {
+					$TXN_ID = 'EE_Transaction: '.$this->transaction->ID();
 					// don't serialize objects
-					$info = $this->_strip_objects( $info );
-					if ( ! isset( $debug_data[ $TXN_ID ] ) ) {
-						$debug_data[ $TXN_ID ] = array();
+					$info = $this->_strip_objects($info);
+					if ( ! isset($debug_data[$TXN_ID])) {
+						$debug_data[$TXN_ID] = array();
 					}
-					$debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+					$debug_data[$TXN_ID][microtime()] = array_merge(
 						$default_data,
 						$info
 					);
-					update_option( 'EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data );
+					update_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), $debug_data);
 				}
 			}
 		}
@@ -1292,23 +1292,23 @@ 
 	 * @param array $info
 	 * @return array
 	 */
-	public function _strip_objects( $info = array() ) {
-		foreach ( (array)$info as $key => $value ) {
-			if ( is_array( $value )) {
-				$info[ $key ] = $this->_strip_objects( $value );
-			} else if ( is_object( $value ) ) {
-				$object_class = get_class( $value );
-				$info[ $object_class ] = array();
-				$info[ $object_class ][ 'ID' ] = method_exists( $value, 'ID' ) ? $value->ID() : 0;
-				if ( method_exists( $value, 'status' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status();
-				} else if ( method_exists( $value, 'status_ID' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status_ID();
+	public function _strip_objects($info = array()) {
+		foreach ((array) $info as $key => $value) {
+			if (is_array($value)) {
+				$info[$key] = $this->_strip_objects($value);
+			} else if (is_object($value)) {
+				$object_class = get_class($value);
+				$info[$object_class] = array();
+				$info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+				if (method_exists($value, 'status')) {
+					$info[$object_class]['status'] = $value->status();
+				} else if (method_exists($value, 'status_ID')) {
+					$info[$object_class]['status'] = $value->status_ID();
 				}
-				unset( $info[ $key ] );
+				unset($info[$key]);
 			}
 		}
-		return (array)$info;
+		return (array) $info;
 	}
 
 

core/domain/services/registration/UpdateRegistrationService.php

Indentation +20 added lines, -20 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\domain\services\DomainService;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,25 +20,25 @@ 
 class UpdateRegistrationService extends DomainService
 {
 
-    /**
-     * @param \EE_Registration $registration
-     * @return bool
-     */
-    public function updateRegistrationAndTransaction(\EE_Registration $registration)
-    {
-        $transaction = $registration->transaction();
-        // reset transaction status back to incomplete
-        $transaction->set_status(\EEM_Transaction::incomplete_status_code);
-        // update transaction and all line item totals and subtotals
-        $transaction->total_line_item()->recalculate_total_including_taxes();
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid();
-        /** @type \EE_Registration_Processor $registration_processor */
-        $registration_processor = \EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->update_registration_final_prices($transaction);
-        $registration_processor->update_registration_status_and_trigger_notifications($registration);
-        return true;
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @return bool
+	 */
+	public function updateRegistrationAndTransaction(\EE_Registration $registration)
+	{
+		$transaction = $registration->transaction();
+		// reset transaction status back to incomplete
+		$transaction->set_status(\EEM_Transaction::incomplete_status_code);
+		// update transaction and all line item totals and subtotals
+		$transaction->total_line_item()->recalculate_total_including_taxes();
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid();
+		/** @type \EE_Registration_Processor $registration_processor */
+		$registration_processor = \EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->update_registration_final_prices($transaction);
+		$registration_processor->update_registration_status_and_trigger_notifications($registration);
+		return true;
+	}
 
 }
 // End of file UpdateRegistrationService.php

admin_pages/registrations/Registrations_Admin_Page.core.php

Spacing +87 added lines, -87 removed lines

@@ -73,7 +73,7 @@ 
         // 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'])
+            if ( ! isset($this->_req_data['processing_registration'])
                  || absint($this->_req_data['processing_registration']) !== 1
             ) {
                 // and it's NOT the attendee information reg step
@@ -168,7 +168,7 @@ 
     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'])
+        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID'] : 0;
         $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
             ? $this->_req_data['reg_status_change_form']['REG_ID']
@@ -658,7 +658,7 @@ 
         //style
         wp_register_style(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
+            REG_ASSETS_URL.'espresso_registrations_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -666,7 +666,7 @@ 
         //script
         wp_register_script(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
+            REG_ASSETS_URL.'espresso_registrations_admin.js',
             array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -704,7 +704,7 @@ 
         wp_deregister_style('espresso_reg');
         wp_register_style(
             'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
+            REG_ASSETS_URL.'espresso_attendees_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -716,7 +716,7 @@ 
     {
         wp_register_script(
             'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
+            REG_ASSETS_URL.'spco_for_admin.js',
             array('underscore', 'jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -849,7 +849,7 @@ 
                     'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
                 ),
             );
-            $this->_views['trash']      = array(
+            $this->_views['trash'] = array(
                 'slug'        => 'trash',
                 'label'       => esc_html__('Trash', 'event_espresso'),
                 'count'       => 0,
@@ -938,7 +938,7 @@ 
         }
         $sc_items = array(
             'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_approved,
                     false,
@@ -946,7 +946,7 @@ 
                 ),
             ),
             'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                '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,
@@ -954,7 +954,7 @@ 
                 ),
             ),
             'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                '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,
@@ -962,7 +962,7 @@ 
                 ),
             ),
             'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_incomplete,
                     false,
@@ -970,7 +970,7 @@ 
                 ),
             ),
             'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                '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,
@@ -978,7 +978,7 @@ 
                 ),
             ),
             'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_declined,
                     false,
@@ -986,7 +986,7 @@ 
                 ),
             ),
             'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_cancelled,
                     false,
@@ -1015,7 +1015,7 @@ 
                 'espresso_registrations_new_registration',
                 $EVT_ID
             )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+                $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                     'new_registration',
                     'add-registrant',
                     array('event_id' => $EVT_ID),
@@ -1055,7 +1055,7 @@ 
                 $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'] .= ' ( '.$datetime->start_date().' )';
                 $this->_template_args['admin_page_header'] .= '</span></h3>';
             }
         }
@@ -1155,7 +1155,7 @@ 
             'caps'                     => EEM_Registration::caps_read_admin,
             'default_where_conditions' => 'this_model_only',
         );
-        if (! $count) {
+        if ( ! $count) {
             $query_params = array_merge(
                 $query_params,
                 $this->_get_orderby_for_registrations_query(),
@@ -1176,7 +1176,7 @@ 
     protected function _add_event_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['event_id'])) {
+        if ( ! empty($request['event_id'])) {
             $where['EVT_ID'] = absint($request['event_id']);
         }
         return $where;
@@ -1192,7 +1192,7 @@ 
     protected function _add_category_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
+        if ( ! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
             $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
         }
         return $where;
@@ -1208,10 +1208,10 @@ 
     protected function _add_datetime_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['datetime_id'])) {
+        if ( ! empty($request['datetime_id'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
         }
-        if (! empty($request['DTT_ID'])) {
+        if ( ! empty($request['DTT_ID'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
         }
         return $where;
@@ -1237,7 +1237,7 @@ 
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
+        if ( ! empty($registration_status)) {
             $where['STS_ID'] = $registration_status;
         } else {
             //make sure we exclude incomplete registrations, but only if not trashed.
@@ -1277,12 +1277,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 00:00:00',
+                        $now.' 00:00:00',
                         'Y-m-d H:i:s'
                     ),
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 23:59:59',
+                        $now.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1295,12 +1295,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
+                        $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',
+                        $current_year_and_month.'-'.$days_this_month.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1315,18 +1315,18 @@ 
                 : '';
             //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'));
+                $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',
+                            $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',
+                            $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59',
                             'Y-m-d H:i:s'
                         ),
                     ),
@@ -1346,8 +1346,8 @@ 
     protected function _add_search_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
+        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),
@@ -1460,7 +1460,7 @@ 
             : $per_page;
 
         //-1 means return all results so get out if that's set.
-        if ((int)$per_page === -1) {
+        if ((int) $per_page === -1) {
             return array();
         }
         $per_page = absint($per_page);
@@ -1513,7 +1513,7 @@ 
                 ),
                 REG_ADMIN_URL
             );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'action' => 'default',
                     'EVT_ID' => $event_id,
@@ -1521,7 +1521,7 @@ 
                 ),
                 admin_url('admin.php')
             );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'page'   => 'espresso_events',
                     'action' => 'edit',
@@ -1530,12 +1530,12 @@ 
                 admin_url('admin.php')
             );
             //next and previous links
-            $next_reg                                      = $this->_registration->next(
+            $next_reg = $this->_registration->next(
                 null,
                 array(),
                 'REG_ID'
             );
-            $this->_template_args['next_registration']     = $next_reg
+            $this->_template_args['next_registration'] = $next_reg
                 ? $this->_next_link(
                     EE_Admin_Page::add_query_args_and_nonce(
                         array(
@@ -1547,7 +1547,7 @@ 
                     'dashicons dashicons-arrow-right ee-icon-size-22'
                 )
                 : '';
-            $previous_reg                                  = $this->_registration->previous(
+            $previous_reg = $this->_registration->previous(
                 null,
                 array(),
                 'REG_ID'
@@ -1565,7 +1565,7 @@ 
                 )
                 : '';
             // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+            $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,
@@ -1682,7 +1682,7 @@ 
                             EEH_HTML::strong(
                                 $this->_registration->pretty_status(),
                                 '',
-                                'status-' . $this->_registration->status_ID(),
+                                'status-'.$this->_registration->status_ID(),
                                 'line-height: 1em; font-size: 1.5em; font-weight: bold;'
                             )
                         )
@@ -1758,11 +1758,11 @@ 
     {
         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) $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) $this->_req_data['_REG_ID']
                 : array();
         }
         // sanitize $REG_IDs
@@ -1807,7 +1807,7 @@ 
     {
         $success = false;
         // typecast $REG_IDs
-        $REG_IDs = (array)$REG_IDs;
+        $REG_IDs = (array) $REG_IDs;
         if ( ! empty($REG_IDs)) {
             $success = true;
             // set default status if none is passed
@@ -1944,7 +1944,7 @@ 
             $action,
             $notify
         );
-        $method = $action . '_registration';
+        $method = $action.'_registration';
         if (method_exists($this, $method)) {
             $this->$method($notify);
         }
@@ -2058,7 +2058,7 @@ 
             $filtered_line_item_tree,
             array('EE_Registration' => $this->_registration)
         );
-        $attendee                                = $this->_registration->attendee();
+        $attendee = $this->_registration->attendee();
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_read_transaction',
             'espresso_transactions_view_transaction'
@@ -2137,7 +2137,7 @@ 
                 'Payment method response',
                 'event_espresso'
             );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+            $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__(
@@ -2165,7 +2165,7 @@ 
         $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';
+            REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2194,7 +2194,7 @@ 
             $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';
+                REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
             echo EEH_Template::display_template($template_path, $this->_template_args, true);
         }
     }
@@ -2211,7 +2211,7 @@ 
     public function form_before_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __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'
@@ -2236,7 +2236,7 @@ 
     public function form_after_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __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'
@@ -2274,7 +2274,7 @@ 
     public function form_form_field_label_wrap($label)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __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'
@@ -2284,7 +2284,7 @@ 
         return '
 			<tr>
 				<th>
-					' . $label . '
+					' . $label.'
 				</th>';
     }
 
@@ -2300,7 +2300,7 @@ 
     public function form_form_field_input__wrap($input)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __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'
@@ -2309,7 +2309,7 @@ 
         );
         return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
-					' . $input . '
+					' . $input.'
 				</td>
 			</tr>';
     }
@@ -2351,7 +2351,7 @@ 
     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');
+            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)
             );
@@ -2384,7 +2384,7 @@ 
         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(
+                    $where_conditions = array(
                         'QST_ID' => $question_id,
                         'REG_ID' => $REG_ID,
                     );
@@ -2422,7 +2422,7 @@ 
         $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(
+        $registrations = $REG->get_all(array(
             array(
                 'TXN_ID' => $this->_registration->transaction_ID(),
                 'REG_ID' => array('!=', $this->_registration->ID()),
@@ -2446,7 +2446,7 @@ 
             $att_nmbr = 1;
             foreach ($registrations as $registration) {
                 /* @var $registration EE_Registration */
-                $attendee                                                    = $registration->attendee()
+                $attendee = $registration->attendee()
                     ? $registration->attendee()
                     : EEM_Attendee::instance()
                                   ->create_default_object();
@@ -2459,19 +2459,19 @@ 
                     ', ',
                     $attendee->full_address_as_array()
                 );
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
+                $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();
+                $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';
+        $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);
     }
 
@@ -2511,20 +2511,20 @@ 
         $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(
+        $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
+        $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';
+        $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);
     }
 
@@ -2566,7 +2566,7 @@ 
             /** @var EE_Registration $REG */
             $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
             $payments = $REG->registration_payments();
-            if (! empty($payments)) {
+            if ( ! empty($payments)) {
                 $name = $REG->attendee() instanceof EE_Attendee
                     ? $REG->attendee()->full_name()
                     : esc_html__('Unknown Attendee', 'event_espresso');
@@ -2759,7 +2759,7 @@ 
                 'action' => 'edit',
                 'post'   => $this->_reg_event->ID(),
             ), EVENTS_ADMIN_URL);
-            $edit_event_lnk                     = '<a href="'
+            $edit_event_lnk = '<a href="'
                                                   . $edit_event_url
                                                   . '" title="'
                                                   . esc_attr__('Edit ', 'event_espresso')
@@ -2777,7 +2777,7 @@ 
         }
         // grab header
         $template_path                              =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+            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 );
@@ -2812,7 +2812,7 @@ 
                 '</b>'
             );
             return '
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
+	<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
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -2880,7 +2880,7 @@ 
         //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',
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php',
             $template_args,
             true
         );
@@ -2899,7 +2899,7 @@ 
         if (is_object($this->_reg_event)) {
             return true;
         }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+        $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
         if ( ! $EVT_ID) {
             return false;
         }
@@ -2965,7 +2965,7 @@ 
                 }
                 break;
             case 'questions' :
-                if (! isset(
+                if ( ! isset(
                     $this->_req_data['txn_reg_status_change'],
                     $this->_req_data['txn_reg_status_change']['send_notifications'])
                 ) {
@@ -3079,7 +3079,7 @@ 
     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');
+        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']) {
@@ -3116,7 +3116,7 @@ 
             : $per_page;
         $_where       = array();
         if ( ! empty($this->_req_data['s'])) {
-            $sstr         = '%' . $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),
@@ -3192,9 +3192,9 @@ 
      *                                                     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 )
+    public function _registrations_report_base($method_name_for_getting_query_params)
     {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'page'        => 'espresso_batch',
@@ -3203,7 +3203,7 @@ 
                     'filters'     => urlencode(
                         serialize(
                             call_user_func(
-                                array( $this, $method_name_for_getting_query_params ),
+                                array($this, $method_name_for_getting_query_params),
                                 EEH_Array::is_set(
                                     $this->_req_data,
                                     'filters',
@@ -3223,8 +3223,8 @@ 
                 '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');
+            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();
             }
@@ -3245,8 +3245,8 @@ 
 
     public function _contact_list_export()
     {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export_attendees();
         }
@@ -3263,8 +3263,8 @@ 
                 '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');
+            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();
             }
@@ -3330,7 +3330,7 @@ 
             $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_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'] : '',
@@ -3463,7 +3463,7 @@ 
     {
         //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';
+        $template                         = REG_TEMPLATE_PATH.'attendee_contact_info_metabox_content.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3525,8 +3525,8 @@ 
                 )
             )
         );
-        $template                             =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+        $template =
+            REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3545,7 +3545,7 @@ 
         $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';
+            REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3560,7 +3560,7 @@ 
     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                  = 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);
         }

Indentation +3582 added lines, -3582 removed lines

@@ -30,2269 +30,2269 @@ 
 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;
-        $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
-            ? $this->_req_data['reg_status_change_form']['REG_ID']
-            : $reg_id;
-        $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,
-            ),
-            'approve_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('approve')
-            ),
-            'approve_and_notify_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('approve', true)
-            ),
-            '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,
-            ),
-            'decline_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('decline')
-            ),
-            'decline_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('decline', true)
-            ),
-            '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,
-            ),
-            'pending_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('pending')
-            ),
-            'pending_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('pending', true)
-            ),
-            '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,
-            ),
-            'no_approve_registrations'            => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('not_approve')
-            ),
-            'no_approve_and_notify_registrations' => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('not_approve', true)
-            ),
-            '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,
-            ),
-            'cancel_registrations'                => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('cancel')
-            ),
-            'cancel_and_notify_registrations'     => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('cancel', true)
-            ),
-            '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_attendees' => array(
-                'func' => '_trash_or_restore_attendees',
-                'args' => array(
-                    'trash' => 'true'
-                ),
-                'noheader' => true,
-                'capability' => 'ee_delete_contacts'
-            ),
-            '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_registrations'    => 'registration',
-            'decline_registrations'    => 'declined_registration',
-            'pending_registrations'    => 'pending_approval',
-            'no_approve_registrations' => 'not_approved_registration',
-            'cancel_registrations'     => '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_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
-                    'Approve and Notify Registrations',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
-                    'Decline and Notify Registrations',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['pending_registrations'] = esc_html__(
-            'Set Registrations to Pending Payment',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
-                    'Set Registrations to Pending Payment and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['no_approve_registrations'] = esc_html__(
-            'Set Registrations to Not Approved',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
-                    'Set Registrations to Not Approved and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
-                    '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,
-            $can_send
-        );
-
-        $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 ($this->_registration instanceof EE_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;
+		$reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
+			? $this->_req_data['reg_status_change_form']['REG_ID']
+			: $reg_id;
+		$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,
+			),
+			'approve_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('approve')
+			),
+			'approve_and_notify_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('approve', true)
+			),
+			'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,
+			),
+			'decline_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('decline')
+			),
+			'decline_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('decline', true)
+			),
+			'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,
+			),
+			'pending_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('pending')
+			),
+			'pending_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('pending', true)
+			),
+			'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,
+			),
+			'no_approve_registrations'            => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('not_approve')
+			),
+			'no_approve_and_notify_registrations' => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('not_approve', true)
+			),
+			'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,
+			),
+			'cancel_registrations'                => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('cancel')
+			),
+			'cancel_and_notify_registrations'     => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('cancel', true)
+			),
+			'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_attendees' => array(
+				'func' => '_trash_or_restore_attendees',
+				'args' => array(
+					'trash' => 'true'
+				),
+				'noheader' => true,
+				'capability' => 'ee_delete_contacts'
+			),
+			'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_registrations'    => 'registration',
+			'decline_registrations'    => 'declined_registration',
+			'pending_registrations'    => 'pending_approval',
+			'no_approve_registrations' => 'not_approved_registration',
+			'cancel_registrations'     => '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_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
+					'Approve and Notify Registrations',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
+					'Decline and Notify Registrations',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['pending_registrations'] = esc_html__(
+			'Set Registrations to Pending Payment',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
+					'Set Registrations to Pending Payment and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['no_approve_registrations'] = esc_html__(
+			'Set Registrations to Not Approved',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
+					'Set Registrations to Not Approved and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
+					'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,
+			$can_send
+		);
+
+		$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 ($this->_registration instanceof EE_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)
-        );
-        //because there are many registrations with the same date, define
-        //a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($order['REG_ID'])) {
-            $orderby_field['REG_ID'] = $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 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',
-                $this->_registration->ID()
-            )
-        ) {
-            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 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
-            && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
-        ) {
-            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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    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();
-        }
-        // sanitize $REG_IDs
-        $REG_IDs = array_map('absint', $REG_IDs);
-        // and remove empty entries
-        $REG_IDs = array_filter($REG_IDs);
-
-        $result = $this->_set_registration_status($REG_IDs, $status, $notify);
-
-        /**
-         * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
-         * Currently this value is used downstream by the _process_resend_registration method.
-         *
-         * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
-         * @param bool                     $status           The status registrations were changed to.
-         * @param bool                     $success          If the status was changed successfully for all registrations.
-         * @param Registrations_Admin_Page $admin_page_object
-         */
-        $this->_req_data['_REG_ID'] = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
-            $result['REG_ID'],
-            $status,
-            $result['success'],
-            $this
-        );
-
-        //notify?
-        if ($notify
-            && $result['success']
-            && ! empty($this->_req_data['_REG_ID'])
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $result;
-    }
-
-
-    /**
-     * 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 string $status
-     * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
-     *                        slug sent with setting the registration status.
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = 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;
-            $status_context = $notify
-                ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-                : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
-            //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,
-                        false,
-                        new Context(
-                            $status_context,
-                            esc_html__(
-                                'Manually triggered status change on a Registration Admin Page route.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-
-        //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;
-        }
-    }
-
-
-    /**
-     * Callback for bulk action routes.
-     * Note: although we could just register the singular route callbacks for each bulk action route as well, this
-     * method was chosen so there is one central place all the registration status bulk actions are going through.
-     * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
-     * when an action is happening on just a single registration).
-     * @param      $action
-     * @param bool $notify
-     */
-    protected function bulk_action_on_registrations($action, $notify = false) {
-        do_action(
-            'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
-            $this,
-            $action,
-            $notify
-        );
-        $method = $action . '_registration';
-        if (method_exists($this, $method)) {
-            $this->$method($notify);
-        }
-    }
-
-
-    /**
-     * 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 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)
+		);
+		//because there are many registrations with the same date, define
+		//a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($order['REG_ID'])) {
+			$orderby_field['REG_ID'] = $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 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',
+				$this->_registration->ID()
+			)
+		) {
+			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 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
+			&& EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
+		) {
+			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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	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();
+		}
+		// sanitize $REG_IDs
+		$REG_IDs = array_map('absint', $REG_IDs);
+		// and remove empty entries
+		$REG_IDs = array_filter($REG_IDs);
+
+		$result = $this->_set_registration_status($REG_IDs, $status, $notify);
+
+		/**
+		 * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
+		 * Currently this value is used downstream by the _process_resend_registration method.
+		 *
+		 * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
+		 * @param bool                     $status           The status registrations were changed to.
+		 * @param bool                     $success          If the status was changed successfully for all registrations.
+		 * @param Registrations_Admin_Page $admin_page_object
+		 */
+		$this->_req_data['_REG_ID'] = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
+			$result['REG_ID'],
+			$status,
+			$result['success'],
+			$this
+		);
+
+		//notify?
+		if ($notify
+			&& $result['success']
+			&& ! empty($this->_req_data['_REG_ID'])
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $result;
+	}
+
+
+	/**
+	 * 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 string $status
+	 * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
+	 *                        slug sent with setting the registration status.
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = 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;
+			$status_context = $notify
+				? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+				: Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
+			//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,
+						false,
+						new Context(
+							$status_context,
+							esc_html__(
+								'Manually triggered status change on a Registration Admin Page route.',
+								'event_espresso'
+							)
+						)
+					);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+
+		//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;
+		}
+	}
+
+
+	/**
+	 * Callback for bulk action routes.
+	 * Note: although we could just register the singular route callbacks for each bulk action route as well, this
+	 * method was chosen so there is one central place all the registration status bulk actions are going through.
+	 * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
+	 * when an action is happening on just a single registration).
+	 * @param      $action
+	 * @param bool $notify
+	 */
+	protected function bulk_action_on_registrations($action, $notify = false) {
+		do_action(
+			'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
+			$this,
+			$action,
+			$notify
+		);
+		$method = $action . '_registration';
+		if (method_exists($this, $method)) {
+			$this->$method($notify);
+		}
+	}
+
+
+	/**
+	 * 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 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>
@@ -2300,558 +2300,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
@@ -2864,792 +2864,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/libraries/messages/EE_Message_Factory.lib.php

Spacing +33 added lines, -33 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -53,10 +53,10 @@ 
 	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
 	 * @return \EE_Message_Factory instance
 	 */
-	public static function instance( EE_Message_Resource_Manager $Message_Resource_Manager ) {
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager) {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EE_Message_Factory ) {
-			self::$_instance = new EE_Message_Factory( $Message_Resource_Manager );
+		if ( ! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
 		}
 		return self::$_instance;
 	}
@@ -68,10 +68,10 @@ 
 	 * @param  array $props_n_values
 	 * @return EE_Message
 	 */
-	public static function create( $props_n_values = array() ) {
+	public static function create($props_n_values = array()) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_create( $props_n_values );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
 	}
 
 
@@ -82,10 +82,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_messenger_and_message_type( EE_Message $message ) {
+	public static function set_messenger_and_message_type(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_messenger_and_message_type( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
 	}
 
 
@@ -96,10 +96,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_messenger( EE_Message $message ) {
+	public static function set_messenger(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_messenger( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
 	}
 
 
@@ -110,10 +110,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	public static function set_message_type( EE_Message $message ) {
+	public static function set_message_type(EE_Message $message) {
 		/** @type EE_Message_Factory $Message_Factory */
-		$Message_Factory = EE_Registry::instance()->load_lib( 'Message_Factory' );
-		return $Message_Factory->_set_message_type( $message );
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
 	}
 
 
@@ -124,15 +124,15 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _create( $props_n_values = array() ) {
+	protected function _create($props_n_values = array()) {
 		$new_instance = false;
-		if ( ! empty( $props_n_values['MSG_ID'] ) ) {
-			$message = EE_Message::new_instance_from_db( $props_n_values );
+		if ( ! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
 		} else {
-			$message = EE_Message::new_instance( $props_n_values );
+			$message = EE_Message::new_instance($props_n_values);
 			$new_instance = true;
 		}
-		return $this->_set_messenger_and_message_type( $message, $new_instance );
+		return $this->_set_messenger_and_message_type($message, $new_instance);
 	}
 
 
@@ -144,9 +144,9 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_messenger_and_message_type( EE_Message $message, $new_instance = false ) {
-		$message = $this->_set_messenger( $message );
-		$message = $this->_set_message_type( $message, $new_instance );
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false) {
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
 		return $message;
 	}
 
@@ -158,10 +158,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_messenger( EE_Message $message ) {
-		$messenger = $this->_message_resource_manager->get_messenger( $message->messenger() );
-		if ( $messenger instanceof EE_messenger ) {
-			$message->set_messenger_object( $messenger );
+	protected function _set_messenger(EE_Message $message) {
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
 		}
 		return $message;
 	}
@@ -175,10 +175,10 @@ 
 	 * @return \EE_Message
 	 * @throws \EE_Error
 	 */
-	protected function _set_message_type( EE_Message $message, $new_instance = false ) {
-		$message_type = $this->_message_resource_manager->get_message_type( $message->message_type() );
-		if ( $message_type instanceof EE_message_type ) {
-			$message->set_message_type_object( $message_type, $new_instance );
+	protected function _set_message_type(EE_Message $message, $new_instance = false) {
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
 		}
 		return $message;
 	}

core/libraries/messages/EE_Messages_Queue.lib.php

Indentation +677 added lines, -677 removed lines

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

core/libraries/messages/EE_Messages_Processor.lib.php

Indentation +4 added lines, -4 removed lines

@@ -560,10 +560,10 @@
 
 		foreach ( $regs_to_send as $status_group ) {
 			foreach ( $status_group as $status_id => $registrations ) {
-			    $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-			    if (! $message_type) {
-			        continue;
-                }
+				$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
+				if (! $message_type) {
+					continue;
+				}
 				$messages_to_generate = array_merge(
 					$messages_to_generate,
 					$this->setup_mtgs_for_all_active_messengers(

Spacing +108 added lines, -108 removed lines

@@ -35,7 +35,7 @@ 
 	 *
 	 * @param EE_Message_Resource_Manager $message_resource_manager
 	 */
-	public function __construct( EE_Message_Resource_Manager $message_resource_manager ) {
+	public function __construct(EE_Message_Resource_Manager $message_resource_manager) {
 		$this->_message_resource_manager = $message_resource_manager;
 		$this->_init_queue_and_generator();
 	}
@@ -50,7 +50,7 @@ 
 	 * - $_generator = holds the messages generator
 	 */
 	protected function _init_queue_and_generator() {
-		$this->_generator = EE_Registry::factory( 'EE_Messages_Generator' );
+		$this->_generator = EE_Registry::factory('EE_Messages_Generator');
 		$this->_queue = $this->_generator->generation_queue();
 	}
 
@@ -75,31 +75,31 @@ 
 	 * @param EE_Messages_Queue $queue_to_process
 	 * @return bool  true for success false for error.
 	 */
-	public function process_immediately_from_queue( EE_Messages_Queue $queue_to_process ) {
+	public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process) {
 		$success = false;
 		$messages_to_send = array();
 		$messages_to_generate = array();
 		//loop through and setup the various messages from the queue so we know what is being processed
 		$queue_to_process->get_message_repository()->rewind();
-		foreach ( $queue_to_process->get_message_repository() as $message ) {
-			if ( $message->STS_ID() === EEM_Message::status_incomplete ) {
+		foreach ($queue_to_process->get_message_repository() as $message) {
+			if ($message->STS_ID() === EEM_Message::status_incomplete) {
 				$messages_to_generate[] = $message;
 				continue;
 			}
 
-			if ( in_array( $message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send() ) ) {
+			if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
 				$messages_to_send[] = $message;
 				continue;
 			}
 		}
 
 		//do generation/sends
-		if ( $messages_to_generate ) {
-			$success = $this->batch_generate_from_queue( $messages_to_generate, true );
+		if ($messages_to_generate) {
+			$success = $this->batch_generate_from_queue($messages_to_generate, true);
 		}
 
-		if ( $messages_to_send ) {
-			$sent = $this->batch_send_from_queue( $messages_to_send, true );
+		if ($messages_to_send) {
+			$sent = $this->batch_send_from_queue($messages_to_send, true);
 			//if there was messages to generate and it failed, then we override any success value for the sending process
 			//otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
 			//Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
@@ -119,13 +119,13 @@ 
 	 * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
 	 *                                   generated messages.
 	 */
-	public function batch_generate_from_queue( $messages = array(), $clear_queue = false ) {
-		if ( $this->_build_queue_for_generation( $messages, $clear_queue ) ) {
+	public function batch_generate_from_queue($messages = array(), $clear_queue = false) {
+		if ($this->_build_queue_for_generation($messages, $clear_queue)) {
 			$new_queue = $this->_generator->generate();
-			if ( $new_queue instanceof EE_Messages_Queue ) {
+			if ($new_queue instanceof EE_Messages_Queue) {
 				//unlock queue
 				$this->_queue->unlock_queue();
-				$new_queue->initiate_request_by_priority( 'send' );
+				$new_queue->initiate_request_by_priority('send');
 				return $new_queue;
 			}
 		}
@@ -146,24 +146,24 @@ 
 	 *
 	 * @return bool true means queue prepped, false means there was a lock so no generation please.
 	 */
-	protected function _build_queue_for_generation( $messages = array(), $clear_queue = false ) {
+	protected function _build_queue_for_generation($messages = array(), $clear_queue = false) {
 
-		if ( $clear_queue ) {
+		if ($clear_queue) {
 			$this->_init_queue_and_generator();
 		}
 
-		if ( $messages ) {
+		if ($messages) {
 			//if generation is locked then get out now because that means processing is already happening.
-			if ( $this->_queue->is_locked() ) {
+			if ($this->_queue->is_locked()) {
 				return false;
 			}
 
 			$this->_queue->lock_queue();
-			$messages = is_array( $messages ) ? $messages : array( $messages );
-			foreach ( $messages as $message ) {
-				if ( $message instanceof EE_Message ) {
+			$messages = is_array($messages) ? $messages : array($messages);
+			foreach ($messages as $message) {
+				if ($message instanceof EE_Message) {
 					$data = $message->all_extra_meta_array();
-					$this->_queue->add( $message, $data );
+					$this->_queue->add($message, $data);
 				}
 			}
 			return true;
@@ -181,22 +181,22 @@ 
 	 *
 	 * @return bool true means queue prepped, false means there was a lock so no queue prepped.
 	 */
-	protected function _build_queue_for_sending( $messages, $clear_queue = false ) {
+	protected function _build_queue_for_sending($messages, $clear_queue = false) {
 		//if sending is locked then get out now because that means processing is already happening.
-		if ( $this->_queue->is_locked( EE_Messages_Queue::action_sending ) ) {
+		if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
 			return false;
 		}
 
-		$this->_queue->lock_queue( EE_Messages_Queue::action_sending );
+		$this->_queue->lock_queue(EE_Messages_Queue::action_sending);
 
-		if ( $clear_queue ) {
+		if ($clear_queue) {
 			$this->_init_queue_and_generator();
 		}
 
-		$messages = is_array( $messages ) ? $messages : array( $messages );
+		$messages = is_array($messages) ? $messages : array($messages);
 
-		foreach ( $messages as $message ) {
-			$this->_queue->add( $message );
+		foreach ($messages as $message) {
+			$this->_queue->add($message);
 		}
 		return true;
 	}
@@ -212,11 +212,11 @@ 
 	 *
 	 * @return EE_Messages_Queue
 	 */
-	public function batch_send_from_queue( $messages = array(), $clear_queue = false ) {
+	public function batch_send_from_queue($messages = array(), $clear_queue = false) {
 
-		if ( $messages && $this->_build_queue_for_sending( $messages, $clear_queue ) ) {
+		if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
 			$this->_queue->execute();
-			$this->_queue->unlock_queue( EE_Messages_Queue::action_sending );
+			$this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
 		} else {
 			//get messages to send and execute.
 			$this->_queue->get_to_send_batch_and_send();
@@ -239,10 +239,10 @@ 
 	 * @param EE_Message_To_Generate[] $messages_to_generate
 	 * @return EE_Messages_Queue
 	 */
-	public function generate_and_return(  $messages_to_generate ) {
+	public function generate_and_return($messages_to_generate) {
 		$this->_init_queue_and_generator();
-		$this->_queue_for_generation_loop( $messages_to_generate );
-		return $this->_generator->generate( false );
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(false);
 	}
 
 
@@ -253,8 +253,8 @@ 
 	 * @param  bool     $persist    Indicate whether to instruct the generator to persist the generated queue (true) or not (false).
 	 * @return EE_Messages_Queue
 	 */
-	public function generate_queue( $persist = true ) {
-		return $this->_generator->generate( $persist );
+	public function generate_queue($persist = true) {
+		return $this->_generator->generate($persist);
 	}
 
 
@@ -267,9 +267,9 @@ 
 	 * @param bool                   $test_send             Whether this item is for a test send or not.
 	 * @return  EE_Messages_Queue
 	 */
-	public function queue_for_generation( EE_Message_To_Generate $message_to_generate, $test_send = false ) {
-		if ( $message_to_generate->valid() ) {
-			$this->_generator->create_and_add_message_to_queue( $message_to_generate, $test_send );
+	public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false) {
+		if ($message_to_generate->valid()) {
+			$this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send);
 		}
 	}
 
@@ -285,9 +285,9 @@ 
 	 *
 	 * @param EE_Message_To_Generate[] $messages_to_generate
 	 */
-	public function batch_queue_for_generation_and_persist( $messages_to_generate ) {
+	public function batch_queue_for_generation_and_persist($messages_to_generate) {
 		$this->_init_queue_and_generator();
-		$this->_queue_for_generation_loop( $messages_to_generate );
+		$this->_queue_for_generation_loop($messages_to_generate);
 		$this->_queue->save();
 	}
 
@@ -303,9 +303,9 @@ 
 	 *
 	 * @param EE_Message_To_Generate[]  $messages_to_generate
 	 */
-	public function batch_queue_for_generation_no_persist( $messages_to_generate ) {
+	public function batch_queue_for_generation_no_persist($messages_to_generate) {
 		$this->_init_queue_and_generator();
-		$this->_queue_for_generation_loop( $messages_to_generate );
+		$this->_queue_for_generation_loop($messages_to_generate);
 	}
 
 
@@ -317,15 +317,15 @@ 
 	 *
 	 * @param EE_Message_To_Generate[] $messages_to_generate
 	 */
-	protected function _queue_for_generation_loop( $messages_to_generate ) {
+	protected function _queue_for_generation_loop($messages_to_generate) {
 		//make sure is in an array.
-		if ( ! is_array( $messages_to_generate ) ) {
-			$messages_to_generate = array( $messages_to_generate );
+		if ( ! is_array($messages_to_generate)) {
+			$messages_to_generate = array($messages_to_generate);
 		}
 
-		foreach ( $messages_to_generate as $message_to_generate ) {
-			if ( $message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid() ) {
-				$this->queue_for_generation( $message_to_generate );
+		foreach ($messages_to_generate as $message_to_generate) {
+			if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
+				$this->queue_for_generation($message_to_generate);
 			}
 		}
 	}
@@ -340,10 +340,10 @@ 
 	 * @param  EE_Message_To_Generate[]
 	 * @return EE_Messages_Queue
 	 */
-	public function generate_and_queue_for_sending( $messages_to_generate ) {
+	public function generate_and_queue_for_sending($messages_to_generate) {
 		$this->_init_queue_and_generator();
-		$this->_queue_for_generation_loop( $messages_to_generate );
-		return $this->_generator->generate( true );
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(true);
 	}
 
 
@@ -357,10 +357,10 @@ 
 	 * @param   bool                   $test_send                Whether this is a test send or not.
 	 * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
 	 */
-	public function generate_for_preview( EE_Message_To_Generate $message_to_generate, $test_send = false ) {
-		if ( ! $message_to_generate->valid() ) {
+	public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false) {
+		if ( ! $message_to_generate->valid()) {
 			EE_Error::add_error(
-				__( 'Unable to generate preview because of invalid data', 'event_espresso' ),
+				__('Unable to generate preview because of invalid data', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -368,14 +368,14 @@ 
 			return false;
 		}
 		//just make sure preview is set on the $message_to_generate (in case client forgot)
-		$message_to_generate->set_preview( true );
+		$message_to_generate->set_preview(true);
 		$this->_init_queue_and_generator();
-		$this->queue_for_generation( $message_to_generate, $test_send );
-		$generated_queue = $this->_generator->generate( false );
-		if ( $generated_queue->execute( false ) ) {
+		$this->queue_for_generation($message_to_generate, $test_send);
+		$generated_queue = $this->_generator->generate(false);
+		if ($generated_queue->execute(false)) {
 			//the first queue item should be the preview
 			$generated_queue->get_message_repository()->rewind();
-			if ( ! $generated_queue->get_message_repository()->valid() ) {
+			if ( ! $generated_queue->get_message_repository()->valid()) {
 				return $generated_queue;
 			}
 			return $generated_queue;
@@ -392,15 +392,15 @@ 
 	 * @param EE_Message_To_Generate $message_to_generate
 	 * @return bool true or false for success.
 	 */
-	public function queue_for_sending( EE_Message_To_Generate $message_to_generate ) {
-		if ( ! $message_to_generate->valid() ) {
+	public function queue_for_sending(EE_Message_To_Generate $message_to_generate) {
+		if ( ! $message_to_generate->valid()) {
 			return false;
 		}
 		$this->_init_queue_and_generator();
 		$message = $message_to_generate->get_EE_Message();
-		$this->_queue->add( $message );
-		if ( $message->send_now() ) {
-			$this->_queue->execute( false );
+		$this->_queue->add($message);
+		if ($message->send_now()) {
+			$this->_queue->execute(false);
 		} else {
 			$this->_queue->save();
 		}
@@ -413,12 +413,12 @@ 
 	 * @param EE_Message_To_Generate $message_to_generate
 	 * @return EE_Messages_Queue | null
 	 */
-	public function generate_and_send_now( EE_Message_To_Generate $message_to_generate ) {
-		if ( ! $message_to_generate->valid() ) {
+	public function generate_and_send_now(EE_Message_To_Generate $message_to_generate) {
+		if ( ! $message_to_generate->valid()) {
 			return null;
 		}
 		// is there supposed to be a sending messenger for this message?
-		if ( $message_to_generate instanceof EEI_Has_Sending_Messenger ) {
+		if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
 			// make sure it's valid, but if it's not,
 			// then set the value of $sending_messenger to an EE_Error object
 			// so that downstream code can easily see that things went wrong.
@@ -434,14 +434,14 @@ 
 			$sending_messenger = null;
 		}
 
-		if ( $message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle ) {
+		if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
 			$this->_init_queue_and_generator();
-			$this->_queue->add( $message_to_generate->get_EE_Message() );
-			$this->_queue->execute( false, $sending_messenger );
+			$this->_queue->add($message_to_generate->get_EE_Message());
+			$this->_queue->execute(false, $sending_messenger);
 			return $this->_queue;
-		} elseif ( $message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete ) {
-			$generated_queue = $this->generate_and_return( array( $message_to_generate ) );
-			$generated_queue->execute( false, $sending_messenger );
+		} elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
+			$generated_queue = $this->generate_and_return(array($message_to_generate));
+			$generated_queue->execute(false, $sending_messenger);
 			return $generated_queue;
 		}
 		return null;
@@ -458,13 +458,13 @@ 
 	 * @param mixed  $data   The data being used for generation.
 	 * @param bool   $persist   Whether to persist the queued messages to the db or not.
 	 */
-	public function generate_for_all_active_messengers( $message_type, $data, $persist = true ) {
-		$messages_to_generate = $this->setup_mtgs_for_all_active_messengers( $message_type, $data );
-		if ( $persist ) {
-			$this->batch_queue_for_generation_and_persist( $messages_to_generate );
+	public function generate_for_all_active_messengers($message_type, $data, $persist = true) {
+		$messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
+		if ($persist) {
+			$this->batch_queue_for_generation_and_persist($messages_to_generate);
 			$this->_queue->initiate_request_by_priority();
 		} else {
-			$this->batch_queue_for_generation_no_persist( $messages_to_generate );
+			$this->batch_queue_for_generation_no_persist($messages_to_generate);
 		}
 	}
 
@@ -479,11 +479,11 @@ 
 	 *
 	 * @return EE_Message_To_Generate[]
 	 */
-	public function setup_mtgs_for_all_active_messengers( $message_type, $data ) {
+	public function setup_mtgs_for_all_active_messengers($message_type, $data) {
 		$messages_to_generate = array();
-		foreach ( $this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object  ) {
-			$message_to_generate = new EE_Message_To_Generate( $messenger_slug, $message_type, $data );
-			if ( $message_to_generate->valid() ) {
+		foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
+			$message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
+			if ($message_to_generate->valid()) {
 				$messages_to_generate[] = $message_to_generate;
 			}
 		}
@@ -498,29 +498,29 @@ 
 	 * and send.
 	 * @param array $message_ids
 	 */
-	public function setup_messages_from_ids_and_send( $message_ids ) {
+	public function setup_messages_from_ids_and_send($message_ids) {
 		$this->_init_queue_and_generator();
-		$messages = EEM_Message::instance()->get_all( array(
+		$messages = EEM_Message::instance()->get_all(array(
 			array(
-				'MSG_ID' => array( 'IN', $message_ids ),
+				'MSG_ID' => array('IN', $message_ids),
 				'STS_ID' => array(
 					'IN',
 					array_merge(
 						EEM_Message::instance()->stati_indicating_sent(),
-						array( EEM_Message::status_retry )
+						array(EEM_Message::status_retry)
 					),
 				),
 			),
 		));
 		//set the Messages to resend.
-		foreach ( $messages as $message ) {
-			if ( $message instanceof EE_Message ) {
-				$message->set_STS_ID( EEM_Message::status_resend );
-				$this->_queue->add( $message );
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$message->set_STS_ID(EEM_Message::status_resend);
+				$this->_queue->add($message);
 			}
 		}
 
-		$this->_queue->initiate_request_by_priority( 'send' );
+		$this->_queue->initiate_request_by_priority('send');
 	}
 
 
@@ -534,23 +534,23 @@ 
 	 *
 	 * @return EE_Message_To_Generate[]
 	 */
-	public function setup_messages_to_generate_from_registration_ids_in_request( $registration_ids_key = '_REG_ID' ) {
-		EE_Registry::instance()->load_core( 'Request_Handler' );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
+	public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID') {
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_helper('MSG_Template');
 		$regs_to_send = array();
-		$regIDs = EE_Registry::instance()->REQ->get( $registration_ids_key );
-		if ( empty( $regIDs ) ) {
-			EE_Error::add_error( __('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+		$regIDs = EE_Registry::instance()->REQ->get($registration_ids_key);
+		if (empty($regIDs)) {
+			EE_Error::add_error(__('Something went wrong because we\'re missing the registration ID', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 
 		//make sure is an array
-		$regIDs = is_array( $regIDs ) ? $regIDs : array( $regIDs );
+		$regIDs = is_array($regIDs) ? $regIDs : array($regIDs);
 
-		foreach( $regIDs as $regID ) {
-			$reg = EEM_Registration::instance()->get_one_by_ID( $regID );
-			if ( ! $reg instanceof EE_Registration ) {
-				EE_Error::add_error( sprintf( __('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID ) );
+		foreach ($regIDs as $regID) {
+			$reg = EEM_Registration::instance()->get_one_by_ID($regID);
+			if ( ! $reg instanceof EE_Registration) {
+				EE_Error::add_error(sprintf(__('Unable to retrieve a registration object for the given reg id (%s)', 'event_espresso'), $regID));
 				return false;
 			}
 			$regs_to_send[$reg->transaction_ID()][$reg->status_ID()][] = $reg;
@@ -558,17 +558,17 @@ 
 
 		$messages_to_generate = array();
 
-		foreach ( $regs_to_send as $status_group ) {
-			foreach ( $status_group as $status_id => $registrations ) {
+		foreach ($regs_to_send as $status_group) {
+			foreach ($status_group as $status_id => $registrations) {
 			    $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-			    if (! $message_type) {
+			    if ( ! $message_type) {
 			        continue;
                 }
 				$messages_to_generate = array_merge(
 					$messages_to_generate,
 					$this->setup_mtgs_for_all_active_messengers(
 						$message_type,
-						array( $registrations, $status_id )
+						array($registrations, $status_id)
 					)
 				);
 			}

core/domain/Domain.php

Indentation +8 added lines, -8 removed lines

@@ -15,13 +15,13 @@
  */
 class Domain extends DomainBase
 {
-    /**
-     * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
-     * Page ui.
-     */
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
-        = 'manual_registration_status_change_from_registration_admin';
+	/**
+	 * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
+	 * Page ui.
+	 */
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
+		= 'manual_registration_status_change_from_registration_admin';
 
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-        = 'manual_registration_status_change_from_registration_admin_and_notify';
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+		= 'manual_registration_status_change_from_registration_admin_and_notify';
 }

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +636 added lines, -636 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,641 +34,641 @@ 
 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) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-
-    /**
-     * @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()->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) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+
+	/**
+	 * @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()->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 +18 added lines, -18 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) {
@@ -289,7 +289,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;
@@ -315,7 +315,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;
@@ -341,7 +341,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -366,7 +366,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)) {
@@ -397,7 +397,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;
@@ -521,11 +521,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,
             )
         );
@@ -543,11 +543,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
         );
@@ -565,11 +565,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'),
             )
         );
@@ -590,7 +590,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,
@@ -649,11 +649,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(