eventespresso / event-espresso-core

core/db_models/EEM_Event.model.php

Spacing +17 added lines, -17 removed lines

@@ -278,7 +278,7 @@ 
             '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->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password = '';
         parent::__construct($timezone);
     }
@@ -371,7 +371,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        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.',
@@ -405,7 +405,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -448,7 +448,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! 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.',
@@ -867,11 +867,11 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
+                $questions[$qg->ID()] = $qg->model_field_array();
+                $questions[$qg->ID()]['QSG_questions'] = array();
                 foreach ($qsts as $qst) {
                     if ($qst->is_system_question()) {
                         continue;
@@ -885,26 +885,26 @@ 
                     $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 . ']';
+                    $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'
+                    $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;
+                    $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;
+                    $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();
+                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
                             }
                         }
                     }

Indentation +915 added lines, -915 removed lines

@@ -15,919 +15,919 @@
 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
-     */
-    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',
-                    __('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
-                ),
-                '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'),
-                    true,
-                    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
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            '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
-     */
-    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',
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                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
-     */
-    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
-     */
-    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 (! isset($EVT_ID) || ! 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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     *
-     * @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
-     * @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).
-     * @throws EE_Error
-     * @return    array
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(__(
-                '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
+	 */
+	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',
+					__('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
+				),
+				'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'),
+					true,
+					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
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'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
+	 */
+	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',
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				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
+	 */
+	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
+	 */
+	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 (! isset($EVT_ID) || ! 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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 *
+	 * @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
+	 * @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).
+	 * @throws EE_Error
+	 * @return    array
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(__(
+				'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/EE_Error.core.php

Indentation +1126 added lines, -1126 removed lines

@@ -10,8 +10,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -25,251 +25,251 @@ 
 class EE_Error extends Exception
 {
 
-    const OPTIONS_KEY_NOTICES = 'ee_notices';
-
-
-    /**
-     * name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/':
-            case 'http://ee4decaf.eventespresso.com/':
-            case 'http://ee4hf.eventespresso.com/':
-            case 'http://ee4a.eventespresso.com/':
-            case 'http://ee4ad.eventespresso.com/':
-            case 'http://ee4b.eventespresso.com/':
-            case 'http://ee4bd.eventespresso.com/':
-            case 'http://ee4d.eventespresso.com/':
-            case 'http://ee4dd.eventespresso.com/':
-                $to = 'developers@eventespresso.com';
-                break;
-            default:
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
-        self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
-        self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
-        self::$_all_exceptions[ $x_time ]['msg'] = $msg;
-        self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
-        self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        // add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-    /**
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
-                     && ! empty(self::$_espresso_notices[ $type_to_check ])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = EE_Error::getStoredNotices();
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-    /**
-     * @echo string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	const OPTIONS_KEY_NOTICES = 'ee_notices';
+
+
+	/**
+	 * name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/':
+			case 'http://ee4decaf.eventespresso.com/':
+			case 'http://ee4hf.eventespresso.com/':
+			case 'http://ee4a.eventespresso.com/':
+			case 'http://ee4ad.eventespresso.com/':
+			case 'http://ee4b.eventespresso.com/':
+			case 'http://ee4bd.eventespresso.com/':
+			case 'http://ee4d.eventespresso.com/':
+			case 'http://ee4dd.eventespresso.com/':
+				$to = 'developers@eventespresso.com';
+				break;
+			default:
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
+		self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
+		self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
+		self::$_all_exceptions[ $x_time ]['msg'] = $msg;
+		self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
+		self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
+		self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		// add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+	/**
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[ $type_to_check ])
+					 && ! empty(self::$_espresso_notices[ $type_to_check ])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = EE_Error::getStoredNotices();
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+	/**
+	 * @echo string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -325,21 +325,21 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __(
-                    'Sorry, but no trace information was available for this exception.',
-                    'event_espresso'
-                );
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __(
+					'Sorry, but no trace information was available for this exception.',
+					'event_espresso'
+				);
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -349,43 +349,43 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            try {
-                                // if $function is a closure, this throws an exception
-                                $b = new ReflectionMethod($class, $function);
-                                $line = $b->getStartLine();
-                            } catch (Exception $closure_exception) {
-                                $line = 'unknown';
-                            }
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							try {
+								// if $function is a closure, this throws an exception
+								$b = new ReflectionMethod($class, $function);
+								$line = $b->getStartLine();
+							} catch (Exception $closure_exception) {
+								$line = 'unknown';
+							}
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -393,626 +393,626 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     * @param string $type whether the message is for a success or error notification
-     * @param string $msg  the message to display to users or developers
-     *                     - adding a double pipe || (OR) creates separate messages for user || dev
-     * @param string $file the file that the error occurred in - just use __FILE__
-     * @param string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param string $line the line number where the error occurred - just use __LINE__
-     * @return void
-     */
-    private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __(
-                        'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'
-                    ),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __(
-                    'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
-            } else {
-                self::$_espresso_notices[ $type ][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success'] = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
-            ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
-            ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
-            ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success'])
-                ? self::$_espresso_notices['success']
-                : array(),
-            'attention' => isset(self::$_espresso_notices['attention'])
-                ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors'])
-                ? self::$_espresso_notices['errors']
-                : array(),
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getStoredNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // get notices for logged in user
-            $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
-            return is_array($notices) ? $notices : array();
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // get notices for user currently engaged in a session
-            $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
-            return is_array($session_data) ? $session_data : array();
-        }
-        // get global notices and hope they apply to the current site visitor
-        $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-        return is_array($notices) ? $notices : array();
-    }
-
-
-    /**
-     * @param array $notices
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function storeNotices(array $notices)
-    {
-        if ($user_id = get_current_user_id()) {
-            // store notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                $notices
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // store notices for user currently engaged in a session
-            return EE_Session::instance()->set_session_data(
-                array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
-            );
-        }
-        // store global notices and hope they apply to the same site visitor on the next request
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
-    }
-
-
-    /**
-     * @return bool|TRUE
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clearNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // clear notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                array()
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // clear notices for user currently engaged in a session
-            return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
-        }
-        // clear global notices and hope none belonged to some for some other site visitor
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-    }
-
-
-    /**
-     * saves notices to the db for retrieval on next request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function stashNoticesBeforeRedirect()
-    {
-        EE_Error::get_notices(false, true);
-    }
-
-
-    /**
-     * compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param boolean $format_output            whether or not to format the messages for display in the WP admin
-     * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param boolean $remove_empty             whether or not to unset empty messages
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        $success_messages = '';
-        $attention_messages = '';
-        $error_messages = '';
-        // either save notices to the db
-        if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
-            self::$_espresso_notices = array_merge(
-                EE_Error::getStoredNotices(),
-                self::$_espresso_notices
-            );
-            EE_Error::storeNotices(self::$_espresso_notices);
-            return array();
-        }
-        $print_scripts = EE_Error::combineExistingAndNewNotices();
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode('<br />', self::$_espresso_notices['success']);
-            $print_scripts = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode('<br />', self::$_espresso_notices['attention']);
-            $print_scripts = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode('<br />', self::$_espresso_notices['errors']);
-            $print_scripts = true;
-        }
-        if ($format_output) {
-            $notices = EE_Error::formatNoticesOutput(
-                $success_messages,
-                $attention_messages,
-                $error_messages
-            );
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[ $type ]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function combineExistingAndNewNotices()
-    {
-        $print_scripts = false;
-        // grab any notices that have been previously saved
-        $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
-                        : array();
-                    // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            EE_Error::clearNotices();
-        }
-        return $print_scripts;
-    }
-
-
-    /**
-     * @param string $success_messages
-     * @param string $attention_messages
-     * @param string $error_messages
-     * @return string
-     */
-    private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
-    {
-        $notices = '<div id="espresso-notices">';
-        $close = is_admin()
-            ? ''
-            : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
-        if ($success_messages !== '') {
-            $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
-            $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-            // showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($attention_messages !== '') {
-            $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
-            $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($error_messages !== '') {
-            $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
-            $css_class = is_admin() ? 'error' : 'error fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        $notices .= '</div>';
-        return $notices;
-    }
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-            }
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-                return '';
-            }
-        } else {
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 * @param string $type whether the message is for a success or error notification
+	 * @param string $msg  the message to display to users or developers
+	 *                     - adding a double pipe || (OR) creates separate messages for user || dev
+	 * @param string $file the file that the error occurred in - just use __FILE__
+	 * @param string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param string $line the line number where the error occurred - just use __LINE__
+	 * @return void
+	 */
+	private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__(
+						'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'
+					),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__(
+					'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+			} else {
+				self::$_espresso_notices[ $type ][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success'] = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
+			? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
+			? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
+			? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success'])
+				? self::$_espresso_notices['success']
+				: array(),
+			'attention' => isset(self::$_espresso_notices['attention'])
+				? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors'])
+				? self::$_espresso_notices['errors']
+				: array(),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getStoredNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// get notices for logged in user
+			$notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
+			return is_array($notices) ? $notices : array();
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// get notices for user currently engaged in a session
+			$session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
+			return is_array($session_data) ? $session_data : array();
+		}
+		// get global notices and hope they apply to the current site visitor
+		$notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+		return is_array($notices) ? $notices : array();
+	}
+
+
+	/**
+	 * @param array $notices
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function storeNotices(array $notices)
+	{
+		if ($user_id = get_current_user_id()) {
+			// store notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				$notices
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// store notices for user currently engaged in a session
+			return EE_Session::instance()->set_session_data(
+				array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
+			);
+		}
+		// store global notices and hope they apply to the same site visitor on the next request
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
+	}
+
+
+	/**
+	 * @return bool|TRUE
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clearNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// clear notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				array()
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// clear notices for user currently engaged in a session
+			return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
+		}
+		// clear global notices and hope none belonged to some for some other site visitor
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+	}
+
+
+	/**
+	 * saves notices to the db for retrieval on next request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function stashNoticesBeforeRedirect()
+	{
+		EE_Error::get_notices(false, true);
+	}
+
+
+	/**
+	 * compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param boolean $format_output            whether or not to format the messages for display in the WP admin
+	 * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param boolean $remove_empty             whether or not to unset empty messages
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		$success_messages = '';
+		$attention_messages = '';
+		$error_messages = '';
+		// either save notices to the db
+		if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
+			self::$_espresso_notices = array_merge(
+				EE_Error::getStoredNotices(),
+				self::$_espresso_notices
+			);
+			EE_Error::storeNotices(self::$_espresso_notices);
+			return array();
+		}
+		$print_scripts = EE_Error::combineExistingAndNewNotices();
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode('<br />', self::$_espresso_notices['success']);
+			$print_scripts = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode('<br />', self::$_espresso_notices['attention']);
+			$print_scripts = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode('<br />', self::$_espresso_notices['errors']);
+			$print_scripts = true;
+		}
+		if ($format_output) {
+			$notices = EE_Error::formatNoticesOutput(
+				$success_messages,
+				$attention_messages,
+				$error_messages
+			);
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[ $type ]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function combineExistingAndNewNotices()
+	{
+		$print_scripts = false;
+		// grab any notices that have been previously saved
+		$notices = EE_Error::getStoredNotices();
+		if (! empty($notices)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
+														&& ! empty(self::$_espresso_notices[ $type ])
+						? self::$_espresso_notices[ $type ]
+						: array();
+					// add newly created notices to existing ones
+					self::$_espresso_notices[ $type ] += $notice;
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			EE_Error::clearNotices();
+		}
+		return $print_scripts;
+	}
+
+
+	/**
+	 * @param string $success_messages
+	 * @param string $attention_messages
+	 * @param string $error_messages
+	 * @return string
+	 */
+	private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
+	{
+		$notices = '<div id="espresso-notices">';
+		$close = is_admin()
+			? ''
+			: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
+		if ($success_messages !== '') {
+			$css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
+			$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+			// showMessage( $success_messages );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $success_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($attention_messages !== '') {
+			$css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
+			$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $attention_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($error_messages !== '') {
+			$css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
+			$css_class = is_admin() ? 'error' : 'error fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $error_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		$notices .= '</div>';
+		return $notices;
+	}
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+			}
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+				return '';
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1022,221 +1022,221 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-    /**
-     * write exception details to log file
-     * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            error_log($exception_log);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'Event Espresso error logging could not be setup because: %s',
-                        'event_espresso'
-                    ),
-                    $e->getMessage()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param string $pan_message  the message to be stored persistently until dismissed
-     * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function add_persistent_admin_notice($pan_name, $pan_message, $force_update = false)
-    {
-        new PersistentAdminNotice(
-            $pan_name,
-            $pan_message,
-            $force_update
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge
-     * @param bool   $return
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ServiceNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $return_url
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+	/**
+	 * write exception details to log file
+	 * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			error_log($exception_log);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'Event Espresso error logging could not be setup because: %s',
+						'event_espresso'
+					),
+					$e->getMessage()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function add_persistent_admin_notice($pan_name, $pan_message, $force_update = false)
+	{
+		new PersistentAdminNotice(
+			$pan_name,
+			$pan_message,
+			$force_update
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge
+	 * @param bool   $return
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ServiceNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $return_url
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
 }
 
 // end of Class EE_Exceptions
@@ -1249,27 +1249,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 }
 
 

core/EE_System.core.php

Indentation +1310 added lines, -1310 removed lines

@@ -27,1314 +27,1314 @@
 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'r ein 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 EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * 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;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null    $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        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 EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($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',
-            array($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', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadRouteMatchSpecifications')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($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',
-            array($this, 'brew_espresso'),
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($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
-     * @throws EE_Error
-     */
-    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
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * 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
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (($this->request->isWordPressApi() || $this->request->isApi())
-            && $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-    /**
-     * 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($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',
-            array($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)
-    {
-        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 = array();
-                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 = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            // 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 ] = array('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 $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
-     */
-    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', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    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)
-    {
-        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)
-    {
-        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)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($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()
-    {
-        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  $activation_history_for_addon     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 $version_to_upgrade_to            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(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            // it exists, so this isn't a completely new install
-            // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                // it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    // we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            // brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -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 _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        // find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $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 _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '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 => $times_activated) {
-                // check there is a record of when this version was activated. Otherwise,
-                // mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        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 = array('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'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-    /**
-     * 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?
-        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 = array();
-        $non_abstract_db_models = array();
-        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::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            array(
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version()),
-            )
-        );
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @throws Exception
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * 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()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
-            try {
-                // load, register, and add shortcodes the new way
-                $this->loader->getShared(
-                    'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                    array(
-                        // and the old way, but we'll put it under control of the new system
-                        EE_Config::getLegacyShortcodesManager(),
-                    )
-                );
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        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 = __(
-                '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(
-                            array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __(
-                '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
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        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', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        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');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
-        $register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $register_custom_taxonomies->registerCustomTaxonomies();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
-        $register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $register_custom_post_types->registerCustomPostTypes();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
-        $register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        $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
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        } elseif ($this->request->isWordPressHeartbeat()) {
-            $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        }
-        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()
-    {
-        if ($this->request->isAdmin()
-            || $this->request->isFrontend()
-            || $this->request->isIframe()
-            || $this->request->isWordPressApi()
-        ) {
-            try {
-                $this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-                $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
-                if ($this->canLoadBlocks()) {
-                    $this->loader->getShared(
-                        'EventEspresso\core\services\editor\BlockRegistrationManager'
-                    );
-                }
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        if ($this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        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');
-    }
-
-
-    /**
-     * 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
-     */
-    public function initialize_last()
-    {
-        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', array($this, 'addEspressoToolbar'));
-        if (($this->request->isAjax() || $this->request->isAdmin())
-            && $this->maintenance_mode->models_can_query()) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
-            $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($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', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('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)
-    {
-        // 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($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     * @return bool
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * 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'r ein 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 EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * 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;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null    $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		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 EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($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',
+			array($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', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadRouteMatchSpecifications')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($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',
+			array($this, 'brew_espresso'),
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($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
+	 * @throws EE_Error
+	 */
+	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
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * 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
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (($this->request->isWordPressApi() || $this->request->isApi())
+			&& $this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+	/**
+	 * 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($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',
+			array($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)
+	{
+		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 = array();
+				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 = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			// 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 ] = array('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 $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
+	 */
+	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', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	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)
+	{
+		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)
+	{
+		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)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($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()
+	{
+		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  $activation_history_for_addon     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 $version_to_upgrade_to            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(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			// it exists, so this isn't a completely new install
+			// check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				// it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					// we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			// brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -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 _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		// find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $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 _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '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 => $times_activated) {
+				// check there is a record of when this version was activated. Otherwise,
+				// mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		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 = array('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'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * 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?
+		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 = array();
+		$non_abstract_db_models = array();
+		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::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			array(
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version()),
+			)
+		);
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @throws Exception
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * 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()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
+			try {
+				// load, register, and add shortcodes the new way
+				$this->loader->getShared(
+					'EventEspresso\core\services\shortcodes\ShortcodesManager',
+					array(
+						// and the old way, but we'll put it under control of the new system
+						EE_Config::getLegacyShortcodesManager(),
+					)
+				);
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		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 = __(
+				'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(
+							array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __(
+				'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
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		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', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						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');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
+		$register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$register_custom_taxonomies->registerCustomTaxonomies();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
+		$register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$register_custom_post_types->registerCustomPostTypes();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
+		$register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		$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
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		} elseif ($this->request->isWordPressHeartbeat()) {
+			$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		}
+		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()
+	{
+		if ($this->request->isAdmin()
+			|| $this->request->isFrontend()
+			|| $this->request->isIframe()
+			|| $this->request->isWordPressApi()
+		) {
+			try {
+				$this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+				$this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
+				if ($this->canLoadBlocks()) {
+					$this->loader->getShared(
+						'EventEspresso\core\services\editor\BlockRegistrationManager'
+					);
+				}
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		if ($this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		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');
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function initialize_last()
+	{
+		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', array($this, 'addEspressoToolbar'));
+		if (($this->request->isAjax() || $this->request->isAdmin())
+			&& $this->maintenance_mode->models_can_query()) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
+			$this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($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', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('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)
+	{
+		// 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($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 * @return bool
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }

core/EE_Registry.core.php

Indentation +1676 added lines, -1676 removed lines

@@ -23,1680 +23,1680 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * StdClass object for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @var EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = array();
-
-    /**
-     * @var EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = array();
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = array();
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated 4.9.62.p
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map  $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map = $dependency_map;
-        $this->mirror = $mirror;
-        $this->class_cache = $class_cache;
-        $this->object_identifier = $object_identifier;
-        // $registry_container = new RegistryContainer();
-        $this->LIB = new RegistryContainer();
-        $this->addons = new RegistryContainer();
-        $this->modules = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name})
-            ? $this->modules->{$module_name}
-            : null;
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'capabilities/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            array(
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            array(
-                EE_MODELS,
-                EE_CORE,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|EE_Addon|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|object $class_name
-     * @param array         $arguments
-     * @param int           $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : array($arguments);
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
-    {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        $class_name,
-        $class_prefix = '',
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$object_identifier})) {
-            return $this->LIB->{$object_identifier};
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (// request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        $class_name,
-        $addon = false,
-        $arguments = array()
-    ) {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        $class_name,
-        $class_prefix = '',
-        $from_db = false,
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent($class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = array(
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : array($arguments);
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                __('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array)
-            ? array_keys($array) === range(0, count($array) - 1)
-            : true;
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            try {
-                // is this a dependency for a specific class ?
-                $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            } catch (ReflectionException $exception) {
-                // uh-oh... most likely a legacy class that has not been autoloaded
-                // let's try to derive the classname from what we have now
-                // and hope that the property var name is close to the class name
-                $param_class = $param->getName();
-                $param_class = str_replace('_', ' ', $param_class);
-                $param_class = ucwords($param_class);
-                $param_class = str_replace(' ', '_', $param_class);
-            }
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            // param is not even a class
-            if (! class_exists($param_class, false)
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            // parameter is type hinted as a class
-            if ($param_class !== null) {
-                // parameter exists as an incoming argument, AND it's the correct class
-                if (array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-                ) {
-                    // skip this argument and move on to the next
-                    continue;
-                }
-                // parameter should be injected
-                if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
-                    $arguments = $this->_resolve_dependency(
-                        $class_name,
-                        $param_class,
-                        $arguments,
-                        $index
-                    );
-                }
-            }
-            if (empty($arguments[ $index ])) {
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        array(),
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        unset($this->addons->{$class_name});
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_{$model_name}"
-            : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name
-            && is_callable(
-                array($model_class_name, 'reset')
-            )) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\assets\Registry'
-        );
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (array('LIB', 'modules') as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     */
-    private static function _reset_and_unset_object($object, $reset_models)
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @deprecated 4.9.62.p
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * StdClass object for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = array();
+
+	/**
+	 * @var EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = array();
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = array();
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated 4.9.62.p
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map  $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map = $dependency_map;
+		$this->mirror = $mirror;
+		$this->class_cache = $class_cache;
+		$this->object_identifier = $object_identifier;
+		// $registry_container = new RegistryContainer();
+		$this->LIB = new RegistryContainer();
+		$this->addons = new RegistryContainer();
+		$this->modules = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name})
+			? $this->modules->{$module_name}
+			: null;
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts/',
+				EE_CORE . 'capabilities/',
+				EE_CORE . 'request_stack/',
+				EE_CORE . 'middleware/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			array(
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages/',
+			EE_LIBRARIES . 'shortcodes/',
+			EE_LIBRARIES . 'qtips/',
+			EE_LIBRARIES . 'payment_methods/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			array(
+				EE_MODELS,
+				EE_CORE,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields/',
+			EE_MODELS . 'helpers/',
+			EE_MODELS . 'relations/',
+			EE_MODELS . 'strategies/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|EE_Addon|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}// obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|object $class_name
+	 * @param array         $arguments
+	 * @param int           $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : array($arguments);
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
+	{
+		return isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		$class_name,
+		$class_prefix = '',
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$object_identifier})) {
+			return $this->LIB->{$object_identifier};
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (// request does not contain new arguments and therefore no args identifier
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		$class_name,
+		$addon = false,
+		$arguments = array()
+	) {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		$class_name,
+		$class_prefix = '',
+		$from_db = false,
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent($class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = array(
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			);
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: array($arguments);
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array)
+			? array_keys($array) === range(0, count($array) - 1)
+			: true;
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			try {
+				// is this a dependency for a specific class ?
+				$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			} catch (ReflectionException $exception) {
+				// uh-oh... most likely a legacy class that has not been autoloaded
+				// let's try to derive the classname from what we have now
+				// and hope that the property var name is close to the class name
+				$param_class = $param->getName();
+				$param_class = str_replace('_', ' ', $param_class);
+				$param_class = ucwords($param_class);
+				$param_class = str_replace(' ', '_', $param_class);
+			}
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			// param is not even a class
+			if (! class_exists($param_class, false)
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& array_key_exists($argument_keys[ $index ], $arguments)
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			// parameter is type hinted as a class
+			if ($param_class !== null) {
+				// parameter exists as an incoming argument, AND it's the correct class
+				if (array_key_exists($index, $argument_keys)
+					&& isset($arguments[ $argument_keys[ $index ] ])
+					&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+				) {
+					// skip this argument and move on to the next
+					continue;
+				}
+				// parameter should be injected
+				if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
+					$arguments = $this->_resolve_dependency(
+						$class_name,
+						$param_class,
+						$arguments,
+						$index
+					);
+				}
+			}
+			if (empty($arguments[ $index ])) {
+				$arguments[ $index ] = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						array(),
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		unset($this->addons->{$class_name});
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_{$model_name}"
+			: $model_name;
+		if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name
+			&& is_callable(
+				array($model_class_name, 'reset')
+			)) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\assets\Registry'
+		);
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (array('LIB', 'modules') as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 */
+	private static function _reset_and_unset_object($object, $reset_models)
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -193,7 +193,7 @@ 
         ObjectIdentifier $object_identifier = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry
+        if ( ! self::$_instance instanceof EE_Registry
             && $dependency_map instanceof EE_Dependency_Map
             && $mirror instanceof Mirror
             && $class_cache instanceof ClassInterfaceCache
@@ -308,10 +308,10 @@ 
         $i18n_js_strings = (array) self::$i18n_js_strings;
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
             }
         }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -330,7 +330,7 @@ 
             $module_class = get_class($module);
             $this->modules->{$module_class} = $module;
         } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -371,10 +371,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'capabilities/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
+                EE_CORE.'data_migration_scripts/',
+                EE_CORE.'capabilities/',
+                EE_CORE.'request_stack/',
+                EE_CORE.'middleware/',
             )
         );
         // retrieve instantiated class
@@ -409,7 +409,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services/',
+                EE_CORE.'services/',
             )
         );
         // retrieve instantiated class
@@ -544,10 +544,10 @@ 
     {
         $paths = array(
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
+            EE_LIBRARIES.'messages/',
+            EE_LIBRARIES.'shortcodes/',
+            EE_LIBRARIES.'qtips/',
+            EE_LIBRARIES.'payment_methods/',
         );
         // retrieve instantiated class
         return $this->_load(
@@ -615,10 +615,10 @@ 
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
     {
         $paths = array(
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
+            EE_MODELS.'fields/',
+            EE_MODELS.'helpers/',
+            EE_MODELS.'relations/',
+            EE_MODELS.'strategies/',
         );
         // retrieve instantiated class
         return $this->_load(
@@ -642,7 +642,7 @@ 
      */
     public function is_model_name($model_name)
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -763,7 +763,7 @@ 
                 return $cached_class;
             }
         }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
         if ($loader instanceof Closure) {
             $class_obj = $loader($arguments);
         } else {
@@ -805,7 +805,7 @@ 
             case 1:
                 // if it's a FQCN then maybe the class is registered with a preceding \
                 $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -859,11 +859,11 @@ 
         // strip php file extension
         $class_name = str_replace('.php', '', trim($class_name));
         // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name = $this->class_cache->getFqnForAlias($class_name);
         $class_exists = class_exists($class_name, false);
@@ -883,7 +883,7 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        if ( ! $class_exists) {
             // get full path to file
             $path = $this->_resolve_path($class_name, $type, $file_paths);
             // load the file
@@ -894,7 +894,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -922,8 +922,8 @@ 
      */
     protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
     {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
+        return isset($this->_class_abbreviations[$class_name])
+            ? $this->_class_abbreviations[$class_name]
             : $default;
     }
 
@@ -1056,7 +1056,7 @@ 
             $this->addons->{$class_name} = $class_obj;
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
             $this->LIB->{$class_name} = $class_obj;
         }
@@ -1087,13 +1087,13 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, '/').'/'.$class_name.'.'.$type.'php';
             // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
+            if (is_readable($file_paths[$key])) {
+                return $file_paths[$key];
             }
         }
         return false;
@@ -1118,7 +1118,7 @@ 
         // don't give up! you gotta...
         try {
             // does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // just in case the file has already been autoloaded,
                 // but discrepancies in the naming schema are preventing it from
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1136,7 +1136,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1179,8 +1179,8 @@ 
             $legacy_parent_class_map = array(
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
             );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+            if (isset($legacy_parent_class_map[$class_name])) {
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
             }
         } catch (Exception $exception) {
         }
@@ -1312,7 +1312,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1338,10 +1338,10 @@ 
                 ? $this->class_cache->getFqnForAlias($param_class, $class_name)
                 : $param_class;
             // param is not even a class
-            if (! class_exists($param_class, false)
+            if ( ! class_exists($param_class, false)
                 // and something already exists in the incoming arguments for this param
                 && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
+                && array_key_exists($argument_keys[$index], $arguments)
             ) {
                 // so let's skip this argument and move on to the next
                 continue;
@@ -1350,8 +1350,8 @@ 
             if ($param_class !== null) {
                 // parameter exists as an incoming argument, AND it's the correct class
                 if (array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                    && isset($arguments[$argument_keys[$index]])
+                    && $arguments[$argument_keys[$index]] instanceof $param_class
                 ) {
                     // skip this argument and move on to the next
                     continue;
@@ -1366,8 +1366,8 @@ 
                     );
                 }
             }
-            if (empty($arguments[ $index ])) {
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
+            if (empty($arguments[$index])) {
+                $arguments[$index] = $this->mirror->getParameterDefaultValue(
                     $param,
                     $class_name,
                     $index
@@ -1429,7 +1429,7 @@ 
         // did we successfully find the correct dependency ?
         if ($dependency instanceof $param_class) {
             // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
+            $arguments[$index] = $dependency;
         }
         return $arguments;
     }
@@ -1524,7 +1524,7 @@ 
     {
         $addons = array();
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1543,7 +1543,7 @@ 
         $model_class_name = strpos($model_name, 'EEM_') !== 0
             ? "EEM_{$model_name}"
             : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
             return null;
         }
         // get that model reset it and make sure we nuke the old reference to it
@@ -1635,7 +1635,7 @@ 
      */
     private static function _reset_and_unset_object($object, $reset_models)
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1655,7 +1655,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;
@@ -1672,7 +1672,7 @@ 
         $cpt_models = array();
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
+                $cpt_models[$short_name] = $classname;
             }
         }
         return $cpt_models;

core/EE_Config.core.php

Indentation +3176 added lines, -3176 removed lines

@@ -14,2537 +14,2537 @@ 
 final class EE_Config implements ResettableInterface
 {
 
-    const OPTION_NAME = 'ee_config';
-
-    const LOG_NAME = 'ee_config_log';
-
-    const LOG_LENGTH = 100;
-
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
-
-    /**
-     *    instance of the EE_Config object
-     *
-     * @var    EE_Config $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean $_logging_enabled
-     */
-    private static $_logging_enabled = false;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * An StdClass whose property names are addon slugs,
-     * and values are their config classes
-     *
-     * @var StdClass
-     */
-    public $addons;
-
-    /**
-     * @var EE_Admin_Config
-     */
-    public $admin;
-
-    /**
-     * @var EE_Core_Config
-     */
-    public $core;
-
-    /**
-     * @var EE_Currency_Config
-     */
-    public $currency;
-
-    /**
-     * @var EE_Organization_Config
-     */
-    public $organization;
-
-    /**
-     * @var EE_Registration_Config
-     */
-    public $registration;
-
-    /**
-     * @var EE_Template_Config
-     */
-    public $template_settings;
-
-    /**
-     * Holds EE environment values.
-     *
-     * @var EE_Environment_Config
-     */
-    public $environment;
-
-    /**
-     * settings pertaining to Google maps
-     *
-     * @var EE_Map_Config
-     */
-    public $map_settings;
-
-    /**
-     * settings pertaining to Taxes
-     *
-     * @var EE_Tax_Config
-     */
-    public $tax_settings;
-
-    /**
-     * Settings pertaining to global messages settings.
-     *
-     * @var EE_Messages_Config
-     */
-    public $messages;
-
-    /**
-     * @deprecated
-     * @var EE_Gateway_Config
-     */
-    public $gateway;
-
-    /**
-     * @var    array $_addon_option_names
-     * @access    private
-     */
-    private $_addon_option_names = array();
-
-    /**
-     * @var    array $_module_route_map
-     * @access    private
-     */
-    private static $_module_route_map = array();
-
-    /**
-     * @var    array $_module_forward_map
-     * @access    private
-     */
-    private static $_module_forward_map = array();
-
-    /**
-     * @var    array $_module_view_map
-     * @access    private
-     */
-    private static $_module_view_map = array();
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Config instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the config
-     *
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
-     *                               reflect its state in the database
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
-     *                               site was put into maintenance mode)
-     * @return EE_Config
-     */
-    public static function reset($hard_reset = false, $reinstantiate = true)
-    {
-        if (self::$_instance instanceof EE_Config) {
-            if ($hard_reset) {
-                self::$_instance->legacy_shortcodes_manager = null;
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
-        }
-        self::$_instance = null;
-        // we don't need to reset the static properties imo because those should
-        // only change when a module is added or removed. Currently we don't
-        // support removing a module during a request when it previously existed
-        if ($reinstantiate) {
-            return self::instance();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Config__construct__begin', $this);
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
-        // setup empty config classes
-        $this->_initialize_config();
-        // load existing EE site settings
-        $this->_load_core_config();
-        // confirm everything loaded correctly and set filtered defaults if not
-        $this->_verify_config();
-        //  register shortcodes and modules
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_and_modules'),
-            999
-        );
-        //  initialize shortcodes and modules
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
-        // register widgets
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
-        // shutdown
-        add_action('shutdown', array($this, 'shutdown'), 10);
-        // construct__end hook
-        do_action('AHEE__EE_Config__construct__end', $this);
-        // hardcoded hack
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function logging_enabled()
-    {
-        return self::$_logging_enabled;
-    }
-
-
-    /**
-     * use to get the current theme if needed from static context
-     *
-     * @return string current theme set.
-     */
-    public static function get_current_theme()
-    {
-        return isset(self::$_instance->template_settings->current_espresso_theme)
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     *        _initialize_config
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_config()
-    {
-        EE_Config::trim_log();
-        // set defaults
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
-        $this->addons = new stdClass();
-        // set _module_route_map
-        EE_Config::$_module_route_map = array();
-        // set _module_forward_map
-        EE_Config::$_module_forward_map = array();
-        // set _module_view_map
-        EE_Config::$_module_view_map = array();
-    }
-
-
-    /**
-     *        load core plugin configuration
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_core_config()
-    {
-        // load_core_config__start hook
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
-        $espresso_config = $this->get_espresso_config();
-        foreach ($espresso_config as $config => $settings) {
-            // load_core_config__start hook
-            $settings = apply_filters(
-                'FHEE__EE_Config___load_core_config__config_settings',
-                $settings,
-                $config,
-                $this
-            );
-            if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
-                // call configs populate method to ensure any defaults are set for empty values.
-                if (method_exists($settings, 'populate')) {
-                    $this->{$config}->populate();
-                }
-                if (method_exists($settings, 'do_hooks')) {
-                    $this->{$config}->do_hooks();
-                }
-            }
-        }
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
-            $this->update_espresso_config();
-        }
-        // load_core_config__end hook
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
-    }
-
-
-    /**
-     *    _verify_config
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _verify_config()
-    {
-        $this->core = $this->core instanceof EE_Core_Config
-            ? $this->core
-            : new EE_Core_Config();
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
-        $this->organization = $this->organization instanceof EE_Organization_Config
-            ? $this->organization
-            : new EE_Organization_Config();
-        $this->organization = apply_filters(
-            'FHEE__EE_Config___initialize_config__organization',
-            $this->organization
-        );
-        $this->currency = $this->currency instanceof EE_Currency_Config
-            ? $this->currency
-            : new EE_Currency_Config();
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
-        $this->registration = $this->registration instanceof EE_Registration_Config
-            ? $this->registration
-            : new EE_Registration_Config();
-        $this->registration = apply_filters(
-            'FHEE__EE_Config___initialize_config__registration',
-            $this->registration
-        );
-        $this->admin = $this->admin instanceof EE_Admin_Config
-            ? $this->admin
-            : new EE_Admin_Config();
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
-            ? $this->template_settings
-            : new EE_Template_Config();
-        $this->template_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__template_settings',
-            $this->template_settings
-        );
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
-            ? $this->map_settings
-            : new EE_Map_Config();
-        $this->map_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__map_settings',
-            $this->map_settings
-        );
-        $this->environment = $this->environment instanceof EE_Environment_Config
-            ? $this->environment
-            : new EE_Environment_Config();
-        $this->environment = apply_filters(
-            'FHEE__EE_Config___initialize_config__environment',
-            $this->environment
-        );
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
-            ? $this->tax_settings
-            : new EE_Tax_Config();
-        $this->tax_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__tax_settings',
-            $this->tax_settings
-        );
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
-        $this->messages = $this->messages instanceof EE_Messages_Config
-            ? $this->messages
-            : new EE_Messages_Config();
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
-            ? $this->gateway
-            : new EE_Gateway_Config();
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
-        $this->legacy_shortcodes_manager = null;
-    }
-
-
-    /**
-     *    get_espresso_config
-     *
-     * @access    public
-     * @return    array of espresso config stuff
-     */
-    public function get_espresso_config()
-    {
-        // grab espresso configuration
-        return apply_filters(
-            'FHEE__EE_Config__get_espresso_config__CFG',
-            get_option(EE_Config::OPTION_NAME, array())
-        );
-    }
-
-
-    /**
-     *    double_check_config_comparison
-     *
-     * @access    public
-     * @param string $option
-     * @param        $old_value
-     * @param        $value
-     */
-    public function double_check_config_comparison($option, $old_value, $value)
-    {
-        // make sure we're checking the ee config
-        if ($option === EE_Config::OPTION_NAME) {
-            // run a loose comparison of the old value against the new value for type and properties,
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-            if ($value != $old_value) {
-                // if they are NOT the same, then remove the hook,
-                // which means the subsequent update results will be based solely on the update query results
-                // the reason we do this is because, as stated above,
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
-                // this happens PRIOR to serialization and any subsequent update.
-                // If values are found to match their previous old value,
-                // then WP bails before performing any update.
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
-                // it just pulled from the db, with the one being passed to it (which will not match).
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
-                // MySQL MAY ALSO NOT perform the update because
-                // the string it sees in the db looks the same as the new one it has been passed!!!
-                // This results in the query returning an "affected rows" value of ZERO,
-                // which gets returned immediately by WP update_option and looks like an error.
-                remove_action('update_option', array($this, 'check_config_updated'));
-            }
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     */
-    protected function _reset_espresso_addon_config()
-    {
-        $this->_addon_option_names = array();
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
-            if ($addon_config_obj instanceof EE_Config_Base) {
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
-            }
-            $this->addons->{$addon_name} = null;
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     * @param   bool $add_success
-     * @param   bool $add_error
-     * @return   bool
-     */
-    public function update_espresso_config($add_success = false, $add_error = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
-        // $clone = clone( self::$_instance );
-        // self::$_instance = NULL;
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
-        $this->_reset_espresso_addon_config();
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
-        // but BEFORE the actual update occurs
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
-        $this->legacy_shortcodes_manager = null;
-        // now update "ee_config"
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        EE_Config::log(EE_Config::OPTION_NAME);
-        // if not saved... check if the hook we just added still exists;
-        // if it does, it means one of two things:
-        // that update_option bailed at the($value === $old_value) conditional,
-        // or...
-        // the db update query returned 0 rows affected
-        // (probably because the data  value was the same from it's perspective)
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
-        // but just means no update occurred, so don't display an error to the user.
-        // BUT... if update_option returns FALSE, AND the hook is missing,
-        // then it means that something truly went wrong
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
-        // remove our action since we don't want it in the system anymore
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
-        // self::$_instance = $clone;
-        // unset( $clone );
-        // if config remains the same or was updated successfully
-        if ($saved) {
-            if ($add_success) {
-                EE_Error::add_success(
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        } else {
-            if ($add_error) {
-                EE_Error::add_error(
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-    /**
-     *    _verify_config_params
-     *
-     * @access    private
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @param    array          $tests_to_run
-     * @param    bool           $display_errors
-     * @return    bool    TRUE on success, FALSE on fail
-     */
-    private function _verify_config_params(
-        $section = '',
-        $name = '',
-        $config_class = '',
-        $config_obj = null,
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
-        $display_errors = true
-    ) {
-        try {
-            foreach ($tests_to_run as $test) {
-                switch ($test) {
-                    // TEST #1 : check that section was set
-                    case 1:
-                        if (empty($section)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'No configuration section has been provided while attempting to save "%s".',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #2 : check that settings section exists
-                    case 2:
-                        if (! isset($this->{$section})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #3 : check that section is the proper format
-                    case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
-                        ) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" configuration settings have not been formatted correctly.',
-                                            'event_espresso'
-                                        ),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #4 : check that config section name has been set
-                    case 4:
-                        if (empty($name)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #5 : check that a config class name has been set
-                    case 5:
-                        if (empty($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No class name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #6 : verify config class is accessible
-                    case 6:
-                        if (! class_exists($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #7 : check that config has even been set
-                    case 7:
-                        if (! isset($this->{$section}->{$name})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
-                                        $section,
-                                        $name
-                                    )
-                                );
-                            }
-                            return false;
-                        } else {
-                            // and make sure it's not serialized
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
-                        }
-                        break;
-                    // TEST #8 : check that config is the requested type
-                    case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
-                                            'event_espresso'
-                                        ),
-                                        $section,
-                                        $name,
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #9 : verify config object
-                    case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
-                                        print_r($config_obj, true)
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        // you have successfully run the gauntlet
-        return true;
-    }
-
-
-    /**
-     *    _generate_config_option_name
-     *
-     * @access        protected
-     * @param        string $section
-     * @param        string $name
-     * @return        string
-     */
-    private function _generate_config_option_name($section = '', $name = '')
-    {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
-    }
-
-
-    /**
-     *    _set_config_class
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
-     *
-     * @access    private
-     * @param    string $config_class
-     * @param    string $name
-     * @return    string
-     */
-    private function _set_config_class($config_class = '', $name = '')
-    {
-        return ! empty($config_class)
-            ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
-    }
-
-
-    /**
-     *    set_config
-     *
-     * @access    protected
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @return    EE_Config_Base
-     */
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
-            $this->update_addon_option_names();
-        }
-        // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            $config_obj = new $config_class();
-        }
-        if (get_option($config_option_name)) {
-            EE_Config::log($config_option_name);
-            update_option($config_option_name, $config_obj);
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        } else {
-            // create a wp-option for this config
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
-                return $this->{$section}->{$name};
-            } else {
-                EE_Error::add_error(
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return null;
-            }
-        }
-    }
-
-
-    /**
-     *    update_config
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
-     *
-     * @access    public
-     * @param    string                $section
-     * @param    string                $name
-     * @param    EE_Config_Base|string $config_obj
-     * @param    bool                  $throw_errors
-     * @return    bool
-     */
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        $config_obj = maybe_unserialize($config_obj);
-        // get class name of the incoming object
-        $config_class = get_class($config_obj);
-        // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
-            $section,
-            $name,
-            $config_class,
-            $config_obj,
-            array(1, 2, 3, 4, 7, 9)
-        )
-        ) {
-            return false;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            // save new config to db
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
-                return true;
-            }
-        } else {
-            // first check if the record already exists
-            $existing_config = get_option($config_option_name);
-            $config_obj = serialize($config_obj);
-            // just return if db record is already up to date (NOT type safe comparison)
-            if ($existing_config == $config_obj) {
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif (update_option($config_option_name, $config_obj)) {
-                EE_Config::log($config_option_name);
-                // update wp-option for this config class
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif ($throw_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
-                            'event_espresso'
-                        ),
-                        $config_class,
-                        'EE_Config->' . $section . '->' . $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    get_config
-     *
-     * @access    public
-     * @param    string $section
-     * @param    string $name
-     * @param    string $config_class
-     * @return    mixed EE_Config_Base | NULL
-     */
-    public function get_config($section = '', $name = '', $config_class = '')
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        // now test if the requested config object exists, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
-            // config already exists, so pass it back
-            return $this->{$section}->{$name};
-        }
-        // load config option from db if it exists
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
-        // verify the newly retrieved config object, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            // config is good, so set it and pass it back
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        }
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
-        $config_obj = $this->set_config($section, $name, $config_class);
-        // verify the newly created config object
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
-            return $this->{$section}->{$name};
-        } else {
-            EE_Error::add_error(
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_config_option
-     *
-     * @access    public
-     * @param    string $config_option_name
-     * @return    mixed EE_Config_Base | FALSE
-     */
-    public function get_config_option($config_option_name = '')
-    {
-        // retrieve the wp-option for this config class.
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
-        if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
-        }
-        return $config_option;
-    }
-
-
-    /**
-     * log
-     *
-     * @param string $config_option_name
-     */
-    public static function log($config_option_name = '')
-    {
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
-            $config_log = get_option(EE_Config::LOG_NAME, array());
-            // copy incoming $_REQUEST and sanitize it so we can save it
-            $_request = $_REQUEST;
-            array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
-                'config_name' => $config_option_name,
-                'request'     => $_request,
-            );
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     * trim_log
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
-     */
-    public static function trim_log()
-    {
-        if (! EE_Config::logging_enabled()) {
-            return;
-        }
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
-        $log_length = count($config_log);
-        if ($log_length > EE_Config::LOG_LENGTH) {
-            ksort($config_log);
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     *    get_page_for_posts
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
-     *    wp-option "page_for_posts", or "posts" if no page is selected
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function get_page_for_posts()
-    {
-        $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
-            return 'posts';
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
-    }
-
-
-    /**
-     *    register_shortcodes_and_modules.
-     *    At this point, it's too early to tell if we're maintenance mode or not.
-     *    In fact, this is where we give modules a chance to let core know they exist
-     *    so they can help trigger maintenance mode if it's needed
-     *
-     * @access    public
-     * @return    void
-     */
-    public function register_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        EE_Registry::instance()->modules = $this->_register_modules();
-    }
-
-
-    /**
-     *    initialize_shortcodes_and_modules
-     *    meaning they can start adding their hooks to get stuff done
-     *
-     * @access    public
-     * @return    void
-     */
-    public function initialize_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        $this->_initialize_modules();
-    }
-
-
-    /**
-     *    widgets_init
-     *
-     * @access private
-     * @return void
-     */
-    public function widgets_init()
-    {
-        // only init widgets on admin pages when not in complete maintenance, and
-        // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
-            || (
-                is_admin()
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-            )
-        ) {
-            // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
-            // filter list of modules to register
-            $widgets_to_register = apply_filters(
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
-                $widgets_to_register
-            );
-            if (! empty($widgets_to_register)) {
-                // cycle thru widget folders
-                foreach ($widgets_to_register as $widget_path) {
-                    // add to list of installed widget modules
-                    EE_Config::register_ee_widget($widget_path);
-                }
-            }
-            // filter list of installed modules
-            EE_Registry::instance()->widgets = apply_filters(
-                'FHEE__EE_Config__register_widgets__installed_widgets',
-                EE_Registry::instance()->widgets
-            );
-        }
-    }
-
-
-    /**
-     *    register_ee_widget - makes core aware of this widget
-     *
-     * @access    public
-     * @param    string $widget_path - full path up to and including widget folder
-     * @return    void
-     */
-    public static function register_ee_widget($widget_path = null)
-    {
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
-        $widget_ext = '.widget.php';
-        // make all separators match
-        $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($widget_path, $widget_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $file_name = explode('.', basename($widget_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
-            // sanitize shortcode directory name
-            $widget = sanitize_key($widget);
-            // now we need to rebuild the shortcode path
-            $widget_path = explode('/', $widget_path);
-            // remove last segment
-            array_pop($widget_path);
-            // glue it back together
-            $widget_path = implode(DS, $widget_path);
-        } else {
-            // grab and sanitize widget directory name
-            $widget = sanitize_key(basename($widget_path));
-        }
-        // create classname from widget directory name
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
-        // add class prefix
-        $widget_class = 'EEW_' . $widget;
-        // does the widget exist ?
-        if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                    'event_espresso'
-                ),
-                $widget_class,
-                $widget_path . '/' . $widget_class . $widget_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        // load the widget class file
-        require_once($widget_path . '/' . $widget_class . $widget_ext);
-        // verify that class exists
-        if (! class_exists($widget_class)) {
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        register_widget($widget_class);
-        // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext;
-    }
-
-
-    /**
-     *        _register_modules
-     *
-     * @access private
-     * @return array
-     */
-    private function _register_modules()
-    {
-        // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $modules_to_register = apply_filters(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            $modules_to_register
-        );
-        if (! empty($modules_to_register)) {
-            // loop through folders
-            foreach ($modules_to_register as $module_path) {
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
-                ) {
-                    // add to list of installed modules
-                    EE_Config::register_module($module_path);
-                }
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_modules__installed_modules',
-            EE_Registry::instance()->modules
-        );
-    }
-
-
-    /**
-     *    register_module - makes core aware of this module
-     *
-     * @access    public
-     * @param    string $module_path - full path up to and including module folder
-     * @return    bool
-     */
-    public static function register_module($module_path = null)
-    {
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
-        $module_ext = '.module.php';
-        // make all separators match
-        $module_path = str_replace(array('\\', '/'), '/', $module_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($module_path, $module_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $module_file = explode('.', basename($module_path));
-            // now we need to rebuild the shortcode path
-            $module_path = explode('/', $module_path);
-            // remove last segment
-            array_pop($module_path);
-            // glue it back together
-            $module_path = implode('/', $module_path) . '/';
-            // take first segment from file name pieces and sanitize it
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
-            // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize module name
-            $module = strtolower(basename($module_path));
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
-            // like trailingslashit()
-            $module_path = rtrim($module_path, '/') . '/';
-            // create classname from module directory name
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
-            // add class prefix
-            $module_class = 'EED_' . $module;
-        }
-        // does the module exist ?
-        if (! is_readable($module_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($module_path . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
-        do_action(
-            'AHEE__EE_Config__register_module__complete',
-            $module_class,
-            EE_Registry::instance()->modules->{$module_class}
-        );
-        return true;
-    }
-
-
-    /**
-     *    _initialize_modules
-     *    allow modules to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_modules()
-    {
-        // cycle thru shortcode folders
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($module_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($module_class, 'set_hooks')
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    register_route - adds module method routes to route_map
-     *
-     * @access    public
-     * @param    string $route       - "pretty" public alias for module method
-     * @param    string $module      - module name (classname without EED_ prefix)
-     * @param    string $method_name - the actual module method to be routed to
-     * @param    string $key         - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
-        $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($route)) {
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! method_exists('EED_' . $module, $method_name)) {
-            $msg = sprintf(
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
-        return true;
-    }
-
-
-    /**
-     *    get_route - get module method route
-     *
-     * @access    public
-     * @param    string $route - "pretty" public alias for module method
-     * @param    string $key   - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_route($route = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_route__begin', $route);
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_routes - get ALL module method routes
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_routes()
-    {
-        return EE_Config::$_module_route_map;
-    }
-
-
-    /**
-     *    register_forward - allows modules to forward request to another module for further processing
-     *
-     * @access    public
-     * @param    string       $route   - "pretty" public alias for module method
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
-     *                                 class, allows different forwards to be served based on status
-     * @param    array|string $forward - function name or array( class, method )
-     * @param    string       $key     - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($forward)) {
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (is_array($forward)) {
-            if (! isset($forward[1])) {
-                $msg = sprintf(
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-            if (! method_exists($forward[0], $forward[1])) {
-                $msg = sprintf(
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                    $forward[1],
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        } elseif (! function_exists($forward)) {
-            $msg = sprintf(
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                $forward,
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
-        return true;
-    }
-
-
-    /**
-     *    get_forward - get forwarding route
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different forwards to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    register_forward - allows modules to specify different view templates for different method routes and status
-     *    results
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $view
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! is_readable($view)) {
-            $msg = sprintf(
-                __(
-                    'The %s view file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $view
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
-        return true;
-    }
-
-
-    /**
-     *    get_view - get view for route and status
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_view($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    public function update_addon_option_names()
-    {
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
-    }
-
-
-    public function shutdown()
-    {
-        $this->update_addon_option_names();
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public static function getLegacyShortcodesManager()
-    {
-
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
-                EE_Registry::instance()
-            );
-        }
-        return EE_Config::instance()->legacy_shortcodes_manager;
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @deprecated 4.9.26
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public static function register_shortcode($shortcode_path = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
-    }
-}
-
-/**
- * Base class used for config classes. These classes should generally not have
- * magic functions in use, except we'll allow them to magically set and get stuff...
- * basically, they should just be well-defined stdClasses
- */
-class EE_Config_Base
-{
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name = get_class($this);
-        $defaults = new $class_name;
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach (get_object_vars($defaults) as $property => $value) {
-            if ($this->{$property} === null) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    /**
-     *        __isset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __unset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __clone
-     */
-    public function __clone()
-    {
-    }
-
-
-    /**
-     *        __wakeup
-     */
-    public function __wakeup()
-    {
-    }
-
-
-    /**
-     *        __destruct
-     */
-    public function __destruct()
-    {
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Core_Config extends EE_Config_Base
-{
-
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
-
-
-    public $current_blog_id;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public $post_shortcodes;
-
-    public $module_route_map;
-
-    public $module_forward_map;
-
-    public $module_view_map;
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_id;
-
-    public $txn_page_id;
-
-    public $thank_you_page_id;
-
-    public $cancel_page_id;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_url;
-
-    public $txn_page_url;
-
-    public $thank_you_page_url;
-
-    public $cancel_page_url;
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public $event_cpt_slug;
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool
-     */
-    public static $ee_ueip_option;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id = get_current_blog_id();
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        $this->post_shortcodes = array();
-        $this->module_route_map = array();
-        $this->module_forward_map = array();
-        $this->module_view_map = array();
-        // critical EE page IDs
-        $this->reg_page_id = 0;
-        $this->txn_page_id = 0;
-        $this->thank_you_page_id = 0;
-        $this->cancel_page_id = 0;
-        // critical EE page URLs
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->thank_you_page_url = '';
-        $this->cancel_page_url = '';
-        // cpt slugs
-        $this->event_cpt_slug = __('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array()
-    {
-        return array(
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array()
-    {
-        return array(
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        );
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function reg_page_url()
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                array('uts' => time()),
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function txn_page_url($query_args = array())
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        } else {
-            return $this->txn_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function thank_you_page_url($query_args = array())
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        } else {
-            return $this->thank_you_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function cancel_page_url()
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->cancel_page_url = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return bool
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option(self::OPTION_NAME_UXIP, false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (EE_Core_Config::$ee_ueip_option !== null) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
-        $option = self::OPTION_NAME_UXIP;
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if (false !== $pre) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if ($property === self::OPTION_NAME_UXIP) {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
-}
-
-/**
- * Config class for storing info on the Organization
- */
-class EE_Organization_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $name
-     * eg EE4.1
-     */
-    public $name;
-
-    /**
-     * @var string $address_1
-     * eg 123 Onna Road
-     */
-    public $address_1 = '';
-
-    /**
-     * @var string $address_2
-     * eg PO Box 123
-     */
-    public $address_2 = '';
-
-    /**
-     * @var string $city
-     * eg Inna City
-     */
-    public $city = '';
-
-    /**
-     * @var int $STA_ID
-     * eg 4
-     */
-    public $STA_ID = 0;
-
-    /**
-     * @var string $CNT_ISO
-     * eg US
-     */
-    public $CNT_ISO = '';
-
-    /**
-     * @var string $zip
-     * eg 12345  or V1A 2B3
-     */
-    public $zip = '';
-
-    /**
-     * @var string $email
-     * eg support@eventespresso.com
-     */
-    public $email;
-
-    /**
-     * @var string $phone
-     * eg. 111-111-1111
-     */
-    public $phone = '';
-
-    /**
-     * @var string $vat
-     * VAT/Tax Number
-     */
-    public $vat = '';
-
-    /**
-     * @var string $logo_url
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
-     */
-    public $logo_url = '';
-
-    /**
-     * The below are all various properties for holding links to organization social network profiles
-     *
-     * @var string
-     */
-    /**
-     * facebook (facebook.com/profile.name)
-     *
-     * @var string
-     */
-    public $facebook = '';
-
-    /**
-     * twitter (twitter.com/twitter_handle)
-     *
-     * @var string
-     */
-    public $twitter = '';
-
-    /**
-     * linkedin (linkedin.com/in/profile_name)
-     *
-     * @var string
-     */
-    public $linkedin = '';
-
-    /**
-     * pinterest (www.pinterest.com/profile_name)
-     *
-     * @var string
-     */
-    public $pinterest = '';
-
-    /**
-     * google+ (google.com/+profileName)
-     *
-     * @var string
-     */
-    public $google = '';
-
-    /**
-     * instagram (instagram.com/handle)
-     *
-     * @var string
-     */
-    public $instagram = '';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
-        $this->email = get_bloginfo('admin_email');
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to currency
- */
-class EE_Currency_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $code
-     * eg 'US'
-     */
-    public $code;
-
-    /**
-     * @var string $name
-     * eg 'Dollar'
-     */
-    public $name;
-
-    /**
-     * plural name
-     *
-     * @var string $plural
-     * eg 'Dollars'
-     */
-    public $plural;
-
-    /**
-     * currency sign
-     *
-     * @var string $sign
-     * eg '$'
-     */
-    public $sign;
-
-    /**
-     * Whether the currency sign should come before the number or not
-     *
-     * @var boolean $sign_b4
-     */
-    public $sign_b4;
-
-    /**
-     * How many digits should come after the decimal place
-     *
-     * @var int $dec_plc
-     */
-    public $dec_plc;
-
-    /**
-     * Symbol to use for decimal mark
-     *
-     * @var string $dec_mrk
-     * eg '.'
-     */
-    public $dec_mrk;
-
-    /**
-     * Symbol to use for thousands
-     *
-     * @var string $thsnds
-     * eg ','
-     */
-    public $thsnds;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param string $CNT_ISO
-     * @throws \EE_Error
-     */
-    public function __construct($CNT_ISO = '')
-    {
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        // get country code from organization settings or use default
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : '';
-        // but override if requested
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
-            && EE_Maintenance_Mode::instance()->models_can_query()
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
-        ) {
-            // retrieve the country settings from the db, just in case they have been customized
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
-            if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
-                $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-                $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            }
-        }
-        // fallback to hardcoded defaults, in case the above failed
-        if (empty($this->code)) {
-            // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-        }
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Registration_Config extends EE_Config_Base
-{
-
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID;
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets;
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level;
-
-    /**
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var boolean $show_pending_payment_options
-     */
-    public $show_pending_payment_options;
-
-    /**
-     * Whether to skip the registration confirmation page
-     *
-     * @var boolean $skip_reg_confirmation
-     */
-    public $skip_reg_confirmation;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps;
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var boolean $reg_confirmation_last
-     */
-    public $reg_confirmation_last;
-
-    /**
-     * Whether or not to enable the EE Bot Trap
-     *
-     * @var boolean $use_bot_trap
-     */
-    public $use_bot_trap;
-
-    /**
-     * Whether or not to encrypt some data sent by the EE Bot Trap
-     *
-     * @var boolean $use_encryption
-     */
-    public $use_encryption;
-
-    /**
-     * Whether or not to use ReCaptcha
-     *
-     * @var boolean $use_captcha
-     */
-    public $use_captcha;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme;
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge;
+	const OPTION_NAME = 'ee_config';
+
+	const LOG_NAME = 'ee_config_log';
+
+	const LOG_LENGTH = 100;
+
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
+
+	/**
+	 *    instance of the EE_Config object
+	 *
+	 * @var    EE_Config $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean $_logging_enabled
+	 */
+	private static $_logging_enabled = false;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * An StdClass whose property names are addon slugs,
+	 * and values are their config classes
+	 *
+	 * @var StdClass
+	 */
+	public $addons;
+
+	/**
+	 * @var EE_Admin_Config
+	 */
+	public $admin;
+
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core;
+
+	/**
+	 * @var EE_Currency_Config
+	 */
+	public $currency;
+
+	/**
+	 * @var EE_Organization_Config
+	 */
+	public $organization;
+
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $registration;
+
+	/**
+	 * @var EE_Template_Config
+	 */
+	public $template_settings;
+
+	/**
+	 * Holds EE environment values.
+	 *
+	 * @var EE_Environment_Config
+	 */
+	public $environment;
+
+	/**
+	 * settings pertaining to Google maps
+	 *
+	 * @var EE_Map_Config
+	 */
+	public $map_settings;
+
+	/**
+	 * settings pertaining to Taxes
+	 *
+	 * @var EE_Tax_Config
+	 */
+	public $tax_settings;
+
+	/**
+	 * Settings pertaining to global messages settings.
+	 *
+	 * @var EE_Messages_Config
+	 */
+	public $messages;
+
+	/**
+	 * @deprecated
+	 * @var EE_Gateway_Config
+	 */
+	public $gateway;
+
+	/**
+	 * @var    array $_addon_option_names
+	 * @access    private
+	 */
+	private $_addon_option_names = array();
+
+	/**
+	 * @var    array $_module_route_map
+	 * @access    private
+	 */
+	private static $_module_route_map = array();
+
+	/**
+	 * @var    array $_module_forward_map
+	 * @access    private
+	 */
+	private static $_module_forward_map = array();
+
+	/**
+	 * @var    array $_module_view_map
+	 * @access    private
+	 */
+	private static $_module_view_map = array();
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Config instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Config) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the config
+	 *
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
+	 *                               reflect its state in the database
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
+	 *                               site was put into maintenance mode)
+	 * @return EE_Config
+	 */
+	public static function reset($hard_reset = false, $reinstantiate = true)
+	{
+		if (self::$_instance instanceof EE_Config) {
+			if ($hard_reset) {
+				self::$_instance->legacy_shortcodes_manager = null;
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
+		}
+		self::$_instance = null;
+		// we don't need to reset the static properties imo because those should
+		// only change when a module is added or removed. Currently we don't
+		// support removing a module during a request when it previously existed
+		if ($reinstantiate) {
+			return self::instance();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
+		// setup empty config classes
+		$this->_initialize_config();
+		// load existing EE site settings
+		$this->_load_core_config();
+		// confirm everything loaded correctly and set filtered defaults if not
+		$this->_verify_config();
+		//  register shortcodes and modules
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_and_modules'),
+			999
+		);
+		//  initialize shortcodes and modules
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
+		// register widgets
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
+		// shutdown
+		add_action('shutdown', array($this, 'shutdown'), 10);
+		// construct__end hook
+		do_action('AHEE__EE_Config__construct__end', $this);
+		// hardcoded hack
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function logging_enabled()
+	{
+		return self::$_logging_enabled;
+	}
+
+
+	/**
+	 * use to get the current theme if needed from static context
+	 *
+	 * @return string current theme set.
+	 */
+	public static function get_current_theme()
+	{
+		return isset(self::$_instance->template_settings->current_espresso_theme)
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 *        _initialize_config
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_config()
+	{
+		EE_Config::trim_log();
+		// set defaults
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
+		$this->addons = new stdClass();
+		// set _module_route_map
+		EE_Config::$_module_route_map = array();
+		// set _module_forward_map
+		EE_Config::$_module_forward_map = array();
+		// set _module_view_map
+		EE_Config::$_module_view_map = array();
+	}
+
+
+	/**
+	 *        load core plugin configuration
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_core_config()
+	{
+		// load_core_config__start hook
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
+		$espresso_config = $this->get_espresso_config();
+		foreach ($espresso_config as $config => $settings) {
+			// load_core_config__start hook
+			$settings = apply_filters(
+				'FHEE__EE_Config___load_core_config__config_settings',
+				$settings,
+				$config,
+				$this
+			);
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+				// call configs populate method to ensure any defaults are set for empty values.
+				if (method_exists($settings, 'populate')) {
+					$this->{$config}->populate();
+				}
+				if (method_exists($settings, 'do_hooks')) {
+					$this->{$config}->do_hooks();
+				}
+			}
+		}
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
+			$this->update_espresso_config();
+		}
+		// load_core_config__end hook
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
+	}
+
+
+	/**
+	 *    _verify_config
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _verify_config()
+	{
+		$this->core = $this->core instanceof EE_Core_Config
+			? $this->core
+			: new EE_Core_Config();
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
+		$this->organization = $this->organization instanceof EE_Organization_Config
+			? $this->organization
+			: new EE_Organization_Config();
+		$this->organization = apply_filters(
+			'FHEE__EE_Config___initialize_config__organization',
+			$this->organization
+		);
+		$this->currency = $this->currency instanceof EE_Currency_Config
+			? $this->currency
+			: new EE_Currency_Config();
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
+		$this->registration = $this->registration instanceof EE_Registration_Config
+			? $this->registration
+			: new EE_Registration_Config();
+		$this->registration = apply_filters(
+			'FHEE__EE_Config___initialize_config__registration',
+			$this->registration
+		);
+		$this->admin = $this->admin instanceof EE_Admin_Config
+			? $this->admin
+			: new EE_Admin_Config();
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
+			? $this->template_settings
+			: new EE_Template_Config();
+		$this->template_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__template_settings',
+			$this->template_settings
+		);
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
+			? $this->map_settings
+			: new EE_Map_Config();
+		$this->map_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__map_settings',
+			$this->map_settings
+		);
+		$this->environment = $this->environment instanceof EE_Environment_Config
+			? $this->environment
+			: new EE_Environment_Config();
+		$this->environment = apply_filters(
+			'FHEE__EE_Config___initialize_config__environment',
+			$this->environment
+		);
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
+			? $this->tax_settings
+			: new EE_Tax_Config();
+		$this->tax_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__tax_settings',
+			$this->tax_settings
+		);
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
+		$this->messages = $this->messages instanceof EE_Messages_Config
+			? $this->messages
+			: new EE_Messages_Config();
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
+			? $this->gateway
+			: new EE_Gateway_Config();
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
+		$this->legacy_shortcodes_manager = null;
+	}
+
+
+	/**
+	 *    get_espresso_config
+	 *
+	 * @access    public
+	 * @return    array of espresso config stuff
+	 */
+	public function get_espresso_config()
+	{
+		// grab espresso configuration
+		return apply_filters(
+			'FHEE__EE_Config__get_espresso_config__CFG',
+			get_option(EE_Config::OPTION_NAME, array())
+		);
+	}
+
+
+	/**
+	 *    double_check_config_comparison
+	 *
+	 * @access    public
+	 * @param string $option
+	 * @param        $old_value
+	 * @param        $value
+	 */
+	public function double_check_config_comparison($option, $old_value, $value)
+	{
+		// make sure we're checking the ee config
+		if ($option === EE_Config::OPTION_NAME) {
+			// run a loose comparison of the old value against the new value for type and properties,
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
+			if ($value != $old_value) {
+				// if they are NOT the same, then remove the hook,
+				// which means the subsequent update results will be based solely on the update query results
+				// the reason we do this is because, as stated above,
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
+				// this happens PRIOR to serialization and any subsequent update.
+				// If values are found to match their previous old value,
+				// then WP bails before performing any update.
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
+				// it just pulled from the db, with the one being passed to it (which will not match).
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
+				// MySQL MAY ALSO NOT perform the update because
+				// the string it sees in the db looks the same as the new one it has been passed!!!
+				// This results in the query returning an "affected rows" value of ZERO,
+				// which gets returned immediately by WP update_option and looks like an error.
+				remove_action('update_option', array($this, 'check_config_updated'));
+			}
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 */
+	protected function _reset_espresso_addon_config()
+	{
+		$this->_addon_option_names = array();
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			if ($addon_config_obj instanceof EE_Config_Base) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
+			}
+			$this->addons->{$addon_name} = null;
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 * @param   bool $add_success
+	 * @param   bool $add_error
+	 * @return   bool
+	 */
+	public function update_espresso_config($add_success = false, $add_error = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
+		// $clone = clone( self::$_instance );
+		// self::$_instance = NULL;
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
+		$this->_reset_espresso_addon_config();
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
+		// but BEFORE the actual update occurs
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
+		$this->legacy_shortcodes_manager = null;
+		// now update "ee_config"
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		EE_Config::log(EE_Config::OPTION_NAME);
+		// if not saved... check if the hook we just added still exists;
+		// if it does, it means one of two things:
+		// that update_option bailed at the($value === $old_value) conditional,
+		// or...
+		// the db update query returned 0 rows affected
+		// (probably because the data  value was the same from it's perspective)
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
+		// but just means no update occurred, so don't display an error to the user.
+		// BUT... if update_option returns FALSE, AND the hook is missing,
+		// then it means that something truly went wrong
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
+		// remove our action since we don't want it in the system anymore
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
+		// self::$_instance = $clone;
+		// unset( $clone );
+		// if config remains the same or was updated successfully
+		if ($saved) {
+			if ($add_success) {
+				EE_Error::add_success(
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		} else {
+			if ($add_error) {
+				EE_Error::add_error(
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+	/**
+	 *    _verify_config_params
+	 *
+	 * @access    private
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @param    array          $tests_to_run
+	 * @param    bool           $display_errors
+	 * @return    bool    TRUE on success, FALSE on fail
+	 */
+	private function _verify_config_params(
+		$section = '',
+		$name = '',
+		$config_class = '',
+		$config_obj = null,
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
+		$display_errors = true
+	) {
+		try {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
+					// TEST #1 : check that section was set
+					case 1:
+						if (empty($section)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'No configuration section has been provided while attempting to save "%s".',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #2 : check that settings section exists
+					case 2:
+						if (! isset($this->{$section})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #3 : check that section is the proper format
+					case 3:
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+						) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" configuration settings have not been formatted correctly.',
+											'event_espresso'
+										),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #4 : check that config section name has been set
+					case 4:
+						if (empty($name)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #5 : check that a config class name has been set
+					case 5:
+						if (empty($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No class name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #6 : verify config class is accessible
+					case 6:
+						if (! class_exists($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #7 : check that config has even been set
+					case 7:
+						if (! isset($this->{$section}->{$name})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
+										$section,
+										$name
+									)
+								);
+							}
+							return false;
+						} else {
+							// and make sure it's not serialized
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
+						}
+						break;
+					// TEST #8 : check that config is the requested type
+					case 8:
+						if (! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
+											'event_espresso'
+										),
+										$section,
+										$name,
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #9 : verify config object
+					case 9:
+						if (! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
+									)
+								);
+							}
+							return false;
+						}
+						break;
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		// you have successfully run the gauntlet
+		return true;
+	}
+
+
+	/**
+	 *    _generate_config_option_name
+	 *
+	 * @access        protected
+	 * @param        string $section
+	 * @param        string $name
+	 * @return        string
+	 */
+	private function _generate_config_option_name($section = '', $name = '')
+	{
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+	}
+
+
+	/**
+	 *    _set_config_class
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
+	 *
+	 * @access    private
+	 * @param    string $config_class
+	 * @param    string $name
+	 * @return    string
+	 */
+	private function _set_config_class($config_class = '', $name = '')
+	{
+		return ! empty($config_class)
+			? $config_class
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+	}
+
+
+	/**
+	 *    set_config
+	 *
+	 * @access    protected
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @return    EE_Config_Base
+	 */
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
+			$this->update_addon_option_names();
+		}
+		// verify the incoming config object but suppress errors
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			$config_obj = new $config_class();
+		}
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		} else {
+			// create a wp-option for this config
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
+				return $this->{$section}->{$name};
+			} else {
+				EE_Error::add_error(
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return null;
+			}
+		}
+	}
+
+
+	/**
+	 *    update_config
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
+	 *
+	 * @access    public
+	 * @param    string                $section
+	 * @param    string                $name
+	 * @param    EE_Config_Base|string $config_obj
+	 * @param    bool                  $throw_errors
+	 * @return    bool
+	 */
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		$config_obj = maybe_unserialize($config_obj);
+		// get class name of the incoming object
+		$config_class = get_class($config_obj);
+		// run tests 1-5 and 9 to verify config
+		if (! $this->_verify_config_params(
+			$section,
+			$name,
+			$config_class,
+			$config_obj,
+			array(1, 2, 3, 4, 7, 9)
+		)
+		) {
+			return false;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			// save new config to db
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
+				return true;
+			}
+		} else {
+			// first check if the record already exists
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
+			// just return if db record is already up to date (NOT type safe comparison)
+			if ($existing_config == $config_obj) {
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
+				// update wp-option for this config class
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif ($throw_errors) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
+							'event_espresso'
+						),
+						$config_class,
+						'EE_Config->' . $section . '->' . $name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    get_config
+	 *
+	 * @access    public
+	 * @param    string $section
+	 * @param    string $name
+	 * @param    string $config_class
+	 * @return    mixed EE_Config_Base | NULL
+	 */
+	public function get_config($section = '', $name = '', $config_class = '')
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6 and 7 to verify that all params have been set
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		// now test if the requested config object exists, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
+			// config already exists, so pass it back
+			return $this->{$section}->{$name};
+		}
+		// load config option from db if it exists
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
+		// verify the newly retrieved config object, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			// config is good, so set it and pass it back
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		}
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
+		$config_obj = $this->set_config($section, $name, $config_class);
+		// verify the newly created config object
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
+			return $this->{$section}->{$name};
+		} else {
+			EE_Error::add_error(
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_config_option
+	 *
+	 * @access    public
+	 * @param    string $config_option_name
+	 * @return    mixed EE_Config_Base | FALSE
+	 */
+	public function get_config_option($config_option_name = '')
+	{
+		// retrieve the wp-option for this config class.
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name . '-NOT-FOUND');
+		}
+		return $config_option;
+	}
+
+
+	/**
+	 * log
+	 *
+	 * @param string $config_option_name
+	 */
+	public static function log($config_option_name = '')
+	{
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
+			// copy incoming $_REQUEST and sanitize it so we can save it
+			$_request = $_REQUEST;
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[ (string) microtime(true) ] = array(
+				'config_name' => $config_option_name,
+				'request'     => $_request,
+			);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 * trim_log
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
+	 */
+	public static function trim_log()
+	{
+		if (! EE_Config::logging_enabled()) {
+			return;
+		}
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 *    get_page_for_posts
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function get_page_for_posts()
+	{
+		$page_for_posts = get_option('page_for_posts');
+		if (! $page_for_posts) {
+			return 'posts';
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
+	}
+
+
+	/**
+	 *    register_shortcodes_and_modules.
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
+	 *    In fact, this is where we give modules a chance to let core know they exist
+	 *    so they can help trigger maintenance mode if it's needed
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function register_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		EE_Registry::instance()->modules = $this->_register_modules();
+	}
+
+
+	/**
+	 *    initialize_shortcodes_and_modules
+	 *    meaning they can start adding their hooks to get stuff done
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function initialize_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		$this->_initialize_modules();
+	}
+
+
+	/**
+	 *    widgets_init
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function widgets_init()
+	{
+		// only init widgets on admin pages when not in complete maintenance, and
+		// on frontend when not in any maintenance mode
+		if (! EE_Maintenance_Mode::instance()->level()
+			|| (
+				is_admin()
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			)
+		) {
+			// grab list of installed widgets
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+			// filter list of modules to register
+			$widgets_to_register = apply_filters(
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
+				$widgets_to_register
+			);
+			if (! empty($widgets_to_register)) {
+				// cycle thru widget folders
+				foreach ($widgets_to_register as $widget_path) {
+					// add to list of installed widget modules
+					EE_Config::register_ee_widget($widget_path);
+				}
+			}
+			// filter list of installed modules
+			EE_Registry::instance()->widgets = apply_filters(
+				'FHEE__EE_Config__register_widgets__installed_widgets',
+				EE_Registry::instance()->widgets
+			);
+		}
+	}
+
+
+	/**
+	 *    register_ee_widget - makes core aware of this widget
+	 *
+	 * @access    public
+	 * @param    string $widget_path - full path up to and including widget folder
+	 * @return    void
+	 */
+	public static function register_ee_widget($widget_path = null)
+	{
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
+		$widget_ext = '.widget.php';
+		// make all separators match
+		$widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($widget_path, $widget_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$file_name = explode('.', basename($widget_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
+			// sanitize shortcode directory name
+			$widget = sanitize_key($widget);
+			// now we need to rebuild the shortcode path
+			$widget_path = explode('/', $widget_path);
+			// remove last segment
+			array_pop($widget_path);
+			// glue it back together
+			$widget_path = implode(DS, $widget_path);
+		} else {
+			// grab and sanitize widget directory name
+			$widget = sanitize_key(basename($widget_path));
+		}
+		// create classname from widget directory name
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
+		// add class prefix
+		$widget_class = 'EEW_' . $widget;
+		// does the widget exist ?
+		if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+					'event_espresso'
+				),
+				$widget_class,
+				$widget_path . '/' . $widget_class . $widget_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		// load the widget class file
+		require_once($widget_path . '/' . $widget_class . $widget_ext);
+		// verify that class exists
+		if (! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		register_widget($widget_class);
+		// add to array of registered widgets
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext;
+	}
+
+
+	/**
+	 *        _register_modules
+	 *
+	 * @access private
+	 * @return array
+	 */
+	private function _register_modules()
+	{
+		// grab list of installed modules
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$modules_to_register = apply_filters(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			$modules_to_register
+		);
+		if (! empty($modules_to_register)) {
+			// loop through folders
+			foreach ($modules_to_register as $module_path) {
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES . 'gateways'
+				) {
+					// add to list of installed modules
+					EE_Config::register_module($module_path);
+				}
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_modules__installed_modules',
+			EE_Registry::instance()->modules
+		);
+	}
+
+
+	/**
+	 *    register_module - makes core aware of this module
+	 *
+	 * @access    public
+	 * @param    string $module_path - full path up to and including module folder
+	 * @return    bool
+	 */
+	public static function register_module($module_path = null)
+	{
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
+		$module_ext = '.module.php';
+		// make all separators match
+		$module_path = str_replace(array('\\', '/'), '/', $module_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($module_path, $module_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$module_file = explode('.', basename($module_path));
+			// now we need to rebuild the shortcode path
+			$module_path = explode('/', $module_path);
+			// remove last segment
+			array_pop($module_path);
+			// glue it back together
+			$module_path = implode('/', $module_path) . '/';
+			// take first segment from file name pieces and sanitize it
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
+			// ensure class prefix is added
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize module name
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
+			// like trailingslashit()
+			$module_path = rtrim($module_path, '/') . '/';
+			// create classname from module directory name
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
+			// add class prefix
+			$module_class = 'EED_' . $module;
+		}
+		// does the module exist ?
+		if (! is_readable($module_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s module file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($module_path . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		do_action(
+			'AHEE__EE_Config__register_module__complete',
+			$module_class,
+			EE_Registry::instance()->modules->{$module_class}
+		);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_modules
+	 *    allow modules to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_modules()
+	{
+		// cycle thru shortcode folders
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($module_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($module_class, 'set_hooks')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    register_route - adds module method routes to route_map
+	 *
+	 * @access    public
+	 * @param    string $route       - "pretty" public alias for module method
+	 * @param    string $module      - module name (classname without EED_ prefix)
+	 * @param    string $method_name - the actual module method to be routed to
+	 * @param    string $key         - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_' . $module;
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! method_exists('EED_' . $module, $method_name)) {
+			$msg = sprintf(
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+		return true;
+	}
+
+
+	/**
+	 *    get_route - get module method route
+	 *
+	 * @access    public
+	 * @param    string $route - "pretty" public alias for module method
+	 * @param    string $key   - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_route($route = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
+			return EE_Config::$_module_route_map[ $key ][ $route ];
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_routes - get ALL module method routes
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_routes()
+	{
+		return EE_Config::$_module_route_map;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to forward request to another module for further processing
+	 *
+	 * @access    public
+	 * @param    string       $route   - "pretty" public alias for module method
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
+	 *                                 class, allows different forwards to be served based on status
+	 * @param    array|string $forward - function name or array( class, method )
+	 * @param    string       $key     - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (is_array($forward)) {
+			if (! isset($forward[1])) {
+				$msg = sprintf(
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+			if (! method_exists($forward[0], $forward[1])) {
+				$msg = sprintf(
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
+					$forward[1],
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		} elseif (! function_exists($forward)) {
+			$msg = sprintf(
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
+				$forward,
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+		return true;
+	}
+
+
+	/**
+	 *    get_forward - get forwarding route
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different forwards to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_forward',
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
+	 *    results
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $view
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! is_readable($view)) {
+			$msg = sprintf(
+				__(
+					'The %s view file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$view
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+		return true;
+	}
+
+
+	/**
+	 *    get_view - get view for route and status
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_view($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_view',
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	public function update_addon_option_names()
+	{
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
+	}
+
+
+	public function shutdown()
+	{
+		$this->update_addon_option_names();
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public static function getLegacyShortcodesManager()
+	{
+
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
+				EE_Registry::instance()
+			);
+		}
+		return EE_Config::instance()->legacy_shortcodes_manager;
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @deprecated 4.9.26
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public static function register_shortcode($shortcode_path = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
+	}
+}
 
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type;
+/**
+ * Base class used for config classes. These classes should generally not have
+ * magic functions in use, except we'll allow them to magically set and get stuff...
+ * basically, they should just be well-defined stdClasses
+ */
+class EE_Config_Base
+{
 
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language;
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name = get_class($this);
+		$defaults = new $class_name;
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	/**
+	 *        __isset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __unset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __clone
+	 */
+	public function __clone()
+	{
+	}
+
+
+	/**
+	 *        __wakeup
+	 */
+	public function __wakeup()
+	{
+	}
+
+
+	/**
+	 *        __destruct
+	 */
+	public function __destruct()
+	{
+	}
+}
 
-    /**
-     * ReCaptcha public key
-     *
-     * @var string $recaptcha_publickey
-     */
-    public $recaptcha_publickey;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Core_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha private key
-     *
-     * @var string $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey;
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
+
+
+	public $current_blog_id;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public $post_shortcodes;
+
+	public $module_route_map;
+
+	public $module_forward_map;
+
+	public $module_view_map;
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_id;
+
+	public $txn_page_id;
+
+	public $thank_you_page_id;
+
+	public $cancel_page_id;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_url;
+
+	public $txn_page_url;
+
+	public $thank_you_page_url;
+
+	public $cancel_page_url;
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public $event_cpt_slug;
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool
+	 */
+	public static $ee_ueip_option;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id = get_current_blog_id();
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		$this->post_shortcodes = array();
+		$this->module_route_map = array();
+		$this->module_forward_map = array();
+		$this->module_view_map = array();
+		// critical EE page IDs
+		$this->reg_page_id = 0;
+		$this->txn_page_id = 0;
+		$this->thank_you_page_id = 0;
+		$this->cancel_page_id = 0;
+		// critical EE page URLs
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->thank_you_page_url = '';
+		$this->cancel_page_url = '';
+		// cpt slugs
+		$this->event_cpt_slug = __('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array()
+	{
+		return array(
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array()
+	{
+		return array(
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		);
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function reg_page_url()
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function txn_page_url($query_args = array())
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		} else {
+			return $this->txn_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function thank_you_page_url($query_args = array())
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		} else {
+			return $this->thank_you_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function cancel_page_url()
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->cancel_page_url = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return bool
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option(self::OPTION_NAME_UXIP, false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (EE_Core_Config::$ee_ueip_option !== null) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
+		$option = self::OPTION_NAME_UXIP;
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if (false !== $pre) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if ($property === self::OPTION_NAME_UXIP) {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
+}
 
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms;
+/**
+ * Config class for storing info on the Organization
+ */
+class EE_Organization_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width;
+	/**
+	 * @var string $name
+	 * eg EE4.1
+	 */
+	public $name;
+
+	/**
+	 * @var string $address_1
+	 * eg 123 Onna Road
+	 */
+	public $address_1 = '';
+
+	/**
+	 * @var string $address_2
+	 * eg PO Box 123
+	 */
+	public $address_2 = '';
+
+	/**
+	 * @var string $city
+	 * eg Inna City
+	 */
+	public $city = '';
+
+	/**
+	 * @var int $STA_ID
+	 * eg 4
+	 */
+	public $STA_ID = 0;
+
+	/**
+	 * @var string $CNT_ISO
+	 * eg US
+	 */
+	public $CNT_ISO = '';
+
+	/**
+	 * @var string $zip
+	 * eg 12345  or V1A 2B3
+	 */
+	public $zip = '';
+
+	/**
+	 * @var string $email
+	 * eg support@eventespresso.com
+	 */
+	public $email;
+
+	/**
+	 * @var string $phone
+	 * eg. 111-111-1111
+	 */
+	public $phone = '';
+
+	/**
+	 * @var string $vat
+	 * VAT/Tax Number
+	 */
+	public $vat = '';
+
+	/**
+	 * @var string $logo_url
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
+	 */
+	public $logo_url = '';
+
+	/**
+	 * The below are all various properties for holding links to organization social network profiles
+	 *
+	 * @var string
+	 */
+	/**
+	 * facebook (facebook.com/profile.name)
+	 *
+	 * @var string
+	 */
+	public $facebook = '';
+
+	/**
+	 * twitter (twitter.com/twitter_handle)
+	 *
+	 * @var string
+	 */
+	public $twitter = '';
+
+	/**
+	 * linkedin (linkedin.com/in/profile_name)
+	 *
+	 * @var string
+	 */
+	public $linkedin = '';
+
+	/**
+	 * pinterest (www.pinterest.com/profile_name)
+	 *
+	 * @var string
+	 */
+	public $pinterest = '';
+
+	/**
+	 * google+ (google.com/+profileName)
+	 *
+	 * @var string
+	 */
+	public $google = '';
+
+	/**
+	 * instagram (instagram.com/handle)
+	 *
+	 * @var string
+	 */
+	public $instagram = '';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
+		$this->email = get_bloginfo('admin_email');
+	}
+}
 
-    /**
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var boolean $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
+/**
+ * Class for defining what's in the EE_Config relating to currency
+ */
+class EE_Currency_Config extends EE_Config_Base
+{
 
-    /**
-     * Whether or not to show the privacy policy consent checkbox
-     *
-     * @var bool
-     */
-    public $consent_checkbox_enabled;
+	/**
+	 * @var string $code
+	 * eg 'US'
+	 */
+	public $code;
+
+	/**
+	 * @var string $name
+	 * eg 'Dollar'
+	 */
+	public $name;
+
+	/**
+	 * plural name
+	 *
+	 * @var string $plural
+	 * eg 'Dollars'
+	 */
+	public $plural;
+
+	/**
+	 * currency sign
+	 *
+	 * @var string $sign
+	 * eg '$'
+	 */
+	public $sign;
+
+	/**
+	 * Whether the currency sign should come before the number or not
+	 *
+	 * @var boolean $sign_b4
+	 */
+	public $sign_b4;
+
+	/**
+	 * How many digits should come after the decimal place
+	 *
+	 * @var int $dec_plc
+	 */
+	public $dec_plc;
+
+	/**
+	 * Symbol to use for decimal mark
+	 *
+	 * @var string $dec_mrk
+	 * eg '.'
+	 */
+	public $dec_mrk;
+
+	/**
+	 * Symbol to use for thousands
+	 *
+	 * @var string $thsnds
+	 * eg ','
+	 */
+	public $thsnds;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param string $CNT_ISO
+	 * @throws \EE_Error
+	 */
+	public function __construct($CNT_ISO = '')
+	{
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		// get country code from organization settings or use default
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: '';
+		// but override if requested
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
+		if (! empty($CNT_ISO)
+			&& EE_Maintenance_Mode::instance()->models_can_query()
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
+		) {
+			// retrieve the country settings from the db, just in case they have been customized
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single();    // Dollar
+				$this->plural = $country->currency_name_plural();    // Dollars
+				$this->sign = $country->currency_sign();            // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(
+				);        // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			}
+		}
+		// fallback to hardcoded defaults, in case the above failed
+		if (empty($this->code)) {
+			// set default currency settings
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
+			$this->sign = '$';    // currency sign: $
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+		}
+	}
+}
 
-    /**
-     * Label text to show on the checkbox
-     *
-     * @var string
-     */
-    public $consent_checkbox_label_text;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Registration_Config extends EE_Config_Base
+{
 
-    /*
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID;
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets;
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level;
+
+	/**
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var boolean $show_pending_payment_options
+	 */
+	public $show_pending_payment_options;
+
+	/**
+	 * Whether to skip the registration confirmation page
+	 *
+	 * @var boolean $skip_reg_confirmation
+	 */
+	public $skip_reg_confirmation;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps;
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var boolean $reg_confirmation_last
+	 */
+	public $reg_confirmation_last;
+
+	/**
+	 * Whether or not to enable the EE Bot Trap
+	 *
+	 * @var boolean $use_bot_trap
+	 */
+	public $use_bot_trap;
+
+	/**
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var boolean $use_encryption
+	 */
+	public $use_encryption;
+
+	/**
+	 * Whether or not to use ReCaptcha
+	 *
+	 * @var boolean $use_captcha
+	 */
+	public $use_captcha;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme;
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge;
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type;
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language;
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string $recaptcha_publickey
+	 */
+	public $recaptcha_publickey;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms;
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width;
+
+	/**
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var boolean $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * Whether or not to show the privacy policy consent checkbox
+	 *
+	 * @var bool
+	 */
+	public $consent_checkbox_enabled;
+
+	/**
+	 * Label text to show on the checkbox
+	 *
+	 * @var string
+	 */
+	public $consent_checkbox_label_text;
+
+	/*
      * String describing how long to keep payment logs. Passed into DateTime constructor
      * @var string
      */
-    public $gateway_log_lifespan = '1 week';
-
-    /**
-     * Enable copy attendee info at form
-     *
-     * @var boolean $enable_copy_attendee
-     */
-    protected $copy_attendee_info = true;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default registration settings
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
-        $this->email_validation_level = 'wp_default';
-        $this->show_pending_payment_options = true;
-        $this->skip_reg_confirmation = true;
-        $this->reg_steps = array();
-        $this->reg_confirmation_last = false;
-        $this->use_bot_trap = true;
-        $this->use_encryption = true;
-        $this->use_captcha = false;
-        $this->recaptcha_theme = 'light';
-        $this->recaptcha_badge = 'bottomleft';
-        $this->recaptcha_type = 'image';
-        $this->recaptcha_language = 'en';
-        $this->recaptcha_publickey = null;
-        $this->recaptcha_privatekey = null;
-        $this->recaptcha_protected_forms = array();
-        $this->recaptcha_width = 500;
-        $this->default_maximum_number_of_tickets = 10;
-        $this->consent_checkbox_enabled = false;
-        $this->consent_checkbox_label_text = '';
-        $this->gateway_log_lifespan = '7 days';
-        $this->copy_attendee_info = true;
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
-
-
-    /**
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
-     * constructed because that happens before we can get the privacy policy page's permalink.
-     *
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function setDefaultCheckboxLabelText()
-    {
-        if ($this->getConsentCheckboxLabelText() === null
-            || $this->getConsentCheckboxLabelText() === '') {
-            $opening_a_tag = '';
-            $closing_a_tag = '';
-            if (function_exists('get_privacy_policy_url')) {
-                $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
-                    $closing_a_tag = '</a>';
-                }
-            }
-            $loader = LoaderFactory::getLoader();
-            $org_config = $loader->getShared('EE_Organization_Config');
-            /**
-             * @var $org_config EE_Organization_Config
-             */
-
-            $this->setConsentCheckboxLabelText(
-                sprintf(
-                    esc_html__(
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
-                        'event_espresso'
-                    ),
-                    $org_config->name,
-                    $opening_a_tag,
-                    $closing_a_tag
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function track_invalid_checkout_access()
-    {
-        return $this->track_invalid_checkout_access;
-    }
-
-
-    /**
-     * @param boolean $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = filter_var(
-            $track_invalid_checkout_access,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-    /**
-     * @return boolean
-     */
-    public function copyAttendeeInfo()
-    {
-        return $this->copy_attendee_info;
-    }
-
-
-    /**
-     * @param boolean $copy_attendee_info
-     */
-    public function setCopyAttendeeInfo($copy_attendee_info)
-    {
-        $this->copy_attendee_info = filter_var(
-            $copy_attendee_info,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Gets the options to make availalbe for the gateway log lifespan
-     * @return array
-     */
-    public function gatewayLogLifespanOptions()
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            array(
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
-                '30 days' => esc_html__('30 Days', 'event_espresso')
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isConsentCheckboxEnabled()
-    {
-        return $this->consent_checkbox_enabled;
-    }
-
-
-    /**
-     * @param bool $consent_checkbox_enabled
-     */
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
-    {
-        $this->consent_checkbox_enabled = filter_var(
-            $consent_checkbox_enabled,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getConsentCheckboxLabelText()
-    {
-        return $this->consent_checkbox_label_text;
-    }
-
-
-    /**
-     * @param string $consent_checkbox_label_text
-     */
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
-    {
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
-    }
+	public $gateway_log_lifespan = '1 week';
+
+	/**
+	 * Enable copy attendee info at form
+	 *
+	 * @var boolean $enable_copy_attendee
+	 */
+	protected $copy_attendee_info = true;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default registration settings
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
+		$this->email_validation_level = 'wp_default';
+		$this->show_pending_payment_options = true;
+		$this->skip_reg_confirmation = true;
+		$this->reg_steps = array();
+		$this->reg_confirmation_last = false;
+		$this->use_bot_trap = true;
+		$this->use_encryption = true;
+		$this->use_captcha = false;
+		$this->recaptcha_theme = 'light';
+		$this->recaptcha_badge = 'bottomleft';
+		$this->recaptcha_type = 'image';
+		$this->recaptcha_language = 'en';
+		$this->recaptcha_publickey = null;
+		$this->recaptcha_privatekey = null;
+		$this->recaptcha_protected_forms = array();
+		$this->recaptcha_width = 500;
+		$this->default_maximum_number_of_tickets = 10;
+		$this->consent_checkbox_enabled = false;
+		$this->consent_checkbox_label_text = '';
+		$this->gateway_log_lifespan = '7 days';
+		$this->copy_attendee_info = true;
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
+	 * constructed because that happens before we can get the privacy policy page's permalink.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function setDefaultCheckboxLabelText()
+	{
+		if ($this->getConsentCheckboxLabelText() === null
+			|| $this->getConsentCheckboxLabelText() === '') {
+			$opening_a_tag = '';
+			$closing_a_tag = '';
+			if (function_exists('get_privacy_policy_url')) {
+				$privacy_page_url = get_privacy_policy_url();
+				if (! empty($privacy_page_url)) {
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+					$closing_a_tag = '</a>';
+				}
+			}
+			$loader = LoaderFactory::getLoader();
+			$org_config = $loader->getShared('EE_Organization_Config');
+			/**
+			 * @var $org_config EE_Organization_Config
+			 */
+
+			$this->setConsentCheckboxLabelText(
+				sprintf(
+					esc_html__(
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
+						'event_espresso'
+					),
+					$org_config->name,
+					$opening_a_tag,
+					$closing_a_tag
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function track_invalid_checkout_access()
+	{
+		return $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param boolean $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = filter_var(
+			$track_invalid_checkout_access,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function copyAttendeeInfo()
+	{
+		return $this->copy_attendee_info;
+	}
+
+
+	/**
+	 * @param boolean $copy_attendee_info
+	 */
+	public function setCopyAttendeeInfo($copy_attendee_info)
+	{
+		$this->copy_attendee_info = filter_var(
+			$copy_attendee_info,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Gets the options to make availalbe for the gateway log lifespan
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions()
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			array(
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
+				'30 days' => esc_html__('30 Days', 'event_espresso')
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isConsentCheckboxEnabled()
+	{
+		return $this->consent_checkbox_enabled;
+	}
+
+
+	/**
+	 * @param bool $consent_checkbox_enabled
+	 */
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
+	{
+		$this->consent_checkbox_enabled = filter_var(
+			$consent_checkbox_enabled,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getConsentCheckboxLabelText()
+	{
+		return $this->consent_checkbox_label_text;
+	}
+
+
+	/**
+	 * @param string $consent_checkbox_label_text
+	 */
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
+	{
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
+	}
 }
 
 /**
@@ -2553,151 +2553,151 @@ 
 class EE_Admin_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_personnel_manager
-     */
-    public $use_personnel_manager;
-
-    /**
-     * @var boolean $use_dashboard_widget
-     */
-    public $use_dashboard_widget;
-
-    /**
-     * @var int $events_in_dashboard
-     */
-    public $events_in_dashboard;
-
-    /**
-     * @var boolean $use_event_timezones
-     */
-    public $use_event_timezones;
-
-    /**
-     * @var string $log_file_name
-     */
-    public $log_file_name;
-
-    /**
-     * @var string $debug_file_name
-     */
-    public $debug_file_name;
-
-    /**
-     * @var boolean $use_remote_logging
-     */
-    public $use_remote_logging;
-
-    /**
-     * @var string $remote_logging_url
-     */
-    public $remote_logging_url;
-
-    /**
-     * @var boolean $show_reg_footer
-     */
-    public $show_reg_footer;
-
-    /**
-     * @var string $affiliate_id
-     */
-    public $affiliate_id;
-
-    /**
-     * help tours on or off (global setting)
-     *
-     * @var boolean
-     */
-    public $help_tour_activation;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    private $encode_session_data = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default general admin settings
-        $this->use_personnel_manager = true;
-        $this->use_dashboard_widget = true;
-        $this->events_in_dashboard = 30;
-        $this->use_event_timezones = false;
-        $this->use_remote_logging = false;
-        $this->remote_logging_url = null;
-        $this->show_reg_footer = apply_filters(
-            'FHEE__EE_Admin_Config__show_reg_footer__default',
-            false
-        );
-        $this->affiliate_id = 'default';
-        $this->help_tour_activation = false;
-        $this->encode_session_data = false;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function log_file_name($reset = false)
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function debug_file_name($reset = false)
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id()
-    {
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data()
-    {
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var boolean $use_personnel_manager
+	 */
+	public $use_personnel_manager;
+
+	/**
+	 * @var boolean $use_dashboard_widget
+	 */
+	public $use_dashboard_widget;
+
+	/**
+	 * @var int $events_in_dashboard
+	 */
+	public $events_in_dashboard;
+
+	/**
+	 * @var boolean $use_event_timezones
+	 */
+	public $use_event_timezones;
+
+	/**
+	 * @var string $log_file_name
+	 */
+	public $log_file_name;
+
+	/**
+	 * @var string $debug_file_name
+	 */
+	public $debug_file_name;
+
+	/**
+	 * @var boolean $use_remote_logging
+	 */
+	public $use_remote_logging;
+
+	/**
+	 * @var string $remote_logging_url
+	 */
+	public $remote_logging_url;
+
+	/**
+	 * @var boolean $show_reg_footer
+	 */
+	public $show_reg_footer;
+
+	/**
+	 * @var string $affiliate_id
+	 */
+	public $affiliate_id;
+
+	/**
+	 * help tours on or off (global setting)
+	 *
+	 * @var boolean
+	 */
+	public $help_tour_activation;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	private $encode_session_data = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default general admin settings
+		$this->use_personnel_manager = true;
+		$this->use_dashboard_widget = true;
+		$this->events_in_dashboard = 30;
+		$this->use_event_timezones = false;
+		$this->use_remote_logging = false;
+		$this->remote_logging_url = null;
+		$this->show_reg_footer = apply_filters(
+			'FHEE__EE_Admin_Config__show_reg_footer__default',
+			false
+		);
+		$this->affiliate_id = 'default';
+		$this->help_tour_activation = false;
+		$this->encode_session_data = false;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function log_file_name($reset = false)
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function debug_file_name($reset = false)
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id()
+	{
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data()
+	{
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
 }
 
 /**
@@ -2706,70 +2706,70 @@ 
 class EE_Template_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $enable_default_style
-     */
-    public $enable_default_style;
-
-    /**
-     * @var string $custom_style_sheet
-     */
-    public $custom_style_sheet;
-
-    /**
-     * @var boolean $display_address_in_regform
-     */
-    public $display_address_in_regform;
-
-    /**
-     * @var int $display_description_on_multi_reg_page
-     */
-    public $display_description_on_multi_reg_page;
-
-    /**
-     * @var boolean $use_custom_templates
-     */
-    public $use_custom_templates;
-
-    /**
-     * @var string $current_espresso_theme
-     */
-    public $current_espresso_theme;
-
-    /**
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-     */
-    public $EED_Ticket_Selector;
-
-    /**
-     * @var EE_Event_Single_Config $EED_Event_Single
-     */
-    public $EED_Event_Single;
-
-    /**
-     * @var EE_Events_Archive_Config $EED_Events_Archive
-     */
-    public $EED_Events_Archive;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default template settings
-        $this->enable_default_style = true;
-        $this->custom_style_sheet = null;
-        $this->display_address_in_regform = true;
-        $this->display_description_on_multi_reg_page = false;
-        $this->use_custom_templates = false;
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
-        $this->EED_Event_Single = null;
-        $this->EED_Events_Archive = null;
-        $this->EED_Ticket_Selector = null;
-    }
+	/**
+	 * @var boolean $enable_default_style
+	 */
+	public $enable_default_style;
+
+	/**
+	 * @var string $custom_style_sheet
+	 */
+	public $custom_style_sheet;
+
+	/**
+	 * @var boolean $display_address_in_regform
+	 */
+	public $display_address_in_regform;
+
+	/**
+	 * @var int $display_description_on_multi_reg_page
+	 */
+	public $display_description_on_multi_reg_page;
+
+	/**
+	 * @var boolean $use_custom_templates
+	 */
+	public $use_custom_templates;
+
+	/**
+	 * @var string $current_espresso_theme
+	 */
+	public $current_espresso_theme;
+
+	/**
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
+	public $EED_Ticket_Selector;
+
+	/**
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
+	public $EED_Event_Single;
+
+	/**
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
+	 */
+	public $EED_Events_Archive;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default template settings
+		$this->enable_default_style = true;
+		$this->custom_style_sheet = null;
+		$this->display_address_in_regform = true;
+		$this->display_description_on_multi_reg_page = false;
+		$this->use_custom_templates = false;
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
+		$this->EED_Event_Single = null;
+		$this->EED_Events_Archive = null;
+		$this->EED_Ticket_Selector = null;
+	}
 }
 
 /**
@@ -2778,114 +2778,114 @@ 
 class EE_Map_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_google_maps
-     */
-    public $use_google_maps;
-
-    /**
-     * @var string $api_key
-     */
-    public $google_map_api_key;
-
-    /**
-     * @var int $event_details_map_width
-     */
-    public $event_details_map_width;
-
-    /**
-     * @var int $event_details_map_height
-     */
-    public $event_details_map_height;
-
-    /**
-     * @var int $event_details_map_zoom
-     */
-    public $event_details_map_zoom;
-
-    /**
-     * @var boolean $event_details_display_nav
-     */
-    public $event_details_display_nav;
-
-    /**
-     * @var boolean $event_details_nav_size
-     */
-    public $event_details_nav_size;
-
-    /**
-     * @var string $event_details_control_type
-     */
-    public $event_details_control_type;
-
-    /**
-     * @var string $event_details_map_align
-     */
-    public $event_details_map_align;
-
-    /**
-     * @var int $event_list_map_width
-     */
-    public $event_list_map_width;
-
-    /**
-     * @var int $event_list_map_height
-     */
-    public $event_list_map_height;
-
-    /**
-     * @var int $event_list_map_zoom
-     */
-    public $event_list_map_zoom;
-
-    /**
-     * @var boolean $event_list_display_nav
-     */
-    public $event_list_display_nav;
-
-    /**
-     * @var boolean $event_list_nav_size
-     */
-    public $event_list_nav_size;
-
-    /**
-     * @var string $event_list_control_type
-     */
-    public $event_list_control_type;
-
-    /**
-     * @var string $event_list_map_align
-     */
-    public $event_list_map_align;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default map settings
-        $this->use_google_maps = true;
-        $this->google_map_api_key = '';
-        // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
-    }
+	/**
+	 * @var boolean $use_google_maps
+	 */
+	public $use_google_maps;
+
+	/**
+	 * @var string $api_key
+	 */
+	public $google_map_api_key;
+
+	/**
+	 * @var int $event_details_map_width
+	 */
+	public $event_details_map_width;
+
+	/**
+	 * @var int $event_details_map_height
+	 */
+	public $event_details_map_height;
+
+	/**
+	 * @var int $event_details_map_zoom
+	 */
+	public $event_details_map_zoom;
+
+	/**
+	 * @var boolean $event_details_display_nav
+	 */
+	public $event_details_display_nav;
+
+	/**
+	 * @var boolean $event_details_nav_size
+	 */
+	public $event_details_nav_size;
+
+	/**
+	 * @var string $event_details_control_type
+	 */
+	public $event_details_control_type;
+
+	/**
+	 * @var string $event_details_map_align
+	 */
+	public $event_details_map_align;
+
+	/**
+	 * @var int $event_list_map_width
+	 */
+	public $event_list_map_width;
+
+	/**
+	 * @var int $event_list_map_height
+	 */
+	public $event_list_map_height;
+
+	/**
+	 * @var int $event_list_map_zoom
+	 */
+	public $event_list_map_zoom;
+
+	/**
+	 * @var boolean $event_list_display_nav
+	 */
+	public $event_list_display_nav;
+
+	/**
+	 * @var boolean $event_list_nav_size
+	 */
+	public $event_list_nav_size;
+
+	/**
+	 * @var string $event_list_control_type
+	 */
+	public $event_list_control_type;
+
+	/**
+	 * @var string $event_list_map_align
+	 */
+	public $event_list_map_align;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default map settings
+		$this->use_google_maps = true;
+		$this->google_map_api_key = '';
+		// for event details pages (reg page)
+		$this->event_details_map_width = 585;            // ee_map_width_single
+		$this->event_details_map_height = 362;            // ee_map_height_single
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
+		$this->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$this->event_list_map_width = 300;            // ee_map_width
+		$this->event_list_map_height = 185;        // ee_map_height
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
+		$this->event_list_display_nav = false;        // ee_map_nav_display
+		$this->event_list_nav_size = true;            // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$this->event_list_map_align = 'center';            // ee_map_align
+	}
 }
 
 /**
@@ -2894,46 +2894,46 @@ 
 class EE_Events_Archive_Config extends EE_Config_Base
 {
 
-    public $display_status_banner;
+	public $display_status_banner;
 
-    public $display_description;
+	public $display_description;
 
-    public $display_ticket_selector;
+	public $display_ticket_selector;
 
-    public $display_datetimes;
+	public $display_datetimes;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $display_expired_events;
+	public $display_expired_events;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner = 0;
-        $this->display_description = 1;
-        $this->display_ticket_selector = 0;
-        $this->display_datetimes = 1;
-        $this->display_venue = 0;
-        $this->display_expired_events = 0;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner = 0;
+		$this->display_description = 1;
+		$this->display_ticket_selector = 0;
+		$this->display_datetimes = 1;
+		$this->display_venue = 0;
+		$this->display_expired_events = 0;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2942,34 +2942,34 @@ 
 class EE_Event_Single_Config extends EE_Config_Base
 {
 
-    public $display_status_banner_single;
+	public $display_status_banner_single;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner_single = 0;
-        $this->display_venue = 1;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner_single = 0;
+		$this->display_venue = 1;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2978,172 +2978,172 @@ 
 class EE_Ticket_Selector_Config extends EE_Config_Base
 {
 
-    /**
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
-     */
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
-
-    /**
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
-     */
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
-
-    /**
-     * @var boolean $show_ticket_sale_columns
-     */
-    public $show_ticket_sale_columns;
-
-    /**
-     * @var boolean $show_ticket_details
-     */
-    public $show_ticket_details;
-
-    /**
-     * @var boolean $show_expired_tickets
-     */
-    public $show_expired_tickets;
-
-    /**
-     * whether or not to display a dropdown box populated with event datetimes
-     * that toggles which tickets are displayed for a ticket selector.
-     * uses one of the *_DATETIME_SELECTOR constants defined above
-     *
-     * @var string $show_datetime_selector
-     */
-    private $show_datetime_selector = 'no_datetime_selector';
-
-    /**
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
-     *
-     * @var int $datetime_selector_threshold
-     */
-    private $datetime_selector_threshold = 3;
-
-    /**
-     * determines the maximum number of "checked" dates in the date and time filter
-     *
-     * @var int $datetime_selector_checked
-     */
-    private $datetime_selector_max_checked = 10;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->show_ticket_sale_columns = true;
-        $this->show_ticket_details = true;
-        $this->show_expired_tickets = true;
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-        $this->datetime_selector_threshold = 3;
-        $this->datetime_selector_max_checked = 10;
-    }
-
-
-    /**
-     * returns true if a datetime selector should be displayed
-     *
-     * @param array $datetimes
-     * @return bool
-     */
-    public function showDatetimeSelector(array $datetimes)
-    {
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
-        return ! (
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-            || (
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getShowDatetimeSelector()
-    {
-        return $this->show_datetime_selector;
-    }
-
-
-    /**
-     * @param bool $keys_only
-     * @return array
-     */
-    public function getShowDatetimeSelectorOptions($keys_only = true)
-    {
-        return $keys_only
-            ? array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
-            )
-            : array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
-                    'Do not show date & time filter',
-                    'event_espresso'
-                ),
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
-                    'Maybe show date & time filter',
-                    'event_espresso'
-                ),
-            );
-    }
-
-
-    /**
-     * @param string $show_datetime_selector
-     */
-    public function setShowDatetimeSelector($show_datetime_selector)
-    {
-        $this->show_datetime_selector = in_array(
-            $show_datetime_selector,
-            $this->getShowDatetimeSelectorOptions(),
-            true
-        )
-            ? $show_datetime_selector
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorThreshold()
-    {
-        return $this->datetime_selector_threshold;
-    }
-
-
-    /**
-     * @param int $datetime_selector_threshold
-     */
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
-    {
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorMaxChecked()
-    {
-        return $this->datetime_selector_max_checked;
-    }
-
-
-    /**
-     * @param int $datetime_selector_max_checked
-     */
-    public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
-    {
-        $this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
-    }
+	/**
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
+	 */
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
+
+	/**
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
+	 */
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
+
+	/**
+	 * @var boolean $show_ticket_sale_columns
+	 */
+	public $show_ticket_sale_columns;
+
+	/**
+	 * @var boolean $show_ticket_details
+	 */
+	public $show_ticket_details;
+
+	/**
+	 * @var boolean $show_expired_tickets
+	 */
+	public $show_expired_tickets;
+
+	/**
+	 * whether or not to display a dropdown box populated with event datetimes
+	 * that toggles which tickets are displayed for a ticket selector.
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
+	 *
+	 * @var string $show_datetime_selector
+	 */
+	private $show_datetime_selector = 'no_datetime_selector';
+
+	/**
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
+	 *
+	 * @var int $datetime_selector_threshold
+	 */
+	private $datetime_selector_threshold = 3;
+
+	/**
+	 * determines the maximum number of "checked" dates in the date and time filter
+	 *
+	 * @var int $datetime_selector_checked
+	 */
+	private $datetime_selector_max_checked = 10;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->show_ticket_sale_columns = true;
+		$this->show_ticket_details = true;
+		$this->show_expired_tickets = true;
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+		$this->datetime_selector_threshold = 3;
+		$this->datetime_selector_max_checked = 10;
+	}
+
+
+	/**
+	 * returns true if a datetime selector should be displayed
+	 *
+	 * @param array $datetimes
+	 * @return bool
+	 */
+	public function showDatetimeSelector(array $datetimes)
+	{
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
+		return ! (
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+			|| (
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getShowDatetimeSelector()
+	{
+		return $this->show_datetime_selector;
+	}
+
+
+	/**
+	 * @param bool $keys_only
+	 * @return array
+	 */
+	public function getShowDatetimeSelectorOptions($keys_only = true)
+	{
+		return $keys_only
+			? array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
+			)
+			: array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
+					'Do not show date & time filter',
+					'event_espresso'
+				),
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
+					'Maybe show date & time filter',
+					'event_espresso'
+				),
+			);
+	}
+
+
+	/**
+	 * @param string $show_datetime_selector
+	 */
+	public function setShowDatetimeSelector($show_datetime_selector)
+	{
+		$this->show_datetime_selector = in_array(
+			$show_datetime_selector,
+			$this->getShowDatetimeSelectorOptions(),
+			true
+		)
+			? $show_datetime_selector
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorThreshold()
+	{
+		return $this->datetime_selector_threshold;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_threshold
+	 */
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
+	{
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorMaxChecked()
+	{
+		return $this->datetime_selector_max_checked;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_max_checked
+	 */
+	public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
+	{
+		$this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
+	}
 }
 
 /**
@@ -3156,86 +3156,86 @@ 
 class EE_Environment_Config extends EE_Config_Base
 {
 
-    /**
-     * Hold any php environment variables that we want to track.
-     *
-     * @var stdClass;
-     */
-    public $php;
-
-
-    /**
-     *    constructor
-     */
-    public function __construct()
-    {
-        $this->php = new stdClass();
-        $this->_set_php_values();
-    }
-
-
-    /**
-     * This sets the php environment variables.
-     *
-     * @since 4.4.0
-     * @return void
-     */
-    protected function _set_php_values()
-    {
-        $this->php->max_input_vars = ini_get('max_input_vars');
-        $this->php->version = phpversion();
-    }
-
-
-    /**
-     * helper method for determining whether input_count is
-     * reaching the potential maximum the server can handle
-     * according to max_input_vars
-     *
-     * @param int   $input_count the count of input vars.
-     * @return array {
-     *                           An array that represents whether available space and if no available space the error
-     *                           message.
-     * @type bool   $has_space   whether more inputs can be added.
-     * @type string $msg         Any message to be displayed.
-     *                           }
-     */
-    public function max_input_vars_limit_check($input_count = 0)
-    {
-        if (! empty($this->php->max_input_vars)
-            && ($input_count >= $this->php->max_input_vars)
-        ) {
-            // check the server setting because the config value could be stale
-            $max_input_vars = ini_get('max_input_vars');
-            if ($input_count >= $max_input_vars) {
-                return sprintf(
-                    esc_html__(
-                        'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    $input_count,
-                    $max_input_vars
-                );
-            } else {
-                return '';
-            }
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
-     *
-     * @since 4.4.1
-     * @return void
-     */
-    public function recheck_values()
-    {
-        $this->_set_php_values();
-    }
+	/**
+	 * Hold any php environment variables that we want to track.
+	 *
+	 * @var stdClass;
+	 */
+	public $php;
+
+
+	/**
+	 *    constructor
+	 */
+	public function __construct()
+	{
+		$this->php = new stdClass();
+		$this->_set_php_values();
+	}
+
+
+	/**
+	 * This sets the php environment variables.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 */
+	protected function _set_php_values()
+	{
+		$this->php->max_input_vars = ini_get('max_input_vars');
+		$this->php->version = phpversion();
+	}
+
+
+	/**
+	 * helper method for determining whether input_count is
+	 * reaching the potential maximum the server can handle
+	 * according to max_input_vars
+	 *
+	 * @param int   $input_count the count of input vars.
+	 * @return array {
+	 *                           An array that represents whether available space and if no available space the error
+	 *                           message.
+	 * @type bool   $has_space   whether more inputs can be added.
+	 * @type string $msg         Any message to be displayed.
+	 *                           }
+	 */
+	public function max_input_vars_limit_check($input_count = 0)
+	{
+		if (! empty($this->php->max_input_vars)
+			&& ($input_count >= $this->php->max_input_vars)
+		) {
+			// check the server setting because the config value could be stale
+			$max_input_vars = ini_get('max_input_vars');
+			if ($input_count >= $max_input_vars) {
+				return sprintf(
+					esc_html__(
+						'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
+						'event_espresso'
+					),
+					'<br>',
+					$input_count,
+					$max_input_vars
+				);
+			} else {
+				return '';
+			}
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
+	 *
+	 * @since 4.4.1
+	 * @return void
+	 */
+	public function recheck_values()
+	{
+		$this->_set_php_values();
+	}
 }
 
 /**
@@ -3248,21 +3248,21 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 /**
@@ -3276,19 +3276,19 @@ 
 class EE_Messages_Config extends EE_Config_Base
 {
 
-    /**
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
-     * A value of 0 represents never deleting.  Default is 0.
-     *
-     * @var integer
-     */
-    public $delete_threshold;
+	/**
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
+	 * A value of 0 represents never deleting.  Default is 0.
+	 *
+	 * @var integer
+	 */
+	public $delete_threshold;
 
 
-    public function __construct()
-    {
-        $this->delete_threshold = 0;
-    }
+	public function __construct()
+	{
+		$this->delete_threshold = 0;
+	}
 }
 
 /**
@@ -3299,31 +3299,31 @@ 
 class EE_Gateway_Config extends EE_Config_Base
 {
 
-    /**
-     * Array with keys that are payment gateways slugs, and values are arrays
-     * with any config info the gateway wants to store
-     *
-     * @var array
-     */
-    public $payment_settings;
-
-    /**
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
-     * the gateway is stored in the uploads directory
-     *
-     * @var array
-     */
-    public $active_gateways;
-
-
-    /**
-     *    class constructor
-     *
-     * @deprecated
-     */
-    public function __construct()
-    {
-        $this->payment_settings = array();
-        $this->active_gateways = array('Invoice' => false);
-    }
+	/**
+	 * Array with keys that are payment gateways slugs, and values are arrays
+	 * with any config info the gateway wants to store
+	 *
+	 * @var array
+	 */
+	public $payment_settings;
+
+	/**
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
+	 * the gateway is stored in the uploads directory
+	 *
+	 * @var array
+	 */
+	public $active_gateways;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated
+	 */
+	public function __construct()
+	{
+		$this->payment_settings = array();
+		$this->active_gateways = array('Invoice' => false);
+	}
 }

core/services/container/Mirror.php

Indentation +266 added lines, -266 removed lines

@@ -21,270 +21,270 @@
 class Mirror
 {
 
-    /**
-     * @var ReflectionClass[] $classes
-     */
-    private $classes = [];
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors = [];
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameters = [];
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameter_classes = [];
-
-    /**
-     * @var ReflectionProperty[][] $properties
-     */
-    private $properties = [];
-
-    /**
-     * @var ReflectionMethod[][] $methods
-     */
-    private $methods = [];
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->classes[ $class_name ])) {
-            $this->classes[ $class_name ] = new ReflectionClass($class_name);
-        }
-        return $this->classes[ $class_name ];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructor($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->constructors[ $class_name ])) {
-            $reflection_class                  = $this->getReflectionClass($class_name);
-            $this->constructors[ $class_name ] = $reflection_class->getConstructor();
-        }
-        return $this->constructors[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructorFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getConstructor($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParameters($class_name)
-    {
-        if (! isset($this->parameters[ $class_name ])) {
-            $constructor                     = $this->getConstructor($class_name);
-            $this->parameters[ $class_name ] = $constructor->getParameters();
-        }
-        return $this->parameters[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getParameters($reflection_class->getName());
-    }
-
-
-    /**
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
-    {
-        return $this->getParameters($constructor->getDeclaringClass());
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     */
-    public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
-        }
-        // ReflectionParameter::getClass() is deprecated in PHP 8+
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = PHP_VERSION_ID < 80000
-            ? $this->getParameterClassNameLegacy($param)
-            : $this->getParameterClassNamePhp8($param);
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @return string|null
-     * @since   4.10.13.p
-     */
-    private function getParameterClassNameLegacy(ReflectionParameter $param)
-    {
-        $reflection_class = $param->getClass();
-        return $reflection_class instanceof ReflectionClass
-            ? $reflection_class->getName()
-            : null;
-    }
-
-
-    /**
-     * ReflectionParameter::getClass() is deprecated in PHP 8+,
-     * so the class name for a parameter needs to be extracted from the ReflectionType,
-     * which can either be a ReflectionNamedType or ReflectionUnionType
-     *
-     * @param ReflectionParameter $param
-     * @return null
-     * @since   4.10.13.p
-     */
-    private function getParameterClassNamePhp8(ReflectionParameter $param)
-    {
-        $reflection_type = $param->getType();
-        if ($reflection_type instanceof \ReflectionNamedType) {
-            return $reflection_type->getName();
-        }
-
-        /** @noinspection PhpElementIsNotAvailableInCurrentPhpVersionInspection */
-        if ($reflection_type instanceof \ReflectionUnionType) {
-            $reflection_types = $reflection_type->getTypes();
-            if (is_array($reflection_types)) {
-                $first = reset($reflection_types);
-                return $first->getName();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     * @throws ReflectionException
-     */
-    public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
-        }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
-            ? $param->getDefaultValue()
-            : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getProperties($class_name)
-    {
-        if (! isset($this->properties[ $class_name ])) {
-            $reflection_class                = $this->getReflectionClass($class_name);
-            $this->properties[ $class_name ] = $reflection_class->getProperties();
-        }
-        return $this->properties[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getPropertiesFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getProperties($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethods($class_name)
-    {
-        if (! isset($this->methods[ $class_name ])) {
-            $reflection_class             = $this->getReflectionClass($class_name);
-            $this->methods[ $class_name ] = $reflection_class->getMethods();
-        }
-        return $this->methods[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class )
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethodsFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getMethods($reflection_class->getName());
-    }
+	/**
+	 * @var ReflectionClass[] $classes
+	 */
+	private $classes = [];
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors = [];
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameters = [];
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameter_classes = [];
+
+	/**
+	 * @var ReflectionProperty[][] $properties
+	 */
+	private $properties = [];
+
+	/**
+	 * @var ReflectionMethod[][] $methods
+	 */
+	private $methods = [];
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->classes[ $class_name ])) {
+			$this->classes[ $class_name ] = new ReflectionClass($class_name);
+		}
+		return $this->classes[ $class_name ];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructor($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->constructors[ $class_name ])) {
+			$reflection_class                  = $this->getReflectionClass($class_name);
+			$this->constructors[ $class_name ] = $reflection_class->getConstructor();
+		}
+		return $this->constructors[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructorFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getConstructor($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParameters($class_name)
+	{
+		if (! isset($this->parameters[ $class_name ])) {
+			$constructor                     = $this->getConstructor($class_name);
+			$this->parameters[ $class_name ] = $constructor->getParameters();
+		}
+		return $this->parameters[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getParameters($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
+	{
+		return $this->getParameters($constructor->getDeclaringClass());
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 */
+	public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = [];
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = [];
+		}
+		// ReflectionParameter::getClass() is deprecated in PHP 8+
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = PHP_VERSION_ID < 80000
+			? $this->getParameterClassNameLegacy($param)
+			: $this->getParameterClassNamePhp8($param);
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @return string|null
+	 * @since   4.10.13.p
+	 */
+	private function getParameterClassNameLegacy(ReflectionParameter $param)
+	{
+		$reflection_class = $param->getClass();
+		return $reflection_class instanceof ReflectionClass
+			? $reflection_class->getName()
+			: null;
+	}
+
+
+	/**
+	 * ReflectionParameter::getClass() is deprecated in PHP 8+,
+	 * so the class name for a parameter needs to be extracted from the ReflectionType,
+	 * which can either be a ReflectionNamedType or ReflectionUnionType
+	 *
+	 * @param ReflectionParameter $param
+	 * @return null
+	 * @since   4.10.13.p
+	 */
+	private function getParameterClassNamePhp8(ReflectionParameter $param)
+	{
+		$reflection_type = $param->getType();
+		if ($reflection_type instanceof \ReflectionNamedType) {
+			return $reflection_type->getName();
+		}
+
+		/** @noinspection PhpElementIsNotAvailableInCurrentPhpVersionInspection */
+		if ($reflection_type instanceof \ReflectionUnionType) {
+			$reflection_types = $reflection_type->getTypes();
+			if (is_array($reflection_types)) {
+				$first = reset($reflection_types);
+				return $first->getName();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 * @throws ReflectionException
+	 */
+	public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = [];
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = [];
+		}
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
+			? $param->getDefaultValue()
+			: null;
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getProperties($class_name)
+	{
+		if (! isset($this->properties[ $class_name ])) {
+			$reflection_class                = $this->getReflectionClass($class_name);
+			$this->properties[ $class_name ] = $reflection_class->getProperties();
+		}
+		return $this->properties[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getPropertiesFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getProperties($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethods($class_name)
+	{
+		if (! isset($this->methods[ $class_name ])) {
+			$reflection_class             = $this->getReflectionClass($class_name);
+			$this->methods[ $class_name ] = $reflection_class->getMethods();
+		}
+		return $this->methods[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class )
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethodsFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getMethods($reflection_class->getName());
+	}
 }

core/services/orm/ModelFieldFactory.php

Indentation +543 added lines, -543 removed lines

@@ -51,547 +51,547 @@
 class ModelFieldFactory
 {
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-
-    /**
-     * ModelFieldFactory constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_All_Caps_Text_Field
-     */
-    public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_All_Caps_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Any_Foreign_Model_Name_Field
-     */
-    public function createAnyForeignModelNameField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $model_name
-    ) {
-        return $this->loader->getNew(
-            'EE_Any_Foreign_Model_Name_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Boolean_Field
-     */
-    public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Boolean_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param string $timezone_string
-     * @param bool   $nullable
-     * @param string $default_value
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @return EE_Datetime_Field
-     */
-    public function createDatetimeField(
-        $table_column,
-        $nice_name,
-        $nullable = false,
-        $default_value = EE_Datetime_Field::now
-    ) {
-        return $this->loader->getNew(
-            'EE_Datetime_Field',
-            array(
-                $table_column,
-                $nice_name,
-                $nullable,
-                $default_value,
-            )
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Float_Field
-     */
-    public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Float_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Int_Field
-     */
-    public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Int_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Text_Field
-     */
-    public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Email_Field
-     */
-    public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '')
-    {
-        return $this->loader->getNew(
-            'EE_Email_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Integer_Field
-     */
-    public function createEnumIntegerField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        array $allowed_enum_values
-    ) {
-        return $this->loader->getNew(
-            'EE_Enum_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Text_Field
-     */
-    public function createEnumTextField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        array $allowed_enum_values
-    ) {
-        return $this->loader->getNew(
-            'EE_Enum_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Float_Field
-     */
-    public function createFloatField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Float_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_Int_Field
-     */
-    public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name)
-    {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_Int_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_String_Field
-     */
-    public function createForeignKeyStringField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $model_name
-    ) {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_String_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Full_HTML_Field
-     */
-    public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Full_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Infinite_Integer_Field
-     */
-    public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Infinite_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string  $table_column
-     * @param string  $nice_name
-     * @param bool    $nullable
-     * @param integer $default_value
-     * @return EE_Integer_Field
-     */
-    public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0)
-    {
-        return $this->loader->getNew(
-            'EE_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Simple_HTML_Field
-     */
-    public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Simple_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Text_Field
-     */
-    public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Money_Field
-     */
-    public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Money_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Plain_Text_Field
-     */
-    public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '')
-    {
-        return $this->loader->getNew(
-            'EE_Plain_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Post_Content_Field
-     */
-    public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Post_Content_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_Int_Field
-     */
-    public function createPrimaryKeyIntField($table_column, $nice_name)
-    {
-        return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_String_Field
-     */
-    public function createPrimaryKeyStringField($table_column, $nice_name)
-    {
-        return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Serialized_Text_Field
-     */
-    public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Serialized_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Simple_HTML_Field
-     */
-    public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Simple_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Slug_Field
-     */
-    public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Slug_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Trashed_Flag_Field
-     */
-    public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Trashed_Flag_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param mixed  $default_value
-     * @param array  $values                            If additional stati are to be used other than the default WP
-     *                                                  statuses, then they can be registered via this property. The
-     *                                                  format of the array should be as follows: array(
-     *                                                  'status_reference' => array(
-     *                                                  'label' => __('Status Reference Label', 'event_espresso'),
-     *                                                  'public' => true,                 // whether this status should
-     *                                                  be shown on the frontend of the site
-     *                                                  'exclude_from_search' => false,   // whether this status should
-     *                                                  be excluded from wp searches
-     *                                                  'show_in_admin_all_list' => true, // whether this status is
-     *                                                  included in queries for the admin "all" view in list table
-     *                                                  views.
-     *                                                  'show_in_admin_status_list' => true, // show in the list of
-     *                                                  statuses with post counts at the top of the admin list tables
-     *                                                  (i.e. Status Reference(2) )
-     *                                                  'label_count' => _n_noop(
-     *                                                  'Status Reference <span class="count">(%s)</span>',
-     *                                                  'Status References <span class="count">(%s)</span>'
-     *                                                  ),                                   // the text to display on
-     *                                                  the admin screen
-     *                                                  ( or you won't see your status count ).
-     *                                                  )
-     *                                                  )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @return EE_WP_Post_Status_Field
-     */
-    public function createWpPostStatusField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value = null,
-        array $values = array()
-    ) {
-        return $this->loader->getNew(
-            'EE_WP_Post_Status_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $values)
-        );
-    }
-
-
-    /**
-     * @param string $post_type
-     * @return EE_WP_Post_Type_Field
-     */
-    public function createWpPostTypeField($post_type)
-    {
-        return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @return EE_WP_User_Field
-     */
-    public function createWpUserField($table_column, $nice_name, $nullable)
-    {
-        return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable));
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+
+	/**
+	 * ModelFieldFactory constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_All_Caps_Text_Field
+	 */
+	public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_All_Caps_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 */
+	public function createAnyForeignModelNameField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$model_name
+	) {
+		return $this->loader->getNew(
+			'EE_Any_Foreign_Model_Name_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Boolean_Field
+	 */
+	public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Boolean_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param string $timezone_string
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @return EE_Datetime_Field
+	 */
+	public function createDatetimeField(
+		$table_column,
+		$nice_name,
+		$nullable = false,
+		$default_value = EE_Datetime_Field::now
+	) {
+		return $this->loader->getNew(
+			'EE_Datetime_Field',
+			array(
+				$table_column,
+				$nice_name,
+				$nullable,
+				$default_value,
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Float_Field
+	 */
+	public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Float_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Int_Field
+	 */
+	public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Int_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Text_Field
+	 */
+	public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Email_Field
+	 */
+	public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '')
+	{
+		return $this->loader->getNew(
+			'EE_Email_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Integer_Field
+	 */
+	public function createEnumIntegerField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		array $allowed_enum_values
+	) {
+		return $this->loader->getNew(
+			'EE_Enum_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Text_Field
+	 */
+	public function createEnumTextField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		array $allowed_enum_values
+	) {
+		return $this->loader->getNew(
+			'EE_Enum_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Float_Field
+	 */
+	public function createFloatField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Float_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_Int_Field
+	 */
+	public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name)
+	{
+		return $this->loader->getNew(
+			'EE_Foreign_Key_Int_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_String_Field
+	 */
+	public function createForeignKeyStringField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$model_name
+	) {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_String_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Full_HTML_Field
+	 */
+	public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Full_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Infinite_Integer_Field
+	 */
+	public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Infinite_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string  $table_column
+	 * @param string  $nice_name
+	 * @param bool    $nullable
+	 * @param integer $default_value
+	 * @return EE_Integer_Field
+	 */
+	public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0)
+	{
+		return $this->loader->getNew(
+			'EE_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Simple_HTML_Field
+	 */
+	public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Simple_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Text_Field
+	 */
+	public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Money_Field
+	 */
+	public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Money_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Plain_Text_Field
+	 */
+	public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '')
+	{
+		return $this->loader->getNew(
+			'EE_Plain_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Post_Content_Field
+	 */
+	public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Post_Content_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_Int_Field
+	 */
+	public function createPrimaryKeyIntField($table_column, $nice_name)
+	{
+		return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_String_Field
+	 */
+	public function createPrimaryKeyStringField($table_column, $nice_name)
+	{
+		return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Serialized_Text_Field
+	 */
+	public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Serialized_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Simple_HTML_Field
+	 */
+	public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Simple_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Slug_Field
+	 */
+	public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Slug_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Trashed_Flag_Field
+	 */
+	public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Trashed_Flag_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param mixed  $default_value
+	 * @param array  $values                            If additional stati are to be used other than the default WP
+	 *                                                  statuses, then they can be registered via this property. The
+	 *                                                  format of the array should be as follows: array(
+	 *                                                  'status_reference' => array(
+	 *                                                  'label' => __('Status Reference Label', 'event_espresso'),
+	 *                                                  'public' => true,                 // whether this status should
+	 *                                                  be shown on the frontend of the site
+	 *                                                  'exclude_from_search' => false,   // whether this status should
+	 *                                                  be excluded from wp searches
+	 *                                                  'show_in_admin_all_list' => true, // whether this status is
+	 *                                                  included in queries for the admin "all" view in list table
+	 *                                                  views.
+	 *                                                  'show_in_admin_status_list' => true, // show in the list of
+	 *                                                  statuses with post counts at the top of the admin list tables
+	 *                                                  (i.e. Status Reference(2) )
+	 *                                                  'label_count' => _n_noop(
+	 *                                                  'Status Reference <span class="count">(%s)</span>',
+	 *                                                  'Status References <span class="count">(%s)</span>'
+	 *                                                  ),                                   // the text to display on
+	 *                                                  the admin screen
+	 *                                                  ( or you won't see your status count ).
+	 *                                                  )
+	 *                                                  )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 * @return EE_WP_Post_Status_Field
+	 */
+	public function createWpPostStatusField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value = null,
+		array $values = array()
+	) {
+		return $this->loader->getNew(
+			'EE_WP_Post_Status_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $values)
+		);
+	}
+
+
+	/**
+	 * @param string $post_type
+	 * @return EE_WP_Post_Type_Field
+	 */
+	public function createWpPostTypeField($post_type)
+	{
+		return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @return EE_WP_User_Field
+	 */
+	public function createWpUserField($table_column, $nice_name, $nullable)
+	{
+		return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable));
+	}
 }

core/services/assets/I18nRegistry.php

Indentation +235 added lines, -235 removed lines

@@ -15,239 +15,239 @@
  */
 class I18nRegistry
 {
-    /**
-     * @var DomainInterface
-     */
-    private $domain;
-
-    /**
-     * Will hold all registered i18n scripts.  Prevents script handles from being registered more than once.
-     *
-     * @var array
-     */
-    private $registered_i18n = array();
-
-
-    /**
-     * Used to hold queued translations for the chunks loading in a view.
-     *
-     * @var array
-     */
-    private $queued_handle_translations = array();
-
-    /**
-     * Used to track script handles queued for adding translation strings as inline data in the dom.
-     *
-     * @var array
-     */
-    private $queued_scripts = array();
-
-
-    /**
-     * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to
-     * translation strings.
-     *
-     * @var array
-     */
-    private $i18n_map;
-
-
-    /**
-     * I18nRegistry constructor.
-     *
-     * @param array() $i18n_map  An array of script handle names and the strings translated for those handles.  If not
-     *                            provided, the class will look for map in root of plugin with filename of
-     *                            'translation-map.json'.
-     * @param DomainInterface $domain
-     */
-    public function __construct(array $i18n_map, DomainInterface $domain)
-    {
-        $this->domain = $domain;
-        $this->setI18nMap($i18n_map);
-        add_filter('print_scripts_array', array($this, 'queueI18n'));
-    }
-
-
-    /**
-     * Used to register a script that has i18n strings for its $handle
-     *
-     * @param string $handle The script handle reference.
-     * @param string $domain The i18n domain for the strings.
-     */
-    public function registerScriptI18n($handle, $domain = 'event_espresso')
-    {
-        if(! isset($this->registered_i18n[$handle])) {
-            $this->registered_i18n[ $handle ] = 1;
-            $this->queued_scripts[ $handle ] = $domain;
-        }
-    }
-
-
-
-    /**
-     * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data.
-     *
-     * @param array $handles Array of registered script handles.
-     * @return array
-     */
-    public function queueI18n(array $handles)
-    {
-        if (empty($this->queued_scripts)) {
-            return $handles;
-        }
-        foreach ($handles as $handle) {
-            $this->queueI18nTranslationsForHandle($handle);
-        }
-        if ($this->queued_handle_translations) {
-            foreach ($this->queued_handle_translations as $handle => $translations_for_domain) {
-                $this->registerInlineScript(
-                    $handle,
-                    $translations_for_domain['translations'],
-                    $translations_for_domain['domain']
-                );
-                unset($this->queued_handle_translations[$handle]);
-            }
-        }
-        return $handles;
-    }
-
-
-    /**
-     * Registers inline script with translations for given handle and domain.
-     *
-     * @param string $handle       Handle used to register javascript file containing translations.
-     * @param array  $translations Array of string translations.
-     * @param string $domain       Domain for translations.  If left empty then strings are registered with the default
-     *                             domain for the javascript.
-     */
-    protected function registerInlineScript($handle, array $translations, $domain)
-    {
-        $script = $domain ?
-            'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ', "' . $domain . '" );' :
-            'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );';
-        wp_add_inline_script($handle, $script, 'before');
-    }
-
-
-    /**
-     * Queues up the translation strings for the given handle.
-     *
-     * @param string $handle The script handle being queued up.
-     */
-    private function queueI18nTranslationsForHandle($handle)
-    {
-        if (isset($this->queued_scripts[$handle])) {
-            $domain = $this->queued_scripts[$handle];
-            $translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain);
-            if (count($translations) > 0) {
-                $this->queued_handle_translations[$handle] = array(
-                    'domain'       => $domain,
-                    'translations' => $translations,
-                );
-            }
-            unset($this->queued_scripts[$handle]);
-        }
-    }
-
-
-    /**
-     * Sets the internal i18n_map property.
-     * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map.
-     *
-     * @param array $i18n_map  If provided, an array of translation strings indexed by script handle names they
-     *                         correspond to.
-     */
-    private function setI18nMap(array $i18n_map)
-    {
-        if (empty($i18n_map)) {
-            $i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json')
-                ? json_decode(
-                        file_get_contents($this->domain->pluginPath() . 'translation-map.json'),
-                        true
-                    )
-                : array();
-        }
-        $this->i18n_map = $i18n_map;
-    }
-
-
-    /**
-     * Get the jed locale data for a given $handle and domain
-     *
-     * @param string $handle The name for the script handle we want strings returned for.
-     * @param string $domain The i18n domain.
-     * @return array
-     */
-    protected function getJedLocaleDataForDomainAndChunk($handle, $domain)
-    {
-        $translations = $this->getJedLocaleData($domain);
-        // get index for adding back after extracting strings for this $chunk.
-        $index = $translations[''];
-        $translations = $this->getLocaleDataMatchingMap(
-            $this->getOriginalStringsForHandleFromMap($handle),
-            $translations
-        );
-        $translations[''] = $index;
-        return $translations;
-    }
-
-
-    /**
-     * Get locale data for given strings from given translations
-     *
-     * @param array $string_set   This is the subset of strings (msgIds) we want to extract from the translations array.
-     * @param array $translations Translation data to extra strings from.
-     * @return array
-     */
-    protected function getLocaleDataMatchingMap(array $string_set, array $translations)
-    {
-        if (empty($string_set)) {
-            return array();
-        }
-        // some strings with quotes in them will break on the array_flip, so making sure quotes in the string are
-        // slashed also filter falsey values.
-        $string_set = array_unique(array_filter(wp_slash($string_set)));
-        return array_intersect_key($translations, array_flip($string_set));
-    }
-
-
-    /**
-     * Get original strings to translate for the given chunk from the map
-     *
-     * @param string $handle The script handle name to get strings from the map for.
-     * @return array
-     */
-    protected function getOriginalStringsForHandleFromMap($handle)
-    {
-        return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array();
-    }
-
-
-    /**
-     * Returns Jed-formatted localization data.
-     *
-     * @param  string $domain Translation domain.
-     * @return array
-     */
-    private function getJedLocaleData($domain)
-    {
-        $translations = get_translations_for_domain($domain);
-
-        $locale = array(
-            '' => array(
-                'domain' => $domain,
-                'lang'   => is_admin() ? EEH_DTT_Helper::get_user_locale() : get_locale()
-            ),
-        );
-
-        if (! empty($translations->headers['Plural-Forms'])) {
-            $locale['']['plural_forms'] = $translations->headers['Plural-Forms'];
-        }
-
-        foreach ($translations->entries as $msgid => $entry) {
-            $locale[$msgid] = $entry->translations;
-        }
-
-        return $locale;
-    }
+	/**
+	 * @var DomainInterface
+	 */
+	private $domain;
+
+	/**
+	 * Will hold all registered i18n scripts.  Prevents script handles from being registered more than once.
+	 *
+	 * @var array
+	 */
+	private $registered_i18n = array();
+
+
+	/**
+	 * Used to hold queued translations for the chunks loading in a view.
+	 *
+	 * @var array
+	 */
+	private $queued_handle_translations = array();
+
+	/**
+	 * Used to track script handles queued for adding translation strings as inline data in the dom.
+	 *
+	 * @var array
+	 */
+	private $queued_scripts = array();
+
+
+	/**
+	 * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to
+	 * translation strings.
+	 *
+	 * @var array
+	 */
+	private $i18n_map;
+
+
+	/**
+	 * I18nRegistry constructor.
+	 *
+	 * @param array() $i18n_map  An array of script handle names and the strings translated for those handles.  If not
+	 *                            provided, the class will look for map in root of plugin with filename of
+	 *                            'translation-map.json'.
+	 * @param DomainInterface $domain
+	 */
+	public function __construct(array $i18n_map, DomainInterface $domain)
+	{
+		$this->domain = $domain;
+		$this->setI18nMap($i18n_map);
+		add_filter('print_scripts_array', array($this, 'queueI18n'));
+	}
+
+
+	/**
+	 * Used to register a script that has i18n strings for its $handle
+	 *
+	 * @param string $handle The script handle reference.
+	 * @param string $domain The i18n domain for the strings.
+	 */
+	public function registerScriptI18n($handle, $domain = 'event_espresso')
+	{
+		if(! isset($this->registered_i18n[$handle])) {
+			$this->registered_i18n[ $handle ] = 1;
+			$this->queued_scripts[ $handle ] = $domain;
+		}
+	}
+
+
+
+	/**
+	 * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data.
+	 *
+	 * @param array $handles Array of registered script handles.
+	 * @return array
+	 */
+	public function queueI18n(array $handles)
+	{
+		if (empty($this->queued_scripts)) {
+			return $handles;
+		}
+		foreach ($handles as $handle) {
+			$this->queueI18nTranslationsForHandle($handle);
+		}
+		if ($this->queued_handle_translations) {
+			foreach ($this->queued_handle_translations as $handle => $translations_for_domain) {
+				$this->registerInlineScript(
+					$handle,
+					$translations_for_domain['translations'],
+					$translations_for_domain['domain']
+				);
+				unset($this->queued_handle_translations[$handle]);
+			}
+		}
+		return $handles;
+	}
+
+
+	/**
+	 * Registers inline script with translations for given handle and domain.
+	 *
+	 * @param string $handle       Handle used to register javascript file containing translations.
+	 * @param array  $translations Array of string translations.
+	 * @param string $domain       Domain for translations.  If left empty then strings are registered with the default
+	 *                             domain for the javascript.
+	 */
+	protected function registerInlineScript($handle, array $translations, $domain)
+	{
+		$script = $domain ?
+			'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ', "' . $domain . '" );' :
+			'eejs.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );';
+		wp_add_inline_script($handle, $script, 'before');
+	}
+
+
+	/**
+	 * Queues up the translation strings for the given handle.
+	 *
+	 * @param string $handle The script handle being queued up.
+	 */
+	private function queueI18nTranslationsForHandle($handle)
+	{
+		if (isset($this->queued_scripts[$handle])) {
+			$domain = $this->queued_scripts[$handle];
+			$translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain);
+			if (count($translations) > 0) {
+				$this->queued_handle_translations[$handle] = array(
+					'domain'       => $domain,
+					'translations' => $translations,
+				);
+			}
+			unset($this->queued_scripts[$handle]);
+		}
+	}
+
+
+	/**
+	 * Sets the internal i18n_map property.
+	 * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map.
+	 *
+	 * @param array $i18n_map  If provided, an array of translation strings indexed by script handle names they
+	 *                         correspond to.
+	 */
+	private function setI18nMap(array $i18n_map)
+	{
+		if (empty($i18n_map)) {
+			$i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json')
+				? json_decode(
+						file_get_contents($this->domain->pluginPath() . 'translation-map.json'),
+						true
+					)
+				: array();
+		}
+		$this->i18n_map = $i18n_map;
+	}
+
+
+	/**
+	 * Get the jed locale data for a given $handle and domain
+	 *
+	 * @param string $handle The name for the script handle we want strings returned for.
+	 * @param string $domain The i18n domain.
+	 * @return array
+	 */
+	protected function getJedLocaleDataForDomainAndChunk($handle, $domain)
+	{
+		$translations = $this->getJedLocaleData($domain);
+		// get index for adding back after extracting strings for this $chunk.
+		$index = $translations[''];
+		$translations = $this->getLocaleDataMatchingMap(
+			$this->getOriginalStringsForHandleFromMap($handle),
+			$translations
+		);
+		$translations[''] = $index;
+		return $translations;
+	}
+
+
+	/**
+	 * Get locale data for given strings from given translations
+	 *
+	 * @param array $string_set   This is the subset of strings (msgIds) we want to extract from the translations array.
+	 * @param array $translations Translation data to extra strings from.
+	 * @return array
+	 */
+	protected function getLocaleDataMatchingMap(array $string_set, array $translations)
+	{
+		if (empty($string_set)) {
+			return array();
+		}
+		// some strings with quotes in them will break on the array_flip, so making sure quotes in the string are
+		// slashed also filter falsey values.
+		$string_set = array_unique(array_filter(wp_slash($string_set)));
+		return array_intersect_key($translations, array_flip($string_set));
+	}
+
+
+	/**
+	 * Get original strings to translate for the given chunk from the map
+	 *
+	 * @param string $handle The script handle name to get strings from the map for.
+	 * @return array
+	 */
+	protected function getOriginalStringsForHandleFromMap($handle)
+	{
+		return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array();
+	}
+
+
+	/**
+	 * Returns Jed-formatted localization data.
+	 *
+	 * @param  string $domain Translation domain.
+	 * @return array
+	 */
+	private function getJedLocaleData($domain)
+	{
+		$translations = get_translations_for_domain($domain);
+
+		$locale = array(
+			'' => array(
+				'domain' => $domain,
+				'lang'   => is_admin() ? EEH_DTT_Helper::get_user_locale() : get_locale()
+			),
+		);
+
+		if (! empty($translations->headers['Plural-Forms'])) {
+			$locale['']['plural_forms'] = $translations->headers['Plural-Forms'];
+		}
+
+		foreach ($translations->entries as $msgid => $entry) {
+			$locale[$msgid] = $entry->translations;
+		}
+
+		return $locale;
+	}
 }
\ No newline at end of file

core/services/request/RequestStackCoreApp.php

Indentation +81 added lines, -81 removed lines

@@ -24,92 +24,92 @@
 class RequestStackCoreApp implements RequestDecoratorInterface, RequestStackCoreAppInterface
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
 
-    /**
-     * handle
-     * 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 RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     * @throws InvalidClassException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        espresso_load_required('EE_Base', EE_CORE . 'EE_Base.core.php');
-        espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
-        // workarounds for PHP < 5.3
-        espresso_load_required('EEH_Class_Tools', EE_HELPERS . 'EEH_Class_Tools.helper.php');
-        do_action(
-            'EE_EventEspresso_core_services_request_RequestStackCoreApp__handle_request__initialize_core_loading'
-        );
-        // legacy action for backwards compatibility
-        do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
-        $this->setupFramework();
-        $loader = LoaderFactory::getLoader();
-        $capabilities_checker = $loader->getShared(
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            [EE_Capabilities::instance()]
-        );
-        $loader->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager',
-            ['', $capabilities_checker, $request]
-        );
-        // WP cron jobs
-        $loader->getShared('EE_Cron_Tasks');
-        $loader->getShared('EE_System');
-        return $this->response;
-    }
+	/**
+	 * handle
+	 * 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 RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		espresso_load_required('EE_Base', EE_CORE . 'EE_Base.core.php');
+		espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
+		// workarounds for PHP < 5.3
+		espresso_load_required('EEH_Class_Tools', EE_HELPERS . 'EEH_Class_Tools.helper.php');
+		do_action(
+			'EE_EventEspresso_core_services_request_RequestStackCoreApp__handle_request__initialize_core_loading'
+		);
+		// legacy action for backwards compatibility
+		do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
+		$this->setupFramework();
+		$loader = LoaderFactory::getLoader();
+		$capabilities_checker = $loader->getShared(
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			[EE_Capabilities::instance()]
+		);
+		$loader->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager',
+			['', $capabilities_checker, $request]
+		);
+		// WP cron jobs
+		$loader->getShared('EE_Cron_Tasks');
+		$loader->getShared('EE_System');
+		return $this->response;
+	}
 
 
-    /**
-     * set framework for the rest of EE to hook into when loading
-     *
-     * @throws EE_Error
-     */
-    private function setupFramework()
-    {
-        espresso_load_required(
-            'EE_Bootstrap',
-            EE_CORE . 'EE_Bootstrap.core.php'
-        );
-        add_action('plugins_loaded', array('EE_Bootstrap', 'load_espresso_addons'), 1);
-        add_action('plugins_loaded', array('EE_Bootstrap', 'detect_activations_or_upgrades'), 3);
-        add_action('plugins_loaded', array('EE_Bootstrap', 'load_core_configuration'), 5);
-        add_action('plugins_loaded', array('EE_Bootstrap', 'register_shortcodes_modules_and_widgets'), 7);
-        add_action('plugins_loaded', array('EE_Bootstrap', 'brew_espresso'), 9);
-    }
+	/**
+	 * set framework for the rest of EE to hook into when loading
+	 *
+	 * @throws EE_Error
+	 */
+	private function setupFramework()
+	{
+		espresso_load_required(
+			'EE_Bootstrap',
+			EE_CORE . 'EE_Bootstrap.core.php'
+		);
+		add_action('plugins_loaded', array('EE_Bootstrap', 'load_espresso_addons'), 1);
+		add_action('plugins_loaded', array('EE_Bootstrap', 'detect_activations_or_upgrades'), 3);
+		add_action('plugins_loaded', array('EE_Bootstrap', 'load_core_configuration'), 5);
+		add_action('plugins_loaded', array('EE_Bootstrap', 'register_shortcodes_modules_and_widgets'), 7);
+		add_action('plugins_loaded', array('EE_Bootstrap', 'brew_espresso'), 9);
+	}
 
 
-    /**
-     * called after the request stack has been fully processed
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     */
-    public function handleResponse(RequestInterface $request, ResponseInterface $response)
-    {
-        if ($response->pluginDeactivated()) {
-            espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
-        }
-    }
+	/**
+	 * called after the request stack has been fully processed
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 */
+	public function handleResponse(RequestInterface $request, ResponseInterface $response)
+	{
+		if ($response->pluginDeactivated()) {
+			espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
+		}
+	}
 }