eventespresso / event-espresso-core

core/db_models/EEM_Event.model.php

Indentation +928 added lines, -928 removed lines

@@ -13,932 +13,932 @@
  */
 class EEM_Event extends EEM_CPT_Base
 {
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($timezone = null)
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            array(
-                EEM_Event::cancelled => array(
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ),
-                EEM_Event::postponed => array(
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ),
-                EEM_Event::sold_out  => array(
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ),
-            )
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status)
-            ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables = array(
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        );
-        $this->_fields = array(
-            'Event_CPT'  => array(
-                'EVT_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__('Post ID for Event', 'event_espresso')
-                ),
-                'EVT_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_slug'       => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__('Event Slug', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_short_desc' => new EE_Simple_HTML_Field(
-                    'post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'EVT_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field(
-                    'post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false,
-                    'draft',
-                    $this->_custom_stati
-                ),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'EVT_desc',
-                        'EVT_short_desc',
-                        'EVT_display_desc',
-                        'EVT_display_ticket_selector',
-                        'EVT_visible_on',
-                        'EVT_additional_limit',
-                        'EVT_default_registration_status',
-                        'EVT_member_only',
-                        'EVT_phone',
-                        'EVT_allow_overflow',
-                        'EVT_timezone_string',
-                        'EVT_external_URL',
-                        'EVT_donations'
-                    )
-                )
-            ),
-            'Event_Meta' => array(
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field(
-                    'EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
-                    false
-                ),
-                'VNU_ID' => new EE_Foreign_Key_Int_Field(
-                    'VNU_ID',
-                    __('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                'EVT_display_desc'                => new EE_Boolean_Field(
-                    'EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field(
-                    'EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_visible_on'                  => new EE_Datetime_Field(
-                    'EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    false,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                    false,
-                    EEM_Event::$_default_reg_status,
-                    EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field(
-                    'EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_phone'                       => new EE_Plain_Text_Field(
-                    'EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_allow_overflow'              => new EE_Boolean_Field(
-                    'EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field(
-                    'EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_external_URL'                => new EE_Plain_Text_Field(
-                    'EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
-                    true
-                ),
-                'EVT_donations'                   => new EE_Boolean_Field(
-                    'EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
-                    true,
-                    null,
-                    'Form_Section',
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Form_Section'           => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Venue'                  => new EE_Belongs_To_Relation(),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @param string $default_reg_status
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                false,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                array('QSG_deleted' => false),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array('EVT_ID' => $EVT_ID),
-            )
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $query_params = [
-            [
-                'EVT_ID' => $EVT_ID,
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true
-            ]
-        ];
-        if ($for_primary_attendee) {
-            $query_params[0]['EQG_primary'] = true;
-        } else {
-            $query_params[0]['EQG_additional'] = true;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
-    {
-        if (! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID'      => $EVT_ID,
-                    'Event_Question_Group.'
-                        . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                            $registration->is_primary_registrant()
-                        ) => true
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            array(
-                array(
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ),
-                'order_by' => 'QST_order',
-            )
-        );
-    }
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            array(
-                array(
-                    'Question.QST_ID' => array('IN', $QST_IDs),
-                    'QSO_deleted'     => false,
-                ),
-                'order_by' => 'QSO_ID',
-            )
-        );
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        // we need to pull events with a status of publish and sold_out
-        $event_status = array('publish', EEM_Event::sold_out);
-        // check if the user can read private events and if so add the 'private status to the were params'
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
-            $event_status[] = 'private';
-        }
-        $where_params['status'] = array('IN', $event_status);
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = array(
-            'Datetime.DTT_EVT_end' => array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ),
-        );
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = array(
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
-            'EVT_ID'               => array('NOT IN', $event_ids),
-        );
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param  array   $query_params An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param  boolean $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = array('!=', 'publish');
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @param EE_Registration $registration    (so existing answers for registration are included)
-     * @param int             $EVT_ID          so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @return    array
-     * @throws ReflectionException
-     * @throws EE_Error*@deprecated as of 4.8.32.rc.001. Instead consider using
-     *                                         EE_Registration_Custom_Questions_Form located in
-     *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(esc_html__(
-                'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                'event_espresso'
-            ));
-        }
-        $questions = array();
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer = EEM_Answer::instance()->get_one(array(
-                        array(
-                            'QST_ID' => $qst->ID(),
-                            'REG_ID' => $registration->ID(),
-                        ),
-                    ));
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
-                    $qst_name = $qstn_id = $qst->ID();
-                    $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($qst->display_text());
-                    $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($timezone = null)
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			array(
+				EEM_Event::cancelled => array(
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				),
+				EEM_Event::postponed => array(
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				),
+				EEM_Event::sold_out  => array(
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				),
+			)
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status)
+			? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables = array(
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		);
+		$this->_fields = array(
+			'Event_CPT'  => array(
+				'EVT_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__('Post ID for Event', 'event_espresso')
+				),
+				'EVT_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__('Event Name', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_slug'       => new EE_Slug_Field(
+					'post_name',
+					esc_html__('Event Slug', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_short_desc' => new EE_Simple_HTML_Field(
+					'post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0
+				),
+				'EVT_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field(
+					'post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false,
+					'draft',
+					$this->_custom_stati
+				),
+				'password' => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'EVT_desc',
+						'EVT_short_desc',
+						'EVT_display_desc',
+						'EVT_display_ticket_selector',
+						'EVT_visible_on',
+						'EVT_additional_limit',
+						'EVT_default_registration_status',
+						'EVT_member_only',
+						'EVT_phone',
+						'EVT_allow_overflow',
+						'EVT_timezone_string',
+						'EVT_external_URL',
+						'EVT_donations'
+					)
+				)
+			),
+			'Event_Meta' => array(
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field(
+					'EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'),
+					false
+				),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
+					'EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
+					false
+				),
+				'VNU_ID' => new EE_Foreign_Key_Int_Field(
+					'VNU_ID',
+					__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'EVT_display_desc'                => new EE_Boolean_Field(
+					'EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field(
+					'EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_visible_on'                  => new EE_Datetime_Field(
+					'EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					false,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'),
+					false,
+					EEM_Event::$_default_reg_status,
+					EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field(
+					'EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_phone'                       => new EE_Plain_Text_Field(
+					'EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_allow_overflow'              => new EE_Boolean_Field(
+					'EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field(
+					'EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_external_URL'                => new EE_Plain_Text_Field(
+					'EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
+					true
+				),
+				'EVT_donations'                   => new EE_Boolean_Field(
+					'EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'),
+					false,
+					false
+				),
+				'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
+					true,
+					null,
+					'Form_Section',
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Form_Section'           => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Venue'                  => new EE_Belongs_To_Relation(),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @param string $default_reg_status
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				false,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				array('QSG_deleted' => false),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array('EVT_ID' => $EVT_ID),
+			)
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$query_params = [
+			[
+				'EVT_ID' => $EVT_ID,
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true
+			]
+		];
+		if ($for_primary_attendee) {
+			$query_params[0]['EQG_primary'] = true;
+		} else {
+			$query_params[0]['EQG_additional'] = true;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
+	{
+		if (! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID'      => $EVT_ID,
+					'Event_Question_Group.'
+						. EEM_Event_Question_Group::instance()->fieldNameForContext(
+							$registration->is_primary_registrant()
+						) => true
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			array(
+				array(
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				),
+				'order_by' => 'QST_order',
+			)
+		);
+	}
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			array(
+				array(
+					'Question.QST_ID' => array('IN', $QST_IDs),
+					'QSO_deleted'     => false,
+				),
+				'order_by' => 'QSO_ID',
+			)
+		);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		// we need to pull events with a status of publish and sold_out
+		$event_status = array('publish', EEM_Event::sold_out);
+		// check if the user can read private events and if so add the 'private status to the were params'
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
+			$event_status[] = 'private';
+		}
+		$where_params['status'] = array('IN', $event_status);
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = array(
+			'Datetime.DTT_EVT_end' => array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			),
+		);
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = array(
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
+			'EVT_ID'               => array('NOT IN', $event_ids),
+		);
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param  array   $query_params An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = array('!=', 'publish');
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @param EE_Registration $registration    (so existing answers for registration are included)
+	 * @param int             $EVT_ID          so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @return    array
+	 * @throws ReflectionException
+	 * @throws EE_Error*@deprecated as of 4.8.32.rc.001. Instead consider using
+	 *                                         EE_Registration_Custom_Questions_Form located in
+	 *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(esc_html__(
+				'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+				'event_espresso'
+			));
+		}
+		$questions = array();
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts = $qg->questions();
+				$questions[ $qg->ID() ] = $qg->model_field_array();
+				$questions[ $qg->ID() ]['QSG_questions'] = array();
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer = EEM_Answer::instance()->get_one(array(
+						array(
+							'QST_ID' => $qst->ID(),
+							'REG_ID' => $registration->ID(),
+						),
+					));
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
+					$qst_name = $qstn_id = $qst->ID();
+					$ans_id = $answer->ID();
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($qst->display_text());
+					$input_class = '';
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $qst_name;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

core/admin/EE_Admin_Page.core.php

Indentation +4197 added lines, -4197 removed lines

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

Spacing +180 added lines, -180 removed lines

@@ -629,7 +629,7 @@ 
         $ee_menu_slugs = (array) $ee_menu_slugs;
         if (
             ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+            && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))
         ) {
             return;
         }
@@ -649,7 +649,7 @@ 
             : $req_action;
 
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -679,33 +679,33 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
+            'FHEE__'.$this->class_name.'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
+            'FHEE__'.$this->class_name.'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         if ($this->base_class_name !== '') {
             $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_routes',
                 $this->_page_routes,
                 $this
             );
             $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_config',
                 $this->_page_config,
                 $this
             );
         }
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -718,8 +718,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init'], 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -738,12 +738,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -760,7 +760,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -802,13 +802,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices'], 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -929,7 +929,7 @@ 
     protected function _verify_routes()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         $this->_route = false;
@@ -941,7 +941,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
                               'event_espresso'
@@ -950,8 +950,8 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = $this->_page_config[$this->_req_action] ?? [];
         } else {
             // user error msg
             $error_msg = sprintf(
@@ -962,7 +962,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . sprintf(
                               esc_html__(
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -973,7 +973,7 @@ 
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
+        if ( ! array_key_exists('default', $this->_page_routes)) {
             // user error msg
             $error_msg = sprintf(
                 esc_html__(
@@ -983,7 +983,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
                               'event_espresso'
@@ -1025,7 +1025,7 @@ 
             $this->_admin_page_title
         );
         // developer error msg
-        $error_msg .= '||' . $error_msg
+        $error_msg .= '||'.$error_msg
                       . sprintf(
                           esc_html__(
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -1053,7 +1053,7 @@ 
     protected function _verify_nonce($nonce, $nonce_ref)
     {
         // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
             // these are not the droids you are looking for !!!
             $msg = sprintf(
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -1070,7 +1070,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1094,7 +1094,7 @@ 
      */
     protected function _route_admin_request()
     {
-        if (! $this->_is_UI_request) {
+        if ( ! $this->_is_UI_request) {
             $this->_verify_routes();
         }
         $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
@@ -1114,7 +1114,7 @@ 
         $error_msg = '';
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // strip _wp_http_referer from the server REQUEST_URI
@@ -1128,7 +1128,7 @@ 
         );
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func)) {
                 [$class, $method] = $func;
             } elseif (strpos($func, '::') !== false) {
@@ -1137,7 +1137,7 @@ 
                 $class  = $this;
                 $method = $func;
             }
-            if (! (is_object($class) && $class === $this)) {
+            if ( ! (is_object($class) && $class === $this)) {
                 // send along this admin page object for access by addons.
                 $args['admin_page_object'] = $this;
             }
@@ -1178,7 +1178,7 @@ 
                     $method
                 );
             }
-            if (! empty($error_msg)) {
+            if ( ! empty($error_msg)) {
                 throw new EE_Error($error_msg);
             }
         }
@@ -1264,7 +1264,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1304,12 +1304,12 @@ 
      */
     protected function _add_help_tabs()
     {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
+        if (isset($this->_page_config[$this->_req_action])) {
+            $config = $this->_page_config[$this->_req_action];
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
             if (is_array($config) && isset($config['help_sidebar'])) {
                 // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
+                if ( ! method_exists($this, $config['help_sidebar'])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1322,18 +1322,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.$this->class_name.'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $this->_current_screen->set_help_sidebar($content);
             }
-            if (! isset($config['help_tabs'])) {
+            if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 // we're here so there ARE help tabs!
                 // make sure we've got what we need
-                if (! isset($cfg['title'])) {
+                if ( ! isset($cfg['title'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1341,7 +1341,7 @@ 
                         )
                     );
                 }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
@@ -1350,11 +1350,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = ! empty($cfg['content']) ? $cfg['content'] : null;
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1362,7 +1362,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1410,7 +1410,7 @@ 
                     return;
                 }
                 // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+                $id  = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
                 $_ht = [
                     'id'       => $id,
                     'title'    => $cfg['title'],
@@ -1436,8 +1436,8 @@ 
             $qtips = (array) $this->_route_config['qtips'];
             // load qtip loader
             $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+                $this->_get_dir().'/qtips/',
+                EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
             ];
             EEH_Qtip_Loader::instance()->register($qtips, $path);
         }
@@ -1459,7 +1459,7 @@ 
         $i = 0;
         $only_tab = count($this->_page_config) < 2;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1468,27 +1468,27 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+            $css_class = isset($config['css_class']) ? $config['css_class'].' ' : '';
             $css_class .= $only_tab ? ' ee-only-tab' : '';
 
-            $this->_nav_tabs[ $slug ] = [
+            $this->_nav_tabs[$slug] = [
                 'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
                     ['action' => $slug],
                     $this->_admin_base_url
                 ),
                 'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.' nav-tab-active' : $css_class,
                 'order'     => $config['nav']['order'] ?? $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1504,11 +1504,11 @@ 
     {
         $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
         $icon = $nav_tab['icon'] ?? null;
-        $icon = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+        $icon = $icon ? '<span class="dashicons '.$icon.'"></span>' : '';
         return '
             <span class="ee-admin-screen-tab__label">
-                ' . $icon . '
-                <span class="ee-nav-label__text">' . $label . '</span>
+                ' . $icon.'
+                <span class="ee-nav-label__text">' . $label.'</span>
             </span>';
     }
 
@@ -1525,10 +1525,10 @@ 
             foreach ($this->_route_config['labels'] as $label => $text) {
                 if (is_array($text)) {
                     foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
+                        $this->_labels[$label][$sublabel] = $subtext;
                     }
                 } else {
-                    $this->_labels[ $label ] = $text;
+                    $this->_labels[$label] = $text;
                 }
             }
         }
@@ -1550,10 +1550,10 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
-                                      && is_array($this->_page_routes[ $route_to_check ])
-                        && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability']
+        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check])
+                                      && is_array($this->_page_routes[$route_to_check])
+                        && ! empty($this->_page_routes[$route_to_check]['capability'])
+            ? $this->_page_routes[$route_to_check]['capability']
             : null;
 
         if (empty($capability) && empty($route_to_check)) {
@@ -1607,14 +1607,14 @@ 
         string $priority = 'default',
         ?array $callback_args = null
     ) {
-        if (! is_callable($callback)) {
+        if ( ! is_callable($callback)) {
             return;
         }
 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_{$box_id}",
-            function ($classes) {
+            function($classes) {
                 array_push($classes, 'ee-admin-container');
                 return $classes;
             }
@@ -1708,7 +1708,7 @@ 
         ';
 
         // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+        echo '<span id="current_timezone" class="hidden">'.esc_html(EEH_DTT_Helper::get_timezone()).'</span>';
     }
 
 
@@ -1742,7 +1742,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is setup properly
-            if (! isset($help['title'], $help['content'])) {
+            if ( ! isset($help['title'], $help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1756,8 +1756,8 @@ 
                 'help_popup_title'   => $help['title'],
                 'help_popup_content' => $help['content'],
             ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+            $content .= EEH_Template::display_template(
+                EE_ADMIN_TEMPLATE.'admin_help_popup.template.php',
                 $template_args,
                 true
             );
@@ -1779,15 +1779,15 @@ 
     private function _get_help_content()
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = $this->{$method_name}();
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1819,8 +1819,8 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
@@ -1915,7 +1915,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -2006,12 +2006,12 @@ 
     protected function _set_list_table()
     {
         // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
+        if ( ! isset($this->_route_config['list_table'])) {
             return;
         } //not a list_table view so get out.
         // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -2031,10 +2031,10 @@ 
         }
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
         $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
             $this->_views
         );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -2069,7 +2069,7 @@ 
     protected function _set_list_table_object()
     {
         if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
+            if ( ! class_exists($this->_route_config['list_table'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2107,17 +2107,17 @@ 
         foreach ($this->_views as $key => $view) {
             $query_args = [];
             // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+            $this->_views[$key]['class']               = $this->_view === $view['slug'] ? 'current' : '';
             $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
             $query_args['status']                        = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
+            if (isset($extra_query_args[$view['slug']])) {
+                foreach ($extra_query_args[$view['slug']] as $extra_query_arg) {
                     $query_args[] = $extra_query_arg;
                 }
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2148,14 +2148,14 @@ 
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
         foreach ($values as $value) {
             if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+                $selected = $value === $per_page ? ' selected="'.$per_page.'"' : '';
                 $entries_per_page_dropdown .= '
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
             }
         }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+        $selected = $max_entries === $per_page ? ' selected="'.$per_page.'"' : '';
         $entries_per_page_dropdown .= '
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
         $entries_per_page_dropdown .= '
 					</select>
 					entries
@@ -2179,7 +2179,7 @@ 
             empty($this->_search_btn_label) ? $this->page_label
                 : $this->_search_btn_label
         );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
     }
 
 
@@ -2267,7 +2267,7 @@ 
             $total_columns                                       = ! empty($screen_columns)
                 ? $screen_columns
                 : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
             $this->_template_args['current_page']                = $this->_wp_page_slug;
             $this->_template_args['screen']                      = $this->_current_screen;
             $this->_column_template_path                         = EE_ADMIN_TEMPLATE
@@ -2313,7 +2313,7 @@ 
      */
     protected function _espresso_ratings_request()
     {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
             return;
         }
         $ratings_box_title = apply_filters(
@@ -2340,28 +2340,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display($rss_id, $url)
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+            echo wp_kses($pre.$output.$post, AllowedTags::getWithFormTags());
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo wp_kses($pre.$loading.$post, AllowedTags::getWithFormTags());
             return false;
         }
         ob_start();
@@ -2428,19 +2428,19 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
 
     private function _publish_post_box()
     {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+        $meta_box_ref = 'espresso_'.$this->page_slug.'_editor_overview';
         // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
         // then we'll use that for the metabox label.
         // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if (! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
+        if ( ! empty($this->_labels['publishbox'])) {
+            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action]
                 : $this->_labels['publishbox'];
         } else {
             $box_label = esc_html__('Publish', 'event_espresso');
@@ -2469,7 +2469,7 @@ 
             ? $this->_template_args['publish_box_extra_content']
             : '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2557,18 +2557,18 @@ 
             );
         }
         $this->_template_args['publish_delete_link'] = $delete_link;
-        if (! empty($name) && ! empty($id)) {
-            $hidden_field_arr[ $name ] = [
+        if ( ! empty($name) && ! empty($id)) {
+            $hidden_field_arr[$name] = [
                 'type'  => 'hidden',
                 'value' => $id,
             ];
-            $hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
         } else {
             $hf = '';
         }
         // add hidden field
         $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
-            ? $hf[ $name ]['field']
+            ? $hf[$name]['field']
             : $hf;
     }
 
@@ -2670,7 +2670,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
@@ -2680,7 +2680,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2797,13 +2797,13 @@ 
             'event-espresso_page_espresso_',
             '',
             $this->_wp_page_slug
-        ) . ' ' . $this->_req_action . '-route';
+        ).' '.$this->_req_action.'-route';
 
         $template_path = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
 
@@ -2837,11 +2837,11 @@ 
     public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2861,8 +2861,8 @@ 
                 true
             )
             : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
+            EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php',
             $this->_template_args,
             true
         );
@@ -2920,7 +2920,7 @@ 
         // setup search attributes
         $this->_set_search_attributes();
         $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+        $template_path                            = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
         $this->_template_args['table_url']        = $this->request->isAjax()
             ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
             : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
@@ -2928,10 +2928,10 @@ 
         $this->_template_args['current_route']    = $this->_req_action;
         $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
         $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
+        if ( ! empty($ajax_sorting_callback)) {
             $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
+                $ajax_sorting_callback.'_nonce',
+                $ajax_sorting_callback.'_nonce',
                 false,
                 false
             );
@@ -2948,18 +2948,18 @@ 
 
         $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref          = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
-        $this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
+        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
         $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -2993,7 +2993,7 @@ 
         // convert to array and filter again
         // arrays are easier to inject new items in a specific location,
         // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
+        $this->_template_args['after_list_table'] = implode(
             " \n",
             (array) apply_filters(
                 'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
@@ -3048,7 +3048,7 @@ 
             $this->page_slug
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3164,16 +3164,16 @@ 
             $this->_template_args['before_admin_page_content'] ?? ''
         );
 
-        $this->_template_args['after_admin_page_content']  = apply_filters(
+        $this->_template_args['after_admin_page_content'] = apply_filters(
             "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
             $this->_template_args['after_admin_page_content'] ?? ''
         );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
                 // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3182,7 +3182,7 @@ 
         // load settings page wrapper template
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper.template.php';
 
         EEH_Template::display_template($template_path, $this->_template_args);
     }
@@ -3266,12 +3266,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button button--primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3311,13 +3311,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $action = $this->_admin_base_url;
@@ -3325,9 +3325,9 @@ 
             <form name='form' method='post' action='{$action}' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3340,7 +3340,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3423,12 +3423,12 @@ 
         bool $override_overwrite = false
     ) {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $notices      = EE_Error::get_notices(false);
+        $notices = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             EE_Error::add_success(
                 sprintf(
@@ -3449,7 +3449,7 @@ 
             );
         }
         // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
+        if ( ! is_array($query_args)) {
             $query_args = [];
         }
         /**
@@ -3481,7 +3481,7 @@ 
             $redirect_url = admin_url('admin.php');
         }
         // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
             $args_to_merge = [];
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
                 // is there a wp_referer array in our _default_route_query_args property?
@@ -3493,15 +3493,15 @@ 
                         }
                         // finally we will override any arguments in the referer with
                         // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+                        if (isset($this->_default_route_query_args[$reference])) {
+                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
                         } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
+                            $args_to_merge[$reference] = urlencode($value);
                         }
                     }
                     continue;
                 }
-                $args_to_merge[ $query_param ] = $query_value;
+                $args_to_merge[$query_param] = $query_value;
             }
             // now let's merge these arguments but override with what was specifically sent in to the
             // redirect.
@@ -3513,19 +3513,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$this->class_name.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
+            'FHEE_redirect_'.$this->class_name.$this->_req_action,
             EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3575,7 +3575,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = isset($query_args['action']) ? $query_args['action'] : 'default';
             $this->_add_transient(
                 $route,
@@ -3615,7 +3615,7 @@ 
         $exclude_nonce = false
     ) {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3626,7 +3626,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3639,7 +3639,7 @@ 
         }
         // finally check user access for this button.
         $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
+        if ( ! $has_access) {
             return '';
         }
         $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
@@ -3647,11 +3647,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3677,7 +3677,7 @@ 
                 'FHEE__EE_Admin_Page___per_page_screen_options__default',
                 20
             ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+            'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
         ];
         // ONLY add the screen option if the user has access to it.
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3698,18 +3698,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
-            $value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
+            $value = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3766,13 +3766,13 @@ 
     protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
     {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = $notices ? ['notices' => $data] : $data;
         // is there already a transient for this route?  If there is then let's ADD to that transient
         $existing = is_multisite() && is_network_admin()
@@ -3801,8 +3801,8 @@ 
         $user_id   = get_current_user_id();
         $route     = ! $route ? $this->_req_action : $route;
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = is_multisite() && is_network_admin()
             ? get_site_transient($transient)
             : get_transient($transient);
@@ -4038,7 +4038,7 @@ 
      */
     protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4051,7 +4051,7 @@ 
      */
     protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4199,13 +4199,13 @@ 
         ?callable $callback = null
     ): bool {
         $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
+        if ( ! $entity_ID) {
             $this->trashRestoreDeleteError($action, $entity_model);
         }
         $result = 0;
         try {
             $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
+            if ( ! $entity instanceof EE_Base_Class) {
                 throw new DomainException(
                     sprintf(
                         esc_html__(
@@ -4256,7 +4256,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/libraries/batch/JobHandlers/ExecuteBatchDeletion.php

Indentation +169 added lines, -169 removed lines

@@ -26,185 +26,185 @@
  */
 class ExecuteBatchDeletion extends JobHandler
 {
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
 
 
-    /**
-     * @param NodeGroupDao $model_obj_node_group_persister
-     */
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	/**
+	 * @param NodeGroupDao $model_obj_node_group_persister
+	 */
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
 
 
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
-        $roots             = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
-        if ($roots === null) {
-            throw new UnexpectedEntityException(
-                $roots,
-                'array',
-                esc_html__(
-                    'The job seems to be stale. Please press the back button in your browser twice.',
-                    'event_espresso'
-                )
-            );
-        }
-        $models_and_ids_to_delete = [];
-        foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        $job_parameters->set_extra_data(
-            [
-                'models_and_ids_to_delete' => $models_and_ids_to_delete,
-            ]
-        );
-        // Find the job's actual size.
-        $job_size = 0;
-        foreach ($models_and_ids_to_delete as $ids) {
-            $job_size += count($ids);
-        }
-        $job_parameters->set_job_size($job_size);
-        $this->updateTextHeader(esc_html__('Beginning to delete items...', 'event_espresso'));
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
+		$roots             = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
+		if ($roots === null) {
+			throw new UnexpectedEntityException(
+				$roots,
+				'array',
+				esc_html__(
+					'The job seems to be stale. Please press the back button in your browser twice.',
+					'event_espresso'
+				)
+			);
+		}
+		$models_and_ids_to_delete = [];
+		foreach ($roots as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		$job_parameters->set_extra_data(
+			[
+				'models_and_ids_to_delete' => $models_and_ids_to_delete,
+			]
+		);
+		// Find the job's actual size.
+		$job_size = 0;
+		foreach ($models_and_ids_to_delete as $ids) {
+			$job_size += count($ids);
+		}
+		$job_parameters->set_job_size($job_size);
+		$this->updateTextHeader(esc_html__('Beginning to delete items...', 'event_espresso'));
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        // We already have the items IDs. So deleting is really fast. Let's speed it up.
-        $batch_size               *= 10;
-        $units_processed          = 0;
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        // Build a new list of everything leftover after this request's of deletions.
-        $models_and_ids_remaining = [];
-        foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
-            // don't delete logs
-            if ($model_name === 'Change_Log') {
-                continue;
-            }
-            if ($units_processed < $batch_size) {
-                /** @var EEM_Base $model */
-                $model                    = EE_Registry::instance()->load_model($model_name);
-                $ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
-                if ($model->has_primary_key_field()) {
-                    $where_conditions = [
-                        $model->primary_key_name() => [
-                            'IN',
-                            $ids_to_delete_this_query,
-                        ],
-                    ];
-                } else {
-                    $where_conditions = [
-                        'OR' => [],
-                    ];
-                    foreach ($ids_to_delete_this_query as $index_primary_key_string) {
-                        $keys_n_values                                                =
-                            $model->parse_index_primary_key_string($index_primary_key_string);
-                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
-                    }
-                }
-                // Deleting time!
-                // The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
-                // two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
-                $model->delete_permanently([ $where_conditions ], false);
-                $units_processed += count($ids_to_delete_this_query);
-                $remaining_ids   = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
-                // If there's any more from this model, we'll do them next time.
-                if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
-                }
-            } else {
-                $models_and_ids_remaining[ $model_name ] = $ids_to_delete;
-            }
-        }
-        $job_parameters->mark_processed($units_processed);
-        // All done deleting for this request. Is there anything to do next time?
-        if (empty($models_and_ids_remaining)) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            return new JobStepResponse($job_parameters, $this->feedback);
-        }
-        $job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
-        $this->displayJobStepResults(
-            $units_processed,
-            esc_html__('Deleted %d items.', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		// We already have the items IDs. So deleting is really fast. Let's speed it up.
+		$batch_size               *= 10;
+		$units_processed          = 0;
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		// Build a new list of everything leftover after this request's of deletions.
+		$models_and_ids_remaining = [];
+		foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
+			// don't delete logs
+			if ($model_name === 'Change_Log') {
+				continue;
+			}
+			if ($units_processed < $batch_size) {
+				/** @var EEM_Base $model */
+				$model                    = EE_Registry::instance()->load_model($model_name);
+				$ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
+				if ($model->has_primary_key_field()) {
+					$where_conditions = [
+						$model->primary_key_name() => [
+							'IN',
+							$ids_to_delete_this_query,
+						],
+					];
+				} else {
+					$where_conditions = [
+						'OR' => [],
+					];
+					foreach ($ids_to_delete_this_query as $index_primary_key_string) {
+						$keys_n_values                                                =
+							$model->parse_index_primary_key_string($index_primary_key_string);
+						$where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
+					}
+				}
+				// Deleting time!
+				// The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
+				// two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
+				$model->delete_permanently([ $where_conditions ], false);
+				$units_processed += count($ids_to_delete_this_query);
+				$remaining_ids   = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
+				// If there's any more from this model, we'll do them next time.
+				if (count($remaining_ids) > 0) {
+					$models_and_ids_remaining[ $model_name ] = $remaining_ids;
+				}
+			} else {
+				$models_and_ids_remaining[ $model_name ] = $ids_to_delete;
+			}
+		}
+		$job_parameters->mark_processed($units_processed);
+		// All done deleting for this request. Is there anything to do next time?
+		if (empty($models_and_ids_remaining)) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			return new JobStepResponse($job_parameters, $this->feedback);
+		}
+		$job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
+		$this->displayJobStepResults(
+			$units_processed,
+			esc_html__('Deleted %d items.', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
-            $job_parameters->request_datum('deletion_job_code')
-        );
-        // For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        foreach ($models_and_ids_to_delete['Event'] as $event_id) {
-            // TrashLogger hooks into the following to create a log entry
-            // so we know when and who permanently deleted this event.
-            do_action(
-                'AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted',
-                $event_id,
-                'Event',
-                $job_parameters
-            );
-        }
-        $this->displayJobFinalResults(
-            $job_parameters,
-            esc_html__('All Done. Deleted a total of %d items.', 'event_espresso')
-        );
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to return to the %2$sprevious admin screen%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
+			$job_parameters->request_datum('deletion_job_code')
+		);
+		// For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		foreach ($models_and_ids_to_delete['Event'] as $event_id) {
+			// TrashLogger hooks into the following to create a log entry
+			// so we know when and who permanently deleted this event.
+			do_action(
+				'AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted',
+				$event_id,
+				'Event',
+				$job_parameters
+			);
+		}
+		$this->displayJobFinalResults(
+			$job_parameters,
+			esc_html__('All Done. Deleted a total of %d items.', 'event_espresso')
+		);
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to return to the %2$sprevious admin screen%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php

Spacing +8 added lines, -8 removed lines

@@ -68,7 +68,7 @@ 
         }
         $models_and_ids_to_delete = [];
         foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
+            if ( ! $root instanceof ModelObjNode) {
                 throw new UnexpectedEntityException($root, 'ModelObjNode');
             }
             $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
@@ -101,7 +101,7 @@ 
     public function continue_job(JobParameters $job_parameters, $batch_size = 50)
     {
         // We already have the items IDs. So deleting is really fast. Let's speed it up.
-        $batch_size               *= 10;
+        $batch_size *= 10;
         $units_processed          = 0;
         $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
         // Build a new list of everything leftover after this request's of deletions.
@@ -129,21 +129,21 @@ 
                     foreach ($ids_to_delete_this_query as $index_primary_key_string) {
                         $keys_n_values                                                =
                             $model->parse_index_primary_key_string($index_primary_key_string);
-                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
+                        $where_conditions['OR']['AND*'.$index_primary_key_string] = $keys_n_values;
                     }
                 }
                 // Deleting time!
                 // The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
                 // two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
-                $model->delete_permanently([ $where_conditions ], false);
+                $model->delete_permanently([$where_conditions], false);
                 $units_processed += count($ids_to_delete_this_query);
-                $remaining_ids   = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
+                $remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
                 // If there's any more from this model, we'll do them next time.
                 if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
+                    $models_and_ids_remaining[$model_name] = $remaining_ids;
                 }
             } else {
-                $models_and_ids_remaining[ $model_name ] = $ids_to_delete;
+                $models_and_ids_remaining[$model_name] = $ids_to_delete;
             }
         }
         $job_parameters->mark_processed($units_processed);
@@ -198,7 +198,7 @@ 
                         'event_espresso'
                     ),
                     '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
+                    '<a href="'.$job_parameters->request_datum('return_url').'">',
                     '</a>'
                 )
             )

core/EE_System.core.php

Indentation +1216 added lines, -1216 removed lines

@@ -24,1220 +24,1220 @@
  */
 final class EE_System implements ResettableInterface
 {
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var AddonManager $addon_manager
-     */
-    private $addon_manager;
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * @var Router $router
-     */
-    private $router;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
-     */
-    private $register_custom_post_types;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
-     */
-    private $register_custom_taxonomies;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
-     */
-    private $register_custom_taxonomy_terms;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null     $loader
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @param EE_Registry|null         $registry
-     * @param RequestInterface|null    $request
-     * @param Router|null              $router
-     * @return EE_System
-     */
-    public static function instance(
-        LoaderInterface $loader = null,
-        EE_Maintenance_Mode $maintenance_mode = null,
-        EE_Registry $registry = null,
-        RequestInterface $request = null,
-        Router $router = null
-    ): EE_System {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset(): EE_System
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param LoaderInterface     $loader
-     * @param EE_Maintenance_Mode $maintenance_mode
-     * @param EE_Registry         $registry
-     * @param RequestInterface    $request
-     * @param Router              $router
-     */
-    private function __construct(
-        LoaderInterface $loader,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry,
-        RequestInterface $request,
-        Router $router
-    ) {
-        $this->registry         = $registry;
-        $this->loader           = $loader;
-        $this->request          = $request;
-        $this->router           = $router;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCapabilities'],
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCommandBus'],
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadPluginApi'],
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'load_espresso_addons']
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            [$this, 'detect_activations_or_upgrades'],
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'load_core_configuration'],
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadRouteMatchSpecifications']
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            [$this, 'register_shortcodes_modules_and_widgets'],
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            [$this, 'brew_espresso'],
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            [$this, 'remove_pages_from_wp_list_pages'],
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     * CommandBus middleware operate FIFO - First In First Out
-     * so LocateMovedCommands will run first in order to return any new commands
-     *
-     * @return void
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            [
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    [
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws Exception
-     */
-    public function loadPluginApi()
-    {
-        $this->addon_manager = $this->loader->getShared(AddonManager::class);
-        $this->addon_manager->initialize();
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function load_espresso_addons()
-    {
-        // looking for hooks? they've been moved into the AddonManager to maintain compatibility
-        $this->addon_manager->loadAddons();
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type       = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change(array $espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = [];
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = [$espresso_db_update => []];
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = [];
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return ! empty($espresso_db_update) ? $espresso_db_update : [];
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null): int
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update          = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type             = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history): bool
-    {
-        $previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts  = explode('.', espresso_version());
-        return isset(
-            $previous_version_parts[0],
-            $previous_version_parts[1],
-            $current_version_parts[0],
-            $current_version_parts[1]
-        ) && (
-            $previous_version_parts[0] !== $current_version_parts[0]
-            || $previous_version_parts[1] !== $current_version_parts[1]
-        );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change(): bool
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array|null $activation_history             the option's value which stores the activation history for
-     *                                                 this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $current_version                  the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public static function detect_req_type_given_activation_history(
-        array $activation_history,
-        string $activation_indicator_option_name,
-        string $current_version
-    ): int {
-        $version_change = self::compareVersionWithPrevious($activation_history, $current_version);
-        $is_activation  = get_option($activation_indicator_option_name, false);
-        $req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
-        if ($is_activation) {
-            // cleanup in aisle 6
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * @param array  $activation_history
-     * @param int    $version_change
-     * @param bool   $is_activation
-     * @return int
-     * @since $VID:$
-     */
-    private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
-    {
-        // if no previous activation history exists, then this is a brand new install
-        if (empty($activation_history)) {
-            return EE_System::req_type_new_activation;
-        }
-        // current version is higher than previous version, so it's an upgrade
-        if ($version_change === 1) {
-            return EE_System::req_type_upgrade;
-        }
-        // current version is lower than previous version, so it's a downgrade
-        if ($version_change === -1) {
-            return EE_System::req_type_downgrade;
-        }
-        // version hasn't changed since last version so check if the activation indicator is set
-        // to determine if it's a reactivation, or just a normal request
-        return $is_activation
-            ? EE_System::req_type_reactivation
-            : EE_System::req_type_normal;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history    array where keys are versions,
-     *                                      values are arrays of times activated (sometimes 'unknown-date')
-     * @param string $current_version
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
-    {
-        // find the most recently-activated version
-        $most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
-        return version_compare($current_version, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function getMostRecentlyActiveVersion(array $activation_history): string
-    {
-        $most_recent_activation_date  = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $activation_dates) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $activation_dates) {
-                    $activation_dates = ['unknown-date'];
-                }
-                $activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
-                foreach ($activation_dates as $activation_date) {
-                    if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
-                        $most_recently_active_version = $version;
-                        $most_recent_activation_date  = $activation_date;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = ['page' => 'espresso_about'];
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            EEH_URL::safeRedirectAndExit($url);
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        $this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
-        $model_names            = [];
-        $non_abstract_db_models = [];
-        foreach ($models as $model) {
-            // get model classname
-            $classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name      = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     */
-    private function _maybe_brew_regular()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getEventEspressoCoreDomain();
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @throws Exception
-     * @since 4.9.71.p
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
-            $this->router->loadPrimaryRoutes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * loading CPT related classes earlier so that their definitions are available
-     * but not performing any actual registration with WP core until load_CPTs_and_session() is called
-     *
-     * @since   4.10.21.p
-     */
-    public function loadCustomPostTypes()
-    {
-        $this->register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $this->register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $this->register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        $this->router->registerShortcodesModulesAndWidgets();
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', [$this, 'set_hooks_for_core'], 1);
-        add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
-        add_action('init', [$this, 'load_CPTs_and_session'], 5);
-        add_action('init', [$this, 'load_controllers'], 7);
-        add_action('init', [$this, 'core_loaded_and_ready'], 9);
-        add_action('init', [$this, 'initialize'], 10);
-        add_action('init', [$this, 'initialize_last'], 100);
-        $this->router->brewEspresso();
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', []);
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        $this->register_custom_taxonomies->registerCustomTaxonomies();
-        $this->register_custom_post_types->registerCustomPostTypes();
-        $this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        $this->router->loadControllers();
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->router->coreLoadedAndReady();
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-        add_filter(
-            'safe_style_css',
-            function ($styles) {
-                $styles[] = 'display';
-                $styles[] = 'visibility';
-                $styles[] = 'position';
-                $styles[] = 'top';
-                $styles[] = 'right';
-                $styles[] = 'bottom';
-                $styles[] = 'left';
-                $styles[] = 'resize';
-                $styles[] = 'max-width';
-                $styles[] = 'max-height';
-                return $styles;
-            }
-        );
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function initialize_last()
-    {
-        $this->router->initializeLast();
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            [$this->registry->CAP]
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers): array
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages(array $exclude_array): array
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var AddonManager $addon_manager
+	 */
+	private $addon_manager;
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * @var Router $router
+	 */
+	private $router;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
+	 */
+	private $register_custom_post_types;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
+	 */
+	private $register_custom_taxonomies;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
+	 */
+	private $register_custom_taxonomy_terms;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @param EE_Registry|null         $registry
+	 * @param RequestInterface|null    $request
+	 * @param Router|null              $router
+	 * @return EE_System
+	 */
+	public static function instance(
+		LoaderInterface $loader = null,
+		EE_Maintenance_Mode $maintenance_mode = null,
+		EE_Registry $registry = null,
+		RequestInterface $request = null,
+		Router $router = null
+	): EE_System {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset(): EE_System
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param LoaderInterface     $loader
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 * @param EE_Registry         $registry
+	 * @param RequestInterface    $request
+	 * @param Router              $router
+	 */
+	private function __construct(
+		LoaderInterface $loader,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry,
+		RequestInterface $request,
+		Router $router
+	) {
+		$this->registry         = $registry;
+		$this->loader           = $loader;
+		$this->request          = $request;
+		$this->router           = $router;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCapabilities'],
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCommandBus'],
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadPluginApi'],
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'load_espresso_addons']
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			[$this, 'detect_activations_or_upgrades'],
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'load_core_configuration'],
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadRouteMatchSpecifications']
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			[$this, 'register_shortcodes_modules_and_widgets'],
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			[$this, 'brew_espresso'],
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			[$this, 'remove_pages_from_wp_list_pages'],
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 * CommandBus middleware operate FIFO - First In First Out
+	 * so LocateMovedCommands will run first in order to return any new commands
+	 *
+	 * @return void
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			[
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					[
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Exception
+	 */
+	public function loadPluginApi()
+	{
+		$this->addon_manager = $this->loader->getShared(AddonManager::class);
+		$this->addon_manager->initialize();
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_espresso_addons()
+	{
+		// looking for hooks? they've been moved into the AddonManager to maintain compatibility
+		$this->addon_manager->loadAddons();
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type       = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change(array $espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = [];
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = [$espresso_db_update => []];
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = [];
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string                         = $should_be_array;
+					$corrected_db_update[ $version_string ] = ['unknown-date'];
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return ! empty($espresso_db_update) ? $espresso_db_update : [];
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null): int
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update          = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type             = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history): bool
+	{
+		$previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts  = explode('.', espresso_version());
+		return isset(
+			$previous_version_parts[0],
+			$previous_version_parts[1],
+			$current_version_parts[0],
+			$current_version_parts[1]
+		) && (
+			$previous_version_parts[0] !== $current_version_parts[0]
+			|| $previous_version_parts[1] !== $current_version_parts[1]
+		);
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change(): bool
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array|null $activation_history             the option's value which stores the activation history for
+	 *                                                 this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $current_version                  the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public static function detect_req_type_given_activation_history(
+		array $activation_history,
+		string $activation_indicator_option_name,
+		string $current_version
+	): int {
+		$version_change = self::compareVersionWithPrevious($activation_history, $current_version);
+		$is_activation  = get_option($activation_indicator_option_name, false);
+		$req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
+		if ($is_activation) {
+			// cleanup in aisle 6
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * @param array  $activation_history
+	 * @param int    $version_change
+	 * @param bool   $is_activation
+	 * @return int
+	 * @since $VID:$
+	 */
+	private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
+	{
+		// if no previous activation history exists, then this is a brand new install
+		if (empty($activation_history)) {
+			return EE_System::req_type_new_activation;
+		}
+		// current version is higher than previous version, so it's an upgrade
+		if ($version_change === 1) {
+			return EE_System::req_type_upgrade;
+		}
+		// current version is lower than previous version, so it's a downgrade
+		if ($version_change === -1) {
+			return EE_System::req_type_downgrade;
+		}
+		// version hasn't changed since last version so check if the activation indicator is set
+		// to determine if it's a reactivation, or just a normal request
+		return $is_activation
+			? EE_System::req_type_reactivation
+			: EE_System::req_type_normal;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history    array where keys are versions,
+	 *                                      values are arrays of times activated (sometimes 'unknown-date')
+	 * @param string $current_version
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
+	{
+		// find the most recently-activated version
+		$most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
+		return version_compare($current_version, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function getMostRecentlyActiveVersion(array $activation_history): string
+	{
+		$most_recent_activation_date  = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $activation_dates) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $activation_dates) {
+					$activation_dates = ['unknown-date'];
+				}
+				$activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
+				foreach ($activation_dates as $activation_date) {
+					if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
+						$most_recently_active_version = $version;
+						$most_recent_activation_date  = $activation_date;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = ['page' => 'espresso_about'];
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			EEH_URL::safeRedirectAndExit($url);
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		$this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models                 = glob(EE_MODELS . '*.model.php');
+		$model_names            = [];
+		$non_abstract_db_models = [];
+		foreach ($models as $model) {
+			// get model classname
+			$classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name      = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 */
+	private function _maybe_brew_regular()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getEventEspressoCoreDomain();
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @throws Exception
+	 * @since 4.9.71.p
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
+			$this->router->loadPrimaryRoutes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * loading CPT related classes earlier so that their definitions are available
+	 * but not performing any actual registration with WP core until load_CPTs_and_session() is called
+	 *
+	 * @since   4.10.21.p
+	 */
+	public function loadCustomPostTypes()
+	{
+		$this->register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$this->register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$this->register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		$this->router->registerShortcodesModulesAndWidgets();
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', [$this, 'set_hooks_for_core'], 1);
+		add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
+		add_action('init', [$this, 'load_CPTs_and_session'], 5);
+		add_action('init', [$this, 'load_controllers'], 7);
+		add_action('init', [$this, 'core_loaded_and_ready'], 9);
+		add_action('init', [$this, 'initialize'], 10);
+		add_action('init', [$this, 'initialize_last'], 100);
+		$this->router->brewEspresso();
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', []);
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', []);
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		$this->register_custom_taxonomies->registerCustomTaxonomies();
+		$this->register_custom_post_types->registerCustomPostTypes();
+		$this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		$this->router->loadControllers();
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->router->coreLoadedAndReady();
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+		add_filter(
+			'safe_style_css',
+			function ($styles) {
+				$styles[] = 'display';
+				$styles[] = 'visibility';
+				$styles[] = 'position';
+				$styles[] = 'top';
+				$styles[] = 'right';
+				$styles[] = 'bottom';
+				$styles[] = 'left';
+				$styles[] = 'resize';
+				$styles[] = 'max-width';
+				$styles[] = 'max-height';
+				return $styles;
+			}
+		);
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize_last()
+	{
+		$this->router->initializeLast();
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			[$this->registry->CAP]
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers): array
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages(array $exclude_array): array
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 }

core/db_classes/EE_Transaction.class.php

Indentation +1706 added lines, -1706 removed lines

@@ -13,1710 +13,1710 @@
  */
 class EE_Transaction extends EE_Base_Class implements EEI_Transaction
 {
-    /**
-     * The length of time in seconds that a lock is applied before being considered expired.
-     * It is not long because a transaction should only be locked for the duration of the request that locked it
-     */
-    const LOCK_EXPIRATION = 2;
-
-    /**
-     * txn status upon initial construction.
-     *
-     * @var string
-     */
-    protected $_old_txn_status;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone
-     *                                        (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        $txn        = $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
-            $txn->set_old_txn_status($txn->status_ID());
-        }
-        return $txn;
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        $txn = new self($props_n_values, true, $timezone);
-        $txn->set_old_txn_status($txn->status_ID());
-        return $txn;
-    }
-
-
-    /**
-     * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
-     * If a lock has already been set, then we will attempt to remove it in case it has expired.
-     * If that also fails, then an exception is thrown.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function lock()
-    {
-        // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
-            // then attempt to remove the lock in case it is expired
-            if ($this->_remove_expired_lock()) {
-                // if removal was successful, then try setting lock again
-                $this->lock();
-            } else {
-                // but if the lock can not be removed, then throw an exception
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
-                            'event_espresso'
-                        ),
-                        $this->ID()
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * removes transaction lock applied in EE_Transaction::lock()
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unlock()
-    {
-        return $this->delete_extra_meta('lock');
-    }
-
-
-    /**
-     * Decides whether or not now is the right time to update the transaction.
-     * This is useful because we don't always know if it is safe to update the transaction
-     * and its related data. why?
-     * because it's possible that the transaction is being used in another
-     * request and could overwrite anything we save.
-     * So we want to only update the txn once we know that won't happen.
-     * We also check that the lock isn't expired, and remove it if it is
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_locked()
-    {
-        // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
-            return false;
-        }
-        // if not, then let's try and remove the lock in case it's expired...
-        // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
-        // and a positive number if the lock was removed (ie: number of locks deleted),
-        // so we need to return the opposite
-        return ! $this->_remove_expired_lock() ? true : false;
-    }
-
-
-    /**
-     * Gets the meta field indicating that this TXN is locked
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_lock()
-    {
-        return (int) $this->get_extra_meta('lock', true, 0);
-    }
-
-
-    /**
-     * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _remove_expired_lock()
-    {
-        $locked = $this->_get_lock();
-        if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
-            return $this->unlock();
-        }
-        return 0;
-    }
-
-
-    /**
-     * Set transaction total
-     *
-     * @param float $total total value of transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total = 0.00)
-    {
-        $this->set('TXN_total', (float) $total);
-    }
-
-
-    /**
-     * Set Total Amount Paid to Date
-     *
-     * @param float $total_paid total amount paid to date (sum of all payments)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_paid($total_paid = 0.00)
-    {
-        $this->set('TXN_paid', (float) $total_paid);
-    }
-
-
-    /**
-     * Set transaction status
-     *
-     * @param string $status        whether the transaction is open, declined, accepted,
-     *                              or any number of custom values that can be set
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_status($status = '')
-    {
-        $this->set('STS_ID', $status);
-    }
-
-
-    /**
-     * Set hash salt
-     *
-     * @param string $hash_salt required for some payment gateways
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_hash_salt($hash_salt = '')
-    {
-        $this->set('TXN_hash_salt', $hash_salt);
-    }
-
-
-    /**
-     * Sets TXN_reg_steps array
-     *
-     * @param array $txn_reg_steps
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_steps(array $txn_reg_steps)
-    {
-        $this->set('TXN_reg_steps', $txn_reg_steps);
-    }
-
-
-    /**
-     * Gets TXN_reg_steps
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_steps()
-    {
-        $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps) ? $TXN_reg_steps : [];
-    }
-
-
-    /**
-     * @return string of transaction's total cost, with currency symbol and decimal
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_total()
-    {
-        return $this->get_pretty('TXN_total');
-    }
-
-
-    /**
-     * Gets the amount paid in a pretty string (formatted and with currency symbol)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('TXN_paid');
-    }
-
-
-    /**
-     * calculate the amount remaining for this transaction and return;
-     *
-     * @return float amount remaining
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remaining()
-    {
-        return $this->total() - $this->paid();
-    }
-
-
-    /**
-     * get Transaction Total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return (float) $this->get('TXN_total');
-    }
-
-
-    /**
-     * get Total Amount Paid to Date
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid()
-    {
-        return (float) $this->get('TXN_paid');
-    }
-
-
-    /**
-     * @return mixed|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_cart_session()
-    {
-        $session_data = (array) $this->get('TXN_session_data');
-        return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
-            ? $session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * get Transaction session data
-     *
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function session_data()
-    {
-        $session_data = $this->get('TXN_session_data');
-        if (empty($session_data)) {
-            $session_data = [
-                'id'            => null,
-                'user_id'       => null,
-                'ip_address'    => null,
-                'user_agent'    => null,
-                'init_access'   => null,
-                'last_access'   => null,
-                'pages_visited' => [],
-            ];
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * Set session data within the TXN object
-     *
-     * @param EE_Session|array $session_data
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_txn_session_data($session_data)
-    {
-        if ($session_data instanceof EE_Session) {
-            $this->set('TXN_session_data', $session_data->get_session_data(null, true));
-        } else {
-            $this->set('TXN_session_data', $session_data);
-        }
-    }
-
-
-    /**
-     * get Transaction hash salt
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function hash_salt_()
-    {
-        return $this->get('TXN_hash_salt');
-    }
-
-
-    /**
-     * Returns the transaction datetime as either:
-     *            - unix timestamp format ($format = false, $gmt = true)
-     *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
-     *              has no affect with this option)), this also may include a timezone abbreviation if the
-     *              set timezone in this class differs from what the timezone is on the blog.
-     *            - formatted date string including the UTC (timezone) offset (default).
-     *
-     * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
-     * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
-     *                          or no UTC offset applied
-     * @return string | int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime($format = false, $gmt = false)
-    {
-        if ($format) {
-            return $this->get_pretty('TXN_timestamp');
-        }
-        if ($gmt) {
-            return $this->get_raw('TXN_timestamp');
-        }
-        return $this->get('TXN_timestamp');
-    }
-
-
-    /**
-     * Gets registrations on this transaction
-     *
-     * @param array   $query_params array of query parameters
-     * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registrations($query_params = [], $get_cached = false)
-    {
-        $query_params = (empty($query_params) || ! is_array($query_params))
-            ? [
-                'order_by' => [
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ],
-            ]
-            : $query_params;
-        $query_params = $get_cached ? [] : $query_params;
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
-     * function for getting attendees and how many registrations they each have for an event)
-     *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendees()
-    {
-        return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
-    }
-
-
-    /**
-     * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = [])
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * gets only approved payments for this transaction
-     *
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function approved_payments()
-    {
-        EE_Registry::instance()->load_model('Payment');
-        return $this->get_many_related(
-            'Payment',
-            [
-                ['STS_ID' => EEM_Payment::status_id_approved],
-                'order_by' => ['PAY_timestamp' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all payments which have not been approved
-     *
-     * @return EE_Base_Class[]|EEI_Payment[]
-     * @throws EE_Error if a model is misconfigured somehow
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pending_payments()
-    {
-        return $this->get_many_related(
-            'Payment',
-            [
-                [
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                ],
-                'order_by' => [
-                    'PAY_timestamp' => 'DESC',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$this->status_ID() => esc_html__('unknown', 'event_espresso')],
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Transaction::complete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
-                break;
-            case EEM_Transaction::incomplete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::abandoned_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::failed_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::overpaid_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     * get Transaction Status
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Returns TRUE or FALSE for whether or not this transaction cost any money
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_free()
-    {
-        return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
-    }
-
-
-    /**
-     * Returns whether this transaction is complete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_completed()
-    {
-        return $this->status_ID() === EEM_Transaction::complete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is incomplete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Transaction::incomplete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is overpaid
-     * Useful in templates and other logic for deciding if monies need to be refunded
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_overpaid()
-    {
-        return $this->status_ID() === EEM_Transaction::overpaid_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction was abandoned
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * but that contact information exists for at least one registrant
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_abandoned()
-    {
-        return $this->status_ID() === EEM_Transaction::abandoned_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction failed
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * and that NO contact information exists for any registrants
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function failed()
-    {
-        return $this->status_ID() === EEM_Transaction::failed_status_code;
-    }
-
-
-    /**
-     * This returns the url for the invoice of this transaction
-     *
-     * @param string $type 'html' or 'pdf' (default is pdf)
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function invoice_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->invoice_url($type);
-    }
-
-
-    /**
-     * Gets the primary registration only
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function primary_registration()
-    {
-        $registrations = (array) $this->get_many_related(
-            'Registration',
-            [['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
-        );
-        foreach ($registrations as $registration) {
-            // valid registration that is NOT cancelled or declined ?
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
-            ) {
-                return $registration;
-            }
-        }
-        // nothing valid found, so just return first thing from array of results
-        return reset($registrations);
-    }
-
-
-    /**
-     * Gets the URL for viewing the receipt
-     *
-     * @param string $type 'pdf' or 'html' (default is 'html')
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function receipt_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->receipt_url($type);
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url()
-    {
-        $primary_registration = $this->primary_registration();
-        return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function gateway_response_on_transaction()
-    {
-        $payment = $this->get_first_related('Payment');
-        return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function extra_meta($query_params = [])
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_registration(EE_Registration $registration)
-    {
-        return $this->_add_relation_to($registration, 'Registration');
-    }
-
-
-    /**
-     * Removes the given registration from being related (even before saving this transaction).
-     * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
-     *
-     * @param int $registration_or_id
-     * @return EE_Base_Class that was removed from being related
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_registration_with_id($registration_or_id)
-    {
-        return $this->_remove_relation_to($registration_or_id, 'Registration');
-    }
-
-
-    /**
-     * Gets all the line items which are for ACTUAL items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function items_purchased()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_line_item(EE_Line_Item $line_item)
-    {
-        return $this->_add_relation_to($line_item, 'Line_Item');
-    }
-
-
-    /**
-     * Gets ALL the line items related to this transaction (unstructured)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function line_items($query_params = [])
-    {
-        return $this->get_many_related('Line_Item', $query_params);
-    }
-
-
-    /**
-     * Gets all the line items which are taxes on the total
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_items()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other related line items,
-     * meaning it takes them all into account on its total)
-     *
-     * @param bool $create_if_not_found
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
-    {
-        $item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
-        if ($item instanceof EE_Line_Item) {
-            return $item;
-        }
-        return $create_if_not_found ? EEH_Line_Item::create_total_line_item($this) : null;
-    }
-
-
-    /**
-     * Returns the total amount of tax on this transaction
-     * (assumes there's only one tax subtotal line item)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total()
-    {
-        $tax_line_item = $this->tax_total_line_item();
-        if ($tax_line_item) {
-            return (float) $tax_line_item->total();
-        }
-        return (float) 0;
-    }
-
-
-    /**
-     * Gets the tax subtotal line item (assumes there's only one)
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total_line_item()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
-    }
-
-
-    /**
-     * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function billing_info()
-    {
-        $payment_method = $this->payment_method();
-        if (! $payment_method) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Could not find billing info for transaction because no gateway has been used for it yet',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because no primary registration exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $attendee->billing_info_for_payment_method($payment_method);
-    }
-
-
-    /**
-     * Gets PMD_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method_ID()
-    {
-        return $this->get('PMD_ID');
-    }
-
-
-    /**
-     * Sets PMD_ID
-     *
-     * @param int $PMD_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_payment_method_ID($PMD_ID)
-    {
-        $this->set('PMD_ID', $PMD_ID);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method()
-    {
-        $pm = $this->get_first_related('Payment_Method');
-        if ($pm instanceof EE_Payment_Method) {
-            return $pm;
-        }
-        $last_payment = $this->last_payment();
-        if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
-            return $last_payment->payment_method();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the last payment made
-     *
-     * @return EE_Base_Class|EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function last_payment()
-    {
-        return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
-    }
-
-
-    /**
-     * Gets all the line items which are unrelated to tickets on this transaction
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function non_ticket_line_items()
-    {
-        return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
-    }
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @param boolean $update whether to save the TXN
-     * @return bool whether the TXN was saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_status_based_on_total_paid($update = true)
-    {
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
-            $new_txn_status = EEM_Transaction::overpaid_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
-            $new_txn_status = EEM_Transaction::complete_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
-            $new_txn_status = EEM_Transaction::incomplete_status_code;
-        } else {
-            throw new RuntimeException(
-                esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
-            );
-        }
-        if ($new_txn_status !== $this->status_ID()) {
-            $this->set_status($new_txn_status);
-            if ($update) {
-                return (bool) $this->save();
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the transaction's status and total_paid based on all the payments
-     * that apply to it
-     *
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated
-     */
-    public function update_based_on_payments()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_status_updated()
-    {
-        return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
-    }
-
-
-    /**
-     * _reg_steps_completed
-     * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
-     * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
-     * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
-     *
-     * @param string $reg_step_slug
-     * @param bool   $check_all
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
-    {
-        $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
-            return false;
-        }
-        // loop thru reg steps array)
-        foreach ($reg_steps as $slug => $reg_step_completed) {
-            // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
-                // and this is the one
-                if ($slug === $reg_step_slug) {
-                    return $reg_step_completed;
-                }
-                // skip to next reg step in loop
-                continue;
-            }
-            // $check_all must be true, else we would never have gotten to this point
-            if ($slug === $reg_step_slug) {
-                // if we reach this point, then we are testing either:
-                // all_reg_steps_completed_except() or
-                // all_reg_steps_completed_except_final_step(),
-                // and since this is the reg step EXCEPTION being tested
-                // we want to return true (yes true) if this reg step is NOT completed
-                // ie: "is everything completed except the final step?"
-                // "that is correct... the final step is not completed, but all others are."
-                return $reg_step_completed !== true;
-            }
-            if ($reg_step_completed !== true) {
-                // if any reg step is NOT completed, then ALL steps are not completed
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed()
-    {
-        return $this->_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param string $exception
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except($exception = '')
-    {
-        return $this->_reg_steps_completed($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except_final_step()
-    {
-        return $this->_reg_steps_completed('finalize_registration');
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param string $reg_step_slug
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_step_completed($reg_step_slug)
-    {
-        return $this->_reg_steps_completed($reg_step_slug, false);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_reg_step_completed()
-    {
-        return $this->_reg_steps_completed('finalize_registration', false);
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_initiated($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, time());
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, true);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_not_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, false);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
-     *
-     * @param string      $reg_step_slug
-     * @param boolean|int $status
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_reg_step_completed_status($reg_step_slug, $status)
-    {
-        // validate status
-        $status = is_bool($status) || is_int($status) ? $status : false;
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
-            return false;
-        }
-        // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
-            return true;
-        }
-        // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
-            return false;
-        }
-        // if current status value matches the incoming value (no change)
-        // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
-            // this will happen in cases where multiple AJAX requests occur during the same step
-            return true;
-        }
-        // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
-            // skip the update below, but don't return FALSE so that errors won't be displayed
-            return true;
-        }
-        // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
-        $this->set_reg_steps($txn_reg_steps);
-        $this->save();
-        return true;
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param string $reg_step_slug
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_reg_step($reg_step_slug)
-    {
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
-        $this->set_reg_steps($txn_reg_steps);
-    }
-
-
-    /**
-     * toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param bool $save
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_failed_transaction_status($save = true)
-    {
-        // if TXN status is still set as "failed"...
-        if ($this->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->set_status(EEM_Transaction::abandoned_status_code);
-            if ($save) {
-                $this->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_abandoned_transaction_status()
-    {
-        // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-        $txn_status = $this->status_ID();
-        if (
-            $txn_status === EEM_Transaction::failed_status_code
-            || $txn_status === EEM_Transaction::abandoned_status_code
-        ) {
-            // if a contact record for the primary registrant has been created
-            if (
-                $this->primary_registration() instanceof EE_Registration
-                && $this->primary_registration()->attendee() instanceof EE_Attendee
-            ) {
-                $this->set_status(EEM_Transaction::incomplete_status_code);
-            } else {
-                // no contact record? yer abandoned!
-                $this->set_status(EEM_Transaction::abandoned_status_code);
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * checks if an Abandoned TXN has any related payments, and if so,
-     * updates the TXN status based on the amount paid
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function verify_abandoned_transaction_status()
-    {
-        if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
-            return;
-        }
-        $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Payment) {
-                    // kk this TXN should NOT be abandoned
-                    $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-                        EE_Error::add_attention(
-                            sprintf(
-                                esc_html__(
-                                    'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
-                                    'event_espresso'
-                                ),
-                                $this->ID(),
-                                $this->pretty_status()
-                            )
-                        );
-                    }
-                    // get final reg step status
-                    $finalized = $this->final_reg_step_completed();
-                    // if the 'finalize_registration' step has been initiated (has a timestamp)
-                    // but has not yet been fully completed (TRUE)
-                    if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-                        $this->set_reg_step_completed('finalize_registration');
-                        $this->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @since 4.10.4.p
-     */
-    public function recalculateLineItems()
-    {
-        $total_line_item = $this->total_line_item(false);
-        if ($total_line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
-            return EEH_Line_Item::apply_taxes($total_line_item, true);
-        }
-        return false;
-    }
+	/**
+	 * The length of time in seconds that a lock is applied before being considered expired.
+	 * It is not long because a transaction should only be locked for the duration of the request that locked it
+	 */
+	const LOCK_EXPIRATION = 2;
+
+	/**
+	 * txn status upon initial construction.
+	 *
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone
+	 *                                        (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		$txn        = $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+		if (! $has_object) {
+			$txn->set_old_txn_status($txn->status_ID());
+		}
+		return $txn;
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		$txn = new self($props_n_values, true, $timezone);
+		$txn->set_old_txn_status($txn->status_ID());
+		return $txn;
+	}
+
+
+	/**
+	 * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
+	 * If a lock has already been set, then we will attempt to remove it in case it has expired.
+	 * If that also fails, then an exception is thrown.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function lock()
+	{
+		// attempt to set lock, but if that fails...
+		if (! $this->add_extra_meta('lock', time(), true)) {
+			// then attempt to remove the lock in case it is expired
+			if ($this->_remove_expired_lock()) {
+				// if removal was successful, then try setting lock again
+				$this->lock();
+			} else {
+				// but if the lock can not be removed, then throw an exception
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
+							'event_espresso'
+						),
+						$this->ID()
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * removes transaction lock applied in EE_Transaction::lock()
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unlock()
+	{
+		return $this->delete_extra_meta('lock');
+	}
+
+
+	/**
+	 * Decides whether or not now is the right time to update the transaction.
+	 * This is useful because we don't always know if it is safe to update the transaction
+	 * and its related data. why?
+	 * because it's possible that the transaction is being used in another
+	 * request and could overwrite anything we save.
+	 * So we want to only update the txn once we know that won't happen.
+	 * We also check that the lock isn't expired, and remove it if it is
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_locked()
+	{
+		// if TXN is not locked, then return false immediately
+		if (! $this->_get_lock()) {
+			return false;
+		}
+		// if not, then let's try and remove the lock in case it's expired...
+		// _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
+		// and a positive number if the lock was removed (ie: number of locks deleted),
+		// so we need to return the opposite
+		return ! $this->_remove_expired_lock() ? true : false;
+	}
+
+
+	/**
+	 * Gets the meta field indicating that this TXN is locked
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_lock()
+	{
+		return (int) $this->get_extra_meta('lock', true, 0);
+	}
+
+
+	/**
+	 * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _remove_expired_lock()
+	{
+		$locked = $this->_get_lock();
+		if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
+			return $this->unlock();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * Set transaction total
+	 *
+	 * @param float $total total value of transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total = 0.00)
+	{
+		$this->set('TXN_total', (float) $total);
+	}
+
+
+	/**
+	 * Set Total Amount Paid to Date
+	 *
+	 * @param float $total_paid total amount paid to date (sum of all payments)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_paid($total_paid = 0.00)
+	{
+		$this->set('TXN_paid', (float) $total_paid);
+	}
+
+
+	/**
+	 * Set transaction status
+	 *
+	 * @param string $status        whether the transaction is open, declined, accepted,
+	 *                              or any number of custom values that can be set
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_status($status = '')
+	{
+		$this->set('STS_ID', $status);
+	}
+
+
+	/**
+	 * Set hash salt
+	 *
+	 * @param string $hash_salt required for some payment gateways
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_hash_salt($hash_salt = '')
+	{
+		$this->set('TXN_hash_salt', $hash_salt);
+	}
+
+
+	/**
+	 * Sets TXN_reg_steps array
+	 *
+	 * @param array $txn_reg_steps
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_steps(array $txn_reg_steps)
+	{
+		$this->set('TXN_reg_steps', $txn_reg_steps);
+	}
+
+
+	/**
+	 * Gets TXN_reg_steps
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_steps()
+	{
+		$TXN_reg_steps = $this->get('TXN_reg_steps');
+		return is_array($TXN_reg_steps) ? $TXN_reg_steps : [];
+	}
+
+
+	/**
+	 * @return string of transaction's total cost, with currency symbol and decimal
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_total()
+	{
+		return $this->get_pretty('TXN_total');
+	}
+
+
+	/**
+	 * Gets the amount paid in a pretty string (formatted and with currency symbol)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('TXN_paid');
+	}
+
+
+	/**
+	 * calculate the amount remaining for this transaction and return;
+	 *
+	 * @return float amount remaining
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remaining()
+	{
+		return $this->total() - $this->paid();
+	}
+
+
+	/**
+	 * get Transaction Total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return (float) $this->get('TXN_total');
+	}
+
+
+	/**
+	 * get Total Amount Paid to Date
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid()
+	{
+		return (float) $this->get('TXN_paid');
+	}
+
+
+	/**
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_cart_session()
+	{
+		$session_data = (array) $this->get('TXN_session_data');
+		return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
+			? $session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * get Transaction session data
+	 *
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function session_data()
+	{
+		$session_data = $this->get('TXN_session_data');
+		if (empty($session_data)) {
+			$session_data = [
+				'id'            => null,
+				'user_id'       => null,
+				'ip_address'    => null,
+				'user_agent'    => null,
+				'init_access'   => null,
+				'last_access'   => null,
+				'pages_visited' => [],
+			];
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * Set session data within the TXN object
+	 *
+	 * @param EE_Session|array $session_data
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_txn_session_data($session_data)
+	{
+		if ($session_data instanceof EE_Session) {
+			$this->set('TXN_session_data', $session_data->get_session_data(null, true));
+		} else {
+			$this->set('TXN_session_data', $session_data);
+		}
+	}
+
+
+	/**
+	 * get Transaction hash salt
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function hash_salt_()
+	{
+		return $this->get('TXN_hash_salt');
+	}
+
+
+	/**
+	 * Returns the transaction datetime as either:
+	 *            - unix timestamp format ($format = false, $gmt = true)
+	 *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
+	 *              has no affect with this option)), this also may include a timezone abbreviation if the
+	 *              set timezone in this class differs from what the timezone is on the blog.
+	 *            - formatted date string including the UTC (timezone) offset (default).
+	 *
+	 * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
+	 * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
+	 *                          or no UTC offset applied
+	 * @return string | int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime($format = false, $gmt = false)
+	{
+		if ($format) {
+			return $this->get_pretty('TXN_timestamp');
+		}
+		if ($gmt) {
+			return $this->get_raw('TXN_timestamp');
+		}
+		return $this->get('TXN_timestamp');
+	}
+
+
+	/**
+	 * Gets registrations on this transaction
+	 *
+	 * @param array   $query_params array of query parameters
+	 * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registrations($query_params = [], $get_cached = false)
+	{
+		$query_params = (empty($query_params) || ! is_array($query_params))
+			? [
+				'order_by' => [
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				],
+			]
+			: $query_params;
+		$query_params = $get_cached ? [] : $query_params;
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
+	 * function for getting attendees and how many registrations they each have for an event)
+	 *
+	 * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendees()
+	{
+		return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
+	}
+
+
+	/**
+	 * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = [])
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * gets only approved payments for this transaction
+	 *
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function approved_payments()
+	{
+		EE_Registry::instance()->load_model('Payment');
+		return $this->get_many_related(
+			'Payment',
+			[
+				['STS_ID' => EEM_Payment::status_id_approved],
+				'order_by' => ['PAY_timestamp' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all payments which have not been approved
+	 *
+	 * @return EE_Base_Class[]|EEI_Payment[]
+	 * @throws EE_Error if a model is misconfigured somehow
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pending_payments()
+	{
+		return $this->get_many_related(
+			'Payment',
+			[
+				[
+					'STS_ID' => EEM_Payment::status_id_pending,
+				],
+				'order_by' => [
+					'PAY_timestamp' => 'DESC',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$this->status_ID() => esc_html__('unknown', 'event_espresso')],
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Transaction::complete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
+				break;
+			case EEM_Transaction::incomplete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::abandoned_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::failed_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::overpaid_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 * get Transaction Status
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Returns TRUE or FALSE for whether or not this transaction cost any money
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_free()
+	{
+		return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
+	}
+
+
+	/**
+	 * Returns whether this transaction is complete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_completed()
+	{
+		return $this->status_ID() === EEM_Transaction::complete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is incomplete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Transaction::incomplete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is overpaid
+	 * Useful in templates and other logic for deciding if monies need to be refunded
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_overpaid()
+	{
+		return $this->status_ID() === EEM_Transaction::overpaid_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction was abandoned
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * but that contact information exists for at least one registrant
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_abandoned()
+	{
+		return $this->status_ID() === EEM_Transaction::abandoned_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction failed
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * and that NO contact information exists for any registrants
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function failed()
+	{
+		return $this->status_ID() === EEM_Transaction::failed_status_code;
+	}
+
+
+	/**
+	 * This returns the url for the invoice of this transaction
+	 *
+	 * @param string $type 'html' or 'pdf' (default is pdf)
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function invoice_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->invoice_url($type);
+	}
+
+
+	/**
+	 * Gets the primary registration only
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function primary_registration()
+	{
+		$registrations = (array) $this->get_many_related(
+			'Registration',
+			[['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
+		);
+		foreach ($registrations as $registration) {
+			// valid registration that is NOT cancelled or declined ?
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
+			) {
+				return $registration;
+			}
+		}
+		// nothing valid found, so just return first thing from array of results
+		return reset($registrations);
+	}
+
+
+	/**
+	 * Gets the URL for viewing the receipt
+	 *
+	 * @param string $type 'pdf' or 'html' (default is 'html')
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function receipt_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->receipt_url($type);
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url()
+	{
+		$primary_registration = $this->primary_registration();
+		return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function gateway_response_on_transaction()
+	{
+		$payment = $this->get_first_related('Payment');
+		return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function extra_meta($query_params = [])
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_registration(EE_Registration $registration)
+	{
+		return $this->_add_relation_to($registration, 'Registration');
+	}
+
+
+	/**
+	 * Removes the given registration from being related (even before saving this transaction).
+	 * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
+	 *
+	 * @param int $registration_or_id
+	 * @return EE_Base_Class that was removed from being related
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_registration_with_id($registration_or_id)
+	{
+		return $this->_remove_relation_to($registration_or_id, 'Registration');
+	}
+
+
+	/**
+	 * Gets all the line items which are for ACTUAL items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function items_purchased()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_line_item(EE_Line_Item $line_item)
+	{
+		return $this->_add_relation_to($line_item, 'Line_Item');
+	}
+
+
+	/**
+	 * Gets ALL the line items related to this transaction (unstructured)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function line_items($query_params = [])
+	{
+		return $this->get_many_related('Line_Item', $query_params);
+	}
+
+
+	/**
+	 * Gets all the line items which are taxes on the total
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_items()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other related line items,
+	 * meaning it takes them all into account on its total)
+	 *
+	 * @param bool $create_if_not_found
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
+	{
+		$item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
+		if ($item instanceof EE_Line_Item) {
+			return $item;
+		}
+		return $create_if_not_found ? EEH_Line_Item::create_total_line_item($this) : null;
+	}
+
+
+	/**
+	 * Returns the total amount of tax on this transaction
+	 * (assumes there's only one tax subtotal line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total()
+	{
+		$tax_line_item = $this->tax_total_line_item();
+		if ($tax_line_item) {
+			return (float) $tax_line_item->total();
+		}
+		return (float) 0;
+	}
+
+
+	/**
+	 * Gets the tax subtotal line item (assumes there's only one)
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total_line_item()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
+	}
+
+
+	/**
+	 * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function billing_info()
+	{
+		$payment_method = $this->payment_method();
+		if (! $payment_method) {
+			EE_Error::add_error(
+				esc_html__(
+					'Could not find billing info for transaction because no gateway has been used for it yet',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$primary_reg = $this->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because no primary registration exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $attendee->billing_info_for_payment_method($payment_method);
+	}
+
+
+	/**
+	 * Gets PMD_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method_ID()
+	{
+		return $this->get('PMD_ID');
+	}
+
+
+	/**
+	 * Sets PMD_ID
+	 *
+	 * @param int $PMD_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_payment_method_ID($PMD_ID)
+	{
+		$this->set('PMD_ID', $PMD_ID);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method()
+	{
+		$pm = $this->get_first_related('Payment_Method');
+		if ($pm instanceof EE_Payment_Method) {
+			return $pm;
+		}
+		$last_payment = $this->last_payment();
+		if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
+			return $last_payment->payment_method();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the last payment made
+	 *
+	 * @return EE_Base_Class|EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function last_payment()
+	{
+		return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
+	}
+
+
+	/**
+	 * Gets all the line items which are unrelated to tickets on this transaction
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function non_ticket_line_items()
+	{
+		return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
+	}
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @param boolean $update whether to save the TXN
+	 * @return bool whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_status_based_on_total_paid($update = true)
+	{
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
+			$new_txn_status = EEM_Transaction::overpaid_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
+			$new_txn_status = EEM_Transaction::complete_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
+			$new_txn_status = EEM_Transaction::incomplete_status_code;
+		} else {
+			throw new RuntimeException(
+				esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
+			);
+		}
+		if ($new_txn_status !== $this->status_ID()) {
+			$this->set_status($new_txn_status);
+			if ($update) {
+				return (bool) $this->save();
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the transaction's status and total_paid based on all the payments
+	 * that apply to it
+	 *
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated
+	 */
+	public function update_based_on_payments()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_status_updated()
+	{
+		return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
+	}
+
+
+	/**
+	 * _reg_steps_completed
+	 * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
+	 * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
+	 * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
+	 *
+	 * @param string $reg_step_slug
+	 * @param bool   $check_all
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
+	{
+		$reg_steps = $this->reg_steps();
+		if (! is_array($reg_steps) || empty($reg_steps)) {
+			return false;
+		}
+		// loop thru reg steps array)
+		foreach ($reg_steps as $slug => $reg_step_completed) {
+			// if NOT checking ALL steps (only checking one step)
+			if (! $check_all) {
+				// and this is the one
+				if ($slug === $reg_step_slug) {
+					return $reg_step_completed;
+				}
+				// skip to next reg step in loop
+				continue;
+			}
+			// $check_all must be true, else we would never have gotten to this point
+			if ($slug === $reg_step_slug) {
+				// if we reach this point, then we are testing either:
+				// all_reg_steps_completed_except() or
+				// all_reg_steps_completed_except_final_step(),
+				// and since this is the reg step EXCEPTION being tested
+				// we want to return true (yes true) if this reg step is NOT completed
+				// ie: "is everything completed except the final step?"
+				// "that is correct... the final step is not completed, but all others are."
+				return $reg_step_completed !== true;
+			}
+			if ($reg_step_completed !== true) {
+				// if any reg step is NOT completed, then ALL steps are not completed
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed()
+	{
+		return $this->_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param string $exception
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except($exception = '')
+	{
+		return $this->_reg_steps_completed($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except_final_step()
+	{
+		return $this->_reg_steps_completed('finalize_registration');
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param string $reg_step_slug
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_step_completed($reg_step_slug)
+	{
+		return $this->_reg_steps_completed($reg_step_slug, false);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_reg_step_completed()
+	{
+		return $this->_reg_steps_completed('finalize_registration', false);
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_initiated($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, time());
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, true);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_not_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, false);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
+	 *
+	 * @param string      $reg_step_slug
+	 * @param boolean|int $status
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_reg_step_completed_status($reg_step_slug, $status)
+	{
+		// validate status
+		$status = is_bool($status) || is_int($status) ? $status : false;
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		// if reg step does NOT exist
+		if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+			return false;
+		}
+		// if  we're trying to complete a step that is already completed
+		if ($txn_reg_steps[ $reg_step_slug ] === true) {
+			return true;
+		}
+		// if  we're trying to complete a step that hasn't even started
+		if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+			return false;
+		}
+		// if current status value matches the incoming value (no change)
+		// type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
+		if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+			// this will happen in cases where multiple AJAX requests occur during the same step
+			return true;
+		}
+		// if we're trying to set a start time, but it has already been set...
+		if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+			// skip the update below, but don't return FALSE so that errors won't be displayed
+			return true;
+		}
+		// update completed status
+		$txn_reg_steps[ $reg_step_slug ] = $status;
+		$this->set_reg_steps($txn_reg_steps);
+		$this->save();
+		return true;
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param string $reg_step_slug
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_reg_step($reg_step_slug)
+	{
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		unset($txn_reg_steps[ $reg_step_slug ]);
+		$this->set_reg_steps($txn_reg_steps);
+	}
+
+
+	/**
+	 * toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param bool $save
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_failed_transaction_status($save = true)
+	{
+		// if TXN status is still set as "failed"...
+		if ($this->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->set_status(EEM_Transaction::abandoned_status_code);
+			if ($save) {
+				$this->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_abandoned_transaction_status()
+	{
+		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
+		$txn_status = $this->status_ID();
+		if (
+			$txn_status === EEM_Transaction::failed_status_code
+			|| $txn_status === EEM_Transaction::abandoned_status_code
+		) {
+			// if a contact record for the primary registrant has been created
+			if (
+				$this->primary_registration() instanceof EE_Registration
+				&& $this->primary_registration()->attendee() instanceof EE_Attendee
+			) {
+				$this->set_status(EEM_Transaction::incomplete_status_code);
+			} else {
+				// no contact record? yer abandoned!
+				$this->set_status(EEM_Transaction::abandoned_status_code);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * checks if an Abandoned TXN has any related payments, and if so,
+	 * updates the TXN status based on the amount paid
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function verify_abandoned_transaction_status()
+	{
+		if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
+			return;
+		}
+		$payments = $this->get_many_related('Payment');
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Payment) {
+					// kk this TXN should NOT be abandoned
+					$this->update_status_based_on_total_paid();
+					if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+						EE_Error::add_attention(
+							sprintf(
+								esc_html__(
+									'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
+									'event_espresso'
+								),
+								$this->ID(),
+								$this->pretty_status()
+							)
+						);
+					}
+					// get final reg step status
+					$finalized = $this->final_reg_step_completed();
+					// if the 'finalize_registration' step has been initiated (has a timestamp)
+					// but has not yet been fully completed (TRUE)
+					if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+						$this->set_reg_step_completed('finalize_registration');
+						$this->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @since 4.10.4.p
+	 */
+	public function recalculateLineItems()
+	{
+		$total_line_item = $this->total_line_item(false);
+		if ($total_line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
+			return EEH_Line_Item::apply_taxes($total_line_item, true);
+		}
+		return false;
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -46,7 +46,7 @@ 
         $txn        = $has_object
             ? $has_object
             : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
+        if ( ! $has_object) {
             $txn->set_old_txn_status($txn->status_ID());
         }
         return $txn;
@@ -86,7 +86,7 @@ 
     public function lock()
     {
         // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
+        if ( ! $this->add_extra_meta('lock', time(), true)) {
             // then attempt to remove the lock in case it is expired
             if ($this->_remove_expired_lock()) {
                 // if removal was successful, then try setting lock again
@@ -142,7 +142,7 @@ 
     public function is_locked()
     {
         // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
+        if ( ! $this->_get_lock()) {
             return false;
         }
         // if not, then let's try and remove the lock in case it's expired...
@@ -622,7 +622,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case EEM_Transaction::complete_status_code:
                 $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
@@ -641,7 +641,7 @@ 
                 $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -779,7 +779,7 @@ 
     public function invoice_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->invoice_url($type);
@@ -831,7 +831,7 @@ 
     public function receipt_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->receipt_url($type);
@@ -1078,7 +1078,7 @@ 
     public function billing_info()
     {
         $payment_method = $this->payment_method();
-        if (! $payment_method) {
+        if ( ! $payment_method) {
             EE_Error::add_error(
                 esc_html__(
                     'Could not find billing info for transaction because no gateway has been used for it yet',
@@ -1091,7 +1091,7 @@ 
             return null;
         }
         $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot get billing info for gateway %s on transaction because no primary registration exists',
@@ -1104,7 +1104,7 @@ 
             return null;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
@@ -1261,7 +1261,7 @@ 
     public function update_based_on_payments()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -1329,13 +1329,13 @@ 
     private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
     {
         $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
+        if ( ! is_array($reg_steps) || empty($reg_steps)) {
             return false;
         }
         // loop thru reg steps array)
         foreach ($reg_steps as $slug => $reg_step_completed) {
             // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
+            if ( ! $check_all) {
                 // and this is the one
                 if ($slug === $reg_step_slug) {
                     return $reg_step_completed;
@@ -1538,30 +1538,30 @@ 
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
         // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+        if ( ! isset($txn_reg_steps[$reg_step_slug])) {
             return false;
         }
         // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
+        if ($txn_reg_steps[$reg_step_slug] === true) {
             return true;
         }
         // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+        if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
             return false;
         }
         // if current status value matches the incoming value (no change)
         // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+        if ((int) $txn_reg_steps[$reg_step_slug] === (int) $status) {
             // this will happen in cases where multiple AJAX requests occur during the same step
             return true;
         }
         // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+        if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
             // skip the update below, but don't return FALSE so that errors won't be displayed
             return true;
         }
         // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
+        $txn_reg_steps[$reg_step_slug] = $status;
         $this->set_reg_steps($txn_reg_steps);
         $this->save();
         return true;
@@ -1585,7 +1585,7 @@ 
     {
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
+        unset($txn_reg_steps[$reg_step_slug]);
         $this->set_reg_steps($txn_reg_steps);
     }
 
@@ -1670,12 +1670,12 @@ 
             return;
         }
         $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Payment) {
                     // kk this TXN should NOT be abandoned
                     $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+                    if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
                         EE_Error::add_attention(
                             sprintf(
                                 esc_html__(

core/db_classes/EE_Registration.class.php

Indentation +2484 added lines, -2484 removed lines

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

Spacing +16 added lines, -16 removed lines

@@ -133,7 +133,7 @@ 
     {
         switch ($field_name) {
             case 'REG_code':
-                if (! empty($field_value) && $this->reg_code() === null) {
+                if ( ! empty($field_value) && $this->reg_code() === null) {
                     $this->set_reg_code($field_value, $use_default);
                 }
                 break;
@@ -434,7 +434,7 @@ 
     public function event()
     {
         $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new EntityNotFoundException('Event ID', $this->event_ID());
         }
         return $event;
@@ -481,7 +481,7 @@ 
     {
         // reserved ticket and datetime counts will be decremented as sold counts are incremented
         // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:".__LINE__.')');
         $ticket = $this->ticket();
         $ticket->increaseSold();
         // possibly set event status to sold out
@@ -531,7 +531,7 @@ 
             $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
             if ($reserved && $update_ticket) {
                 $ticket = $this->ticket();
-                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:".__LINE__.')');
                 $this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
                 $ticket->save();
             }
@@ -559,7 +559,7 @@ 
             $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, false);
             if ($reserved && $update_ticket) {
                 $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:".__LINE__.')');
                 $this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
             }
         }
@@ -1445,7 +1445,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1701,7 +1701,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
         // first check registration status
-        if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
+        if ( ! $DTT_ID || ($check_approved && ! $this->is_approved())) {
             return false;
         }
         // is there a datetime ticket that matches this dtt_ID?
@@ -1741,7 +1741,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1749,7 +1749,7 @@ 
 
         // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
         // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
+        if ( ! $max_uses || $max_uses === EE_INF) {
             return true;
         }
 
@@ -1813,7 +1813,7 @@ 
             $datetime = $this->get_latest_related_datetime();
             $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
             // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
+        } elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1836,7 +1836,7 @@ 
         );
         // start by getting the current status so we know what status we'll be changing to.
         $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-        $status_to = $status_paths[ $cur_status ];
+        $status_to = $status_paths[$cur_status];
         // database only records true for checked IN or false for checked OUT
         // no record ( null ) means checked in NEVER, but we obviously don't save that
         $new_status = $status_to === EE_Checkin::status_checked_in;
@@ -1957,7 +1957,7 @@ 
                 'order_by' => ['CHK_timestamp' => 'DESC'],
             ]
         );
-        return $checkin instanceof EE_Checkin ? $checkin->status() :  EE_Checkin::status_checked_never;
+        return $checkin instanceof EE_Checkin ? $checkin->status() : EE_Checkin::status_checked_never;
     }
 
 
@@ -2012,7 +2012,7 @@ 
     public function transaction(): EE_Transaction
     {
         $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
+        if ( ! $transaction instanceof \EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
         }
         return $transaction;
@@ -2085,11 +2085,11 @@ 
             );
             return;
         }
-        if (! $this->reg_code()) {
+        if ( ! $this->reg_code()) {
             parent::set('REG_code', $REG_code, $use_default);
         } else {
             EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
+                __CLASS__.'::'.__FUNCTION__,
                 esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -2280,7 +2280,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

caffeinated/admin/new/pricing/Pricing_Admin_Page.core.php

Indentation +1275 added lines, -1275 removed lines

@@ -11,1286 +11,1286 @@
  */
 class Pricing_Admin_Page extends EE_Admin_Page
 {
-    protected function _init_page_props()
-    {
-        $this->page_slug        = PRICING_PG_SLUG;
-        $this->page_label       = PRICING_LABEL;
-        $this->_admin_base_url  = PRICING_ADMIN_URL;
-        $this->_admin_base_path = PRICING_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_update_prices_order', [$this, 'update_price_order']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = PRICING_LABEL;
-        $this->_labels           = [
-            'buttons' => [
-                'add'         => esc_html__('Add New Default Price', 'event_espresso'),
-                'edit'        => esc_html__('Edit Default Price', 'event_espresso'),
-                'delete'      => esc_html__('Delete Default Price', 'event_espresso'),
-                'add_type'    => esc_html__('Add New Default Price Type', 'event_espresso'),
-                'edit_type'   => esc_html__('Edit Price Type', 'event_espresso'),
-                'delete_type' => esc_html__('Delete Price Type', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * an array for storing request actions and their corresponding methods
-     *
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $PRC_ID             = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
-        $PRT_ID             = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-        $this->_page_routes = [
-            'default'                     => [
-                'func'       => [$this, '_price_overview_list_table'],
-                'capability' => 'ee_read_default_prices',
-            ],
-            'add_new_price'               => [
-                'func'       => [$this, '_edit_price_details'],
-                'capability' => 'ee_edit_default_prices',
-            ],
-            'edit_price'                  => [
-                'func'       => [$this, '_edit_price_details'],
-                'capability' => 'ee_edit_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'insert_price'                => [
-                'func'       => [$this, '_insert_or_update_price'],
-                'args'       => ['insert' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_prices',
-            ],
-            'update_price'                => [
-                'func'       => [$this, '_insert_or_update_price'],
-                'args'       => ['insert' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'trash_price'                 => [
-                'func'       => [$this, '_trash_or_restore_price'],
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'restore_price'               => [
-                'func'       => [$this, '_trash_or_restore_price'],
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'delete_price'                => [
-                'func'       => [$this, '_delete_price'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price',
-                'obj_id'     => $PRC_ID,
-            ],
-            'espresso_update_price_order' => [
-                'func'       => [$this, 'update_price_order'],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_prices',
-            ],
-            // price types
-            'price_types'                 => [
-                'func'       => [$this, '_price_types_overview_list_table'],
-                'capability' => 'ee_read_default_price_types',
-            ],
-            'add_new_price_type'          => [
-                'func'       => [$this, '_edit_price_type_details'],
-                'capability' => 'ee_edit_default_price_types',
-            ],
-            'edit_price_type'             => [
-                'func'       => [$this, '_edit_price_type_details'],
-                'capability' => 'ee_edit_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'insert_price_type'           => [
-                'func'       => [$this, '_insert_or_update_price_type'],
-                'args'       => ['new_price_type' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price_types',
-            ],
-            'update_price_type'           => [
-                'func'       => [$this, '_insert_or_update_price_type'],
-                'args'       => ['new_price_type' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'trash_price_type'            => [
-                'func'       => [$this, '_trash_or_restore_price_type'],
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'restore_price_type'          => [
-                'func'       => [$this, '_trash_or_restore_price_type'],
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'delete_price_type'           => [
-                'func'       => [$this, '_delete_price_type'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_default_price_type',
-                'obj_id'     => $PRT_ID,
-            ],
-            'tax_settings'                => [
-                'func'       => [$this, '_tax_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_tax_settings'         => [
-                'func'       => [$this, '_update_tax_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $PRC_ID             = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        $this->_page_config = [
-            'default'            => [
-                'nav'           => [
-                    'label' => esc_html__('Default Pricing', 'event_espresso'),
-                    'icon' => 'dashicons-money-alt',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Prices_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'pricing_default_pricing_help_tab'                           => [
-                        'title'    => esc_html__('Default Pricing', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing',
-                    ],
-                    'pricing_default_pricing_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Default Pricing Table Column Headings', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing_table_column_headings',
-                    ],
-                    'pricing_default_pricing_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Default Pricing Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'pricing_default_pricing_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'add_new_price'      => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Default Price', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 20,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_new_default_price_help_tab' => [
-                        'title'    => esc_html__('Add New Default Price', 'event_espresso'),
-                        'filename' => 'pricing_add_new_default_price',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'edit_price'         => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Default Price', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 20,
-                    'url'        => $PRC_ID
-                        ? add_query_arg(['id' => $PRC_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'help_tabs'     => [
-                    'edit_default_price_help_tab' => [
-                        'title'    => esc_html__('Edit Default Price', 'event_espresso'),
-                        'filename' => 'pricing_edit_default_price',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'price_types'        => [
-                'nav'           => [
-                    'label' => esc_html__('Price Types', 'event_espresso'),
-                    'icon' => 'dashicons-networking',
-                    'order' => 30,
-                ],
-                'list_table'    => 'Price_Types_List_Table',
-                'help_tabs'     => [
-                    'pricing_price_types_help_tab'                           => [
-                        'title'    => esc_html__('Price Types', 'event_espresso'),
-                        'filename' => 'pricing_price_types',
-                    ],
-                    'pricing_price_types_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Price Types Table Column Headings', 'event_espresso'),
-                        'filename' => 'pricing_price_types_table_column_headings',
-                    ],
-                    'pricing_price_types_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Price Types Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'pricing_price_types_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'add_new_price_type' => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Price Type', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 40,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_new_price_type_help_tab' => [
-                        'title'    => esc_html__('Add New Price Type', 'event_espresso'),
-                        'filename' => 'pricing_add_new_price_type',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'edit_price_type'    => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Price Type', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 40,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'edit_price_type_help_tab' => [
-                        'title'    => esc_html__('Edit Price Type', 'event_espresso'),
-                        'filename' => 'pricing_edit_price_type',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => false,
-            ],
-            'tax_settings'       => [
-                'nav' => [
-                    'label' => esc_html__('Tax Settings', 'event_espresso'),
-                    'icon' => 'dashicons-sticky',
-                    'order' => 50,
-                ],
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Tax Settings', 'event_espresso'),
-                ],
-                'metaboxes'     => array_merge(
-                    ['_publish_post_box'],
-                    $this->_default_espresso_metaboxes
-                ),
-                'require_nonce' => true,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_price_types()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Price Types', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_PRICING',
-            PRICING_ASSETS_URL . 'espresso_pricing_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_PRICING');
-
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('jquery-ui-position');
-        wp_enqueue_script('jquery-ui-widget');
-        wp_register_script(
-            'espresso_PRICING',
-            PRICING_ASSETS_URL . 'espresso_pricing_admin.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_PRICING');
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('espresso_ajax_table_sorting');
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Default Pricing', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_price' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed'] = [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_price' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_price'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_price_types()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_price_type' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_default_price_types',
-                'pricing_trash_price_type'
-            )
-        ) {
-            $this->_views['trashed'] = [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_price_type' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_price_type'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * generates HTML for main Prices Admin page
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _price_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_new_price',
-            'add',
-            [],
-            'add-new-h2'
-        );
-        $this->_admin_page_title .= $this->_learn_more_about_pricing_link();
-        $this->_search_btn_label = esc_html__('Default Prices', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * retrieve data for Prices List table
-     *
-     * @param int  $per_page how many prices displayed per page
-     * @param bool $count    return the count or objects
-     * @param bool $trashed  whether the current view is of the trash can - eww yuck!
-     * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_prices_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
-    {
-        // start with an empty array
-        $event_pricing = [];
-
-        require_once(PRICING_ADMIN . 'Prices_List_Table.class.php');
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-
-        switch ($orderby) {
-            case 'name':
-                $orderby = ['PRC_name' => $order];
-                break;
-            case 'type':
-                $orderby = ['Price_Type.PRT_name' => $order];
-                break;
-            case 'amount':
-                $orderby = ['PRC_amount' => $order];
-                break;
-            default:
-                $orderby = ['PRC_order' => $order, 'Price_Type.PRT_order' => $order, 'PRC_ID' => $order];
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
-
-        $where = [
-            'PRC_is_default' => 1,
-            'PRC_deleted'    => $trashed,
-        ];
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = "%{$search_term}%";
-            $where['OR'] = [
-                'PRC_name'            => ['LIKE', $search_term],
-                'PRC_desc'            => ['LIKE', $search_term],
-                'PRC_amount'          => ['LIKE', $search_term],
-                'Price_Type.PRT_name' => ['LIKE', $search_term],
-            ];
-        }
-
-        $query_params = [
-            $where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-            'group_by' => 'PRC_ID',
-        ];
-
-        if ($count) {
-            return $trashed
-                ? EEM_Price::instance()->count([$where])
-                : EEM_Price::instance()->count_deleted_and_undeleted([$where]);
-        }
-        return EEM_Price::instance()->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_price_details()
-    {
-        // grab price ID
-        $PRC_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        // change page title based on request action
-        switch ($this->_req_action) {
-            case 'add_new_price':
-                $this->_admin_page_title = esc_html__('Add New Price', 'event_espresso');
-                break;
-            case 'edit_price':
-                $this->_admin_page_title = esc_html__('Edit Price', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add PRC_ID to title if editing
-        $this->_admin_page_title = $PRC_ID ? $this->_admin_page_title . ' # ' . $PRC_ID : $this->_admin_page_title;
-
-        if ($PRC_ID) {
-            $price                    = EEM_Price::instance()->get_one_by_ID($PRC_ID);
-            $additional_hidden_fields = [
-                'PRC_ID' => ['type' => 'hidden', 'value' => $PRC_ID],
-            ];
-            $this->_set_add_edit_form_tags('update_price', $additional_hidden_fields);
-        } else {
-            $price = EEM_Price::instance()->get_new_price();
-            $this->_set_add_edit_form_tags('insert_price');
-        }
-
-        if (! $price instanceof EE_Price) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'A valid Price could not be retrieved from the database with ID: %1$s',
-                        'event_espresso'
-                    ),
-                    $PRC_ID
-                )
-            );
-        }
-
-        $this->_template_args['PRC_ID'] = $PRC_ID;
-        $this->_template_args['price']  = $price;
-
-        $default_base_price = $price->type_obj() && $price->type_obj()->base_type() === 1;
-
-        $this->_template_args['default_base_price'] = $default_base_price;
-
-        // get price types
-        $price_types = EEM_Price_Type::instance()->get_all([['PBT_ID' => ['!=', 1]]]);
-        if (empty($price_types)) {
-            $msg = esc_html__(
-                'You have no price types defined. Please add a price type before adding a price.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->display_admin_page_with_sidebar();
-        }
-        $attributes       = [];
-        $price_type_names = [];
-        $attributes[]     = 'id="PRT_ID"';
-        if ($default_base_price) {
-            $attributes[]       = 'disabled="disabled"';
-            $price_type_names[] = ['id' => 1, 'text' => esc_html__('Base Price', 'event_espresso')];
-        }
-        foreach ($price_types as $type) {
-            $price_type_names[] = ['id' => $type->ID(), 'text' => $type->name()];
-        }
-        $this->_template_args['attributes']  = implode(' ', $attributes);
-        $this->_template_args['price_types'] = $price_type_names;
-
-        $this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
-        $this->_template_args['admin_page_content']            = $this->_edit_price_details_meta_box();
-
-        $this->_set_publish_post_box_vars('id', $PRC_ID);
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *
-     * @return string
-     */
-    public function _edit_price_details_meta_box(): string
-    {
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'pricing_details_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function set_price_column_values(): array
-    {
-        $PRC_order = 0;
-        $PRT_ID    = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-        if ($PRT_ID) {
-            /** @var EE_Price_Type $price_type */
-            $price_type = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
-            if ($price_type instanceof EE_Price_Type) {
-                $PRC_order = $price_type->order();
-            }
-        }
-        return [
-            'PRT_ID'         => $PRT_ID,
-            'PRC_amount'     => $this->request->getRequestParam('PRC_amount', 0, DataType::FLOAT),
-            'PRC_name'       => $this->request->getRequestParam('PRC_name'),
-            'PRC_desc'       => $this->request->getRequestParam('PRC_desc'),
-            'PRC_is_default' => 1,
-            'PRC_overrides'  => null,
-            'PRC_order'      => $PRC_order,
-            'PRC_deleted'    => 0,
-            'PRC_parent'     => 0,
-        ];
-    }
-
-
-    /**
-     * @param bool $insert - whether to insert or update
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_price(bool $insert = false)
-    {
-        // why be so pessimistic ???  : (
-        $updated = 0;
-
-        $set_column_values = $this->set_price_column_values();
-        // is this a new Price ?
-        if ($insert) {
-            // run the insert
-            $PRC_ID = EEM_Price::instance()->insert($set_column_values);
-            if ($PRC_ID) {
-                // make sure this new price modifier is attached to the ticket but ONLY if it is not a tax type
-                $price = EEM_price::instance()->get_one_by_ID($PRC_ID);
-                if (
-                    $price instanceof EE_Price
-                    && $price->type_obj() instanceof EE_Price_type
-                    && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax
-                ) {
-                    $ticket = EEM_Ticket::instance()->get_one_by_ID(1);
-                    $ticket->_add_relation_to($price, 'Price');
-                    $ticket->save();
-                }
-                $updated = 1;
-            }
-            $action_desc = 'created';
-        } else {
-            $PRC_ID = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
-            // run the update
-            $where_cols_n_values = ['PRC_ID' => $PRC_ID];
-            $updated             = EEM_Price::instance()->update($set_column_values, [$where_cols_n_values]);
-
-            $price = EEM_Price::instance()->get_one_by_ID($PRC_ID);
-            if ($price instanceof EE_Price && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax) {
-                // if this is $PRC_ID == 1,
-                // then we need to update the default ticket attached to this price so the TKT_price value is updated.
-                if ($PRC_ID === 1) {
-                    $ticket = $price->get_first_related('Ticket');
-                    if ($ticket) {
-                        $ticket->set('TKT_price', $price->get('PRC_amount'));
-                        $ticket->set('TKT_name', $price->get('PRC_name'));
-                        $ticket->set('TKT_description', $price->get('PRC_desc'));
-                        $ticket->save();
-                    }
-                } else {
-                    // we make sure this price is attached to base ticket. but ONLY if its not a tax ticket type.
-                    $ticket = EEM_Ticket::instance()->get_one_by_ID(1);
-                    $ticket->_add_relation_to($PRC_ID, 'Price');
-                    $ticket->save();
-                }
-            }
-
-            $action_desc = 'updated';
-        }
-
-        $query_args = ['action' => 'edit_price', 'id' => $PRC_ID];
-
-        $this->_redirect_after_action($updated, 'Prices', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_price($trash = true)
-    {
-        $entity_model = EEM_Price::instance();
-        $action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
-        $result       = $this->trashRestoreDeleteEntities(
-            $entity_model,
-            'id',
-            $action,
-            'PRC_deleted',
-            [$this, 'adjustTicketRelations']
-        );
-
-        if ($result) {
-            $msg = $trash
-                ? esc_html(
-                    _n(
-                        'The Price has been trashed',
-                        'The Prices have been trashed',
-                        $result,
-                        'event_espresso'
-                    )
-                )
-                : esc_html(
-                    _n(
-                        'The Price has been restored',
-                        'The Prices have been restored',
-                        $result,
-                        'event_espresso'
-                    )
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(
-            $result,
-            _n('Price', 'Prices', $result, 'event_espresso'),
-            $trash ? 'trashed' : 'restored',
-            ['action' => 'default'],
-            true
-        );
-    }
-
-
-    /**
-     * @param EEM_Base   $entity_model
-     * @param int|string $entity_ID
-     * @param string     $action
-     * @param int        $result
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.30.p
-     */
-    public function adjustTicketRelations(
-        EEM_Base $entity_model,
-        $entity_ID,
-        string $action,
-        int $result
-    ) {
-        if (! $entity_ID || (float) $result < 1) {
-            return;
-        }
-
-        $entity = $entity_model->get_one_by_ID($entity_ID);
-        if (! $entity instanceof EE_Price || $entity->type_obj()->base_type() === EEM_Price_Type::base_type_tax) {
-            return;
-        }
-
-        // get default tickets for updating
-        $default_tickets = EEM_Ticket::instance()->get_all_default_tickets();
-        foreach ($default_tickets as $default_ticket) {
-            if (! $default_ticket instanceof EE_Ticket) {
-                continue;
-            }
-            switch ($action) {
-                case EE_Admin_List_Table::ACTION_DELETE:
-                case EE_Admin_List_Table::ACTION_TRASH:
-                    // if trashing then remove relations to base default ticket.
-                    $default_ticket->_remove_relation_to($entity_ID, 'Price');
-                    break;
-                case EE_Admin_List_Table::ACTION_RESTORE:
-                    // if restoring then add back to base default ticket
-                    $default_ticket->_add_relation_to($entity_ID, 'Price');
-                    break;
-            }
-            $default_ticket->save();
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_price()
-    {
-        $entity_model = EEM_Price::instance();
-        $deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
-        $entity       = $entity_model->item_name($deleted);
-        $this->_redirect_after_action(
-            $deleted,
-            $entity,
-            'deleted',
-            ['action' => 'default']
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_price_order()
-    {
-        // grab our row IDs
-        $row_ids = $this->request->getRequestParam('row_ids', '');
-        $row_ids = explode(',', rtrim($row_ids, ','));
-
-        $all_updated = true;
-        foreach ($row_ids as $i => $row_id) {
-            // Update the prices when re-ordering
-            $fields_n_values = ['PRC_order' => $i + 1];
-            $query_params    = [['PRC_ID' => absint($row_id)]];
-            // any failure will toggle $all_updated to false
-            $all_updated = $row_id && EEM_Price::instance()->update($fields_n_values, $query_params) !== false
-                ? $all_updated
-                : false;
-        }
-        $success = $all_updated
-            ? esc_html__('Price order was updated successfully.', 'event_espresso')
-            : false;
-        $errors  = ! $all_updated
-            ? esc_html__('An error occurred. The price order was not updated.', 'event_espresso')
-            : false;
-
-        echo wp_json_encode(['return_data' => false, 'success' => $success, 'errors' => $errors]);
-        die();
-    }
-
-
-    /******************************************************************************************************************
+	protected function _init_page_props()
+	{
+		$this->page_slug        = PRICING_PG_SLUG;
+		$this->page_label       = PRICING_LABEL;
+		$this->_admin_base_url  = PRICING_ADMIN_URL;
+		$this->_admin_base_path = PRICING_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_update_prices_order', [$this, 'update_price_order']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = PRICING_LABEL;
+		$this->_labels           = [
+			'buttons' => [
+				'add'         => esc_html__('Add New Default Price', 'event_espresso'),
+				'edit'        => esc_html__('Edit Default Price', 'event_espresso'),
+				'delete'      => esc_html__('Delete Default Price', 'event_espresso'),
+				'add_type'    => esc_html__('Add New Default Price Type', 'event_espresso'),
+				'edit_type'   => esc_html__('Edit Price Type', 'event_espresso'),
+				'delete_type' => esc_html__('Delete Price Type', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * an array for storing request actions and their corresponding methods
+	 *
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$PRC_ID             = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
+		$PRT_ID             = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+		$this->_page_routes = [
+			'default'                     => [
+				'func'       => [$this, '_price_overview_list_table'],
+				'capability' => 'ee_read_default_prices',
+			],
+			'add_new_price'               => [
+				'func'       => [$this, '_edit_price_details'],
+				'capability' => 'ee_edit_default_prices',
+			],
+			'edit_price'                  => [
+				'func'       => [$this, '_edit_price_details'],
+				'capability' => 'ee_edit_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'insert_price'                => [
+				'func'       => [$this, '_insert_or_update_price'],
+				'args'       => ['insert' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_prices',
+			],
+			'update_price'                => [
+				'func'       => [$this, '_insert_or_update_price'],
+				'args'       => ['insert' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'trash_price'                 => [
+				'func'       => [$this, '_trash_or_restore_price'],
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'restore_price'               => [
+				'func'       => [$this, '_trash_or_restore_price'],
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'delete_price'                => [
+				'func'       => [$this, '_delete_price'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price',
+				'obj_id'     => $PRC_ID,
+			],
+			'espresso_update_price_order' => [
+				'func'       => [$this, 'update_price_order'],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_prices',
+			],
+			// price types
+			'price_types'                 => [
+				'func'       => [$this, '_price_types_overview_list_table'],
+				'capability' => 'ee_read_default_price_types',
+			],
+			'add_new_price_type'          => [
+				'func'       => [$this, '_edit_price_type_details'],
+				'capability' => 'ee_edit_default_price_types',
+			],
+			'edit_price_type'             => [
+				'func'       => [$this, '_edit_price_type_details'],
+				'capability' => 'ee_edit_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'insert_price_type'           => [
+				'func'       => [$this, '_insert_or_update_price_type'],
+				'args'       => ['new_price_type' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price_types',
+			],
+			'update_price_type'           => [
+				'func'       => [$this, '_insert_or_update_price_type'],
+				'args'       => ['new_price_type' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'trash_price_type'            => [
+				'func'       => [$this, '_trash_or_restore_price_type'],
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'restore_price_type'          => [
+				'func'       => [$this, '_trash_or_restore_price_type'],
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'delete_price_type'           => [
+				'func'       => [$this, '_delete_price_type'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_default_price_type',
+				'obj_id'     => $PRT_ID,
+			],
+			'tax_settings'                => [
+				'func'       => [$this, '_tax_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_tax_settings'         => [
+				'func'       => [$this, '_update_tax_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$PRC_ID             = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		$this->_page_config = [
+			'default'            => [
+				'nav'           => [
+					'label' => esc_html__('Default Pricing', 'event_espresso'),
+					'icon' => 'dashicons-money-alt',
+					'order' => 10,
+				],
+				'list_table'    => 'Prices_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'pricing_default_pricing_help_tab'                           => [
+						'title'    => esc_html__('Default Pricing', 'event_espresso'),
+						'filename' => 'pricing_default_pricing',
+					],
+					'pricing_default_pricing_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Default Pricing Table Column Headings', 'event_espresso'),
+						'filename' => 'pricing_default_pricing_table_column_headings',
+					],
+					'pricing_default_pricing_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Default Pricing Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'pricing_default_pricing_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'add_new_price'      => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Default Price', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 20,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_new_default_price_help_tab' => [
+						'title'    => esc_html__('Add New Default Price', 'event_espresso'),
+						'filename' => 'pricing_add_new_default_price',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'edit_price'         => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Default Price', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 20,
+					'url'        => $PRC_ID
+						? add_query_arg(['id' => $PRC_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'help_tabs'     => [
+					'edit_default_price_help_tab' => [
+						'title'    => esc_html__('Edit Default Price', 'event_espresso'),
+						'filename' => 'pricing_edit_default_price',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'price_types'        => [
+				'nav'           => [
+					'label' => esc_html__('Price Types', 'event_espresso'),
+					'icon' => 'dashicons-networking',
+					'order' => 30,
+				],
+				'list_table'    => 'Price_Types_List_Table',
+				'help_tabs'     => [
+					'pricing_price_types_help_tab'                           => [
+						'title'    => esc_html__('Price Types', 'event_espresso'),
+						'filename' => 'pricing_price_types',
+					],
+					'pricing_price_types_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Price Types Table Column Headings', 'event_espresso'),
+						'filename' => 'pricing_price_types_table_column_headings',
+					],
+					'pricing_price_types_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Price Types Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'pricing_price_types_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'add_new_price_type' => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Price Type', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 40,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_new_price_type_help_tab' => [
+						'title'    => esc_html__('Add New Price Type', 'event_espresso'),
+						'filename' => 'pricing_add_new_price_type',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'edit_price_type'    => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Price Type', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 40,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'edit_price_type_help_tab' => [
+						'title'    => esc_html__('Edit Price Type', 'event_espresso'),
+						'filename' => 'pricing_edit_price_type',
+					],
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => false,
+			],
+			'tax_settings'       => [
+				'nav' => [
+					'label' => esc_html__('Tax Settings', 'event_espresso'),
+					'icon' => 'dashicons-sticky',
+					'order' => 50,
+				],
+				'labels'        => [
+					'publishbox' => esc_html__('Update Tax Settings', 'event_espresso'),
+				],
+				'metaboxes'     => array_merge(
+					['_publish_post_box'],
+					$this->_default_espresso_metaboxes
+				),
+				'require_nonce' => true,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_price_types()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Price Types', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_PRICING',
+			PRICING_ASSETS_URL . 'espresso_pricing_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_PRICING');
+
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('jquery-ui-position');
+		wp_enqueue_script('jquery-ui-widget');
+		wp_register_script(
+			'espresso_PRICING',
+			PRICING_ASSETS_URL . 'espresso_pricing_admin.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_PRICING');
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('espresso_ajax_table_sorting');
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Default Pricing', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_price' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed'] = [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_price' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_price'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_price_types()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_price_type' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_default_price_types',
+				'pricing_trash_price_type'
+			)
+		) {
+			$this->_views['trashed'] = [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_price_type' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_price_type'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * generates HTML for main Prices Admin page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _price_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_new_price',
+			'add',
+			[],
+			'add-new-h2'
+		);
+		$this->_admin_page_title .= $this->_learn_more_about_pricing_link();
+		$this->_search_btn_label = esc_html__('Default Prices', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * retrieve data for Prices List table
+	 *
+	 * @param int  $per_page how many prices displayed per page
+	 * @param bool $count    return the count or objects
+	 * @param bool $trashed  whether the current view is of the trash can - eww yuck!
+	 * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_prices_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
+	{
+		// start with an empty array
+		$event_pricing = [];
+
+		require_once(PRICING_ADMIN . 'Prices_List_Table.class.php');
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+
+		switch ($orderby) {
+			case 'name':
+				$orderby = ['PRC_name' => $order];
+				break;
+			case 'type':
+				$orderby = ['Price_Type.PRT_name' => $order];
+				break;
+			case 'amount':
+				$orderby = ['PRC_amount' => $order];
+				break;
+			default:
+				$orderby = ['PRC_order' => $order, 'Price_Type.PRT_order' => $order, 'PRC_ID' => $order];
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
+
+		$where = [
+			'PRC_is_default' => 1,
+			'PRC_deleted'    => $trashed,
+		];
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = "%{$search_term}%";
+			$where['OR'] = [
+				'PRC_name'            => ['LIKE', $search_term],
+				'PRC_desc'            => ['LIKE', $search_term],
+				'PRC_amount'          => ['LIKE', $search_term],
+				'Price_Type.PRT_name' => ['LIKE', $search_term],
+			];
+		}
+
+		$query_params = [
+			$where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+			'group_by' => 'PRC_ID',
+		];
+
+		if ($count) {
+			return $trashed
+				? EEM_Price::instance()->count([$where])
+				: EEM_Price::instance()->count_deleted_and_undeleted([$where]);
+		}
+		return EEM_Price::instance()->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_price_details()
+	{
+		// grab price ID
+		$PRC_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		// change page title based on request action
+		switch ($this->_req_action) {
+			case 'add_new_price':
+				$this->_admin_page_title = esc_html__('Add New Price', 'event_espresso');
+				break;
+			case 'edit_price':
+				$this->_admin_page_title = esc_html__('Edit Price', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add PRC_ID to title if editing
+		$this->_admin_page_title = $PRC_ID ? $this->_admin_page_title . ' # ' . $PRC_ID : $this->_admin_page_title;
+
+		if ($PRC_ID) {
+			$price                    = EEM_Price::instance()->get_one_by_ID($PRC_ID);
+			$additional_hidden_fields = [
+				'PRC_ID' => ['type' => 'hidden', 'value' => $PRC_ID],
+			];
+			$this->_set_add_edit_form_tags('update_price', $additional_hidden_fields);
+		} else {
+			$price = EEM_Price::instance()->get_new_price();
+			$this->_set_add_edit_form_tags('insert_price');
+		}
+
+		if (! $price instanceof EE_Price) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'A valid Price could not be retrieved from the database with ID: %1$s',
+						'event_espresso'
+					),
+					$PRC_ID
+				)
+			);
+		}
+
+		$this->_template_args['PRC_ID'] = $PRC_ID;
+		$this->_template_args['price']  = $price;
+
+		$default_base_price = $price->type_obj() && $price->type_obj()->base_type() === 1;
+
+		$this->_template_args['default_base_price'] = $default_base_price;
+
+		// get price types
+		$price_types = EEM_Price_Type::instance()->get_all([['PBT_ID' => ['!=', 1]]]);
+		if (empty($price_types)) {
+			$msg = esc_html__(
+				'You have no price types defined. Please add a price type before adding a price.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->display_admin_page_with_sidebar();
+		}
+		$attributes       = [];
+		$price_type_names = [];
+		$attributes[]     = 'id="PRT_ID"';
+		if ($default_base_price) {
+			$attributes[]       = 'disabled="disabled"';
+			$price_type_names[] = ['id' => 1, 'text' => esc_html__('Base Price', 'event_espresso')];
+		}
+		foreach ($price_types as $type) {
+			$price_type_names[] = ['id' => $type->ID(), 'text' => $type->name()];
+		}
+		$this->_template_args['attributes']  = implode(' ', $attributes);
+		$this->_template_args['price_types'] = $price_type_names;
+
+		$this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
+		$this->_template_args['admin_page_content']            = $this->_edit_price_details_meta_box();
+
+		$this->_set_publish_post_box_vars('id', $PRC_ID);
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *
+	 * @return string
+	 */
+	public function _edit_price_details_meta_box(): string
+	{
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'pricing_details_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function set_price_column_values(): array
+	{
+		$PRC_order = 0;
+		$PRT_ID    = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+		if ($PRT_ID) {
+			/** @var EE_Price_Type $price_type */
+			$price_type = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
+			if ($price_type instanceof EE_Price_Type) {
+				$PRC_order = $price_type->order();
+			}
+		}
+		return [
+			'PRT_ID'         => $PRT_ID,
+			'PRC_amount'     => $this->request->getRequestParam('PRC_amount', 0, DataType::FLOAT),
+			'PRC_name'       => $this->request->getRequestParam('PRC_name'),
+			'PRC_desc'       => $this->request->getRequestParam('PRC_desc'),
+			'PRC_is_default' => 1,
+			'PRC_overrides'  => null,
+			'PRC_order'      => $PRC_order,
+			'PRC_deleted'    => 0,
+			'PRC_parent'     => 0,
+		];
+	}
+
+
+	/**
+	 * @param bool $insert - whether to insert or update
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_price(bool $insert = false)
+	{
+		// why be so pessimistic ???  : (
+		$updated = 0;
+
+		$set_column_values = $this->set_price_column_values();
+		// is this a new Price ?
+		if ($insert) {
+			// run the insert
+			$PRC_ID = EEM_Price::instance()->insert($set_column_values);
+			if ($PRC_ID) {
+				// make sure this new price modifier is attached to the ticket but ONLY if it is not a tax type
+				$price = EEM_price::instance()->get_one_by_ID($PRC_ID);
+				if (
+					$price instanceof EE_Price
+					&& $price->type_obj() instanceof EE_Price_type
+					&& $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax
+				) {
+					$ticket = EEM_Ticket::instance()->get_one_by_ID(1);
+					$ticket->_add_relation_to($price, 'Price');
+					$ticket->save();
+				}
+				$updated = 1;
+			}
+			$action_desc = 'created';
+		} else {
+			$PRC_ID = $this->request->getRequestParam('PRC_ID', 0, DataType::INTEGER);
+			// run the update
+			$where_cols_n_values = ['PRC_ID' => $PRC_ID];
+			$updated             = EEM_Price::instance()->update($set_column_values, [$where_cols_n_values]);
+
+			$price = EEM_Price::instance()->get_one_by_ID($PRC_ID);
+			if ($price instanceof EE_Price && $price->type_obj()->base_type() !== EEM_Price_Type::base_type_tax) {
+				// if this is $PRC_ID == 1,
+				// then we need to update the default ticket attached to this price so the TKT_price value is updated.
+				if ($PRC_ID === 1) {
+					$ticket = $price->get_first_related('Ticket');
+					if ($ticket) {
+						$ticket->set('TKT_price', $price->get('PRC_amount'));
+						$ticket->set('TKT_name', $price->get('PRC_name'));
+						$ticket->set('TKT_description', $price->get('PRC_desc'));
+						$ticket->save();
+					}
+				} else {
+					// we make sure this price is attached to base ticket. but ONLY if its not a tax ticket type.
+					$ticket = EEM_Ticket::instance()->get_one_by_ID(1);
+					$ticket->_add_relation_to($PRC_ID, 'Price');
+					$ticket->save();
+				}
+			}
+
+			$action_desc = 'updated';
+		}
+
+		$query_args = ['action' => 'edit_price', 'id' => $PRC_ID];
+
+		$this->_redirect_after_action($updated, 'Prices', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_price($trash = true)
+	{
+		$entity_model = EEM_Price::instance();
+		$action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
+		$result       = $this->trashRestoreDeleteEntities(
+			$entity_model,
+			'id',
+			$action,
+			'PRC_deleted',
+			[$this, 'adjustTicketRelations']
+		);
+
+		if ($result) {
+			$msg = $trash
+				? esc_html(
+					_n(
+						'The Price has been trashed',
+						'The Prices have been trashed',
+						$result,
+						'event_espresso'
+					)
+				)
+				: esc_html(
+					_n(
+						'The Price has been restored',
+						'The Prices have been restored',
+						$result,
+						'event_espresso'
+					)
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(
+			$result,
+			_n('Price', 'Prices', $result, 'event_espresso'),
+			$trash ? 'trashed' : 'restored',
+			['action' => 'default'],
+			true
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base   $entity_model
+	 * @param int|string $entity_ID
+	 * @param string     $action
+	 * @param int        $result
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.30.p
+	 */
+	public function adjustTicketRelations(
+		EEM_Base $entity_model,
+		$entity_ID,
+		string $action,
+		int $result
+	) {
+		if (! $entity_ID || (float) $result < 1) {
+			return;
+		}
+
+		$entity = $entity_model->get_one_by_ID($entity_ID);
+		if (! $entity instanceof EE_Price || $entity->type_obj()->base_type() === EEM_Price_Type::base_type_tax) {
+			return;
+		}
+
+		// get default tickets for updating
+		$default_tickets = EEM_Ticket::instance()->get_all_default_tickets();
+		foreach ($default_tickets as $default_ticket) {
+			if (! $default_ticket instanceof EE_Ticket) {
+				continue;
+			}
+			switch ($action) {
+				case EE_Admin_List_Table::ACTION_DELETE:
+				case EE_Admin_List_Table::ACTION_TRASH:
+					// if trashing then remove relations to base default ticket.
+					$default_ticket->_remove_relation_to($entity_ID, 'Price');
+					break;
+				case EE_Admin_List_Table::ACTION_RESTORE:
+					// if restoring then add back to base default ticket
+					$default_ticket->_add_relation_to($entity_ID, 'Price');
+					break;
+			}
+			$default_ticket->save();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_price()
+	{
+		$entity_model = EEM_Price::instance();
+		$deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
+		$entity       = $entity_model->item_name($deleted);
+		$this->_redirect_after_action(
+			$deleted,
+			$entity,
+			'deleted',
+			['action' => 'default']
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_price_order()
+	{
+		// grab our row IDs
+		$row_ids = $this->request->getRequestParam('row_ids', '');
+		$row_ids = explode(',', rtrim($row_ids, ','));
+
+		$all_updated = true;
+		foreach ($row_ids as $i => $row_id) {
+			// Update the prices when re-ordering
+			$fields_n_values = ['PRC_order' => $i + 1];
+			$query_params    = [['PRC_ID' => absint($row_id)]];
+			// any failure will toggle $all_updated to false
+			$all_updated = $row_id && EEM_Price::instance()->update($fields_n_values, $query_params) !== false
+				? $all_updated
+				: false;
+		}
+		$success = $all_updated
+			? esc_html__('Price order was updated successfully.', 'event_espresso')
+			: false;
+		$errors  = ! $all_updated
+			? esc_html__('An error occurred. The price order was not updated.', 'event_espresso')
+			: false;
+
+		echo wp_json_encode(['return_data' => false, 'success' => $success, 'errors' => $errors]);
+		die();
+	}
+
+
+	/******************************************************************************************************************
      ***********************************************  TICKET PRICE TYPES  *********************************************
      ******************************************************************************************************************/
 
 
-    /**
-     * generates HTML for main Prices Admin page
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _price_types_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_new_price_type',
-            'add_type',
-            [],
-            'add-new-h2'
-        );
-        $this->_admin_page_title .= $this->_learn_more_about_pricing_link();
-        $this->_search_btn_label = esc_html__('Price Types', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * retrieve data for Price Types List table
-     *
-     * @param int  $per_page how many prices displayed per page
-     * @param bool $count    return the count or objects
-     * @param bool $trashed  whether the current view is of the trash can - eww yuck!
-     * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_price_types_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
-    {
-        // start with an empty array
-        require_once(PRICING_ADMIN . 'Price_Types_List_Table.class.php');
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-
-        switch ($orderby) {
-            case 'name':
-                $orderby = ['PRT_name' => $order];
-                break;
-            default:
-                $orderby = ['PRT_order' => $order];
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $where = ['PRT_deleted' => $trashed, 'PBT_ID' => ['!=', 1]];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $where['OR'] = [
-                'PRT_name' => ['LIKE', "%{$search_term}%"],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-        ];
-        return $count
-            ? EEM_Price_Type::instance()->count_deleted_and_undeleted($query_params)
-            : EEM_Price_Type::instance()->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * _edit_price_type_details
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_price_type_details()
-    {
-        // grab price type ID
-        $PRT_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
-        // change page title based on request action
-        switch ($this->_req_action) {
-            case 'add_new_price_type':
-                $this->_admin_page_title = esc_html__('Add New Price Type', 'event_espresso');
-                break;
-            case 'edit_price_type':
-                $this->_admin_page_title = esc_html__('Edit Price Type', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add PRT_ID to title if editing
-        $this->_admin_page_title = $PRT_ID ? $this->_admin_page_title . ' # ' . $PRT_ID : $this->_admin_page_title;
-
-        if ($PRT_ID) {
-            $price_type               = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
-            $additional_hidden_fields = ['PRT_ID' => ['type' => 'hidden', 'value' => $PRT_ID]];
-            $this->_set_add_edit_form_tags('update_price_type', $additional_hidden_fields);
-        } else {
-            $price_type = EEM_Price_Type::instance()->get_new_price_type();
-            $this->_set_add_edit_form_tags('insert_price_type');
-        }
-
-        if (! $price_type instanceof EE_Price_Type) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'A valid Price Type could not be retrieved from the database with ID: %1$s',
-                        'event_espresso'
-                    ),
-                    $PRT_ID
-                )
-            );
-        }
-
-        $this->_template_args['PRT_ID']     = $PRT_ID;
-        $this->_template_args['price_type'] = $price_type;
-
-        $base_types    = EEM_Price_Type::instance()->get_base_types();
-        $select_values = [];
-        foreach ($base_types as $ref => $text) {
-            if ($ref == EEM_Price_Type::base_type_base_price) {
-                // do not allow creation of base_type_base_prices because that's a system only base type.
-                continue;
-            }
-            $select_values[] = ['id' => $ref, 'text' => $text];
-        }
-
-        $this->_template_args['base_type_select'] = EEH_Form_Fields::select_input(
-            'base_type',
-            $select_values,
-            $price_type->base_type(),
-            'id="price-type-base-type-slct"'
-        );
-
-        $this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
-        $this->_template_args['admin_page_content']            = $this->_edit_price_type_details_meta_box();
-
-        $redirect_URL = add_query_arg(['action' => 'price_types'], $this->_admin_base_url);
-        $this->_set_publish_post_box_vars('id', $PRT_ID, false, $redirect_URL);
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_price_type_details_meta_box
-     *
-     * @return string
-     */
-    public function _edit_price_type_details_meta_box(): string
-    {
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'pricing_type_details_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function set_price_type_column_values(): array
-    {
-        $base_type  = $this->request->getRequestParam(
-            'base_type',
-            EEM_Price_Type::base_type_base_price,
-            DataType::INTEGER
-        );
-        $is_percent = $this->request->getRequestParam('PRT_is_percent', 0, DataType::INTEGER);
-        $order      = $this->request->getRequestParam('PRT_order', 0, DataType::INTEGER);
-        switch ($base_type) {
-            case EEM_Price_Type::base_type_base_price:
-                $is_percent = 0;
-                $order      = 0;
-                break;
-
-            case EEM_Price_Type::base_type_discount:
-            case EEM_Price_Type::base_type_surcharge:
-                break;
-
-            case EEM_Price_Type::base_type_tax:
-                $is_percent = 1;
-                break;
-        }
-
-        return [
-            'PBT_ID'         => $base_type,
-            'PRT_name'       => $this->request->getRequestParam('PRT_name', ''),
-            'PRT_is_percent' => $is_percent,
-            'PRT_order'      => $order,
-            'PRT_deleted'    => 0,
-        ];
-    }
-
-
-    /**
-     * @param bool $new_price_type - whether to insert or update
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_price_type(bool $new_price_type = false)
-    {
-        // why be so pessimistic ???  : (
-        $success = 0;
-
-        $set_column_values = $this->set_price_type_column_values();
-        // is this a new Price ?
-        if ($new_price_type) {
-            // run the insert
-            if ($PRT_ID = EEM_Price_Type::instance()->insert($set_column_values)) {
-                $success = 1;
-            }
-            $action_desc = 'created';
-        } else {
-            $PRT_ID = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
-            // run the update
-            $where_cols_n_values = ['PRT_ID' => $PRT_ID];
-            if (EEM_Price_Type::instance()->update($set_column_values, [$where_cols_n_values])) {
-                $success = 1;
-            }
-            $action_desc = 'updated';
-        }
-
-        $query_args = ['action' => 'edit_price_type', 'id' => $PRT_ID];
-        $this->_redirect_after_action($success, 'Price Type', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_price_type(bool $trash = true)
-    {
-        $entity_model = EEM_Price_Type::instance();
-        $action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
-        $success      = $this->trashRestoreDeleteEntities($entity_model, 'id', $action, 'PRT_deleted');
-        if ($success) {
-            $msg = $trash
-                ? esc_html(
-                    _n(
-                        'The Price Type has been trashed',
-                        'The Price Types have been trashed',
-                        $success,
-                        'event_espresso'
-                    )
-                )
-                : esc_html(
-                    _n(
-                        'The Price Type has been restored',
-                        'The Price Types have been restored',
-                        $success,
-                        'event_espresso'
-                    )
-                );
-            EE_Error::add_success($msg);
-        }
-        $this->_redirect_after_action('', '', '', ['action' => 'price_types'], true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_price_type()
-    {
-        $entity_model = EEM_Price_Type::instance();
-        $deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
-        $this->_redirect_after_action(
-            $deleted,
-            $entity_model->item_name($deleted),
-            'deleted',
-            ['action' => 'price_types']
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _learn_more_about_pricing_link(): string
-    {
-        return '
+	/**
+	 * generates HTML for main Prices Admin page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _price_types_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_new_price_type',
+			'add_type',
+			[],
+			'add-new-h2'
+		);
+		$this->_admin_page_title .= $this->_learn_more_about_pricing_link();
+		$this->_search_btn_label = esc_html__('Price Types', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * retrieve data for Price Types List table
+	 *
+	 * @param int  $per_page how many prices displayed per page
+	 * @param bool $count    return the count or objects
+	 * @param bool $trashed  whether the current view is of the trash can - eww yuck!
+	 * @return EE_Soft_Delete_Base_Class[]|int int = count || array of price objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_price_types_overview_data(int $per_page = 10, bool $count = false, bool $trashed = false)
+	{
+		// start with an empty array
+		require_once(PRICING_ADMIN . 'Price_Types_List_Table.class.php');
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+
+		switch ($orderby) {
+			case 'name':
+				$orderby = ['PRT_name' => $order];
+				break;
+			default:
+				$orderby = ['PRT_order' => $order];
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, DataType::INTEGER);
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, DataType::INTEGER);
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$where = ['PRT_deleted' => $trashed, 'PBT_ID' => ['!=', 1]];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$where['OR'] = [
+				'PRT_name' => ['LIKE', "%{$search_term}%"],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+		];
+		return $count
+			? EEM_Price_Type::instance()->count_deleted_and_undeleted($query_params)
+			: EEM_Price_Type::instance()->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * _edit_price_type_details
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_price_type_details()
+	{
+		// grab price type ID
+		$PRT_ID = $this->request->getRequestParam('id', 0, DataType::INTEGER);
+		// change page title based on request action
+		switch ($this->_req_action) {
+			case 'add_new_price_type':
+				$this->_admin_page_title = esc_html__('Add New Price Type', 'event_espresso');
+				break;
+			case 'edit_price_type':
+				$this->_admin_page_title = esc_html__('Edit Price Type', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add PRT_ID to title if editing
+		$this->_admin_page_title = $PRT_ID ? $this->_admin_page_title . ' # ' . $PRT_ID : $this->_admin_page_title;
+
+		if ($PRT_ID) {
+			$price_type               = EEM_Price_Type::instance()->get_one_by_ID($PRT_ID);
+			$additional_hidden_fields = ['PRT_ID' => ['type' => 'hidden', 'value' => $PRT_ID]];
+			$this->_set_add_edit_form_tags('update_price_type', $additional_hidden_fields);
+		} else {
+			$price_type = EEM_Price_Type::instance()->get_new_price_type();
+			$this->_set_add_edit_form_tags('insert_price_type');
+		}
+
+		if (! $price_type instanceof EE_Price_Type) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'A valid Price Type could not be retrieved from the database with ID: %1$s',
+						'event_espresso'
+					),
+					$PRT_ID
+				)
+			);
+		}
+
+		$this->_template_args['PRT_ID']     = $PRT_ID;
+		$this->_template_args['price_type'] = $price_type;
+
+		$base_types    = EEM_Price_Type::instance()->get_base_types();
+		$select_values = [];
+		foreach ($base_types as $ref => $text) {
+			if ($ref == EEM_Price_Type::base_type_base_price) {
+				// do not allow creation of base_type_base_prices because that's a system only base type.
+				continue;
+			}
+			$select_values[] = ['id' => $ref, 'text' => $text];
+		}
+
+		$this->_template_args['base_type_select'] = EEH_Form_Fields::select_input(
+			'base_type',
+			$select_values,
+			$price_type->base_type(),
+			'id="price-type-base-type-slct"'
+		);
+
+		$this->_template_args['learn_more_about_pricing_link'] = $this->_learn_more_about_pricing_link();
+		$this->_template_args['admin_page_content']            = $this->_edit_price_type_details_meta_box();
+
+		$redirect_URL = add_query_arg(['action' => 'price_types'], $this->_admin_base_url);
+		$this->_set_publish_post_box_vars('id', $PRT_ID, false, $redirect_URL);
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_price_type_details_meta_box
+	 *
+	 * @return string
+	 */
+	public function _edit_price_type_details_meta_box(): string
+	{
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'pricing_type_details_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function set_price_type_column_values(): array
+	{
+		$base_type  = $this->request->getRequestParam(
+			'base_type',
+			EEM_Price_Type::base_type_base_price,
+			DataType::INTEGER
+		);
+		$is_percent = $this->request->getRequestParam('PRT_is_percent', 0, DataType::INTEGER);
+		$order      = $this->request->getRequestParam('PRT_order', 0, DataType::INTEGER);
+		switch ($base_type) {
+			case EEM_Price_Type::base_type_base_price:
+				$is_percent = 0;
+				$order      = 0;
+				break;
+
+			case EEM_Price_Type::base_type_discount:
+			case EEM_Price_Type::base_type_surcharge:
+				break;
+
+			case EEM_Price_Type::base_type_tax:
+				$is_percent = 1;
+				break;
+		}
+
+		return [
+			'PBT_ID'         => $base_type,
+			'PRT_name'       => $this->request->getRequestParam('PRT_name', ''),
+			'PRT_is_percent' => $is_percent,
+			'PRT_order'      => $order,
+			'PRT_deleted'    => 0,
+		];
+	}
+
+
+	/**
+	 * @param bool $new_price_type - whether to insert or update
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_price_type(bool $new_price_type = false)
+	{
+		// why be so pessimistic ???  : (
+		$success = 0;
+
+		$set_column_values = $this->set_price_type_column_values();
+		// is this a new Price ?
+		if ($new_price_type) {
+			// run the insert
+			if ($PRT_ID = EEM_Price_Type::instance()->insert($set_column_values)) {
+				$success = 1;
+			}
+			$action_desc = 'created';
+		} else {
+			$PRT_ID = $this->request->getRequestParam('PRT_ID', 0, DataType::INTEGER);
+			// run the update
+			$where_cols_n_values = ['PRT_ID' => $PRT_ID];
+			if (EEM_Price_Type::instance()->update($set_column_values, [$where_cols_n_values])) {
+				$success = 1;
+			}
+			$action_desc = 'updated';
+		}
+
+		$query_args = ['action' => 'edit_price_type', 'id' => $PRT_ID];
+		$this->_redirect_after_action($success, 'Price Type', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_price_type(bool $trash = true)
+	{
+		$entity_model = EEM_Price_Type::instance();
+		$action       = $trash ? EE_Admin_List_Table::ACTION_TRASH : EE_Admin_List_Table::ACTION_RESTORE;
+		$success      = $this->trashRestoreDeleteEntities($entity_model, 'id', $action, 'PRT_deleted');
+		if ($success) {
+			$msg = $trash
+				? esc_html(
+					_n(
+						'The Price Type has been trashed',
+						'The Price Types have been trashed',
+						$success,
+						'event_espresso'
+					)
+				)
+				: esc_html(
+					_n(
+						'The Price Type has been restored',
+						'The Price Types have been restored',
+						$success,
+						'event_espresso'
+					)
+				);
+			EE_Error::add_success($msg);
+		}
+		$this->_redirect_after_action('', '', '', ['action' => 'price_types'], true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_price_type()
+	{
+		$entity_model = EEM_Price_Type::instance();
+		$deleted      = $this->trashRestoreDeleteEntities($entity_model, 'id');
+		$this->_redirect_after_action(
+			$deleted,
+			$entity_model->item_name($deleted),
+			'deleted',
+			['action' => 'price_types']
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _learn_more_about_pricing_link(): string
+	{
+		return '
             <a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >
                 ' . esc_html__('learn more about how pricing works', 'event_espresso') . '
             </a>';
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _tax_settings()
-    {
-        $this->_set_add_edit_form_tags('update_tax_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->tax_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function tax_settings_form(): EE_Form_Section_Proper
-    {
-        $tax_settings = EE_Config::instance()->tax_settings;
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'tax_settings_form',
-                'html_id'         => 'tax_settings_form',
-                'html_class'      => 'padding',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Pricing_Admin_Page__tax_settings_form__form_subsections',
-                    [
-                        'tax_settings' => new EE_Form_Section_Proper(
-                            [
-                                'name'            => 'tax_settings_tbl',
-                                'html_id'         => 'tax_settings_tbl',
-                                'html_class'      => 'form-table',
-                                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                                'subsections'     => [
-                                    'prices_displayed_including_taxes' => new EE_Yes_No_Input(
-                                        [
-                                            'html_label_text'         => esc_html__(
-                                                'Show Prices With Taxes Included?',
-                                                'event_espresso'
-                                            ),
-                                            'html_help_text'          => esc_html__(
-                                                'Indicates whether or not to display prices with the taxes included',
-                                                'event_espresso'
-                                            ),
-                                            'default'                 => $tax_settings->prices_displayed_including_taxes
-                                                                         ?? true,
-                                            'display_html_label_text' => false,
-                                        ]
-                                    ),
-                                ],
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _update_tax_settings
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.13
-     */
-    public function _update_tax_settings()
-    {
-        $tax_settings = EE_Config::instance()->tax_settings;
-        if (! $tax_settings instanceof EE_Tax_Config) {
-            $tax_settings = new EE_Tax_Config();
-        }
-        try {
-            $tax_form = $this->tax_settings_form();
-            // check for form submission
-            if ($tax_form->was_submitted()) {
-                // capture form data
-                $tax_form->receive_form_submission();
-                // validate form data
-                if ($tax_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $tax_form->valid_data();
-                    // set data on config
-                    $tax_settings->prices_displayed_including_taxes =
-                        $valid_data['tax_settings']['prices_displayed_including_taxes'];
-                } else {
-                    if ($tax_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $tax_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->get_error(), __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        $what    = 'Tax Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            $tax_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'tax_settings']);
-    }
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _tax_settings()
+	{
+		$this->_set_add_edit_form_tags('update_tax_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->tax_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function tax_settings_form(): EE_Form_Section_Proper
+	{
+		$tax_settings = EE_Config::instance()->tax_settings;
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'tax_settings_form',
+				'html_id'         => 'tax_settings_form',
+				'html_class'      => 'padding',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Pricing_Admin_Page__tax_settings_form__form_subsections',
+					[
+						'tax_settings' => new EE_Form_Section_Proper(
+							[
+								'name'            => 'tax_settings_tbl',
+								'html_id'         => 'tax_settings_tbl',
+								'html_class'      => 'form-table',
+								'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+								'subsections'     => [
+									'prices_displayed_including_taxes' => new EE_Yes_No_Input(
+										[
+											'html_label_text'         => esc_html__(
+												'Show Prices With Taxes Included?',
+												'event_espresso'
+											),
+											'html_help_text'          => esc_html__(
+												'Indicates whether or not to display prices with the taxes included',
+												'event_espresso'
+											),
+											'default'                 => $tax_settings->prices_displayed_including_taxes
+																		 ?? true,
+											'display_html_label_text' => false,
+										]
+									),
+								],
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _update_tax_settings
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.13
+	 */
+	public function _update_tax_settings()
+	{
+		$tax_settings = EE_Config::instance()->tax_settings;
+		if (! $tax_settings instanceof EE_Tax_Config) {
+			$tax_settings = new EE_Tax_Config();
+		}
+		try {
+			$tax_form = $this->tax_settings_form();
+			// check for form submission
+			if ($tax_form->was_submitted()) {
+				// capture form data
+				$tax_form->receive_form_submission();
+				// validate form data
+				if ($tax_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $tax_form->valid_data();
+					// set data on config
+					$tax_settings->prices_displayed_including_taxes =
+						$valid_data['tax_settings']['prices_displayed_including_taxes'];
+				} else {
+					if ($tax_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$tax_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->get_error(), __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		$what    = 'Tax Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			$tax_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'tax_settings']);
+	}
 }

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

Indentation +2175 added lines, -2175 removed lines

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

Spacing +88 added lines, -88 removed lines

@@ -76,7 +76,7 @@ 
     protected function _setup_metaboxes()
     {
         // if we were going to add our own metaboxes we'd use the below.
-        $this->_metaboxes        = [
+        $this->_metaboxes = [
             0 => [
                 'page_route' => ['edit', 'create_new'],
                 'func'       => [$this, 'pricing_metabox'],
@@ -119,7 +119,7 @@ 
         $this->_date_format_strings['date'] = $this->_date_format_strings['date'] ?? '';
         $this->_date_format_strings['time'] = $this->_date_format_strings['time'] ?? '';
 
-        $this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time'];
+        $this->_date_time_format = $this->_date_format_strings['date'].' '.$this->_date_format_strings['time'];
     }
 
 
@@ -143,7 +143,7 @@ 
             );
             $msg .= '</p><ul>';
             foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
+                $msg .= '<li>'.$error.'</li>';
             }
             $msg .= '</ul><p>';
             $msg .= sprintf(
@@ -172,11 +172,11 @@ 
         $this->_scripts_styles = [
             'registers'   => [
                 'ee-tickets-datetimes-css' => [
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+                    'url'  => PRICING_ASSETS_URL.'event-tickets-datetimes.css',
                     'type' => 'css',
                 ],
                 'ee-dtt-ticket-metabox'    => [
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+                    'url'     => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js',
                     'depends' => ['ee-datepicker', 'ee-dialog', 'underscore'],
                 ],
             ],
@@ -201,11 +201,11 @@ 
                         ),
                         'cancel_button'           => '
                             <button class="button--secondary ee-modal-cancel">
-                                ' . esc_html__('Cancel', 'event_espresso') . '
+                                ' . esc_html__('Cancel', 'event_espresso').'
                             </button>',
                         'close_button'            => '
                             <button class="button--secondary ee-modal-cancel">
-                                ' . esc_html__('Close', 'event_espresso') . '
+                                ' . esc_html__('Close', 'event_espresso').'
                             </button>',
                         'single_warning_from_tkt' => esc_html__(
                             'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
@@ -217,7 +217,7 @@ 
                         ),
                         'dismiss_button'          => '
                             <button class="button--secondary ee-modal-cancel">
-                                ' . esc_html__('Dismiss', 'event_espresso') . '
+                                ' . esc_html__('Dismiss', 'event_espresso').'
                             </button>',
                     ],
                     'DTT_ERROR_MSG'         => [
@@ -225,7 +225,7 @@ 
                         'dismiss_button' => '
                             <div class="save-cancel-button-container">
                                 <button class="button--secondary ee-modal-cancel">
-                                    ' . esc_html__('Dismiss', 'event_espresso') . '
+                                    ' . esc_html__('Dismiss', 'event_espresso').'
                                 </button>
                             </div>',
                     ],
@@ -314,7 +314,7 @@ 
         foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
             // trim all values to ensure any excess whitespace is removed.
             $datetime_data = array_map(
-                function ($datetime_data) {
+                function($datetime_data) {
                     return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
                 },
                 $datetime_data
@@ -324,7 +324,7 @@ 
                                             && ! empty($datetime_data['DTT_EVT_end'])
                 ? $datetime_data['DTT_EVT_end']
                 : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
+            $datetime_values = [
                 'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
                     ? $datetime_data['DTT_ID']
                     : null,
@@ -346,7 +346,7 @@ 
 
             // if we have an id then let's get existing object first and then set the new values.
             // Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
+            if ( ! empty($datetime_data['DTT_ID'])) {
                 $datetime = EE_Registry::instance()
                                        ->load_model('Datetime', [$timezone])
                                        ->get_one_by_ID($datetime_data['DTT_ID']);
@@ -361,7 +361,7 @@ 
                 // after the add_relation_to() the autosave replaces it.
                 // We need to do this so we dont' TRASH the parent DTT.
                 // (save the ID for both key and value to avoid duplications)
-                $saved_datetime_ids[ $datetime->ID() ] = $datetime->ID();
+                $saved_datetime_ids[$datetime->ID()] = $datetime->ID();
             } else {
                 $datetime = EE_Datetime::new_instance(
                     $datetime_values,
@@ -392,8 +392,8 @@ 
             // because it is possible there was a new one created for the autosave.
             // (save the ID for both key and value to avoid duplications)
             $DTT_ID                        = $datetime->ID();
-            $saved_datetime_ids[ $DTT_ID ] = $DTT_ID;
-            $saved_datetime_objs[ $row ]   = $datetime;
+            $saved_datetime_ids[$DTT_ID] = $DTT_ID;
+            $saved_datetime_objs[$row]   = $datetime;
             // @todo if ANY of these updates fail then we want the appropriate global error message.
         }
         $event->save();
@@ -459,13 +459,13 @@ 
             $update_prices = $create_new_TKT = false;
             // figure out what datetimes were added to the ticket
             // and what datetimes were removed from the ticket in the session.
-            $starting_ticket_datetime_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]);
-            $ticket_datetime_rows          = explode(',', $data['ticket_datetime_rows'][ $row ]);
+            $starting_ticket_datetime_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
+            $ticket_datetime_rows          = explode(',', $data['ticket_datetime_rows'][$row]);
             $datetimes_added               = array_diff($ticket_datetime_rows, $starting_ticket_datetime_rows);
             $datetimes_removed             = array_diff($starting_ticket_datetime_rows, $ticket_datetime_rows);
             // trim inputs to ensure any excess whitespace is removed.
             $ticket_data = array_map(
-                function ($ticket_data) {
+                function($ticket_data) {
                     return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
                 },
                 $ticket_data
@@ -485,8 +485,8 @@ 
                 ? $base_price
                 : $ticket_price;
             $base_price_id = $ticket_data['TKT_base_price_ID'] ?? 0;
-            $price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
+            $price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][$row])
+                ? $data['edit_prices'][$row]
                 : [];
             $now           = null;
             if (empty($ticket_data['TKT_start_date'])) {
@@ -498,7 +498,7 @@ 
                 /**
                  * set the TKT_end_date to the first datetime attached to the ticket.
                  */
-                $first_datetime              = $saved_datetimes[ reset($ticket_datetime_rows) ];
+                $first_datetime              = $saved_datetimes[reset($ticket_datetime_rows)];
                 $ticket_data['TKT_end_date'] = $first_datetime->start_date_and_time($this->_date_time_format);
             }
             $TKT_values = [
@@ -599,7 +599,7 @@ 
                 if ($ticket instanceof EE_Ticket) {
                     // make sure ticket has an ID of setting relations won't work
                     $ticket->save();
-                    $ticket        = $this->_update_ticket_datetimes(
+                    $ticket = $this->_update_ticket_datetimes(
                         $ticket,
                         $saved_datetimes,
                         $datetimes_added,
@@ -633,7 +633,7 @@ 
             // need to make sue that the TKT_price is accurate after saving the prices.
             $ticket->ensure_TKT_Price_correct();
             // handle CREATING a default ticket from the incoming ticket but ONLY if this isn't an autosave.
-            if (! defined('DOING_AUTOSAVE') && ! empty($ticket_data['TKT_is_default_selector'])) {
+            if ( ! defined('DOING_AUTOSAVE') && ! empty($ticket_data['TKT_is_default_selector'])) {
                 $new_default = clone $ticket;
                 $new_default->set('TKT_ID', 0);
                 $new_default->set('TKT_is_default', 1);
@@ -677,7 +677,7 @@ 
                 // save new TKT
                 $new_ticket->save();
                 // add new ticket to array
-                $saved_tickets[ $new_ticket->ID() ] = $new_ticket;
+                $saved_tickets[$new_ticket->ID()] = $new_ticket;
                 do_action(
                     'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
                     $new_ticket,
@@ -687,7 +687,7 @@ 
                 );
             } else {
                 // add ticket to saved tickets
-                $saved_tickets[ $ticket->ID() ] = $ticket;
+                $saved_tickets[$ticket->ID()] = $ticket;
                 do_action(
                     'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
                     $ticket,
@@ -755,25 +755,25 @@ 
         // to start we have to add the ticket to all the datetimes its supposed to be with,
         // and removing the ticket from datetimes it got removed from.
         // first let's add datetimes
-        if (! empty($added_datetimes) && is_array($added_datetimes)) {
+        if ( ! empty($added_datetimes) && is_array($added_datetimes)) {
             foreach ($added_datetimes as $row_id) {
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+                    $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
                     // Is this an existing ticket (has an ID) and does it have any sold?
                     // If so, then we need to add that to the DTT sold because this DTT is getting added.
                     if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[ $row_id ]->increaseSold($ticket->sold(), false);
+                        $saved_datetimes[$row_id]->increaseSold($ticket->sold(), false);
                     }
                 }
             }
         }
         // then remove datetimes
-        if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
+        if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) {
             foreach ($removed_datetimes as $row_id) {
                 // its entirely possible that a datetime got deleted (instead of just removed from relationship.
                 // So make sure we skip over this if the datetime isn't in the $saved_datetimes array)
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+                    $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
                 }
             }
         }
@@ -885,7 +885,7 @@ 
             ];
         }
         // possibly need to save ticket
-        if (! $ticket->ID()) {
+        if ( ! $ticket->ID()) {
             $ticket->save();
         }
         foreach ($prices as $row => $prc) {
@@ -919,17 +919,17 @@ 
                 }
             }
             $price->save();
-            $updated_prices[ $price->ID() ] = $price;
+            $updated_prices[$price->ID()] = $price;
             $ticket->_add_relation_to($price, 'Price');
         }
         // now let's remove any prices that got removed from the ticket
-        if (! empty($current_prices_on_ticket)) {
+        if ( ! empty($current_prices_on_ticket)) {
             $current          = array_keys($current_prices_on_ticket);
             $updated          = array_keys($updated_prices);
             $prices_to_remove = array_diff($current, $updated);
-            if (! empty($prices_to_remove)) {
+            if ( ! empty($prices_to_remove)) {
                 foreach ($prices_to_remove as $prc_id) {
-                    $p = $current_prices_on_ticket[ $prc_id ];
+                    $p = $current_prices_on_ticket[$prc_id];
                     $ticket->_remove_relation_to($p, 'Price');
                     // delete permanently the price
                     $p->delete_or_restore();
@@ -950,7 +950,7 @@ 
      */
     public function pricing_metabox()
     {
-        $event                 = $this->_adminpage_obj->get_cpt_model_obj();
+        $event = $this->_adminpage_obj->get_cpt_model_obj();
         $timezone = $event instanceof EE_Event ? $event->timezone_string() : null;
         $price_model = EEM_Price::instance($timezone);
         $ticket_model = EEM_Ticket::instance($timezone);
@@ -1042,18 +1042,18 @@ 
                 $TKT_ID     = $ticket->get('TKT_ID');
                 $ticket_row = $ticket->get('TKT_row');
                 // we only want unique tickets in our final display!!
-                if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
+                if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) {
                     $existing_ticket_ids[] = $TKT_ID;
                     $all_tickets[]         = $ticket;
                 }
                 // temporary cache of this ticket info for this datetime for later processing of datetime rows.
-                $datetime_tickets[ $DTT_ID ][] = $ticket_row;
+                $datetime_tickets[$DTT_ID][] = $ticket_row;
                 // temporary cache of this datetime info for this ticket for later processing of ticket rows.
                 if (
-                    ! isset($ticket_datetimes[ $TKT_ID ])
-                    || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true)
+                    ! isset($ticket_datetimes[$TKT_ID])
+                    || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true)
                 ) {
-                    $ticket_datetimes[ $TKT_ID ][] = $datetime_row;
+                    $ticket_datetimes[$TKT_ID][] = $datetime_row;
                 }
             }
             $datetime_row++;
@@ -1064,7 +1064,7 @@ 
         // sort $all_tickets by order
         usort(
             $all_tickets,
-            function (EE_Ticket $a, EE_Ticket $b) {
+            function(EE_Ticket $a, EE_Ticket $b) {
                 $a_order = (int) $a->get('TKT_order');
                 $b_order = (int) $b->get('TKT_order');
                 if ($a_order === $b_order) {
@@ -1112,7 +1112,7 @@ 
         );
 
         EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php',
             $main_template_args
         );
     }
@@ -1139,7 +1139,7 @@ 
         array $all_datetimes = []
     ): string {
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php',
             [
                 'dtt_edit_row'             => $this->_get_dtt_edit_row(
                     $datetime_row,
@@ -1232,7 +1232,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php',
             $template_args,
             true
         );
@@ -1272,7 +1272,7 @@ 
             'DTT_ID'                            => $default ? '' : $datetime->ID(),
         ];
         // need to setup the list items (but only if this isn't a default skeleton setup)
-        if (! $default) {
+        if ( ! $default) {
             $ticket_row = 1;
             foreach ($all_tickets as $ticket) {
                 $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
@@ -1297,7 +1297,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php',
             $template_args,
             true
         );
@@ -1323,8 +1323,8 @@ 
         array $datetime_tickets = [],
         bool $default = false
     ): string {
-        $datetime_tickets = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ])
-            ? $datetime_tickets[ $datetime->ID() ]
+        $datetime_tickets = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()])
+            ? $datetime_tickets[$datetime->ID()]
             : [];
         $display_row      = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
         $no_ticket        = $default && empty($ticket);
@@ -1345,8 +1345,8 @@ 
                 ? 'TKTNAME'
                 : $ticket->get('TKT_name'),
             'tkt_status_class'        => $no_ticket || $this->_is_creating_event
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status(),
+                ? ' tkt-status-'.EE_Ticket::onsale
+                : ' tkt-status-'.$ticket->ticket_status(),
         ];
         // filter template args
         $template_args = apply_filters(
@@ -1361,7 +1361,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php',
             $template_args,
             true
         );
@@ -1417,19 +1417,19 @@ 
         // (otherwise there won't be any new relationships created for tickets based off of the default ticket).
         // This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
         $default_datetime = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
-        $ticket_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
+        $ticket_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+            ? $ticket_datetimes[$ticket->ID()]
             : [];
         $ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
         $base_price       = $default ? null : $ticket->base_price();
         $count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
         // breaking out complicated condition for ticket_status
         if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+            $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale;
         } else {
             $ticket_status_class = $ticket->is_default()
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status();
+                ? ' tkt-status-'.EE_Ticket::onsale
+                : ' tkt-status-'.$ticket->ticket_status();
         }
         // breaking out complicated condition for TKT_taxable
         if ($default) {
@@ -1454,7 +1454,7 @@ 
                 $TKT_min = '';
             }
         }
-        $template_args                 = [
+        $template_args = [
             'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
             'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
             // on initial page load this will always be the correct order.
@@ -1521,7 +1521,7 @@ 
                 : 'display:none;',
             'show_price_mod_button'         => count($prices) > 1
                                                || ($default && $count_price_mods > 0)
-                                               || (! $default && $ticket->deleted())
+                                               || ( ! $default && $ticket->deleted())
                 ? 'display:none;'
                 : '',
             'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
@@ -1562,11 +1562,11 @@ 
         // handle rows that should NOT be empty
         if (empty($template_args['TKT_start_date'])) {
             // if empty then the start date will be now.
-            $template_args['TKT_start_date']   = date(
+            $template_args['TKT_start_date'] = date(
                 $this->_date_time_format,
                 current_time('timestamp')
             );
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         if (empty($template_args['TKT_end_date'])) {
             // get the earliest datetime (if present);
@@ -1576,7 +1576,7 @@ 
                     ['order_by' => ['DTT_EVT_start' => 'ASC']]
                 )
                 : null;
-            if (! empty($earliest_datetime)) {
+            if ( ! empty($earliest_datetime)) {
                 $template_args['TKT_end_date'] = $earliest_datetime->get_datetime(
                     'DTT_EVT_start',
                     $this->_date_time_format
@@ -1595,10 +1595,10 @@ 
                     )
                 );
             }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         // generate ticket_datetime items
-        if (! $default) {
+        if ( ! $default) {
             $datetime_row = 1;
             foreach ($all_datetimes as $datetime) {
                 $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
@@ -1614,7 +1614,7 @@ 
         }
         $price_row = 1;
         foreach ($prices as $price) {
-            if (! $price instanceof EE_Price) {
+            if ( ! $price instanceof EE_Price) {
                 continue;
             }
             if ($price->is_base_price()) {
@@ -1649,7 +1649,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php',
             $template_args,
             true
         );
@@ -1689,8 +1689,8 @@ 
                 $ticket,
                 $this->_is_creating_event
             );
-            $tax_rows      .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
+            $tax_rows .= EEH_Template::display_template(
+                PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php',
                 $template_args,
                 true
             );
@@ -1810,7 +1810,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php',
             $template_args,
             true
         );
@@ -1890,7 +1890,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php',
             $template_args,
             true
         );
@@ -1920,7 +1920,7 @@ 
     ): string {
         $select_name = $default && ! $price instanceof EE_Price
             ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
-            : 'edit_prices[' . esc_attr($ticket_row) . '][' . esc_attr($price_row) . '][PRT_ID]';
+            : 'edit_prices['.esc_attr($ticket_row).']['.esc_attr($price_row).'][PRT_ID]';
 
         $price_type_model       = EEM_Price_Type::instance();
         $price_types            = $price_type_model->get_all(
@@ -1940,25 +1940,25 @@ 
         $price_option_spans     = '';
         // setup price types for selector
         foreach ($price_types as $price_type) {
-            if (! $price_type instanceof EE_Price_Type) {
+            if ( ! $price_type instanceof EE_Price_Type) {
                 continue;
             }
-            $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name');
+            $all_price_types[$price_type->ID()] = $price_type->get('PRT_name');
             // while we're in the loop let's setup the option spans used by js
-            $span_args          = [
+            $span_args = [
                 'PRT_ID'         => $price_type->ID(),
                 'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
                 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
             ];
             $price_option_spans .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
+                PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php',
                 $span_args,
                 true
             );
         }
 
         $select_name = $disabled
-            ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]'
+            ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]'
             : $select_name;
 
         $select_input = new EE_Select_Input(
@@ -1986,7 +1986,7 @@ 
             'price_selected_is_percent' => $price_selected_is_percent,
             'disabled'                  => $disabled,
         ];
-        $template_args             = apply_filters(
+        $template_args = apply_filters(
             'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
             $template_args,
             $ticket_row,
@@ -1997,7 +1997,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php',
             $template_args,
             true
         );
@@ -2024,8 +2024,8 @@ 
         array $ticket_datetimes = [],
         bool $default = false
     ): string {
-        $ticket_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
+        $ticket_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+            ? $ticket_datetimes[$ticket->ID()]
             : [];
         $template_args    = [
             'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
@@ -2045,7 +2045,7 @@ 
                 : $datetime->get_dtt_display_name(true),
             'tkt_status_class'         => '',
         ];
-        $template_args    = apply_filters(
+        $template_args = apply_filters(
             'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
             $template_args,
             $datetime_row,
@@ -2057,7 +2057,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php',
             $template_args,
             true
         );
@@ -2135,7 +2135,7 @@ 
                 true
             ),
         ];
-        $ticket_row    = 1;
+        $ticket_row = 1;
         foreach ($all_tickets as $ticket) {
             $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
                 'DTTNUM',
@@ -2163,11 +2163,11 @@ 
         $default_prices = $price_model->get_all_default_prices();
         $price_row      = 1;
         foreach ($default_prices as $price) {
-            if (! $price instanceof EE_Price) {
+            if ( ! $price instanceof EE_Price) {
                 continue;
             }
             if ($price->is_base_price()) {
-                $template_args['default_base_price_amount']      = $price->get_pretty(
+                $template_args['default_base_price_amount'] = $price->get_pretty(
                     'PRC_amount',
                     'localized_float'
                 );
@@ -2199,7 +2199,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php',
             $template_args,
             true
         );

caffeinated/admin/new/tickets/Tickets_List_Table.class.php

Indentation +169 added lines, -169 removed lines

@@ -16,173 +16,173 @@
  */
 class Tickets_List_Table extends EE_Admin_List_Table
 {
-    protected function _setup_data()
-    {
-        \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        $trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data = $this->_admin_page->get_default_tickets($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_default_tickets($this->_per_page, true, false);
-        $this->_trashed_count = $this->_admin_page->get_default_tickets($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('ticket', 'event_espresso'),
-            'plural'   => esc_html__('tickets', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />', // Render a checkbox instead of text
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'TKT_name'        => esc_html__('Name', 'event_espresso'),
-            'TKT_description' => esc_html__('Description', 'event_espresso'),
-            'TKT_qty'         => esc_html__('Quantity', 'event_espresso'),
-            'TKT_uses'        => esc_html__('Uses', 'event_espresso'),
-            'TKT_min'         => esc_html__('Minimum', 'event_espresso'),
-            'TKT_max'         => esc_html__('Maximum', 'event_espresso'),
-            'TKT_price'       => esc_html__('Price', 'event_espresso'),
-            'TKT_taxable'     => esc_html__('Taxable', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            // TRUE means its already sorted
-            'id' => array('TKT_ID', false),
-            'TKT_name'        => array('TKT_name', true),
-            'TKT_description' => array('TKT_description', false),
-            'TKT_qty'         => array('TKT_qty', false),
-            'TKT_uses'        => array('TKT_uses', false),
-            'TKT_min'         => array('TKT_min', false),
-            'TKT_max'         => array('TKT_max', false),
-            'TKT_price'       => array('TKT_price', false),
-        );
-
-        $this->_hidden_columns = array();
-    }
-
-
-    protected function _get_table_filters()
-    {
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_tickets', 'trash_ticket')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    public function column_cb($item)
-    {
-        return $item->ID() === 1
-            ? '<span class="dashicons dashicons-lock"></span>'
-            : sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            );
-    }
-
-
-    /**
-     * @param EE_Ticket $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_id($item): string
-    {
-        $content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">' . $this->column_TKT_name($item, false) . '</span>';
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    public function column_TKT_name(EE_Ticket $ticket, bool $prep_content = true): string
-    {
-        // build row actions
-        $actions = array();
-
-        // trash links
-        if ($ticket->ID() !== 1) {
-            if ($this->_view == 'all') {
-                $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'trash_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" aria-label="'
-                                    . esc_attr__('Move Ticket to trash', 'event_espresso') . '">'
-                                    . esc_html__('Trash', 'event_espresso') . '</a>';
-            } else {
-                // restore price link
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'restore_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" aria-label="'
-                                      . esc_attr__('Restore Ticket', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-                // delete price link
-                $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'delete_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['delete'] = '<a href="' . $delete_lnk_url . '" aria-label="'
-                                     . esc_attr__('Delete Ticket Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso') . '</a>';
-            }
-        }
-        // return $ticket->get('TKT_name') . $this->row_actions($actions);
-        $content = $prep_content ? $ticket->name() . $this->row_actions($actions) : $ticket->name();
-        return $prep_content ? $this->columnContent('TKT_name', $content) : $content;
-    }
-
-
-    public function column_TKT_description(EE_Ticket $ticket)
-    {
-        return $this->columnContent('TKT_description', $ticket->description());
-    }
-
-
-    public function column_TKT_qty(EE_Ticket $ticket)
-    {
-
-        return $ticket->get_pretty('TKT_qty', 'text');
-        // return $this->columnContent('TKT_qty', $ticket->qty());
-    }
-
-
-    public function column_TKT_uses(EE_Ticket $ticket)
-    {
-        return $ticket->get_pretty('TKT_uses', 'text');
-    }
-
-
-    public function column_TKT_min(EE_Ticket $ticket)
-    {
-        return $ticket->get('TKT_min');
-    }
-
-
-    public function column_TKT_max(EE_Ticket $ticket)
-    {
-        return $ticket->get_pretty('TKT_max', 'text');
-    }
-
-
-    public function column_TKT_price(EE_Ticket $ticket)
-    {
-        return EEH_Template::format_currency($ticket->get('TKT_price'));
-    }
-
-
-    public function column_TKT_taxable(EE_Ticket $ticket)
-    {
-        return $ticket->get('TKT_taxable') ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso');
-    }
+	protected function _setup_data()
+	{
+		\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		$trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data = $this->_admin_page->get_default_tickets($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_default_tickets($this->_per_page, true, false);
+		$this->_trashed_count = $this->_admin_page->get_default_tickets($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('ticket', 'event_espresso'),
+			'plural'   => esc_html__('tickets', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />', // Render a checkbox instead of text
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'TKT_name'        => esc_html__('Name', 'event_espresso'),
+			'TKT_description' => esc_html__('Description', 'event_espresso'),
+			'TKT_qty'         => esc_html__('Quantity', 'event_espresso'),
+			'TKT_uses'        => esc_html__('Uses', 'event_espresso'),
+			'TKT_min'         => esc_html__('Minimum', 'event_espresso'),
+			'TKT_max'         => esc_html__('Maximum', 'event_espresso'),
+			'TKT_price'       => esc_html__('Price', 'event_espresso'),
+			'TKT_taxable'     => esc_html__('Taxable', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			// TRUE means its already sorted
+			'id' => array('TKT_ID', false),
+			'TKT_name'        => array('TKT_name', true),
+			'TKT_description' => array('TKT_description', false),
+			'TKT_qty'         => array('TKT_qty', false),
+			'TKT_uses'        => array('TKT_uses', false),
+			'TKT_min'         => array('TKT_min', false),
+			'TKT_max'         => array('TKT_max', false),
+			'TKT_price'       => array('TKT_price', false),
+		);
+
+		$this->_hidden_columns = array();
+	}
+
+
+	protected function _get_table_filters()
+	{
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_tickets', 'trash_ticket')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	public function column_cb($item)
+	{
+		return $item->ID() === 1
+			? '<span class="dashicons dashicons-lock"></span>'
+			: sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			);
+	}
+
+
+	/**
+	 * @param EE_Ticket $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_id($item): string
+	{
+		$content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
+		$content .= '<span class="show-on-mobile-view-only">' . $this->column_TKT_name($item, false) . '</span>';
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	public function column_TKT_name(EE_Ticket $ticket, bool $prep_content = true): string
+	{
+		// build row actions
+		$actions = array();
+
+		// trash links
+		if ($ticket->ID() !== 1) {
+			if ($this->_view == 'all') {
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'trash_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['trash'] = '<a href="' . $trash_lnk_url . '" aria-label="'
+									. esc_attr__('Move Ticket to trash', 'event_espresso') . '">'
+									. esc_html__('Trash', 'event_espresso') . '</a>';
+			} else {
+				// restore price link
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'restore_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" aria-label="'
+									  . esc_attr__('Restore Ticket', 'event_espresso') . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+				// delete price link
+				$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'delete_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['delete'] = '<a href="' . $delete_lnk_url . '" aria-label="'
+									 . esc_attr__('Delete Ticket Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso') . '</a>';
+			}
+		}
+		// return $ticket->get('TKT_name') . $this->row_actions($actions);
+		$content = $prep_content ? $ticket->name() . $this->row_actions($actions) : $ticket->name();
+		return $prep_content ? $this->columnContent('TKT_name', $content) : $content;
+	}
+
+
+	public function column_TKT_description(EE_Ticket $ticket)
+	{
+		return $this->columnContent('TKT_description', $ticket->description());
+	}
+
+
+	public function column_TKT_qty(EE_Ticket $ticket)
+	{
+
+		return $ticket->get_pretty('TKT_qty', 'text');
+		// return $this->columnContent('TKT_qty', $ticket->qty());
+	}
+
+
+	public function column_TKT_uses(EE_Ticket $ticket)
+	{
+		return $ticket->get_pretty('TKT_uses', 'text');
+	}
+
+
+	public function column_TKT_min(EE_Ticket $ticket)
+	{
+		return $ticket->get('TKT_min');
+	}
+
+
+	public function column_TKT_max(EE_Ticket $ticket)
+	{
+		return $ticket->get_pretty('TKT_max', 'text');
+	}
+
+
+	public function column_TKT_price(EE_Ticket $ticket)
+	{
+		return EEH_Template::format_currency($ticket->get('TKT_price'));
+	}
+
+
+	public function column_TKT_taxable(EE_Ticket $ticket)
+	{
+		return $ticket->get('TKT_taxable') ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso');
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -97,8 +97,8 @@ 
      */
     public function column_id($item): string
     {
-        $content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">' . $this->column_TKT_name($item, false) . '</span>';
+        $content = '<span class="ee-entity-id">'.$item->ID().'</span>';
+        $content .= '<span class="show-on-mobile-view-only">'.$this->column_TKT_name($item, false).'</span>';
         return $this->columnContent('id', $content, 'end');
     }
 
@@ -115,30 +115,30 @@ 
                     'action' => 'trash_ticket',
                     'TKT_ID' => $ticket->ID(),
                 ), TICKETS_ADMIN_URL);
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" aria-label="'
-                                    . esc_attr__('Move Ticket to trash', 'event_espresso') . '">'
-                                    . esc_html__('Trash', 'event_espresso') . '</a>';
+                $actions['trash'] = '<a href="'.$trash_lnk_url.'" aria-label="'
+                                    . esc_attr__('Move Ticket to trash', 'event_espresso').'">'
+                                    . esc_html__('Trash', 'event_espresso').'</a>';
             } else {
                 // restore price link
                 $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
                     'action' => 'restore_ticket',
                     'TKT_ID' => $ticket->ID(),
                 ), TICKETS_ADMIN_URL);
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" aria-label="'
-                                      . esc_attr__('Restore Ticket', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                $actions['restore'] = '<a href="'.$restore_lnk_url.'" aria-label="'
+                                      . esc_attr__('Restore Ticket', 'event_espresso').'">'
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
                 // delete price link
                 $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
                     'action' => 'delete_ticket',
                     'TKT_ID' => $ticket->ID(),
                 ), TICKETS_ADMIN_URL);
-                $actions['delete'] = '<a href="' . $delete_lnk_url . '" aria-label="'
-                                     . esc_attr__('Delete Ticket Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso') . '</a>';
+                $actions['delete'] = '<a href="'.$delete_lnk_url.'" aria-label="'
+                                     . esc_attr__('Delete Ticket Permanently', 'event_espresso').'">'
+                                     . esc_html__('Delete Permanently', 'event_espresso').'</a>';
             }
         }
         // return $ticket->get('TKT_name') . $this->row_actions($actions);
-        $content = $prep_content ? $ticket->name() . $this->row_actions($actions) : $ticket->name();
+        $content = $prep_content ? $ticket->name().$this->row_actions($actions) : $ticket->name();
         return $prep_content ? $this->columnContent('TKT_name', $content) : $content;
     }